-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
2,062 additions
and
35 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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,115 @@ | ||
| import Foundation | ||
|
|
||
| /// A type-erased case path that supports embedding a value in a root and attempting to extract a | ||
| /// root's embedded value. | ||
| /// | ||
| /// This type defines key path-like semantics for enum cases, and is used to derive ``CaseKeyPath``s | ||
| /// from types that conform to ``CasePathable``. | ||
| @dynamicMemberLookup | ||
| public struct AnyCasePath<Root, Value>: Sendable { | ||
| private let _embed: @Sendable (Value) -> Root | ||
| private let _extract: @Sendable (Root) -> Value? | ||
|
|
||
| /// Creates a type-erased case path from a pair of functions. | ||
| /// | ||
| /// - Parameters: | ||
| /// - embed: A function that always succeeds in embedding a value in a root. | ||
| /// - extract: A function that can optionally fail in extracting a value from a root. | ||
| public init( | ||
| embed: @escaping @Sendable (Value) -> Root, | ||
| extract: @escaping @Sendable (Root) -> Value? | ||
| ) { | ||
| self._embed = embed | ||
| self._extract = extract | ||
| } | ||
|
|
||
| public static func _$embed( | ||
| _ embed: @escaping (Value) -> Root, | ||
| extract: @escaping @Sendable (Root) -> Value? | ||
| ) -> Self { | ||
| #if swift(>=5.10) | ||
| nonisolated(unsafe) let embed = embed | ||
| return Self(embed: { embed($0) }, extract: extract) | ||
| #else | ||
| @UncheckedSendable var embed = embed | ||
| return Self(embed: { [$embed] in $embed.wrappedValue($0) }, extract: extract) | ||
| #endif | ||
| } | ||
|
|
||
| /// Returns a root by embedding a value. | ||
| /// | ||
| /// - Parameter value: A value to embed. | ||
| /// - Returns: A root that embeds `value`. | ||
| public func embed(_ value: Value) -> Root { | ||
| self._embed(value) | ||
| } | ||
|
|
||
| /// Attempts to extract a value from a root. | ||
| /// | ||
| /// - Parameter root: A root to extract from. | ||
| /// - Returns: A value if it can be extracted from the given root, otherwise `nil`. | ||
| public func extract(from root: Root) -> Value? { | ||
| self._extract(root) | ||
| } | ||
| } | ||
|
|
||
| extension AnyCasePath where Root == Value { | ||
| /// The identity case path. | ||
| /// | ||
| /// A case path that: | ||
| /// | ||
| /// * Given a value to embed, returns the given value. | ||
| /// * Given a value to extract, returns the given value. | ||
| public init() where Root == Value { | ||
| self.init(embed: { $0 }, extract: { $0 }) | ||
| } | ||
| } | ||
|
|
||
| extension AnyCasePath: CustomDebugStringConvertible { | ||
| public var debugDescription: String { | ||
| "AnyCasePath<\(typeName(Root.self)), \(typeName(Value.self))>" | ||
| } | ||
| } | ||
|
|
||
| extension AnyCasePath { | ||
| @available( | ||
| iOS, deprecated: 9999, | ||
| message: "Use 'CasePathable.modify', or 'extract' and 'embed', instead." | ||
| ) | ||
| @available( | ||
| macOS, deprecated: 9999, | ||
| message: "Use 'CasePathable.modify', or 'extract' and 'embed', instead." | ||
| ) | ||
| @available( | ||
| tvOS, deprecated: 9999, | ||
| message: "Use 'CasePathable.modify', or 'extract' and 'embed', instead." | ||
| ) | ||
| @available( | ||
| watchOS, deprecated: 9999, | ||
| message: "Use 'CasePathable.modify', or 'extract' and 'embed', instead." | ||
| ) | ||
| public func modify<Result>( | ||
| _ root: inout Root, | ||
| _ body: (inout Value) throws -> Result | ||
| ) throws -> Result { | ||
| guard var value = self.extract(from: root) else { throw ExtractionFailed() } | ||
| let result = try body(&value) | ||
| root = self.embed(value) | ||
| return result | ||
| } | ||
|
|
||
| @available(iOS, deprecated: 9999, message: "Chain case key paths together, instead.") | ||
| @available(macOS, deprecated: 9999, message: "Chain case key paths together, instead.") | ||
| @available(tvOS, deprecated: 9999, message: "Chain case key paths together, instead.") | ||
| @available(watchOS, deprecated: 9999, message: "Chain case key paths together, instead.") | ||
| public func appending<AppendedValue>( | ||
| path: AnyCasePath<Value, AppendedValue> | ||
| ) -> AnyCasePath<Root, AppendedValue> { | ||
| AnyCasePath<Root, AppendedValue>( | ||
| embed: { self.embed(path.embed($0)) }, | ||
| extract: { self.extract(from: $0).flatMap(path.extract) } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| struct ExtractionFailed: Error {} |
This file contains 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,17 @@ | ||
| /// A type that provides a collection of all of its case paths. | ||
| /// | ||
| /// The ``CasePathable()`` macro automatically generates a conformance to this protocol. | ||
| /// | ||
| /// You can iterate over ``CasePathable/allCasePaths`` to get access to each individual case path: | ||
| /// | ||
| /// ```swift | ||
| /// @CasePathable enum Field { | ||
| /// case title(String) | ||
| /// case body(String | ||
| /// case isLive | ||
| /// } | ||
| /// | ||
| /// Array(Field.allCasePaths) // [\.title, \.body, \.isLive] | ||
| /// ``` | ||
| public protocol CasePathIterable: CasePathable | ||
| where AllCasePaths: Sequence, AllCasePaths.Element == PartialCaseKeyPath<Self> {} |
This file contains 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 @@ | ||
| /// A type that can reflect a case path from a given case. | ||
| /// | ||
| /// The ``CasePathable()`` macro automatically generates a conformance to this protocol on the | ||
| /// enum's ``CasePathable/AllCasePaths`` type. | ||
| /// | ||
| /// You can look up an enum's case path by passing it to ``subscript(root:)``: | ||
| /// | ||
| /// ```swift | ||
| /// @CasePathable | ||
| /// enum Field { | ||
| /// case title(String) | ||
| /// case body(String) | ||
| /// case isLive | ||
| /// } | ||
| /// | ||
| /// Field.allCasePaths[.title("Hello, Blob!")] // \.title | ||
| /// ``` | ||
| public protocol CasePathReflectable<Root> { | ||
| /// The enum type that can be reflected. | ||
| associatedtype Root: CasePathable | ||
|
|
||
| /// Returns the case key path for a given root value. | ||
| /// | ||
| /// - Parameter root: An root value. | ||
| /// - Returns: A case path to the root value. | ||
| subscript(root: Root) -> PartialCaseKeyPath<Root> { get } | ||
| } |
Oops, something went wrong.