Update PHP_CodeSniffer (#328)

* Add lint

* update travis

* coding style

* add coverage to gitignore

* removed ignore lines

* nit

Author: dplewis

.gitignore

@@ -8,3 +8,7 @@ logs
 
 # ignore test results
 phpunit-test-results
+
+*.log
+
+coverage.xml

.travis.yml

@@ -9,14 +9,15 @@ php:
 #  - nightly
 before_install:
   - nvm install 6.11
-install: 
+install:
   - composer install
   - npm install
 before_script:
   - npm start 1>&2
   - sleep 3
+  - npm run lint
 script:
-    - ./vendor/bin/phpunit --coverage-clover=coverage.xml
+    - npm run test:coverage
 
 after_success:
     - bash <(curl -s https://codecov.io/bash)

CONTRIBUTING.md

@@ -27,7 +27,7 @@ To setup the Test Parse Server:
 * Run `npm install` from the project root to download the server and it's dependencies.
 * When you're ready to run tests use `npm start` from the project root to boot up the test server.
 
-The embedded test server utilizes this [parse server test] project. 
+The embedded test server utilizes this [parse server test] project.
 It's setup with the appropriate configuration to run the php sdk test suite.
 Additionally it handles setting up mongodb for the server.
 
@@ -65,6 +65,18 @@ You should now be able to execute the tests, from project root folder:
 
     ./vendor/bin/phpunit
 
+You may also run tests directly using phpunit as follows:
+
+    npm test
+
+Make sure your code is linted with phpcs ([PSR-2 Coding Style]):
+
+    npm run lint
+
+You can automatically fix lint errors with phpcbf:
+
+    npm run lint:fix
+
 The test suite is setup for code coverage if you have [XDebug] installed and setup.
 Coverage is outputted as text and as html in the phpunit-test-results/ directory within the project root.
 
@@ -79,3 +91,5 @@ If you have XDebug setup and can view code coverage please ensure that you do yo
 [XDebug]: https://xdebug.org/
 [parse server test]: https://github.com/montymxb/parse-server-test
 [Setup a local Parse Server instance]: https://github.com/parse-community/parse-server#user-content-locally
+[PSR-2 Coding Style]: http://www.php-fig.org/psr/psr-2/
+

composer.json

@@ -18,7 +18,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "~4.0",
-        "squizlabs/php_codesniffer": "~1.5",
+        "squizlabs/php_codesniffer": "^3.0.1",
         "phpdocumentor/phpdocumentor": "~2.5"
     },
     "autoload": {

package.json

@@ -1,7 +1,10 @@
 {
   "name": "parse-php-sdk",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "./vendor/bin/phpunit",
+    "test:coverage": "./vendor/bin/phpunit --coverage-clover=coverage.xml",
+    "lint": "./vendor/bin/phpcs --standard=./phpcs.xml.dist ./src/Parse ./tests/Parse",
+    "lint:fix": "./vendor/bin/phpcbf --standard=./phpcs.xml.dist ./src/Parse ./tests/Parse",
     "start" : "./node_modules/parse-server-test/run-server",
     "stop"  : "./node_modules/parse-server-test/stop-server"
   },

phpcs.xml.dist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="phpcsignore">
+ <description>PHPCS Ignore Rule</description>
+ <rule ref="PSR2" />
+ <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
+   <severity>0</severity>
+ </rule>
+ <rule ref="PSR2.Methods.MethodDeclaration">
+  <severity>0</severity>
+ </rule>
+ <rule ref="PSR2.Classes.PropertyDeclaration.Underscore">
+  <severity>0</severity>
+ </rule>
+</ruleset>

src/Parse/HttpClients/ParseCurl.php

@@ -7,7 +7,6 @@
 
 namespace Parse\HttpClients;
 
-
 use Parse\ParseException;
 
 /**
@@ -27,11 +26,9 @@ class ParseCurl
      */
     public function init()
     {
-        if($this->curl === null) {
+        if ($this->curl === null) {
             $this->curl = curl_init();
-
         }
-
     }
 
     /**
@@ -42,9 +39,8 @@ public function init()
      */
     public function exec()
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         return curl_exec($this->curl);
@@ -59,13 +55,11 @@ public function exec()
      */
     public function setOption($option, $value)
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         curl_setopt($this->curl, $option, $value);
-
     }
 
     /**
@@ -76,13 +70,11 @@ public function setOption($option, $value)
      */
     public function setOptionsArray($options)
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         curl_setopt_array($this->curl, $options);
-
     }
 
     /**
@@ -94,13 +86,11 @@ public function setOptionsArray($options)
      */
     public function getInfo($info)
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         return curl_getinfo($this->curl, $info);
-
     }
 
     /**
@@ -111,13 +101,11 @@ public function getInfo($info)
      */
     public function getError()
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         return curl_error($this->curl);
-
     }
 
     /**
@@ -128,31 +116,26 @@ public function getError()
      */
     public function getErrorCode()
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         return curl_errno($this->curl);
-
     }
 
     /**
      * Closed our curl handle and disposes of it
      */
     public function close()
     {
-        if(!isset($this->curl)) {
+        if (!isset($this->curl)) {
             throw new ParseException('You must call ParseCurl::init first');
-
         }
 
         // close our handle
         curl_close($this->curl);
 
         // unset our curl handle
         $this->curl = null;
-
     }
-
-}
+}