ParameterHelper::askStore() - Code Metrics - Inspection of "Merge branch 'release/1.97.11'" - netz98/n98-magerun - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c365cd...202f3c )

by Tom

created 2016-01-29 21:28 UTC

ParameterHelper::askStore() B

↳ Parent: ParameterHelper

Complexity

Conditions	6
Paths	7

Size

Total Lines	45
Code Lines	28

Duplication

Lines	45
Ratio	100 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
dl	45
loc	45
rs	8.439
c	4
b	0
f	0
cc	6
eloc	28
nc	7
nop	4

<?php

namespace N98\Util\Console\Helper;

use Exception;
use InvalidArgumentException;
use N98\Util\Validator\FakeMetadataFactory;
use RuntimeException;
use Symfony\Component\Console\Helper\DialogHelper;
use Symfony\Component\Console\Helper\Helper as AbstractHelper;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Translation\Translator;
use Symfony\Component\Validator\ConstraintViolationInterface;
use Symfony\Component\Validator\ConstraintViolationListInterface;
use Symfony\Component\Validator\Validator;
use Symfony\Component\Validator\Constraints;
use Symfony\Component\Validator\ConstraintValidatorFactory;

/**
 * Helper to init some parameters
 */
class ParameterHelper extends AbstractHelper
{
    /**
     * @var Validator
     */
    private $validator;

