Update PHPUnit to PHPUnit10

Author: macocci7

.github/workflows/tag_meged_pull_request.yml

@@ -23,7 +23,7 @@ jobs:
           tools: composer:v2
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 

.github/workflows/test_pull_request.yml

@@ -15,7 +15,7 @@ jobs:
           tools: composer:v2
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -63,12 +63,12 @@ jobs:
           tools: composer:v2
 
       - name: Set up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '14.x'
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -126,25 +126,25 @@ jobs:
           tools: composer:v2
 
       - name: Set up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '14.x'
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Run Composer
         run: composer install --no-interaction
 
       - name: Update PHPUnit for Code Coverage
-        run: composer require phpunit/phpunit:^9.6 phploc/phploc:* sebastian/version:* --with-all-dependencies
+        run: composer require phpunit/phpunit:^10.5 sebastian/version:* --with-all-dependencies
 
       - name: PHP Lint
         run: ./vendor/bin/parallel-lint src tests examples
 
       - name: Unit tests
         run: |
           mkdir -p build/logs
-          ./vendor/bin/phpunit ./tests/ --coverage-clover build/logs/clover.xml
+          ./vendor/bin/phpunit ./tests/ --coverage-clover build/logs/clover.xml --coverage-filter=./src/

.gitignore

@@ -1 +1,3 @@
 /vendor/
+composer.lock
+.php-version

README.md

@@ -149,40 +149,47 @@ This class treats basic matters of primes.
   // judge if all of $n are prime or not
   $n = [ 2, 3, 5, ];
   echo sprintf(
-      "Are all of [%s] prime? - %s.\n",
+      "Are all of [%s] prime? - %s.\n\n",
       implode(', ', $n),
       $p->isPrimeAll($n) ? 'Yes' : 'No'
   );
 
+  // a prime previous to $n
+  $n = 5;
+  echo sprintf("A prime previous to %d is %d.\n", $n, $p->previous($n));
+
   // a prime next to $n
   $n = 5;
-  echo sprintf("A prime next to %d is %d.\n", $n, $p->next($n));
+  echo sprintf("A prime next to %d is %d.\n\n", $n, $p->next($n));
 
   // primes between $a and $b
   $a = 6;
   $b = 14;
   echo sprintf(
-      "Primes between %d and %d are [%s].\n",
+      "Primes between %d and %d are [%s].\n\n",
       $a,
       $b,
       implode(', ', $p->between($a, $b))
   );
 
   // factorize
   $n = 1234567890;
-  echo sprintf("Factorize %d:\n", $n);
+  echo sprintf("Factorize %d:\n\n", $n);
+
   $r = $p->factorize($n);
   $l1 = $p->numberOfDigits(max(array_column($r, 0)));
   $l2 = $p->numberOfDigits(max(array_column($r, 1)));
   $s = str_repeat(' ', $l1 + 1);
   $b = $s . str_repeat('-', $l2);
+
   foreach ($r as $f) {
       echo (
           $f[0]
           ? sprintf("%" . $l1 . "d)%" . $l2 . "d\n%s\n", $f[0], $f[1], $b)
           : sprintf("%s%" . $l2 . "d\n", $s, $f[1])
       );
   }
+  echo "\n";
 
   // Factorized formula
   echo $n . " = " . $p->factorizedFormula($n)['formula'] . "\n";
@@ -193,9 +200,14 @@ This class treats basic matters of primes.
   ```
   Is 3 prime? - Yes.
   Are all of [2, 3, 5] prime? - Yes.
+
+  A prime previous to 5 is 3.
   A prime next to 5 is 7.
+
   Primes between 6 and 14 are [7, 11, 13].
+
   Factorize 1234567890:
+
     2)1234567890
       ----------
     3) 617283945
@@ -207,6 +219,7 @@ This class treats basic matters of primes.
   3607)  13717421
       ----------
             3803
+
   1234567890 = 2 * 3 ^ 2 * 5 * 3607 * 3803
   ```
 
@@ -216,6 +229,7 @@ This class treats basic matters of primes.
   |:---|:---|
   |`isPrime(int $n)`|judges if the param is prime or not|
   |`isPrimeAll(array $elements)`|judges if all of the param are prime or not|
