minor #9244 [Console] make parent constructor test more reliable (Tobion)

fabpot · fabpot · commit 3502ca22a6db · 2013-10-31T17:40:24.000+01:00
This PR was merged into the master branch. Discussion ---------- [Console] make parent constructor test more reliable | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Fixes | #9186 , f2b60e9 | Tests pass? | yes | license? | MIT It also fixes the test since f2b60e9 and improves phpdoc The second commit improves regex performance to validate name (using possesive quantifier). I did some basic performance tests http://3v4l.org/PuvuL The new regex only takes 1/3 of the time compared to the old one! Commits ------- 5798029 [Console] improve regex performance to validate name 22b09ce [Console] make parent constructor test more reliable
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -56,13 +56,13 @@
  */
 class Application
 {
-    private $commands;
+    private $commands = array();
     private $wantHelps = false;
     private $runningCommand;
     private $name;
     private $version;
-    private $catchExceptions;
-    private $autoExit;
+    private $catchExceptions = true;
+    private $autoExit = true;
     private $definition;
     private $helperSet;
     private $dispatcher;
@@ -80,9 +80,6 @@ public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN')
     {
         $this->name = $name;
         $this->version = $version;
-        $this->catchExceptions = true;
-        $this->autoExit = true;
-        $this->commands = array();
         $this->helperSet = $this->getDefaultHelperSet();
         $this->definition = $this->getDefaultInputDefinition();
 
@@ -407,8 +404,8 @@ public function add(Command $command)
             return;
         }
 
-        if (null === $command->getAliases()) {
-            throw new \LogicException(sprintf('You must call the parent constructor in "%s::__construct()"', get_class($command)));
+        if (null === $command->getDefinition()) {
+            throw new \LogicException(sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', get_class($command)));
         }
 
         $this->commands[$command->getName()] = $command;
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -33,21 +33,21 @@ class Command
 {
     private $application;
     private $name;
-    private $aliases;
+    private $aliases = array();
     private $definition;
     private $help;
     private $description;
-    private $ignoreValidationErrors;
-    private $applicationDefinitionMerged;
-    private $applicationDefinitionMergedWithArgs;
+    private $ignoreValidationErrors = false;
+    private $applicationDefinitionMerged = false;
+    private $applicationDefinitionMergedWithArgs = false;
     private $code;
     private $synopsis;
     private $helperSet;
 
     /**
      * Constructor.
      *
-     * @param string $name The name of the command
+     * @param string|null $name The name of the command; passing null means it must be set in configure()
      *
      * @throws \LogicException When the command name is empty
      *
@@ -56,10 +56,6 @@ class Command
     public function __construct($name = null)
     {
         $this->definition = new InputDefinition();
-        $this->ignoreValidationErrors = false;
-        $this->applicationDefinitionMerged = false;
-        $this->applicationDefinitionMergedWithArgs = false;
-        $this->aliases = array();
 
         if (null !== $name) {
             $this->setName($name);
@@ -402,7 +398,7 @@ public function addOption($name, $shortcut = null, $mode = null, $description =
      *
      * @return Command The current instance
      *
-     * @throws \InvalidArgumentException When command name given is empty
+     * @throws \InvalidArgumentException When the name is invalid
      *
      * @api
      */
@@ -512,6 +508,8 @@ public function getProcessedHelp()
      *
      * @return Command The current instance
      *
+     * @throws \InvalidArgumentException When an alias is invalid
+     *
      * @api
      */
     public function setAliases($aliases)
@@ -606,9 +604,18 @@ public function asXml($asDom = false)
         return $output->fetch();
     }
 
+    /**
+     * Validates a command name.
+     *
+     * It must be non-empty and parts can optionally be separated by ":".
+     *
+     * @param string $name
+     *
+     * @throws \InvalidArgumentException When the name is invalid
+     */
     private function validateName($name)
     {
-        if (!preg_match('/^[^\:]+(\:[^\:]+)*$/', $name)) {
+        if (!preg_match('/^[^\:]++(\:[^\:]++)*$/', $name)) {
             throw new \InvalidArgumentException(sprintf('Command name "%s" is invalid.', $name));
         }
     }
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -127,13 +127,13 @@ public function testAdd()
     }
 
     /**
-     * @expectedException LogicException
-     * @expectedExceptionMessage You must call the parent constructor in "Foo5Command::__construct()"
+     * @expectedException \LogicException
+     * @expectedExceptionMessage Command class "Foo5Command" is not correctly initialized. You probably forgot to call the parent constructor.
      */
     public function testAddCommandWithEmptyConstructor()
     {
         $application = new Application();
-        $application->add($foo = new \Foo5Command());
+        $application->add(new \Foo5Command());
     }
 
     public function testHasGet()

Original file line number	Diff line number	Diff line change
`@@ -33,21 +33,21 @@ class Command`
`33`	`33`	`{`
`34`	`34`	`private $application;`
`35`	`35`	`private $name;`
`36`		`- private $aliases;`
	`36`	`+ private $aliases = array();`
`37`	`37`	`private $definition;`
`38`	`38`	`private $help;`
`39`	`39`	`private $description;`
`40`		`- private $ignoreValidationErrors;`
`41`		`- private $applicationDefinitionMerged;`
`42`		`- private $applicationDefinitionMergedWithArgs;`
	`40`	`+ private $ignoreValidationErrors = false;`
	`41`	`+ private $applicationDefinitionMerged = false;`
	`42`	`+ private $applicationDefinitionMergedWithArgs = false;`
`43`	`43`	`private $code;`
`44`	`44`	`private $synopsis;`
`45`	`45`	`private $helperSet;`
`46`	`46`
`47`	`47`	`/**`
`48`	`48`	`* Constructor.`
`49`	`49`	`*`
`50`		`- * @param string $name The name of the command`
	`50`	`+ * @param string\|null $name The name of the command; passing null means it must be set in configure()`
`51`	`51`	`*`
`52`	`52`	`* @throws \LogicException When the command name is empty`
`53`	`53`	`*`
`@@ -56,10 +56,6 @@ class Command`
`56`	`56`	`public function __construct($name = null)`
`57`	`57`	`{`
`58`	`58`	`$this->definition = new InputDefinition();`
`59`		`- $this->ignoreValidationErrors = false;`
`60`		`- $this->applicationDefinitionMerged = false;`
`61`		`- $this->applicationDefinitionMergedWithArgs = false;`
`62`		`- $this->aliases = array();`
`63`	`59`
`64`	`60`	`if (null !== $name) {`
`65`	`61`	`$this->setName($name);`
`@@ -402,7 +398,7 @@ public function addOption($name, $shortcut = null, $mode = null, $description =`
`402`	`398`	`*`
`403`	`399`	`* @return Command The current instance`
`404`	`400`	`*`
`405`		`- * @throws \InvalidArgumentException When command name given is empty`
	`401`	`+ * @throws \InvalidArgumentException When the name is invalid`
`406`	`402`	`*`
`407`	`403`	`* @api`
`408`	`404`	`*/`
`@@ -512,6 +508,8 @@ public function getProcessedHelp()`
`512`	`508`	`*`
`513`	`509`	`* @return Command The current instance`
`514`	`510`	`*`
	`511`	`+ * @throws \InvalidArgumentException When an alias is invalid`
	`512`	`+ *`
`515`	`513`	`* @api`
`516`	`514`	`*/`
`517`	`515`	`public function setAliases($aliases)`
`@@ -606,9 +604,18 @@ public function asXml($asDom = false)`
`606`	`604`	`return $output->fetch();`
`607`	`605`	`}`
`608`	`606`
	`607`	`+ /**`
	`608`	`+ * Validates a command name.`
	`609`	`+ *`
	`610`	`+ * It must be non-empty and parts can optionally be separated by ":".`
	`611`	`+ *`
	`612`	`+ * @param string $name`
	`613`	`+ *`
	`614`	`+ * @throws \InvalidArgumentException When the name is invalid`
	`615`	`+ */`
`609`	`616`	`private function validateName($name)`
`610`	`617`	`{`
`611`		`- if (!preg_match('/^[^\:]+(\:[^\:]+)*$/', $name)) {`
	`618`	`+ if (!preg_match('/^[^\:]++(\:[^\:]++)*$/', $name)) {`
`612`	`619`	`throw new \InvalidArgumentException(sprintf('Command name "%s" is invalid.', $name));`
`613`	`620`	`}`
`614`	`621`	`}`
Original file line number	Diff line number	Diff line change
`@@ -127,13 +127,13 @@ public function testAdd()`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`/**`
`130`		`- * @expectedException LogicException`
`131`		`- * @expectedExceptionMessage You must call the parent constructor in "Foo5Command::__construct()"`
	`130`	`+ * @expectedException \LogicException`
	`131`	`+ * @expectedExceptionMessage Command class "Foo5Command" is not correctly initialized. You probably forgot to call the parent constructor.`
`132`	`132`	`*/`
`133`	`133`	`public function testAddCommandWithEmptyConstructor()`
`134`	`134`	`{`
`135`	`135`	`$application = new Application();`
`136`		`- $application->add($foo = new \Foo5Command());`
	`136`	`+ $application->add(new \Foo5Command());`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`public function testHasGet()`