Merge pull request #31 from tiny-blocks/release/3.5.0

gustavofreze · web-flow · commit d4fe94b0997e · 2024-12-11T13:00:10.000-03:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,55 +1,49 @@
 name: CI
 
 on:
-  push:
   pull_request:
 
 permissions:
   contents: read
 
+env:
+  PHP_VERSION: '8.3'
+
 jobs:
   auto-review:
     name: Auto review
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Use PHP 8.2
+      - name: Configure PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.2'
+          php-version: ${{ env.PHP_VERSION }}
 
       - name: Install dependencies
         run: composer update --no-progress --optimize-autoloader
 
-      - name: Run phpcs
-        run: composer phpcs
-
-      - name: Run phpmd
-        run: composer phpmd
+      - name: Run review
+        run: composer review
 
   tests:
     name: Tests
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Use PHP 8.2
+      - name: Use PHP ${{ env.PHP_VERSION }}
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.2'
+          php-version: ${{ env.PHP_VERSION }}
 
       - name: Install dependencies
         run: composer update --no-progress --optimize-autoloader
 
-      - name: Run unit tests
-        env:
-          XDEBUG_MODE: coverage
-        run: composer test
-
-      - name: Run mutation tests
-        run: composer test-mutation
+      - name: Run tests
+        run: composer tests
diff --git a/Makefile b/Makefile
@@ -1,16 +1,13 @@
-DOCKER_RUN = docker run --rm -it --net=host -v ${PWD}:/app -w /app gustavofreze/php:8.2
+DOCKER_RUN = docker run --rm -it --net=host -v ${PWD}:/app -w /app gustavofreze/php:8.3
 
-.PHONY: configure test test-file test-no-coverage review show-reports clean
+.PHONY: configure test test-no-coverage review show-reports clean
 
 configure:
 	@${DOCKER_RUN} composer update --optimize-autoloader
 
 test:
 	@${DOCKER_RUN} composer tests
 
-test-file:
-	@${DOCKER_RUN} composer tests-file-no-coverage ${FILE}
-
 test-no-coverage:
 	@${DOCKER_RUN} composer tests-no-coverage
 
@@ -22,4 +19,4 @@ show-reports:
 
 clean:
 	@sudo chown -R ${USER}:${USER} ${PWD}
-	@rm -rf report vendor .phpunit.cache
+	@rm -rf report vendor .phpunit.cache .lock
diff --git a/composer.json b/composer.json
@@ -43,41 +43,36 @@
         }
     },
     "require": {
-        "php": "^8.2",
+        "php": "^8.3",
         "ext-bcmath": "*"
     },
     "require-dev": {
         "phpmd/phpmd": "^2.15",
         "phpunit/phpunit": "^11",
         "phpstan/phpstan": "^1",
-        "infection/infection": "^0.29",
-        "squizlabs/php_codesniffer": "^3.10"
+        "infection/infection": "^0",
+        "squizlabs/php_codesniffer": "^3.11"
     },
     "suggest": {
         "ext-bcmath": "Enables the extension which is an interface to the GNU implementation as a Basic Calculator utility library."
     },
     "scripts": {
+        "test": "phpunit --configuration phpunit.xml tests",
         "phpcs": "phpcs --standard=PSR12 --extensions=php ./src",
-        "phpmd": "phpmd ./src text phpmd.xml --suffixes php --exclude /src/RoundingMode.php --ignore-violations-on-exit",
+        "phpmd": "phpmd ./src text phpmd.xml --suffixes php --ignore-violations-on-exit",
         "phpstan": "phpstan analyse -c phpstan.neon.dist --quiet --no-progress",
-        "test": "phpunit --log-junit=report/coverage/junit.xml --coverage-xml=report/coverage/coverage-xml --coverage-html=report/coverage/coverage-html tests",
-        "test-mutation": "infection --only-covered --logger-html=report/coverage/mutation-report.html --coverage=report/coverage --min-msi=100 --min-covered-msi=100 --threads=4",
-        "test-no-coverage": "phpunit --no-coverage",
-        "test-mutation-no-coverage": "infection --only-covered --min-msi=100 --threads=4",
+        "mutation-test": "infection --only-covered --threads=max --logger-html=report/coverage/mutation-report.html --coverage=report/coverage",
+        "test-no-coverage": "phpunit --configuration phpunit.xml --no-coverage tests",
         "review": [
             "@phpcs",
             "@phpmd",
             "@phpstan"
         ],
         "tests": [
             "@test",
-            "@test-mutation"
+            "@mutation-test"
         ],
         "tests-no-coverage": [
-            "@test-no-coverage",
-            "@test-mutation-no-coverage"
-        ],
-        "tests-file-no-coverage": [
             "@test-no-coverage"
         ]
     }
