ENGCOM-5918: Refactor apply options of sales rule to it's own source model to simplify extending it #24665

sidolov · web-flow · commit daeab6be6c98 · 2019-09-23T13:16:35.000-05:00
diff --git a/app/code/Magento/SalesRule/Model/Rule/Action/SimpleActionOptionsProvider.php b/app/code/Magento/SalesRule/Model/Rule/Action/SimpleActionOptionsProvider.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\SalesRule\Model\Rule\Action;
+
+use Magento\Framework\Data\OptionSourceInterface;
+use Magento\SalesRule\Model\Rule;
+
+/**
+ * Class SimpleActionOptionsProvider
+ */
+class SimpleActionOptionsProvider implements OptionSourceInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function toOptionArray()
+    {
+        return [
+            ['label' => __('Percent of product price discount'), 'value' =>  Rule::BY_PERCENT_ACTION],
+            ['label' => __('Fixed amount discount'), 'value' => Rule::BY_FIXED_ACTION],
+            ['label' => __('Fixed amount discount for whole cart'), 'value' => Rule::CART_FIXED_ACTION],
+            ['label' => __('Buy X get Y free (discount amount is Y)'), 'value' => Rule::BUY_X_GET_Y_ACTION]
+        ];
+    }
+}
diff --git a/app/code/Magento/SalesRule/Model/Rule/Metadata/ValueProvider.php b/app/code/Magento/SalesRule/Model/Rule/Metadata/ValueProvider.php
@@ -5,11 +5,14 @@
  */
 namespace Magento\SalesRule\Model\Rule\Metadata;
 
-use Magento\SalesRule\Model\Rule;
-use Magento\Store\Model\System\Store;
 use Magento\Customer\Api\GroupRepositoryInterface;
 use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Convert\DataObject;
+use Magento\SalesRule\Model\Rule;
+use Magento\SalesRule\Model\Rule\Action\SimpleActionOptionsProvider;
+use Magento\SalesRule\Model\RuleFactory;
+use Magento\Store\Model\System\Store;
 
 /**
  * Metadata provider for sales rule edit form.
@@ -37,31 +40,40 @@ class ValueProvider
     protected $objectConverter;
 
     /**
-     * @var \Magento\SalesRule\Model\RuleFactory
+     * @var RuleFactory
      */
     protected $salesRuleFactory;
 
