Merge branch 'refactor-sync'

Author: lkrms

composer.json

@@ -16,7 +16,7 @@
     "require": {
         "php": ">=7.4",
         "composer-runtime-api": "^2.2",
-        "lkrms/dice": "^4.1.9",
+        "lkrms/dice": "^4.1.10",
         "psr/container": "^2",
         "psr/event-dispatcher": "^1",
         "psr/http-client": "^1",
@@ -36,7 +36,7 @@
         "php-http/psr7-integration-tests": "^1.3",
         "phpstan/extension-installer": "^1",
         "phpstan/phpdoc-parser": "^1",
-        "phpstan/phpstan": "^1",
+        "phpstan/phpstan": "^1.11",
         "phpstan/phpstan-deprecation-rules": "^1",
         "phpstan/phpstan-phpunit": "^1",
         "phpunit/phpunit": "^9",

composer.lock

@@ -76,5 +76,5 @@ $opt = Option::build()  // or `$opt = (new OptionBuilder())` if `Option` doesn't
     ->type(OptionType::VALUE)
     ->valueType(ValueType::STRING)
     ->description('Write output to <FILE>')
-    ->go();
+    ->build();
 ```

docs/Builders.md

@@ -7,9 +7,9 @@ performs one or more [sync operations][SyncOperation] on supported [entity
 classes][SyncEntityInterface] to propagate data to and from a backend.
 
 For a provider to perform sync operations on entities of a given type, it must
-also implement the entity's provider interface. Aside from entities in
-namespaces registered with a [class resolver][SyncClassResolverInterface], the
-provider interface is assumed to be:
+also implement the entity's provider interface, which--aside from entities in
+namespaces with a registered [class resolver][SyncClassResolverInterface]--has
+the following name:
 
 ```
 <entity-namespace>\Provider\<entity>Provider
@@ -31,21 +31,21 @@ vendor/bin/sli generate sync provider --magic --op 'get,get-list' 'Acme\Sync\Use
 
 To map entity classes to different provider interfaces (or multiple entities to
 one interface, perhaps), you can provide a [SyncClassResolverInterface][] to the
-entity store when registering a namespace. See [Sync::namespace()][namespace]
-for details and [this test fixture][SyncClassResolver.php] for a working example
-that would map `Acme\Sync\Entity\User` to `Acme\Sync\Contract\ProvidesUser`.
+entity store when registering a namespace. See [registerNamespace()][] for
+details and [this test fixture][SyncClassResolver.php] for a working example
+that maps `Acme\Sync\Entity\User` to `Acme\Sync\Contract\ProvidesUser`.
 
 #### Operations
 
 To perform a sync operation on an [entity][SyncEntityInterface], a
 [SyncProviderInterface][] must implement its provider interface and either:
 
 1. return a closure for the [SyncOperation][] and entity via
-   [getDefinition()][getDefinition], or
+   [getDefinition()][], or
 2. declare a method for the operation using the naming convention below.
 
 In either case, the signature for the implemented operation must be as follows.
-The first value passed is always the current [SyncContextInterface] and
+The first value passed is always the current [SyncContextInterface][] and
 **optional** arguments may be accepted after mandatory parameters.
 
 | Operation[^op]  | Closure signature                                                                           | Equivalent method[^1]    | Alternative method[^2] |
@@ -59,7 +59,7 @@ The first value passed is always the current [SyncContextInterface] and
 | `UPDATE_LIST`   | `fn(SyncContextInterface $ctx, iterable $entities, ...$args): iterable`                     | `update<EntityPlural>`   | `updateList_<Entity>`  |
 | `DELETE_LIST`   | `fn(SyncContextInterface $ctx, iterable $entities, ...$args): iterable`                     | `delete<EntityPlural>`   | `deleteList_<Entity>`  |
 
-[^op]: See [SyncOperation].
+[^op]: See [SyncOperation][].
 [^1]:
     Method names must match either the singular or plural form of the entity's
     unqualified name.
@@ -69,23 +69,23 @@ The first value passed is always the current [SyncContextInterface] and
     Method names must match the entity's unqualified name.
 
 [^3]:
-    See [SyncContextInterface::withFilter()][withFilter] for filter argument
+    See [SyncContextInterface::withFilter()][] for filter argument
     recommendations, including recognised signatures.
 
-[getDefinition]:
+[getDefinition()]:
   https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncProviderInterface.html#_getDefinition
+[registerNamespace()]:
+  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncStoreInterface.html#_registerNamespace
+[SyncClassResolver.php]: ../tests/fixtures/Toolkit/Sync/SyncClassResolver.php
+[SyncClassResolverInterface]:
+  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncClassResolverInterface.html
+[SyncContextInterface::withFilter()]:
+  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncContextInterface.html#_withFilter
 [SyncContextInterface]:
   https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncContextInterface.html
 [SyncEntityInterface]:
   https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncEntityInterface.html
-[SyncProviderInterface]:
-  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncProviderInterface.html
-[SyncClassResolverInterface]:
-  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncClassResolverInterface.html
 [SyncOperation]:
   https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncOperation.html
-[withFilter]:
-  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncContextInterface.html#_withFilter
-[namespace]:
-  https://salient-labs.github.io/toolkit/Salient.Sync.SyncStore.html#_namespace
-[SyncClassResolver.php]: ../tests/fixtures/Toolkit/Sync/SyncClassResolver.php
+[SyncProviderInterface]:
+  https://salient-labs.github.io/toolkit/Salient.Contract.Sync.SyncProviderInterface.html