Bump requirements to PHP 8.0 & follow PSR-12 coding style

Author: tvdijen

.scrutinizer.yml

@@ -15,7 +15,7 @@ build:
                           file: build/logs/clover.xml
     environment:
         php:
-            version: 7.2
+            version: 8.0
 filter:
     excluded_paths:
         - test/

.travis.yml

@@ -1,7 +1,7 @@
 language: php
 php:
-    - "7.2"
-    - "7.3"
+    - "8.0"
+    - "8.1"
 before_script:
     - "composer install"
     - "composer require php-coveralls/php-coveralls"

README.md

@@ -10,7 +10,7 @@ textual encodings of cryptographic structures _(PEM)_.
 
 ## Requirements
 
-- PHP >=7.2
+- PHP >=8.0
 
 ## Installation
 

composer.json

@@ -18,14 +18,14 @@
         }
     ],
     "require": {
-        "php": ">=7.2"
+        "php": "^8.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.1"
+        "phpunit/phpunit": "^9.5"
     },
     "autoload": {
         "psr-4": {
             "Sop\\CryptoEncoding\\": "lib/CryptoEncoding/"
         }
     }
-}
+}

lib/CryptoEncoding/PEM.php

@@ -1,9 +1,20 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Sop\CryptoEncoding;
 
+use RuntimeException;
+use UnexpectedValueException;
+
+use function base_decode;
+use function base_encode;
+use function chunk_split;
+use function file_get_contents;
+use function is_readable;
+use function preg_match;
+use function trim;
+
 /**
  * Implements PEM file encoding and decoding.
  *
@@ -12,44 +23,45 @@
 class PEM
 {
     // well-known PEM types
-    const TYPE_CERTIFICATE = 'CERTIFICATE';
-    const TYPE_CRL = 'X509 CRL';
-    const TYPE_CERTIFICATE_REQUEST = 'CERTIFICATE REQUEST';
-    const TYPE_ATTRIBUTE_CERTIFICATE = 'ATTRIBUTE CERTIFICATE';
-    const TYPE_PRIVATE_KEY = 'PRIVATE KEY';
-    const TYPE_PUBLIC_KEY = 'PUBLIC KEY';
-    const TYPE_ENCRYPTED_PRIVATE_KEY = 'ENCRYPTED PRIVATE KEY';
-    const TYPE_RSA_PRIVATE_KEY = 'RSA PRIVATE KEY';
-    const TYPE_RSA_PUBLIC_KEY = 'RSA PUBLIC KEY';
-    const TYPE_EC_PRIVATE_KEY = 'EC PRIVATE KEY';
-    const TYPE_PKCS7 = 'PKCS7';
-    const TYPE_CMS = 'CMS';
+    public const TYPE_CERTIFICATE = 'CERTIFICATE';
+    public const TYPE_CRL = 'X509 CRL';
+    public const TYPE_CERTIFICATE_REQUEST = 'CERTIFICATE REQUEST';
+    public const TYPE_ATTRIBUTE_CERTIFICATE = 'ATTRIBUTE CERTIFICATE';
+    public const TYPE_PRIVATE_KEY = 'PRIVATE KEY';
+    public const TYPE_PUBLIC_KEY = 'PUBLIC KEY';
+    public const TYPE_ENCRYPTED_PRIVATE_KEY = 'ENCRYPTED PRIVATE KEY';
+    public const TYPE_RSA_PRIVATE_KEY = 'RSA PRIVATE KEY';
+    public const TYPE_RSA_PUBLIC_KEY = 'RSA PUBLIC KEY';
+    public const TYPE_EC_PRIVATE_KEY = 'EC PRIVATE KEY';
+    public const TYPE_PKCS7 = 'PKCS7';
+    public const TYPE_CMS = 'CMS';
 
     /**
      * Regular expression to match PEM block.
      *
      * @var string
      */
