Store the value of unimplemented enum cases #31
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| // | ||
| // UnknownDecodable.swift | ||
| // | ||
|
|
||
| /// A convenience protocol to reduce duplication of RawRepresentable and Decodable initializers | ||
| protocol UnknownDecodable: Decodable, CaseIterable, RawRepresentable where RawValue == String { | ||
| static func unknown(_ rawValue: String) -> Self | ||
| } | ||
|
|
||
| extension UnknownDecodable { | ||
| public init?(rawValue: String) { | ||
| guard let match = Self.allCases.first(where: { $0.rawValue == rawValue }) else { | ||
| return nil | ||
| } | ||
|
|
||
| self = match | ||
| } | ||
|
|
||
| public init(from decoder: any Decoder) throws { | ||
| let rawValue = try decoder.singleValueContainer().decode(String.self) | ||
| self = .init(rawValue: rawValue) ?? .unknown(rawValue) | ||
| } | ||
| } | ||
|
|
||
| extension Card.FrameEffect: UnknownDecodable {} | ||
| extension Card.Layout: UnknownDecodable {} | ||
| extension MTGSet.Kind: UnknownDecodable {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| // | ||
| // CaseIterableTests.swift | ||
| // | ||
|
|
||
| import XCTest | ||
| import ScryfallKit | ||
|
|
||
| /// A test suite to remind maintainers to make sure that all the known cases for | ||
| /// an enum's `allCases` property. | ||
| /// | ||
| /// Some of the enums in ScryfallKit have to get updated a lot because WOTC | ||
| /// is constantly playing with card design. To fill the gap between the release | ||
| /// of a new enum case and the release of a supporting ScryfallKit version, | ||
| /// the `unknown(String)` case was introduced. | ||
| /// | ||
| /// Unfortunately, adding an associated value to an enum prevents the compiler | ||
| /// from automatically synthesizing the `CaseIterable` conformance. | ||
| /// | ||
| /// The manual conformance of `CaseIterable` for the affected types MUST include all cases | ||
| /// _except_ the `unknown(String)` case. Manually providing this conformance introduces the | ||
| /// risk that a new case will be added to one of these types but NOT added to the `allCases` | ||
| /// array. This test suite aims to prevent that via (ab)use of switch exhaustivity. By switching | ||
| /// on an arbitrary enum case in a unit test, the compiler will error out if a new case is added | ||
| /// to the enum but not added to the switch statement in the test. This should hopefully | ||
| /// remind maintainers to keep `allCases` up to date. | ||
| final class CaseIterableTests: XCTestCase { | ||
| func testFrameEffect() { | ||
| let stub = Card.FrameEffect.battle | ||
| let contains = switch stub { | ||
| case .legendary: Card.FrameEffect.allCases.contains(.legendary) | ||
| case .miracle: Card.FrameEffect.allCases.contains(.miracle) | ||
| case .nyxtouched: Card.FrameEffect.allCases.contains(.nyxtouched) | ||
| case .draft: Card.FrameEffect.allCases.contains(.draft) | ||
| case .devoid: Card.FrameEffect.allCases.contains(.devoid) | ||
| case .tombstone: Card.FrameEffect.allCases.contains(.tombstone) | ||
| case .colorshifted: Card.FrameEffect.allCases.contains(.colorshifted) | ||
| case .inverted: Card.FrameEffect.allCases.contains(.inverted) | ||
| case .sunmoondfc: Card.FrameEffect.allCases.contains(.sunmoondfc) | ||
| case .compasslanddfc: Card.FrameEffect.allCases.contains(.compasslanddfc) | ||
| case .originpwdfc: Card.FrameEffect.allCases.contains(.originpwdfc) | ||
| case .mooneldrazidfc: Card.FrameEffect.allCases.contains(.mooneldrazidfc) | ||
| case .waxingandwaningmoondfc: Card.FrameEffect.allCases.contains(.waxingandwaningmoondfc) | ||
| case .showcase: Card.FrameEffect.allCases.contains(.showcase) | ||
| case .extendedart: Card.FrameEffect.allCases.contains(.extendedart) | ||
| case .companion: Card.FrameEffect.allCases.contains(.companion) | ||
| case .etched: Card.FrameEffect.allCases.contains(.etched) | ||
| case .snow: Card.FrameEffect.allCases.contains(.snow) | ||
| case .lesson: Card.FrameEffect.allCases.contains(.lesson) | ||
| case .convertdfc: Card.FrameEffect.allCases.contains(.convertdfc) | ||
| case .fandfc: Card.FrameEffect.allCases.contains(.fandfc) | ||
| case .battle: Card.FrameEffect.allCases.contains(.battle) | ||
|
There was a problem hiding this comment. If I understand this test correctly, I think only |
||
| case .gravestone: Card.FrameEffect.allCases.contains(.gravestone) | ||
| case .fullart: Card.FrameEffect.allCases.contains(.fullart) | ||
| case .vehicle: Card.FrameEffect.allCases.contains(.vehicle) | ||
| case .borderless: Card.FrameEffect.allCases.contains(.borderless) | ||
| case .extended: Card.FrameEffect.allCases.contains(.extended) | ||
| case .spree: Card.FrameEffect.allCases.contains(.spree) | ||
| case .textless: Card.FrameEffect.allCases.contains(.textless) | ||
| case .enchantment: Card.FrameEffect.allCases.contains(.enchantment) | ||
| case .shatteredglass: Card.FrameEffect.allCases.contains(.shatteredglass) | ||
| case .upsidedowndfc: Card.FrameEffect.allCases.contains(.upsidedowndfc) | ||
| case .unknown(let string): | ||
| // Unknown case shouldn't be in allCases | ||
| !Card.FrameEffect.allCases.contains(.unknown(string)) | ||
| } | ||
|
|
||
| XCTAssertTrue(contains) | ||
| } | ||
|
|
||
| func testLayout() { | ||
| let stub = Card.Layout.adventure | ||
| let contains = switch stub { | ||
| case .normal: Card.Layout.allCases.contains(.normal) | ||
| case .split: Card.Layout.allCases.contains(.split) | ||
| case .flip: Card.Layout.allCases.contains(.flip) | ||
| case .transform: Card.Layout.allCases.contains(.transform) | ||
| case .meld: Card.Layout.allCases.contains(.meld) | ||
| case .leveler: Card.Layout.allCases.contains(.leveler) | ||
| case .saga: Card.Layout.allCases.contains(.saga) | ||
| case .adventure: Card.Layout.allCases.contains(.adventure) | ||
| case .planar: Card.Layout.allCases.contains(.planar) | ||
| case .scheme: Card.Layout.allCases.contains(.scheme) | ||
| case .vanguard: Card.Layout.allCases.contains(.vanguard) | ||
| case .token: Card.Layout.allCases.contains(.token) | ||
| case .emblem: Card.Layout.allCases.contains(.emblem) | ||
| case .augment: Card.Layout.allCases.contains(.augment) | ||
| case .host: Card.Layout.allCases.contains(.host) | ||
| case .class: Card.Layout.allCases.contains(.class) | ||
| case .battle: Card.Layout.allCases.contains(.battle) | ||
| case .case: Card.Layout.allCases.contains(.case) | ||
| case .mutate: Card.Layout.allCases.contains(.mutate) | ||
| case .prototype: Card.Layout.allCases.contains(.prototype) | ||
| case .modalDfc: Card.Layout.allCases.contains(.modalDfc) | ||
| case .doubleSided: Card.Layout.allCases.contains(.doubleSided) | ||
| case .doubleFacedToken: Card.Layout.allCases.contains(.doubleFacedToken) | ||
| case .artSeries: Card.Layout.allCases.contains(.artSeries) | ||
| case .reversibleCard: Card.Layout.allCases.contains(.reversibleCard) | ||
| case .unknown(let string): | ||
| // Unknown case shouldn't be in allCases | ||
| !Card.Layout.allCases.contains(.unknown(string)) | ||
| } | ||
|
|
||
| XCTAssertTrue(contains) | ||
| } | ||
|
|
||
| func testSetType() { | ||
| let stub = MTGSet.Kind.funny | ||
| let contains = switch stub { | ||
| case .core: MTGSet.Kind.allCases.contains(.core) | ||
| case .expansion: MTGSet.Kind.allCases.contains(.expansion) | ||
| case .masters: MTGSet.Kind.allCases.contains(.masters) | ||
| case .masterpiece: MTGSet.Kind.allCases.contains(.masterpiece) | ||
| case .spellbook: MTGSet.Kind.allCases.contains(.spellbook) | ||
| case .commander: MTGSet.Kind.allCases.contains(.commander) | ||
| case .planechase: MTGSet.Kind.allCases.contains(.planechase) | ||
| case .archenemy: MTGSet.Kind.allCases.contains(.archenemy) | ||
| case .vanguard: MTGSet.Kind.allCases.contains(.vanguard) | ||
| case .funny: MTGSet.Kind.allCases.contains(.funny) | ||
| case .starter: MTGSet.Kind.allCases.contains(.starter) | ||
| case .box: MTGSet.Kind.allCases.contains(.box) | ||
| case .promo: MTGSet.Kind.allCases.contains(.promo) | ||
| case .token: MTGSet.Kind.allCases.contains(.token) | ||
| case .memorabilia: MTGSet.Kind.allCases.contains(.memorabilia) | ||
| case .arsenal: MTGSet.Kind.allCases.contains(.arsenal) | ||
| case .alchemy: MTGSet.Kind.allCases.contains(.alchemy) | ||
| case .minigame: MTGSet.Kind.allCases.contains(.minigame) | ||
| case .fromTheVault: MTGSet.Kind.allCases.contains(.fromTheVault) | ||
| case .premiumDeck: MTGSet.Kind.allCases.contains(.premiumDeck) | ||
| case .duelDeck: MTGSet.Kind.allCases.contains(.duelDeck) | ||
| case .draftInnovation: MTGSet.Kind.allCases.contains(.draftInnovation) | ||
| case .treasureChest: MTGSet.Kind.allCases.contains(.treasureChest) | ||
| case .unknown(let string): | ||
| // Unknown case shouldn't be in allCases | ||
| !MTGSet.Kind.allCases.contains(.unknown(string)) | ||
| } | ||
|
|
||
| XCTAssertTrue(contains) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we also take the opportunity to make these cases camelCase to align with all the other enums we have?