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

Completed

Push — master ( 10f0b5...3dd64b )

by Tim

created 2017-07-05 11:18 UTC

PreLoadEntityIdObserver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	6
lcom	1
cbo	2
dl	0
loc	71
ccs	0
cts	11
cp	0
rs	10
c	1
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getProductBunchProcessor()	4	1
A	process()	11	2
A	preLoadEntityId()	4	1
A	loadProduct()	4	1

<?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\Utils\ColumnKeys;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;

/**
 * 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\Services\ProductBunchProcessorInterface The product bunch processor instance
     */
    protected function getProductBunchProcessor()
    {
        return $this->productBunchProcessor;
    }

    /**
     * Process the observer's business logic.
     *
     * @return array The processed row
     */
    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
        $this->preLoadEntityId($this->loadProduct($sku));
    }

    /**
     * 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)
    {
        return $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\Utils\ColumnKeys;
24			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
25			use TechDivision\Import\Product\Services\ProductBunchProcessorInterface;
26
27			/**
28			* Observer that pre-loads the entity ID of the product with the SKU found in the CSV file.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2016 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/techdivision/import-product
34			* @link http://www.techdivision.com
35			*/
36			class PreLoadEntityIdObserver extends AbstractProductImportObserver
37			{
38
39			/**
40			* The product bunch processor instance.
41			*
42			* @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface
43			*/
44			protected $productBunchProcessor;
45
46			/**
47			* Initialize the observer with the passed product bunch processor instance.
48			*
49			* @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor The product bunch processor instance
50			*/
51			public function __construct(ProductBunchProcessorInterface $productBunchProcessor)
52			{
53			$this->productBunchProcessor = $productBunchProcessor;
54			}
55
56			/**
57			* Return's the product bunch processor instance.
58			*
59			* @return \TechDivision\Import\Services\ProductBunchProcessorInterface The product bunch processor instance
60			*/
61			protected function getProductBunchProcessor()
62			{
63			return $this->productBunchProcessor;
64			}
65
66			/**
67			* Process the observer's business logic.
68			*
69			* @return array The processed row
70			*/
71			protected function process()
72			{
73
74			// query whether or not, we've found a new SKU => means we've found a new product
75			if ($this->isLastSku($sku = $this->getValue(ColumnKeys::SKU))) {
76			return;
77			}
78
79			// preserve the entity ID for the product with the passed SKU
80			$this->preLoadEntityId($this->loadProduct($sku));
81			}
82
83			/**
84			* Pre-load the entity ID for the passed product.
85			*
86			* @param array $product The product to be pre-loaded
87			*
88			* @return void
89			*/
90			protected function preLoadEntityId(array $product)
91			{
92			return $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...
93			}
94
95			/**
96			* Load's and return's the product with the passed SKU.
97			*
98			* @param string $sku The SKU of the product to load
99			*
100			* @return array The product
101			*/
102			protected function loadProduct($sku)
103			{
104			return $this->getProductBunchProcessor()->loadProduct($sku);
105			}
106			}
107

techdivision / import-product

Push — master ( 10f0b5...3dd64b )

PreLoadEntityIdObserver A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like