StockDiffProcessor::validate() - Code Metrics - Inspection of "Disable coverage" - nanasess/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — experimental/sf (#31)

by Kentaro

created 2018-08-08 04:16 UTC

StockDiffProcessor::validate() B

↳ Parent: StockDiffProcessor

Complexity

Conditions	8
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	7
nop	2
dl	0
loc	36
rs	8.0995
c	0
b	0
f	0

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Eccube\Service\PurchaseFlow\Processor;

use Eccube\Entity\ItemHolderInterface;
use Eccube\Entity\Master\OrderStatus;
use Eccube\Entity\ProductClass;
use Eccube\Entity\ProductStock;
use Eccube\Repository\ProductClassRepository;
use Eccube\Service\PurchaseFlow\ItemHolderValidator;
use Eccube\Service\PurchaseFlow\PurchaseContext;
use Eccube\Service\PurchaseFlow\PurchaseException;
use Eccube\Service\PurchaseFlow\PurchaseProcessor;

/**
 * 編集前/編集後の個数の差分にもとづいて在庫を更新します.
 */
class StockDiffProcessor extends ItemHolderValidator implements PurchaseProcessor
{
    /**
     * @var ProductClassRepository
     */
    protected $productClassRepository;

    /**
     * StockProcessor constructor.
     *
     * @param ProductClassRepository $productClassRepository
     */
    public function __construct(ProductClassRepository $productClassRepository)
    {
        $this->productClassRepository = $productClassRepository;
    }

    /**
     * @param ItemHolderInterface $itemHolder
     * @param PurchaseContext $context
     *
     * @throws \Eccube\Service\PurchaseFlow\InvalidItemException
     */
    public function validate(ItemHolderInterface $itemHolder, PurchaseContext $context)
    {
        if (is_null($context->getOriginHolder())) {
            return;
        }

        $From = $context->getOriginHolder();
        $To = $itemHolder;
        $diff = $this->getDiffOfQuantities($From, $To);

        foreach ($diff as $id => $quantity) {
            /** @var ProductClass $ProductClass */
            $ProductClass = $this->productClassRepository->find($id);
            if ($ProductClass->isStockUnlimited()) {
                continue;
            }
            $stock = $ProductClass->getStock();
            // 更新後ステータスがキャンセルの場合は, 差分ではなく更新後の個数で確認.
            if ($To->getOrderStatus() && $To->getOrderStatus()->getId() == OrderStatus::CANCEL) {
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.
    }
}
                $Items = $To->getProductOrderItems();
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.
    }
}
                $Items = array_filter($Items, function ($Item) use ($id) {
                    return $Item->getProductClass()->getId() == $id;
                });
                $toQuantity = array_reduce($Items, function ($quantity, $Item) {
                    return $quantity += $Item->getQuantity();
                }, 0);
                if ($stock - $toQuantity < 0) {
                    $this->throwInvalidItemException(sprintf('%s: 在庫がたりません', $ProductClass->formatedProductName()));
                }
            } else {
                if ($stock - $quantity < 0) {
                    $this->throwInvalidItemException(sprintf('%s: 在庫がたりません', $ProductClass->formatedProductName()));
                }
            }
        }
    }

    protected function getDiffOfQuantities(ItemHolderInterface $From, ItemHolderInterface $To)
    {
        $FromItems = $this->getQuantityByProductClass($From);
        $ToItems = $this->getQuantityByProductClass($To);
        $ids = array_unique(array_merge(array_keys($FromItems), array_keys($ToItems)));

        $diff = [];
        foreach ($ids as $id) {
            // 更新された明細
            if (isset($FromItems[$id]) && isset($ToItems[$id])) {
                // 2 -> 3 = +1

                // 2 -> 1 = -1

                $diff[$id] = $ToItems[$id] - $FromItems[$id];
            } // 削除された明細
            elseif (isset($FromItems[$id]) && empty($ToItems[$id])) {

                // 2 -> 0 = -2

                $diff[$id] = $FromItems[$id] * -1;
            } // 追加された明細
            elseif (!isset($FromItems[$id]) && isset($ToItems[$id])) {

                // 0 -> 2 = +2

                $diff[$id] = $ToItems[$id];
            }
        }

        return $diff;
    }

    protected function getQuantityByProductClass(ItemHolderInterface $ItemHolder)
    {
        $ItemsByProductClass = [];
        foreach ($ItemHolder->getItems() as $Item) {
            if ($Item->isProduct()) {
                $id = $Item->getProductClass()->getId();
                if (isset($ItemsByProductClass[$id])) {
                    $ItemsByProductClass[$id] += $Item->getQuantity();
                } else {
                    $ItemsByProductClass[$id] = $Item->getQuantity();
                }
            }
        }

        return $ItemsByProductClass;
    }

    /**
     * 受注の仮確定処理を行います。
     *
     * @param ItemHolderInterface $target
     * @param PurchaseContext $context
     *
     * @throws PurchaseException
     */
    public function prepare(ItemHolderInterface $target, PurchaseContext $context)
    {
        if (is_null($context->getOriginHolder())) {
            return;
        }

        $diff = $this->getDiffOfQuantities($context->getOriginHolder(), $target);

        foreach ($diff as $id => $quantity) {
            /** @var ProductClass $ProductClass */
            $ProductClass = $this->productClassRepository->find($id);
            if ($ProductClass->isStockUnlimited()) {
                continue;
            }

            $stock = $ProductClass->getStock() - $quantity;
            $ProductStock = $ProductClass->getProductStock();
            if (!$ProductStock) {
                $ProductStock = new ProductStock();
                $ProductStock->setProductClass($ProductClass);
                $ProductClass->setProductStock($ProductStock);
            }
            $ProductClass->setStock($stock);
            $ProductStock->setStock($stock);
        }
    }

    /**
     * 受注の確定処理を行います。
     *
     * @param ItemHolderInterface $target
     * @param PurchaseContext $context
     *
     * @throws PurchaseException
     */
    public function commit(ItemHolderInterface $target, PurchaseContext $context)
    {
        // 何もしない.
        return;
    }

    /**
     * 仮確定した受注データの取り消し処理を行います。
     *
     * @param ItemHolderInterface $itemHolder
     * @param PurchaseContext $context
     */
    public function rollback(ItemHolderInterface $itemHolder, PurchaseContext $context)
    {
        // 何もしない.
        return;
    }
}


