Manager::resolvePrevious() - Code Metrics - Inspection of "Order: compara com Pedido atual, normaliza Shippin..." - gpupo/netshoes-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b5bd65...a5e931 )

by Gilmar

created 2016-07-29 18:10 UTC

Manager::resolvePrevious() A

↳ Parent: Manager

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	4.944

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
ccs	2
cts	5
cp	0.4
rs	9.4285
cc	3
eloc	7
nc	3
nop	1
crap	4.944

<?php

/*
 * This file is part of gpupo/netshoes-sdk
 * Created by Gilmar Pupo <[email protected]>
 * For the information of copyright and license you should read the file
 * LICENSE which is distributed with this source code.
 * Para a informação dos direitos autorais e de licença você deve ler o arquivo
 * LICENSE que é distribuído com este código-fonte.
 * Para obtener la información de los derechos de autor y la licencia debe leer
 * el archivo LICENSE que se distribuye con el código fuente.
 * For more information, see <http://www.g1mr.com/>.
 */

namespace Gpupo\NetshoesSdk\Entity\Order;

use DateInterval;
use DateTime;
use Gpupo\CommonSdk\Entity\EntityInterface;
use Gpupo\CommonSdk\Response;
use Gpupo\CommonSdk\Traits\LoadTrait;
use Gpupo\CommonSdk\Traits\TranslatorManagerTrait;
use Gpupo\NetshoesSdk\Entity\AbstractManager;

final class Manager extends AbstractManager
{
    use TranslatorManagerTrait;
    use LoadTrait;

    protected $entity = 'Order';

    /**
     * @codeCoverageIgnore
     */
    protected function setUp()
    {
        $this->maps = $this->loadArrayFromFile(__DIR__.'/map/restful.map.php');
    }

    public function factoryDecorator(Order $order, $decoratorName)
    {
        $className = __NAMESPACE__.'\\Decorator\\'.$decoratorName;
        $instance = new $className();
        $instance->setOrder($order);

        return $instance;
    }

    protected function resolvePrevious(Order $entity)
    {
        try {
            $o = $this->findById($entity->getId());
            if ($o instanceof Order) {
                return $o;
            }
        } catch (\Exception $o) {
            throw new \Exception('Order #'.$entity->getId().' not found on marketplace!');
        }
    }

    protected function normalizeShipping(Order $entity, Order $existent)
    {
        if (1000 > intval($entity->getShipping()->getShippingCode())) {
            $code = $existent->getShipping()->getShippingCode();
            $entity->getShipping()->setShippingCode($code);
        }

        return $entity;
    }

    /**
     * {@inheritdoc}
     */
    public function update(EntityInterface $entity, EntityInterface $existent = null)
    {
        parent::update($entity, $existent);

        $factory204 = function ($message) {
            return new Response([
                'raw'            => '{"message":"'.$message.'"}',
                'httpStatusCode' => 204,
            ]);
        };

        if (empty($existent)) {
            $existent = $this->resolvePrevious($entity);

        }

        if ($entity->getOrderStatus() === $existent->getOrderStatus()) {
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.
    }
}
            $this->log('info', 'Order sem atualização');

            return $factory204('Order status not changed!');
        }

        if ('processing' === $entity->getOrderStatus()) {
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 $factory204('Order status not used!');
        }

        $entity = $this->normalizeShipping($entity, $existent);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if (in_array($entity->getOrderStatus(), ['approved', 'canceled',
            'delivered', 'invoiced', 'shipped', ], true)) {
            $decorator = $this->factoryDecorator($entity, 'Status\\'.ucfirst($entity->getOrderStatus()));
            $json = $decorator->toJson();
            $mapKey = 'to'.ucfirst($entity->getOrderStatus());
            $shipping = $entity->getShipping();
            $code = $shipping->getShippingCode();
            $shipping->toJson();
            $map = $this->factoryMap($mapKey, [
                'orderNumber'  => $entity->getOrderNumber(),
                'itemId'       => $entity->getOrderNumber(),
                'shippingCode' => $code,
            ]);

            return $this->execute($map, $json);
        }

        throw new \InvalidArgumentException('Order Status ['.$entity->getOrderStatus().'] não suportado', 1);
    }

    public function factoryTranslator(array $data = [])
    {
        $translator = new Translator($data);

        return $translator;
    }

    public function fetchQueue($offset = 0, $limit = 50, array $parameters = [])
    {
        $date = new DateTime();
        $date->sub(new DateInterval('P4D'));

        return $this->translatorFetch($offset, $limit, array_merge([
            'orderStatus'    => 'approved',
            'orderStartDate' => $date->format('Y-m-d'),
        ], $parameters));
    }
}


