Merge pull request #211 from mlocati/cs

Add PHP coding style rules and check PHP coding style

Author: mlocati

.atoum.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  * Pickle
  *
  *
@@ -39,12 +39,14 @@
 if (getenv('TRAVIS_PHP_VERSION') === '7.0') {
     $script
         ->php('php -n -ddate.timezone=Europe/Paris')
-        ->noCodeCoverage();
+        ->noCodeCoverage()
+    ;
 } else {
     $script->noCodeCoverageForNamespaces('Composer');
 }
 
 $script->addTestsFromDirectory(__DIR__ . '/tests/units');
 $runner
     ->addExtension(new \Atoum\PraspelExtension\Manifest())
-    ->addExtension(new visibility\extension($script));
+    ->addExtension(new visibility\extension($script))
+;

.bootstrap.atoum.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  * Pickle
  *
  *

.github/workflows/test.yml

@@ -36,6 +36,9 @@ jobs:
           fetch-depth: 0
       - name: Install Composer dependencies (including dev, preferring source)
         run: composer install --prefer-source --optimize-autoloader --ansi --no-interaction
+      - name: Check coding style
+        if: matrix.os == 'ubuntu-latest' && matrix.php-version == '7.2'
+        run: ./vendor/bin/php-cs-fixer fix --path-mode=intersection --config=./.php_cs.dist --dry-run --using-cache=no --diff --diff-format=udiff --ansi --no-interaction .
       - name: Run Atoum
         run: php ./vendor/atoum/atoum/scripts/coverage.php --format xml --output clover.xml
       - name: Install Composer dependencies (excluding dev)

.gitignore

@@ -4,3 +4,4 @@ vendor/
 *.test
 /clover.xml
 /ocular.phar
+/.php_cs.cache

.php_cs.dist

@@ -10,10 +10,10 @@ function includeIfExists($file)
     return file_exists($file) ? include $file : false;
 }
 