+  |`previous(int $n)`|returns a prime previous to the param|
   |`next(int $n)`|returns a prime next to the param|
   |`between(int $a, int $b)`|returns array of primes between the params|
   |`factorize(int $n)`|factorize the param and returns the process as an array|
@@ -593,6 +607,6 @@ This class treats basic matters of Bezout's Identity.
 
 *Document Created: 2023/10/19*
 
-*Document Updated: 2024/03/16*
+*Document Updated: 2024/04/17*
 
 Copyright 2023 - 2024 macocci7

bin/TestAndLint.sh

@@ -55,7 +55,7 @@ test_and_lint() {
     echo "-----------------------------------------------------------"
     echo "[PHP $1][phpunit]"
     ./vendor/bin/phpunit ./tests/ \
-                         --color auto
+                         --color=auto
     echo "-----------------------------------------------------------"
 }
 

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "macocci7/php-math-integer",
-    "version": "1.1.1",
+    "version": "1.1.2",
     "description": "PHP Math Library of the subjects of number theory(only natural number).",
     "type": "library",
     "license": "MIT",
@@ -18,10 +18,9 @@
     "minimum-stability": "stable",
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.7",
-        "phpunit/phpunit": "^9.6",
+        "phpunit/phpunit": "^10.5",
         "phpmd/phpmd": "^2.15",
         "phpstan/phpstan": "^1.10",
-        "phploc/phploc": "^7.0",
         "php-parallel-lint/php-parallel-lint": "^1.3"
     }
 }

examples/UsePrime.php

@@ -13,40 +13,47 @@
 // judge if all of $n are prime or not
 $n = [ 2, 3, 5, ];
 echo sprintf(
-    "Are all of [%s] prime? - %s.\n",
+    "Are all of [%s] prime? - %s.\n\n",
     implode(', ', $n),
     $p->isPrimeAll($n) ? 'Yes' : 'No'
 );
 
+// a prime previous to $n
+$n = 5;
+echo sprintf("A prime previous to %d is %d.\n", $n, $p->previous($n));
+
 // a prime next to $n
 $n = 5;
-echo sprintf("A prime next to %d is %d.\n", $n, $p->next($n));
+echo sprintf("A prime next to %d is %d.\n\n", $n, $p->next($n));
 
 // primes between $a and $b
 $a = 6;
 $b = 14;
 echo sprintf(
-    "Primes between %d and %d are [%s].\n",
+    "Primes between %d and %d are [%s].\n\n",
     $a,
     $b,
     implode(', ', $p->between($a, $b))
 );
 
 // factorize
 $n = 1234567890;
-echo sprintf("Factorize %d:\n", $n);
+echo sprintf("Factorize %d:\n\n", $n);
+
 $r = $p->factorize($n);
 $l1 = $p->numberOfDigits(max(array_column($r, 0)));
 $l2 = $p->numberOfDigits(max(array_column($r, 1)));
 $s = str_repeat(' ', $l1 + 1);
 $b = $s . str_repeat('-', $l2);
+
 foreach ($r as $f) {
     echo (
         $f[0]
         ? sprintf("%" . $l1 . "d)%" . $l2 . "d\n%s\n", $f[0], $f[1], $b)
         : sprintf("%s%" . $l2 . "d\n", $s, $f[1])
     );
 }
+echo "\n";
 
 // Factorized formula
 echo $n . " = " . $p->factorizedFormula($n)['formula'] . "\n";

examples/UsePrime.txt

@@ -1,8 +1,13 @@
 Is 3 prime? - Yes.
 Are all of [2, 3, 5] prime? - Yes.
+
+A prime previous to 5 is 3.
 A prime next to 5 is 7.
+
 Primes between 6 and 14 are [7, 11, 13].
+
 Factorize 1234567890:
+
    2)1234567890
      ----------
    3) 617283945
@@ -14,4 +19,5 @@ Factorize 1234567890:
 3607)  13717421
      ----------
            3803
+
 1234567890 = 2 * 3 ^ 2 * 5 * 3607 * 3803

