Add PhpStan and implement suggested fixes

rpkamp · rpkamp · commit af3f16c482f4 · 2018-03-11T09:33:10.000+01:00
diff --git a/src/Bridge/FormFactory/ConsoleFormWithDefaultValuesAndOptionsFactory.php b/src/Bridge/FormFactory/ConsoleFormWithDefaultValuesAndOptionsFactory.php
@@ -2,6 +2,7 @@
 
 namespace Matthias\SymfonyConsoleForm\Bridge\FormFactory;
 
+use Matthias\SymfonyConsoleForm\Form\FormUtil;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Form\Extension\Core\Type\FormType;
 use Symfony\Component\Form\Extension\Csrf\Type\FormTypeCsrfExtension;
@@ -37,13 +38,13 @@ public function __construct(FormFactoryInterface $formFactory, FormRegistryInter
      * @param InputInterface           $input
      * @param array                    $options
      *
-     * @return \Symfony\Component\Form\Form
+     * @return \Symfony\Component\Form\FormInterface
      */
     public function create($formType, InputInterface $input, array $options = [])
     {
         $options = $this->addDefaultOptions($options);
 
-        $formBuilder = $this->formFactory->createBuilder($formType, null, $options);
+        $formBuilder = $this->formFactory->createBuilder(FormUtil::formTypeToString($formType), null, $options);
 
         foreach ($formBuilder as $name => $childBuilder) {
             /* @var FormBuilderInterface $childBuilder */
diff --git a/src/Bridge/Interaction/CollectionInteractor.php b/src/Bridge/Interaction/CollectionInteractor.php
@@ -6,6 +6,7 @@
 use Matthias\SymfonyConsoleForm\Bridge\Interaction\Exception\FormNotReadyForInteraction;
 use Matthias\SymfonyConsoleForm\Console\Formatter\Format;
 use Matthias\SymfonyConsoleForm\Form\FormUtil;
+use RuntimeException;
 use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
@@ -122,7 +123,13 @@ private function askIfContinueToAdd(
      */
     private function questionHelper(HelperSet $helperSet)
     {
-        return $helperSet->get('question');
+        $helper = $helperSet->get('question');
+
+        if (!$helper instanceof QuestionHelper) {
+            throw new RuntimeException('HelperSet does not contain valid QuestionHelper');
+        }
+
+        return $helper;
     }
 
     /**
diff --git a/src/Bridge/Interaction/FieldInteractor.php b/src/Bridge/Interaction/FieldInteractor.php
@@ -4,6 +4,7 @@
 
 use Matthias\SymfonyConsoleForm\Bridge\Interaction\Exception\CanNotInteractWithForm;
 use Matthias\SymfonyConsoleForm\Bridge\Transformer\TransformerResolver;
+use RuntimeException;
 use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
@@ -57,6 +58,12 @@ public function interactWith(
      */
     private function questionHelper(HelperSet $helperSet)
     {
-        return $helperSet->get('question');
+        $helper = $helperSet->get('question');
+
+        if (!$helper instanceof QuestionHelper) {
+            throw new RuntimeException('HelperSet does not contain valid QuestionHelper');
+        }
+
+        return $helper;
     }
 }
diff --git a/src/Bridge/Transformer/ChoiceTransformer.php b/src/Bridge/Transformer/ChoiceTransformer.php
@@ -4,16 +4,16 @@
 
 use Matthias\SymfonyConsoleForm\Console\Helper\Question\AlwaysReturnKeyOfChoiceQuestion;
 use Symfony\Component\Console\Question\Question;
-use Symfony\Component\Form\Form;
+use Symfony\Component\Form\FormInterface;
 
 class ChoiceTransformer extends AbstractTransformer
 {
     /**
-     * @param Form $form
+     * @param FormInterface $form
      *
      * @return Question
      */
-    public function transform(Form $form)
+    public function transform(FormInterface $form)
     {
         $formView = $form->createView();
 
diff --git a/src/Bridge/Transformer/FormToQuestionTransformer.php b/src/Bridge/Transformer/FormToQuestionTransformer.php
@@ -3,17 +3,17 @@
 namespace Matthias\SymfonyConsoleForm\Bridge\Transformer;
 
 use Symfony\Component\Console\Question\Question;
-use Symfony\Component\Form\Form;
+use Symfony\Component\Form\FormInterface;
 
 /**
  * Transform the given form (field) to a Question used by the Console Component to interact with the user.
  */
 interface FormToQuestionTransformer
 {
     /**
-     * @param Form $form
+     * @param FormInterface $form
      *
      * @return Question
      */
-    public function transform(Form $form);
+    public function transform(FormInterface $form);
 }
diff --git a/src/Bridge/Transformer/PasswordTransformer.php b/src/Bridge/Transformer/PasswordTransformer.php
@@ -2,16 +2,17 @@
 
 namespace Matthias\SymfonyConsoleForm\Bridge\Transformer;
 
-use Symfony\Component\Form\Form;
+use Symfony\Component\Console\Question\Question;
+use Symfony\Component\Form\FormInterface;
 
 class PasswordTransformer extends TextTransformer
 {
     /**
-     * @param Form $form
+     * @param FormInterface $form
      *
      * @return Question
      */
-    public function transform(Form $form)
+    public function transform(FormInterface $form)
     {
         $question = parent::transform($form);
         $question->setHidden(true);
diff --git a/src/Bridge/Transformer/TextTransformer.php b/src/Bridge/Transformer/TextTransformer.php
@@ -3,16 +3,16 @@
 namespace Matthias\SymfonyConsoleForm\Bridge\Transformer;
 
 use Symfony\Component\Console\Question\Question;
-use Symfony\Component\Form\Form;
+use Symfony\Component\Form\FormInterface;
 
 class TextTransformer extends AbstractTransformer
 {
     /**
-     * @param Form $form
+     * @param FormInterface $form
      *
      * @return Question
      */
-    public function transform(Form $form)
+    public function transform(FormInterface $form)
     {
         return new Question($this->questionFrom($form), $this->defaultValueFrom($form));
     }
diff --git a/src/Console/EventListener/RegisterHelpersEventListener.php b/src/Console/EventListener/RegisterHelpersEventListener.php
@@ -3,6 +3,7 @@
 namespace Matthias\SymfonyConsoleForm\Console\EventListener;
 
 use Matthias\SymfonyConsoleForm\Console\Helper\HelperCollection;
+use RuntimeException;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
 class RegisterHelpersEventListener
@@ -25,7 +26,13 @@ public function __construct(HelperCollection $helperCollection)
      */
     public function onConsoleCommand(ConsoleCommandEvent $event)
     {
-        $helperSet = $event->getCommand()->getHelperSet();
+        $command = $event->getCommand();
+
+        if (null === $command) {
+            throw new RuntimeException('Received ConsoleCommandEvent without Command instance!');
+        }
+
+        $helperSet = $command->getHelperSet();
 
         $this->helperCollection->addTo($helperSet);
     }
diff --git a/src/Console/Helper/FormHelper.php b/src/Console/Helper/FormHelper.php
@@ -71,7 +71,7 @@ public function interactUsingForm(
             if (!$form->isValid()) {
                 $output->write(sprintf('Invalid data provided: %s', $form->getErrors(true, false)));
                 array_map(
-                    function (FormInterface $formField) use ($form, &$validFormFields) {
+                    function (FormInterface $formField) use (&$validFormFields) {
                         if ($formField->isValid()) {
                             $validFormFields[] = $formField->getName();
                         }
diff --git a/src/Console/Helper/Question/AlwaysReturnKeyOfChoiceQuestion.php b/src/Console/Helper/Question/AlwaysReturnKeyOfChoiceQuestion.php
@@ -23,9 +23,9 @@ class AlwaysReturnKeyOfChoiceQuestion extends ChoiceQuestion
     private $_errorMessage = 'Value "%s" is invalid';
 
     /**
-     * @param string $question The question to ask to the user
-     * @param array  $choices  The list of available choices
-     * @param mixed  $default  The default answer to return
+     * @param string $question    The question to ask to the user
+     * @param array  $choiceViews The list of available choices
+     * @param mixed  $default     The default answer to return
      */
     public function __construct($question, array $choiceViews, $default = null)
     {
diff --git a/src/Console/Input/CachedInputDefinitionFactory.php b/src/Console/Input/CachedInputDefinitionFactory.php
@@ -36,7 +36,7 @@ public function __construct(InputDefinitionFactory $inputDefinitionFactory, $cac
 
     /**
      * @param string|\Symfony\Component\Form\FormTypeInterface $formType
-     * @param array                                            &$resources
+     * @param array                                            $resources
      *
      * @return mixed
      */
@@ -82,7 +82,7 @@ private function inputDefinitionFromCache($cache)
     /**
      * @param string|\Symfony\Component\Form\FormTypeInterface $formType
      * @param ConfigCache                                      $cache
-     * @param array                                            &$resources
+     * @param array                                            $resources
      *
      * @return \Symfony\Component\Console\Input\InputDefinition
      */
diff --git a/src/Console/Input/FormBasedInputDefinitionFactory.php b/src/Console/Input/FormBasedInputDefinitionFactory.php
@@ -27,15 +27,15 @@ public function __construct(FormFactoryInterface $formFactory)
 
     /**
      * @param string|\Symfony\Component\Form\FormTypeInterface $formType
-     * @param array                                            &$resources
+     * @param array                                            $resources
      *
      * @return InputDefinition
      */
     public function createForFormType($formType, array &$resources = [])
     {
         $resources[] = new FileResource(__FILE__);
 
-        $form = $this->formFactory->create($formType);
+        $form = $this->formFactory->create(FormUtil::formTypeToString($formType));
 
         $actualFormType = $form->getConfig()->getType()->getInnerType();
         $reflection = new \ReflectionObject($actualFormType);
diff --git a/src/Console/Input/InputDefinitionFactory.php b/src/Console/Input/InputDefinitionFactory.php
@@ -6,7 +6,7 @@ interface InputDefinitionFactory
 {
     /**
      * @param string|\Symfony\Component\Form\FormTypeInterface $formType
-     * @param array                                            &$resources
+     * @param array                                            $resources
      */
     public function createForFormType($formType, array &$resources = []);
 }
diff --git a/src/Form/FormUtil.php b/src/Form/FormUtil.php
@@ -2,7 +2,9 @@
 
 namespace Matthias\SymfonyConsoleForm\Form;
 
+use Symfony\Component\Form\Exception\RuntimeException;
 use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormTypeInterface;
 use Symfony\Component\Form\ResolvedFormTypeInterface;
 
 class FormUtil
@@ -22,7 +24,7 @@ public static function typeAncestry(FormInterface $form)
 
     /**
      * @param ResolvedFormTypeInterface|null $formType
-     * @param array                          &$types
+     * @param array                          $types
      */
     public static function typeAncestryForType(ResolvedFormTypeInterface $formType = null, array &$types)
     {
@@ -82,10 +84,34 @@ public static function isCompound(FormInterface $form)
         return $form->getConfig()->getCompound();
     }
 
+    /**
+     * @param FormTypeInterface|string $formType
+     *
+     * @return string
+     */
+    public static function formTypeToString($formType)
+    {
+        if ($formType instanceof FormTypeInterface) {
+            return get_class($formType);
+        }
+
+        if (is_string($formType)) {
+            return $formType;
+        }
+
+        throw new RuntimeException(
+            sprintf(
+                'Unable to determine form type for %s. Expected string or instance of %s',
+                is_object($formType) ? get_class($formType) : gettype($formType),
+                FormInterface::class
+            )
+        );
+    }
+
     /**
      * Copied from Symfony\Component\Form method humanize.
      *
-     * @param $text
+     * @param string $text
      *
      * @return string
      */

Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,16 @@`
`4`	`4`
`5`	`5`	`use Matthias\SymfonyConsoleForm\Console\Helper\Question\AlwaysReturnKeyOfChoiceQuestion;`
`6`	`6`	`use Symfony\Component\Console\Question\Question;`
`7`		`-use Symfony\Component\Form\Form;`
	`7`	`+use Symfony\Component\Form\FormInterface;`
`8`	`8`
`9`	`9`	`class ChoiceTransformer extends AbstractTransformer`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`		`- * @param Form $form`
	`12`	`+ * @param FormInterface $form`
`13`	`13`	`*`
`14`	`14`	`* @return Question`
`15`	`15`	`*/`
`16`		`- public function transform(Form $form)`
	`16`	`+ public function transform(FormInterface $form)`
`17`	`17`	`{`
`18`	`18`	`$formView = $form->createView();`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -3,17 +3,17 @@`
`3`	`3`	`namespace Matthias\SymfonyConsoleForm\Bridge\Transformer;`
`4`	`4`
`5`	`5`	`use Symfony\Component\Console\Question\Question;`
`6`		`-use Symfony\Component\Form\Form;`
	`6`	`+use Symfony\Component\Form\FormInterface;`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Transform the given form (field) to a Question used by the Console Component to interact with the user.`
`10`	`10`	`*/`
`11`	`11`	`interface FormToQuestionTransformer`
`12`	`12`	`{`
`13`	`13`	`/**`
`14`		`- * @param Form $form`
	`14`	`+ * @param FormInterface $form`
`15`	`15`	`*`
`16`	`16`	`* @return Question`
`17`	`17`	`*/`
`18`		`- public function transform(Form $form);`
	`18`	`+ public function transform(FormInterface $form);`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,17 @@`
`2`	`2`
`3`	`3`	`namespace Matthias\SymfonyConsoleForm\Bridge\Transformer;`
`4`	`4`
`5`		`-use Symfony\Component\Form\Form;`
	`5`	`+use Symfony\Component\Console\Question\Question;`
	`6`	`+use Symfony\Component\Form\FormInterface;`
`6`	`7`
`7`	`8`	`class PasswordTransformer extends TextTransformer`
`8`	`9`	`{`
`9`	`10`	`/**`
`10`		`- * @param Form $form`
	`11`	`+ * @param FormInterface $form`
`11`	`12`	`*`
`12`	`13`	`* @return Question`
`13`	`14`	`*/`
`14`		`- public function transform(Form $form)`
	`15`	`+ public function transform(FormInterface $form)`
`15`	`16`	`{`
`16`	`17`	`$question = parent::transform($form);`
`17`	`18`	`$question->setHidden(true);`
Original file line number	Diff line number	Diff line change
`@@ -3,16 +3,16 @@`
`3`	`3`	`namespace Matthias\SymfonyConsoleForm\Bridge\Transformer;`
`4`	`4`
`5`	`5`	`use Symfony\Component\Console\Question\Question;`
`6`		`-use Symfony\Component\Form\Form;`
	`6`	`+use Symfony\Component\Form\FormInterface;`
`7`	`7`
`8`	`8`	`class TextTransformer extends AbstractTransformer`
`9`	`9`	`{`
`10`	`10`	`/**`
`11`		`- * @param Form $form`
	`11`	`+ * @param FormInterface $form`
`12`	`12`	`*`
`13`	`13`	`* @return Question`
`14`	`14`	`*/`
`15`		`- public function transform(Form $form)`
	`15`	`+ public function transform(FormInterface $form)`
`16`	`16`	`{`
`17`	`17`	`return new Question($this->questionFrom($form), $this->defaultValueFrom($form));`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public function interactUsingForm(`
`71`	`71`	`if (!$form->isValid()) {`
`72`	`72`	`$output->write(sprintf('Invalid data provided: %s', $form->getErrors(true, false)));`
`73`	`73`	`array_map(`
`74`		`- function (FormInterface $formField) use ($form, &$validFormFields) {`
	`74`	`+ function (FormInterface $formField) use (&$validFormFields) {`
`75`	`75`	`if ($formField->isValid()) {`
`76`	`76`	`$validFormFields[] = $formField->getName();`
`77`	`77`	`}`