MugProductFixture::load() - Code Metrics - Inspection of "Customise Behat configurations to FOB extensions" - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — to-be-a-hat-or-not-to-be-kuhwa ( 7c7f7b...b72886 )

by Kamil

created 2016-11-07 10:40 UTC

MugProductFixture::load() A

↳ Parent: MugProductFixture

Complexity

Conditions	2
Paths	2

Size

Total Lines	52
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	52
rs	9.4929
c	0
b	0
f	0
cc	2
eloc	32
nc	2
nop	1

How to fix Long Method

<?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\Bundle\CoreBundle\Fixture;

use Sylius\Bundle\FixturesBundle\Fixture\AbstractFixture;
use Sylius\Component\Attribute\AttributeType\TextAttributeType;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * @author Kamil Kokot <[email protected]>
 */
final class MugProductFixture extends AbstractFixture
{
    /**
     * @var TaxonFixture
     */
    private $taxonFixture;

    /**
     * @var ProductAttributeFixture
     */
    private $productAttributeFixture;

    /**
     * @var ProductOptionFixture
     */
    private $productOptionFixture;

    /**
     * @var ProductFixture
     */
    private $productFixture;

    /**
     * @var \Faker\Generator
     */
    private $faker;

    /**
     * @var OptionsResolver
     */
    private $optionsResolver;

    /**
     * @param TaxonFixture $taxonFixture
     * @param ProductAttributeFixture $productAttributeFixture
     * @param ProductOptionFixture $productOptionFixture
     * @param ProductFixture $productFixture
     */
    public function __construct(
        TaxonFixture $taxonFixture,
        ProductAttributeFixture $productAttributeFixture,

        ProductOptionFixture $productOptionFixture,
        ProductFixture $productFixture
    ) {
        $this->taxonFixture = $taxonFixture;
        $this->productAttributeFixture = $productAttributeFixture;
        $this->productOptionFixture = $productOptionFixture;
        $this->productFixture = $productFixture;

        $this->faker = \Faker\Factory::create();
        $this->optionsResolver =
            (new OptionsResolver())
                ->setRequired('amount')
                ->setAllowedTypes('amount', 'int')
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'mug_product';
    }

    /**
     * {@inheritdoc}
     */
    public function load(array $options)
    {
        $options = $this->optionsResolver->resolve($options);

        $this->taxonFixture->load(['custom' => [[
            'code' => 'category',
            'name' => 'Category',
            'children' => [
                [
                    'code' => 'mugs',
                    'name' => 'Mugs',
                ]
            ]
        ]]]);

        $this->productAttributeFixture->load(['custom' => [
            ['name' => 'Mug material', 'code' => 'mug_material', 'type' => TextAttributeType::TYPE],
        ]]);

        $this->productOptionFixture->load(['custom' => [
            [
                'name' => 'Mug type',
                'code' => 'mug_type',
                'values' => [
                    'mug_type_medium' => 'Medium mug',
                    'mug_type_double' => 'Double mug',
                    'mug_type_monster' => 'Monster mug',
                ],
            ],
        ]]);

        $products = [];
        $productsNames = $this->getUniqueNames($options['amount']);
        for ($i = 0; $i < $options['amount']; ++$i) {
            $products[] = [
                'name' => sprintf('Mug "%s"', $productsNames[$i]),
                'code' => $this->faker->uuid,
                'main_taxon' => 'mugs',
                'taxons' => ['mugs'],
                'product_attributes' => [
                    'mug_material' => $this->faker->randomElement(['Invisible porcelain', 'Banana skin', 'Porcelain', 'Centipede']),
                ],
                'product_options' => ['mug_type'],
                'images' => [
                    'main' => sprintf('%s/../Resources/fixtures/%s', __DIR__, 'mugs.jpg'),
                    'thumbnail' => sprintf('%s/../Resources/fixtures/%s', __DIR__, 'mugs.jpg'),
                ],
            ];
        }

        $this->productFixture->load(['custom' => $products]);
    }

    /**
     * {@inheritdoc}
     */
    protected function configureOptionsNode(ArrayNodeDefinition $optionsNode)
    {
        $optionsNode
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            ->children()
                ->integerNode('amount')->isRequired()->min(0)->end()
        ;
    }

