Run PHPStan as Github Action

* Depend on PHPUnit for development

In order to run the unit tests, PHPUnit is a hard dev
dependency, so I've included it in this commit, and now
I can run the unit tests as part of this PR.

* Depend on PHPStan for development

This is for willdurand#89 - to ensure correct type hints are provided
to developers who use IDEs.

* Fix object model of AcceptHeader interface

Fixes willdurand#89 - IDEs and PHPStan are happy with this implementation

* Correct return type

* Correct nonexistent Priority class to AcceptHeader

* Improve typehint - allow looser type to be returned

* Improve typehint - more accurate types as parameters

* Improve typehint - more accurate generics as parameters

* Expose script property - was only ever written

* Properly typehint associative array

* Typehint nullable string

* Match typehints of parent method

* Add PHPStan to CI

* Configure PHPUnit versions for different PHP runtimes

* Use real phpunit

.github/workflows/ci.yaml

@@ -31,4 +31,30 @@ jobs:
         uses: "ramsey/composer-install@v1"
 
       - name: "Run PHPUnit"
-        run: "vendor/bin/simple-phpunit --coverage-text"
+        run: "vendor/bin/phpunit --coverage-text"
+
+  phpstan:
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version:
+          - "7.4"
+          - "8.0"
+          - "8.1"
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: "Install PHP ${{ matrix.php-version }}"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: "pcov"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+
+      - name: "Run PHPStan"
+        run: "vendor/bin/phpstan analyse src --level 5"

composer.json

@@ -25,6 +25,8 @@
         }
     },
     "require-dev": {
-        "symfony/phpunit-bridge": "^5.0"
+        "symfony/phpunit-bridge": "^5.0",
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.4"
     }
 }

src/Negotiation/AbstractNegotiator.php

@@ -11,7 +11,7 @@ abstract class AbstractNegotiator
      * @param string $header     A string containing an `Accept|Accept-*` header.
      * @param array  $priorities A set of server priorities.
      *
-     * @return AcceptHeader|null best matching type
+     * @return BaseAccept|null best matching type
      */
     public function getBest($header, array $priorities, $strict = false)
     {
@@ -100,18 +100,18 @@ public function getOrderedElements($header)
     /**
      * @param string $header accept header part or server priority
      *
-     * @return AcceptHeader Parsed header object
+     * @return BaseAccept Parsed header object
      */
     abstract protected function acceptFactory($header);
 
     /**
-     * @param AcceptHeader $header
-     * @param AcceptHeader $priority
+     * @param BaseAccept $header
+     * @param BaseAccept $priority
      * @param integer      $index
      *
      * @return AcceptMatch|null Headers matched
      */
-    protected function match(AcceptHeader $header, AcceptHeader $priority, $index)
+    protected function match(BaseAccept $header, BaseAccept $priority, $index)
     {
         $ac = $header->getType();
         $pc = $priority->getType();
@@ -130,7 +130,7 @@ protected function match(AcceptHeader $header, AcceptHeader $priority, $index)
     /**
      * @param string $header A string that contains an `Accept*` header.
      *
-     * @return AcceptHeader[]
+     * @return string[]
      */
     private function parseHeader($header)
     {
@@ -144,8 +144,8 @@ private function parseHeader($header)
     }
 
     /**
-     * @param AcceptHeader[] $headerParts
-     * @param Priority[]     $priorities  Configured priorities
+     * @param BaseAccept[] $headerParts
+     * @param BaseAccept[]     $priorities  Configured priorities
      *
      * @return AcceptMatch[] Headers matched
      */

src/Negotiation/Accept.php

@@ -4,7 +4,7 @@
 
 use Negotiation\Exception\InvalidMediaType;
 
-final class Accept extends BaseAccept implements AcceptHeader
+final class Accept extends BaseAccept
 {
     private $basePart;
 

src/Negotiation/AcceptCharset.php

@@ -2,6 +2,6 @@
 
 namespace Negotiation;
 
-final class AcceptCharset extends BaseAccept implements AcceptHeader
+final class AcceptCharset extends BaseAccept
 {
 }

src/Negotiation/AcceptEncoding.php

@@ -2,6 +2,6 @@
 
 namespace Negotiation;
 
-final class AcceptEncoding extends BaseAccept implements AcceptHeader
+final class AcceptEncoding extends BaseAccept
 {
 }

src/Negotiation/AcceptLanguage.php

@@ -4,7 +4,7 @@
 
 use Negotiation\Exception\InvalidLanguage;
 
-final class AcceptLanguage extends BaseAccept implements AcceptHeader
+final class AcceptLanguage extends BaseAccept
 {
     private $language;
     private $script;
@@ -32,7 +32,7 @@ public function __construct($value)
     }
 
     /**
-     * @return string
+     * @return null|string
      */
     public function getSubPart()
     {
@@ -46,4 +46,12 @@ public function getBasePart()
     {
         return $this->language;
     }
+
+    /**
+     * @return null|string
+     */
+    public function getScript()
+    {
+        return $this->script;
+    }
 }

src/Negotiation/BaseAccept.php

@@ -2,7 +2,7 @@
 
 namespace Negotiation;
 
-abstract class BaseAccept
+abstract class BaseAccept implements AcceptHeader
 {
     /**
      * @var float
@@ -140,14 +140,13 @@ private function parseParameters($acceptPart)
     }
 
     /**
-     * @param string $parameters
+     * @param array<string, string> $parameters
      *
      * @return string
      */
     private function buildParametersString($parameters)
     {
         $parts = [];
-
         ksort($parameters);
         foreach ($parameters as $key => $val) {
             $parts[] = sprintf('%s=%s', $key, $val);

src/Negotiation/LanguageNegotiator.php

@@ -15,7 +15,7 @@ protected function acceptFactory($accept)
     /**
      * {@inheritdoc}
      */
-    protected function match(AcceptHeader $acceptLanguage, AcceptHeader $priority, $index)
+    protected function match(BaseAccept $acceptLanguage, BaseAccept $priority, $index)
     {
         if (!$acceptLanguage instanceof AcceptLanguage || !$priority instanceof AcceptLanguage) {
             return null;

tests/Negotiation/Tests/AcceptLanguageTest.php

@@ -42,6 +42,12 @@ public function testGetValue($header, $expected)
 
     }
 
+    public function testGetScript()
+    {
+        $accept = new AcceptLanguage("zh-Hans-CN;q=0.3");
+        $this->assertSame("hans", $accept->getScript());
+    }
+
     public static function dataProviderForGetValue()
     {
         return array(