Update code standards to PSR12.

Author: chrisryan

build.php

@@ -8,9 +8,7 @@
     exit(1);
 }
 
-$phpcs = './vendor/bin/phpcs --standard=' . __DIR__ . '/vendor/traderinteractive/coding-standard/DWS -n';
-$phpcs .= ' src tests *.php';
-passthru($phpcs, $returnStatus);
+passthru('./vendor/bin/phpcs -n', $returnStatus);
 if ($returnStatus !== 0) {
     exit(1);
 }

phpcs.xml.dist

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+    <config name="ignore_warnings_on_exit" value="true"/>
+    <file>tests</file>
+    <file>src</file>
+    <file>build.php</file>
+    <arg name="report" value="full"/>
+    <arg name="colors" />
+    <arg value="p" />
+    <rule ref="PSR12">
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore" />
+        <exclude name="PSR2.Classes.PropertyDeclaration.Underscore" />
+    </rule>
+</ruleset>

src/Application.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes;
 
 use Symfony\Component\Console\Application as SymfonyApplication;

src/BuildRelease.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes;
 
 use Gregwar\Cache\Cache;
@@ -97,7 +98,13 @@ protected function configure()
             null,
             InputOption::VALUE_NONE,
             'Only include Pull Requests in the change list.'
-        )->addOption('cache-dir', null, InputOption::VALUE_REQUIRED, 'The access token cache location', dirname(__DIR__))->addOption(
+        )->addOption(
+            'cache-dir',
+            null,
+            InputOption::VALUE_REQUIRED,
+            'The access token cache location',
+            dirname(__DIR__)
+        )->addOption(
             'token-file',
             null,
             InputOption::VALUE_REQUIRED,
@@ -127,7 +134,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $this->versionFactory = new CalendarVersionFactory();
         }
 
