Merge pull request rikbruil#21 from rikbruil/add-specification-repository-class

Added back the SpecificationRepository class for backwards-compatibility reasons

Author: rikbruil

README.md

@@ -13,6 +13,9 @@ The main one is that SpecificationRepository->match() does not return the result
 
 Since I like Doctrine's Paginator object, I wanted to be able to use that in combination with the Specification pattern.
 
+__Note:__ In versions prior to 1.2 it was required to extend the SpecificationRepository class. This is no longer needed since we provide a SpecificationRepositoryTrait that you can use instead.
+The class is still provided for backwards compatibility reasons. There is also the SpecificationAwareInterface that you can use if you need it.
+
 ## Usage
 
 Install the latest version with `composer require rikbruil/doctrine-specification`
@@ -59,7 +62,7 @@ $spec = new Specification([
     )
 ]);
 
-// Note: Advertisement repository is an instance of the SpecificationRepository class
+// Note: Advertisement repository is an instance that uses the SpecificationRepositoryTrait
 return $this->em->getRepository('Advertisement')->match($spec)->execute();
 ```
 

composer.json

@@ -15,8 +15,7 @@
     "psr-4": {"Rb\\Specification\\Doctrine\\": "src/"}
   },
   "autoload-dev": {
-    "psr-4": {"spec\\Rb\\Specification\\Doctrine\\": "spec/"},
-    "files": ["spec/SpecificationRepositoryStub.php"]
+    "psr-4": {"spec\\Rb\\Specification\\Doctrine\\": "spec/"}
   },
   "require": {
     "php": ">=5.5",
@@ -32,7 +31,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "1.2-dev"
+      "dev-master": "1.3-dev"
     }
   },
   "scripts": {

spec/SpecificationRepositorySpec.php

@@ -11,7 +11,7 @@
 use Rb\Specification\Doctrine\Exception\LogicException;
 use Rb\Specification\Doctrine\Result\ModifierInterface;
 use Rb\Specification\Doctrine\SpecificationInterface;
-use Rb\Specification\Doctrine\SpecificationRepositoryStub;
+use Rb\Specification\Doctrine\SpecificationRepository;
 
 class SpecificationRepositorySpec extends ObjectBehavior
 {
@@ -23,7 +23,7 @@ class SpecificationRepositorySpec extends ObjectBehavior
 
     public function let(EntityManager $entityManager, ClassMetadata $classMetadata)
     {
-        $this->beAnInstanceOf(SpecificationRepositoryStub::class);
+        $this->beAnInstanceOf(SpecificationRepository::class);
         $this->beConstructedWith($entityManager, $classMetadata);
     }
 

spec/SpecificationRepositoryStub.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Rb\Specification\Doctrine;
+
+use Doctrine\ORM\EntityRepository;
+
+/**
+ * This class is only here for backwards compatibility reasons.
+ *
+ * The preferred way of interacting with specification objects is by writing your own
+ * custom repository class that uses the SpecificationRepositoryTrait.
+ *
+ * The SpecificationAwareInterface is added in case you need it.
+ *
+ * @see SpecificationRepositoryTrait
+ * @see SpecificationAwareInterface
+ */
+class SpecificationRepository extends EntityRepository implements SpecificationAwareInterface
+{
+    use SpecificationRepositoryTrait;
+}