Merge pull request #3 from MFB-Technologies-Inc/bugfix/remove-rawrep-string-init-for-option

roanutil · web-flow · commit a1cfa054b0af · 2023-03-07T10:21:14.000-06:00
Minor API improvements
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 [![ci](https://github.com/MFB-Technologies-Inc/swift-argument-encoding/actions/workflows/ci.yml/badge.svg)](https://github.com/MFB-Technologies-Inc/swift-argument-encoding/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/MFB-Technologies-Inc/swift-argument-encoding/branch/main/graph/badge.svg?token=UU95IDUXAX)](https://codecov.io/gh/MFB-Technologies-Inc/swift-argument-encoding)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FMFB-Technologies-Inc%2Fswift-argument-encoding%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/MFB-Technologies-Inc/swift-argument-encoding)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FMFB-Technologies-Inc%2Fswift-argument-encoding%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/MFB-Technologies-Inc/swift-argument-encoding)
 
 A library for encoding types into an Array of Strings, or 'arguments'.
 
diff --git a/Sources/ArgumentEncoding/CommandRepresentable.swift b/Sources/ArgumentEncoding/CommandRepresentable.swift
@@ -35,8 +35,8 @@ import Dependencies
 /// let arguments = container.arguments()
 /// ```
 ///
-/// `CommandRepresentable` inherits from ``ArgumentGroup`` and ``FormatterNode``
-public protocol CommandRepresentable: ArgumentGroup, FormatterNode {}
+/// `CommandRepresentable` inherits from ``ArgumentGroup``
+public protocol CommandRepresentable: ArgumentGroup {}
 
 extension CommandRepresentable {
     /// Prefixes the child arguments with an explicit command value.
diff --git a/Sources/ArgumentEncoding/Option.swift b/Sources/ArgumentEncoding/Option.swift
@@ -127,32 +127,6 @@ extension Option where Value: CustomStringConvertible {
     }
 }
 
-// MARK: Convenience initializers when Value: RawRepresentable and Value.RawValue == String
-
-extension Option where Value: RawRepresentable, Value.RawValue == String {
-    /// Initializes a new option when not used as a `@propertyWrapper`
-    ///
-    /// - Parameters
-    ///     - key: Explicit key value
-    ///     - wrappedValue: The underlying value
-    public init(key: some CustomStringConvertible, value: Value) {
-        keyOverride = key.description
-        wrappedValue = value
-        unwrap = { [$0.rawValue] }
-    }
-
-    /// Initializes a new option when used as a `@propertyWrapper`
-    ///
-    /// - Parameters
-    ///     - wrappedValue: The underlying value
-    ///     - _ key: Optional explicit key value
-    public init(wrappedValue: Value, _ key: String? = nil) {
-        keyOverride = key
-        self.wrappedValue = wrappedValue
-        unwrap = { [$0.rawValue] }
-    }
-}
-
 // MARK: Convenience initializers when Value == Optional<Wrapped>
 
 extension Option {
@@ -181,32 +155,6 @@ extension Option {
         self.wrappedValue = wrappedValue
         unwrap = { [$0?.description].compactMap { $0 } }
     }
-
-    /// Initializes a new option when not used as a `@propertyWrapper`
-    ///
-    /// - Parameters
-    ///     - key: Explicit key value
-    ///     - wrappedValue: The underlying value
-    public init<Wrapped>(key: some CustomStringConvertible, value: Wrapped?) where Wrapped: RawRepresentable,
-        Wrapped.RawValue == String, Value == Wrapped?
-    {
-        keyOverride = key.description
-        wrappedValue = value
-        unwrap = { [$0?.rawValue].compactMap { $0 } }
-    }
-
-    /// Initializes a new option when used as a `@propertyWrapper`
-    ///
-    /// - Parameters
-    ///     - wrappedValue: The underlying value
-    ///     - _ key: Optional explicit key value
-    public init<Wrapped>(wrappedValue: Wrapped?, _ key: String? = nil) where Wrapped: RawRepresentable,
-        Wrapped.RawValue == String, Value == Wrapped?
-    {
-        keyOverride = key
-        self.wrappedValue = wrappedValue
-        unwrap = { [$0?.rawValue].compactMap { $0 } }
-    }
 }
 
 // MARK: Convenience initializers when Value == Sequence<E>
@@ -237,32 +185,6 @@ extension Option {
         self.wrappedValue = wrappedValue
         unwrap = { $0.map(\E.description) }
     }
-
-    /// Initializes a new option when not used as a `@propertyWrapper`
-    ///
-    /// - Parameters
-    ///     - key: Explicit key value
-    ///     - wrappedValue: The underlying value
-    public init<E>(key: some CustomStringConvertible, values: Value) where Value: Sequence, Value.Element == E,
-        E: RawRepresentable, E.RawValue == String
-    {
-        keyOverride = key.description
-        wrappedValue = values
-        unwrap = { $0.map(\E.rawValue) }
-    }
-
-    /// Initializes a new option when used as a `@propertyWrapper`
-    ///
-    /// - Parameters
-    ///     - wrappedValue: The underlying value
-    ///     - _ key: Optional explicit key value
-    public init<E>(wrappedValue: Value, _ key: String? = nil) where Value: Sequence, Value.Element == E,
-        E: RawRepresentable, E.RawValue == String
-    {
-        keyOverride = key
-        self.wrappedValue = wrappedValue
-        unwrap = { $0.map(\E.rawValue) }
-    }
 }
 
 // MARK: ExpressibleBy...Literal conformances
@@ -305,6 +227,20 @@ extension Option: ExpressibleByStringInterpolation where Value: StringProtocol {
     }
 }
 
