Merge pull request #485 from thephpleague/feature/phpcs-circleci

Add phpcs and circleci configurations and run phpcs check on PRs

Author: matthewtrask

.circleci/config.yml

@@ -0,0 +1,42 @@
+# PHP CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-php/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # Specify the version you desire here
+      - image: circleci/php:7.2
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # Using the RAM variation mitigates I/O contention
+      # for database intensive operations.
+      # - image: circleci/mysql:5.7-ram
+      #
+      # - image: redis:2.8.19
+
+    steps:
+      - checkout
+
+      - run: sudo apt update # PHP CircleCI 2.0 Configuration File# PHP CircleCI 2.0 Configuration File sudo apt install zlib1g-dev libsqlite3-dev
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            # "composer.lock" can be used if it is committed to the repo
+            - v1-dependencies-{{ checksum "composer.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run: composer install -n --prefer-dist
+
+      - save_cache:
+          key: v1-dependencies-{{ checksum "composer.json" }}
+          paths:
+            - ./vendor
+
+      # Check code style
+      - run: ./vendor/bin/phpcs src

.gitignore

@@ -1,3 +1,4 @@
+.idea
 .ruby-version
 composer.lock
 build

composer.json

@@ -29,7 +29,7 @@
         "mockery/mockery": "~0.9",
         "pagerfanta/pagerfanta": "~1.0.0",
         "phpunit/phpunit": "^4.8.35 || ^7.5",
-        "squizlabs/php_codesniffer": "~1.5",
+        "squizlabs/php_codesniffer": "~1.5|~2.0|~3.4",
         "zendframework/zend-paginator": "~2.3"
     },
     "suggest": {

phpcs.xml.dist

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="fractal">
+    <description>Fractal Coding Standards</description>
+    <arg value="p" />
+
+    <config name="ignore_warnings_on_exit" value="1" />
+    <config name="ignore_errors_on_exit" value="1" />
+
+    <arg name="colors" />
+    <arg value="s" />
+
+    <!-- Use the PSR2 Standard-->
+    <rule ref="PSR2" />
+</ruleset>

src/Manager.php

@@ -223,7 +223,7 @@ public function parseIncludes($includes)
     /**
      * Parse field parameter.
      *
-     * @param array $fieldsets Array of fields to include. It must be an array whose keys 
+     * @param array $fieldsets Array of fields to include. It must be an array whose keys
      *                         are resource types and values an array or a string
      *                         of the fields to return, separated by a comma
      *

src/Pagination/PhalconFrameworkPaginatorAdapter.php

@@ -93,7 +93,7 @@ public function getPerPage()
      * Get the next.
      *
      * @return int
-     */ 
+     */
     public function getNext()
     {
         return $this->paginator->next;

src/Serializer/JsonApiSerializer.php

@@ -72,25 +72,25 @@ public function item($resourceKey, array $data)
 
         unset($resource['data']['attributes']['id']);
 
-        if(isset($resource['data']['attributes']['links'])) {
+        if (isset($resource['data']['attributes']['links'])) {
             $custom_links = $data['links'];
             unset($resource['data']['attributes']['links']);
         }
 
-        if (isset($resource['data']['attributes']['meta'])){
+        if (isset($resource['data']['attributes']['meta'])) {
             $resource['data']['meta'] = $data['meta'];
             unset($resource['data']['attributes']['meta']);
         }
 
-        if(empty($resource['data']['attributes'])) {
+        if (empty($resource['data']['attributes'])) {
             $resource['data']['attributes'] = (object) [];
         }
 
         if ($this->shouldIncludeLinks()) {
             $resource['data']['links'] = [
                 'self' => "{$this->baseUrl}/$resourceKey/$id",
             ];
-            if(isset($custom_links)) {
+            if (isset($custom_links)) {
                 $resource['data']['links'] = array_merge($resource['data']['links'], $custom_links);
             }
         }

src/Serializer/Serializer.php

@@ -99,4 +99,4 @@ public function injectData($data, $rawIncludedData);
      * @return array
      */
     public function filterIncludes($includedData, $data);
-}
+}