AbstractBuilder::_build() - Code Metrics - Inspection of "MGFX-08: Add OAuth Consumer fixture" - ctasca/magefix - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#17)

by Carlo

created 2016-01-21 22:30 UTC

AbstractBuilder::_build() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	2
eloc	6
nc	2
nop	0

<?php

namespace Magefix\Fixture\Builder;

use Mage_Core_Model_Abstract as MagentoModel;
use Magefix\Exceptions\UndefinedDataProvider;
use Magefix\Fixture\DataIterator;
use Magefix\Fixture\Builder;
use Magefix\Fixture\Factory\Builder as FixtureBuilder;
use Magefix\Fixtures\Data\Provider;
use Magefix\Magento\Store\Scope as MagentoStoreScope;
use Magefix\Exceptions\UndefinedAttributes;

/**
 * Class AbstractBuilder
 *
 * @package Magefix\Fixture\Builder
 * @author  Carlo Tasca <[email protected]>
 */
abstract class AbstractBuilder implements Builder
{
    /**
     * @var MagentoModel
     */
    private $_mageModel;

    /**
     * @var Provider
     */
    private $_dataProvider;

    /**
     * @var string
     */
    private $_hook;

    /**
     * @var array
     */
    protected $_data;

    public function __construct(array $parserData, MagentoModel $model, $hook)
    {
        $this->_mageModel = $model;
        $this->_data = $parserData;
        $this->_hook = $hook;
    }

    /**
     *
     * Concrete classes to provide implementation for build method
     *
     * @return mixed
     */
    abstract public function build();

    /**
     * @return MagentoModel
     * @throws \Exception
     */
    public function getMageModel()
    {
        return $this->_getMageModel();
    }

    /**
     * @return string
     */
    public function getHook()
    {
        return $this->_getHook();
    }

    /**
     * Iterate fixture data
     */
    public function invokeProvidersMethods()
    {
        $iterator = new DataIterator($this->_data);
        $this->_data = $iterator->apply($this->_getDataProvider());
    }

    /**
     * @param $mageModel
     * @param $data
     *
     */
    public function saveFixtureWithModelAndData($mageModel, $data)
    {
        $this->_saveFixtureWithModelAndData($mageModel, $data);
    }

    /**
     * @param $entity
     *
     * @throws UndefinedDataProvider
     *
     */
    public function throwUndefinedDataProvider($entity)
    {
        $this->_throwUndefinedDataProvider($entity);
    }

    protected function _build()
    {
        $this->invokeProvidersMethods();
        $defaultData = $this->_getMageModelData() ? $this->_getMageModelData() : [];
        $mergedData  = array_merge($defaultData, $this->_getFixtureAttributes());

        $this->_getMageModel()->setData($mergedData);

        return $this->_saveFixture();
    }

    /**
     * @return array
     * @throws \Exception
     */
    protected function _getMageModelData()
    {
        return $this->_getMageModel()->getData();
    }

    /**
     * @return MagentoModel
     */
    protected function _getMageModel()
    {
        return $this->_mageModel;
    }

    /**
     * @return mixed
     */
    protected function _getDataProvider()
    {
        $this->_throwUndefinedDataProvider($this->_data['fixture']);

        if (is_null($this->_dataProvider)) {
            $dataProvider = new \ReflectionClass($this->_data['fixture']['data_provider']);
            $this->_dataProvider = $dataProvider->newInstance();
        }
        return $this->_dataProvider;
    }

    /**
     * @return string
     */
    protected function _getHook()
    {
        return $this->_hook;
    }

    /**
     * @return array
     * @throws \Exception
     */
    protected function _getFixtureAttributes()
    {
        $this->_throwUndefinedAttributesException(isset($this->_data['fixture']['attributes']));

        return $this->_data['fixture']['attributes'];
    }

    /**
     * @return int
     * @throws \Exception
     */
    protected function _saveFixture()
    {
        MagentoStoreScope::setAdminStoreScope();
        $this->_getMageModel()->save();
        MagentoStoreScope::setCurrentStoreScope();

        return $this->_getMageModel()->getId();
    }