-    const PEM_REGEX = '/' .
+    public const PEM_REGEX =
+         '/' .
         /* line start */ '(?:^|[\r\n])' .
         /* header */     '-----BEGIN (.+?)-----[\r\n]+' .
         /* payload */    '(.+?)' .
         /* trailer */    '[\r\n]+-----END \\1-----' .
-    '/ms';
+        '/ms';
 
     /**
      * Content type.
      *
      * @var string
      */
-    protected $_type;
+    protected $type;
 
     /**
      * Payload.
      *
      * @var string
      */
-    protected $_data;
+    protected $data;
 
     /**
      * Constructor.
@@ -59,8 +71,8 @@ class PEM
      */
     public function __construct(string $type, string $data)
     {
-        $this->_type = $type;
-        $this->_data = $data;
+        $this->type = $type;
+        $this->data = $data;
     }
 
     /**
@@ -83,12 +95,12 @@ public function __toString(): string
     public static function fromString(string $str): self
     {
         if (!preg_match(self::PEM_REGEX, $str, $match)) {
-            throw new \UnexpectedValueException('Not a PEM formatted string.');
+            throw new UnexpectedValueException('Not a PEM formatted string.');
         }
         $payload = preg_replace('/\s+/', '', $match[2]);
         $data = base64_decode($payload, true);
         if (false === $data) {
-            throw new \UnexpectedValueException('Failed to decode PEM data.');
+            throw new UnexpectedValueException('Failed to decode PEM data.');
         }
         return new self($match[1], $data);
     }
@@ -104,9 +116,11 @@ public static function fromString(string $str): self
      */
     public static function fromFile(string $filename): self
     {
-        if (!is_readable($filename) ||
-            false === ($str = file_get_contents($filename))) {
-            throw new \RuntimeException("Failed to read {$filename}.");
+        if (
+            !is_readable($filename) ||
+            false === ($str = file_get_contents($filename))
+        ) {
+            throw new RuntimeException("Failed to read {$filename}.");
         }
         return self::fromString($str);
     }
@@ -118,7 +132,7 @@ public static function fromFile(string $filename): self
      */
     public function type(): string
     {
-        return $this->_type;
+        return $this->type;
     }
 
     /**
@@ -128,7 +142,7 @@ public function type(): string
      */
     public function data(): string
     {
-        return $this->_data;
+        return $this->data;
     }
 
     /**
@@ -138,8 +152,8 @@ public function data(): string
      */
     public function string(): string
     {
-        return "-----BEGIN {$this->_type}-----\n" .
-            trim(chunk_split(base64_encode($this->_data), 64, "\n")) . "\n" .
-            "-----END {$this->_type}-----";
+        return "-----BEGIN {$this->type}-----\n" .
+            trim(chunk_split(base64_encode($this->data), 64, "\n")) . "\n" .
+            "-----END {$this->type}-----";
     }
 }

lib/CryptoEncoding/PEMBundle.php

@@ -1,31 +1,48 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Sop\CryptoEncoding;
 
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use LogicException;
+use RuntimeException;
+use UnexpectedValueException;
+
+use function array_map;
+use function array_merge;
+use function base64_decode;
+use function count;
+use function implode;
+use function is_readable;
+use function file_get_contents;
+use function preg_match_all;
+use function preg_replace;
+
 /**
  * Container for multiple PEM objects.
  *
  * The order of PEMs shall be retained, eg. when read from a file.
  */
