PurchaseFlow - Code Metrics - Inspection of "[WIP] カート商品周りの改修" - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — experimental/3.1 (#2486)

unknown

created 2017-09-06 06:59 UTC

PurchaseFlow A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	228
Duplicated Lines	25.88 %

Coupling/Cohesion

Components	3
Dependencies	3

Test Coverage

Coverage

90.43%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	59
loc	228
ccs	85
cts	94
cp	0.9043
rs	10
c	1
b	0
f	0
wmc	26
lcom	3
cbo	3

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	setItemProcessors()	0	4	1
A	setItemHolderProcessors()	0	4	1
A	setPurchaseProcessors()	0	4	1
A	setAddItemProcessors()	0	4	1
A	addItem()	0	12	2
B	calculate()	0	24	4
A	purchase()	0	6	2
A	addPurchaseProcessor()	0	4	1
A	addItemHolderProcessor()	0	4	1
A	addItemProcessor()	0	4	1
A	addAddItemProcessor()	0	4	1
A	calculateTotal()	0	14	2
A	calculateSubTotal()	15	15	2
A	calculateDeliveryFeeTotal()	11	11	1
A	calculateDiscount()	12	12	1
A	calculateCharge()	11	11	1
A	calculateTax()	10	10	1
A	calculateAll()	0	9	1

How to fix Duplicated Code

<?php

namespace Eccube\Service\PurchaseFlow;

use Doctrine\Common\Collections\ArrayCollection;
use Eccube\Entity\ItemHolderInterface;
use Eccube\Entity\ItemInterface;

class PurchaseFlow

{
    /**
     * @var ArrayCollection|ItemHolderProcessor[]
     */
    protected $itemHolderProcessors;

    /**
     * @var ArrayCollection|ItemProcessor[]
     */
    protected $itemProcessors;

    /**
     * @var ArrayCollection|PurchaseProcessor[]
     */
    protected $purchaseProcessors;

    /**
     * @var ArrayCollection|ItemProcessor[]
     */
    protected $addItemProcessors;

    public function __construct()

    {
        $this->itemProcessors = new ArrayCollection();
        $this->itemHolderProcessors = new ArrayCollection();
        $this->purchaseProcessors = new ArrayCollection();
        $this->addItemProcessors = new ArrayCollection();
    }

    public function setItemProcessors(ArrayCollection $processors)

    {
        $this->itemProcessors = $processors;
    }

    public function setItemHolderProcessors(ArrayCollection $processors)

    {
        $this->itemHolderProcessors = $processors;
    }

    public function setPurchaseProcessors(ArrayCollection $processors)

    {
        $this->purchaseProcessors = $processors;
    }

    public function setAddItemProcessors(ArrayCollection $addItemProcessors)

    {
        $this->addItemProcessors = $addItemProcessors;
    }

    public function addItem(ItemInterface $item, PurchaseContext $context)

    {
        $holder = $context->getOriginHolder();
        $flowResult = new PurchaseFlowResult($holder);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        foreach ($this->addItemProcessors as $addItemProcessor) {
            $result = $addItemProcessor->process($item, $context);
            $flowResult->addProcessResult($result);
        }

        return $flowResult;
    }

    public function calculate(ItemHolderInterface $itemHolder, PurchaseContext $context)

    {
        $this->calculateAll($itemHolder);

        $flowResult = new PurchaseFlowResult($itemHolder);

        foreach ($itemHolder->getItems() as $item) {
            foreach ($this->itemProcessors as $itemProsessor) {
                $result = $itemProsessor->process($item, $context);
                $flowResult->addProcessResult($result);
            }
        }

        $this->calculateAll($itemHolder);

        foreach ($this->itemHolderProcessors as $holderProcessor) {
            $result = $holderProcessor->process($itemHolder, $context);
            $flowResult->addProcessResult($result);
        }

        $this->calculateAll($itemHolder);

        return $flowResult;
    }

    /**
     * @param ItemHolderInterface $target
     * @param PurchaseContext     $context
     *
     * @throws PurchaseException
     */
    public function purchase(ItemHolderInterface $target, PurchaseContext $context)
    {
        foreach ($this->purchaseProcessors as $processor) {
            $processor->process($target, $context);
        }
    }

    public function addPurchaseProcessor(PurchaseProcessor $processor)

    {
        $this->purchaseProcessors[] = $processor;
    }

    public function addItemHolderProcessor(ItemHolderProcessor $prosessor)

    {
        $this->itemHolderProcessors[] = $prosessor;
    }

    public function addItemProcessor(ItemProcessor $prosessor)

    {
        $this->itemProcessors[] = $prosessor;
    }

    public function addAddItemProcessor(ItemProcessor $prosessor)

    {
        $this->addItemProcessors[] = $prosessor;
    }

    /**
     * @param ItemHolderInterface $itemHolder
     */
    protected function calculateTotal(ItemHolderInterface $itemHolder)
    {
        $total = $itemHolder->getItems()->reduce(function ($sum, ItemInterface $item) {
            $sum += $item->getPriceIncTax() * $item->getQuantity();

            return $sum;
        }, 0);
        $itemHolder->setTotal($total);
        // TODO
        if ($itemHolder instanceof \Eccube\Entity\Order) {
            // Order には PaymentTotal もセットする
            $itemHolder->setPaymentTotal($total);
        }
    }

    protected function calculateSubTotal(ItemHolderInterface $itemHolder)

    {
        $total = $itemHolder->getItems()
            ->getProductClasses()
            ->reduce(function ($sum, ItemInterface $item) {
                $sum += $item->getPriceIncTax() * $item->getQuantity();

                return $sum;
            }, 0);
        // TODO
        if ($itemHolder instanceof \Eccube\Entity\Order) {
            // Order の場合は SubTotal をセットする
            $itemHolder->setSubTotal($total);
        }
    }

    /**
     * @param ItemHolderInterface $itemHolder
     */
    protected function calculateDeliveryFeeTotal(ItemHolderInterface $itemHolder)

    {
        $total = $itemHolder->getItems()
            ->getDeliveryFees()
            ->reduce(function ($sum, ItemInterface $item) {
                $sum += $item->getPriceIncTax() * $item->getQuantity();

                return $sum;
            }, 0);
        $itemHolder->setDeliveryFeeTotal($total);
    }

    /**
     * @param ItemHolderInterface $itemHolder
     */
    protected function calculateDiscount(ItemHolderInterface $itemHolder)

    {
        $total = $itemHolder->getItems()
            ->getDiscounts()
            ->reduce(function ($sum, ItemInterface $item) {
                $sum += $item->getPriceIncTax() * $item->getQuantity();

                return $sum;
            }, 0);
        // TODO 後方互換のため discount には正の整数を代入する
        $itemHolder->setDiscount($total * -1);
    }

    /**
     * @param ItemHolderInterface $itemHolder
     */
    protected function calculateCharge(ItemHolderInterface $itemHolder)

    {
        $total = $itemHolder->getItems()
            ->getCharges()
            ->reduce(function ($sum, ItemInterface $item) {
                $sum += $item->getPriceIncTax() * $item->getQuantity();

                return $sum;
            }, 0);
        $itemHolder->setCharge($total);
    }

    /**
     * @param ItemHolderInterface $itemHolder
     */
    protected function calculateTax(ItemHolderInterface $itemHolder)

    {
        $total = $itemHolder->getItems()
            ->reduce(function ($sum, ItemInterface $item) {
                $sum += ($item->getPriceIncTax() - $item->getPrice()) * $item->getQuantity();

                return $sum;
            }, 0);
        $itemHolder->setTax($total);
    }

    /**
     * @param ItemHolderInterface $itemHolder
     */
    protected function calculateAll(ItemHolderInterface $itemHolder)
    {
        $this->calculateDeliveryFeeTotal($itemHolder);
        $this->calculateCharge($itemHolder);
        $this->calculateDiscount($itemHolder);
        $this->calculateSubTotal($itemHolder); // Order の場合のみ
        $this->calculateTax($itemHolder);
        $this->calculateTotal($itemHolder);
    }
}


1			<?php
2
3			namespace Eccube\Service\PurchaseFlow;
4
5			use Doctrine\Common\Collections\ArrayCollection;
6			use Eccube\Entity\ItemHolderInterface;
7			use Eccube\Entity\ItemInterface;
8
9			class PurchaseFlow
			0 ignored issues – show introduced 2017-07-20 09:47 UTC by Report Bug Copy Issue Report Missing class doc comment Loading history...
10			{
11			/**
12			* @var ArrayCollection\|ItemHolderProcessor[]
13			*/
14			protected $itemHolderProcessors;
15
16			/**
17			* @var ArrayCollection\|ItemProcessor[]
18			*/
19			protected $itemProcessors;
20
21			/**
22			* @var ArrayCollection\|PurchaseProcessor[]
23			*/
24			protected $purchaseProcessors;
25
26			/**
27			* @var ArrayCollection\|ItemProcessor[]
28			*/
29			protected $addItemProcessors;
30
31	49		public function __construct()
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
32			{
33	49		$this->itemProcessors = new ArrayCollection();
34	49		$this->itemHolderProcessors = new ArrayCollection();
35	49		$this->purchaseProcessors = new ArrayCollection();
36	49		$this->addItemProcessors = new ArrayCollection();
37			}
38
39	24		public function setItemProcessors(ArrayCollection $processors)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
40			{
41	24		$this->itemProcessors = $processors;
42			}
43
44	24		public function setItemHolderProcessors(ArrayCollection $processors)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
45			{
46	24		$this->itemHolderProcessors = $processors;
47			}
48
49			public function setPurchaseProcessors(ArrayCollection $processors)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
50			{
51			$this->purchaseProcessors = $processors;
52			}
53
54	32		public function setAddItemProcessors(ArrayCollection $addItemProcessors)
			0 ignored issues – show introduced 2017-09-06 07:00 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
55			{
56	32		$this->addItemProcessors = $addItemProcessors;
57			}
58
59	15		public function addItem(ItemInterface $item, PurchaseContext $context)
			0 ignored issues – show introduced 2017-09-06 07:00 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
60			{
61	15		$holder = $context->getOriginHolder();
62	15		$flowResult = new PurchaseFlowResult($holder);
			0 ignored issues – show Bug introduced 2017-09-06 07:00 UTC by Report Bug Copy Issue Report It seems like `$holder` defined by `$context->getOriginHolder()` on line `61` can be `null`; however, `Eccube\Service\PurchaseF...owResult::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
63
64	15		foreach ($this->addItemProcessors as $addItemProcessor) {
65	15		$result = $addItemProcessor->process($item, $context);
66	15		$flowResult->addProcessResult($result);
67			}
68
69	15		return $flowResult;
70			}
71
72	20		public function calculate(ItemHolderInterface $itemHolder, PurchaseContext $context)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
73			{
74	20		$this->calculateAll($itemHolder);
75
76	20		$flowResult = new PurchaseFlowResult($itemHolder);
77
78	20		foreach ($itemHolder->getItems() as $item) {
79	15		foreach ($this->itemProcessors as $itemProsessor) {
80	15		$result = $itemProsessor->process($item, $context);
81	15		$flowResult->addProcessResult($result);
82			}
83			}
84
85	20		$this->calculateAll($itemHolder);
86
87	20		foreach ($this->itemHolderProcessors as $holderProcessor) {
88	16		$result = $holderProcessor->process($itemHolder, $context);
89	16		$flowResult->addProcessResult($result);
90			}
91
92	20		$this->calculateAll($itemHolder);
93
94	20		return $flowResult;
95			}
96
97			/**
98			* @param ItemHolderInterface $target
99			* @param PurchaseContext $context
100			*
101			* @throws PurchaseException
102			*/
103			public function purchase(ItemHolderInterface $target, PurchaseContext $context)
104			{
105			foreach ($this->purchaseProcessors as $processor) {
106			$processor->process($target, $context);
107			}
108			}
109
110	8		public function addPurchaseProcessor(PurchaseProcessor $processor)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
111			{
112	8		$this->purchaseProcessors[] = $processor;
113			}
114
115	32		public function addItemHolderProcessor(ItemHolderProcessor $prosessor)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
116			{
117	32		$this->itemHolderProcessors[] = $prosessor;
118			}
119
120	33		public function addItemProcessor(ItemProcessor $prosessor)
			0 ignored issues – show introduced 2017-08-02 04:20 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
121			{
122	33		$this->itemProcessors[] = $prosessor;
123			}
124
125	2		public function addAddItemProcessor(ItemProcessor $prosessor)
			0 ignored issues – show introduced 2017-09-06 07:00 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
126			{
127	2		$this->addItemProcessors[] = $prosessor;
128			}
129
130			/**
131			* @param ItemHolderInterface $itemHolder
132			*/
133	20		protected function calculateTotal(ItemHolderInterface $itemHolder)
134			{
135			$total = $itemHolder->getItems()->reduce(function ($sum, ItemInterface $item) {
136	15		$sum += $item->getPriceIncTax() * $item->getQuantity();
137
138	15		return $sum;
139	20		}, 0);
140	20		$itemHolder->setTotal($total);
141			// TODO
142	20		if ($itemHolder instanceof \Eccube\Entity\Order) {
143			// Order には PaymentTotal もセットする
144	13		$itemHolder->setPaymentTotal($total);
145			}
146			}
147
148	20	View Code Duplication	protected function calculateSubTotal(ItemHolderInterface $itemHolder)
			0 ignored issues – show Duplication introduced 2017-08-02 04:20 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...
149			{
150	20		$total = $itemHolder->getItems()
151	20		->getProductClasses()
152			->reduce(function ($sum, ItemInterface $item) {
153	13		$sum += $item->getPriceIncTax() * $item->getQuantity();
154
155	13		return $sum;
156	20		}, 0);
157			// TODO
158	20		if ($itemHolder instanceof \Eccube\Entity\Order) {
159			// Order の場合は SubTotal をセットする
160	13		$itemHolder->setSubTotal($total);
161			}
162			}
163
164			/**
165			* @param ItemHolderInterface $itemHolder
166			*/
167	20	View Code Duplication	protected function calculateDeliveryFeeTotal(ItemHolderInterface $itemHolder)
			0 ignored issues – show Duplication introduced 2017-08-02 04:20 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...
168			{
169	20		$total = $itemHolder->getItems()
170	20		->getDeliveryFees()
171			->reduce(function ($sum, ItemInterface $item) {
172	11		$sum += $item->getPriceIncTax() * $item->getQuantity();
173
174	11		return $sum;
175	20		}, 0);
176	20		$itemHolder->setDeliveryFeeTotal($total);
177			}
178
179			/**
180			* @param ItemHolderInterface $itemHolder
181			*/
182	20	View Code Duplication	protected function calculateDiscount(ItemHolderInterface $itemHolder)
			0 ignored issues – show Duplication introduced 2017-08-02 04:20 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...
183			{
184	20		$total = $itemHolder->getItems()
185	20		->getDiscounts()
186			->reduce(function ($sum, ItemInterface $item) {
187			$sum += $item->getPriceIncTax() * $item->getQuantity();
188
189			return $sum;
190	20		}, 0);
191			// TODO 後方互換のため discount には正の整数を代入する
192	20		$itemHolder->setDiscount($total * -1);
193			}
194
195			/**
196			* @param ItemHolderInterface $itemHolder
197			*/
198	20	View Code Duplication	protected function calculateCharge(ItemHolderInterface $itemHolder)
			0 ignored issues – show Duplication introduced 2017-08-02 04:20 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...
199			{
200	20		$total = $itemHolder->getItems()
201	20		->getCharges()
202			->reduce(function ($sum, ItemInterface $item) {
203			$sum += $item->getPriceIncTax() * $item->getQuantity();
204
205			return $sum;
206	20		}, 0);
207	20		$itemHolder->setCharge($total);
208			}
209
210			/**
211			* @param ItemHolderInterface $itemHolder
212			*/
213	20	View Code Duplication	protected function calculateTax(ItemHolderInterface $itemHolder)
			0 ignored issues – show Duplication introduced 2017-08-02 04:20 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...
214			{
215	20		$total = $itemHolder->getItems()
216	20		->reduce(function ($sum, ItemInterface $item) {
217	15		$sum += ($item->getPriceIncTax() - $item->getPrice()) * $item->getQuantity();
218
219	15		return $sum;
220	20		}, 0);
221	20		$itemHolder->setTax($total);
222			}
223
224			/**
225			* @param ItemHolderInterface $itemHolder
226			*/
227	20		protected function calculateAll(ItemHolderInterface $itemHolder)
228			{
229	20		$this->calculateDeliveryFeeTotal($itemHolder);
230	20		$this->calculateCharge($itemHolder);
231	20		$this->calculateDiscount($itemHolder);
232	20		$this->calculateSubTotal($itemHolder); // Order の場合のみ
233	20		$this->calculateTax($itemHolder);
234	20		$this->calculateTotal($itemHolder);
235			}
236			}
237

EC-CUBE / ec-cube

Pull Request — experimental/3.1 (#2486)

PurchaseFlow A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

19 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like