    /**
     * @param MagentoModel $mageModel
     * @param $data
     * @return mixed
     * @throws \Exception
     */
    protected function _saveFixtureWithModelAndData(MagentoModel $mageModel, $data)
    {
        MagentoStoreScope::setAdminStoreScope();
        $mageModel->setData($data);
        $mageModel->save();
        MagentoStoreScope::setCurrentStoreScope();

        return $mageModel->getId();
    }

    /**
     * Add data to model, but don't invoke save
     *
     * @param array $data
     */
    protected function _initFixtureWithData(array $data)
    {
        $this->_getMageModel()->setData($data);
    }

    /**
     * @param $node
     *
     * @return array
     */
    protected function _buildManySimple($node)
    {
        $products = $this->_data['fixture'][$node]['products'];

        return FixtureBuilder::buildMany(
            FixtureBuilder::SIMPLE_PRODUCT_FIXTURE_TYPE, $this, $products, $this->getHook()
        );
    }

    /**
     * @param boolean $isSet
     * @param string $message
     *
     * @throws UndefinedAttributes
     *
     */
    protected function _throwUndefinedAttributesException(
        $isSet, $message = 'Fixture attributes have not been defined. Check fixture yml file.'
    )
    {
        if (!$isSet) {
            throw new UndefinedAttributes($message);
        }
    }

    /**
     * @param array $a
     *
     * @throws UndefinedDataProvider
     *
     */
    protected function _throwUndefinedDataProvider(array $a)
    {
        if (!isset($a['data_provider'])) {
            throw new UndefinedDataProvider(
                'Fixture has no data provider specified. Check fixture yml file.'
            );
        }
    }
}


