Merge pull request googleapis#604 from localheinz/feature/phpcs

Enhancement: Run phpcs on Travis

Author: tbetbetbe

.travis.yml

@@ -14,14 +14,17 @@ cache:
   directories:
     - $HOME/.composer/cache
 
-php:
-  # Can't test against 5.2; openssl is not available:
-  # http://docs.travis-ci.com/user/languages/php/#PHP-installation
-  - 5.3
-  - 5.4
-  - 5.5
-  - 5.6
-  - hhvm
+matrix:
+  fast_finish: true
+  include:
+    # Can't test against 5.2; openssl is not available:
+    # http://docs.travis-ci.com/user/languages/php/#PHP-installation
+    - php: 5.3
+    - php: 5.4
+    - php: 5.5
+    - php: 5.6
+      env: PHPCS=true
+    - php: hhvm
 
 install:
   - composer install
@@ -34,3 +37,4 @@ before_script:
 
 script:
   - vendor/bin/phpunit
+  - if [[ "$PHPCS" == "true" ]]; then vendor/bin/phpcs src --standard=style/ruleset.xml -np; fi

README.md

@@ -84,18 +84,22 @@ $opt_params = array(
 
 The library strips out nulls from the objects sent to the Google APIs as its the default value of all of the uninitialised properties. To work around this, set the field you want to null to Google_Model::NULL_VALUE. This is a placeholder that will be replaced with a true null when sent over the wire.
 
-## Notes For Distributors ##
-
-To avoid clashes with the autoloader, its best to update the function inside autoload.php to `google_api_php_client_autoload_MyProject`.
-
 ## Code Quality ##
 
 Run the PHPUnit tests with PHPUnit. You can configure an API key and token in BaseTest.php to run all calls, but this will require some setup on the Google Developer Console.
 
     phpunit tests/
 
-Copy the ruleset.xml in style/ into a new directory named GAPI/ in your
-/usr/share/php/PHP/CodeSniffer/Standards (or appropriate equivalent directory),
-and run code sniffs with:
+### Coding Style
+
+To check for coding style violations, run
 
-        phpcs --standard=GAPI src/
+```
+vendor/bin/phpcs src --standard=style/ruleset.xml -np 
+```
+
+To automatically fix (fixable) coding style violations, run  
+
+```
+vendor/bin/phpcbf src --standard=style/ruleset.xml
+```

composer.json

@@ -9,7 +9,8 @@
         "php": ">=5.2.1"
     },
     "require-dev": {
-      "phpunit/phpunit": "3.7.*"
+        "phpunit/phpunit": "3.7.*",
+        "squizlabs/php_codesniffer": "~2.3"
     },
     "autoload": {
         "classmap": [

src/Google/Auth/OAuth2.php

@@ -95,7 +95,7 @@ public function authenticate($code, $crossClient = false)
           'client_secret' => $this->client->getClassConfig($this, 'client_secret')
     );
 
-    if($crossClient !== true) {
+    if ($crossClient !== true) {
         $arguments['redirect_uri'] = $this->client->getClassConfig($this, 'redirect_uri');
     }
 

src/Google/Client.php

@@ -129,10 +129,10 @@ public function authenticate($code, $crossClient = false)
   }
 
   /**
-   * Loads a service account key and parameters from a JSON 
+   * Loads a service account key and parameters from a JSON
    * file from the Google Developer Console. Uses that and the
-   * given array of scopes to return an assertion credential for 
-   * use with refreshTokenWithAssertionCredential. 
+   * given array of scopes to return an assertion credential for
+   * use with refreshTokenWithAssertionCredential.
    *
    * @param string $jsonLocation File location of the project-key.json.
    * @param array $scopes The scopes to assert.

src/Google/Collection.php

@@ -56,7 +56,7 @@ public function count()
     return count($this->modelData[$this->collection_key]);
   }
 
-  public function offsetExists ($offset)
+  public function offsetExists($offset)
   {
     if (!is_numeric($offset)) {
       return parent::offsetExists($offset);

src/Google/Config.php

@@ -380,8 +380,8 @@ public function setDeveloperKey($key)
   /**
    * Set the hd (hosted domain) parameter streamlines the login process for
    * Google Apps hosted accounts. By including the domain of the user, you
-   * restrict sign-in to accounts at that domain. 
-   * 
+   * restrict sign-in to accounts at that domain.
+   *
    * This should not be used to ensure security on your application - check
    * the hd values within an id token (@see Google_Auth_LoginTicket) after sign
    * in to ensure that the user is from the domain you were expecting.

src/Google/Http/MediaFileUpload.php

@@ -287,7 +287,7 @@ private function getResumeUri()
     }
     $message = $code;
     $body = @json_decode($response->getResponseBody());
-    if (!empty( $body->error->errors ) ) {
+    if (!empty($body->error->errors) ) {
       $message .= ': ';
       foreach ($body->error->errors as $error) {
         $message .= "{$error->domain}, {$error->message};";

src/Google/Http/Request.php

@@ -130,7 +130,7 @@ public function getQueryParams()
     return $this->queryParams;
   }
 
-  /** 
+  /**
    * Set a new query parameter.
    * @param $key - string to set, does not need to be URL encoded
    * @param $value - string to set, does not need to be URL encoded
@@ -441,7 +441,7 @@ public function toBatchString($id)
 
   /**
    * Our own version of parse_str that allows for multiple variables
-   * with the same name. 
+   * with the same name.
    * @param $string - the query string to parse
    */
   private function parseQuery($string)
@@ -465,7 +465,7 @@ private function parseQuery($string)
 
   /**
    * A version of build query that allows for multiple
-   * duplicate keys. 
+   * duplicate keys.
    * @param $parts array of key value pairs
    */
   private function buildQuery($parts)
@@ -483,7 +483,7 @@ private function buildQuery($parts)
     return implode('&', $return);
   }
 
-  /** 
+  /**
    * If we're POSTing and have no body to send, we can send the query
    * parameters in there, which avoids length issues with longer query
    * params.

src/Google/Model.php

@@ -25,7 +25,7 @@ class Google_Model implements ArrayAccess
 {
   /**
    * If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE
-   * instead - it will be replaced when converting to JSON with a real null. 
+   * instead - it will be replaced when converting to JSON with a real null.
    */
   const NULL_VALUE = "{}gapi-php-null";
   protected $internal_gapi_mappings = array();