BundleOptionObserver - Code Metrics - Inspection of "Merge pull request #15 from wagnert/master" - techdivision/import-product-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a3ab00...b679e8 )

by Tim

created 2017-07-05 11:55 UTC

BundleOptionObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	165
Duplicated Lines	13.94 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	13
lcom	1
cbo	2
dl	23
loc	165
ccs	0
cts	64
cp	0
rs	10
c	0
b	0
f	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getProductBundleProcessor()	0	4	1
A	process()	23	23	3
B	prepareAttributes()	0	28	2
A	initializeBundleOption()	0	4	1
A	resetPositionCounter()	0	4	1
A	addNameOptionIdMapping()	0	4	1
A	exists()	0	4	1
A	mapSku()	0	4	1
A	persistProductBundleOption()	0	4	1

How to fix Duplicated Code

<?php

/**
 * TechDivision\Import\Product\Bundle\Observers\BundleOptionObserver
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-bundle
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Bundle\Observers;

use TechDivision\Import\Utils\StoreViewCodes;
use TechDivision\Import\Product\Bundle\Utils\ColumnKeys;
use TechDivision\Import\Product\Bundle\Utils\MemberNames;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
use TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface;

/**
 * Oberserver that provides functionality for the bundle option replace operation.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-bundle
 * @link      http://www.techdivision.com
 */
class BundleOptionObserver extends AbstractProductImportObserver
{

    /**
     * The product bundle processor instance.
     *
     * @var \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface
     */
    protected $productBundleProcessor;

    /**
     * Initialize the observer with the passed product bundle processor instance.
     *
     * @param \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface $productBundleProcessor The product bundle processor instance
     */
    public function __construct(ProductBundleProcessorInterface $productBundleProcessor)
    {
        $this->productBundleProcessor = $productBundleProcessor;
    }

    /**
     * Return's the product bundle processor instance.
     *
     * @return \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface The product bundle processor instance
     */
    protected function getProductBundleProcessor()
    {
        return $this->productBundleProcessor;
    }

    /**
     * Process the observer's business logic.
     *
     * @return array The processed row
     */
    protected function process()

    {

        // prepare the store view code
        $this->prepareStoreViewCode($this->getRow());


        // return immediately if we're have no store view code set
        if (StoreViewCodes::ADMIN !== $this->getStoreViewCode(StoreViewCodes::ADMIN)) {
            return;
        }

        // query whether or not the option has already been created
        if (!$this->exists($name = $this->getValue(ColumnKeys::BUNDLE_VALUE_NAME))) {
            // load the bundle option
            $bundleOption = $this->initializeBundleOption($this->prepareAttributes());

            // persist the product bundle option
            $optionId = $this->persistProductBundleOption($bundleOption);

            // store the name => option ID mapping
            $this->addNameOptionIdMapping($name, $optionId);
        }
    }

