Merge pull request #59 from pattisahusiwa/phpcs

Add coding standard

Author: adhocore

.gitattributes

@@ -0,0 +1,13 @@
+* text=auto
+*.php text eol=lf
+
+/.github export-ignore
+/.phive export-ignore
+/tests export-ignore
+/.editorconfig export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.travis.yml export-ignore
+/ahccli.plugin.zsh export-ignore
+/phpcs.xml.dist export-ignore
+/phpunit.xml.dist export-ignore

.gitignore

@@ -3,7 +3,10 @@
 /.env
 /.idea/
 /vendor/
+/tools/
+
 composer.lock
 *.local.*
 clover.xml
 coverage.xml
+phpcs.xml

.phive/phars.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phive xmlns="https://phar.io/phive">
+  <phar name="phpcs" version="^3.5.5" installed="3.5.5" location="./tools/phpcs" copy="false"/>
+  <phar name="phpcbf" version="^3.5.5" installed="3.5.5" location="./tools/phpcbf" copy="false"/>
+</phive>

composer.json

@@ -3,9 +3,21 @@
     "description": "Command line interface library for PHP",
     "type": "library",
     "keywords": [
-        "php7", "command", "argv-parser", "cli", "cli-color", "cli-action", "console",
-        "cli-writer", "argument-parser", "cli-option", "stream-output", "stream-input",
-        "cli-app", "console-app", "php-cli"
+        "php7",
+        "command",
+        "argv-parser",
+        "cli",
+        "cli-color",
+        "cli-action",
+        "console",
+        "cli-writer",
+        "argument-parser",
+        "cli-option",
+        "stream-output",
+        "stream-input",
+        "cli-app",
+        "console-app",
+        "php-cli"
     ],
     "license": "MIT",
     "authors": [
@@ -32,6 +44,8 @@
     },
     "scripts": {
         "test": "phpunit",
-        "test:cov": "phpunit --coverage-text --coverage-clover coverage.xml --coverage-html vendor/cov"
+        "test:cov": "phpunit --coverage-text --coverage-clover coverage.xml --coverage-html vendor/cov",
+        "cs:sniff": "tools/phpcs",
+        "cs:fix": "tools/phpcbf"
     }
 }

phpcs.xml.dist

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset>
+  <arg value="psv"/>
+  <arg name="extensions" value="php"/>
+
+  <file>src</file>
+  <file>tests</file>
+
+  <exclude-pattern>/vendor/</exclude-pattern>
+
+  <rule ref="PSR12"/>
+
+  <rule ref="PSR12">
+    <exclude name="PSR12.Classes.ClassInstantiation.MissingParentheses" />
+  </rule>
+
+  <rule ref="PSR2.Classes.PropertyDeclaration.Underscore">
+    <exclude-pattern>/src/Input/Command.php</exclude-pattern>
+    <exclude-pattern>/src/Input/Parser.php</exclude-pattern>
+  </rule>
+
+  <rule ref="PSR12.Properties.ConstantVisibility.NotFound">
+    <exclude-pattern>/src/</exclude-pattern>
+  </rule>
+
+  <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
+    <exclude-pattern>/tests/</exclude-pattern>
+  </rule>
+
+  <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+    <exclude-pattern>/tests/</exclude-pattern>
+  </rule>
+</ruleset>

src/Application.php

@@ -166,7 +166,13 @@ public function add(Command $command, string $alias = '', bool $default = false)
     {
         $name = $command->name();
 
-        if ($this->commands[$name] ?? $this->aliases[$name] ?? $this->commands[$alias] ?? $this->aliases[$alias] ?? null) {
+        if (
+            $this->commands[$name] ??
+            $this->aliases[$name] ??
+            $this->commands[$alias] ??
+            $this->aliases[$alias] ??
+            null
+        ) {
             throw new InvalidArgumentException(\sprintf('Command "%s" already added', $name));
         }
 

src/Helper/Shell.php

@@ -157,8 +157,12 @@ protected function checkTimeout()
 
     // @codeCoverageIgnoreEnd
 
-    public function setOptions(string $cwd = null, array $env = null, float $timeout = null, array $otherOptions = []): self
-    {
+    public function setOptions(
+        string $cwd = null,
+        array $env = null,
+        float $timeout = null,
+        array $otherOptions = []
+    ): self {
         $this->cwd            = $cwd;
         $this->env            = $env;
         $this->processTimeout = $timeout;
@@ -176,7 +180,14 @@ public function execute(bool $async = false): self
         $this->descriptors      = $this->getDescriptors();
         $this->processStartTime = \microtime(true);
 
-        $this->process = \proc_open($this->command, $this->descriptors, $this->pipes, $this->cwd, $this->env, $this->otherOptions);
+        $this->process = \proc_open(
+            $this->command,
+            $this->descriptors,
+            $this->pipes,
+            $this->cwd,
+            $this->env,
+            $this->otherOptions
+        );
         $this->setInput();
 
         // @codeCoverageIgnoreStart

tests/Output/ColorTest.php

@@ -55,7 +55,10 @@ public function test_colors()
         $this->assertSame("\033[0;31mRed\033[0m", $c->colors('<red>Red</end>'));
         $this->assertSame("\033[1;31mBoldRed\n\033[0m", $c->colors('<boldRed>BoldRed<eol/></end>'));
         $this->assertSame("\033[0;36;42mBgGreenCyan\033[0m\n", $c->colors('<bgGreenCyan>BgGreenCyan</end><eol>'));
-        $this->assertSame("\033[0;31mRed\033[0m\nNormal\n\033[1;37mBOLD\033[0m", $c->colors("<red>Red</end>\r\nNormal\n<bold>BOLD</end>"));
+        $this->assertSame(
+            "\033[0;31mRed\033[0m\nNormal\n\033[1;37mBOLD\033[0m",
+            $c->colors("<red>Red</end>\r\nNormal\n<bold>BOLD</end>")
+        );
     }
 
     public function test_magic_call()

tests/Output/WriterTest.php

@@ -86,7 +86,10 @@ public function test_table()
         ]);
 
         $this->assertSame(3, \substr_count($this->buffer(), '+--------+------+------+'), '3 dashes');
-        $this->assertBufferContains("|\33[1;37;42m A      \33[0m|\33[1;37;42m B C  \33[0m|\33[1;37;42m C D  \33[0m|", 'Head');
+        $this->assertBufferContains(
+            "|\33[1;37;42m A      \33[0m|\33[1;37;42m B C  \33[0m|\33[1;37;42m C D  \33[0m|",
+            'Head'
+        );
         $this->assertBufferContains("|\33[0;35m apple  \33[0m|\33[0;35m ball \33[0m|\33[0;35m cat  \33[0m|", 'Odd');
         $this->assertBufferContains("|\33[0;36m applet \33[0m|\33[0;36m bee  \33[0m|\33[0;36m cute \33[0m|", 'Even');
     }