Add code style check into CI pipeline (#21)

martinssipenko · NoelDavies · commit f4c614c1fdb8 · 2019-11-29T11:30:44.000Z
Added CI using CircleCI
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -51,6 +51,10 @@ unit-config: &unit-config
         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
diff --git a/composer.json b/composer.json
@@ -15,11 +15,12 @@
     "require": {
         "php": "^7.3",
         "ext-json": "*",
-        "guzzlehttp/guzzle": "^6.2",
+        "guzzlehttp/guzzle": "^6.3",
         "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.",
diff --git a/examples/flush_adapter.php b/examples/flush_adapter.php
@@ -14,4 +14,4 @@
 } elseif ($adapter === 'in-memory') {
     $inMemoryAdapter = new Prometheus\Storage\InMemory();
     $inMemoryAdapter->flushMemory();
-}
+}
diff --git a/examples/pushgateway.php b/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']);
diff --git a/examples/some_gauge.php b/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'];
 
diff --git a/examples/some_histogram.php b/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'];
 
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+    <file>src/</file>
+    <file>tests/</file>
+    <file>examples/</file>
+
+    <exclude-pattern type="relative">vendor/*</exclude-pattern>
+
+    <arg value="nps"/>
+
+    <rule ref="PSR12"/>
+</ruleset>
diff --git a/src/Prometheus/Collector.php b/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
diff --git a/src/Prometheus/CollectorRegistry.php b/src/Prometheus/CollectorRegistry.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus;
diff --git a/src/Prometheus/Counter.php b/src/Prometheus/Counter.php
@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 
diff --git a/src/Prometheus/Gauge.php b/src/Prometheus/Gauge.php
@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 
diff --git a/src/Prometheus/Histogram.php b/src/Prometheus/Histogram.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus;
diff --git a/src/Prometheus/MetricFamilySamples.php b/src/Prometheus/MetricFamilySamples.php
@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 
diff --git a/src/Prometheus/PushGateway.php b/src/Prometheus/PushGateway.php
@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 
diff --git a/src/Prometheus/RenderTextFormat.php b/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());
         });
 
diff --git a/src/Prometheus/Sample.php b/src/Prometheus/Sample.php
@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus;
 
diff --git a/src/Prometheus/Storage/APC.php b/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);
         }
diff --git a/src/Prometheus/Storage/Adapter.php b/src/Prometheus/Storage/Adapter.php
@@ -1,5 +1,6 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
 
 namespace Prometheus\Storage;
 
diff --git a/src/Prometheus/Storage/InMemory.php b/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);
         }
diff --git a/src/Prometheus/Storage/Redis.php b/src/Prometheus/Storage/Redis.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Prometheus\Storage;
diff --git a/tests/Test/BlackBoxPushGatewayTest.php b/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;
diff --git a/tests/Test/BlackBoxTest.php b/tests/Test/BlackBoxTest.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Test;
 
 use GuzzleHttp\Client;
diff --git a/tests/Test/Prometheus/APC/HistogramTest.php b/tests/Test/Prometheus/APC/HistogramTest.php
@@ -17,4 +17,3 @@ public function configureAdapter()
         $this->adapter->flushAPC();
     }
 }
-
diff --git a/tests/Test/Prometheus/AbstractCollectorRegistryTest.php b/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();
 }
diff --git a/tests/Test/Prometheus/AbstractCounterTest.php b/tests/Test/Prometheus/AbstractCounterTest.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Test\Prometheus;
 
 use InvalidArgumentException;
@@ -25,7 +24,7 @@ public function setUp()
         $this->configureAdapter();
     }
 
-    public abstract function configureAdapter();
+    abstract public function configureAdapter();
 
     /**
      * @test
diff --git a/tests/Test/Prometheus/AbstractGaugeTest.php b/tests/Test/Prometheus/AbstractGaugeTest.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Test\Prometheus;
 
 use InvalidArgumentException;
@@ -25,7 +24,7 @@ public function setUp()
         $this->configureAdapter();
     }
 
-    public abstract function configureAdapter();
+    abstract public function configureAdapter();
 
     /**
      * @test
diff --git a/tests/Test/Prometheus/AbstractHistogramTest.php b/tests/Test/Prometheus/AbstractHistogramTest.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Test\Prometheus;
 
 use InvalidArgumentException;
@@ -10,7 +9,6 @@
 use Prometheus\Sample;
 use Prometheus\Storage\Adapter;
 
-
 /**
  * See https://prometheus.io/docs/instrumenting/exposition_formats/
  */
@@ -26,7 +24,7 @@ public function setUp()
         $this->configureAdapter();
     }
 
-    public abstract function configureAdapter();
+    abstract public function configureAdapter();
 
     /**
      * @test
@@ -250,7 +248,6 @@ public function itShouldProvideDefaultBuckets()
             'some_metric',
             'this is for testing',
             []
-
         );
         $histogram->observe(0.11);
         $histogram->observe(0.03);
diff --git a/tests/Test/Prometheus/InMemory/HistogramTest.php b/tests/Test/Prometheus/InMemory/HistogramTest.php
@@ -17,4 +17,3 @@ public function configureAdapter()
         $this->adapter->flushMemory();
     }
 }
-
diff --git a/tests/Test/Prometheus/PushGatewayTest.php b/tests/Test/Prometheus/PushGatewayTest.php
@@ -76,4 +76,4 @@ public function clientGetsDefinedIfNotSpecified(): void
         $pushGateway = new PushGateway('http://foo.bar');
         $pushGateway->push($mockedCollectorRegistry, 'foo');
     }
-}
+}
diff --git a/tests/Test/Prometheus/Storage/RedisTest.php b/tests/Test/Prometheus/Storage/RedisTest.php
@@ -21,5 +21,4 @@ public function itShouldThrowAnExceptionOnConnectionFailure()
         $redis->collect();
         $redis->flushRedis();
     }
-
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`<?php`
	`2`	`+`
`2`	`3`	`declare(strict_types=1);`
`3`	`4`
`4`	`5`	`namespace Prometheus;`