    /**
     * Prepare the attributes of the entity that has to be persisted.
     *
     * @return array The prepared attributes
     */
    protected function prepareAttributes()
    {

        // reset the position counter for the bundle selection
        $this->resetPositionCounter();

        try {
            // load and map the parent SKU
            $parentId = $this->mapSku($this->getValue(ColumnKeys::BUNDLE_PARENT_SKU));
        } catch (\Exception $e) {
            throw $this->wrapException(array(ColumnKeys::BUNDLE_PARENT_SKU), $e);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        // extract the parent/child ID as well as type and position
        $required = $this->getValue(ColumnKeys::BUNDLE_VALUE_REQUIRED);
        $type = $this->getValue(ColumnKeys::BUNDLE_VALUE_TYPE);
        $position = 1;

        // return the prepared product
        return $this->initializeEntity(
            array(
                MemberNames::PARENT_ID => $parentId,
                MemberNames::REQUIRED  => $required,
                MemberNames::POSITION  => $position,
                MemberNames::TYPE      => $type
            )
        );
    }

    /**
     * Initialize the bundle option with the passed attributes and returns an instance.
     *
     * @param array $attr The bundle option attributes
     *
     * @return array The initialized bundle option
     */
    protected function initializeBundleOption(array $attr)
    {
        return $attr;
    }

    /**
     * Reset the position counter to 1.
     *
     * @return void
     */
    protected function resetPositionCounter()
    {
        $this->getSubject()->resetPositionCounter();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Add's the mapping for the passed name => option ID.
     *
     * @param string  $name     The name of the option
     * @param integer $optionId The created option ID
     *
     * @return void
     */
    protected function addNameOptionIdMapping($name, $optionId)
    {
        $this->getSubject()->addNameOptionIdMapping($name, $optionId);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Query whether or not the option with the passed name has already been created.
     *
     * @param string $name The option name to query for
     *
     * @return boolean TRUE if the option already exists, else FALSE
     */
    protected function exists($name)
    {
        return $this->getSubject()->exists($name);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Return the entity ID for the passed SKU.
     *
     * @param string $sku The SKU to return the entity ID for
     *
     * @return integer The mapped entity ID
     * @throws \Exception Is thrown if the SKU is not mapped yet
     */
    protected function mapSku($sku)
    {
        return $this->getSubject()->mapSkuToEntityId($sku);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Persist's the passed product bundle option data and return's the ID.
     *
     * @param array $productBundleOption The product bundle option data to persist
     *
     * @return string The ID of the persisted entity
     */
    protected function persistProductBundleOption($productBundleOption)
    {
        return $this->getProductBundleProcessor()->persistProductBundleOption($productBundleOption);
    }
}


Push — master ( a3ab00...b679e8 )

BundleOptionObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		/**
4		* TechDivision\Import\Product\Bundle\Observers\BundleOptionObserver
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Tim Wagner <[email protected]>
15		* @copyright 2016 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link https://github.com/techdivision/import-product-bundle
18		* @link http://www.techdivision.com
19		*/
20
21		namespace TechDivision\Import\Product\Bundle\Observers;
22
23		use TechDivision\Import\Utils\StoreViewCodes;
24		use TechDivision\Import\Product\Bundle\Utils\ColumnKeys;
25		use TechDivision\Import\Product\Bundle\Utils\MemberNames;
26		use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
27		use TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface;
28
29		/**
30		* Oberserver that provides functionality for the bundle option replace operation.
31		*
32		* @author Tim Wagner <[email protected]>
33		* @copyright 2016 TechDivision GmbH <[email protected]>
34		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
35		* @link https://github.com/techdivision/import-product-bundle
36		* @link http://www.techdivision.com
37		*/
38		class BundleOptionObserver extends AbstractProductImportObserver
39		{
40
41		/**
42		* The product bundle processor instance.
43		*
44		* @var \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface
45		*/
46		protected $productBundleProcessor;
47
48		/**
49		* Initialize the observer with the passed product bundle processor instance.
50		*
51		* @param \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface $productBundleProcessor The product bundle processor instance
52		*/
53		public function __construct(ProductBundleProcessorInterface $productBundleProcessor)
54		{
55		$this->productBundleProcessor = $productBundleProcessor;
56		}
57
58		/**
59		* Return's the product bundle processor instance.
60		*
61		* @return \TechDivision\Import\Product\Bundle\Services\ProductBundleProcessorInterface The product bundle processor instance
62		*/
63		protected function getProductBundleProcessor()
64		{
65		return $this->productBundleProcessor;
66		}
67
68		/**
69		* Process the observer's business logic.
70		*
71		* @return array The processed row
72		*/
73	View Code Duplication	protected function process()
		0 ignored issues – show Duplication introduced 2017-01-03 17:14 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74		{
75
76		// prepare the store view code
77		$this->prepareStoreViewCode($this->getRow());
		0 ignored issues – show Unused Code introduced 2017-01-09 18:01 UTC by Report Bug Copy Issue Report The call to `BundleOptionObserver::prepareStoreViewCode()` has too many arguments starting with `$this->getRow()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
78
79		// return immediately if we're have no store view code set
80		if (StoreViewCodes::ADMIN !== $this->getStoreViewCode(StoreViewCodes::ADMIN)) {
81		return;
82		}
83
84		// query whether or not the option has already been created
85		if (!$this->exists($name = $this->getValue(ColumnKeys::BUNDLE_VALUE_NAME))) {
86		// load the bundle option
87		$bundleOption = $this->initializeBundleOption($this->prepareAttributes());
88
89		// persist the product bundle option
90		$optionId = $this->persistProductBundleOption($bundleOption);
91
92		// store the name => option ID mapping
93		$this->addNameOptionIdMapping($name, $optionId);
94		}
95		}
96
97		/**
98		* Prepare the attributes of the entity that has to be persisted.
99		*
100		* @return array The prepared attributes
101		*/
102		protected function prepareAttributes()
103		{
104
105		// reset the position counter for the bundle selection
106		$this->resetPositionCounter();
107
108		try {
109		// load and map the parent SKU
110		$parentId = $this->mapSku($this->getValue(ColumnKeys::BUNDLE_PARENT_SKU));
111		} catch (\Exception $e) {
112		throw $this->wrapException(array(ColumnKeys::BUNDLE_PARENT_SKU), $e);
		0 ignored issues – show Documentation introduced 2017-03-22 22:02 UTC by Report Bug Copy Issue Report `array(\TechDivision\Impo...eys::BUNDLE_PARENT_SKU)` is of type `array<integer,?>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
113		}
114
115		// extract the parent/child ID as well as type and position
116		$required = $this->getValue(ColumnKeys::BUNDLE_VALUE_REQUIRED);
117		$type = $this->getValue(ColumnKeys::BUNDLE_VALUE_TYPE);
118		$position = 1;
119
120		// return the prepared product
121		return $this->initializeEntity(
122		array(
123		MemberNames::PARENT_ID => $parentId,
124		MemberNames::REQUIRED => $required,
125		MemberNames::POSITION => $position,
126		MemberNames::TYPE => $type
127		)
128		);
129		}
130
131		/**
132		* Initialize the bundle option with the passed attributes and returns an instance.
133		*
134		* @param array $attr The bundle option attributes
135		*
136		* @return array The initialized bundle option
137		*/
138		protected function initializeBundleOption(array $attr)
139		{
140		return $attr;
141		}
142
143		/**
144		* Reset the position counter to 1.
145		*
146		* @return void
147		*/
148		protected function resetPositionCounter()
149		{
150		$this->getSubject()->resetPositionCounter();
		0 ignored issues – show Bug introduced 2017-05-19 19:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `resetPositionCounter()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
151		}
152
153		/**
154		* Add's the mapping for the passed name => option ID.
155		*
156		* @param string $name The name of the option
157		* @param integer $optionId The created option ID
158		*
159		* @return void
160		*/
161		protected function addNameOptionIdMapping($name, $optionId)
162		{
163		$this->getSubject()->addNameOptionIdMapping($name, $optionId);
		0 ignored issues – show Bug introduced 2017-05-19 19:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `addNameOptionIdMapping()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
164		}
165
166		/**
167		* Query whether or not the option with the passed name has already been created.
168		*
169		* @param string $name The option name to query for
170		*
171		* @return boolean TRUE if the option already exists, else FALSE
172		*/
173		protected function exists($name)
174		{
175		return $this->getSubject()->exists($name);
		0 ignored issues – show Bug introduced 2017-05-19 19:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `exists()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
176		}
177
178		/**
179		* Return the entity ID for the passed SKU.
180		*
181		* @param string $sku The SKU to return the entity ID for
182		*
183		* @return integer The mapped entity ID
184		* @throws \Exception Is thrown if the SKU is not mapped yet
185		*/
186		protected function mapSku($sku)
187		{
188		return $this->getSubject()->mapSkuToEntityId($sku);
		0 ignored issues – show Bug introduced 2017-05-19 19:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `mapSkuToEntityId()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...\Subjects\BundleSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
189		}
190
191		/**
192		* Persist's the passed product bundle option data and return's the ID.
193		*
194		* @param array $productBundleOption The product bundle option data to persist
195		*
196		* @return string The ID of the persisted entity
197		*/
198		protected function persistProductBundleOption($productBundleOption)
199		{
200		return $this->getProductBundleProcessor()->persistProductBundleOption($productBundleOption);
201		}
202		}
203

techdivision / import-product-bundle

Push — master ( a3ab00...b679e8 )

BundleOptionObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like