[FEATURE] SubscriptionRepository.findOneBySubscriberListAndSubscriber (#284)

This makes it possible to retrieve an existing subscription, e.g.,
for removing it.

Author: oliverklee

CHANGELOG.md

@@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## x.y.z
 
 ### Added
+- SubscriptionRepository.findOneBySubscriberListAndSubscriber (#284)
 - Repository.remove (#278)
 - Interface for domain models (#274)
 - Trait for database tests and abstract web test (#264)

src/Domain/Repository/Subscription/SubscriptionRepository.php

@@ -18,4 +18,19 @@
  */
 class SubscriptionRepository extends AbstractRepository
 {
+    /**
+     * @param SubscriberList $list
+     * @param Subscriber $subscriber
+     *
+     * @return Subscription|null
+     */
+    public function findOneBySubscriberListAndSubscriber(SubscriberList $list, Subscriber $subscriber)
+    {
+        return $this->findOneBy(
+            [
+                'subscriberList' => $list,
+                'subscriber' => $subscriber,
+            ]
+        );
+    }
 }

tests/Integration/Domain/Repository/Fixtures/Subscriber.csv

@@ -2,3 +2,4 @@ id,entered,modified,email,confirmed,blacklisted,bouncecount,uniqid,htmlemail,dis
 1,"2016-07-22 15:01:17","2016-08-23 19:50:43","[email protected]",1,1,17,"95feb7fe7e06e6c11ca8d0c48cb46e89",1,1
 2,"2016-08-22 15:01:17","2017-08-23 19:50:43","[email protected]",1,1,17,"95feb7fe7e06e6c11ca8d0c48cb46e81",1,0
 3,"2016-08-22 15:01:17","2017-08-23 19:50:43","[email protected]",1,1,17,"95feb7fe7e06e6c11ca8d0c48cb46e84",1,0
+4,"2016-08-22 15:01:17","2017-08-23 19:50:43","[email protected]",1,1,17,"95feb7fe7e06e6c11ca8d0c48cb46e8a",1,0

tests/Integration/Domain/Repository/Subscription/SubscriptionRepositoryTest.php

@@ -258,4 +258,74 @@ public function removeRemovesModel()
         $numberOfModelsAfterRemove = count($this->subject->findAll());
         static::assertSame(1, $numberOfModelsBeforeRemove - $numberOfModelsAfterRemove);
     }
+
+    /**
+     * @test
+     */
+    public function findOneBySubscriberListAndSubscriberForNeitherMatchingReturnsNull()
+    {
+        $this->getDataSet()->addTable(static::SUBSCRIBER_TABLE_NAME, __DIR__ . '/../Fixtures/Subscriber.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIBER_LIST_TABLE_NAME, __DIR__ . '/../Fixtures/SubscriberList.csv');
+        $this->getDataSet()->addTable(static::TABLE_NAME, __DIR__ . '/../Fixtures/Subscription.csv');
+        $this->applyDatabaseChanges();
+
+        $subscriberList = $this->subscriberListRepository->find(3);
+        $subscriber = $this->subscriberRepository->find(4);
+        $result = $this->subject->findOneBySubscriberListAndSubscriber($subscriberList, $subscriber);
+
+        static::assertNull($result);
+    }
+
+    /**
+     * @test
+     */
+    public function findOneBySubscriberListAndSubscriberForMatchingSubscriberListOnlyReturnsNull()
+    {
+        $this->getDataSet()->addTable(static::SUBSCRIBER_TABLE_NAME, __DIR__ . '/../Fixtures/Subscriber.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIBER_LIST_TABLE_NAME, __DIR__ . '/../Fixtures/SubscriberList.csv');
+        $this->getDataSet()->addTable(static::TABLE_NAME, __DIR__ . '/../Fixtures/Subscription.csv');
+        $this->applyDatabaseChanges();
+
+        $subscriberList = $this->subscriberListRepository->find(2);
+        $subscriber = $this->subscriberRepository->find(4);
+        $result = $this->subject->findOneBySubscriberListAndSubscriber($subscriberList, $subscriber);
+
+        static::assertNull($result);
+    }
+
+    /**
+     * @test
+     */
+    public function findOneBySubscriberListAndSubscriberForMatchingSubscriberOnlyReturnsNull()
+    {
+        $this->getDataSet()->addTable(static::SUBSCRIBER_TABLE_NAME, __DIR__ . '/../Fixtures/Subscriber.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIBER_LIST_TABLE_NAME, __DIR__ . '/../Fixtures/SubscriberList.csv');
+        $this->getDataSet()->addTable(static::TABLE_NAME, __DIR__ . '/../Fixtures/Subscription.csv');
+        $this->applyDatabaseChanges();
+
+        $subscriberList = $this->subscriberListRepository->find(3);
+        $subscriber = $this->subscriberRepository->find(1);
+        $result = $this->subject->findOneBySubscriberListAndSubscriber($subscriberList, $subscriber);
+
+        static::assertNull($result);
+    }
+
+    /**
+     * @test
+     */
+    public function findOneBySubscriberListAndSubscriberForBothMatchingReturnsMatch()
+    {
+        $this->getDataSet()->addTable(static::SUBSCRIBER_TABLE_NAME, __DIR__ . '/../Fixtures/Subscriber.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIBER_LIST_TABLE_NAME, __DIR__ . '/../Fixtures/SubscriberList.csv');
+        $this->getDataSet()->addTable(static::TABLE_NAME, __DIR__ . '/../Fixtures/Subscription.csv');
+        $this->applyDatabaseChanges();
+
+        $subscriberList = $this->subscriberListRepository->find(2);
+        $subscriber = $this->subscriberRepository->find(1);
+        $result = $this->subject->findOneBySubscriberListAndSubscriber($subscriberList, $subscriber);
+
+        static::assertInstanceOf(Subscription::class, $result);
+        static::assertSame($subscriberList, $result->getSubscriberList());
+        static::assertSame($subscriber, $result->getSubscriber());
+    }
 }