TaxonSlugGenerator::generate() - Code Metrics - Inspection of "Include taxon slug generator related changes in UP..." - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — taxon-slug-generator-revisited ( fa32c0 )

by Kamil

created 2017-07-17 10:28 UTC

TaxonSlugGenerator::generate() A

↳ Parent: TaxonSlugGenerator

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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\Taxonomy\Generator;

use Behat\Transliterator\Transliterator;
use Sylius\Component\Taxonomy\Model\TaxonInterface;
use Webmozart\Assert\Assert;

final class TaxonSlugGenerator implements TaxonSlugGeneratorInterface
{
    /**
     * {@inheritdoc}
     */
    public function generate(TaxonInterface $taxon, $locale = null)
    {
        $name = $taxon->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.
    }
}

        Assert::notEmpty($name, 'Cannot generate slug without a name.');

        $slug = $this->transliterate($name);

        $parentTaxon = $taxon->getParent();
        if (null === $parentTaxon) {
            return $slug;
        }

        $parentSlug = $parentTaxon->getTranslation($locale)->getSlug() ?: $this->generate($parentTaxon, $locale);
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 $parentSlug . '/' . $slug;
    }

    /**
     * @param string $string
     *
     * @return string
     */
    private function transliterate($string)
    {
        // Manually replacing apostrophes since Transliterator started removing them at v1.2.
        return Transliterator::transliterate(str_replace('\'', '-', $string));
    }
}


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\Taxonomy\Generator;
13
14			use Behat\Transliterator\Transliterator;
15			use Sylius\Component\Taxonomy\Model\TaxonInterface;
16			use Webmozart\Assert\Assert;
17
18			final class TaxonSlugGenerator implements TaxonSlugGeneratorInterface
19			{
20			/**
21			* {@inheritdoc}
22			*/
23			public function generate(TaxonInterface $taxon, $locale = null)
24			{
25			$name = $taxon->getTranslation($locale)->getName();
			0 ignored issues – show Bug introduced 2017-07-17 10:49 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...
26
27			Assert::notEmpty($name, 'Cannot generate slug without a name.');
28
29			$slug = $this->transliterate($name);
30
31			$parentTaxon = $taxon->getParent();
32			if (null === $parentTaxon) {
33			return $slug;
34			}
35
36			$parentSlug = $parentTaxon->getTranslation($locale)->getSlug() ?: $this->generate($parentTaxon, $locale);
			0 ignored issues – show Bug introduced 2017-07-17 10:49 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			return $parentSlug . '/' . $slug;
39			}
40
41			/**
42			* @param string $string
43			*
44			* @return string
45			*/
46			private function transliterate($string)
47			{
48			// Manually replacing apostrophes since Transliterator started removing them at v1.2.
49			return Transliterator::transliterate(str_replace('\'', '-', $string));
50			}
51			}
52

pamil / Sylius

Push — taxon-slug-generator-revisited ( fa32c0 )

TaxonSlugGenerator::generate() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like