Upgrade to PHP 8 (#6)

* PHP 8 support
* Update CS fixer

.github/workflows/php-cs-fixer.yml

@@ -11,4 +11,4 @@ jobs:
       - name: Package
         uses: docker://oskarstark/php-cs-fixer-ga
         with:
-          args: --config=.php_cs.dist --diff --dry-run
+          args: --config=.php-cs-fixer.dist.php --diff --dry-run

.github/workflows/run-tests.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        php: [7.4]
+        php: [8.2, 8.3]
         dependency-version: [prefer-lowest, prefer-stable]
         include:
           - testbench: 5.*
@@ -18,16 +18,16 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: ~/.composer/cache/files
           key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@v1
+        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: json
@@ -41,7 +41,7 @@ jobs:
         run: vendor/bin/phpunit --coverage-clover=coverage.xml
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml

.gitignore

@@ -2,5 +2,7 @@ composer.lock
 /vendor/
 .php_cs.cache
 .phpunit.result.cache
+.phpunit.cache/*
+phpunit.xml.dist.bak
 coverage.xml
 .coverage

.php-cs-fixer.dist.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Residue package.
+ * (c) Romain Norberg <romainnorberg@gmail.com>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+$fileHeaderComment = <<<COMMENT
+This file is part of the Residue package.
+(c) Romain Norberg <romainnorberg@gmail.com>
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+COMMENT;
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->exclude('config')
+;
+
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony'       => true,
+        '@Symfony:risky' => true,
+        // Binary operators should be surrounded by space as configured.
+        'binary_operator_spaces' => [
+            'operators' => ['=>' => 'align_single_space_minimal'],
+        ],
+        'array_syntax'                          => ['syntax' => 'short'],
+        'header_comment'                        => ['header' => $fileHeaderComment, 'separate' => 'both'],
+        'linebreak_after_opening_tag'           => true,
+        'mb_str_functions'                      => true,
+        'no_php4_constructor'                   => true,
+        'no_superfluous_phpdoc_tags'            => true,
+        'no_unreachable_default_argument_value' => true,
+        'no_useless_else'                       => true,
+        'no_useless_return'                     => true,
+        'ordered_imports'                       => true,
+        'php_unit_strict'                       => false,
+        'phpdoc_order'                          => true,
+        'semicolon_after_instruction'           => true,
+        'strict_comparison'                     => true,
+        'strict_param'                          => true,
+        'trailing_comma_in_multiline'           => true,
+        'php_unit_method_casing'                => false,
+        'php_unit_test_annotation'              => false,
+        'visibility_required'                   => false,
+    ])
+    ->setFinder($finder)
+    ->setCacheFile(__DIR__.'/.php_cs.cache')
+;

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Romain Norberg
+Copyright (c) 2023 Romain Norberg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -147,10 +147,6 @@ array(3) {
 composer test
 ```
 
-## Changelog
-
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
-
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

composer.json

@@ -19,12 +19,12 @@
     },
     "type": "library",
     "require": {
-        "php": "^7.4"
+        "php": "^8.2"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.16",
-        "phpstan/phpstan": "^0.12.49",
-        "phpunit/phpunit": "^8.0",
+        "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^10.0",
         "spatie/phpunit-watcher": "^1.22"
     },
     "authors": [

phpunit.xml.dist

@@ -1,22 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Residue Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage/>
+  <testsuites>
+    <testsuite name="Residue Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </source>
 </phpunit>

src/Contracts/ResidueInterface.php

@@ -9,10 +9,10 @@
 
 namespace Romainnorberg\Residue\Contracts;
 
-use Generator;
-
 interface ResidueInterface
 {
+    public const DEFAULT_DECIMAL = 2;
+
     public const SPLIT_MODE_ALLOCATE = 'allocate';
     public const SPLIT_MODE_EQUITY = 'equity';
     public const SPLIT_MODES = [
@@ -41,7 +41,7 @@ public function decimal(int $decimal): self;
      *   or
      *   101/3 with step 1 will split again into [33, 33, 33]
      */
-    public function split(string $mode = self::SPLIT_MODE_ALLOCATE): Generator;
+    public function split(string $mode = self::SPLIT_MODE_ALLOCATE): \Generator;
 
     public function toArray(string $mode = self::SPLIT_MODE_ALLOCATE): array;
 

src/Exception/DecimalException.php

@@ -9,8 +9,6 @@
 
 namespace Romainnorberg\Residue\Exception;
 
-use InvalidArgumentException;
-
-class DecimalException extends InvalidArgumentException
+class DecimalException extends \InvalidArgumentException
 {
 }

src/Exception/DivideException.php

@@ -9,8 +9,6 @@
 
 namespace Romainnorberg\Residue\Exception;
 
-use InvalidArgumentException;
-
-class DivideException extends InvalidArgumentException
+class DivideException extends \InvalidArgumentException
 {
 }

src/Exception/ResidueModeException.php

@@ -9,8 +9,6 @@
 
 namespace Romainnorberg\Residue\Exception;
 
-use InvalidArgumentException;
-
-class ResidueModeException extends InvalidArgumentException
+class ResidueModeException extends \InvalidArgumentException
 {
 }

src/Exception/StepException.php

@@ -9,8 +9,6 @@
 
 namespace Romainnorberg\Residue\Exception;
 
-use InvalidArgumentException;
-
-class StepException extends InvalidArgumentException
+class StepException extends \InvalidArgumentException
 {
 }

src/Residue.php

@@ -11,7 +11,6 @@
 
 namespace Romainnorberg\Residue;
 
-use Generator;
 use Romainnorberg\Residue\Contracts\ResidueInterface;
 use Romainnorberg\Residue\Exception\CannotGetRemainderException;
 use Romainnorberg\Residue\Exception\DecimalException;
@@ -24,7 +23,7 @@ final class Residue implements ResidueInterface
     private float $value;
     private bool $isNegative;
     private int $divider = 1;
-    private int $decimal = 2;
+    private int $decimal = ResidueInterface::DEFAULT_DECIMAL;
     private float $step;
     private float $remainder;
 
@@ -73,7 +72,7 @@ public static function create(float $value): self
      *  - Defining rm according to `M`
      *  - Iterate [n as 1 ... Dv] : yield pⁿ
      */
-    public function split(string $mode = self::SPLIT_MODE_ALLOCATE): Generator
+    public function split(string $mode = self::SPLIT_MODE_ALLOCATE): \Generator
     {
         if (!\in_array($mode, self::SPLIT_MODES, true)) {
             throw new ResidueModeException(sprintf('Accepted modes are : %s', implode(', ', self::SPLIT_MODES)));
@@ -92,8 +91,8 @@ public function split(string $mode = self::SPLIT_MODE_ALLOCATE): Generator
 
         for ($i = 1; $i <= $this->divider; ++$i) {
             $xn = $defaultNumberOfSteps;
-            if (self::SPLIT_MODE_ALLOCATE === $mode &&
-                ($defaultNumberOfSteps * $this->divider + $i) <= $maxNumberOfSteps
+            if (self::SPLIT_MODE_ALLOCATE === $mode
+                && ($defaultNumberOfSteps * $this->divider + $i) <= $maxNumberOfSteps
             ) {
                 ++$xn;
             }

tests/ResidueExceptionTest.php

@@ -45,6 +45,7 @@ public function it_should_throw_cannot_get_remainder_exception(): void
 
     /**
      * @test
+     *
      * @dataProvider provideDataForDivideException
      */
     public function it_should_throw_divide_exception(int $minusThanOne): void
@@ -80,7 +81,7 @@ public function it_should_throw_decimal_exception(): void
             ->decimal(-1);
     }
 
-    public function provideDataForDivideException()
+    static public function provideDataForDivideException()
     {
         return [
             [0],