Minor cleanup and bug fixes

Deprecated passing array as arg to with
Add more PHP8 code features

CHANGELOG.md

@@ -1,6 +1,17 @@
 Change Log
 ==========
 
+2021-10-27 - 3.1.0
+------------------
+
+ * fix bug in `GenerateRelationshipsToEagerLoad`
+
+2021-10-05
+----------
+
+ * deprecate passing an array as first argument on `with()`s
+ * use more PHP8 syntax in classes
+
 2021-01-25
 ----------
 

composer.json

@@ -13,10 +13,10 @@
         "php": ">=8.0",
         "ext-json":  "*",
         "doctrine/dbal": "~2.11",
-        "pagerfanta/pagerfanta": "~2.4",
+        "pagerfanta/pagerfanta": "~2.6",
         "pragmarx/ia-str": "^7.0",
         "somnambulist/attribute-model": "~2.0",
-        "somnambulist/collection": "~5.0"
+        "somnambulist/collection": "~5.2"
     },
     "require-dev": {
         "phpunit/phpunit": "~9.5",

src/ConnectionManager.php

@@ -14,7 +14,6 @@
  */
 final class ConnectionManager
 {
-
     private array $connections = [];
 
     public function __construct(array $connections)

src/EventSubscribers/IdentityMapClearerMessengerSubscriber.php

@@ -20,12 +20,8 @@
  */
 class IdentityMapClearerMessengerSubscriber implements EventSubscriberInterface
 {
-
-    private Manager $manager;
-
-    public function __construct(Manager $manager)
+    public function __construct(private Manager $manager)
     {
-        $this->manager = $manager;
     }
 
     public static function getSubscribedEvents()

src/EventSubscribers/IdentityMapClearerSubscriber.php

@@ -21,12 +21,8 @@
  */
 class IdentityMapClearerSubscriber implements EventSubscriberInterface
 {
-
-    private Manager $manager;
-
-    public function __construct(Manager $manager)
+    public function __construct(private Manager $manager)
     {
-        $this->manager = $manager;
     }
 
     public static function getSubscribedEvents()

src/Exceptions/ConnectionManagerException.php

@@ -13,7 +13,6 @@
  */
 class ConnectionManagerException extends Exception
 {
-
     public static function missingConnectionFor(string $model): self
     {
         return new self(sprintf('No connection found for "%s" or "default"', $model));

src/Exceptions/EntityNotFoundException.php

@@ -13,9 +13,8 @@
  */
 class EntityNotFoundException extends Exception
 {
-
     public static function noMatchingRecordFor(string $class, string $key, $id): self
     {
-        return new self(sprintf('Could not find a record for %s with %s and %s', $class, $key, $id));
+        return new self(sprintf('Could not find a record for %s with %s and %s', $class, $key, $id), 404);
     }
 }

src/Exceptions/JsonEncodingException.php

@@ -15,7 +15,6 @@
  */
 class JsonEncodingException extends RuntimeException
 {
-
     public static function failedToConvertModel(Model $model, string $error): JsonEncodingException
     {
         return new self(

src/Exceptions/NoResultsException.php

@@ -14,7 +14,6 @@
  */
 class NoResultsException extends Exception
 {
-
     private QueryBuilder $query;
 
     public function __construct(string $class, QueryBuilder $queryBuilder)

src/Manager.php

@@ -16,7 +16,6 @@
  */
 final class Manager
 {
-
     private static ?Manager $instance = null;
     private ConnectionManager $connections;
     private AttributeCaster $caster;

src/Model.php

@@ -31,7 +31,6 @@
  */
 abstract class Model extends AbstractModel implements Arrayable, Jsonable, JsonSerializable
 {
-
     /**
      * The table associated with the model
      */

src/ModelBuilder.php

@@ -62,7 +62,6 @@
  */
 class ModelBuilder implements Queryable
 {
-
     private Model $model;
     private ModelMetadata $meta;
     private QueryBuilder $query;
@@ -258,7 +257,7 @@ public function paginate(int $page = 1, int $perPage = 30): Pagerfanta
     /**
      * Set the relationships that should be eager loaded
      *
-     * @param mixed $relations Strings of relationship names, or an array
+     * @param mixed $relations Strings of relationship names
      *
      * @return $this
      */
@@ -472,6 +471,12 @@ public function where($expression, array $values = []): self
      */
     public function orWhere($expression, array $values = []): self
     {
+        if (is_callable($expression)) {
+            $expression($this);
+
+            return $this;
+        }
+
         $this->query->orWhere($expression);
 
         foreach ($values as $key => $value) {

src/ModelExporter.php

@@ -19,7 +19,6 @@
  */
 final class ModelExporter implements Jsonable
 {
-
     private Model $model;
     private array $attributes;
     private array $relationships;

src/ModelIdentityMap.php

@@ -17,7 +17,6 @@
  */
 final class ModelIdentityMap
 {
-
     private array $identityMap = [];
     private array $aliases = [];
     private array $relationships = [];

src/ModelMetadata.php

@@ -17,7 +17,6 @@
  */
 final class ModelMetadata
 {
-
     private Model $model;
     private string $table;
     private string $primaryKey;

src/PHPUnit/PHPUnitListener.php

@@ -26,7 +26,6 @@
  */
 class PHPUnitListener implements BeforeTestHook, AfterTestHook
 {
-
     public function executeAfterTest(string $test, float $time): void
     {
         Manager::clear();

src/PaginatorAdapter.php

@@ -14,7 +14,6 @@
  */
 final class PaginatorAdapter implements AdapterInterface
 {
-
     private ModelBuilder $builder;
 
     public function __construct(ModelBuilder $queryBuilder)

src/Relationships/AbstractRelationship.php

@@ -68,7 +68,6 @@
  */
 abstract class AbstractRelationship implements Queryable
 {
-
     /**
      * A prefix used to flag attributes generated by ReadModels
      *

src/Relationships/BelongsTo.php

@@ -17,7 +17,6 @@
  */
 class BelongsTo extends AbstractRelationship
 {
-
     protected string $foreignKey;
     protected string $ownerKey;
     protected bool $nullOnNotFound;

src/Relationships/BelongsToMany.php

@@ -19,7 +19,6 @@
  */
 class BelongsToMany extends AbstractRelationship
 {
-
     private string $joinTable;
     private string $joinTableSourceKey;
     private string $joinTableTargetKey;

src/Relationships/HasOne.php

@@ -17,7 +17,6 @@
  */
 class HasOne extends HasOneOrMany
 {
-
     private bool $nullOnNotFound;
 
     public function __construct(ModelBuilder $builder, Model $parent, string $foreignKey, string $localKey, bool $nullOnNotFound = true)

src/Relationships/HasOneOrMany.php

@@ -14,7 +14,6 @@
  */
 abstract class HasOneOrMany extends AbstractRelationship
 {
-
     protected string $foreignKey;
     protected string $localKey;
 

src/Relationships/HasOneToMany.php

@@ -17,7 +17,6 @@
  */
 class HasOneToMany extends HasOneOrMany
 {
-
     protected ?string $indexBy;
 
     public function __construct(ModelBuilder $builder, Model $parent, string $foreignKey, string $localKey, ?string $indexBy = null)

src/TypeCasters/DoctrineTypeCaster.php

@@ -19,12 +19,8 @@
  */
 final class DoctrineTypeCaster implements AttributeCasterInterface
 {
-
-    private Connection $connection;
-
-    public function __construct(Connection $connection)
+    public function __construct(private Connection $connection)
     {
-        $this->connection = $connection;
     }
 
     public function types(): array

src/Utils/ClassHelpers.php

@@ -84,7 +84,7 @@ public static function getCallingMethod(): string
      *
      * @return object
      */
-    public static function set(object $object, string $property, mixed $value, mixed $scope = null)
+    public static function set(object $object, string $property, mixed $value, mixed $scope = null): object
     {
         Closure::bind(function () use ($property, $value) {
             $this->{$property} = $value;
@@ -106,7 +106,7 @@ public static function set(object $object, string $property, mixed $value, mixed
      *
      * @return object
      */
-    public static function setPropertyArrayKey(object $object, string $property, string $key, mixed $value, mixed $scope = null)
+    public static function setPropertyArrayKey(object $object, string $property, string $key, mixed $value, mixed $scope = null): object
     {
         Closure::bind(function () use ($property, $key, $value) {
             $this->{$property}[$key] = $value;

src/Utils/FilterGeneratedKeysFromCollection.php

@@ -15,7 +15,6 @@
  */
 final class FilterGeneratedKeysFromCollection
 {
-
     /**
      * Filters out library generated keys from the set of attributes
      *

src/Utils/GenerateRelationshipsToEagerLoad.php

@@ -10,6 +10,7 @@
 use function implode;
 use function is_array;
 use function is_numeric;
+use function trigger_deprecation;
 
 /**
  * Class GenerateRelationshipsToEagerLoad
@@ -24,19 +25,19 @@
  */
 final class GenerateRelationshipsToEagerLoad
 {
-
     /**
      * Set the relationships that should be eager loaded
      *
      * @param array $toEagerLoad The default eager loads defined on the model
-     * @param mixed $relations   Strings of relationship names, or an array
+     * @param mixed $relations   Strings of relationship names
      *
      * @return array
      */
     public function __invoke(array $toEagerLoad = [], ...$relations): array
     {
-        if (is_array($relations[0])) {
+        if (count($relations) > 0 && is_array($relations[0])) {
             // if an array is passed, it will be the first arg and wont unpack
+            trigger_deprecation('somnambulist/read-models', '3.1.0', 'Passing an array as argument is deprecated, use multiple string arguments');
             $relations = $relations[0];
         }
 

src/Utils/ProxyTo.php

@@ -20,7 +20,6 @@
  */
 class ProxyTo
 {
-
     /**
      * Proxy a call into the specified object, collecting error information if it fails
      *