Add readonly where possible

README.md

@@ -168,7 +168,5 @@ This library is heavily inspired by Benjamin Eberlei's [blog post][blog_post]
 and [Happyr's Doctrine-Specification library][happyr_spec].
 
 [specification_pattern]: http://en.wikipedia.org/wiki/Specification_pattern
-
 [happyr_spec]: https://github.com/Happyr/Doctrine-Specification
-
 [blog_post]: http://www.whitewashing.de/2013/03/04/doctrine_repositories.html

spec/Condition/NotInSpec.php

@@ -6,7 +6,7 @@
 use Doctrine\ORM\Query\Expr;
 use Doctrine\ORM\QueryBuilder;
 use PhpSpec\ObjectBehavior;
-use Purist\Specification\Doctrine\Condition\In;
+use Purist\Specification\Doctrine\Condition\NotIn;
 use Purist\Specification\Doctrine\SpecificationInterface;
 
 class NotInSpec extends ObjectBehavior
@@ -23,7 +23,7 @@ public function let(): void
     public function it_is_an_expression(): void
     {
         $this->shouldBeAnInstanceOf(SpecificationInterface::class);
-        $this->shouldBeAnInstanceOf(In::class);
+        $this->shouldBeAnInstanceOf(NotIn::class);
     }
 
     public function it_returns_an_expression_func_object(QueryBuilder $queryBuilder, ArrayCollection $parameters, Expr $expr): void

spec/Logic/NotSpec.php

@@ -11,7 +11,7 @@ class NotSpec extends ObjectBehavior
 {
     public function let(SpecificationInterface $condition): void
     {
-        $this->beConstructedWith($condition, null);
+        $this->beConstructedWith($condition);
     }
 
     public function it_calls_parent_match(QueryBuilder $queryBuilder, Expr $expr, SpecificationInterface $condition): void
@@ -32,16 +32,16 @@ public function it_calls_parent_match(QueryBuilder $queryBuilder, Expr $expr, Sp
     public function it_modifies_parent_query(QueryBuilder $queryBuilder, SpecificationInterface $specification): void
     {
         $dqlAlias = 'a';
-        $this->beConstructedWith($specification, null);
+        $this->beConstructedWith($specification);
 
-        $specification->modify($queryBuilder, $dqlAlias)->shouldBeCalled();
+        $specification->modify($queryBuilder, $dqlAlias)->shouldBeCalled()->willReturn(null);
         $this->modify($queryBuilder, $dqlAlias);
     }
 
     public function it_should_call_supports_on_parent(SpecificationInterface $specification): void
     {
         $className = 'foo';
-        $this->beConstructedWith($specification, null);
+        $this->beConstructedWith($specification);
 
         $specification->isSatisfiedBy($className)->shouldBeCalled();
 

spec/Query/HavingSpec.php

@@ -38,33 +38,30 @@ public function it_calls_having_on_query_builder(QueryBuilder $queryBuilder, Spe
     {
         $condition = 'foo';
         $specification->modify($queryBuilder, $this->dqlAlias)->willReturn($condition);
-
-        $this->setType(Having::HAVING);
         $queryBuilder->having($condition)->shouldBeCalled()->willReturn($queryBuilder);
 
-        $this->modify($queryBuilder, $this->dqlAlias);
+        $having = $this->setType(Having::HAVING);
+        $having->modify($queryBuilder, $this->dqlAlias);
     }
 
     public function it_calls_andHaving_on_query_builder(QueryBuilder $queryBuilder, SpecificationInterface $specification): void
     {
         $condition = 'foo';
         $specification->modify($queryBuilder, $this->dqlAlias)->willReturn($condition);
-
-        $this->setType(Having::AND_HAVING);
         $queryBuilder->andHaving($condition)->shouldBeCalled()->willReturn($queryBuilder);
 
-        $this->modify($queryBuilder, $this->dqlAlias);
+        $having = $this->setType(Having::AND_HAVING);
+        $having->modify($queryBuilder, $this->dqlAlias);
     }
 
     public function it_calls_orHaving_on_query_builder(QueryBuilder $queryBuilder, SpecificationInterface $specification): void
     {
         $condition = 'foo';
         $specification->modify($queryBuilder, $this->dqlAlias)->willReturn($condition);
-
-        $this->setType(Having::OR_HAVING);
         $queryBuilder->orHaving($condition)->shouldBeCalled()->willReturn($queryBuilder);
 
-        $this->modify($queryBuilder, $this->dqlAlias);
+        $having = $this->setType(Having::OR_HAVING);
+        $having->modify($queryBuilder, $this->dqlAlias);
     }
 
     public function it_throws_exception_when_setting_illegal_type(): void

spec/Query/JoinSpec.php

@@ -13,7 +13,7 @@ class JoinSpec extends ObjectBehavior
 {
     public function let(): void
     {
-        $this->beConstructedWith('user', 'authUser', 'a');
+        $this->beConstructedWith('user', 'authUser', Join::JOIN, 'a');
     }
 
     public function it_is_a_specification(): void
@@ -46,12 +46,11 @@ public function it_should_use_be_able_to_use_join_conditions(QueryBuilder $query
 
         $this->beConstructedWith('user', 'authUser');
 
-        $this->setConditionType($joinType)->shouldReturn($this);
-        $this->setCondition($joinCondition)->shouldReturn($this);
+        $join = $this->setConditionType($joinType)->setCondition($joinCondition);
 
         $queryBuilder->join('a.user', 'authUser', $joinType, $joinCondition, null)->shouldBeCalled()->willReturn($queryBuilder);
 
-        $this->modify($queryBuilder, 'a');
+        $join->modify($queryBuilder, 'a');
     }
 
     public function it_should_be_able_to_set_index_by_for_join(QueryBuilder $queryBuilder): void
@@ -62,9 +61,9 @@ public function it_should_be_able_to_set_index_by_for_join(QueryBuilder $queryBu
 
         $queryBuilder->join('a.user', 'authUser', null, null, $indexedBy)->shouldBeCalled()->willReturn($queryBuilder);
 
-        $this->setIndexedBy($indexedBy)->shouldReturn($this);
+        $join = $this->setIndexedBy($indexedBy);
 
-        $this->modify($queryBuilder, 'a');
+        $join->modify($queryBuilder, 'a');
     }
 
     public function it_should_accept_specifications_as_condition(QueryBuilder $queryBuilder, SpecificationInterface $specification): void
@@ -78,9 +77,8 @@ public function it_should_accept_specifications_as_condition(QueryBuilder $query
 
         $queryBuilder->join('a.user', 'authUser', $type, $condition, null)->shouldBeCalled()->willReturn($queryBuilder);
 
-        $this->setConditionType($type)->shouldReturn($this);
-        $this->setCondition($specification)->shouldReturn($this);
-        $this->modify($queryBuilder, 'a');
+        $join = $this->setConditionType($type)->setCondition($specification);
+        $join->modify($queryBuilder, 'a');
     }
 
     public function it_throws_an_exception_when_setting_illegal_type(): void

src/AbstractSpecification.php

@@ -2,7 +2,7 @@
 
 namespace Purist\Specification\Doctrine;
 
-abstract class AbstractSpecification implements SpecificationInterface
+abstract readonly class AbstractSpecification implements SpecificationInterface
 {
     public function __construct(protected string $field, protected ?string $dqlAlias = null)
     {
@@ -31,7 +31,7 @@ protected function createAliasedName(string $value, ?string $dqlAlias): string
             return $value;
         }
 
-        if (null !== $this->dqlAlias && '' !== $this->dqlAlias && '0' !== $this->dqlAlias) {
+        if (null !== $this->dqlAlias) {
             $dqlAlias = $this->dqlAlias;
         }
 

src/Condition/Between.php

@@ -5,7 +5,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Purist\Specification\Doctrine\AbstractSpecification;
 
-class Between extends AbstractSpecification
+readonly class Between extends AbstractSpecification
 {
     public function __construct(string $field, protected mixed $from, protected mixed $to, ?string $dqlAlias = null)
     {

src/Condition/Comparison.php

@@ -7,39 +7,29 @@
 use Purist\Specification\Doctrine\AbstractSpecification;
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class Comparison extends AbstractSpecification
+readonly class Comparison extends AbstractSpecification
 {
     public const string EQ = '=';
-
     public const string NEQ = '<>';
-
     public const string LT = '<';
-
     public const string LTE = '<=';
-
     public const string GT = '>';
-
     public const string GTE = '>=';
-
     public const string LIKE = 'LIKE';
-
     /**
      * @var string[]
      */
-    protected static array $operators = [self::EQ, self::NEQ, self::LT, self::LTE, self::GT, self::GTE, self::LIKE];
-    protected string $operator;
+    protected const array OPERATORS = [self::EQ, self::NEQ, self::LT, self::LTE, self::GT, self::GTE, self::LIKE];
 
     /**
      * @throws InvalidArgumentException
      */
-    public function __construct(string $operator, string $field, protected string $value, ?string $dqlAlias = null)
+    public function __construct(protected string $operator, string $field, protected string $value, ?string $dqlAlias = null)
     {
-        if (!in_array($operator, self::$operators, true)) {
-            throw new InvalidArgumentException(sprintf('"%s" is not a valid operator. Valid operators: %s', $operator, implode(', ', self::$operators)));
+        if (!in_array($operator, self::OPERATORS, true)) {
+            throw new InvalidArgumentException(sprintf('"%s" is not a valid operator. Valid operators: %s', $operator, implode(', ', self::OPERATORS)));
         }
 
-        $this->operator = $operator;
-
         parent::__construct($field, $dqlAlias);
     }
 

src/Condition/Equals.php

@@ -4,7 +4,7 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class Equals extends Comparison
+readonly class Equals extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/EqualsProperty.php

@@ -6,7 +6,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class EqualsProperty extends Comparison
+readonly class EqualsProperty extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/GreaterThan.php

@@ -4,7 +4,7 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class GreaterThan extends Comparison
+readonly class GreaterThan extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/GreaterThanOrEquals.php

@@ -4,7 +4,7 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class GreaterThanOrEquals extends Comparison
+readonly class GreaterThanOrEquals extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/In.php

@@ -5,7 +5,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Purist\Specification\Doctrine\AbstractSpecification;
 
-class In extends AbstractSpecification
+readonly class In extends AbstractSpecification
 {
     public function __construct(string $field, protected mixed $value, ?string $dqlAlias = null)
     {

src/Condition/IsInstanceOf.php

@@ -5,7 +5,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Purist\Specification\Doctrine\AbstractSpecification;
 
-class IsInstanceOf extends AbstractSpecification
+readonly class IsInstanceOf extends AbstractSpecification
 {
     public function __construct(string $field, private string $className, ?string $dqlAlias = null)
     {

src/Condition/IsMemberOf.php

@@ -5,7 +5,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Purist\Specification\Doctrine\AbstractSpecification;
 
-class IsMemberOf extends AbstractSpecification
+readonly class IsMemberOf extends AbstractSpecification
 {
     public function __construct(string $field, private string $className, ?string $dqlAlias = null)
     {

src/Condition/IsNotNull.php

@@ -3,8 +3,9 @@
 namespace Purist\Specification\Doctrine\Condition;
 
 use Doctrine\ORM\QueryBuilder;
+use Purist\Specification\Doctrine\AbstractSpecification;
 
-class IsNotNull extends IsNull
+readonly class IsNotNull extends AbstractSpecification
 {
     #[\Override]
     public function modify(QueryBuilder $queryBuilder, ?string $dqlAlias = null): string

src/Condition/IsNull.php

@@ -5,7 +5,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Purist\Specification\Doctrine\AbstractSpecification;
 
-class IsNull extends AbstractSpecification
+readonly class IsNull extends AbstractSpecification
 {
     #[\Override]
     public function modify(QueryBuilder $queryBuilder, ?string $dqlAlias = null): string

src/Condition/LessThan.php

@@ -4,7 +4,7 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class LessThan extends Comparison
+readonly class LessThan extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/LessThanOrEquals.php

@@ -4,7 +4,7 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class LessThanOrEquals extends Comparison
+readonly class LessThanOrEquals extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/Like.php

@@ -4,12 +4,10 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class Like extends Comparison
+readonly class Like extends Comparison
 {
     public const string CONTAINS = '%%%s%%';
-
     public const string ENDS_WITH = '%%%s';
-
     public const string STARTS_WITH = '%s%%';
 
     /**

src/Condition/NotEquals.php

@@ -4,7 +4,7 @@
 
 use Purist\Specification\Doctrine\Exception\InvalidArgumentException;
 
-class NotEquals extends Comparison
+readonly class NotEquals extends Comparison
 {
     /**
      * @throws InvalidArgumentException

src/Condition/NotIn.php

@@ -3,9 +3,15 @@
 namespace Purist\Specification\Doctrine\Condition;
 
 use Doctrine\ORM\QueryBuilder;
+use Purist\Specification\Doctrine\AbstractSpecification;
 
-class NotIn extends In
+readonly class NotIn extends AbstractSpecification
 {
+    public function __construct(string $field, protected mixed $value, ?string $dqlAlias = null)
+    {
+        parent::__construct($field, $dqlAlias);
+    }
+
     #[\Override]
     public function modify(QueryBuilder $queryBuilder, ?string $dqlAlias = null): string
     {
@@ -18,7 +24,6 @@ public function modify(QueryBuilder $queryBuilder, ?string $dqlAlias = null): st
         );
     }
 
-    #[\Override]
     protected function generateParameterName(QueryBuilder $queryBuilder): string
     {
         return sprintf('not_in_%d', count($queryBuilder->getParameters()));

src/Logic/Not.php

@@ -18,7 +18,8 @@ public function __construct(private SpecificationInterface $parent)
     public function modify(QueryBuilder $queryBuilder, ?string $dqlAlias = null): ?string
     {
         $filter = $this->parent->modify($queryBuilder, $dqlAlias);
-        if (null === $filter || '' === $filter || '0' === $filter) {
+
+        if (null === $filter) {
             return '';
         }