Merge pull request #1 from CubiclDev/update8.2

Update dependencies

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        operating-system: [ ubuntu-latest ]
+        php: [ '8.1', '8.2' ]
+
+    name: PHP ${{ matrix.php }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: composer:v2
+          coverage: none
+          ini-values: expose_php=1
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: |
+          echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run tests suite
+        run: composer tests
+
+      - name: Run phpstan
+        run: composer analyze
+
+      - uses: actions/cache@v1
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-

README.md

@@ -1,7 +1,4 @@
-Cubicl\Sorting Module
-==============
-
-[![Build Status](https://travis-ci.org/CubiclDev/php-sorting.svg?branch=master)](https://travis-ci.org/CubiclDev/php-sorting)
+# Cubicl\Sorting Module
 
 Implementation of a generic sorting system with an interface definition compatible
 to the [Comparable RFC](https://wiki.php.net/rfc/comparable).

composer.json

@@ -13,13 +13,14 @@
         }
     ],
     "scripts": {
-        "check": ["@analyze", "@test"],
-        "test": "phpunit tests",
+        "check": ["@analyze", "@tests"],
+        "tests": "phpunit tests",
         "analyze": "phpstan analyse --level max src"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5",
-        "phpstan/phpstan": "^0.11.4"
+        "phpunit/phpunit": "^9.6.8",
+        "phpstan/phpstan": "^1.10.15",
+        "phpspec/prophecy-phpunit": "^2.0.2"
     },
     "autoload": {
         "psr-4": {

src/Comparable.php

@@ -6,8 +6,6 @@
 
 /**
  * Interface for the natural ordering of objects.
- *
- * @package Cubicl\Sorting
  */
 interface Comparable {
 
@@ -22,5 +20,5 @@ interface Comparable {
      * @return int
      * @throws InvalidComparisonException
      */
-    public function compareTo($other);
+    public function compareTo(mixed $other): int;
 }

src/SortManager.php

@@ -2,17 +2,12 @@
 
 namespace Cubicl\Sorting;
 
-/**
- * Class SortManager
- *
- * @package Cubicl\Sorting
- */
 class SortManager implements SortManagerInterface
 {
     /**
      * @inheritdoc
      */
-    public function sortWithComparator(ComparatorInterface $comparator, array $list)
+    public function sortWithComparator(ComparatorInterface $comparator, array $list): array
     {
         usort($list, [$comparator, 'compare']);
 
@@ -22,7 +17,7 @@ public function sortWithComparator(ComparatorInterface $comparator, array $list)
     /**
      * @inheritdoc
      */
-    public function sortComparable(array $list)
+    public function sortComparable(array $list): array
     {
         usort(
             $list,

src/SortManagerInterface.php

@@ -6,28 +6,27 @@
  * A sort manager handles user defined sorting of objects or value types. Make sure
  * that the objects or the values you want to sort have a total ordering, otherwise
  * the result of the methods is not specified.
- *
- * @package Cubicl\Sorting
  */
 interface SortManagerInterface
 {
     /**
      * Sort a list of values or objects by a given comparator.
      *
+     * @phpstan-template T
      * @param ComparatorInterface $comparator
-     * @param array $list a possible unsorted list
+     * @param array<T> $list a possible unsorted list
      *
-     * @return array the sorted list
+     * @return array<T> the sorted list
      */
-    public function sortWithComparator(ComparatorInterface $comparator, array $list);
+    public function sortWithComparator(ComparatorInterface $comparator, array $list): array;
 
 
     /**
      * Sort the list of objects by their natural order.
      *
      * @param Comparable[] $list
      *
-     * @return array the sorted list
+     * @return Comparable[] the sorted list
      */
-    public function sortComparable(array $list);
+    public function sortComparable(array $list): array;
 }

tests/Unit/SortManagerTest.php

@@ -5,27 +5,21 @@
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Cubicl\Sorting\Comparable;
 use Cubicl\Sorting\ComparatorInterface;
 use Cubicl\Sorting\SortManager;
 use Cubicl\Sorting\SortManagerInterface;
 
-/**
- * Class SortManagerTest
- *
- * @package Cubicl\Sorting
- */
 class SortManagerTest extends TestCase
 {
-    /**
-     * @var SortManagerInterface
-     */
-    private $sortManager;
+    use ProphecyTrait;
+    private SortManagerInterface $sortManager;
 
     /**
      *
      */
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
         $this->sortManager = new SortManager();