Add code style check into CI pipeline

.circleci/config.yml

@@ -0,0 +1,85 @@
+unit-config: &unit-config
+  environment:
+    COMPOSER_PREFER_LOWEST: 0
+  steps:
+    - checkout
+
+    - run:
+        name: Install latest composer
+        command: |
+          php -r "copy('https://raw.githubusercontent.com/composer/getcomposer.org/master/web/installer', 'composer-setup.php');"
+          php composer-setup.php
+          php -r "unlink('composer-setup.php');"
+          mv composer.phar /usr/local/bin/composer
+
+    - run:
+        name: Write COMPOSER_PREFER_LOWEST to file
+        command: echo "$COMPOSER_PREFER_LOWEST" > ~/COMPOSER_PREFER_LOWEST.txt
+
+    # Download and cache dependencies
+    - restore_cache:
+        keys:
+        - v1-composer-cache-{{ checksum "~/COMPOSER_PREFER_LOWEST.txt" }}-{{ checksum "composer.json" }}
+        # Fall back to using the latest cache if no exact match is found.
+        - v1-composer-cache-{{ checksum "~/COMPOSER_PREFER_LOWEST.txt" }}
+
+    - run:
+        name: Validate composer files
+        command: composer validate --strict
+
+    - run:
+        name: Install PHP extensions
+        command: |
+            printf '\n' | sudo pecl install redis
+            sudo docker-php-ext-enable redis
+
+    - run:
+        name: Install composer packages
+        command: |
+          if [ $COMPOSER_PREFER_LOWEST -eq "1" ]; then
+            composer update --no-ansi --no-progress --optimize-autoloader --no-interaction --no-plugins --no-scripts --prefer-dist --prefer-stable --prefer-lowest
+          else
+            composer update --no-ansi --no-progress --optimize-autoloader --no-interaction --no-plugins --no-scripts --prefer-dist --prefer-stable
+          fi
+
+    - save_cache:
+        key: v1-composer-cache-{{ checksum "~/COMPOSER_PREFER_LOWEST.txt" }}-{{ checksum "composer.json" }}
+        paths:
+          - ./vendor
+
+    - run:
+        name: Wait for backing services to start
+        command: dockerize -wait tcp://127.0.0.1:6379 -timeout 30s
+
+    - run:
+        name: Run PHP Code Sniffer
+        command: ./vendor/bin/phpcs
+
+    - run:
+        name: Run tests
+        command: ./vendor/bin/phpunit
+
+version: 2.1
+jobs:
+  php73:
+    <<: *unit-config
+    docker:
+      - image: circleci/php:7.3-cli-node
+      - image: circleci/redis:5-alpine
+    environment:
+      COMPOSER_PREFER_LOWEST: 0
+
+  php73-lowest:
+    <<: *unit-config
+    docker:
+      - image: circleci/php:7.3-cli-node
+      - image: circleci/redis:5-alpine
+    environment:
+      COMPOSER_PREFER_LOWEST: 1
+
+workflows:
+  version: 2
+  units:
+    jobs:
+      - php73
+      - php73-lowest

.gitattributes

@@ -0,0 +1,12 @@
+* text=auto
+/.circleci/         export-ignore
+/.github/           export-ignore
+/examples/          export-ignore
+/nginx/             export-ignore
+/php-fpm/           export-ignore
+/tests/             export-ignore
+.gitattributes      export-ignore
+.gitignore          export-ignore
+docker-compose.yml  export-ignore
+phpcs.xml.dist      export-ignore
+phpunit.xml.dist    export-ignore

composer.json

@@ -1,6 +1,8 @@
 {
     "name": "endclothing/prometheus_client_php",
-    "version": "1.0.1",
+    "description": "Prometheus instrumentation library for PHP applications.",
+    "type": "library",
+    "license": "Apache-2.0",
     "authors": [
         {
             "name": "Daniel Noel-Davies",
@@ -17,7 +19,8 @@
         "symfony/polyfill-apcu": "^1.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5"
+        "phpunit/phpunit": "^7.5",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "suggest": {
         "ext-redis": "Required if using Redis.",
@@ -33,5 +36,13 @@
             "Test\\Prometheus\\": "tests/"
         }
     },
-    "license": "Apache-2.0"
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "prefer-stable": true
 }

examples/flush_adapter.php

@@ -14,4 +14,4 @@
 } elseif ($adapter === 'in-memory') {
     $inMemoryAdapter = new Prometheus\Storage\InMemory();
     $inMemoryAdapter->flushMemory();
-}
+}

examples/pushgateway.php

@@ -22,4 +22,4 @@
 $counter->incBy(6, ['blue']);
 
 $pushGateway = new PushGateway('192.168.59.100:9091');
