10414 - Recactored the code to be closer to CQRS design pattern

damiantomczak · damiantomczak · commit 2d9631cf63c3 · 2017-09-24T13:45:13.000+02:00
diff --git a/app/code/Magento/Cms/Api/GetBlockByIdentifierInterface.php b/app/code/Magento/Cms/Api/GetBlockByIdentifierInterface.php
@@ -6,18 +6,18 @@
 namespace Magento\Cms\Api;
 
 /**
- * CMS Block management interface
+ * Command to load the block data by specified identifier
  * @api
  */
-interface BlockManagementInterface
+interface GetBlockByIdentifierInterface
 {
     /**
      * Load block data by given block identifier.
      *
      * @param string $identifier
-     * @param int|null $storeId
+     * @param int $storeId
      * @return \Magento\Cms\Api\Data\BlockInterface
      */
-    public function getByIdentifier(string $identifier, $storeId = null) : \Magento\Cms\Api\Data\BlockInterface;
+    public function execute(string $identifier, int $storeId) : \Magento\Cms\Api\Data\BlockInterface;
 }
 
diff --git a/app/code/Magento/Cms/Api/GetPageByIdentifierInterface.php b/app/code/Magento/Cms/Api/GetPageByIdentifierInterface.php
@@ -6,18 +6,18 @@
 namespace Magento\Cms\Api;
 
 /**
- * CMS Page management interface
+ * Command to load the page data by specified identifier
  * @api
  */
-interface PageManagementInterface
+interface GetPageByIdentifierInterface
 {
     /**
      * Load page data by given page identifier.
      *
      * @param string $identifier
-     * @param int|null $storeId
+     * @param int $storeId
      * @return \Magento\Cms\Api\Data\PageInterface
      */
-    public function getByIdentifier(string $identifier, $storeId = null) : \Magento\Cms\Api\Data\PageInterface;
+    public function execute(string $identifier, int $storeId) : \Magento\Cms\Api\Data\PageInterface;
 }
 
diff --git a/app/code/Magento/Cms/Model/GetBlockByIdentifier.php b/app/code/Magento/Cms/Model/GetBlockByIdentifier.php
@@ -5,14 +5,14 @@
  */
 namespace Magento\Cms\Model;
 
-use Magento\Cms\Api\BlockManagementInterface;
+use Magento\Cms\Api\GetBlockByIdentifierInterface;
 use Magento\Cms\Api\Data\BlockInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
 
 /**
- * Class BlockManagement
+ * Class GetBlockByIdentifier
  */