-class PEMBundle implements \Countable, \IteratorAggregate
+class PEMBundle implements Countable, IteratorAggregate
 {
     /**
      * Array of PEM objects.
      *
-     * @var PEM[]
+     * @var \Sop\CryptoEncoding\PEM[]
      */
-    protected $_pems;
+    protected $pems;
 
     /**
      * Constructor.
      *
-     * @param PEM ...$pems
+     * @param \Sop\CryptoEncoding\PEM[] $pems
      */
     public function __construct(PEM ...$pems)
     {
-        $this->_pems = $pems;
+        $this->pems = $pems;
     }
 
     /**
@@ -48,18 +65,21 @@ public function __toString(): string
     public static function fromString(string $str): self
     {
         if (!preg_match_all(PEM::PEM_REGEX, $str, $matches, PREG_SET_ORDER)) {
-            throw new \UnexpectedValueException('No PEM blocks.');
+            throw new UnexpectedValueException('No PEM blocks.');
         }
+
         $pems = array_map(
             function ($match) {
                 $payload = preg_replace('/\s+/', '', $match[2]);
                 $data = base64_decode($payload, true);
                 if (false === $data) {
-                    throw new \UnexpectedValueException(
-                        'Failed to decode PEM data.');
+                    throw new UnexpectedValueException('Failed to decode PEM data.');
                 }
                 return new PEM($match[1], $data);
-            }, $matches);
+            },
+            $matches
+        );
+
         return new self(...$pems);
     }
 
@@ -74,9 +94,11 @@ function ($match) {
      */
     public static function fromFile(string $filename): self
     {
-        if (!is_readable($filename) ||
-            false === ($str = file_get_contents($filename))) {
-            throw new \RuntimeException("Failed to read {$filename}.");
+        if (
+            !is_readable($filename) ||
+            false === ($str = file_get_contents($filename))
+        ) {
+            throw new RuntimeException("Failed to read {$filename}.");
         }
         return self::fromString($str);
     }
@@ -91,48 +113,48 @@ public static function fromFile(string $filename): self
     public function withPEMs(PEM ...$pems): self
     {
         $obj = clone $this;
-        $obj->_pems = array_merge($obj->_pems, $pems);
+        $obj->pems = array_merge($obj->pems, $pems);
         return $obj;
     }
 
     /**
      * Get all PEMs in a bundle.
      *
-     * @return PEM[]
+     * @return \Sop\CryptoEncoding\PEM[]
      */
     public function all(): array
     {
-        return $this->_pems;
+        return $this->pems;
     }
 
     /**
      * Get the first PEM in a bundle.
      *
      * @throws \LogicException If bundle contains no PEM objects
      *
-     * @return PEM
+     * @return \Sop\CryptoEncoding\PEM
      */
     public function first(): PEM
     {
-        if (!count($this->_pems)) {
-            throw new \LogicException('No PEMs.');
+        if (!count($this->pems)) {
+            throw new LogicException('No PEMs.');
         }
-        return $this->_pems[0];
+        return $this->pems[0];
     }
 
     /**
      * Get the last PEM in a bundle.
      *
      * @throws \LogicException If bundle contains no PEM objects
      *
-     * @return PEM
+     * @return \Sop\CryptoEncoding\PEM
      */
     public function last(): PEM
     {
-        if (!count($this->_pems)) {
-            throw new \LogicException('No PEMs.');
+        if (!count($this->pems)) {
+            throw new LogicException('No PEMs.');
         }
-        return $this->_pems[count($this->_pems) - 1];
+        return $this->pems[count($this->pems) - 1];
     }
 
     /**
@@ -142,7 +164,7 @@ public function last(): PEM
      */
     public function count(): int
     {
-        return count($this->_pems);
+        return count($this->pems);
     }
 
     /**
@@ -152,9 +174,9 @@ public function count(): int
      *
      * @return \ArrayIterator
      */
-    public function getIterator(): \ArrayIterator
+    public function getIterator(): ArrayIterator
     {
-        return new \ArrayIterator($this->_pems);
+        return new ArrayIterator($this->pems);
     }
 
     /**
@@ -164,10 +186,14 @@ public function getIterator(): \ArrayIterator
      */
     public function string(): string
     {
-        return implode("\n",
+        return implode(
+            "\n",
             array_map(
                 function (PEM $pem) {
                     return $pem->string();
-                }, $this->_pems));
+                },
+                $this->pems
+            )
+        );
     }
 }