ProductViewFactory::createWithVariants() - Code Metrics - Inspection of "Merge pull request #108 from Sylius/add-coupon-to-..." - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (9d8d38)

by Łukasz

created 2017-05-17 07:16 UTC

ProductViewFactory::createWithVariants() B

↳ Parent: Project

Complexity

Conditions	4
Paths	6

Size

Total Lines	23
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	8.7972
c	0
b	0
f	0
cc	4
eloc	10
nc	6
nop	3

<?php

namespace Sylius\ShopApiPlugin\Factory;

use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Core\Model\ProductImageInterface;
use Sylius\Component\Core\Model\ProductInterface;
use Sylius\Component\Core\Model\ProductVariantInterface;
use Sylius\Component\Core\Model\TaxonInterface;
use Sylius\ShopApiPlugin\View\ProductVariantView;
use Sylius\ShopApiPlugin\View\ProductView;

final class ProductViewFactory implements ProductViewFactoryInterface

{
    /**
     * @var ImageViewFactoryInterface
     */
    private $imageViewFactory;

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

    /**
     * {@inheritdoc}
     */
    public function create(ProductInterface $product, ChannelInterface $channel, $locale)
    {
        $productView = new ProductView();
        $productView->name = $product->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.
    }
}
        $productView->code = $product->getCode();
        $productView->slug = $product->getTranslation($locale)->getSlug();
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.
    }
}

        /** @var ProductImageInterface $image */
        foreach ($product->getImages() as $image) {
            $imageView = $this->imageViewFactory->create($image);
            $productView->images[] = $imageView;
        }

        /** @var TaxonInterface $taxon */
        foreach ($product->getTaxons() as $taxon) {
            $productView->taxons[] = $taxon->getCode();
        }

        return $productView;
    }
}


Branch — master (9d8d38)

ProductViewFactory::createWithVariants() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1		<?php
2
3		namespace Sylius\ShopApiPlugin\Factory;
4
5		use Sylius\Component\Core\Model\ChannelInterface;
6		use Sylius\Component\Core\Model\ProductImageInterface;
7		use Sylius\Component\Core\Model\ProductInterface;
8		use Sylius\Component\Core\Model\ProductVariantInterface;
9		use Sylius\Component\Core\Model\TaxonInterface;
10		use Sylius\ShopApiPlugin\View\ProductVariantView;
11		use Sylius\ShopApiPlugin\View\ProductView;
12
13	View Code Duplication	final class ProductViewFactory implements ProductViewFactoryInterface
		1 ignored issue – show Duplication introduced 2017-05-17 07:19 UTC by Report Bug Copy Issue Report This class 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...
14		{
15		/**
16		* @var ImageViewFactoryInterface
17		*/
18		private $imageViewFactory;
19
20		/**
21		* @param ImageViewFactoryInterface $imageViewFactory
22		*/
23		public function __construct(ImageViewFactoryInterface $imageViewFactory)
24		{
25		$this->imageViewFactory = $imageViewFactory;
26		}
27
28		/**
29		* {@inheritdoc}
30		*/
31		public function create(ProductInterface $product, ChannelInterface $channel, $locale)
32		{
33		$productView = new ProductView();
34		$productView->name = $product->getTranslation($locale)->getName();
		0 ignored issues – show Bug introduced 2017-04-24 07:50 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...
35		$productView->code = $product->getCode();
36		$productView->slug = $product->getTranslation($locale)->getSlug();
		0 ignored issues – show Bug introduced 2017-04-24 07:50 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 `getSlug()` does only exist in the following implementations of said interface: `Sylius\Component\Core\Model\ProductTranslation`, `Sylius\Component\Product\Model\ProductTranslation`, `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...
37
38		/** @var ProductImageInterface $image */
39		foreach ($product->getImages() as $image) {
40		$imageView = $this->imageViewFactory->create($image);
41		$productView->images[] = $imageView;
42		}
43
44		/** @var TaxonInterface $taxon */
45		foreach ($product->getTaxons() as $taxon) {
46		$productView->taxons[] = $taxon->getCode();
47		}
48
49		return $productView;
50		}
51		}
52

Sylius / SyliusShopApiPlugin

Branch — master (9d8d38)

ProductViewFactory::createWithVariants() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like