+    /**
+     * @var SimpleActionOptionsProvider
+     */
+    private $simpleActionOptionsProvider;
+
     /**
      * Initialize dependencies.
      *
      * @param Store $store
      * @param GroupRepositoryInterface $groupRepository
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param DataObject $objectConverter
-     * @param \Magento\SalesRule\Model\RuleFactory $salesRuleFactory
+     * @param RuleFactory $salesRuleFactory
+     * @param SimpleActionOptionsProvider|null $simpleActionOptionsProvider
      */
     public function __construct(
         Store $store,
         GroupRepositoryInterface $groupRepository,
         SearchCriteriaBuilder $searchCriteriaBuilder,
         DataObject $objectConverter,
-        \Magento\SalesRule\Model\RuleFactory $salesRuleFactory
+        RuleFactory $salesRuleFactory,
+        SimpleActionOptionsProvider $simpleActionOptionsProvider = null
     ) {
         $this->store = $store;
         $this->groupRepository = $groupRepository;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->objectConverter = $objectConverter;
         $this->salesRuleFactory = $salesRuleFactory;
+        $this->simpleActionOptionsProvider = $simpleActionOptionsProvider ?:
+            ObjectManager::getInstance()->get(SimpleActionOptionsProvider::class);
     }
 
     /**
@@ -71,15 +83,10 @@ public function __construct(
      * @return array
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
-    public function getMetadataValues(\Magento\SalesRule\Model\Rule $rule)
+    public function getMetadataValues(Rule $rule)
     {
         $customerGroups = $this->groupRepository->getList($this->searchCriteriaBuilder->create())->getItems();
-        $applyOptions = [
-            ['label' => __('Percent of product price discount'), 'value' =>  Rule::BY_PERCENT_ACTION],
-            ['label' => __('Fixed amount discount'), 'value' => Rule::BY_FIXED_ACTION],
-            ['label' => __('Fixed amount discount for whole cart'), 'value' => Rule::CART_FIXED_ACTION],
-            ['label' => __('Buy X get Y free (discount amount is Y)'), 'value' => Rule::BUY_X_GET_Y_ACTION]
-        ];
+        $applyOptions = $this->simpleActionOptionsProvider->toOptionArray();
 
         $couponTypesOptions = [];
         $couponTypes = $this->salesRuleFactory->create()->getCouponTypes();
diff --git a/app/code/Magento/SalesRule/Test/Unit/Model/Rule/Action/SimpleActionOptionsProviderTest.php b/app/code/Magento/SalesRule/Test/Unit/Model/Rule/Action/SimpleActionOptionsProviderTest.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\SalesRule\Test\Unit\Model\Rule\Action;
+
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\SalesRule\Model\Rule;
+use Magento\SalesRule\Model\Rule\Action\SimpleActionOptionsProvider;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers Magento\SalesRule\Model\Rule\Action\SimpleActionOptionsProvider
+ */
+class SimpleActionOptionsProviderTest extends TestCase
+{
+    /**
+     * @var SimpleActionOptionsProvider|MockObject
+     */
+    protected $model;
+
+    protected function setUp()
+    {
+        $objectManager = new ObjectManager($this);
+
+        $this->model = $objectManager->getObject(SimpleActionOptionsProvider::class);
+    }
+
+    public function testToOptionArray()
+    {
+        $expected = [
+            ['label' => __('Percent of product price discount'), 'value' =>  Rule::BY_PERCENT_ACTION],
+            ['label' => __('Fixed amount discount'), 'value' => Rule::BY_FIXED_ACTION],
+            ['label' => __('Fixed amount discount for whole cart'), 'value' => Rule::CART_FIXED_ACTION],
+            ['label' => __('Buy X get Y free (discount amount is Y)'), 'value' => Rule::BUY_X_GET_Y_ACTION]
+        ];
+
+        $this->assertEquals($expected, $this->model->toOptionArray());
+    }
+}
diff --git a/app/code/Magento/SalesRule/Test/Unit/Model/Rule/Metadata/ValueProviderTest.php b/app/code/Magento/SalesRule/Test/Unit/Model/Rule/Metadata/ValueProviderTest.php
@@ -5,52 +5,72 @@
  */
 namespace Magento\SalesRule\Test\Unit\Model\Rule\Metadata;
 
+use Magento\Customer\Api\Data\GroupInterface;
+use Magento\Customer\Api\Data\GroupSearchResultsInterface;
+use Magento\Customer\Api\GroupRepositoryInterface;
+use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Convert\DataObject;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\SalesRule\Model\Rule;
+use Magento\SalesRule\Model\Rule\Action\SimpleActionOptionsProvider;
+use Magento\SalesRule\Model\Rule\Metadata\ValueProvider;
+use Magento\SalesRule\Model\RuleFactory;
+use Magento\Store\Model\System\Store;
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\MockObject\MockObject;
 
 /**
  * @covers Magento\SalesRule\Model\Rule\Metadata\ValueProvider
  */
