From 949337ccbb3747870f83d06adbeafe8b998a9f09 Mon Sep 17 00:00:00 2001
From: Joby Elliott <code@byjoby.com>
Date: Sat, 3 Dec 2022 11:01:45 -0700
Subject: [PATCH] starting work on modernizing everything for v1.5

---
 .github/workflows/phpstan.yml          | 14 +++++++++++
 .github/workflows/phpunit.yml          | 11 +++++++++
 .gitignore                             |  6 +++--
 composer.json                          | 20 ++++++++--------
 phpstan.neon                           |  4 ++++
 phpunit.xml                            | 32 ++++++++++++++++++++++----
 src/Config/Config.php                  |  2 +-
 src/Config/ConfigInterface.php         |  2 +-
 src/FlatArray.php                      |  2 +-
 src/FlatArrayInterface.php             | 12 ++++++++--
 src/FlatArrayTrait.php                 | 26 ++++++++++-----------
 src/SelfReferencingFlatArray.php       | 14 ++---------
 tests/Config/ConfigTest.php            |  2 +-
 tests/FlatArrayPushPopTest.php         |  2 +-
 tests/FlatArrayTest.php                |  2 +-
 tests/SelfReferencingFlatArrayTest.php |  2 +-
 16 files changed, 104 insertions(+), 49 deletions(-)
 create mode 100644 .github/workflows/phpstan.yml
 create mode 100644 .github/workflows/phpunit.yml
 create mode 100644 phpstan.neon

diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
new file mode 100644
index 0000000..45f5e23
--- /dev/null
+++ b/.github/workflows/phpstan.yml
@@ -0,0 +1,14 @@
+name: phpstan
+on: push
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: php-actions/composer@v6
+        with:
+          dev: yes
+      - uses: php-actions/phpstan@v3
+        with:
+          memory_limit: 1G
+          args: --memory-limit 1G
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
new file mode 100644
index 0000000..c5a182c
--- /dev/null
+++ b/.github/workflows/phpunit.yml
@@ -0,0 +1,11 @@
+name: phpunit
+on: push
+jobs:
+  phpunit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: php-actions/composer@v6
+        with:
+          dev: yes
+      - uses: php-actions/phpunit@v3
diff --git a/.gitignore b/.gitignore
index 3a9875b..82dac7f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
-/vendor/
-composer.lock
+/vendor
+/composer.lock
+/.phpunit.result.cache
+/coverage
\ No newline at end of file
diff --git a/composer.json b/composer.json
index 66585af..88dadc1 100644
--- a/composer.json
+++ b/composer.json
@@ -3,12 +3,15 @@
   "description": "A library for working with multi-dimensional arrays through flattened keys",
   "type": "library",
   "license": "MIT",
-  "authors": [{
-    "name": "Joby Elliott",
-    "email": "joby@byjoby.com"
-  }],
+  "authors": [
+    {
+      "name": "Joby Elliott",
+      "email": "joby@byjoby.com"
+    }
+  ],
   "require-dev": {
-    "phpunit/phpunit": "^7.3"
+    "phpunit/phpunit": "^9.5",
+    "phpstan/phpstan": "^1.9"
   },
   "autoload": {
     "psr-4": {
@@ -21,12 +24,11 @@
     }
   },
   "scripts": {
-    "test": [
-      "phpunit"
-    ]
+    "test": "phpunit",
+    "stan": "phpstan"
   },
   "require": {
-    "php": ">=7.1",
+    "php": ">=8.1",
     "mustangostang/spyc": "^0.6.3"
   }
 }
diff --git a/phpstan.neon b/phpstan.neon
new file mode 100644
index 0000000..faa90c7
--- /dev/null
+++ b/phpstan.neon
@@ -0,0 +1,4 @@
+parameters:
+  level: 1
+  paths:
+    - src
\ No newline at end of file
diff --git a/phpunit.xml b/phpunit.xml
index 89c010e..bc2f7c1 100644
--- a/phpunit.xml
+++ b/phpunit.xml
@@ -1,7 +1,31 @@
-<phpunit bootstrap="vendor/autoload.php">
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+  colors="true"
+  executionOrder="random"
+  failOnWarning="true"
+  failOnRisky="true"
+  failOnEmptyTestSuite="true"
+  beStrictAboutOutputDuringTests="true"
+  verbose="true"
+  bootstrap="vendor/autoload.php">
+  <php>
+    <ini name="display_errors" value="On" />
+    <ini name="error_reporting" value="-1" />
+    <ini name="xdebug.mode" value="coverage" />
+  </php>
   <testsuites>
-    <testsuite name="All">
-      <directory>tests</directory>
+    <testsuite name="Tests">
+      <directory>tests/</directory>
     </testsuite>
   </testsuites>
-</phpunit>
+  <coverage>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <report>
+      <html outputDirectory="coverage" lowUpperBound="50" highLowerBound="90" />
+    </report>
+  </coverage>
+</phpunit>
\ No newline at end of file
diff --git a/src/Config/Config.php b/src/Config/Config.php
index 33c5987..cfb66a7 100644
--- a/src/Config/Config.php
+++ b/src/Config/Config.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 
 namespace Flatrr\Config;
 