diff --git a/infection.json.dist b/infection.json.dist
@@ -1,29 +1,29 @@
 {
-    "timeout": 10,
-    "testFramework": "phpunit",
+    "logs": {
+        "text": "report/infection/logs/infection-text.log",
+        "summary": "report/infection/logs/infection-summary.log"
+    },
     "tmpDir": "report/infection/",
+    "minMsi": 100,
+    "timeout": 30,
     "source": {
         "directories": [
             "src"
         ]
     },
-    "logs": {
-        "text": "report/infection/logs/infection-text.log",
-        "summary": "report/infection/logs/infection-summary.log"
+    "phpUnit": {
+        "configDir": "",
+        "customPath": "./vendor/bin/phpunit"
     },
     "mutators": {
         "@default": true,
         "Minus": false,
         "BCMath": false,
-        "CastInt": false,
         "Ternary": false,
         "RoundingFamily": false,
-        "DecrementInteger": false,
-        "IncrementInteger": false,
+        "PublicVisibility": false,
         "ProtectedVisibility": false
     },
-    "phpUnit": {
-        "configDir": "",
-        "customPath": "./vendor/bin/phpunit"
-    }
+    "minCoveredMsi": 100,
+    "testFramework": "phpunit"
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -4,9 +4,10 @@ parameters:
   level: 9
   tmpDir: report/phpstan
   ignoreErrors:
+    - '#does not accept#'
     - '#Binary operation#'
-    - '#of function sprintf expects#'
     - '#Access to an undefined property#'
+    - '#function number_format expects int#'
     - '#expects TinyBlocks\\Math\\BigNumber#'
     - '#type specified in iterable type array#'
   reportUnmatchedIgnoredErrors: false
diff --git a/phpunit.xml b/phpunit.xml
@@ -6,6 +6,7 @@
          failOnRisky="true"
          failOnWarning="true"
          cacheDirectory=".phpunit.cache"
+         executionOrder="random"
          beStrictAboutOutputDuringTests="true">
 
     <source>
@@ -22,14 +23,15 @@
 
     <coverage>
         <report>
+            <xml outputDirectory="report/coverage/coverage-xml"/>
+            <html outputDirectory="report/coverage/coverage-html"/>
             <text outputFile="report/coverage.txt"/>
-            <html outputDirectory="report/html/"/>
             <clover outputFile="report/coverage-clover.xml"/>
         </report>
     </coverage>
 
     <logging>
-        <junit outputFile="report/execution-result.xml"/>
+        <junit outputFile="report/coverage/junit.xml"/>
     </logging>
 
 </phpunit>
diff --git a/src/BigNumber.php b/src/BigNumber.php
@@ -12,7 +12,7 @@
  */
 interface BigNumber
 {
-    public const AUTOMATIC_SCALE = null;
+    public const null AUTOMATIC_SCALE = null;
 
     /**
      * Converts the current BigNumber to its absolute value.
diff --git a/src/Internal/Exceptions/DivisionByZero.php b/src/Internal/Exceptions/DivisionByZero.php
@@ -11,6 +11,7 @@ final class DivisionByZero extends RuntimeException
     public function __construct(string $dividend, string $divisor)
     {
         $template = 'Cannot divide <%.2f> by <%.2f>.';
+
         parent::__construct(message: sprintf($template, $dividend, $divisor));
     }
 }
diff --git a/src/Internal/Exceptions/InvalidNumber.php b/src/Internal/Exceptions/InvalidNumber.php
@@ -11,6 +11,7 @@ final class InvalidNumber extends RuntimeException
     public function __construct(string $value)
     {
         $template = 'The value <%s> is not a valid number.';
+
         parent::__construct(message: sprintf($template, $value));
     }
 }
diff --git a/src/Internal/Exceptions/InvalidScale.php b/src/Internal/Exceptions/InvalidScale.php
@@ -11,6 +11,7 @@ final class InvalidScale extends RuntimeException
     public function __construct(int $value, int $minimum, int $maximum)
     {
         $template = 'Scale value <%s> is invalid. The value must be between <%s> and <%s>.';
+
         parent::__construct(message: sprintf($template, $value, $minimum, $maximum));
     }
 }
diff --git a/src/Internal/Exceptions/MathOperationsNotAvailable.php b/src/Internal/Exceptions/MathOperationsNotAvailable.php
@@ -11,6 +11,7 @@ final class MathOperationsNotAvailable extends RuntimeException
     public function __construct(array $extensions)
     {
         $template = 'There are no implementations available. Enable one of these <%s> extensions.';
+
         parent::__construct(message: sprintf($template, implode(',', $extensions)));
     }
 }
diff --git a/src/Internal/Exceptions/NonNegativeValue.php b/src/Internal/Exceptions/NonNegativeValue.php
@@ -12,6 +12,7 @@ final class NonNegativeValue extends RuntimeException
     public function __construct(Number $number)
     {
         $template = 'Value <%s> is not valid. Must be a negative number less than zero.';
+
         parent::__construct(message: sprintf($template, $number->value));
     }
 }
diff --git a/src/Internal/Exceptions/NonPositiveValue.php b/src/Internal/Exceptions/NonPositiveValue.php
@@ -12,6 +12,7 @@ final class NonPositiveValue extends RuntimeException
     public function __construct(Number $number)
     {
         $template = 'Value <%s> is not valid. Must be a positive number greater than zero.';
+
         parent::__construct(message: sprintf($template, $number->value));
     }
 }
diff --git a/src/Internal/Number.php b/src/Internal/Number.php
@@ -8,17 +8,18 @@
 
 final class Number
 {
-    private const ZERO = 0.0;
-    private const SIGN = '?<sign>[\-\+]';
-    private const POINT = '?<point>\.';
-    private const INTEGRAL = '?<integral>[0-9]+';
-    private const EXPONENT = '?<exponent>[\-\+]?[0-9]+';
-    private const NUMERATOR = '?<numerator>[0-9]+';
-    private const FRACTIONAL = '?<fractional>[0-9]+';
-    private const DENOMINATOR = '?<denominator>[0-9]+';
-    private const VALID_NUMBER = '/^(%s)?(?:(?:(%s)?(%s)?(%s)?(?:[eE](%s))?)|(?:(%s)\/?(%s)))$/';
+    private const float ZERO = 0.0;
+    private const string SIGN = '?<sign>[\-\+]';
+    private const string POINT = '?<point>\.';
+    private const string INTEGRAL = '?<integral>[0-9]+';
+    private const string EXPONENT = '?<exponent>[\-\+]?[0-9]+';
+    private const string NUMERATOR = '?<numerator>[0-9]+';
+    private const string FRACTIONAL = '?<fractional>[0-9]+';
+    private const string DENOMINATOR = '?<denominator>[0-9]+';
+    private const string VALID_NUMBER = '/^(%s)?(?:(?:(%s)?(%s)?(%s)?(?:[eE](%s))?)|(?:(%s)\/?(%s)))$/';
 
     private int $match;
+
     private array $matches = [];
 
     private function __construct(public readonly string $value)
@@ -34,7 +35,7 @@ private function __construct(public readonly string $value)
             self::DENOMINATOR
         );
 
-        $this->match = (int)preg_match($pattern, $this->value, $this->matches);
+        $this->match = preg_match($pattern, $this->value, $this->matches);
 
         if ($this->isInvalidNumber()) {
             throw new InvalidNumber(value: $this->value);
@@ -100,7 +101,7 @@ public function toFloatWithScale(Scale $scale): float
     {
         $value = (float)$this->value;
 
-        return $scale->hasAutomaticScale() ? $value : (float)number_format($value, (int)$scale->value, '.', '');
+        return $scale->hasAutomaticScale() ? $value : (float)number_format($value, $scale->value, '.', '');
     }
 
     private function match(string $key): ?string
@@ -114,6 +115,6 @@ private function isInvalidNumber(): bool
     {
         $integral = $this->match(key: 'integral');
 
-        return ($this->match != 1) || (is_null($integral) && is_null($this->getFractional()));
+        return ($this->match !== 1) || (is_null($integral) && is_null($this->getFractional()));
     }
 }
diff --git a/src/Internal/Operations/Adapters/Scales/Addition.php b/src/Internal/Operations/Adapters/Scales/Addition.php
@@ -10,6 +10,7 @@
 final readonly class Addition implements Scales
 {
     private Scale $augendScale;
+
     private Scale $addendScale;
 
     public function __construct(private BigNumber $augend, private BigNumber $addend)
diff --git a/src/Internal/Operations/Adapters/Scales/Division.php b/src/Internal/Operations/Adapters/Scales/Division.php
@@ -9,9 +9,10 @@
 
 final readonly class Division implements Scales
 {
-    private Scale $dividendScale;
     private Scale $divisorScale;
 
+    private Scale $dividendScale;
+
     public function __construct(private BigNumber $dividend, private BigNumber $divisor)
     {
         $this->dividendScale = Scale::from(value: $this->dividend->getScale());
diff --git a/src/Internal/Operations/Adapters/Scales/Multiplication.php b/src/Internal/Operations/Adapters/Scales/Multiplication.php
@@ -9,13 +9,14 @@
 
 final readonly class Multiplication implements Scales
 {
-    private Scale $multiplicandScale;
     private Scale $multiplierScale;
 
+    private Scale $multiplicandScale;
+
     public function __construct(private BigNumber $multiplicand, private BigNumber $multiplier)
     {
-        $this->multiplicandScale = Scale::from(value: $this->multiplicand->getScale());
         $this->multiplierScale = Scale::from(value: $this->multiplier->getScale());
+        $this->multiplicandScale = Scale::from(value: $this->multiplicand->getScale());
     }
 
     public function applyScale(): Scale
diff --git a/src/Internal/Operations/Adapters/Scales/Subtraction.php b/src/Internal/Operations/Adapters/Scales/Subtraction.php
@@ -10,6 +10,7 @@
 final readonly class Subtraction
 {
     private Scale $minuendScale;
+
     private Scale $subtrahendScale;
 
     public function __construct(private BigNumber $minuend, private BigNumber $subtrahend)
diff --git a/src/Internal/Operations/Extension/Extension.php b/src/Internal/Operations/Extension/Extension.php
@@ -9,7 +9,7 @@
  */
 interface Extension
 {
-    public const BC_MATH = 'bcmath';
+    public const string BC_MATH = 'bcmath';
 
     /**
      * Checks if a given PHP extension is loaded and available for use.
diff --git a/src/Internal/Scale.php b/src/Internal/Scale.php
diff --git a/src/RoundingMode.php b/src/RoundingMode.php
diff --git a/tests/RoundingModeTest.php b/tests/RoundingModeTest.php

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`*/`
`13`	`13`	`interface BigNumber`
`14`	`14`	`{`
`15`		`- public const AUTOMATIC_SCALE = null;`
	`15`	`+ public const null AUTOMATIC_SCALE = null;`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* Converts the current BigNumber to its absolute value.`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ final class DivisionByZero extends RuntimeException`
`11`	`11`	`public function __construct(string $dividend, string $divisor)`
`12`	`12`	`{`
`13`	`13`	`$template = 'Cannot divide <%.2f> by <%.2f>.';`
	`14`	`+`
`14`	`15`	`parent::__construct(message: sprintf($template, $dividend, $divisor));`
`15`	`16`	`}`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ final class InvalidNumber extends RuntimeException`
`11`	`11`	`public function __construct(string $value)`
`12`	`12`	`{`
`13`	`13`	`$template = 'The value <%s> is not a valid number.';`
	`14`	`+`
`14`	`15`	`parent::__construct(message: sprintf($template, $value));`
`15`	`16`	`}`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ final class InvalidScale extends RuntimeException`
`11`	`11`	`public function __construct(int $value, int $minimum, int $maximum)`
`12`	`12`	`{`
`13`	`13`	`$template = 'Scale value <%s> is invalid. The value must be between <%s> and <%s>.';`
	`14`	`+`
`14`	`15`	`parent::__construct(message: sprintf($template, $value, $minimum, $maximum));`
`15`	`16`	`}`
`16`	`17`	`}`