Fix PSR-2 naming convention issues

phpDocumentor · Oct 28, 2015 · 950516c · 950516c
1 parent 5d2e2fc
commit 950516c
Show file tree

Hide file tree

Showing 42 changed files with 197 additions and 131 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/phpDocumentor/ApiReference/Api.php b/src/phpDocumentor/ApiReference/Api.php
@@ -103,4 +103,4 @@ public function getElements()
     {
         return $this->elements;
     }
-}
+}
diff --git a/src/phpDocumentor/ApiReference/DocumentGroupDefinition.php b/src/phpDocumentor/ApiReference/DocumentGroupDefinition.php
@@ -12,7 +12,6 @@
 
 namespace phpDocumentor\ApiReference;
 
-
 use Flyfinder\Specification\SpecificationInterface;
 use League\Flysystem\FilesystemInterface;
 use phpDocumentor\DocumentGroupDefinition as DocumentGroupDefinitionInterface;
@@ -49,8 +48,7 @@ public function __construct(
         DocumentGroupFormat $format,
         FilesystemInterface $filesystem,
         SpecificationInterface $specification
-    )
-    {
+    ) {
         $this->format = $format;
         $this->filesystem = $filesystem;
         $this->specification = $specification;

diff --git a/src/phpDocumentor/Application/Cli/Command/ListCommand.php b/src/phpDocumentor/Application/Cli/Command/ListCommand.php
@@ -41,7 +41,7 @@ protected function configure()
                 'Displays a listing of all available templates in phpDocumentor'
             )
             ->setHelp(
-<<<HELP
+                <<<HELP
 This task outputs a list of templates as available in phpDocumentor.
 Please mind that custom templates which are situated outside phpDocumentor are not
 shown in this listing.

diff --git a/src/phpDocumentor/Application/Cli/Command/RunCommand.php b/src/phpDocumentor/Application/Cli/Command/RunCommand.php
@@ -112,7 +112,7 @@ protected function configure()
                 'Parses and transforms the given files to a specified location'
             )
             ->setHelp(
-<<<HELP
+                <<<HELP
 phpDocumentor creates documentation from PHP source files. The simplest way
 to use it is:
 
@@ -297,14 +297,19 @@ protected function execute(InputInterface $input, OutputInterface $output)
             );
         }
 
-        foreach($this->definitionRepository->fetchAll() as $definition) {
+        foreach ($this->definitionRepository->fetchAll() as $definition) {
             $documentation = $this->documentationRepository->findByVersionNumber($definition->getVersionNumber());
 
             if ($documentation === null) {
                 $documentation = $this->documentationFactory->create($definition);
                 $this->documentationRepository->save($documentation);
             }
-            $this->commandBus->handle(new Render(sys_get_temp_dir() . '/phpdoc', $input->getOption('template') ?: ['clean']));
+            $this->commandBus->handle(
+                new Render(
+                    sys_get_temp_dir() . '/phpdoc',
+                    $input->getOption('template') ?: ['clean']
+                )
+            );
         }
 
 

diff --git a/src/phpDocumentor/DefinitionFactory.php b/src/phpDocumentor/DefinitionFactory.php
@@ -22,4 +22,4 @@ interface DefinitionFactory
      * @return Definition
      */
     public function create(array $options);
-}
+}
diff --git a/src/phpDocumentor/DocumentGroupDefinitionFactory.php b/src/phpDocumentor/DocumentGroupDefinitionFactory.php
@@ -18,4 +18,4 @@
 interface DocumentGroupDefinitionFactory extends DefinitionFactory
 {
 
-}
+}
diff --git a/src/phpDocumentor/DocumentGroupFormat.php b/src/phpDocumentor/DocumentGroupFormat.php
@@ -48,7 +48,7 @@ public function getFormat()
      *
      * @return string
      */
-    function __toString()
+    public function __toString()
     {
         return $this->getFormat();
     }

diff --git a/src/phpDocumentor/Documentation.php b/src/phpDocumentor/Documentation.php
@@ -11,6 +11,7 @@
  */
 
 namespace phpDocumentor;
+
 use phpDocumentor\Project\VersionNumber;
 
 /**

diff --git a/src/phpDocumentor/DocumentationRepository.php b/src/phpDocumentor/DocumentationRepository.php
@@ -10,6 +10,7 @@
  */
 
 namespace phpDocumentor;
+
 use phpDocumentor\Project\VersionNumber;
 use Stash\Pool;
 