-class BlockManagement implements BlockManagementInterface
+class GetBlockByIdentifier implements GetBlockByIdentifierInterface
 {
     /**
      * @var \Magento\Cms\Model\BlockFactory
@@ -24,41 +24,29 @@ class BlockManagement implements BlockManagementInterface
      */
     private $blockResource;
 
-    /**
-     * @var \Magento\Store\Model\StoreManagerInterface
-     */
-    private $storeManager;
-
     /**
      * BlockManagement constructor.
      * @param BlockFactory $blockFactory
      * @param ResourceModel\Block $blockResource
-     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      */
     public function __construct(
         \Magento\Cms\Model\BlockFactory $blockFactory,
-        \Magento\Cms\Model\ResourceModel\Block $blockResource,
-        \Magento\Store\Model\StoreManagerInterface $storeManager
+        \Magento\Cms\Model\ResourceModel\Block $blockResource
     ) {
         $this->blockFactory = $blockFactory;
         $this->blockResource = $blockResource;
-        $this->storeManager = $storeManager;
     }
 
     /**
      * Load block data by given block identifier.
      *
      * @param string $identifier
-     * @param int|null $storeId
+     * @param int $storeId
      * @return BlockInterface
      * @throws NoSuchEntityException
      */
-    public function getByIdentifier(string $identifier, $storeId = null) : BlockInterface
+    public function execute(string $identifier, int $storeId) : BlockInterface
     {
-        if ($storeId === null) {
-            $storeId = $this->storeManager->getStore()->getId();
-        }
-
         $block = $this->blockFactory->create();
         $block->setStoreId($storeId);
         $this->blockResource->load($block, $identifier, BlockInterface::IDENTIFIER);
diff --git a/app/code/Magento/Cms/Model/GetPageByIdentifier.php b/app/code/Magento/Cms/Model/GetPageByIdentifier.php
@@ -6,13 +6,13 @@
 namespace Magento\Cms\Model;
 
 use Magento\Cms\Api\Data\PageInterface;
-use Magento\Cms\Api\PageManagementInterface;
+use Magento\Cms\Api\GetPageByIdentifierInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
 
 /**
- * Class PageManagement
+ * Class GetPageByIdentifier
  */
-class PageManagement implements PageManagementInterface
+class GetPageByIdentifier implements GetPageByIdentifierInterface
 {
     /**
      * @var \Magento\Cms\Model\PageFactory
@@ -24,41 +24,29 @@ class PageManagement implements PageManagementInterface
      */
     private $pageResource;
 
-    /**
-     * @var \Magento\Store\Model\StoreManagerInterface
-     */
-    private $storeManager;
-
     /**
      * PageManagement constructor.
      * @param PageFactory $pageFactory
      * @param ResourceModel\Page $pageResource
-     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      */
     public function __construct(
         \Magento\Cms\Model\PageFactory $pageFactory,
-        \Magento\Cms\Model\ResourceModel\Page $pageResource,
-        \Magento\Store\Model\StoreManagerInterface $storeManager
+        \Magento\Cms\Model\ResourceModel\Page $pageResource
     ) {
         $this->pageFactory = $pageFactory;
         $this->pageResource = $pageResource;
-        $this->storeManager = $storeManager;
     }
 
     /**
      * Load page data by given page identifier.
      *
      * @param string $identifier
-     * @param int|null $storeId
+     * @param int $storeId
      * @return PageInterface
      * @throws NoSuchEntityException
      */
-    public function getByIdentifier(string $identifier, $storeId = null) : PageInterface
+    public function execute(string $identifier, int $storeId) : PageInterface
     {
-        if ($storeId === null) {
-            $storeId = $this->storeManager->getStore()->getId();
-        }
-
         $page = $this->pageFactory->create();
         $page->setStoreId($storeId);
         $this->pageResource->load($page, $identifier, PageInterface::IDENTIFIER);
diff --git a/app/code/Magento/Cms/Test/Unit/Model/GetBlockByIdentifierTest.php b/app/code/Magento/Cms/Test/Unit/Model/GetBlockByIdentifierTest.php
@@ -5,18 +5,18 @@
  */
 namespace Magento\Cms\Test\Unit\Model;
 
-use Magento\Cms\Model\BlockManagement;
+use Magento\Cms\Model\GetBlockByIdentifier;
 
 /**
- * Test for Magento\Cms\Model\BlockManagment
+ * Test for Magento\Cms\Model\GetBlockByIdentifier
  */
 
-class BlockManagementTest extends \PHPUnit\Framework\TestCase
+class GetBlockByIdentifierTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * @var BlockManagement
+     * @var GetBlockByIdentifier
      */
-    private $blockManagement;
+    private $getBlockByIdentifierCommand;
 
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Cms\Model\Block
@@ -33,16 +33,6 @@ class BlockManagementTest extends \PHPUnit\Framework\TestCase
      */
     private $blockResource;
 
-    /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Store\Model\StoreManagerInterface
-     */
-    private $storeManager;
-
-    /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Store\Api\Data\StoreInterface
-     */
-    private $store;
-
     protected function setUp()
     {
         $this->blockFactory = $this->getMockBuilder(\Magento\Cms\Model\BlockFactory::class)
@@ -54,20 +44,12 @@ protected function setUp()
             ->disableOriginalConstructor()
             ->getMock();
 
-        $this->storeManager = $this->getMockBuilder(\Magento\Store\Model\StoreManagerInterface::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $this->store = $this->getMockBuilder(\Magento\Store\Api\Data\StoreInterface::class)
-            ->disableOriginalConstructor(true)
-            ->getMock();
-
         $this->block = $this->getMockBuilder(\Magento\Cms\Model\Block::class)
             ->disableOriginalConstructor()
             ->setMethods(['setStoreId', 'getId'])
             ->getMock();
 
-        $this->blockManagement = new BlockManagement($this->blockFactory, $this->blockResource, $this->storeManager);
+        $this->getBlockByIdentifierCommand = new GetBlockByIdentifier($this->blockFactory, $this->blockResource);
     }
 
     /**
@@ -76,15 +58,7 @@ protected function setUp()
     public function testGetByIdentifier()
     {
         $identifier = 'banner';
-        $storeId = null;
-
-        $this->storeManager->expects($this->once())
-            ->method('getStore')
-            ->willReturn($this->store);
-
-        $this->store->expects($this->once())
-            ->method('getId')
-            ->willReturn(1);
+        $storeId = 0;
 
         $this->blockFactory->expects($this->once())
             ->method('create')
@@ -103,7 +77,7 @@ public function testGetByIdentifier()
             ->with($this->block, $identifier)
             ->willReturn($this->block);
 
-        $this->blockManagement->getByIdentifier($identifier, $storeId);
+        $this->getBlockByIdentifierCommand->execute($identifier, $storeId);
     }
 }
 
diff --git a/app/code/Magento/Cms/Test/Unit/Model/GetPageByIdentifierTest.php b/app/code/Magento/Cms/Test/Unit/Model/GetPageByIdentifierTest.php
@@ -5,18 +5,18 @@
  */
 namespace Magento\Cms\Test\Unit\Model;
 
-use Magento\Cms\Model\PageManagement;
+use Magento\Cms\Model\GetPageByIdentifier;
 
 /**
- * Test for Magento\Cms\Model\PageManagment
+ * Test for Magento\Cms\Model\GetPageByIdentifier
  */
 
-class PageManagementTest extends \PHPUnit\Framework\TestCase
+class GetPageByIdentifierTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * @var PageManagement
+     * @var GetPageByIdentifier
      */
-    protected $pageManagment;
+    protected $getPageByIdentifierCommand;
 
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Cms\Model\Page
@@ -33,16 +33,6 @@ class PageManagementTest extends \PHPUnit\Framework\TestCase
      */
     protected $pageResource;
 
-    /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Store\Model\StoreManagerInterface
-     */
-    protected $storeManager;
-
-    /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Store\Api\Data\StoreInterface
-     */
-    protected $store;
-
     public function setUp()
     {
         $this->pageFactory = $this->getMockBuilder(\Magento\Cms\Model\PageFactory::class)
@@ -54,20 +44,12 @@ public function setUp()
             ->disableOriginalConstructor(true)
             ->getMock();
 
-        $this->storeManager = $this->getMockBuilder(\Magento\Store\Model\StoreManagerInterface::class)
-            ->disableOriginalConstructor(true)
-            ->getMock();
-
-        $this->store = $this->getMockBuilder(\Magento\Store\Api\Data\StoreInterface::class)
-            ->disableOriginalConstructor(true)
-            ->getMock();
-
         $this->page = $this->getMockBuilder(\Magento\Cms\Model\Page::class)
             ->disableOriginalConstructor()
             ->setMethods(['setStoreId', 'getId'])
             ->getMock();
 
-        $this->pageManagment = new PageManagement($this->pageFactory, $this->pageResource, $this->storeManager);
+        $this->getPageByIdentifierCommand = new GetPageByIdentifier($this->pageFactory, $this->pageResource);
     }
 
     /**
@@ -76,15 +58,7 @@ public function setUp()
     public function testGetByIdentifier()
     {
         $identifier = 'home';
-        $storeId = null;
-
-        $this->storeManager->expects($this->once())
-            ->method('getStore')
-            ->willReturn($this->store);
-
-        $this->store->expects($this->once())
-            ->method('getId')
-            ->willReturn(1);
+        $storeId = 0;
 
         $this->pageFactory->expects($this->once())
             ->method('create')
@@ -103,6 +77,6 @@ public function testGetByIdentifier()
             ->with($this->page, $identifier)
             ->willReturn($this->page);
 
-        $this->pageManagment->getByIdentifier($identifier, $storeId);
+        $this->getPageByIdentifierCommand->execute($identifier, $storeId);
     }
 }
diff --git a/app/code/Magento/Cms/etc/di.xml b/app/code/Magento/Cms/etc/di.xml
@@ -10,6 +10,8 @@
                 type="Magento\Framework\Api\SearchResults" />
     <preference for="Magento\Cms\Api\Data\BlockSearchResultsInterface"
                 type="Magento\Framework\Api\SearchResults" />
+    <preference for="Magento\Cms\Api\GetBlockByIdentifierInterface" type="Magento\Cms\Model\GetBlockByIdentifier" />
+    <preference for="Magento\Cms\Api\GetPageByIdentifierInterface" type="Magento\Cms\Model\GetPageByIdentifier" />
     <preference for="Magento\Cms\Api\Data\PageInterface" type="Magento\Cms\Model\Page" />
     <preference for="Magento\Cms\Api\Data\BlockInterface" type="Magento\Cms\Model\Block" />
     <preference for="Magento\Cms\Api\BlockRepositoryInterface" type="Magento\Cms\Model\BlockRepository" />
diff --git a/dev/tests/integration/testsuite/Magento/Cms/Model/BlockTest.php b/dev/tests/integration/testsuite/Magento/Cms/Model/BlockTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Cms/Model/PageTest.php b/dev/tests/integration/testsuite/Magento/Cms/Model/PageTest.php