    /**
     * @param int $amount
     *
     * @return string

     */
    private function getUniqueNames($amount)
    {
        $productsNames = [];

        for ($i = 0; $i < $amount; ++$i) {
            $name = $this->faker->word;
            while (in_array($name, $productsNames)) {
                $name = $this->faker->word;
            }
            $productsNames[] = $name;
        }

        return $productsNames;
    }
}


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\Bundle\CoreBundle\Fixture;
13
14			use Sylius\Bundle\FixturesBundle\Fixture\AbstractFixture;
15			use Sylius\Component\Attribute\AttributeType\TextAttributeType;
16			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
17			use Symfony\Component\OptionsResolver\OptionsResolver;
18
19			/**
20			* @author Kamil Kokot <[email protected]>
21			*/
22			final class MugProductFixture extends AbstractFixture
23			{
24			/**
25			* @var TaxonFixture
26			*/
27			private $taxonFixture;
28
29			/**
30			* @var ProductAttributeFixture
31			*/
32			private $productAttributeFixture;
33
34			/**
35			* @var ProductOptionFixture
36			*/
37			private $productOptionFixture;
38
39			/**
40			* @var ProductFixture
41			*/
42			private $productFixture;
43
44			/**
45			* @var \Faker\Generator
46			*/
47			private $faker;
48
49			/**
50			* @var OptionsResolver
51			*/
52			private $optionsResolver;
53
54			/**
55			* @param TaxonFixture $taxonFixture
56			* @param ProductAttributeFixture $productAttributeFixture
57			* @param ProductOptionFixture $productOptionFixture
58			* @param ProductFixture $productFixture
59			*/
60			public function __construct(
61			TaxonFixture $taxonFixture,
62			ProductAttributeFixture $productAttributeFixture,
			0 ignored issues – show Comprehensibility Naming introduced 2016-06-24 14:31 UTC by Report Bug Copy Issue Report The variable name `$productAttributeFixture` 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...
63			ProductOptionFixture $productOptionFixture,
64			ProductFixture $productFixture
65			) {
66			$this->taxonFixture = $taxonFixture;
67			$this->productAttributeFixture = $productAttributeFixture;
68			$this->productOptionFixture = $productOptionFixture;
69			$this->productFixture = $productFixture;
70
71			$this->faker = \Faker\Factory::create();
72			$this->optionsResolver =
73			(new OptionsResolver())
74			->setRequired('amount')
75			->setAllowedTypes('amount', 'int')
76			;
77			}
78
79			/**
80			* {@inheritdoc}
81			*/
82			public function getName()
83			{
84			return 'mug_product';
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90			public function load(array $options)
91			{
92			$options = $this->optionsResolver->resolve($options);
93
94			$this->taxonFixture->load(['custom' => [[
95			'code' => 'category',
96			'name' => 'Category',
97			'children' => [
98			[
99			'code' => 'mugs',
100			'name' => 'Mugs',
101			]
102			]
103			]]]);
104
105			$this->productAttributeFixture->load(['custom' => [
106			['name' => 'Mug material', 'code' => 'mug_material', 'type' => TextAttributeType::TYPE],
107			]]);
108
109			$this->productOptionFixture->load(['custom' => [
110			[
111			'name' => 'Mug type',
112			'code' => 'mug_type',
113			'values' => [
114			'mug_type_medium' => 'Medium mug',
115			'mug_type_double' => 'Double mug',
116			'mug_type_monster' => 'Monster mug',
117			],
118			],
119			]]);
120
121			$products = [];
122			$productsNames = $this->getUniqueNames($options['amount']);
123			for ($i = 0; $i < $options['amount']; ++$i) {
124			$products[] = [
125			'name' => sprintf('Mug "%s"', $productsNames[$i]),
126			'code' => $this->faker->uuid,
127			'main_taxon' => 'mugs',
128			'taxons' => ['mugs'],
129			'product_attributes' => [
130			'mug_material' => $this->faker->randomElement(['Invisible porcelain', 'Banana skin', 'Porcelain', 'Centipede']),
131			],
132			'product_options' => ['mug_type'],
133			'images' => [
134			'main' => sprintf('%s/../Resources/fixtures/%s', __DIR__, 'mugs.jpg'),
135			'thumbnail' => sprintf('%s/../Resources/fixtures/%s', __DIR__, 'mugs.jpg'),
136			],
137			];
138			}
139
140			$this->productFixture->load(['custom' => $products]);
141			}
142
143			/**
144			* {@inheritdoc}
145			*/
146			protected function configureOptionsNode(ArrayNodeDefinition $optionsNode)
147			{
148			$optionsNode
			0 ignored issues – show Bug introduced 2016-06-24 14:31 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `min()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\FloatNodeDefinition`, `Symfony\Component\Config...r\IntegerNodeDefinition`, `Symfony\Component\Config...r\NumericNodeDefinition`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
149			->children()
150			->integerNode('amount')->isRequired()->min(0)->end()
151			;
152			}
153
154			/**
155			* @param int $amount
156			*
157			* @return string
			0 ignored issues – show Documentation introduced 2016-11-07 10:59 UTC by Report Bug Copy Issue Report Should the return type not be `array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
158			*/
159			private function getUniqueNames($amount)
160			{
161			$productsNames = [];
162
163			for ($i = 0; $i < $amount; ++$i) {
164			$name = $this->faker->word;
165			while (in_array($name, $productsNames)) {
166			$name = $this->faker->word;
167			}
168			$productsNames[] = $name;
169			}
170
171			return $productsNames;
172			}
173			}
174

pamil / Sylius

Push — to-be-a-hat-or-not-to-be-kuhwa ( 7c7f7b...b72886 )

MugProductFixture::load() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like