diff --git a/src/phpDocumentor/Exception.php b/src/phpDocumentor/Exception.php
@@ -19,4 +19,4 @@
 class Exception extends BaseException
 {
 
-}
+}
diff --git a/src/phpDocumentor/FactoryNotFoundException.php b/src/phpDocumentor/FactoryNotFoundException.php
@@ -17,4 +17,4 @@
 final class FactoryNotFoundException extends Exception
 {
 
-}
+}
diff --git a/src/phpDocumentor/FlySystemFactory.php b/src/phpDocumentor/FlySystemFactory.php
@@ -48,7 +48,6 @@ public function create(Dsn $dsn)
             $filesystem = $this->mountManager->getFilesystem($dsnId);
         } catch (LogicException $e) {
             if ($dsn->getScheme() === 'file') {
-
                 $path = $dsn->getPath();
                 $filesystem = new Filesystem(new Local($path, LOCK_EX, Local::SKIP_LINKS));
 

diff --git a/src/phpDocumentor/Guides/Document.php b/src/phpDocumentor/Guides/Document.php
@@ -10,6 +10,7 @@
  */
 
 namespace phpDocumentor\Guides;
+
 use phpDocumentor\Path;
 
 /**

diff --git a/src/phpDocumentor/Infrastructure/FlyFinder/SpecificationFactory.php b/src/phpDocumentor/Infrastructure/FlyFinder/SpecificationFactory.php
@@ -53,7 +53,8 @@ public function create(array $paths, array $ignore, array $extensions)
             $ignoreSpec = $this->orSpec(new IsHidden(), $ignoreSpec);
         }
 
-        return new AndSpecification($pathSpec,
+        return new AndSpecification(
+            $pathSpec,
             new AndSpecification(
                 new NotSpecification($ignoreSpec),
                 new HasExtension($extensions)
@@ -88,4 +89,3 @@ private function inPath($path)
         return new InPath(new Path($path));
     }
 }
-
diff --git a/...Plugin/Core/Descriptor/Validator/Constraints/Functions/DoesArgumentTypehintMatchParam.php b/...Plugin/Core/Descriptor/Validator/Constraints/Functions/DoesArgumentTypehintMatchParam.php
@@ -20,8 +20,10 @@
  */
 class DoesArgumentTypehintMatchParam extends Constraint
 {
+    // @codingStandardsIgnoreStart
     /** @var string message */
     public $message = 'The type hint of the argument is incorrect for the type definition of the @param tag with argument %s in %s';
+    // @codingStandardsIgnoreEnd
 
     public $code = 50016;
 

diff --git a/src/phpDocumentor/Plugin/Core/Descriptor/Validator/DeprecatedValidator.php b/src/phpDocumentor/Plugin/Core/Descriptor/Validator/DeprecatedValidator.php
@@ -75,7 +75,12 @@
 //            if (count($this->docblock->getTagsByName($tag)) < 1) {
 //                continue;
 //            }
-//            $this->logParserError('CRITICAL', 'Found deprecated tag "%s" in %s', $this->lineNumber, array($tag, $this->entityName));
+//            $this->logParserError(
+//              'CRITICAL',
+//              'Found deprecated tag "%s" in %s',
+//              $this->lineNumber,
+//              array($tag, $this->entityName)
+//            );
 //        }
 //    }
 //}
diff --git a/src/phpDocumentor/Project/Version/DefinitionFactory.php b/src/phpDocumentor/Project/Version/DefinitionFactory.php
@@ -56,7 +56,7 @@ private function createDocumentGroupDefinitions(array $options)
         $documentGroups = array();
 
         foreach ($options as $documentGroupType => $documentGroupOptions) {
-            if(is_array($documentGroupOptions)) {
+            if (is_array($documentGroupOptions)) {
                 $factory = $this->findFactory($documentGroupType, $documentGroupOptions['format']);
                 $documentGroups[] = $factory->create($documentGroupOptions);
             }
@@ -93,8 +93,11 @@ private function findFactory($type, $format)
      * @param DocumentGroupFormat $format
      * @param DocumentGroupDefinitionFactory $factory
      */
-    public function registerDocumentGroupDefinitionFactory($type, DocumentGroupFormat $format, DocumentGroupDefinitionFactory $factory)
-    {
+    public function registerDocumentGroupDefinitionFactory(
+        $type,
+        DocumentGroupFormat $format,
+        DocumentGroupDefinitionFactory $factory
+    ) {
         $this->documentGroupDefinitionFactories[$type][(string)$format] = $factory;
     }
 }
diff --git a/src/phpDocumentor/Project/Version/DefinitionRepository.php b/src/phpDocumentor/Project/Version/DefinitionRepository.php
@@ -10,6 +10,7 @@
  */
 
 namespace phpDocumentor\Project\Version;
+
 use phpDocumentor\ConfigurationFactory;
 
 /**

diff --git a/src/phpDocumentor/Reflection/Php/Factory/File/FlySystemAdapter.php b/src/phpDocumentor/Reflection/Php/Factory/File/FlySystemAdapter.php
@@ -77,4 +77,3 @@ public function path($filePath)
         return $filePath;
     }
 }
-
diff --git a/src/phpDocumentor/Renderer/Action/SourcecodeHandler.php b/src/phpDocumentor/Renderer/Action/SourcecodeHandler.php
@@ -60,7 +60,7 @@ public function __invoke(Action $action)
             $fs = $action->getRenderPass()->getFilesystem();
             $fs->put(
                 $path.'.html',
-<<<HTML
+                <<<HTML
 <html>
     <head>
         <script

diff --git a/src/phpDocumentor/Renderer/Action/Xml/Tag/AuthorTag.php b/src/phpDocumentor/Renderer/Action/Xml/Tag/AuthorTag.php
@@ -45,7 +45,6 @@ public function process(\DOMDocument $xml)
 
         /** @var \DOMElement $node */
         foreach ($nodes as $node) {
-
             // FIXME: #193
             if (preg_match($regex, $node->nodeValue, $matches)) {
                 if ($matches['name']) {

diff --git a/src/phpDocumentor/Renderer/Action/Xml/Tag/CoversTag.php b/src/phpDocumentor/Renderer/Action/Xml/Tag/CoversTag.php
@@ -122,7 +122,6 @@ public function process(\DOMDocument $xml)
                     $referral_name = $node->parentNode->parentNode
                         ->getElementsByTagName('full_name')->item(0)->nodeValue;
                 } else {
-
                     $referral_class_name = null;
                     if ($node->parentNode->parentNode->nodeName == 'method') {
                         // gather the name of the class where the @covers is in

diff --git a/src/phpDocumentor/Renderer/Action/Xml/Tag/LicenseTag.php b/src/phpDocumentor/Renderer/Action/Xml/Tag/LicenseTag.php
@@ -50,7 +50,6 @@ public function process(\DOMDocument $xml)
 
         /** @var \DOMElement $node */
         foreach ($nodes as $node) {
-
             $license = $node->nodeValue;
 
             // FIXME: migrate to '#^' . PHPDOC::LINK_REGEX . '(\s+(?P<text>.+))

diff --git a/src/phpDocumentor/Renderer/Action/Xml/Tag/UsesTag.php b/src/phpDocumentor/Renderer/Action/Xml/Tag/UsesTag.php
@@ -118,7 +118,6 @@ public function process(\DOMDocument $xml)
                     $referral_name = $node->parentNode->parentNode
                         ->getElementsByTagName('full_name')->item(0)->nodeValue;
                 } else {
-
                     $referral_class_name = null;
                     if ($node->parentNode->parentNode->nodeName == 'method') {
                         // gather the name of the class where the @uses is in

diff --git a/tests/unit/phpDocumentor/BootstrapTest.php b/tests/unit/phpDocumentor/BootstrapTest.php
@@ -94,8 +94,8 @@ public function testFindVendorPathComposerInstalled()
         $bootstrap = Bootstrap::createInstance();
         $baseDir = vfsStream::url('root/dummy/vendor/phpDocumentor/phpDocumentor/src/phpDocumentor');
         $this->assertSame(
-            'vfs://root/dummy/vendor/phpDocumentor/phpDocumentor/src/phpDocumentor/../../../../../vendor'
-            , $bootstrap->findVendorPath($baseDir)
+            'vfs://root/dummy/vendor/phpDocumentor/phpDocumentor/src/phpDocumentor/../../../../../vendor',
+            $bootstrap->findVendorPath($baseDir)
         );
     }
 
@@ -126,5 +126,4 @@ public function testCreateAutoloader()
         $bootstrap = Bootstrap::createInstance();
         $this->assertTrue($bootstrap->createAutoloader(vfsStream::url('root/dummy/vendor')));
     }
-
 }
diff --git a/tests/unit/phpDocumentor/ConfigurationFactory/PhpDocumentor2Test.php b/tests/unit/phpDocumentor/ConfigurationFactory/PhpDocumentor2Test.php
@@ -12,15 +12,18 @@
 
 namespace phpDocumentor\ConfigurationFactory;
 
-require_once(__DIR__ . '/../../../../tests/data/phpDocumentor2ExpectedArray.php');
-
 /**
  * Test case for PhpDocumentor2
  *
  * @coversDefaultClass phpDocumentor\ConfigurationFactory\PhpDocumentor2
  */
 final class PhpDocumentor2Test extends \PHPUnit_Framework_TestCase
 {
+    public function setUp()
+    {
+        require_once(__DIR__ . '/../../../../tests/data/phpDocumentor2ExpectedArray.php');
+    }
+
     /**
      * @covers ::convert
      * @covers ::<private>
@@ -73,7 +76,11 @@ public function testItMatchesWhenVersionIsEmpty()
      */
     public function testItRevertsToDefaultsIfValuesAreNotInTheConfigurationFile()
     {
-        $xml = new \SimpleXMLElement(__DIR__ . '/../../../../tests/data/phpDocumentor2XMLWithoutExtensions.xml', 0, true);
+        $xml = new \SimpleXMLElement(
+            __DIR__ . '/../../../../tests/data/phpDocumentor2XMLWithoutExtensions.xml',
+            0,
+            true
+        );
 
         $phpDocumentor2 = new PhpDocumentor2();
         $array          = $phpDocumentor2->convert($xml);
@@ -87,7 +94,11 @@ public function testItRevertsToDefaultsIfValuesAreNotInTheConfigurationFile()
      */
     public function testItAcceptsMultipleIgnorePathsInThePhpdoc2Xml()
     {
-        $xml = new \SimpleXMLElement(__DIR__ . '/../../../../tests/data/phpDocumentor2XMLWithMultipleIgnorePaths.xml', 0, true);
+        $xml = new \SimpleXMLElement(
+            __DIR__ . '/../../../../tests/data/phpDocumentor2XMLWithMultipleIgnorePaths.xml',
+            0,
+            true
+        );
 
         $phpDocumentor2 = new PhpDocumentor2();
         $array          = $phpDocumentor2->convert($xml);

diff --git a/tests/unit/phpDocumentor/ConfigurationFactory/PhpDocumentor3Test.php b/tests/unit/phpDocumentor/ConfigurationFactory/PhpDocumentor3Test.php
@@ -12,15 +12,18 @@
 
 namespace phpDocumentor\ConfigurationFactory;
 
-require_once(__DIR__ . '/../../../../tests/data/phpDocumentor3ExpectedArrays.php');
-
 /**
  * Test case for PhpDocumentor3
  *
  * @coversDefaultClass phpDocumentor\ConfigurationFactory\PhpDocumentor3
  */
 final class PhpDocumentor3Test extends \PHPUnit_Framework_TestCase
 {
+    public function setUp()
+    {
+        require_once(__DIR__ . '/../../../../tests/data/phpDocumentor3ExpectedArrays.php');
+    }
+
     /**
      * @covers ::__construct
      * @covers ::convert
@@ -97,7 +100,11 @@ public function testItSetsDefaultValuesIfNoneAreFoundInThePhpdoc3Xml()
      */
     public function testItAcceptsMultipleVersionsInThePhpdoc3Xml()
     {
-        $xml = new \SimpleXMLElement(__DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleVersions.xml', 0, true);
+        $xml = new \SimpleXMLElement(
+            __DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleVersions.xml',
+            0,
+            true
+        );
 
         $phpDocumentor3 = new PhpDocumentor3('');
         $array          = $phpDocumentor3->convert($xml);
@@ -112,7 +119,11 @@ public function testItAcceptsMultipleVersionsInThePhpdoc3Xml()
      */
     public function testItAcceptsMultipleApisInThePhpdoc3Xml()
     {
-        $xml = new \SimpleXMLElement(__DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleApis.xml', 0, true);
+        $xml = new \SimpleXMLElement(
+            __DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleApis.xml',
+            0,
+            true
+        );
 
         $phpDocumentor3 = new PhpDocumentor3('');
         $array          = $phpDocumentor3->convert($xml);
@@ -127,7 +138,11 @@ public function testItAcceptsMultipleApisInThePhpdoc3Xml()
      */
     public function testItAcceptsMultipleGuidesInThePhpdoc3Xml()
     {
-        $xml = new \SimpleXMLElement(__DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleGuides.xml', 0, true);
+        $xml = new \SimpleXMLElement(
+            __DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleGuides.xml',
+            0,
+            true
+        );
 
         $phpDocumentor3 = new PhpDocumentor3('');
         $array          = $phpDocumentor3->convert($xml);
@@ -142,7 +157,11 @@ public function testItAcceptsMultipleGuidesInThePhpdoc3Xml()
      */
     public function testItAcceptsMultipleTemplatesInThePhpdoc3Xml()
     {
-        $xml = new \SimpleXMLElement(__DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleTemplates.xml', 0, true);
+        $xml = new \SimpleXMLElement(
+            __DIR__ . '/../../../../tests/data/phpDocumentor3XMLWithMultipleTemplates.xml',
+            0,
+            true
+        );
 
         $phpDocumentor3 = new PhpDocumentor3('');
         $array          = $phpDocumentor3->convert($xml);

diff --git a/tests/unit/phpDocumentor/DocumentationFactoryTest.php b/tests/unit/phpDocumentor/DocumentationFactoryTest.php
@@ -103,5 +103,4 @@ public function testDocumentGroupFactoryShouldHaveMatch()
         $this->fixture->addDocumentGroupFactory($this->documentGroupFactoryMock);
         $this->fixture->create($versionDefinition);
     }
-
 }