src/Prime.php

@@ -56,6 +56,23 @@ public function isPrimeAll(array $elements)
         return true;
     }
 
+    /**
+     * returns the previous prime
+     * @param   int     $n
+     * @return  int|null
+     */
+    public function previous(int $n)
+    {
+        if ($n <= 2) {
+            return null;
+        }
+        $i = $n - 1;
+        while (!$this->isPrime($i)) {
+            --$i;
+        }
+        return $i;
+    }
+
     /**
      * returns the next prime
      * @param   int     $n
@@ -65,7 +82,7 @@ public function next(int $n)
     {
         $i = $n > 1 ? $n + 1 : 2;
         while (!$this->isPrime($i)) {
-            $i++;
+            ++$i;
         }
         return $i;
     }
@@ -122,7 +139,7 @@ public function factorize(int $n)
                     break;
                 }
             }
-            $i++;
+            ++$i;
         }
         return $factors;
     }

tests/BezoutTest.php

@@ -6,6 +6,7 @@
 
 require_once('vendor/autoload.php');
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Macocci7\PhpMathInteger\Bezout;
 
@@ -34,9 +35,7 @@ public static function provide_set_can_throw_exception_with_invalid_param(): arr
         ];
     }
 
-    /**
-     * @dataProvider provide_set_can_throw_exception_with_invalid_param
-     */
+    #[DataProvider('provide_set_can_throw_exception_with_invalid_param')]
     public function test_set_can_throw_exception_with_invalid_param(array $param, string $message): void
     {
         $b = new Bezout();
@@ -53,9 +52,7 @@ public static function provide_set_can_set_coefficients_correctly(): array
         ];
     }
 
-    /**
-     * @dataProvider provide_set_can_set_coefficients_correctly
-     */
+    #[DataProvider('provide_set_can_set_coefficients_correctly')]
     public function test_set_can_set_coefficients_correctly(array $param, array $expect): void
     {
         $b = new Bezout();
@@ -74,9 +71,7 @@ public static function provide_clear_can_clear_coefficients_correctly(): array
         ];
     }
 
-    /**
-     * @dataProvider provide_clear_can_clear_coefficients_correctly
-     */
+    #[DataProvider('provide_clear_can_clear_coefficients_correctly')]
     public function test_clear_can_clear_coeffecients_correctly(array $preset, array $expect): void
     {
         $b = new Bezout($preset);
@@ -99,9 +94,7 @@ public static function provide_identity_can_return_identity_correctly(): array
         ];
     }
 
-    /**
-     * @dataProvider provide_identity_can_return_identity_correctly
-     */
+    #[DataProvider('provide_identity_can_return_identity_correctly')]
     public function test_identity_can_return_identity_correctly(array $preset, string|null $expect): void
     {
         $b = new Bezout($preset);
@@ -130,9 +123,7 @@ public static function provide_isSolvable_can_judge_correctly(): array
         ];
     }
 
-    /**
-     * @dataProvider provide_isSolvable_can_judge_correctly
-     */
+    #[DataProvider('provide_isSolvable_can_judge_correctly')]
     public function test_isSolvable_can_judge_correctly(int|null $a, int|null $b, int|null $c, bool $expect): void
     {
         $bz = new Bezout();
@@ -153,9 +144,7 @@ public static function provide_solution_can_return_a_solution_set_correctly(): a
         ];
     }
 
-    /**
-     * @dataProvider provide_solution_can_return_a_solution_set_correctly
-     */
+    #[DataProvider('provide_solution_can_return_a_solution_set_correctly')]
     public function test_solution_can_return_a_solution_set_correctly(array $preset, array $expect): void
     {
         $b = new Bezout();
@@ -203,9 +192,7 @@ public static function provide_generalSolution_can_return_general_solution_corre
         ];
     }
 
-    /**
-     * @dataProvider provide_generalSolution_can_return_general_solution_correctly
-     */
+    #[DataProvider('provide_generalSolution_can_return_general_solution_correctly')]
     public function test_generalSolution_can_return_general_solution_correctly(array $preset, array $expect): void
     {
         $b = new Bezout();