Testing a style-check, with style fixed (#2)

* Testing a style-check, with style fixed * adding grumphp, removing phpcs
diablomedia · Apr 23, 2018 · 5e9552d · 5e9552d
1 parent e25c966
commit 5e9552d
Show file tree

Hide file tree

Showing 40 changed files with 297 additions and 202 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 /vendor
 /composer.lock
-/clover.xml
+/clover.xml
+.php_cs.cache
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,22 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->files()
+    ->in(__DIR__)
+;
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR2' => true,
+        '@PHPUnit60Migration:risky' => true,
+        'binary_operator_spaces' => ['align_double_arrow' => true, 'align_equals' => true],
+        'single_quote' => true,
+        'array_syntax' => ['syntax' => 'long'],
+        'concat_space' => ['spacing' => 'one'],
+        'psr0' => true
+    ])
+    ->setUsingCache(true)
+    ->setFinder($finder);
+;
diff --git a/.travis.yml b/.travis.yml
@@ -23,6 +23,7 @@ install:
 
 stages:
   - test
+  - style check
   - phpstan analysis
   - test with coverage
 
@@ -37,6 +38,11 @@ jobs:
   allow_failures:
     - php: nightly
   include:
+    - stage: style check
+      php: 7.1
+      env: TMPDIR=/tmp USE_XDEBUG=false
+      script:
+        - composer style-check
     - stage: phpstan analysis
       php: 7.1
       env: TMPDIR=/tmp USE_XDEBUG=false