1			<?php
2
3			namespace Magefix\Fixture\Builder;
4
5			use Mage_Core_Model_Abstract as MagentoModel;
6			use Magefix\Exceptions\UndefinedDataProvider;
7			use Magefix\Fixture\DataIterator;
8			use Magefix\Fixture\Builder;
9			use Magefix\Fixture\Factory\Builder as FixtureBuilder;
10			use Magefix\Fixtures\Data\Provider;
11			use Magefix\Magento\Store\Scope as MagentoStoreScope;
12			use Magefix\Exceptions\UndefinedAttributes;
13
14			/**
15			* Class AbstractBuilder
16			*
17			* @package Magefix\Fixture\Builder
18			* @author Carlo Tasca <[email protected]>
19			*/
20			abstract class AbstractBuilder implements Builder
21			{
22			/**
23			* @var MagentoModel
24			*/
25			private $_mageModel;
26
27			/**
28			* @var Provider
29			*/
30			private $_dataProvider;
31
32			/**
33			* @var string
34			*/
35			private $_hook;
36
37			/**
38			* @var array
39			*/
40			protected $_data;
41
42			public function __construct(array $parserData, MagentoModel $model, $hook)
43			{
44			$this->_mageModel = $model;
45			$this->_data = $parserData;
46			$this->_hook = $hook;
47			}
48
49			/**
50			*
51			* Concrete classes to provide implementation for build method
52			*
53			* @return mixed
54			*/
55			abstract public function build();
56
57			/**
58			* @return MagentoModel
59			* @throws \Exception
60			*/
61			public function getMageModel()
62			{
63			return $this->_getMageModel();
64			}
65
66			/**
67			* @return string
68			*/
69			public function getHook()
70			{
71			return $this->_getHook();
72			}
73
74			/**
75			* Iterate fixture data
76			*/
77			public function invokeProvidersMethods()
78			{
79			$iterator = new DataIterator($this->_data);
80			$this->_data = $iterator->apply($this->_getDataProvider());
81			}
82
83			/**
84			* @param $mageModel
85			* @param $data
86			*
87			*/
88			public function saveFixtureWithModelAndData($mageModel, $data)
89			{
90			$this->_saveFixtureWithModelAndData($mageModel, $data);
91			}
92
93			/**
94			* @param $entity
95			*
96			* @throws UndefinedDataProvider
97			*
98			*/
99			public function throwUndefinedDataProvider($entity)
100			{
101			$this->_throwUndefinedDataProvider($entity);
102			}
103
104			protected function _build()
105			{
106			$this->invokeProvidersMethods();
107			$defaultData = $this->_getMageModelData() ? $this->_getMageModelData() : [];
108			$mergedData = array_merge($defaultData, $this->_getFixtureAttributes());
109
110			$this->_getMageModel()->setData($mergedData);
111
112			return $this->_saveFixture();
113			}
114
115			/**
116			* @return array
117			* @throws \Exception
118			*/
119			protected function _getMageModelData()
120			{
121			return $this->_getMageModel()->getData();
122			}
123
124			/**
125			* @return MagentoModel
126			*/
127			protected function _getMageModel()
128			{
129			return $this->_mageModel;
130			}
131
132			/**
133			* @return mixed
134			*/
135			protected function _getDataProvider()
136			{
137			$this->_throwUndefinedDataProvider($this->_data['fixture']);
138
139			if (is_null($this->_dataProvider)) {
140			$dataProvider = new \ReflectionClass($this->_data['fixture']['data_provider']);
141			$this->_dataProvider = $dataProvider->newInstance();
142			}
143			return $this->_dataProvider;
144			}
145
146			/**
147			* @return string
148			*/
149			protected function _getHook()
150			{
151			return $this->_hook;
152			}
153
154			/**
155			* @return array
156			* @throws \Exception
157			*/
158			protected function _getFixtureAttributes()
159			{
160			$this->_throwUndefinedAttributesException(isset($this->_data['fixture']['attributes']));
161
162			return $this->_data['fixture']['attributes'];
163			}
164
165			/**
166			* @return int
167			* @throws \Exception
168			*/
169			protected function _saveFixture()
170			{
171			MagentoStoreScope::setAdminStoreScope();
172			$this->_getMageModel()->save();
173			MagentoStoreScope::setCurrentStoreScope();
174
175			return $this->_getMageModel()->getId();
176			}
177
178			/**
179			* @param MagentoModel $mageModel
180			* @param $data
181			* @return mixed
182			* @throws \Exception
183			*/
184			protected function _saveFixtureWithModelAndData(MagentoModel $mageModel, $data)
185			{
186			MagentoStoreScope::setAdminStoreScope();
187			$mageModel->setData($data);
188			$mageModel->save();
189			MagentoStoreScope::setCurrentStoreScope();
190
191			return $mageModel->getId();
192			}
193
194			/**
195			* Add data to model, but don't invoke save
196			*
197			* @param array $data
198			*/
199			protected function _initFixtureWithData(array $data)
200			{
201			$this->_getMageModel()->setData($data);
202			}
203
204			/**
205			* @param $node
206			*
207			* @return array
208			*/
209			protected function _buildManySimple($node)
210			{
211			$products = $this->_data['fixture'][$node]['products'];
212
213			return FixtureBuilder::buildMany(
214			FixtureBuilder::SIMPLE_PRODUCT_FIXTURE_TYPE, $this, $products, $this->getHook()
215			);
216			}
217
218			/**
219			* @param boolean $isSet
220			* @param string $message
221			*
222			* @throws UndefinedAttributes
223			*
224			*/
225			protected function _throwUndefinedAttributesException(
226			$isSet, $message = 'Fixture attributes have not been defined. Check fixture yml file.'
227			)
228			{
229			if (!$isSet) {
230			throw new UndefinedAttributes($message);
231			}
232			}
233
234			/**
235			* @param array $a
236			*
237			* @throws UndefinedDataProvider
238			*
239			*/
240			protected function _throwUndefinedDataProvider(array $a)
241			{
242			if (!isset($a['data_provider'])) {
243			throw new UndefinedDataProvider(
244			'Fixture has no data provider specified. Check fixture yml file.'
245			);
246			}
247			}
248			}
249

ctasca / magefix

Pull Request — develop (#17)

AbstractBuilder::_build() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like