-class ValueProviderTest extends \PHPUnit\Framework\TestCase
+class ValueProviderTest extends TestCase
 {
     /**
-     * @var \Magento\SalesRule\Model\Rule\Metadata\ValueProvider
+     * @var ValueProvider
      */
     protected $model;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var Store|MockObject
      */
     protected $storeMock;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var GroupRepositoryInterface|MockObject
      */
     protected $groupRepositoryMock;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var SearchCriteriaBuilder|MockObject
      */
     protected $searchCriteriaBuilderMock;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var DataObject|MockObject
      */
     protected $dataObjectMock;
 
     /**
-     * @var \Magento\SalesRule\Model\RuleFactory|\PHPUnit_Framework_MockObject_MockObject
+     * @var RuleFactory|MockObject
      */
     protected $ruleFactoryMock;
 
+    /**
+     * @var SimpleActionOptionsProvider|MockObject
+     */
+    private $simpleActionOptionsProviderMock;
+
     protected function setUp()
     {
-        $this->searchCriteriaBuilderMock = $this->createMock(\Magento\Framework\Api\SearchCriteriaBuilder::class);
-        $this->storeMock = $this->createMock(\Magento\Store\Model\System\Store::class);
-        $this->groupRepositoryMock = $this->createMock(\Magento\Customer\Api\GroupRepositoryInterface::class);
-        $this->dataObjectMock = $this->createMock(\Magento\Framework\Convert\DataObject::class);
-        $searchCriteriaMock = $this->createMock(\Magento\Framework\Api\SearchCriteriaInterface::class);
-        $groupSearchResultsMock = $this->createMock(\Magento\Customer\Api\Data\GroupSearchResultsInterface::class);
-        $groupsMock = $this->createMock(\Magento\Customer\Api\Data\GroupInterface::class);
+        $expectedData = include __DIR__ . '/_files/MetaData.php';
+        $this->searchCriteriaBuilderMock = $this->createMock(SearchCriteriaBuilder::class);
+        $this->storeMock = $this->createMock(Store::class);
+        $this->groupRepositoryMock = $this->createMock(GroupRepositoryInterface::class);
+        $this->dataObjectMock = $this->createMock(DataObject::class);
+        $this->simpleActionOptionsProviderMock = $this->createMock(SimpleActionOptionsProvider::class);
+        $searchCriteriaMock = $this->createMock(SearchCriteriaInterface::class);
+        $groupSearchResultsMock = $this->createMock(GroupSearchResultsInterface::class);
+        $groupsMock = $this->createMock(GroupInterface::class);
 
         $this->searchCriteriaBuilderMock->expects($this->once())->method('create')->willReturn($searchCriteriaMock);
         $this->groupRepositoryMock->expects($this->once())->method('getList')->with($searchCriteriaMock)
@@ -59,15 +79,19 @@ protected function setUp()
         $this->storeMock->expects($this->once())->method('getWebsiteValuesForForm')->willReturn([]);
         $this->dataObjectMock->expects($this->once())->method('toOptionArray')->with([$groupsMock], 'id', 'code')
             ->willReturn([]);
-        $this->ruleFactoryMock = $this->createPartialMock(\Magento\SalesRule\Model\RuleFactory::class, ['create']);
+        $this->ruleFactoryMock = $this->createPartialMock(RuleFactory::class, ['create']);
+        $this->simpleActionOptionsProviderMock->method('toOptionArray')->willReturn(
+            $expectedData['actions']['children']['simple_action']['arguments']['data']['config']['options']
+        );
         $this->model = (new ObjectManager($this))->getObject(
-            \Magento\SalesRule\Model\Rule\Metadata\ValueProvider::class,
+            ValueProvider::class,
             [
                 'store' => $this->storeMock,
                 'groupRepository' => $this->groupRepositoryMock,
                 'searchCriteriaBuilder' => $this->searchCriteriaBuilderMock,
                 'objectConverter' => $this->dataObjectMock,
                 'salesRuleFactory' => $this->ruleFactoryMock,
+                'simpleActionOptionsProvider' => $this->simpleActionOptionsProviderMock
             ]
         );
     }
@@ -76,8 +100,8 @@ public function testGetMetadataValues()
     {
         $expectedData = include __DIR__ . '/_files/MetaData.php';
 
-        /** @var \Magento\SalesRule\Model\Rule|\PHPUnit_Framework_MockObject_MockObject $ruleMock */
-        $ruleMock = $this->createMock(\Magento\SalesRule\Model\Rule::class);
+        /** @var Rule|MockObject $ruleMock */
+        $ruleMock = $this->createMock(Rule::class);
         $this->ruleFactoryMock->expects($this->once())
             ->method('create')
             ->willReturn($ruleMock);