1		<?php
2
3		/*
4		* This file is part of gpupo/netshoes-sdk
5		* Created by Gilmar Pupo <[email protected]>
6		* For the information of copyright and license you should read the file
7		* LICENSE which is distributed with this source code.
8		* Para a informação dos direitos autorais e de licença você deve ler o arquivo
9		* LICENSE que é distribuído com este código-fonte.
10		* Para obtener la información de los derechos de autor y la licencia debe leer
11		* el archivo LICENSE que se distribuye con el código fuente.
12		* For more information, see <http://www.g1mr.com/>.
13		*/
14
15		namespace Gpupo\NetshoesSdk\Entity\Order;
16
17		use DateInterval;
18		use DateTime;
19		use Gpupo\CommonSdk\Entity\EntityInterface;
20		use Gpupo\CommonSdk\Response;
21		use Gpupo\CommonSdk\Traits\LoadTrait;
22		use Gpupo\CommonSdk\Traits\TranslatorManagerTrait;
23		use Gpupo\NetshoesSdk\Entity\AbstractManager;
24
25		final class Manager extends AbstractManager
26		{
27		use TranslatorManagerTrait;
28		use LoadTrait;
29
30		protected $entity = 'Order';
31
32		/**
33		* @codeCoverageIgnore
34		*/
35		protected function setUp()
36		{
37		$this->maps = $this->loadArrayFromFile(__DIR__.'/map/restful.map.php');
38		}
39
40	1	public function factoryDecorator(Order $order, $decoratorName)
41		{
42	1	$className = __NAMESPACE__.'\\Decorator\\'.$decoratorName;
43	1	$instance = new $className();
44	1	$instance->setOrder($order);
45
46	1	return $instance;
47		}
48
49		protected function resolvePrevious(Order $entity)
50		{
51		try {
52	7	$o = $this->findById($entity->getId());
53		if ($o instanceof Order) {
54	7	return $o;
55		}
56		} catch (\Exception $o) {
57		throw new \Exception('Order #'.$entity->getId().' not found on marketplace!');
58		}
59		}
60
61		protected function normalizeShipping(Order $entity, Order $existent)
62	7	{
63		if (1000 > intval($entity->getShipping()->getShippingCode())) {
64		$code = $existent->getShipping()->getShippingCode();
65		$entity->getShipping()->setShippingCode($code);
66		}
67
68		return $entity;
69	7	}
70	7
71	6	/**
72	6	* {@inheritdoc}
73	6	*/
74	6	public function update(EntityInterface $entity, EntityInterface $existent = null)
75	6	{
76	6	parent::update($entity, $existent);
77	5
78	5	$factory204 = function ($message) {
79	5	return new Response([
80	5	'raw' => '{"message":"'.$message.'"}',
81		'httpStatusCode' => 204,
82		]);
83	5	};
84
85		if (empty($existent)) {
86	1	$existent = $this->resolvePrevious($entity);
		0 ignored issues – show Compatibility introduced 2016-07-29 18:35 UTC by Report Bug Copy Issue Report `$entity` of type `object<Gpupo\CommonSdk\Entity\EntityInterface>` is not a sub-type of `object<Gpupo\NetshoesSdk\Entity\Order\Order>`. It seems like you assume a concrete implementation of the interface `Gpupo\CommonSdk\Entity\EntityInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
87		}
88
89		if ($entity->getOrderStatus() === $existent->getOrderStatus()) {
		0 ignored issues – show Bug introduced 2016-07-27 15:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Gpupo\CommonSdk\Entity\EntityInterface` as the method `getOrderStatus()` does only exist in the following implementations of said interface: `Gpupo\NetshoesSdk\Entity\Order\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...
90		$this->log('info', 'Order sem atualização');
91
92		return $factory204('Order status not changed!');
93		}
94
95		if ('processing' === $entity->getOrderStatus()) {
		0 ignored issues – show Bug introduced 2016-07-27 19:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Gpupo\CommonSdk\Entity\EntityInterface` as the method `getOrderStatus()` does only exist in the following implementations of said interface: `Gpupo\NetshoesSdk\Entity\Order\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...
96	1	return $factory204('Order status not used!');
97		}
98	1
99	1	$entity = $this->normalizeShipping($entity, $existent);
		0 ignored issues – show Compatibility introduced 2016-07-29 18:35 UTC by Report Bug Copy Issue Report `$entity` of type `object<Gpupo\CommonSdk\Entity\EntityInterface>` is not a sub-type of `object<Gpupo\NetshoesSdk\Entity\Order\Order>`. It seems like you assume a concrete implementation of the interface `Gpupo\CommonSdk\Entity\EntityInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history... Documentation introduced 2016-07-29 18:35 UTC by Report Bug Copy Issue Report `$existent` is of type `null\|object<Gpupo\Common...Entity\EntityInterface>`, but the function expects a `object<Gpupo\NetshoesSdk\Entity\Order\Order>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
100
101	1	if (in_array($entity->getOrderStatus(), ['approved', 'canceled',
102	1	'delivered', 'invoiced', 'shipped', ], true)) {
103	1	$decorator = $this->factoryDecorator($entity, 'Status\\'.ucfirst($entity->getOrderStatus()));
104		$json = $decorator->toJson();
105		$mapKey = 'to'.ucfirst($entity->getOrderStatus());
106		$shipping = $entity->getShipping();
107		$code = $shipping->getShippingCode();
108		$shipping->toJson();
109		$map = $this->factoryMap($mapKey, [
110		'orderNumber' => $entity->getOrderNumber(),
111		'itemId' => $entity->getOrderNumber(),
112		'shippingCode' => $code,
113		]);
114
115		return $this->execute($map, $json);
116		}
117
118		throw new \InvalidArgumentException('Order Status ['.$entity->getOrderStatus().'] não suportado', 1);
119		}
120
121		public function factoryTranslator(array $data = [])
122		{
123		$translator = new Translator($data);
124
125		return $translator;
126		}
127
128		public function fetchQueue($offset = 0, $limit = 50, array $parameters = [])
129		{
130		$date = new DateTime();
131		$date->sub(new DateInterval('P4D'));
132
133		return $this->translatorFetch($offset, $limit, array_merge([
134		'orderStatus' => 'approved',
135		'orderStartDate' => $date->format('Y-m-d'),
136		], $parameters));
137		}
138		}
139

gpupo / netshoes-sdk

Push — master ( b5bd65...a5e931 )

Manager::resolvePrevious() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like