Cleaned up

Author: rimi-itk

README.md

@@ -10,6 +10,10 @@ See the [F2 REST API documentation](resources/f2-rest-docs/f2-rest-docs-v13s.htm
 composer require itk-dev/f2-api-client
 ```
 
+## Usage
+
+See [F2ApiClientCommand](src/Command/F2ApiClientCommand.php) for an example usage.
+
 ## Testing
 
 Edit `.env.local` and set these variables:

phpstan.dist.neon

@@ -4,13 +4,3 @@ parameters:
         - src
 
     treatPhpDocTypesAsCertain: false
-
-    ignoreErrors:
-        - message: '#Method ItkDev\\F2ApiClient\\ApiClient::[^ ]+\(\) has parameter \$[^ ]+ with no value type specified in iterable type array.#'
-          path: src/*
-
-        - message: '#Method ItkDev\\F2ApiClient\\Model\\[^ ]+::jsonSerialize\(\) return type has no value type specified in iterable type array.#'
-          path: src/*
-
-        - message: '#Method ItkDev\\F2ApiClient\\Command\\F2ApiClientCommand::responseToArray\(\) has parameter \$response with no value type specified in iterable type array.#'
-          path: src/Command/F2ApiClientCommand.php

src/ApiClient.php

@@ -682,10 +682,8 @@ public function getLinkCollection(AbstractF2Item $item, string $rel): Collection
 
     private function computeDiff(AbstractF2Item $old, AbstractF2Item $new): JsonDiff
     {
-        $oldValues = $old->jsonSerialize();
-        $newValues = $new->jsonSerialize();
-
-        // @todo Filter out some values, e.g. timestamps.
+        $oldValues = $old::filterForJsonPatch($old->jsonSerialize());
+        $newValues = $new::filterForJsonPatch($new->jsonSerialize());
 
         return new JsonDiff($oldValues, $newValues, options: JsonDiff::SKIP_TEST_OPS);
     }

src/Command/F2ApiClientCommand.php

@@ -82,6 +82,8 @@ private function createClient(?string $cacheDirectory): ApiClient
     }
 
     /**
+     * @param AbstractItem|array<array-key, mixed> $response
+     *
      * @return array<array-key, mixed>
      */
     private function responseToArray(array|AbstractItem $response): array

src/Model/AbstractF2Item.php

@@ -6,7 +6,7 @@
 
 use ItkDev\F2ApiClient\Model\F2Item\Links;
 
-abstract class AbstractF2Item extends AbstractItem implements \Stringable
+abstract class AbstractF2Item extends AbstractItem
 {
     public ?int $id = null;
     public Links $links;
@@ -34,6 +34,10 @@ public function __toString(): string
 
     /**
      * Serialize with the names (paths) needed for JSON patch.
+     *
+     * Only names starting with a capital letter will be included in JSON patch'ing (cf. self::filterForJsonPatch).
+     *
+     * @see self::filterForJsonPatch()
      */
     #[\Override]
     public function jsonSerialize(): array
@@ -43,4 +47,19 @@ public function jsonSerialize(): array
             'links' => $this->links->jsonSerialize(),
         ];
     }
+
+    /**
+     * @param array<string, mixed> $values
+     *
+     * @return array<string, mixed>
+     */
+    public static function filterForJsonPatch(array $values): array
+    {
+        // Keep only keys starting with a capital letter.
+        return array_filter(
+            $values,
+            static fn (string $key) => ucfirst($key) === $key,
+            ARRAY_FILTER_USE_KEY,
+        );
+    }
 }

src/Model/AbstractItem.php

@@ -47,6 +47,11 @@ protected function createDateTime(\SimpleXMLElement|string $value): \DateTimeImm
         return (new \DateTimeImmutable((string) $value, $apiTimeZone))->setTimeZone($appTimeZone);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    abstract public function jsonSerialize(): array;
+
     protected function jsonSerializeDateTime(?\DateTimeImmutable $dateTime): ?string
     {
         return $dateTime?->format(\DateTimeInterface::ATOM);

src/Model/CaseFile.php

@@ -65,14 +65,15 @@ public function jsonSerialize(): array
             'CaseNumber' => $this->caseNumber,
             'Title' => $this->title,
             'Closed' => $this->closed,
-            'JournalPlan' => $this->journalPlan->jsonSerialize(),
-            'ProcessInstruction' => $this->processInstruction->jsonSerialize(),
             'Deadline' => $this->deadline,
-            'CreatedDate' => $this->jsonSerializeDateTime($this->createdDate),
-            'ModifiedDate' => $this->jsonSerializeDateTime($this->modifiedDate),
-            'ModifiedBy' => $this->modifiedBy->jsonSerialize(),
-            'Responsible' => $this->responsible?->jsonSerialize(),
-            'Matters' => array_map(static fn (Matter $matter) => $matter->jsonSerialize(), $this->matters),
+
+            'journalPlan' => $this->journalPlan->jsonSerialize(),
+            'processInstruction' => $this->processInstruction->jsonSerialize(),
+            'createdDate' => $this->jsonSerializeDateTime($this->createdDate),
+            'modifiedDate' => $this->jsonSerializeDateTime($this->modifiedDate),
+            'modifiedBy' => $this->modifiedBy->jsonSerialize(),
+            'responsible' => $this->responsible?->jsonSerialize(),
+            'matters' => array_map(static fn (Matter $matter) => $matter->jsonSerialize(), $this->matters),
         ] + parent::jsonSerialize();
     }
 }

src/Model/Collection/Item.php

@@ -6,7 +6,7 @@
 
 use ItkDev\F2ApiClient\Model\AbstractF2Item;
 
-final class Item extends AbstractF2Item implements \JsonSerializable
+final class Item extends AbstractF2Item
 {
     public string $title;
 

src/Model/Document.php

@@ -38,8 +38,9 @@ public function jsonSerialize(): array
         return [
             'Title' => $this->title,
             'Description' => $this->description,
-            'CreatedDate' => $this->jsonSerializeDateTime($this->createdDate),
-            'ModifiedDate' => $this->jsonSerializeDateTime($this->modifiedDate),
+
+            'createdDate' => $this->jsonSerializeDateTime($this->createdDate),
+            'modifiedDate' => $this->jsonSerializeDateTime($this->modifiedDate),
         ] + parent::jsonSerialize();
     }
 }

src/Model/F2Item/Links.php

@@ -5,18 +5,25 @@
 namespace ItkDev\F2ApiClient\Model\F2Item;
 
 use ItkDev\F2ApiClient\Exception\RuntimeException;
+use ItkDev\F2ApiClient\Model\AbstractItem;
 
 /**
  * @phpstan-type Link array{rel: string, href: string, title:string}
  */
-final class Links implements \JsonSerializable
+final class Links extends AbstractItem
 {
     public function __construct(
         /** @var array<string, Link> */
         private readonly array $links,
     ) {
     }
 
+    #[\Override]
+    public function __toString(): string
+    {
+        return self::class;
+    }
+
     // @mago-ignore analysis:non-documented-property
     public static function fromSimpleXMLElement(\SimpleXMLElement $sxe): static
     {