Updated documentation.

Author: ABridoux

Sources/SafeFetching/Predicate/Types/Predicate.swift

@@ -9,6 +9,7 @@ import CoreData
 
 extension Builders {
 
+    /// Generated from ``FetchableMember`` operations to wrap a `NSPredicate`.
     public class Predicate<Entity: Fetchable> {
 
         // MARK: Type alias

Sources/SafeFetching/Request/FetchableMember.swift

@@ -11,6 +11,7 @@ public struct FetchableMember<Entity: Fetchable, Value>: Sendable {
 
     // MARK: Properties
 
+    /// Attribute or relationship identifier used to generate `NSPredicate`.
     public let identifier: String
 
     // MARK: Init

Sources/SafeFetching/SafeFetching.docc/Articles/build-predicates.md

@@ -6,17 +6,16 @@ Examples in the article refer to this entity.
 
 ```swift
 @FetchableManagedObject
-final class StubEntity: NSManagedObject {
+final class User: NSManagedObject {
     @NSManaged var score = 0.0
     @NSManaged var name: String? = ""
 }
 ```
 
-When building a request, the ``Builders/Request/where(_:)-5uzqj`` operation allows to specify a predicate. For a demonstration purpose in this article, predicates are specified after their implicit declaration.
+When building a request, the ``Builders/Request/where(_:)-5uzqj`` operation allows to specify a predicate. For a demonstration purpose in this article, predicates are specified after their implicit declaration, as shown below.
 
 ```swift
-let predicate: Builders.Predicate<StubEntity>
-$0.name == "Toto"
+let predicate: Builders.Predicate<User> = .predicate { $0.name == "Toto" }
 ```
 
 ## Comparison
@@ -71,7 +70,7 @@ Inversion is supported.
 
 
 ## Advanced Operations
-It's possible to use the advanced operators offered by `NSPredicate` safely by specifying calling the dedicated function from the ``FetchableMember``.
+It's possible to use the advanced operators offered by `NSPredicate` safely by calling the dedicated function from ``FetchableMember``.
 
 ###### Has Prefix (String property)
 
@@ -105,7 +104,7 @@ $0.score.isIn(10...20)
 (10...20).contains($0.score)
 ```
 
-###### Matches a Regular Expression (string property)
+###### Matches a Regular Expression (String property)
 
 ```swift
 $0.name.matches("[A-Za-z]{3}")
@@ -159,12 +158,12 @@ $0.score.isIn(20..<40)
 ```
 
 ## RawRepresentable
-`RawRepresentable` types can be used in the predicate when they conform to ``DatabaseValue`` (and thus can be stored as their raw value in the CoreData store).
+`RawRepresentable` types can be used in the predicate when they conform to ``DatabaseValue`` and ``DatabaseTestValue`` (and thus can be stored as their raw value in the CoreData store).
 
 For instance with the `Colors` enum:
 
 ```swift
-struct Colors: String {
+struct Colors: String, DatabaseValue, DatabaseTestValue {
     case red
     case blue
     case green
@@ -212,11 +211,11 @@ other modules.
 
 ### OptionSet
 
-With an option set, it's advised to rather use the `intersects` predicates.
+With an `OptionSet`, it's advised to rather use the `intersects` predicates.
 For instance with the `Colors` option set:
 
 ```swift
-struct Colors: OptionSet {
+struct Colors: OptionSet, DatabaseValue, DatabaseTestValue {
     let rawValue: Int
 
     static let red = StubOptionSet(rawValue: 1 << 0)
@@ -235,26 +234,14 @@ $0.color.intersects([.red, .blue])
 [.red, .blue].intersects($0.color)
 ```
 
-### Comparing Option Set Values
-
-Do note that
-```swift
-$0.color.intersects(.blue)
-```
-
-is only the same as
-
-```swift
-$0.color == .blue
-```
-*when the stored `color` is a single option*. 
+> Note: `$0.color.intersects(.blue)` is only the same as `$0.color == .blue` when the stored `color` is a single option. 
 
 ## Relationships
 Predicates in SafeFetching support relationships. Given the two entities:
 
 ```swift
 @FetchableManagedObject
-final class StubEntity: NSManagedObject {
+final class User: NSManagedObject {
     @NSManaged var score = 0.0
     @NSManaged var pet: Pet?
 }

Sources/SafeFetching/SafeFetching.docc/Articles/build-requests.md

@@ -2,7 +2,7 @@
 
 Learn how to build requests with the SafeFetching DSL.
 
-Examples in the article refer to this `User`class.
+Examples in the article refer to this `User` class.
 
 ```swift
 @FetchableManagedObject
@@ -107,13 +107,13 @@ Naming the parameter can sometimes be preferable for longer predicates.
 ```swift
 User.request()
     .all()
-    .where { members in 
-        members.score > 20 && members.name.contains("dore")
-        || !members.isAdmin
+    .where { user in 
+        user.score > 20 && user.name.contains("dore")
+        || !user.isAdmin
     }
 ```
 
-To learn more about building predicates, you can read <doc:build-predicates>.
+To learn more about predicates, you can read <doc:build-predicates>.
 
 ### Sort
 After the target has been specified, one sort or more can be set to the request with ``Builders/Request/sorted(by:_:)``.

Sources/SafeFetching/SafeFetching.docc/Articles/getting-started.md

@@ -61,7 +61,7 @@ try User.request()
     .fetch(in: context) // [User]
 ```
 
-The `where(_:)` expects a predicate built on the provided `User.FetchableMembers` that is then converted to a `NSPredicate` with the appropriate format. The predicate is built using operators overloads or extensions on `FetchableMember`. Write more complex predicates still feels natural.
+The `where(_:)` expects a predicate built on the provided `User.FetchableMembers` that is then converted to a `NSPredicate` with the appropriate format. The predicate is built using operators overloads or extensions on `FetchableMember`. Writing more complex predicates still feels natural.
 
 ```swift
 try User.request()

Sources/SafeFetching/SafeFetching.docc/FetchableMember.md

@@ -0,0 +1,43 @@
+# ``SafeFetching/FetchableMember``
+
+## Topics
+
+### Identifier
+
+- ``identifier``
+
+### Initializer
+
+- ``init(identifier:)``
+
+### String
+
+- ``contains(_:options:)``
+- ``hasPrefix(_:options:)``
+- ``hasSuffix(_:options:)``
+
+### OptionSet
+
+- ``intersects(_:)``
+
+### Collection
+
+- ``isIn(_:)-6ue9b``
+- ``isIn(_:)-1652j``
+- ``isIn(_:)-5vms8``
+
+### Range
+
+- ``isIn(_:)-7lmi8``
+- ``isIn(_:)-1om8b``
+
+### Regular Expression
+
+- ``matches(_:options:)``
+
+### Relationship Member
+
+Allows to write naturally `$0.relationship.property` and generate the proper predicate.
+
+- ``subscript(dynamicMember:)-ubmi``
+- ``subscript(dynamicMember:)-18job``

docs/data/documentation/safefetching.json

@@ -1 +1 @@
-{"identifier":{"url":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/safefetching\/!(_:)-1nel2"]}],"metadata":{"modules":[{"name":"SafeFetching"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","kind":"typeIdentifier","text":"Predicate"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:12SafeFetching8BuildersO","kind":"typeIdentifier","text":"Builders"},{"kind":"text","text":"."},{"preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","kind":"typeIdentifier","text":"Predicate"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"title":"!(_:)","externalID":"s:12SafeFetching1nopyAA8BuildersO9PredicateCy_xGAgA9FetchableRzlF","roleHeading":"Operator","symbolKind":"op"},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Builders","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Predicate","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Builders","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Predicate","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":"> "},{"kind":"keyword","text":"where"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":" : "},{"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable","preciseIdentifier":"s:12SafeFetching9FetchableP","kind":"typeIdentifier","text":"Fetchable"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/SafeFetching\/documentation\/SafeFetching"]]},"sections":[],"kind":"symbol","references":{"doc://SafeFetching/documentation/SafeFetching/Builders":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Builders"}],"navigatorTitle":[{"kind":"identifier","text":"Builders"}],"role":"symbol","title":"Builders","kind":"symbol","abstract":[{"type":"text","text":"Namespace to hide most building types used by SafeFetching to make requests."}],"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","url":"\/documentation\/safefetching\/builders","type":"topic"},"doc://SafeFetching/documentation/SafeFetching/!(_:)-1nel2":{"title":"!(_:)","url":"\/documentation\/safefetching\/!(_:)-1nel2","type":"topic","abstract":[],"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"E"},{"kind":"text","text":">("},{"kind":"typeIdentifier","text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"kind":"text","text":"<"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://SafeFetching/documentation/SafeFetching/Builders/Predicate":{"title":"Builders.Predicate","type":"topic","url":"\/documentation\/safefetching\/builders\/predicate","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Predicate"}],"abstract":[],"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Predicate"}],"kind":"symbol"},"doc://SafeFetching/documentation/SafeFetching":{"url":"\/documentation\/safefetching","abstract":[{"type":"text","text":"Convenience functions around "},{"type":"codeVoice","code":"CoreData"},{"type":"text","text":" fetching."}],"title":"SafeFetching","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching","kind":"symbol","type":"topic","role":"collection"},"doc://SafeFetching/documentation/SafeFetching/Fetchable":{"type":"topic","abstract":[{"text":"Implemented by a ","type":"text"},{"code":"NSManagedObject","type":"codeVoice"},{"text":" to offer fetching using SafeFetching API.","type":"text"}],"url":"\/documentation\/safefetching\/fetchable","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable","title":"Fetchable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Fetchable","kind":"identifier"}],"navigatorTitle":[{"text":"Fetchable","kind":"identifier"}],"kind":"symbol","role":"symbol"}}}
+{"hierarchy":{"paths":[["doc:\/\/SafeFetching\/documentation\/SafeFetching"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2"},"variants":[{"paths":["\/documentation\/safefetching\/!(_:)-1nel2"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"op","roleHeading":"Operator","modules":[{"name":"SafeFetching"}],"externalID":"s:12SafeFetching1nopyAA8BuildersO9PredicateCy_xGAgA9FetchableRzlF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"text":"E","kind":"genericParameter"},{"kind":"text","text":">("},{"kind":"typeIdentifier","text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Builders","preciseIdentifier":"s:12SafeFetching8BuildersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Predicate","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"!(_:)"},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Builders","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders"},{"text":".","kind":"text"},{"text":"Predicate","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Builders","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders"},{"text":".","kind":"text"},{"text":"Predicate","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate"},{"text":"<","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Fetchable","kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching9FetchableP","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable"}],"languages":["swift"]}]}],"references":{"doc://SafeFetching/documentation/SafeFetching/!(_:)-1nel2":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"E"},{"kind":"text","text":">("},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","text":"Predicate"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO","text":"Builders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:12SafeFetching8BuildersO9PredicateC","text":"Predicate"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"url":"\/documentation\/safefetching\/!(_:)-1nel2","role":"symbol","abstract":[],"identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/!(_:)-1nel2","kind":"symbol","type":"topic","title":"!(_:)"},"doc://SafeFetching/documentation/SafeFetching/Builders":{"type":"topic","url":"\/documentation\/safefetching\/builders","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Builders"}],"abstract":[{"type":"text","text":"Namespace to hide most building types used by SafeFetching to make requests."}],"role":"symbol","title":"Builders","navigatorTitle":[{"kind":"identifier","text":"Builders"}],"kind":"symbol"},"doc://SafeFetching/documentation/SafeFetching/FetchableMember":{"role":"symbol","abstract":[{"text":"Stores types and identifier of an entity and attribute or relationship that can be used for fetching.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FetchableMember","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/FetchableMember","url":"\/documentation\/safefetching\/fetchablemember","kind":"symbol","navigatorTitle":[{"text":"FetchableMember","kind":"identifier"}],"title":"FetchableMember"},"doc://SafeFetching/documentation/SafeFetching/Fetchable":{"title":"Fetchable","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Fetchable","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Fetchable","kind":"identifier"}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Fetchable","kind":"identifier"}],"abstract":[{"type":"text","text":"Implemented by a "},{"type":"codeVoice","code":"NSManagedObject"},{"type":"text","text":" to offer fetching using SafeFetching API."}],"url":"\/documentation\/safefetching\/fetchable"},"doc://SafeFetching/documentation/SafeFetching":{"role":"collection","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching","kind":"symbol","abstract":[{"type":"text","text":"Convenience functions around "},{"type":"codeVoice","code":"CoreData"},{"type":"text","text":" fetching."}],"type":"topic","title":"SafeFetching","url":"\/documentation\/safefetching"},"doc://SafeFetching/documentation/SafeFetching/Builders/Predicate":{"title":"Builders.Predicate","kind":"symbol","abstract":[{"text":"Generated from ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/FetchableMember"},{"text":" operations to wrap a ","type":"text"},{"type":"codeVoice","code":"NSPredicate"},{"text":".","type":"text"}],"navigatorTitle":[{"text":"Predicate","kind":"identifier"}],"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Predicate","kind":"identifier"}],"type":"topic","url":"\/documentation\/safefetching\/builders\/predicate","role":"symbol","identifier":"doc:\/\/SafeFetching\/documentation\/SafeFetching\/Builders\/Predicate"}}}