diff --git a/src/Config/ConfigInterface.php b/src/Config/ConfigInterface.php
index 5fff574..867ba34 100644
--- a/src/Config/ConfigInterface.php
+++ b/src/Config/ConfigInterface.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 namespace Flatrr\Config;
 
 interface ConfigInterface extends \ArrayAccess
diff --git a/src/FlatArray.php b/src/FlatArray.php
index 289624a..5619a33 100644
--- a/src/FlatArray.php
+++ b/src/FlatArray.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 namespace Flatrr;
 
 class FlatArray implements FlatArrayInterface
diff --git a/src/FlatArrayInterface.php b/src/FlatArrayInterface.php
index f4da1ef..d8ae79b 100644
--- a/src/FlatArrayInterface.php
+++ b/src/FlatArrayInterface.php
@@ -1,8 +1,16 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
+
 namespace Flatrr;
 
-interface FlatArrayInterface extends \ArrayAccess, \Iterator
+use ArrayAccess;
+use Iterator;
+
+/** 
+ * @extends ArrayAccess<string|mixed>
+ * @extends Iterator<string|mixed>
+ */
+interface FlatArrayInterface extends ArrayAccess, Iterator
 {
     public function set(?string $name, $value);
     public function get(?string $name = null);
diff --git a/src/FlatArrayTrait.php b/src/FlatArrayTrait.php
index 3225986..8e49847 100644
--- a/src/FlatArrayTrait.php
+++ b/src/FlatArrayTrait.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 
 namespace Flatrr;
 
@@ -71,47 +71,47 @@ trait FlatArrayTrait
         $this->flattenSearch($name, null, true);
     }
 
-    public function offsetSet($name, $value)
+    public function offsetSet($name, $value): void
     {
-        return $this->set($name, $value);
+        $this->set($name, $value);
     }
 
-    public function offsetGet($name)
+    public function offsetGet($name): mixed
     {
         return $this->get($name);
     }
 
-    public function offsetExists($name)
+    public function offsetExists($name): bool
     {
         return $this->flattenSearch($name) !== null;
     }
 
-    public function offsetUnset($name)
+    public function offsetUnset($name): void
     {
         $this->unset($name);
     }
 
-    public function rewind()
+    public function rewind(): void
     {
-        return reset($this->_arrayData);
+        reset($this->_arrayData);
     }
 
-    public function current()
+    public function current(): mixed
     {
         return current($this->_arrayData);
     }
 
-    public function next()
+    public function next(): void
     {
-        return next($this->_arrayData);
+        next($this->_arrayData);
     }
 
-    public function key()
+    public function key(): null|string
     {
         return key($this->_arrayData);
     }
 
-    public function valid()
+    public function valid(): bool
     {
         return isset($this->_arrayData[$this->key()]);
     }
diff --git a/src/SelfReferencingFlatArray.php b/src/SelfReferencingFlatArray.php
index be12251..542d3ed 100644
--- a/src/SelfReferencingFlatArray.php
+++ b/src/SelfReferencingFlatArray.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 
 namespace Flatrr;
 
@@ -46,17 +46,7 @@ class SelfReferencingFlatArray extends FlatArray
         return $this->filter(parent::shift($name));
     }
 
-    public function rewind()
-    {
-        return $this->filter(parent::rewind());
-    }
-
-    public function next()
-    {
-        return $this->filter(parent::next());
-    }
-
-    public function current()
+    public function current(): mixed
     {
         return $this->filter(parent::current());
     }
diff --git a/tests/Config/ConfigTest.php b/tests/Config/ConfigTest.php
index 54edc70..3f6a0ad 100644
--- a/tests/Config/ConfigTest.php
+++ b/tests/Config/ConfigTest.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 declare(strict_types=1);
 namespace Flatrr\Config;
 
diff --git a/tests/FlatArrayPushPopTest.php b/tests/FlatArrayPushPopTest.php
index 5acdaf2..8bc4508 100644
--- a/tests/FlatArrayPushPopTest.php
+++ b/tests/FlatArrayPushPopTest.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 declare(strict_types=1);
 namespace Flatrr;
 
diff --git a/tests/FlatArrayTest.php b/tests/FlatArrayTest.php
index 81b42db..22e87ad 100644
--- a/tests/FlatArrayTest.php
+++ b/tests/FlatArrayTest.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 declare(strict_types=1);
 namespace Flatrr;
 
diff --git a/tests/SelfReferencingFlatArrayTest.php b/tests/SelfReferencingFlatArrayTest.php
index 7e3b35c..037c1e5 100644
--- a/tests/SelfReferencingFlatArrayTest.php
+++ b/tests/SelfReferencingFlatArrayTest.php
@@ -1,5 +1,5 @@
 <?php
-/* Flatrr | https://gitlab.com/byjoby/flatrr | MIT License */
+/* Flatrr | https://github.com/jobyone/flatrr | MIT License */
 declare(strict_types=1);
 namespace Flatrr;