+extension Option: Decodable where Value: Decodable & CustomStringConvertible {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        self.init(wrappedValue: try container.decode(Value.self))
+    }
+}
+
+extension Option: Encodable where Value: Encodable {
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        try container.encode(wrappedValue)
+    }
+}
+
 // MARK: Internal Types
 
 /*
diff --git a/Sources/ArgumentEncoding/TopLevelCommandRepresentable.swift b/Sources/ArgumentEncoding/TopLevelCommandRepresentable.swift
@@ -34,7 +34,7 @@
 /// ```
 ///
 /// `TopLevelCommandRepresentable` inherits from ``ArgumentGroup``, ``FormatterNode``, and ``CommandRepresentable``
-public protocol TopLevelCommandRepresentable: CommandRepresentable {
+public protocol TopLevelCommandRepresentable: CommandRepresentable, FormatterNode {
     func commandValue() -> Command
 }
 
diff --git a/Tests/ArgumentEncodingTests/ArgumentGroupTests.swift b/Tests/ArgumentEncodingTests/ArgumentGroupTests.swift
@@ -75,9 +75,11 @@ final class ArgumentGroupTests: XCTestCase {
             self.buildTests = buildTests
         }
 
-        enum Configuration: String {
+        enum Configuration: String, CustomStringConvertible {
             case arm64
             case x86_64
+
+            var description: String { rawValue }
         }
     }
 
diff --git a/Tests/ArgumentEncodingTests/CommandRepresentableTests.swift b/Tests/ArgumentEncodingTests/CommandRepresentableTests.swift
@@ -7,9 +7,9 @@ import ArgumentEncoding
 import XCTest
 
 final class CommandRepresentableTests: XCTestCase {
-    private struct Container<T>: ArgumentGroup where T: CommandRepresentable {
-        static var flagFormatter: FlagFormatter { .doubleDashPrefix }
-        static var optionFormatter: OptionFormatter { .doubleDashPrefix }
+    private struct Container<T>: ArgumentGroup, FormatterNode where T: CommandRepresentable {
+        var flagFormatter: FlagFormatter { .doubleDashPrefix }
+        var optionFormatter: OptionFormatter { .doubleDashPrefix }
 
         var command: T
 
@@ -18,7 +18,7 @@ final class CommandRepresentableTests: XCTestCase {
         }
     }
 
-    private struct EmptyCommand: CommandRepresentable {
+    private struct EmptyCommand: CommandRepresentable, FormatterNode {
         let flagFormatter: FlagFormatter = .doubleDashPrefix
         let optionFormatter: OptionFormatter = .doubleDashPrefix
     }
@@ -29,7 +29,7 @@ final class CommandRepresentableTests: XCTestCase {
         XCTAssertEqual(args, ["command"])
     }
 
-    private struct CommandGroup: CommandRepresentable {
+    private struct CommandGroup: CommandRepresentable, FormatterNode {
         let flagFormatter: FlagFormatter = .doubleDashPrefix
         let optionFormatter: OptionFormatter = .doubleDashPrefix
 
@@ -67,7 +67,7 @@ final class CommandRepresentableTests: XCTestCase {
         )
     }
 
-    private struct ParentCommand: CommandRepresentable {
+    private struct ParentCommand: CommandRepresentable, FormatterNode {
         let flagFormatter: FlagFormatter = .doubleDashPrefix
         let optionFormatter: OptionFormatter = .doubleDashPrefix
 
@@ -82,7 +82,7 @@ final class CommandRepresentableTests: XCTestCase {
         }
     }
 
-    private struct ChildCommand: CommandRepresentable {
+    private struct ChildCommand: CommandRepresentable, FormatterNode {
         let flagFormatter: FlagFormatter = .singleDashPrefix
         let optionFormatter: OptionFormatter = .singleDashPrefix
 
@@ -94,9 +94,13 @@ final class CommandRepresentableTests: XCTestCase {
             self.buildTests = buildTests
         }
 
-        enum Configuration: String {
+        enum Configuration: String, CustomStringConvertible {
             case arm64
             case x86_64
+
+            var description: String {
+                rawValue
+            }
         }
     }
 
@@ -126,7 +130,7 @@ final class CommandRepresentableTests: XCTestCase {
         )
     }
 
-    private enum ParentEnumCommand: CommandRepresentable {
+    private enum ParentEnumCommand: CommandRepresentable, FormatterNode {
         var flagFormatter: FlagFormatter { .singleDashPrefix }
         var optionFormatter: OptionFormatter { .singleDashPrefix }
 
diff --git a/Tests/ArgumentEncodingTests/TopLevelCommandRepresentableTests.swift b/Tests/ArgumentEncodingTests/TopLevelCommandRepresentableTests.swift
@@ -73,7 +73,7 @@ final class TopLevelCommandRepresentableTests: XCTestCase {
             self.child = child
         }
 
-        struct ChildCommand: CommandRepresentable {
+        struct ChildCommand: CommandRepresentable, FormatterNode {
             func commandValue() -> Command { "child" }
             let flagFormatter: FlagFormatter = .singleDashPrefix
             let optionFormatter: OptionFormatter = .singleDashPrefix
@@ -86,9 +86,11 @@ final class TopLevelCommandRepresentableTests: XCTestCase {
                 self.buildTests = buildTests
             }
 
-            enum Configuration: String {
+            enum Configuration: String, CustomStringConvertible {
                 case arm64
                 case x86_64
+
+                var description: String { rawValue }
             }
         }
     }
@@ -142,9 +144,11 @@ final class TopLevelCommandRepresentableTests: XCTestCase {
             self.buildTests = buildTests
         }
 
-        enum Configuration: String {
+        enum Configuration: String, CustomStringConvertible {
             case arm64
             case x86_64
+
+            var description: String { rawValue }
         }
     }
 
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,3 @@
+coverage:
+  status:
+    patch: false

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	/// ```
`35`	`35`	`///`
`36`	`36`	/// `TopLevelCommandRepresentable` inherits from ``ArgumentGroup``, ``FormatterNode``, and ``CommandRepresentable``
`37`		`-public protocol TopLevelCommandRepresentable: CommandRepresentable {`
	`37`	`+public protocol TopLevelCommandRepresentable: CommandRepresentable, FormatterNode {`
`38`	`38`	`func commandValue() -> Command`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -75,9 +75,11 @@ final class ArgumentGroupTests: XCTestCase {`
`75`	`75`	`self.buildTests = buildTests`
`76`	`76`	`}`
`77`	`77`
`78`		`- enum Configuration: String {`
	`78`	`+ enum Configuration: String, CustomStringConvertible {`
`79`	`79`	`case arm64`
`80`	`80`	`case x86_64`
	`81`	`+`
	`82`	`+ var description: String { rawValue }`
`81`	`83`	`}`
`82`	`84`	`}`
`83`	`85`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,9 @@ import ArgumentEncoding`
`7`	`7`	`import XCTest`
`8`	`8`
`9`	`9`	`final class CommandRepresentableTests: XCTestCase {`
`10`		`- private struct Container<T>: ArgumentGroup where T: CommandRepresentable {`
`11`		`- static var flagFormatter: FlagFormatter { .doubleDashPrefix }`
`12`		`- static var optionFormatter: OptionFormatter { .doubleDashPrefix }`
	`10`	`+ private struct Container<T>: ArgumentGroup, FormatterNode where T: CommandRepresentable {`
	`11`	`+ var flagFormatter: FlagFormatter { .doubleDashPrefix }`
	`12`	`+ var optionFormatter: OptionFormatter { .doubleDashPrefix }`
`13`	`13`
`14`	`14`	`var command: T`
`15`	`15`
`@@ -18,7 +18,7 @@ final class CommandRepresentableTests: XCTestCase {`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`
`21`		`- private struct EmptyCommand: CommandRepresentable {`
	`21`	`+ private struct EmptyCommand: CommandRepresentable, FormatterNode {`
`22`	`22`	`let flagFormatter: FlagFormatter = .doubleDashPrefix`
`23`	`23`	`let optionFormatter: OptionFormatter = .doubleDashPrefix`
`24`	`24`	`}`
`@@ -29,7 +29,7 @@ final class CommandRepresentableTests: XCTestCase {`
`29`	`29`	`XCTAssertEqual(args, ["command"])`
`30`	`30`	`}`
`31`	`31`
`32`		`- private struct CommandGroup: CommandRepresentable {`
	`32`	`+ private struct CommandGroup: CommandRepresentable, FormatterNode {`
`33`	`33`	`let flagFormatter: FlagFormatter = .doubleDashPrefix`
`34`	`34`	`let optionFormatter: OptionFormatter = .doubleDashPrefix`
`35`	`35`
`@@ -67,7 +67,7 @@ final class CommandRepresentableTests: XCTestCase {`
`67`	`67`	`)`
`68`	`68`	`}`
`69`	`69`
`70`		`- private struct ParentCommand: CommandRepresentable {`
	`70`	`+ private struct ParentCommand: CommandRepresentable, FormatterNode {`
`71`	`71`	`let flagFormatter: FlagFormatter = .doubleDashPrefix`
`72`	`72`	`let optionFormatter: OptionFormatter = .doubleDashPrefix`
`73`	`73`
`@@ -82,7 +82,7 @@ final class CommandRepresentableTests: XCTestCase {`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`85`		`- private struct ChildCommand: CommandRepresentable {`
	`85`	`+ private struct ChildCommand: CommandRepresentable, FormatterNode {`
`86`	`86`	`let flagFormatter: FlagFormatter = .singleDashPrefix`
`87`	`87`	`let optionFormatter: OptionFormatter = .singleDashPrefix`
`88`	`88`
`@@ -94,9 +94,13 @@ final class CommandRepresentableTests: XCTestCase {`
`94`	`94`	`self.buildTests = buildTests`
`95`	`95`	`}`
`96`	`96`
`97`		`- enum Configuration: String {`
	`97`	`+ enum Configuration: String, CustomStringConvertible {`
`98`	`98`	`case arm64`
`99`	`99`	`case x86_64`
	`100`	`+`
	`101`	`+ var description: String {`
	`102`	`+ rawValue`
	`103`	`+ }`
`100`	`104`	`}`
`101`	`105`	`}`
`102`	`106`
`@@ -126,7 +130,7 @@ final class CommandRepresentableTests: XCTestCase {`
`126`	`130`	`)`
`127`	`131`	`}`
`128`	`132`
`129`		`- private enum ParentEnumCommand: CommandRepresentable {`
	`133`	`+ private enum ParentEnumCommand: CommandRepresentable, FormatterNode {`
`130`	`134`	`var flagFormatter: FlagFormatter { .singleDashPrefix }`
`131`	`135`	`var optionFormatter: OptionFormatter { .singleDashPrefix }`
`132`	`136`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ final class TopLevelCommandRepresentableTests: XCTestCase {`
`73`	`73`	`self.child = child`
`74`	`74`	`}`
`75`	`75`
`76`		`- struct ChildCommand: CommandRepresentable {`
	`76`	`+ struct ChildCommand: CommandRepresentable, FormatterNode {`
`77`	`77`	`func commandValue() -> Command { "child" }`
`78`	`78`	`let flagFormatter: FlagFormatter = .singleDashPrefix`
`79`	`79`	`let optionFormatter: OptionFormatter = .singleDashPrefix`
`@@ -86,9 +86,11 @@ final class TopLevelCommandRepresentableTests: XCTestCase {`
`86`	`86`	`self.buildTests = buildTests`
`87`	`87`	`}`
`88`	`88`
`89`		`- enum Configuration: String {`
	`89`	`+ enum Configuration: String, CustomStringConvertible {`
`90`	`90`	`case arm64`
`91`	`91`	`case x86_64`
	`92`	`+`
	`93`	`+ var description: String { rawValue }`
`92`	`94`	`}`
`93`	`95`	`}`
`94`	`96`	`}`
`@@ -142,9 +144,11 @@ final class TopLevelCommandRepresentableTests: XCTestCase {`
`142`	`144`	`self.buildTests = buildTests`
`143`	`145`	`}`
`144`	`146`
`145`		`- enum Configuration: String {`
	`147`	`+ enum Configuration: String, CustomStringConvertible {`
`146`	`148`	`case arm64`
`147`	`149`	`case x86_64`
	`150`	`+`
	`151`	`+ var description: String { rawValue }`
`148`	`152`	`}`
`149`	`153`	`}`
`150`	`154`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+coverage:`
	`2`	`+ status:`
	`3`	`+ patch: false`