Merged in develop (pull request #2)

Bump to version 1.0.0 (API is the same, but requires php 7.1) Approved-by: Andre Ferraz <[email protected]> Approved-by: DuShaun Alderson-Claeys <[email protected]> Approved-by: Robin Shimield <[email protected]>
endclothing · Jul 23, 2019 · 8caf681 · 8caf681
2 parents 215c9ae + 8c7fa91
commit 8caf681
Show file tree

Hide file tree

Showing 44 changed files with 1,025 additions and 783 deletions.
diff --git a/README.md b/README.md
@@ -89,7 +89,7 @@ Also look at the [examples](examples).
 
 ### Dependencies
 
-* PHP 5.6
+* PHP 7.1
 * PHP Redis extension
 * PHP APCu extension
 * [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)

diff --git a/composer.json b/composer.json
@@ -11,20 +11,21 @@
         }
     ],
     "require": {
-        "php": ">=5.6.3",
+        "php": "^7.1",
+        "ext-json": "*",
         "guzzlehttp/guzzle": "^6.2",
         "symfony/polyfill-apcu": "^1.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.1.0"
+        "phpunit/phpunit": "^7.5"
     },
     "suggest": {
         "ext-redis": "Required if using Redis.",
         "ext-apc": "Required if using APCu."
     },
     "autoload": {
-        "psr-0": {
-            "Prometheus\\": "src/"
+        "psr-4": {
+            "Prometheus\\": "src/Prometheus/"
         }
     },
     "autoload-dev": {

diff --git a/examples/flush_adapter.php b/examples/flush_adapter.php
@@ -4,9 +4,9 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    define('REDIS_HOST', isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1');
+    define('REDIS_HOST', $_SERVER['REDIS_HOST'] ?? '127.0.0.1');
 
-    $redisAdapter = new Prometheus\Storage\Redis(array('host' => REDIS_HOST));
+    $redisAdapter = new Prometheus\Storage\Redis(['host' => REDIS_HOST]);
     $redisAdapter->flushRedis();
 } elseif ($adapter === 'apc') {
     $apcAdapter = new Prometheus\Storage\APC();

diff --git a/examples/metrics.php b/examples/metrics.php
@@ -9,7 +9,7 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

diff --git a/examples/pushgateway.php b/examples/pushgateway.php
@@ -1,13 +1,14 @@
 <?php
 require __DIR__ . '/../vendor/autoload.php';
 
+use Prometheus\PushGateway;
 use Prometheus\Storage\Redis;
 use Prometheus\CollectorRegistry;
 
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();
@@ -20,5 +21,5 @@
 $counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);
 $counter->incBy(6, ['blue']);
 
-$pushGateway = new \Prometheus\PushGateway('192.168.59.100:9091');
-$pushGateway->push($registry, 'my_job', array('instance'=>'foo'));
+$pushGateway = new PushGateway('192.168.59.100:9091');
+$pushGateway->push($registry, 'my_job', ['instance'=>'foo']);
diff --git a/examples/some_counter.php b/examples/some_counter.php
@@ -8,7 +8,7 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

diff --git a/examples/some_gauge.php b/examples/some_gauge.php
@@ -11,7 +11,7 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

diff --git a/examples/some_histogram.php b/examples/some_histogram.php
@@ -10,7 +10,7 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,7 +1,21 @@
-<phpunit colors="true" bootstrap="./tests/bootstrap.php">
-    <testsuites>
-        <testsuite name="Test Suite">
-            <directory>./tests/Test/Prometheus</directory>
-        </testsuite>
-    </testsuites>
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="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>
 </phpunit>
diff --git a/src/Prometheus/Collector.php b/src/Prometheus/Collector.php
@@ -1,17 +1,33 @@
 <?php
+declare(strict_types=1);
 
 namespace Prometheus;
 
-
+use InvalidArgumentException;
 use Prometheus\Storage\Adapter;
 
 abstract class Collector
 {
     const RE_METRIC_LABEL_NAME = '/^[a-zA-Z_:][a-zA-Z0-9_:]*$/';
 
+    /**
+     * @var Adapter
+     */
     protected $storageAdapter;
+
+    /**
+     * @var string
+     */
     protected $name;
+
+    /**
+     * @var string
+     */
     protected $help;
+
+    /**
+     * @var array
+     */
     protected $labels;
 
     /**
@@ -21,18 +37,18 @@ abstract class Collector
      * @param string $help
      * @param array $labels
      */
-    public function __construct(Adapter $storageAdapter, $namespace, $name, $help, $labels = array())
+    public function __construct(Adapter $storageAdapter, $namespace, $name, $help, $labels = [])
     {
         $this->storageAdapter = $storageAdapter;
         $metricName = ($namespace ? $namespace . '_' : '') . $name;
         if (!preg_match(self::RE_METRIC_LABEL_NAME, $metricName)) {
-            throw new \InvalidArgumentException("Invalid metric name: '" . $metricName . "'");
+            throw new InvalidArgumentException("Invalid metric name: '" . $metricName . "'");
         }
         $this->name = $metricName;
         $this->help = $help;
         foreach ($labels as $label) {
             if (!preg_match(self::RE_METRIC_LABEL_NAME, $label)) {
-                throw new \InvalidArgumentException("Invalid label name: '" . $label . "'");
+                throw new InvalidArgumentException("Invalid label name: '" . $label . "'");
             }
         }
         $this->labels = $labels;
@@ -43,33 +59,45 @@ public function __construct(Adapter $storageAdapter, $namespace, $name, $help, $
      */
     public abstract function getType();
 
-    public function getName()
+    /**
+     * @return string
+     */
+    public function getName(): string
     {
         return $this->name;
     }
 
-    public function getLabelNames()
+    /**
+     * @return array
+     */
+    public function getLabelNames(): array
     {
         return $this->labels;
     }
 
-    public function getHelp()
+    /**
+     * @return string
+     */
+    public function getHelp(): string
     {
         return $this->help;
     }
 
-    public function getKey()
+    /**
+     * @return string
+     */
+    public function getKey(): string
     {
         return sha1($this->getName() . serialize($this->getLabelNames()));
     }
 
     /**
      * @param $labels
      */
-    protected function assertLabelsAreDefinedCorrectly($labels)
+    protected function assertLabelsAreDefinedCorrectly($labels): void
     {
         if (count($labels) != count($this->labels)) {
-            throw new \InvalidArgumentException(sprintf('Labels are not defined correctly: ', print_r($labels, true)));
+            throw new InvalidArgumentException(sprintf('Labels are not defined correctly: ', print_r($labels, true)));
         }
     }
 }