-$pushGateway->push($registry, 'my_job', ['instance'=>'foo']);
+$pushGateway->push($registry, 'my_job', ['instance' => 'foo']);

examples/some_gauge.php

@@ -6,7 +6,7 @@
 use Prometheus\Storage\Redis;
 
 
-error_log('c='. $_GET['c']);
+error_log('c=' . $_GET['c']);
 
 $adapter = $_GET['adapter'];
 

examples/some_histogram.php

@@ -5,7 +5,7 @@
 use Prometheus\CollectorRegistry;
 use Prometheus\Storage\Redis;
 
-error_log('c='. $_GET['c']);
+error_log('c=' . $_GET['c']);
 
 $adapter = $_GET['adapter'];
 

phpcs.xml.dist

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+    <description>KASKO Coding standard.</description>
+
+    <file>src/</file>
+    <file>tests/</file>
+    <file>examples/</file>
+
+    <exclude-pattern type="relative">vendor/*</exclude-pattern>
+
+    <arg value="nps"/>
+
+    <rule ref="PSR12"/>
+</ruleset>

phpunit.xml → phpunit.xml.dist

@@ -7,15 +7,18 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
+         stopOnError="false"
          stopOnFailure="false">
-<testsuites>
-    <testsuite name="Unit">
-        <directory>./tests/Test/Prometheus</directory>
-    </testsuite>
-</testsuites>
-<filter>
-    <whitelist processUncoveredFilesFromWhitelist="true">
-        <directory suffix=".php">./src/Prometheus</directory>
-    </whitelist>
-</filter>
+
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>./tests/Test/Prometheus</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src/Prometheus</directory>
+        </whitelist>
+    </filter>
 </phpunit>

src/Prometheus/Collector.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus;
@@ -57,7 +58,7 @@ public function __construct(Adapter $storageAdapter, $namespace, $name, $help, $
     /**
      * @return string
      */
-    public abstract function getType();
+    abstract public function getType();
 
     /**
      * @return string

src/Prometheus/CollectorRegistry.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus;

src/Prometheus/Counter.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 

src/Prometheus/Gauge.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 

src/Prometheus/Histogram.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus;

src/Prometheus/MetricFamilySamples.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 

src/Prometheus/PushGateway.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 

src/Prometheus/RenderTextFormat.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 
@@ -13,7 +14,7 @@ class RenderTextFormat
      */
     public function render(array $metrics): string
     {
-        usort( $metrics, function (MetricFamilySamples $a, MetricFamilySamples $b) {
+        usort($metrics, function (MetricFamilySamples $a, MetricFamilySamples $b) {
             return strcmp($a->getName(), $b->getName());
         });
 

src/Prometheus/Sample.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 

src/Prometheus/Storage/APC.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus\Storage;
@@ -284,7 +285,6 @@ private function collectHistograms(): array
                     'labelValues' => $decodedLabelValues,
                     'value' => $this->fromInteger($histogramBuckets[$labelValues]['sum']),
                 ];
-
             }
             $histograms[] = new MetricFamilySamples($data);
         }

src/Prometheus/Storage/Adapter.php

@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus\Storage;
 

src/Prometheus/Storage/InMemory.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus\Storage;
@@ -100,7 +101,6 @@ private function collectHistograms(): array
                     'labelValues' => $decodedLabelValues,
                     'value' => $histogramBuckets[$labelValues]['sum'],
                 ];
-
             }
             $histograms[] = new MetricFamilySamples($data);
         }

src/Prometheus/Storage/Redis.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus\Storage;

tests/Test/BlackBoxPushGatewayTest.php

@@ -1,9 +1,9 @@
 <?php
+
 namespace Test;
 
 use GuzzleHttp\Client;
 use PHPUnit\Framework\TestCase;
-
 use Prometheus\CollectorRegistry;
 use Prometheus\PushGateway;
 use Prometheus\Storage\APC;

tests/Test/BlackBoxTest.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Test;
 
 use GuzzleHttp\Client;

tests/Test/Prometheus/APC/HistogramTest.php

@@ -17,4 +17,3 @@ public function configureAdapter()
         $this->adapter->flushAPC();
     }
 }
-

tests/Test/Prometheus/AbstractCollectorRegistryTest.php

@@ -1,9 +1,7 @@
 <?php
 
-
 namespace Test\Prometheus;
 
-
 use PHPUnit\Framework\TestCase;
 use Prometheus\CollectorRegistry;
 use Prometheus\Histogram;
@@ -317,5 +315,5 @@ public function itShouldNotRegisterAHistogramTwice()
     }
 
 
-    public abstract function configureAdapter();
+    abstract public function configureAdapter();
 }