Switched to phpcs

Had issues running CS sniffs under `--prefer-lowest`, so switched to phpcs.
Which helped uncover a ton of CS issues, including underscore-prefixed
properties and methods (most were updated, though the methods defined in the
abstract protocol class were left due to the fact that they are an extension
point).

Author: weierophinney

.php_cs

@@ -57,7 +57,7 @@ install:
 script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/phpunit --coverage-clover clover.xml ; fi
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then ./vendor/bin/phpunit ; fi
-  - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/php-cs-fixer fix -v --diff --dry-run ; fi
+  - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/phpcs ; fi
 
 after_script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/coveralls ; fi

.travis.yml

@@ -23,7 +23,7 @@
         "zendframework/zend-config": "^2.6",
         "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3",
         "zendframework/zend-crypt": "^2.6",
-        "fabpot/php-cs-fixer": "1.7.*",
+        "squizlabs/php_codesniffer": "^2.3.1",
         "phpunit/phpunit": "^4.8"
     },
     "suggest": {

composer.json

@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<ruleset name="Zend Framework coding standard">
+    <description>Zend Framework coding standard</description>
+
+    <!-- display progress -->
+    <arg value="p"/>
+    <arg name="colors"/>
+
+    <!-- inherit rules from: -->
+    <rule ref="PSR2"/>
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
+        <properties>
+            <property name="ignoreBlankLines" value="false"/>
+        </properties>
+    </rule>
+
+    <!-- Paths to check -->
+    <file>src</file>
+    <file>test</file>
+    <exclude-pattern>test/_files/*</exclude-pattern>
+</ruleset>

phpcs.xml

@@ -44,9 +44,9 @@ public static function fromString($headerLine)
         list($fieldName, $fieldValue) = GenericHeader::splitHeaderLine($headerLine);
         if (strtolower($fieldName) !== static::$type) {
             throw new Exception\InvalidArgumentException(sprintf(
-                    'Invalid header line for "%s" string',
-                    __CLASS__
-                ));
+                'Invalid header line for "%s" string',
+                __CLASS__
+            ));
         }
 
         // split value on ","

src/Header/AbstractAddressList.php

@@ -49,7 +49,11 @@ public static function fromString($headerLine)
          * 'name' and 'email' capture groups correspond respectively to 'display-name' and 'addr-spec' in the ABNF
          * @see https://tools.ietf.org/html/rfc5322#section-3.4
          */
-        $hasMatches = preg_match('/^(?:(?P<name>.+)\s)?(?(name)<|<?)(?P<email>[^\s]+?)(?(name)>|>?)$/', $value, $matches);
+        $hasMatches = preg_match(
+            '/^(?:(?P<name>.+)\s)?(?(name)<|<?)(?P<email>[^\s]+?)(?(name)>|>?)$/',
+            $value,
+            $matches
+        );
 
         if ($hasMatches !== 1) {
             throw new Exception\InvalidArgumentException('Invalid header value for Sender string');

src/Header/Sender.php

@@ -12,7 +12,8 @@
 use Zend\Validator;
 
 /**
- * Provides low-level methods for concrete adapters to communicate with a remote mail server and track requests and responses.
+ * Provides low-level methods for concrete adapters to communicate with a
+ * remote mail server and track requests and responses.
  *
  * @todo Implement proxy settings
  */
@@ -128,7 +129,8 @@ public function getMaximumLog()
     /**
      * Create a connection to the remote host
      *
-     * Concrete adapters for this class will implement their own unique connect scripts, using the _connect() method to create the socket resource.
+     * Concrete adapters for this class will implement their own unique connect
+     * scripts, using the _connect() method to create the socket resource.
      */
     abstract public function connect();
 
@@ -171,20 +173,23 @@ public function resetLog()
         $this->log = [];
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * Add the transaction log
      *
      * @param  string $value new transaction
      */
     protected function _addLog($value)
     {
+        // @codingStandardsIgnoreEnd
         if ($this->maximumLog >= 0 && count($this->log) >= $this->maximumLog) {
             array_shift($this->log);
         }
 
         $this->log[] = $value;
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * Connect to the server using the supplied transport and target
      *
@@ -196,6 +201,7 @@ protected function _addLog($value)
      */
     protected function _connect($remote)
     {
+        // @codingStandardsIgnoreEnd
         $errorNum = 0;
         $errorStr = '';
 
@@ -216,17 +222,20 @@ protected function _connect($remote)
         return $result;
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * Disconnect from remote host and free resource
      *
      */
     protected function _disconnect()
     {
+        // @codingStandardsIgnoreEnd
         if (is_resource($this->socket)) {
             fclose($this->socket);
         }
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * Send the given request followed by a LINEEND to the server.
      *
@@ -236,6 +245,7 @@ protected function _disconnect()
      */
     protected function _send($request)
     {
+        // @codingStandardsIgnoreEnd
         if (!is_resource($this->socket)) {
             throw new Exception\RuntimeException('No connection has been established to ' . $this->host);
         }
@@ -254,6 +264,7 @@ protected function _send($request)
         return $result;
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * Get a line from the stream.
      *
@@ -263,6 +274,7 @@ protected function _send($request)
      */
     protected function _receive($timeout = null)
     {
+        // @codingStandardsIgnoreEnd
         if (!is_resource($this->socket)) {
             throw new Exception\RuntimeException('No connection has been established to ' . $this->host);
         }
@@ -292,6 +304,7 @@ protected function _receive($timeout = null)
         return $response;
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * Parse server response for successful codes
      *
@@ -305,6 +318,7 @@ protected function _receive($timeout = null)
      */
     protected function _expect($code, $timeout = null)
     {
+        // @codingStandardsIgnoreEnd
         $this->response = [];
         $errMsg = '';
 
@@ -321,7 +335,9 @@ protected function _expect($code, $timeout = null)
             } elseif ($cmd === null || !in_array($cmd, $code)) {
                 $errMsg =  $msg;
             }
-        } while (strpos($more, '-') === 0); // The '-' message prefix indicates an information string instead of a response string.
+
+        // The '-' message prefix indicates an information string instead of a response string.
+        } while (strpos($more, '-') === 0);
 
         if ($errMsg !== '') {
             throw new Exception\RuntimeException($errMsg);

src/Protocol/AbstractProtocol.php

@@ -96,7 +96,7 @@ public function connect($host, $port = null, $ssl = false)
             ), 0, $error);
         }
 
-        if (!$this->_assumedNextLine('* OK')) {
+        if (!$this->assumedNextLine('* OK')) {
             throw new Exception\RuntimeException('host doesn\'t allow connection');
         }
 
@@ -115,7 +115,7 @@ public function connect($host, $port = null, $ssl = false)
      * @throws Exception\RuntimeException
      * @return string next line
      */
-    protected function _nextLine()
+    protected function nextLine()
     {
         $line = fgets($this->socket);
         if ($line === false) {
@@ -132,9 +132,9 @@ protected function _nextLine()
      * @param  string $start the first bytes we assume to be in the next line
      * @return bool line starts with $start
      */
-    protected function _assumedNextLine($start)
+    protected function assumedNextLine($start)
     {
-        $line = $this->_nextLine();
+        $line = $this->nextLine();
         return strpos($line, $start) === 0;
     }
 
@@ -144,9 +144,9 @@ protected function _assumedNextLine($start)
      * @param  string $tag tag of line is returned by reference
      * @return string next line
      */
-    protected function _nextTaggedLine(&$tag)
+    protected function nextTaggedLine(&$tag)
     {
-        $line = $this->_nextLine();
+        $line = $this->nextLine();
 
         // separate tag from line
         list($tag, $line) = explode(' ', $line, 2);
@@ -160,7 +160,7 @@ protected function _nextTaggedLine(&$tag)
      * @param  string $line line to decode
      * @return array tokens, literals are returned as string, lists as array
      */
-    protected function _decodeLine($line)
+    protected function decodeLine($line)
     {
         $tokens = [];
         $stack = [];
@@ -201,14 +201,14 @@ protected function _decodeLine($line)
                 if (is_numeric($chars)) {
                     $token = '';
                     while (strlen($token) < $chars) {
-                        $token .= $this->_nextLine();
+                        $token .= $this->nextLine();
                     }
                     $line = '';
                     if (strlen($token) > $chars) {
                         $line = substr($token, $chars);
                         $token = substr($token, 0, $chars);
                     } else {
-                        $line .= $this->_nextLine();
+                        $line .= $this->nextLine();
                     }
                     $tokens[] = $token;
                     $line = trim($line) . ' ';
@@ -262,9 +262,9 @@ protected function _decodeLine($line)
     public function readLine(&$tokens = [], $wantedTag = '*', $dontParse = false)
     {
         $tag  = null;                         // define $tag variable before first use
-        $line = $this->_nextTaggedLine($tag); // get next tag
+        $line = $this->nextTaggedLine($tag); // get next tag
         if (!$dontParse) {
-            $tokens = $this->_decodeLine($line);
+            $tokens = $this->decodeLine($line);
         } else {
             $tokens = $line;
         }
@@ -324,7 +324,7 @@ public function sendRequest($command, $tokens = [], &$tag = null)
                 if (fwrite($this->socket, $line . ' ' . $token[0] . "\r\n") === false) {
                     throw new Exception\RuntimeException('cannot write - connection closed?');
                 }
-                if (!$this->_assumedNextLine('+ ')) {
+                if (!$this->assumedNextLine('+ ')) {
                     throw new Exception\RuntimeException('cannot send literal string');
                 }
                 $line = $token[1];