Pull Request — experimental/sf (#31)

StockDiffProcessor::validate() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1		<?php
2
3		/*
4		* This file is part of EC-CUBE
5		*
6		* Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
7		*
8		* http://www.lockon.co.jp/
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Eccube\Service\PurchaseFlow\Processor;
15
16		use Eccube\Entity\ItemHolderInterface;
17		use Eccube\Entity\Master\OrderStatus;
18		use Eccube\Entity\ProductClass;
19		use Eccube\Entity\ProductStock;
20		use Eccube\Repository\ProductClassRepository;
21		use Eccube\Service\PurchaseFlow\ItemHolderValidator;
22		use Eccube\Service\PurchaseFlow\PurchaseContext;
23		use Eccube\Service\PurchaseFlow\PurchaseException;
24		use Eccube\Service\PurchaseFlow\PurchaseProcessor;
25
26		/**
27		* 編集前/編集後の個数の差分にもとづいて在庫を更新します.
28		*/
29		class StockDiffProcessor extends ItemHolderValidator implements PurchaseProcessor
30		{
31		/**
32		* @var ProductClassRepository
33		*/
34		protected $productClassRepository;
35
36		/**
37		* StockProcessor constructor.
38		*
39		* @param ProductClassRepository $productClassRepository
40		*/
41		public function __construct(ProductClassRepository $productClassRepository)
42		{
43		$this->productClassRepository = $productClassRepository;
44		}
45
46		/**
47		* @param ItemHolderInterface $itemHolder
48		* @param PurchaseContext $context
49		*
50		* @throws \Eccube\Service\PurchaseFlow\InvalidItemException
51		*/
52		public function validate(ItemHolderInterface $itemHolder, PurchaseContext $context)
53		{
54		if (is_null($context->getOriginHolder())) {
55		return;
56		}
57
58		$From = $context->getOriginHolder();
59		$To = $itemHolder;
60		$diff = $this->getDiffOfQuantities($From, $To);
61
62		foreach ($diff as $id => $quantity) {
63		/** @var ProductClass $ProductClass */
64		$ProductClass = $this->productClassRepository->find($id);
65		if ($ProductClass->isStockUnlimited()) {
66		continue;
67		}
68		$stock = $ProductClass->getStock();
69		// 更新後ステータスがキャンセルの場合は, 差分ではなく更新後の個数で確認.
70		if ($To->getOrderStatus() && $To->getOrderStatus()->getId() == OrderStatus::CANCEL) {
		0 ignored issues – show Bug introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Eccube\Entity\ItemHolderInterface` as the method `getOrderStatus()` does only exist in the following implementations of said interface: `Eccube\Entity\Order`. 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...
71		$Items = $To->getProductOrderItems();
		0 ignored issues – show Bug introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Eccube\Entity\ItemHolderInterface` as the method `getProductOrderItems()` does only exist in the following implementations of said interface: `Eccube\Entity\Order`. 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...
72		$Items = array_filter($Items, function ($Item) use ($id) {
73		return $Item->getProductClass()->getId() == $id;
74		});
75		$toQuantity = array_reduce($Items, function ($quantity, $Item) {
76		return $quantity += $Item->getQuantity();
77		}, 0);
78		if ($stock - $toQuantity < 0) {
79		$this->throwInvalidItemException(sprintf('%s: 在庫がたりません', $ProductClass->formatedProductName()));
80		}
81		} else {
82		if ($stock - $quantity < 0) {
83		$this->throwInvalidItemException(sprintf('%s: 在庫がたりません', $ProductClass->formatedProductName()));
84		}
85		}
86		}
87		}
88
89		protected function getDiffOfQuantities(ItemHolderInterface $From, ItemHolderInterface $To)
90		{
91		$FromItems = $this->getQuantityByProductClass($From);
92		$ToItems = $this->getQuantityByProductClass($To);
93		$ids = array_unique(array_merge(array_keys($FromItems), array_keys($ToItems)));
94
95		$diff = [];
96		foreach ($ids as $id) {
97		// 更新された明細
98		if (isset($FromItems[$id]) && isset($ToItems[$id])) {
99		// 2 -> 3 = +1
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
100		// 2 -> 1 = -1
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
101		$diff[$id] = $ToItems[$id] - $FromItems[$id];
102		} // 削除された明細
103	View Code Duplication	elseif (isset($FromItems[$id]) && empty($ToItems[$id])) {
		0 ignored issues – show Duplication introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
104		// 2 -> 0 = -2
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
105		$diff[$id] = $FromItems[$id] * -1;
106		} // 追加された明細
107	View Code Duplication	elseif (!isset($FromItems[$id]) && isset($ToItems[$id])) {
		0 ignored issues – show Duplication introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
108		// 0 -> 2 = +2
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-07-25 08:38 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
109		$diff[$id] = $ToItems[$id];
110		}
111		}
112
113		return $diff;
114		}
115
116		protected function getQuantityByProductClass(ItemHolderInterface $ItemHolder)
117		{
118		$ItemsByProductClass = [];
119		foreach ($ItemHolder->getItems() as $Item) {
120		if ($Item->isProduct()) {
121		$id = $Item->getProductClass()->getId();
122		if (isset($ItemsByProductClass[$id])) {
123		$ItemsByProductClass[$id] += $Item->getQuantity();
124		} else {
125		$ItemsByProductClass[$id] = $Item->getQuantity();
126		}
127		}
128		}
129
130		return $ItemsByProductClass;
131		}
132
133		/**
134		* 受注の仮確定処理を行います。
135		*
136		* @param ItemHolderInterface $target
137		* @param PurchaseContext $context
138		*
139		* @throws PurchaseException
140		*/
141		public function prepare(ItemHolderInterface $target, PurchaseContext $context)
142		{
143		if (is_null($context->getOriginHolder())) {
144		return;
145		}
146
147		$diff = $this->getDiffOfQuantities($context->getOriginHolder(), $target);
148
149		foreach ($diff as $id => $quantity) {
150		/** @var ProductClass $ProductClass */
151		$ProductClass = $this->productClassRepository->find($id);
152		if ($ProductClass->isStockUnlimited()) {
153		continue;
154		}
155
156		$stock = $ProductClass->getStock() - $quantity;
157		$ProductStock = $ProductClass->getProductStock();
158		if (!$ProductStock) {
159		$ProductStock = new ProductStock();
160		$ProductStock->setProductClass($ProductClass);
161		$ProductClass->setProductStock($ProductStock);
162		}
163		$ProductClass->setStock($stock);
164		$ProductStock->setStock($stock);
165		}
166		}
167
168		/**
169		* 受注の確定処理を行います。
170		*
171		* @param ItemHolderInterface $target
172		* @param PurchaseContext $context
173		*
174		* @throws PurchaseException
175		*/
176		public function commit(ItemHolderInterface $target, PurchaseContext $context)
177		{
178		// 何もしない.
179		return;
180		}
181
182		/**
183		* 仮確定した受注データの取り消し処理を行います。
184		*
185		* @param ItemHolderInterface $itemHolder
186		* @param PurchaseContext $context
187		*/
188		public function rollback(ItemHolderInterface $itemHolder, PurchaseContext $context)
189		{
190		// 何もしない.
191		return;
192		}
193		}
194

nanasess / ec-cube

Pull Request — experimental/sf (#31)

StockDiffProcessor::validate() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like