ShippingMethodViewFactory::__construct() - Code Metrics - Inspection of "Merge pull request #91 from Sylius/rebased-payment..." - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 41948a...5bb6bb )

by Łukasz

created 2017-05-11 08:17 UTC

ShippingMethodViewFactory::__construct() A

↳ Parent: ShippingMethodViewFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php

namespace Sylius\ShopApiPlugin\Factory;

use Sylius\Component\Core\Model\ShipmentInterface;
use Sylius\Component\Core\Model\ShippingMethodInterface;
use Sylius\Component\Registry\ServiceRegistry;
use Sylius\Component\Shipping\Calculator\CalculatorInterface;
use Sylius\ShopApiPlugin\View\ShippingMethodView;

final class ShippingMethodViewFactory implements ShippingMethodViewFactoryInterface
{
    /**
     * @var ServiceRegistry
     */
    private $calculators;

    /**
     * @var PriceViewFactoryInterface
     */
    private $priceViewFactory;

    /**
     * @param ServiceRegistry $calculators
     * @param PriceViewFactoryInterface $priceViewFactory
     */
    public function __construct(ServiceRegistry $calculators, PriceViewFactoryInterface $priceViewFactory)
    {
        $this->calculators = $calculators;
        $this->priceViewFactory = $priceViewFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function create(ShipmentInterface $shipment, $locale)
    {
        return $this->createWithShippingMethod($shipment, $shipment->getMethod(), $locale);

    }

    /**
     * {@inheritdoc}
     */
    public function createWithShippingMethod(ShipmentInterface $shipment, ShippingMethodInterface $shippingMethod, $locale)
    {
        /** @var CalculatorInterface $calculator */
        $calculator = $this->calculators->get($shippingMethod->getCalculator());

        $shippingMethodView = new ShippingMethodView();

        $shippingMethodView->code = $shippingMethod->getCode();
        $shippingMethodView->name = $shippingMethod->getTranslation($locale)->getName();
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.
    }
}
        $shippingMethodView->description = $shippingMethod->getTranslation($locale)->getDescription();
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.
    }
}
        $shippingMethodView->price = $this->priceViewFactory->create(
            $calculator->calculate($shipment, $shippingMethod->getConfiguration())
        );

        return $shippingMethodView;
    }
}


Push — master ( 41948a...5bb6bb )

ShippingMethodViewFactory::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace Sylius\ShopApiPlugin\Factory;
4
5			use Sylius\Component\Core\Model\ShipmentInterface;
6			use Sylius\Component\Core\Model\ShippingMethodInterface;
7			use Sylius\Component\Registry\ServiceRegistry;
8			use Sylius\Component\Shipping\Calculator\CalculatorInterface;
9			use Sylius\ShopApiPlugin\View\ShippingMethodView;
10
11			final class ShippingMethodViewFactory implements ShippingMethodViewFactoryInterface
12			{
13			/**
14			* @var ServiceRegistry
15			*/
16			private $calculators;
17
18			/**
19			* @var PriceViewFactoryInterface
20			*/
21			private $priceViewFactory;
22
23			/**
24			* @param ServiceRegistry $calculators
25			* @param PriceViewFactoryInterface $priceViewFactory
26			*/
27			public function __construct(ServiceRegistry $calculators, PriceViewFactoryInterface $priceViewFactory)
28			{
29			$this->calculators = $calculators;
30			$this->priceViewFactory = $priceViewFactory;
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			public function create(ShipmentInterface $shipment, $locale)
37			{
38			return $this->createWithShippingMethod($shipment, $shipment->getMethod(), $locale);
			0 ignored issues – show Compatibility introduced 2017-05-09 10:14 UTC by Report Bug Copy Issue Report `$shipment->getMethod()` of type `object<Sylius\Component\...hippingMethodInterface>` is not a sub-type of `object<Sylius\Component\...hippingMethodInterface>`. It seems like you assume a child interface of the interface `Sylius\Component\Shippin...ShippingMethodInterface` 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...
39			}
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function createWithShippingMethod(ShipmentInterface $shipment, ShippingMethodInterface $shippingMethod, $locale)
45			{
46			/** @var CalculatorInterface $calculator */
47			$calculator = $this->calculators->get($shippingMethod->getCalculator());
48
49			$shippingMethodView = new ShippingMethodView();
50
51			$shippingMethodView->code = $shippingMethod->getCode();
52			$shippingMethodView->name = $shippingMethod->getTranslation($locale)->getName();
			0 ignored issues – show Bug introduced 2017-05-09 08:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Component\Resourc...el\TranslationInterface` as the method `getName()` does only exist in the following implementations of said interface: `Sylius\Component\Attribu...el\AttributeTranslation`, `Sylius\Component\Core\Model\ProductTranslation`, `Sylius\Component\Payment...aymentMethodTranslation`, `Sylius\Component\Product...ociationTypeTranslation`, `Sylius\Component\Product...uctAttributeTranslation`, `Sylius\Component\Product...roductOptionTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `Sylius\Component\Product...oductVariantTranslation`, `Sylius\Component\Shippin...ippingMethodTranslation`, `Sylius\Component\Taxonomy\Model\TaxonTranslation`. 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...
53			$shippingMethodView->description = $shippingMethod->getTranslation($locale)->getDescription();
			0 ignored issues – show Bug introduced 2017-05-09 08:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Component\Resourc...el\TranslationInterface` as the method `getDescription()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\ProductTranslation`, `Sylius\Component\Payment...aymentMethodTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `Sylius\Component\Shippin...ippingMethodTranslation`, `Sylius\Component\Taxonomy\Model\TaxonTranslation`. 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...
54			$shippingMethodView->price = $this->priceViewFactory->create(
55			$calculator->calculate($shipment, $shippingMethod->getConfiguration())
56			);
57
58			return $shippingMethodView;
59			}
60			}
61

Sylius / SyliusShopApiPlugin

Push — master ( 41948a...5bb6bb )

ShippingMethodViewFactory::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like