feat: modernize

.gitignore

@@ -4,3 +4,4 @@ vendor/
 .DS_Store
 composer.lock
 phpunit.xml
+.phpunit.result.cache

README.md

@@ -16,7 +16,7 @@ without affecting the memory footprint.
 Via Composer
 
 ``` bash
-$ composer require th3n3rd/cartesian-product
+$ composer require "th3n3rd/cartesian-product"
 ```
 
 ## Usage
@@ -28,18 +28,18 @@ use Nerd\CartesianProduct\CartesianProduct;
 $cartesianProduct = new CartesianProduct();
 
 $cartesianProduct
-    ->appendSet(array('a', 'b', 'c'))
-    ->appendSet(array('d', 'e'))
-    ->appendSet(array('f', 'g', 'h'))
-    ->appendSet(array('i', 'j'))
-    ->appendSet(array('k', 'l'))
-    ->appendSet(array('m', 'n'))
-    ->appendSet(array('o'))
-    ->appendSet(array('p'))
-    ->appendSet(array('q', 'r', 's', 't'))
-    ->appendSet(array('u', 'v', 'w'))
-    ->appendSet(array('x', 'y'))
-    ->appendSet(array('z'))
+    ->appendSet(['a', 'b', 'c'])
+    ->appendSet(['d', 'e'])
+    ->appendSet(['f', 'g', 'h'])
+    ->appendSet(['i', 'j'])
+    ->appendSet(['k', 'l'])
+    ->appendSet(['m', 'n'])
+    ->appendSet(['o'])
+    ->appendSet(['p'])
+    ->appendSet(['q', 'r', 's', 't'])
+    ->appendSet(['u', 'v', 'w'])
+    ->appendSet(['x', 'y'])
+    ->appendSet(['z'])
 ;
 
 foreach ($cartesianProduct as $index => $product) {
@@ -58,7 +58,7 @@ foreach ($result as $index => $product) {
 ## Testing
 
 ``` bash
-$ phpunit
+$ vendor/bin/phpunit
 ```
 
 ## License

composer.json

@@ -10,11 +10,11 @@
         }
     ],
     "require": {
-        "php": ">=5.3.3"
+        "php": ">=8.0"
     },
     "require-dev": {
-        "devster/ubench": "~1.1",
-        "phpunit/phpunit": "~4.4"
+        "devster/ubench": "^2.1",
+        "phpunit/phpunit": "^9.6.17"
     },
     "autoload": {
         "psr-4": {

examples/iterator.php

@@ -17,18 +17,18 @@
 $cartesianProduct = new CartesianProduct();
 
 $cartesianProduct
-    ->appendSet(array('a', 'b', 'c'))
-    ->appendSet(array('d', 'e'))
-    ->appendSet(array('f', 'g', 'h'))
-    ->appendSet(array('i', 'j'))
-    ->appendSet(array('k', 'l'))
-    ->appendSet(array('m', 'n'))
-    ->appendSet(array('o'))
-    ->appendSet(array('p'))
-    ->appendSet(array('q', 'r', 's', 't'))
-    ->appendSet(array('u', 'v', 'w'))
-    ->appendSet(array('x', 'y'))
-    ->appendSet(array('z'))
+    ->appendSet(['a', 'b', 'c'])
+    ->appendSet(['d', 'e'])
+    ->appendSet(['f', 'g', 'h'])
+    ->appendSet(['i', 'j'])
+    ->appendSet(['k', 'l'])
+    ->appendSet(['m', 'n'])
+    ->appendSet(['o'])
+    ->appendSet(['p'])
+    ->appendSet(['q', 'r', 's', 't'])
+    ->appendSet(['u', 'v', 'w'])
+    ->appendSet(['x', 'y'])
+    ->appendSet(['z'])
 ;
 
 $bench->start();
@@ -38,4 +38,4 @@
 $bench->end();
 
 printf("Time elapsed: %s\n", $bench->getTime());
-printf("Memory footprint: %s\n", $bench->getMemoryPeak());
+printf("Memory footprint: %s\n", $bench->getMemoryPeak());

examples/memory-usage-comparison.php

@@ -17,18 +17,18 @@
 $cartesianProduct = new CartesianProduct();
 
 $cartesianProduct
-    ->appendSet(array('a', 'b', 'c'))
-    ->appendSet(array('d', 'e'))
-    ->appendSet(array('f', 'g', 'h'))
-    ->appendSet(array('i', 'j'))
-    ->appendSet(array('k', 'l'))
-    ->appendSet(array('m', 'n'))
-    ->appendSet(array('o'))
-    ->appendSet(array('p'))
-    ->appendSet(array('q', 'r', 's', 't'))
-    ->appendSet(array('u', 'v', 'w'))
-    ->appendSet(array('x', 'y'))
-    ->appendSet(array('z'))
+    ->appendSet(['a', 'b', 'c'])
+    ->appendSet(['d', 'e'])
+    ->appendSet(['f', 'g', 'h'])
+    ->appendSet(['i', 'j'])
+    ->appendSet(['k', 'l'])
+    ->appendSet(['m', 'n'])
+    ->appendSet(['o'])
+    ->appendSet(['p'])
+    ->appendSet(['q', 'r', 's', 't'])
+    ->appendSet(['u', 'v', 'w'])
+    ->appendSet(['x', 'y'])
+    ->appendSet(['z'])
 ;
 
 $bench->start();
@@ -52,4 +52,4 @@
 printf("Memory Usage Comparison: \n");
 printf("Whole -> %s\n", $wholeUseCase);
 printf("Iterator -> %s\n", $iteratorUseCase);
-printf("Ratio: 1:%s (whole vs iterator) \n", ceil($iteratorUseCaseBytes / $wholeUseCaseBytes * 100));
+printf("Ratio: 1:%s (whole vs iterator) \n", ceil($iteratorUseCaseBytes / $wholeUseCaseBytes * 100));

examples/whole-result.php

@@ -17,18 +17,18 @@
 $cartesianProduct = new CartesianProduct();
 
 $cartesianProduct
-    ->appendSet(array('a', 'b', 'c'))
-    ->appendSet(array('d', 'e'))
-    ->appendSet(array('f', 'g', 'h'))
-    ->appendSet(array('i', 'j'))
-    ->appendSet(array('k', 'l'))
-    ->appendSet(array('m', 'n'))
-    ->appendSet(array('o'))
-    ->appendSet(array('p'))
-    ->appendSet(array('q', 'r', 's', 't'))
-    ->appendSet(array('u', 'v', 'w'))
-    ->appendSet(array('x', 'y'))
-    ->appendSet(array('z'))
+    ->appendSet(['a', 'b', 'c'])
+    ->appendSet(['d', 'e'])
+    ->appendSet(['f', 'g', 'h'])
+    ->appendSet(['i', 'j'])
+    ->appendSet(['k', 'l'])
+    ->appendSet(['m', 'n'])
+    ->appendSet(['o'])
+    ->appendSet(['p'])
+    ->appendSet(['q', 'r', 's', 't'])
+    ->appendSet(['u', 'v', 'w'])
+    ->appendSet(['x', 'y'])
+    ->appendSet(['z'])
 ;
 
 $bench->start();
@@ -39,4 +39,4 @@
 $bench->end();
 
 printf("Time elapsed: %s\n", $bench->getTime());
-printf("Memory footprint: %s\n", $bench->getMemoryPeak());
+printf("Memory footprint: %s\n", $bench->getMemoryPeak());

phpunit.xml.dist

@@ -1,13 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit colors="true" bootstrap="vendor/autoload.php">
-    <testsuites>
-        <testsuite name="Cartesian Product 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"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+>
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+
+  <testsuites>
+    <testsuite name="Cartesian Product Test Suite">
+      <directory>tests/</directory>
+    </testsuite>
+  </testsuites>
+
 </phpunit>

src/CartesianProduct.php

@@ -16,25 +16,12 @@
  */
 class CartesianProduct implements \Iterator
 {
-    /**
-     * @var array
-     */
-    private $sets = array();
+    private array $sets = [];
+    private \Iterator $referenceSet;
 
-    /**
-     * @var \Iterator
-     */
-    private $referenceSet;
+    private int $cursor = 0;
 
-    /**
-     * @var integer
-     */
-    private $cursor = 0;
-
-    /**
-     * @param array $sets
-     */
-    public function __construct(array $sets = array())
+    public function __construct(array $sets = [])
     {
         foreach ($sets as $set) {
             $this->addSet($set);
@@ -46,11 +33,9 @@ public function __construct(array $sets = array())
     /**
      * Adds a set.
      *
-     * @param array|Traversable $set
-     *
      * @throws \InvalidArgumentException
      */
-    private function addSet($set)
+    private function addSet(iterable $set): void
     {
         if (is_array($set)) {
             $set = new \ArrayIterator($set);
@@ -66,13 +51,11 @@ private function addSet($set)
     /**
      * Appends the given set.
      *
-     * @param array|Traversable $set
-     *
      * @return $this
      *
      * @throws \InvalidArgumentException
      */
-    public function appendSet($set)
+    public function appendSet(iterable $set): static
     {
         $this->addSet($set);
         $this->computeReferenceSet();
@@ -83,7 +66,7 @@ public function appendSet($set)
     /**
      * Computes the reference set used for iterate over the product.
      */
-    private function computeReferenceSet()
+    private function computeReferenceSet(): void
     {
         if (empty($this->sets)) {
             return;
@@ -100,7 +83,7 @@ private function computeReferenceSet()
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         $current = $this->referenceSet->current();
 
@@ -110,7 +93,7 @@ public function current()
     /**
      * {@inheritdoc}
      */
-    public function next()
+    public function next(): void
     {
         $this->cursor++;
         $this->referenceSet->next();
@@ -119,23 +102,23 @@ public function next()
     /**
      * {@inheritdoc}
      */
-    public function key()
+    public function key(): mixed
     {
         return $this->cursor;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function valid()
+    public function valid(): bool
     {
         return $this->referenceSet->valid();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->cursor = 0;
         $this->referenceSet->rewind();
@@ -149,9 +132,9 @@ public function rewind()
      * The recommended way to use the Cartesian Product is through its iterator interface
      * which is memory efficient.
      */
-    public function compute()
+    public function compute(): array
     {
-        $product = array();
+        $product = [];
 
         $this->referenceSet->rewind();