OrderPaymentStateResolver::getTargetTransition() - Code Metrics - Inspection of "Merge pull request #6582 from pamil/TRAVIS-BARKER" - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3ff7e6...cf5edc )

by Kamil

created 2016-10-28 11:12 UTC

OrderPaymentStateResolver::getTargetTransition() D

↳ Parent: OrderPaymentStateResolver

Complexity

Conditions	9
Paths	14

Size

Total Lines	30
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	30
rs	4.909
c	0
b	0
f	0
cc	9
eloc	16
nc	14
nop	1

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sylius\Component\Core\StateResolver;

use SM\Factory\FactoryInterface;
use SM\StateMachine\StateMachineInterface;
use Sylius\Component\Order\Model\OrderInterface;
use Sylius\Component\Order\StateResolver\StateResolverInterface;
use Sylius\Component\Core\Model\PaymentInterface;
use Sylius\Component\Core\OrderPaymentTransitions;

/**
 * @author Paweł Jędrzejewski <[email protected]>
 * @author Arkadiusz Krakowiak <[email protected]>
 * @author Grzegorz Sadowski <[email protected]>
 */
class OrderPaymentStateResolver implements StateResolverInterface
{
    /**
     * @var FactoryInterface
     */
    private $stateMachineFactory;

    /**
     * @param FactoryInterface $stateMachineFactory
     */
    public function __construct(FactoryInterface $stateMachineFactory)
    {
        $this->stateMachineFactory = $stateMachineFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function resolve(OrderInterface $order)
    {
        $stateMachine = $this->stateMachineFactory->get($order, OrderPaymentTransitions::GRAPH);
        $targetTransition = $this->getTargetTransition($order);

        if (null !== $targetTransition) {
            $this->applyTransition($stateMachine, $targetTransition);
        }
    }

    /**
     * @param StateMachineInterface $stateMachine
     * @param string $transition
     */
    private function applyTransition(StateMachineInterface $stateMachine, $transition)
    {
        if ($stateMachine->can($transition)) {
            $stateMachine->apply($transition);
        }
    }

    /**
     * @param OrderInterface $order
     *
     * @return string|null
     */
    private function getTargetTransition(OrderInterface $order)
    {
        $refundedPaymentTotal = 0;
        $refundedPayments = $this->getPaymentsWithState($order, PaymentInterface::STATE_REFUNDED);

        foreach ($refundedPayments as $payment) {
            $refundedPaymentTotal += $payment->getAmount();
        }

        if (0 < $refundedPayments->count() && $refundedPaymentTotal >= $order->getTotal()) {

            return OrderPaymentTransitions::TRANSITION_REFUND;
        }

        $completedPaymentTotal = 0;

        $completedPayments = $this->getPaymentsWithState($order, PaymentInterface::STATE_COMPLETED);

        foreach ($completedPayments as $payment) {
            $completedPaymentTotal += $payment->getAmount();
        }

        if (0 < $completedPayments->count() && $completedPaymentTotal >= $order->getTotal()) {

            return OrderPaymentTransitions::TRANSITION_PAY;
        }

        if ($completedPaymentTotal < $order->getTotal() && 0 < $completedPaymentTotal) {
            return OrderPaymentTransitions::TRANSITION_PARTIALLY_PAY;
        }

        return null;
    }

    /**
     * @param OrderInterface $order
     * @param string $state
     *
     * @return PaymentInterface[]
     */
    private function getPaymentsWithState(OrderInterface $order, $state)
    {
        return $order->getPayments()->filter(function (PaymentInterface $payment) use ($state) {
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 $state === $payment->getState();
        });
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Component\Core\StateResolver;
13
14			use SM\Factory\FactoryInterface;
15			use SM\StateMachine\StateMachineInterface;
16			use Sylius\Component\Order\Model\OrderInterface;
17			use Sylius\Component\Order\StateResolver\StateResolverInterface;
18			use Sylius\Component\Core\Model\PaymentInterface;
19			use Sylius\Component\Core\OrderPaymentTransitions;
20
21			/**
22			* @author Paweł Jędrzejewski <[email protected]>
23			* @author Arkadiusz Krakowiak <[email protected]>
24			* @author Grzegorz Sadowski <[email protected]>
25			*/
26			class OrderPaymentStateResolver implements StateResolverInterface
27			{
28			/**
29			* @var FactoryInterface
30			*/
31			private $stateMachineFactory;
32
33			/**
34			* @param FactoryInterface $stateMachineFactory
35			*/
36			public function __construct(FactoryInterface $stateMachineFactory)
37			{
38			$this->stateMachineFactory = $stateMachineFactory;
39			}
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function resolve(OrderInterface $order)
45			{
46			$stateMachine = $this->stateMachineFactory->get($order, OrderPaymentTransitions::GRAPH);
47			$targetTransition = $this->getTargetTransition($order);
48
49			if (null !== $targetTransition) {
50			$this->applyTransition($stateMachine, $targetTransition);
51			}
52			}
53
54			/**
55			* @param StateMachineInterface $stateMachine
56			* @param string $transition
57			*/
58			private function applyTransition(StateMachineInterface $stateMachine, $transition)
59			{
60			if ($stateMachine->can($transition)) {
61			$stateMachine->apply($transition);
62			}
63			}
64
65			/**
66			* @param OrderInterface $order
67			*
68			* @return string\|null
69			*/
70			private function getTargetTransition(OrderInterface $order)
71			{
72			$refundedPaymentTotal = 0;
73			$refundedPayments = $this->getPaymentsWithState($order, PaymentInterface::STATE_REFUNDED);
74
75			foreach ($refundedPayments as $payment) {
76			$refundedPaymentTotal += $payment->getAmount();
77			}
78
79			if (0 < $refundedPayments->count() && $refundedPaymentTotal >= $order->getTotal()) {
			0 ignored issues – show Bug introduced 2016-10-28 08:55 UTC by Report Bug Copy Issue Report The method `count` cannot be called on `$refundedPayments` (of type `array<integer,object<Syl...odel\PaymentInterface>>`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
80			return OrderPaymentTransitions::TRANSITION_REFUND;
81			}
82
83			$completedPaymentTotal = 0;
			0 ignored issues – show Comprehensibility Naming introduced 2016-06-24 14:31 UTC by Report Bug Copy Issue Report The variable name `$completedPaymentTotal` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
84			$completedPayments = $this->getPaymentsWithState($order, PaymentInterface::STATE_COMPLETED);
85
86			foreach ($completedPayments as $payment) {
87			$completedPaymentTotal += $payment->getAmount();
88			}
89
90			if (0 < $completedPayments->count() && $completedPaymentTotal >= $order->getTotal()) {
			0 ignored issues – show Bug introduced 2016-10-28 08:55 UTC by Report Bug Copy Issue Report The method `count` cannot be called on `$completedPayments` (of type `array<integer,object<Syl...odel\PaymentInterface>>`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
91			return OrderPaymentTransitions::TRANSITION_PAY;
92			}
93
94			if ($completedPaymentTotal < $order->getTotal() && 0 < $completedPaymentTotal) {
95			return OrderPaymentTransitions::TRANSITION_PARTIALLY_PAY;
96			}
97
98			return null;
99			}
100
101			/**
102			* @param OrderInterface $order
103			* @param string $state
104			*
105			* @return PaymentInterface[]
106			*/
107			private function getPaymentsWithState(OrderInterface $order, $state)
108			{
109			return $order->getPayments()->filter(function (PaymentInterface $payment) use ($state) {
			0 ignored issues – show Bug introduced 2016-10-28 08:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Component\Order\Model\OrderInterface` as the method `getPayments()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\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...
110			return $state === $payment->getState();
111			});
112			}
113			}
114

pamil / Sylius

Push — master ( 3ff7e6...cf5edc )

OrderPaymentStateResolver::getTargetTransition() D

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like