diff --git a/composer.json b/composer.json
@@ -39,7 +39,10 @@
     "require-dev": {
         "phpunit/phpunit": "^6.0",
         "phpstan/phpstan": "^0.9.2",
-        "jetbrains/phpstorm-stubs": "dev-phpstan"
+        "jetbrains/phpstorm-stubs": "dev-phpstan",
+        "friendsofphp/php-cs-fixer": "^2.11",
+        "maglnet/composer-require-checker": "^0.1.6 | ^0.2.1",
+        "phpro/grumphp": "^0.14.0"
     },
     "archive": {
         "exclude": ["/tests"]
@@ -49,8 +52,9 @@
     ],
     "scripts": {
         "test": "phpunit ./tests",
-        "test-with-coverage": "phpunit --coverage-clover=clover.xml ./tests",
-        "phpstan": "phpstan analyze -l7 -c phpstan.neon --no-progress ./src --ansi"
+        "test-with-coverage": "phpunit --coverage-clover=clover.xml",
+        "phpstan": "phpstan analyze -l7 -c phpstan.neon --no-progress ./ --ansi",
+        "style-check": "php-cs-fixer fix --dry-run -vv"
     },
     "suggest": {
         "diablomedia/zendframework1-log-writer-db": "Writer that uses Zend_Db",

diff --git a/grumphp.yml.dist b/grumphp.yml.dist
@@ -0,0 +1,17 @@
+# grumphp.yml
+parameters:
+    tasks:
+        composer:
+            strict: true
+        composer_require_checker:
+            config_file: require-checker-config.json
+        phpcsfixer2:
+            allow_risky: true
+            config: .php_cs
+        phpstan:
+            level: 7
+            configuration: phpstan.neon
+        phpunit:
+            metadata:
+                priority: 100
+            always_execute: true
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,4 +1,7 @@
 parameters:
+    excludes_analyse:
+        - %rootDir%/../../../tests/*
+        - %rootDir%/../../../vendor/*
     bootstrap: %rootDir%/../../../phpstan-bootstrap.php
     ignoreErrors:
         - '#Casting to string something that.s already string\.#'

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -6,6 +6,11 @@
     backupGlobals="true"
     stderr="true"
     colors="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
     <filter>
         <whitelist addUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">./src</directory>

diff --git a/require-checker-config.json b/require-checker-config.json
@@ -0,0 +1,9 @@
+{
+  "symbol-whitelist" : [
+    "null", "true", "false",
+    "static", "self", "parent",
+    "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object",
+    "DOMDocument", "DOMElement",
+    "zend_monitor_custom_event", "monitor_custom_event"
+  ]
+}
diff --git a/src/Zend/Log.php b/src/Zend/Log.php
@@ -39,14 +39,14 @@
  */
 class Zend_Log
 {
-    const EMERG   = 0;  // Emergency: system is unusable
-    const ALERT   = 1;  // Alert: action must be taken immediately
-    const CRIT    = 2;  // Critical: critical conditions
-    const ERR     = 3;  // Error: error conditions
-    const WARN    = 4;  // Warning: warning conditions
-    const NOTICE  = 5;  // Notice: normal but significant condition
-    const INFO    = 6;  // Informational: informational messages
-    const DEBUG   = 7;  // Debug: debug messages
+    const EMERG  = 0;  // Emergency: system is unusable
+    const ALERT  = 1;  // Alert: action must be taken immediately
+    const CRIT   = 2;  // Critical: critical conditions
+    const ERR    = 3;  // Error: error conditions
+    const WARN   = 4;  // Warning: warning conditions
+    const NOTICE = 5;  // Notice: normal but significant condition
+    const INFO   = 6;  // Informational: informational messages
+    const DEBUG  = 7;  // Debug: debug messages
 
     /**
      * @var array of priorities where the keys are the
@@ -91,7 +91,7 @@ class Zend_Log
      *
      * @var callable
      */
-    protected $_origErrorHandler       = null;
+    protected $_origErrorHandler = null;
 
     /**
      *
@@ -103,13 +103,13 @@ class Zend_Log
      *
      * @var array|boolean
      */
-    protected $_errorHandlerMap        = false;
+    protected $_errorHandlerMap = false;
 
     /**
      *
      * @var string
      */
-    protected $_timestampFormat        = 'c';
+    protected $_timestampFormat = 'c';
 
     /**
      * Class constructor.  Create a new logger
@@ -118,7 +118,7 @@ class Zend_Log
      */
     public function __construct(Zend_Log_Writer_Abstract $writer = null)
     {
-        $r = new ReflectionClass($this);
+        $r                 = new ReflectionClass($this);
         $this->_priorities = array_flip($r->getConstants());
 
         if ($writer !== null) {
@@ -134,7 +134,7 @@ public function __construct(Zend_Log_Writer_Abstract $writer = null)
      * @return Zend_Log
      * @throws Zend_Log_Exception
      */
-    static public function factory($config = array())
+    public static function factory($config = array())
     {
         if ($config instanceof Zend_Config) {
             $config = $config->toArray();
@@ -167,7 +167,7 @@ static public function factory($config = array())
         if (!is_array(current($config))) {
             $log->addWriter(current($config));
         } else {
-            foreach($config as $writer) {
+            foreach ($config as $writer) {
                 $log->addWriter($writer);
             }
         }
@@ -219,7 +219,7 @@ protected function _constructFilterFromConfig($config)
         $filter = $this->_constructFromConfig('filter', $config, $this->_defaultFilterNamespace);
 
         if (!$filter instanceof Zend_Log_Filter_Interface) {
-             $filterName = is_object($filter)
+            $filterName = is_object($filter)
                          ? get_class($filter)
                          : 'The specified filter';
             throw new Zend_Log_Exception("{$filterName} does not implement Zend_Log_Filter_Interface");
@@ -228,19 +228,19 @@ protected function _constructFilterFromConfig($config)
         return $filter;
     }
 
-   /**
-    * Construct formatter object from configuration array or Zend_Config object
-    *
-    * @param  array|Zend_Config $config Zend_Config or Array
-    * @return Zend_Log_Formatter_Interface
-    * @throws Zend_Log_Exception
-    */
+    /**
+     * Construct formatter object from configuration array or Zend_Config object
+     *
+     * @param  array|Zend_Config $config Zend_Config or Array
+     * @return Zend_Log_Formatter_Interface
+     * @throws Zend_Log_Exception
+     */
     protected function _constructFormatterFromConfig($config)
     {
         $formatter = $this->_constructFromConfig('formatter', $config, $this->_defaultFormatterNamespace);
 
         if (!$formatter instanceof Zend_Log_Formatter_Interface) {
-             $formatterName = is_object($formatter)
+            $formatterName = is_object($formatter)
                          ? get_class($formatter)
                          : 'The specified formatter';
             throw new Zend_Log_Exception($formatterName . ' does not implement Zend_Log_Formatter_Interface');
@@ -270,7 +270,7 @@ protected function _constructFromConfig($type, $config, $namespace)
             );
         }
 
-        $params    = isset($config[ $type .'Params' ]) ? $config[ $type .'Params' ] : array();
+        $params    = isset($config[ $type . 'Params' ]) ? $config[ $type . 'Params' ] : array();
         $className = $this->getClassName($config, $type, $namespace);
         if (!class_exists($className)) {
             Zend_Loader::loadClass($className);
@@ -330,7 +330,8 @@ protected function getClassName($config, $type, $defaultNamespace)
      */
     protected function _packEvent($message, $priority)
     {
-        return array_merge(array(
+        return array_merge(
+            array(
             'timestamp'    => date($this->_timestampFormat),
             'message'      => $message,
             'priority'     => $priority,
@@ -348,7 +349,7 @@ protected function _packEvent($message, $priority)
     public function __destruct()
     {
         /** @var Zend_Log_Writer_Abstract $writer */
-        foreach($this->_writers as $writer) {
+        foreach ($this->_writers as $writer) {
             $writer->shutdown();
         }
     }
@@ -373,7 +374,7 @@ public function __call($method, $params)
                     throw new Zend_Log_Exception('Missing log message');
                 case 1:
                     $message = array_shift($params);
-                    $extras = null;
+                    $extras  = null;
                     break;
                 default:
                     $message = array_shift($params);
@@ -479,11 +480,9 @@ public function addFilter($filter)
         if (is_int($filter)) {
             /** @see Zend_Log_Filter_Priority */
             $filter = new Zend_Log_Filter_Priority($filter);
-
         } elseif ($filter instanceof Zend_Config || is_array($filter)) {
             $filter = $this->_constructFilterFromConfig($filter);
-
-        } elseif(! $filter instanceof Zend_Log_Filter_Interface) {
+        } elseif (! $filter instanceof Zend_Log_Filter_Interface) {
             throw new Zend_Log_Exception('Invalid filter provided');
         }
 
@@ -600,7 +599,11 @@ public function errorHandler($errno, $errstr, $errfile, $errline, $errcontext)
             } else {
                 $priority = Zend_Log::INFO;
             }
-            $this->log($errstr, $priority, array('errno'=>$errno, 'file'=>$errfile, 'line'=>$errline, 'context'=>$errcontext));
+            $this->log(
+                $errstr,
+                $priority,
+                array('errno'=> $errno, 'file'=>$errfile, 'line'=>$errline, 'context'=>$errcontext)
+            );
         }
 
         if ($this->_origErrorHandler !== null) {

diff --git a/src/Zend/Log/Exception.php b/src/Zend/Log/Exception.php
@@ -27,4 +27,5 @@
  * @version    $Id$
  */
 class Zend_Log_Exception extends Zend_Exception
-{}
+{
+}
diff --git a/src/Zend/Log/FactoryInterface.php b/src/Zend/Log/FactoryInterface.php
@@ -34,5 +34,5 @@ interface Zend_Log_FactoryInterface
      * @param  array|Zend_Config $config
      * @return Zend_Log_FactoryInterface
      */
-    static public function factory($config);
+    public static function factory($config);
 }
diff --git a/src/Zend/Log/Filter/Abstract.php b/src/Zend/Log/Filter/Abstract.php
@@ -28,8 +28,7 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
-abstract class Zend_Log_Filter_Abstract
-    implements Zend_Log_Filter_Interface, Zend_Log_FactoryInterface
+abstract class Zend_Log_Filter_Abstract implements Zend_Log_Filter_Interface, Zend_Log_FactoryInterface
 {
     /**
      * Validate and optionally convert the config to array
@@ -38,7 +37,7 @@ abstract class Zend_Log_Filter_Abstract
      * @return array
      * @throws Zend_Log_Exception
      */
-    static protected function _parseConfig($config)
+    protected static function _parseConfig($config)
     {
         if ($config instanceof Zend_Config) {
             $config = $config->toArray();

diff --git a/src/Zend/Log/Filter/Message.php b/src/Zend/Log/Filter/Message.php
@@ -56,12 +56,15 @@ public function __construct($regexp)
      * @param  array|Zend_Config $config
      * @return Zend_Log_Filter_Message
      */
-    static public function factory($config)
+    public static function factory($config)
     {
         $config = self::_parseConfig($config);
-        $config = array_merge(array(
+        $config = array_merge(
+            array(
             'regexp' => null
-        ), $config);
+            ),
+            $config
+        );
 
         return new self(
             $config['regexp']

diff --git a/src/Zend/Log/Filter/Priority.php b/src/Zend/Log/Filter/Priority.php
@@ -65,13 +65,16 @@ public function __construct($priority, $operator = null)
      * @param  array|Zend_Config $config
      * @return Zend_Log_Filter_Priority
      */
-    static public function factory($config)
+    public static function factory($config)
     {
         $config = self::_parseConfig($config);
-        $config = array_merge(array(
+        $config = array_merge(
+            array(
             'priority' => null,
             'operator' => null,
-        ), $config);
+            ),
+            $config
+        );
 
         // Add support for constants
         if (!is_numeric($config['priority']) && isset($config['priority']) && defined($config['priority'])) {

diff --git a/src/Zend/Log/Filter/Suppress.php b/src/Zend/Log/Filter/Suppress.php
@@ -67,7 +67,7 @@ public function accept($event)
      * @return Zend_Log_Filter_Suppress
      * @throws Zend_Log_Exception
      */
-    static public function factory($config)
+    public static function factory($config)
     {
         return new self();
     }

diff --git a/src/Zend/Log/Formatter/Abstract.php b/src/Zend/Log/Formatter/Abstract.php
@@ -28,7 +28,6 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
-abstract class Zend_Log_Formatter_Abstract
-    implements Zend_Log_Formatter_Interface, Zend_Log_FactoryInterface
+abstract class Zend_Log_Formatter_Abstract implements Zend_Log_Formatter_Interface, Zend_Log_FactoryInterface
 {
 }