-if ((!$loader = includeIfExists(__DIR__.'/../vendor/autoload.php')) && (!$loader = includeIfExists(__DIR__.'/../../../autoload.php'))) {
-    echo 'You must set up the project dependencies, run the following commands:'.PHP_EOL.
-        'curl -sS https://getcomposer.org/installer | php'.PHP_EOL.
-        'php composer.phar install'.PHP_EOL;
+if ((!$loader = includeIfExists(__DIR__ . '/../vendor/autoload.php')) && (!$loader = includeIfExists(__DIR__ . '/../../../autoload.php'))) {
+    echo 'You must set up the project dependencies, run the following commands:' . PHP_EOL
+        . 'curl -sS https://getcomposer.org/installer | php' . PHP_EOL
+        . 'php composer.phar install' . PHP_EOL;
 
     exit(1);
 }
@@ -25,7 +25,7 @@ if (defined('PHP_WINDOWS_VERSION_MAJOR')) {
   | |_) | |/ __| |/ / |/ _ \
   |  __/| | (__|   <| |  __/
   |_|   |_|\___|_|\_\_|\___| ';
- } else {
+} else {
     $name = '
  ██████╗ ██╗ ██████╗██╗  ██╗██╗     ███████╗
  ██╔══██╗██║██╔════╝██║ ██╔╝██║     ██╔════╝

bin/pickle

@@ -33,7 +33,7 @@
         "atoum/praspel-extension": "~0.17",
         "atoum/visibility-extension": "~1.3",
         "behat/behat": "~3.6",
-        "friendsofphp/php-cs-fixer": "^2.16",
+        "friendsofphp/php-cs-fixer": "^2.18.1",
         "mlocati/composer-patcher": "^1.2.2",
         "symfony/process": "^5.0"
     },

composer.json

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  * Pickle
  *
  *
@@ -33,6 +33,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
+
 use Behat\Behat\Context\SnippetAcceptingContext;
 use Behat\Gherkin\Node\PyStringNode;
 use Symfony\Component\Process\PhpExecutableFinder;
@@ -45,12 +46,16 @@
  */
 class FeatureContext implements SnippetAcceptingContext
 {
-    const PICKLE_BIN = 'bin/pickle';
+    protected const PICKLE_BIN = 'bin/pickle';
 
     private $assert;
+
     private $php;
+
     private $dir;
+
     private $workingDir;
+
     private $process;
 
     public function __construct()
@@ -84,49 +89,40 @@ public function prepare()
         $this->php = $php;
     }
 
-    private function moveToNewPath($path)
-    {
-        $newWorkingDir = $this->workingDir .'/' . $path;
-
-        if (!file_exists($newWorkingDir)) {
-            mkdir($newWorkingDir, 0777, true);
-        }
-
-        $this->workingDir = $newWorkingDir;
-    }
-
     /**
      * @Given /^I am in the "([^"]*)" path$/
      */
     public function iAmInThePath($path)
     {
         $this->moveToNewPath($path);
     }
-/*     convert   Convert package.xml to new format
-    help      Displays help for a command
-    info      Display information about a PECL extension
-    install   Install a php extension
-    list      Lists commands
-    release   Package a PECL extension for release
-    validate  Validate a PECL extension */
+
+    /*     convert   Convert package.xml to new format
+        help      Displays help for a command
+        info      Display information about a PECL extension
+        install   Install a php extension
+        list      Lists commands
+        release   Package a PECL extension for release
+        validate  Validate a PECL extension */
+
     /**
      * @When /^I run "pickle(?: ((?:\"|[^"])*))?"$/
      */
     public function iRunPickle($argumentsString = '')
     {
-        $argumentsString = strtr($argumentsString, array('\'' => '"'));
-        $arguments = explode(' ',$argumentsString);
+        $argumentsString = strtr($argumentsString, ['\'' => '"']);
+        $arguments = explode(' ', $argumentsString);
         $processArguments = [
-                $this->php,
-                __DIR__ . '/../../' . static::PICKLE_BIN,
-            ];
+            $this->php,
+            __DIR__ . '/../../' . static::PICKLE_BIN,
+        ];
 
         $processArguments = array_merge($processArguments, $arguments);
         $processArguments[] = '--no-ansi';
         $this->process = new Process($processArguments);
 
         $timeout = getenv('PICKLE_BEHAT_PROCESS_TIMEOUT');
-        if (false !== $timeout) {
+        if ($timeout !== false) {
             $this->process->setTimeout($timeout);
         }
 
@@ -148,14 +144,14 @@ public function theOutputShouldContain(PyStringNode $text)
      */
     public function itShouldFail($success)
     {
-        if ('fail' === $success) {
-            if (0 === $this->getExitCode()) {
+        if ($success === 'fail') {
+            if ($this->getExitCode() === 0) {
                 echo 'Actual output:' . PHP_EOL . PHP_EOL . $this->getOutput();
             }
 
             $this->assert->integer($this->getExitCode())->isGreaterThan(0);
         } else {
-            if (0 !== $this->getExitCode()) {
+            if ($this->getExitCode() !== 0) {
                 echo 'Actual output:' . PHP_EOL . PHP_EOL . $this->getOutput();
             }
 
@@ -177,7 +173,7 @@ public function itShouldPassWith($success, PyStringNode $text)
      */
     public function aFileNamedWith($filename, PyStringNode $content)
     {
-        $content = strtr((string) $content, array("'''" => '"""'));
+        $content = strtr((string) $content, ["'''" => '"""']);
         $this->createFile($this->workingDir . '/' . $filename, $content);
     }
 
@@ -221,6 +217,36 @@ public function JsonfileShouldContain($path, PyStringNode $text)
         $this->assert->object($fileContent)->isEqualTo(json_decode($text));
     }
 
+    /**
+     * @Then /^"([^"]*)" ((?:\d+\.?)+(?:RC\d*|beta\d*|alpha\d*)?) extension exists$/
+     */
+    public function extensionExists($name, $version)
+    {
+        $url = 'https://pecl.php.net/get/' . $name . '/' . $version . '?uncompress=1';
+        $file = $name . '-' . $version . '.tgz';
+        $dir = $this->workingDir . '/' . $name . '-' . $version;
+
+        if (is_dir($dir) === false) {
+            mkdir($dir, 0777, true);
+        }
+        $downloadFile = $dir . '/' . $file;
+        file_put_contents($downloadFile, file_get_contents($url));
+        $p = new PharData($downloadFile);
+        $phar = $p->decompress('.tar');
+        $phar->extractTo($dir);
+    }
+
+    private function moveToNewPath($path)
+    {
+        $newWorkingDir = $this->workingDir . '/' . $path;
+
+        if (!file_exists($newWorkingDir)) {
+            mkdir($newWorkingDir, 0777, true);
+        }
+
+        $this->workingDir = $newWorkingDir;
+    }
+
     private function getExitCode()
     {
         return $this->process->getExitCode();
@@ -249,21 +275,19 @@ private function getOutput()
             $output = str_replace(PHP_EOL, "\n", $output);
         }
 
-        return trim(preg_replace("/ +$/m", '', $output));
+        return trim(preg_replace('/ +$/m', '', $output));
     }
 
     private function getExpectedOutput(PyStringNode $expectedText)
     {
-        $text = strtr(
+        return strtr(
             $expectedText,
             [
                 '\'\'\'' => '"""',
                 '%%TMP_DIR%%' => sys_get_temp_dir(),
                 '%%TEST_DIR%%' => realpath($this->dir),
             ]
         );
-
-        return $text;
     }
 
     private static function clearDirectory($path)
@@ -283,23 +307,4 @@ private static function clearDirectory($path)
 
         rmdir($path);
     }
-
-    /**
-     * @Then /^"([^"]*)" ((?:\d+\.?)+(?:RC\d*|beta\d*|alpha\d*)?) extension exists$/
-     */
-    public function extensionExists($name, $version)
-    {
-        $url = 'https://pecl.php.net/get/' . $name . '/' . $version . '?uncompress=1';
-        $file = $name . '-' . $version . '.tgz';
-        $dir = $this->workingDir . '/' . $name . '-' . $version;
-
-        if (is_dir($dir) === false) {
-            mkdir($dir, 0777, true);
-        }
-        $downloadFile = $dir . '/' . $file;
-        file_put_contents($downloadFile, file_get_contents($url));
-        $p = new PharData($downloadFile);
-        $phar = $p->decompress('.tar');
-        $phar->extractTo($dir);
-    }
 }

composer.lock

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  * Pickle
  *
  *
@@ -33,7 +33,8 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
+
 class PharFeatureContext extends FeatureContext
 {
-    const PICKLE_BIN = 'pickle.phar';
+    protected const PICKLE_BIN = 'pickle.phar';
 }