    /**
     * Returns the canonical name of this helper.
     *
     * @return string The canonical name
     *
     * @api
     */
    public function getName()
    {
        return 'parameter';
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     * @param string          $argumentName
     * @param bool            $withDefaultStore [optional]
     *
     * @return mixed
     *
     * @throws InvalidArgumentException
     */
    public function askStore(

        InputInterface $input,
        OutputInterface $output,
        $argumentName = 'store',
        $withDefaultStore = false
    ) {
        /* @var $storeManager \Mage_Core_Model_App */
        $storeManager = \Mage::app();

        try {
            if ($input->getArgument($argumentName) === null) {
                throw new RuntimeException('No store given');
            }
            /** @var $store \Mage_Core_Model_Store */
            $store = $storeManager->getStore($input->getArgument($argumentName));
        } catch (Exception $e) {
            $stores = array();
            $i = 0;

            foreach ($storeManager->getStores($withDefaultStore) as $store) {
                $stores[$i] = $store->getId();
                $question[] = '<comment>[' . ($i + 1) . ']</comment> ' . $store->getCode() . ' - ' . $store->getName() . PHP_EOL;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                $i++;
            }

            if (count($stores) > 1) {
                $question[] = '<question>Please select a store: </question>';
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                $storeId = $this->askAndValidate($output, $question,
                    function($typeInput) use ($stores) {
                        if (!isset($stores[$typeInput - 1])) {
                            throw new InvalidArgumentException('Invalid store');
                        }

                        return $stores[$typeInput - 1];
                    });
            } else {
                // only one store view available -> take it
                $storeId = $stores[0];
            }

            $store = $storeManager->getStore($storeId);
        }

        return $store;
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     * @param string          $argumentName
     *
     * @return mixed
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function askWebsite(InputInterface $input, OutputInterface $output, $argumentName = 'website')

    {
        /* @var $storeManager \Mage_Core_Model_App */
        $storeManager = \Mage::app();

        try {
            if ($input->getArgument($argumentName) === null) {
                throw new RuntimeException('No website given');
            }
            /** @var $website \Mage_Core_Model_Website */
            $website = $storeManager->getWebsite($input->getArgument($argumentName));
        } catch (Exception $e) {
            $i = 0;
            $websites = array();
            foreach ($storeManager->getWebsites() as $website) {
                $websites[$i] = $website->getId();
                $question[] = '<comment>[' . ($i + 1) . ']</comment> ' . $website->getCode() . ' - ' . $website->getName() . PHP_EOL;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                $i++;
            }
            if (count($websites) == 1) {
                return $storeManager->getWebsite($websites[0]);
            }
            $question[] = '<question>Please select a website: </question>';
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

            $websiteId = $this->askAndValidate($output, $question,
                function($typeInput) use ($websites) {
                    if (!isset($websites[$typeInput - 1])) {
                        throw new InvalidArgumentException('Invalid store');
                    }

                    return $websites[$typeInput - 1];
                });

            $website = $storeManager->getWebsite($websiteId);
        }

        return $website;
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     * @param string          $argumentName
     *
     * @return string
     */
    public function askEmail(InputInterface $input, OutputInterface $output, $argumentName = 'email')
    {
        $constraints = new Constraints\Collection(
            array(
                'email' => array(
                    new Constraints\NotBlank(),
                    new Constraints\Email()
                )
            )
        );

        return $this->validateArgument($output, $argumentName, $input->getArgument($argumentName), $constraints);
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     * @param string          $argumentName
     *
     * @param bool            $needDigits [optional]
     * @return string
     */
    public function askPassword(
        InputInterface $input,
        OutputInterface $output,
        $argumentName = 'password',
        $needDigits = true
    ) {
        $validators = array();

        if ($needDigits) {
            $regex = array(
                'pattern' => '/^(?=.*\d)(?=.*[a-zA-Z])/',
                'message' => 'Password must contain letters and at least one digit'
            );
            $validators[] = new Constraints\Regex($regex);
        }

        $validators[] = new Constraints\Length(array('min' => 6));

        $constraints = new Constraints\Collection(
            array(
                'password' => $validators
            )
        );

        return $this->validateArgument($output, $argumentName, $input->getArgument($argumentName), $constraints);
    }

    /**
     * @param OutputInterface $output
     * @param                 $question
     * @param callable        $callback
     *
     * @return string
     */
    private function askAndValidate(OutputInterface $output, $question, $callback)
    {
        /** @var DialogHelper $dialog */
        $dialog = $this->getHelperSet()->get('dialog');

        return $dialog->askAndValidate($output, $question, $callback);
    }

    /**
     * @param OutputInterface        $output
     * @param string                 $name
     * @param string                 $value
     * @param Constraints\Collection $constraints The constraint(s) to validate against.
     *
     * @return string
     */
    private function validateArgument(OutputInterface $output, $name, $value, $constraints)
    {

        if (strlen($value)) {
            $errors = $this->validateValue($name, $value, $constraints);
            if ($errors->count() > 0) {
                $output->writeln('<error>' . $errors[0]->getMessage() . '</error>');
            } else {

                return $value;
            }
        }

        $question = '<question>' . ucfirst($name) . ': </question>';

        $value = $this->askAndValidate(
            $output, $question,
            function($inputValue) use ($constraints, $name) {
                $errors = $this->validateValue($name, $inputValue, $constraints);
                if ($errors->count() > 0) {
                    throw new InvalidArgumentException($errors[0]->getMessage());
                }

                return $inputValue;
            }
        );

        return $value;
    }

    /**
     * @param string                 $name
     * @param string                 $value
     * @param Constraints\Collection $constraints The constraint(s) to validate against.
     *
     * @return \Symfony\Component\Validator\ConstraintViolationInterface[]|ConstraintViolationListInterface
     */
    private function validateValue($name, $value, $constraints)
    {
        $validator = $this->getValidator();
        /** @var ConstraintViolationListInterface|ConstraintViolationInterface[] $errors */
        $errors = $validator->validateValue(array($name => $value), $constraints);

        return $errors;
    }

    /**
     * @return Validator
     */
    private function getValidator()
    {
        return $this->validator ?: $this->validator = $this->createValidator();
    }

    /**
     * @return Validator
     */
    private function createValidator()
    {
        $factory = new ConstraintValidatorFactory();
        $validator = new Validator(new FakeMetadataFactory(), $factory, new Translator('en'));


        return $validator;
    }
}


Push — master ( c365cd...202f3c )

ParameterHelper::askStore() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1		<?php
2
3		namespace N98\Util\Console\Helper;
4
5		use Exception;
6		use InvalidArgumentException;
7		use N98\Util\Validator\FakeMetadataFactory;
8		use RuntimeException;
9		use Symfony\Component\Console\Helper\DialogHelper;
10		use Symfony\Component\Console\Helper\Helper as AbstractHelper;
11		use Symfony\Component\Console\Output\OutputInterface;
12		use Symfony\Component\Console\Input\InputInterface;
13		use Symfony\Component\Translation\Translator;
14		use Symfony\Component\Validator\ConstraintViolationInterface;
15		use Symfony\Component\Validator\ConstraintViolationListInterface;
16		use Symfony\Component\Validator\Validator;
17		use Symfony\Component\Validator\Constraints;
18		use Symfony\Component\Validator\ConstraintValidatorFactory;
19
20		/**
21		* Helper to init some parameters
22		*/
23		class ParameterHelper extends AbstractHelper
24		{
25		/**
26		* @var Validator
27		*/
28		private $validator;
29
30		/**
31		* Returns the canonical name of this helper.
32		*
33		* @return string The canonical name
34		*
35		* @api
36		*/
37		public function getName()
38		{
39		return 'parameter';
40		}
41
42		/**
43		* @param InputInterface $input
44		* @param OutputInterface $output
45		* @param string $argumentName
46		* @param bool $withDefaultStore [optional]
47		*
48		* @return mixed
49		*
50		* @throws InvalidArgumentException
51		*/
52	View Code Duplication	public function askStore(
		0 ignored issues – show Duplication introduced 2016-01-09 09:08 UTC by Report Bug Copy Issue Report This method 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...
53		InputInterface $input,
54		OutputInterface $output,
55		$argumentName = 'store',
56		$withDefaultStore = false
57		) {
58		/* @var $storeManager \Mage_Core_Model_App */
59		$storeManager = \Mage::app();
60
61		try {
62		if ($input->getArgument($argumentName) === null) {
63		throw new RuntimeException('No store given');
64		}
65		/** @var $store \Mage_Core_Model_Store */
66		$store = $storeManager->getStore($input->getArgument($argumentName));
67		} catch (Exception $e) {
68		$stores = array();
69		$i = 0;
70
71		foreach ($storeManager->getStores($withDefaultStore) as $store) {
72		$stores[$i] = $store->getId();
73		$question[] = '<comment>[' . ($i + 1) . ']</comment> ' . $store->getCode() . ' - ' . $store->getName() . PHP_EOL;
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report `$question` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$question = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history... Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 129 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
74		$i++;
75		}
76
77		if (count($stores) > 1) {
78		$question[] = '<question>Please select a store: </question>';
		0 ignored issues – show Bug introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report The variable `$question` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
79		$storeId = $this->askAndValidate($output, $question,
80		function($typeInput) use ($stores) {
81		if (!isset($stores[$typeInput - 1])) {
82		throw new InvalidArgumentException('Invalid store');
83		}
84
85		return $stores[$typeInput - 1];
86		});
87		} else {
88		// only one store view available -> take it
89		$storeId = $stores[0];
90		}
91
92		$store = $storeManager->getStore($storeId);
93		}
94
95		return $store;
96		}
97
98		/**
99		* @param InputInterface $input
100		* @param OutputInterface $output
101		* @param string $argumentName
102		*
103		* @return mixed
104		* @throws InvalidArgumentException
105		* @throws RuntimeException
106		*/
107	View Code Duplication	public function askWebsite(InputInterface $input, OutputInterface $output, $argumentName = 'website')
		0 ignored issues – show Duplication introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report This method 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...
108		{
109		/* @var $storeManager \Mage_Core_Model_App */
110		$storeManager = \Mage::app();
111
112		try {
113		if ($input->getArgument($argumentName) === null) {
114		throw new RuntimeException('No website given');
115		}
116		/** @var $website \Mage_Core_Model_Website */
117		$website = $storeManager->getWebsite($input->getArgument($argumentName));
118		} catch (Exception $e) {
119		$i = 0;
120		$websites = array();
121		foreach ($storeManager->getWebsites() as $website) {
122		$websites[$i] = $website->getId();
123		$question[] = '<comment>[' . ($i + 1) . ']</comment> ' . $website->getCode() . ' - ' . $website->getName() . PHP_EOL;
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report `$question` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$question = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history... Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 133 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
124		$i++;
125		}
126		if (count($websites) == 1) {
127		return $storeManager->getWebsite($websites[0]);
128		}
129		$question[] = '<question>Please select a website: </question>';
		0 ignored issues – show Bug introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report The variable `$question` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
130
131		$websiteId = $this->askAndValidate($output, $question,
132		function($typeInput) use ($websites) {
133		if (!isset($websites[$typeInput - 1])) {
134		throw new InvalidArgumentException('Invalid store');
135		}
136
137		return $websites[$typeInput - 1];
138		});
139
140		$website = $storeManager->getWebsite($websiteId);
141		}
142
143		return $website;
144		}
145
146		/**
147		* @param InputInterface $input
148		* @param OutputInterface $output
149		* @param string $argumentName
150		*
151		* @return string
152		*/
153		public function askEmail(InputInterface $input, OutputInterface $output, $argumentName = 'email')
154		{
155		$constraints = new Constraints\Collection(
156		array(
157		'email' => array(
158		new Constraints\NotBlank(),
159		new Constraints\Email()
160		)
161		)
162		);
163
164		return $this->validateArgument($output, $argumentName, $input->getArgument($argumentName), $constraints);
165		}
166
167		/**
168		* @param InputInterface $input
169		* @param OutputInterface $output
170		* @param string $argumentName
171		*
172		* @param bool $needDigits [optional]
173		* @return string
174		*/
175		public function askPassword(
176		InputInterface $input,
177		OutputInterface $output,
178		$argumentName = 'password',
179		$needDigits = true
180		) {
181		$validators = array();
182
183		if ($needDigits) {
184		$regex = array(
185		'pattern' => '/^(?=.\d)(?=.[a-zA-Z])/',
186		'message' => 'Password must contain letters and at least one digit'
187		);
188		$validators[] = new Constraints\Regex($regex);
189		}
190
191		$validators[] = new Constraints\Length(array('min' => 6));
192
193		$constraints = new Constraints\Collection(
194		array(
195		'password' => $validators
196		)
197		);
198
199		return $this->validateArgument($output, $argumentName, $input->getArgument($argumentName), $constraints);
200		}
201
202		/**
203		* @param OutputInterface $output
204		* @param $question
205		* @param callable $callback
206		*
207		* @return string
208		*/
209		private function askAndValidate(OutputInterface $output, $question, $callback)
210		{
211		/** @var DialogHelper $dialog */
212		$dialog = $this->getHelperSet()->get('dialog');
213
214		return $dialog->askAndValidate($output, $question, $callback);
215		}
216
217		/**
218		* @param OutputInterface $output
219		* @param string $name
220		* @param string $value
221		* @param Constraints\Collection $constraints The constraint(s) to validate against.
222		*
223		* @return string
224		*/
225		private function validateArgument(OutputInterface $output, $name, $value, $constraints)
226		{
227
228		if (strlen($value)) {
229		$errors = $this->validateValue($name, $value, $constraints);
230		if ($errors->count() > 0) {
231		$output->writeln('<error>' . $errors[0]->getMessage() . '</error>');
232		} else {
233
234		return $value;
235		}
236		}
237
238		$question = '<question>' . ucfirst($name) . ': </question>';
239
240		$value = $this->askAndValidate(
241		$output, $question,
242		function($inputValue) use ($constraints, $name) {
243		$errors = $this->validateValue($name, $inputValue, $constraints);
244		if ($errors->count() > 0) {
245		throw new InvalidArgumentException($errors[0]->getMessage());
246		}
247
248		return $inputValue;
249		}
250		);
251
252		return $value;
253		}
254
255		/**
256		* @param string $name
257		* @param string $value
258		* @param Constraints\Collection $constraints The constraint(s) to validate against.
259		*
260		* @return \Symfony\Component\Validator\ConstraintViolationInterface[]\|ConstraintViolationListInterface
261		*/
262		private function validateValue($name, $value, $constraints)
263		{
264		$validator = $this->getValidator();
265		/** @var ConstraintViolationListInterface\|ConstraintViolationInterface[] $errors */
266		$errors = $validator->validateValue(array($name => $value), $constraints);
267
268		return $errors;
269		}
270
271		/**
272		* @return Validator
273		*/
274		private function getValidator()
275		{
276		return $this->validator ?: $this->validator = $this->createValidator();
277		}
278
279		/**
280		* @return Validator
281		*/
282		private function createValidator()
283		{
284		$factory = new ConstraintValidatorFactory();
285		$validator = new Validator(new FakeMetadataFactory(), $factory, new Translator('en'));
		0 ignored issues – show Deprecated Code introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Validator\Validator` has been deprecated with message: since version 2.5, to be removed in 3.0. Use {@link Validator\RecursiveValidator} instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
286
287		return $validator;
288		}
289		}
290

netz98 / n98-magerun

Push — master ( c365cd...202f3c )

ParameterHelper::askStore() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like