PreLoadEntityIdObserver - Code Metrics - Inspection of "Remove service alias deprecation" - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 19.x ( 353011...e6f787 )

by Tim

created 2019-12-30 15:22 UTC

PreLoadEntityIdObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	85
Duplicated Lines	28.24 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

95.24%

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	4
dl	24
loc	85
ccs	20
cts	21
cp	0.9524
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getProductBunchProcessor()	0	4	1
A	process()	24	24	4
A	preLoadEntityId()	0	4	1
A	loadProduct()	0	4	1

How to fix Duplicated Code

<?php

/**
 * TechDivision\Import\Product\Observers\PreLoadEntityIdObserver
 *
 * 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
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Observers;

use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;
use TechDivision\Import\Product\Utils\ColumnKeys;

/**
 * Observer that pre-loads the entity ID of the product with the SKU found in the CSV file.
 *
 * @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
 * @link      http://www.techdivision.com
 */
class PreLoadEntityIdObserver extends AbstractProductImportObserver
{

    /**
     * The product bunch processor instance.
     *
     * @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
     */
    protected $productBunchProcessor;

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

    /**
     * Return's the product bunch processor instance.
     *
     * @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
     */
    protected function getProductBunchProcessor()
    {
        return $this->productBunchProcessor;
    }

    /**
     * Process the observer's business logic.
     *
     * @return array The processed row
     * @throws \Exception Is thrown, if the product with the SKU can not be loaded
     */
    protected function process()

    {

        // query whether or not, we've found a new SKU => means we've found a new product
        if ($this->isLastSku($sku = $this->getValue(ColumnKeys::SKU))) {
            return;
        }

        // preserve the entity ID for the product with the passed SKU
        if ($product = $this->loadProduct($sku)) {
            $this->preLoadEntityId($product);
        } else {
            // initialize the error message
            $message = sprintf('Can\'t pre-load product with SKU %s', $sku);
            // load the subject
            $subject = $this->getSubject();
            // query whether or not debug mode has been enabled
            if ($subject->isDebugMode()) {
                $subject->getSystemLogger()->warning($subject->appendExceptionSuffix($message));
            } else {
                throw new \Exception($message);
            }
        }
    }

    /**
     * Pre-load the entity ID for the passed product.
     *
     * @param array $product The product to be pre-loaded
     *
     * @return void
     */
    protected function preLoadEntityId(array $product)
    {
        $this->getSubject()->preLoadEntityId($product);
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.
    }
}
    }

    /**
     * Load's and return's the product with the passed SKU.
     *
     * @param string $sku The SKU of the product to load
     *
     * @return array The product
     */
    protected function loadProduct($sku)
    {
        return $this->getProductBunchProcessor()->loadProduct($sku);
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Observers\PreLoadEntityIdObserver
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
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Observers;
22
23			use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;
24			use TechDivision\Import\Product\Utils\ColumnKeys;
25
26			/**
27			* Observer that pre-loads the entity ID of the product with the SKU found in the CSV file.
28			*
29			* @author Tim Wagner <[email protected]>
30			* @copyright 2016 TechDivision GmbH <[email protected]>
31			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
32			* @link https://github.com/techdivision/import-product
33			* @link http://www.techdivision.com
34			*/
35			class PreLoadEntityIdObserver extends AbstractProductImportObserver
36			{
37
38			/**
39			* The product bunch processor instance.
40			*
41			* @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
42			*/
43			protected $productBunchProcessor;
44
45			/**
46			* Initialize the observer with the passed product bunch processor instance.
47			*
48			* @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor The product bunch processor instance
49			*/
50	3		public function __construct(ProductBunchProcessorInterface $productBunchProcessor)
51			{
52	3		$this->productBunchProcessor = $productBunchProcessor;
53	3		}
54
55			/**
56			* Return's the product bunch processor instance.
57			*
58			* @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance
59			*/
60	2		protected function getProductBunchProcessor()
61			{
62	2		return $this->productBunchProcessor;
63			}
64
65			/**
66			* Process the observer's business logic.
67			*
68			* @return array The processed row
69			* @throws \Exception Is thrown, if the product with the SKU can not be loaded
70			*/
71	3	View Code Duplication	protected function process()
			0 ignored issues – show Duplication introduced 2018-02-23 14:56 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...
72			{
73
74			// query whether or not, we've found a new SKU => means we've found a new product
75	3		if ($this->isLastSku($sku = $this->getValue(ColumnKeys::SKU))) {
76	1		return;
77			}
78
79			// preserve the entity ID for the product with the passed SKU
80	2		if ($product = $this->loadProduct($sku)) {
81	1		$this->preLoadEntityId($product);
82			} else {
83			// initialize the error message
84	1		$message = sprintf('Can\'t pre-load product with SKU %s', $sku);
85			// load the subject
86	1		$subject = $this->getSubject();
87			// query whether or not debug mode has been enabled
88	1		if ($subject->isDebugMode()) {
89			$subject->getSystemLogger()->warning($subject->appendExceptionSuffix($message));
90			} else {
91	1		throw new \Exception($message);
92			}
93			}
94	1		}
95
96			/**
97			* Pre-load the entity ID for the passed product.
98			*
99			* @param array $product The product to be pre-loaded
100			*
101			* @return void
102			*/
103	1		protected function preLoadEntityId(array $product)
104			{
105	1		$this->getSubject()->preLoadEntityId($product);
			0 ignored issues – show Bug introduced 2017-06-08 11:20 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 `preLoadEntityId()` does only exist in the following implementations of said interface: `TechDivision\Import\Product\Subjects\BunchSubject`. 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...
106	1		}
107
108			/**
109			* Load's and return's the product with the passed SKU.
110			*
111			* @param string $sku The SKU of the product to load
112			*
113			* @return array The product
114			*/
115	2		protected function loadProduct($sku)
116			{
117	2		return $this->getProductBunchProcessor()->loadProduct($sku);
118			}
119			}
120

techdivision / import-product

Push — 19.x ( 353011...e6f787 )

PreLoadEntityIdObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like