-        $promptFactory = new PromptFactory($input, $output, $this->getHelperSet()->get('question'), $this->getHelperSet()->get('formatter'));
+        $promptFactory = new PromptFactory(
+            $input,
+            $output,
+            $this->getHelperSet()->get('question'),
+            $this->getHelperSet()->get('formatter')
+        );
 
         $client = GithubClient::createWithToken(
             $this->_getToken($input, $promptFactory),
@@ -157,7 +169,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
             $done = false;
             while (!$done) {
-                $choice = $promptFactory->invoke('What would you like to do?', $defaultChoice, $choices, $release->previewFormat());
+                $choice = $promptFactory->invoke(
+                    'What would you like to do?',
+                    $defaultChoice,
+                    $choices,
+                    $release->previewFormat()
+                );
                 $result = $this->_handleUserInput($release, $promptFactory, $client, $input, $output, $choice);
                 if ($result === true) {
                     $done = true;
@@ -189,8 +206,7 @@ private function _handleUserInput(
         InputInterface $input,
         OutputInterface $output,
         string $choice
-    )
-    {
+    ) {
         $typeManager = $this->typeManager;
         $targetBranch = $baseTagName = null;
         switch ($choice) {
@@ -205,7 +221,7 @@ private function _handleUserInput(
                 return $this->_buildRelease($input, $output, $client, $targetBranch, $baseTagName);
                 break;
             case 'c':
-                $selectTypeForChange = function(Change $change) use($promptFactory, $typeManager) {
+                $selectTypeForChange = function (Change $change) use ($promptFactory, $typeManager) {
                     $choice = $promptFactory->invoke(
                         'What type of change is this PR?',
                         $change->getType()->getCode(),
@@ -229,7 +245,13 @@ private function _handleUserInput(
                 $currentVersion = $release->currentVersion;
                 $defaultVersion = $release->version;
                 $release->version = $this->versionFactory->createVersion(
-                    $promptFactory->invoke("Version Number (current: {$currentVersion})", $defaultVersion, $suggestedVersions, null, false)
+                    $promptFactory->invoke(
+                        "Version Number (current: {$currentVersion})",
+                        $defaultVersion,
+                        $suggestedVersions,
+                        null,
+                        false
+                    )
                 );
                 break;
             case 'n':
@@ -267,8 +289,13 @@ private function _handleUserInput(
      *
      * @throws \Exception if tag already exists
      */
-    private function _buildRelease(InputInterface $input, OutputInterface $output, GithubClient $client, $targetBranch, $baseTagName)
-    {
+    private function _buildRelease(
+        InputInterface $input,
+        OutputInterface $output,
+        GithubClient $client,
+        $targetBranch,
+        $baseTagName
+    ) {
         $currentVersion = $this->versionFactory->createVersion($baseTagName);
 
         $typeSelector = null;
@@ -294,7 +321,15 @@ private function _buildRelease(InputInterface $input, OutputInterface $output, G
         $releaseName = $this->_getReleaseName($input);
         $isDraft = !$input->getOption('publish');
 
-        return new Release($changes, $currentVersion, $newVersion, $releaseName, $releaseNotes, $targetBranch, $isDraft);
+        return new Release(
+            $changes,
+            $currentVersion,
+            $newVersion,
+            $releaseName,
+            $releaseNotes,
+            $targetBranch,
+            $isDraft
+        );
     }
 
     private function _getChangesInRange(
@@ -303,8 +338,7 @@ private function _getChangesInRange(
         $startCommitish,
         $endCommitish,
         callable $changePrompter = null
-    )
-    {
+    ) {
         $commitDepth = 1;
         $argument = (int)$input->getOption('commit-depth');
         if ($argument >= 1) {
@@ -313,7 +347,10 @@ private function _getChangesInRange(
 
         $commitGraph = new GithubCommitGraph($client->getCommitsInRange($startCommitish, $endCommitish));
         $leadingCommits = $commitGraph->firstParents($commitDepth);
-        $changeListFactory = new ChangeListFactory(new ChangeFactory($this->typeManager, $changePrompter), $this->typeManager);
+        $changeListFactory = new ChangeListFactory(
+            new ChangeFactory($this->typeManager, $changePrompter),
+            $this->typeManager
+        );
 
         return $changeListFactory->createFromCommits($leadingCommits);
     }
@@ -334,7 +371,13 @@ private function _getToken(InputInterface $input, PromptFactory $promptFactory)
 
         $cache = new Cache($input->getOption('cache-dir'));
 
-        return trim($cache->getOrCreate($input->getOption('token-file'), [], $promptFactory->create('Please enter a github access token')));
+        return trim(
+            $cache->getOrCreate(
+                $input->getOption('token-file'),
+                [],
+                $promptFactory->create('Please enter a github access token')
+            )
+        );
     }
 
     /**
@@ -457,8 +500,7 @@ private function _submitRelease(
         PromptFactory $promptFactory,
         GithubClient $client,
         Release $release
-    )
-    {
+    ) {
         $defaultResponse = !$input->getOption('dry-run');
         $output->writeln($release->previewFormat());
         if ($promptFactory->invoke('Are you sure?', $defaultResponse)) {

src/CalendarVersion.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes;
 
 use Herrera\Version\Parser as VersionParser;

src/CalendarVersionFactory.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes;
 
 final class CalendarVersionFactory implements VersionFactoryInterface
@@ -10,7 +11,7 @@ final class CalendarVersionFactory implements VersionFactoryInterface
      *
      * @return VersionInterface new version object
      */
-    public function createVersion($version = null) : VersionInterface
+    public function createVersion($version = null): VersionInterface
     {
         return new CalendarVersion($version);
     }

src/Change/Change.php

@@ -1,11 +1,12 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes\Change;
 
 use Guywithnose\ReleaseNotes\Type\Type;
 
 class Change implements ChangeInterface
 {
-    const TYPE_IGNORE = 'x';
+    public const TYPE_IGNORE = 'x';
 
     /** @type Type The type of the change. */
     protected $_type;
@@ -45,7 +46,7 @@ public function setType(Type $type)
      *
      * @return Type The type code.
      */
-    public function getType() : Type
+    public function getType(): Type
     {
         return $this->_type;
     }
@@ -67,7 +68,7 @@ public function setLink(string $link)
      *
      * @return string The link.
      */
-    public function getLink() : string
+    public function getLink(): string
     {
         return $this->_link;
     }
@@ -87,7 +88,7 @@ public function displayType()
      *
      * @return string A short representation of the change.
      */
-    public function displayShort() : string
+    public function displayShort(): string
     {
         if (!empty($this->getLink())) {
             return '* [' . strtok($this->_message, "\n") . "]({$this->getLink()})";
@@ -101,7 +102,7 @@ public function displayShort() : string
      *
      * @return string A long representation of the change.
      */
-    public function displayFull() : string
+    public function displayFull(): string
     {
         return $this->_message;
     }

src/Change/ChangeFactory.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes\Change;
 
 use Guywithnose\ReleaseNotes\Type\TypeManager;
@@ -14,15 +15,15 @@ class ChangeFactory
     /**
      * Initialize the change factory with the type selector.
      *
-     * The type selector is a function that is passed the change and must return a valid type (@see \Guywithnose\ReleaseNotes\Change::types) or
-     * null to use the default type.
+     * The type selector is a function that is passed the change and must return a valid type
+     * (@see \Guywithnose\ReleaseNotes\Change::types) or null to use the default type.
      *
      * @param callable $typeSelector The type selector function.
      */
     public function __construct(TypeManager $typeManager, callable $typeSelector = null)
     {
         $this->typeManager = $typeManager;
-        $this->_typeSelector = $typeSelector ?: function(Change $change) {
+        $this->_typeSelector = $typeSelector ?: function (Change $change) {
             return $change->getType();
         };
     }
@@ -38,11 +39,14 @@ public function createFromCommit(array $commit)
         $typeSelector = $this->_typeSelector;
         $change = null;
 
+        $mergePRRegexp = '/Merge pull request #([0-9]*)[^\n]*\n[^\n]*\n(.*)/s';
+        $mergeBranchRegExp = '/Merge branch \'([^\']*)\'[^\n]*\n[^\n]*\n(.*)/s';
+
         if (count($commit['parents']) > 1) {
             $change = null;
-            if (preg_match('/Merge pull request #([0-9]*)[^\n]*\n[^\n]*\n(.*)/s', $commit['commit']['message'], $matches)) {
+            if (preg_match($mergePRRegexp, $commit['commit']['message'], $matches)) {
                 $change = new PullRequest((int)$matches[1], $matches[2], $this->typeManager->getDefaultType());
-            } elseif (preg_match('/Merge branch \'([^\']*)\'[^\n]*\n[^\n]*\n(.*)/s', $commit['commit']['message'], $matches)) {
+            } elseif (preg_match($mergeBranchRegExp, $commit['commit']['message'], $matches)) {
                 $change = new Merge($matches[1], $matches[2], $this->typeManager->getDefaultType());
             } else {
                 $change = new Change($commit['commit']['message'], $this->typeManager->getDefaultType());

src/Change/ChangeInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes\Change;
 
 use Guywithnose\ReleaseNotes\Type\Type;
@@ -19,7 +20,7 @@ public function setType(Type $type);
      *
      * @return Type The type code.
      */
-    public function getType() : Type;
+    public function getType(): Type;
 
     /**
      * Sets the link.
@@ -35,19 +36,19 @@ public function setLink(string $link);
      *
      * @return string The link.
      */
-    public function getLink() : string;
+    public function getLink(): string;
 
     /**
      * Returns a short markdown snippet of the change for use in release notes.
      *
      * @return string A short representation of the change.
      */
-    public function displayShort() : string;
+    public function displayShort(): string;
 
     /**
      * Returns a long markdown version of the change for use in user display.
      *
      * @return string A long representation of the change.
      */
-    public function displayFull() : string;
+    public function displayFull(): string;
 }

src/Change/ChangeList.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes\Change;
 
 use Guywithnose\ReleaseNotes\Type\Type;

src/Change/ChangeListFactory.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes\Change;
 
 use Guywithnose\ReleaseNotes\Type\TypeManager;

src/Change/Merge.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Guywithnose\ReleaseNotes\Change;
 
 use Guywithnose\ReleaseNotes\Type\Type;
@@ -27,7 +28,7 @@ public function __construct($branch, $message, Type $type)
      *
      * @return string A short representation of the merge.
      */
-    public function displayShort() : string
+    public function displayShort(): string
     {
         return parent::displayShort() . "&nbsp;<sup>[{$this->_branch}]</sup>";
     }
@@ -37,7 +38,7 @@ public function displayShort() : string
      *
      * @return string A long representation of the merge.
      */
-    public function displayFull() : string
+    public function displayFull(): string
     {
         return "### {$this->_branch}\n{$this->_message}";
     }