Merge branch 'v1.0.1'

Author: othyn

README.md

@@ -10,8 +10,8 @@ A [Composer](https://getcomposer.org/) package for [PHP](https://www.php.net/) t
 The package so far provides;
 
 - A handy trait that extends PHP's native Enum type
-- Adds a new static `valueArray(): array` method that returns all values within an Enum as an equally typed array of Enum values
-- Adds a new static `valueList(string $separator = ', '): string` method that returns all values within an Enum as a comma separated list string
+- Adds a new static `UnitEnum::valueArray(): array` method that returns all values within an Enum as an equally typed array of Enum values
+- Adds a new static `UnitEnum::valueList(string $separator = ', '): string` method that returns all values within an Enum as a comma separated list string
 
 The package is available on Packagist as [othyn/php-enum-enhancements](https://packagist.org/packages/othyn/php-enum-enhancements).
 
@@ -51,17 +51,21 @@ enum TestEnum
     case Echo;
 }
 
-print_r(TestEnum::valueArray());
+var_dump(TestEnum::valueArray());
 
 // Results in the following being printed:
-// Array
-// (
-//     [0] => Alpha
-//     [1] => Bravo
-//     [2] => Charlie
-//     [3] => Delta
-//     [4] => Echo
-// )
+// array(5) {
+//   [0]=>
+//   string(5) "Alpha"
+//   [1]=>
+//   string(5) "Bravo"
+//   [2]=>
+//   string(7) "Charlie"
+//   [3]=>
+//   string(5) "Delta"
+//   [4]=>
+//   string(4) "Echo"
+// }
 ```
 
 ### Enum: Value List
@@ -84,15 +88,15 @@ enum TestEnum
     case Echo;
 }
 
-print_r(TestEnum::valueList());
+var_dump(TestEnum::valueList());
 
 // Results in the following being printed:
-// 'Alpha, Bravo, Charlie, Delta, Echo'
+// string(34) "Alpha, Bravo, Charlie, Delta, Echo"
 
-print_r(TestEnum::valueList(separator: ':'));
+var_dump(TestEnum::valueList(separator: ':'));
 
 // Results in the following being printed:
-// 'Alpha:Bravo:Charlie:Delta:Echo'
+// string(30) "Alpha:Bravo:Charlie:Delta:Echo"
 ```
 
 ### Backed String Enum: Value Array
@@ -115,17 +119,21 @@ enum TestStringBackedEnum: string
     case Echo    = 'echo';
 }
 
-print_r(TestStringBackedEnum::valueArray());
+var_dump(TestStringBackedEnum::valueArray());
 
 // Results in the following being printed:
-// Array
-// (
-//     [0] => alpha
-//     [1] => bravo
-//     [2] => charlie
-//     [3] => delta
-//     [4] => echo
-// )
+// array(5) {
+//   [0]=>
+//   string(5) "alpha"
+//   [1]=>
+//   string(5) "bravo"
+//   [2]=>
+//   string(7) "charlie"
+//   [3]=>
+//   string(5) "delta"
+//   [4]=>
+//   string(4) "echo"
+// }
 ```
 
 ### Backed String Enum: Value List
@@ -148,15 +156,15 @@ enum TestStringBackedEnum: string
     case Echo    = 'echo';
 }
 
-print_r(TestStringBackedEnum::valueList());
+var_dump(TestStringBackedEnum::valueList());
 
 // Results in the following being printed:
-// 'alpha, bravo, charlie, delta, echo'
+// string(34) "alpha, bravo, charlie, delta, echo"
 
-print_r(TestStringBackedEnum::valueList(separator: ':'));
+var_dump(TestStringBackedEnum::valueList(separator: ':'));
 
 // Results in the following being printed:
-// 'alpha:bravo:charlie:delta:echo'
+// string(30) "alpha:bravo:charlie:delta:echo"
 ```
 
 ### Backed Int Enum: Value Array
@@ -179,17 +187,21 @@ enum TestIntBackedEnum: int
     case Five  = 5;
 }
 
-print_r(TestIntBackedEnum::valueArray());
+var_dump(TestIntBackedEnum::valueArray());
 
 // Results in the following being printed:
-// Array
-// (
-//     [0] => 1
-//     [1] => 2
-//     [2] => 3
-//     [3] => 4
-//     [4] => 5
-// )
+// array(5) {
+//   [0]=>
+//   int(1)
+//   [1]=>
+//   int(2)
+//   [2]=>
+//   int(3)
+//   [3]=>
+//   int(4)
+//   [4]=>
+//   int(5)
+// }
 ```
 
 ### Backed Int Enum: Value List
@@ -212,15 +224,15 @@ enum TestIntBackedEnum: int
     case Five  = 5;
 }
 
-print_r(TestIntBackedEnum::valueList());
+var_dump(TestIntBackedEnum::valueList());
 
 // Results in the following being printed:
-// '1, 2, 3, 4, 5'
+// string(13) "1, 2, 3, 4, 5"
 
-print_r(TestIntBackedEnum::valueList(separator: ':'));
+var_dump(TestIntBackedEnum::valueList(separator: ':'));
 
 // Results in the following being printed:
-// '1:2:3:4:5'
+// string(9) "1:2:3:4:5"
 ```
 
 ---
@@ -275,7 +287,31 @@ composer docker-shell
 
 ## Changelog
 
-Any and all project changes for releases should be documented below. Versioning follows the SEMVER standard.
+Any and all project changes for releases should be documented below. Versioning follows the [SemVer](https://semver.org/) standard.
+
+---
+
+### Version 1.0.1
+
+[[Git Changes]](https://github.com/othyn/php-enum-enhancements/compare/v1.0.0...v1.0.1) TBD.
+
+#### Added
+
+- Everything
+
+#### Changed
+
+- SemVer verbiage and link change in the README.
+- Change usage examples in the readme to instead utilise `var_dump` to demonstrate the resulting types within the array returned from `UnitEnum::valueArray()`.
+- Utilised the `UnitEnum` base type within the docs in code examples where a test Enum is not present.
+
+#### Fixed
+
+- Everything
+
+#### Removed
+
+- Nothing
 
 ---
 

test_coverage/html/EnumEnhancements.php.html

@@ -183,7 +183,7 @@
     <h4>Legend</h4>
     <p><span class="success"><strong>Executed</strong></span><span class="danger"><strong>Not Executed</strong></span><span class="warning"><strong>Dead Code</strong></span></p>
     <p>
-     <small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 9.2.10</a> using <a href="https://secure.php.net/" target="_top">PHP 8.1.2</a> and <a href="https://phpunit.de/">PHPUnit 9.5.13</a> at Tue Feb 15 18:46:59 UTC 2022.</small>
+     <small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 9.2.10</a> using <a href="https://secure.php.net/" target="_top">PHP 8.1.2</a> and <a href="https://phpunit.de/">PHPUnit 9.5.13</a> at Tue Feb 15 19:12:57 UTC 2022.</small>
     </p>
     <a title="Back to the top" id="toplink" href="#">
         <svg xmlns="http://www.w3.org/2000/svg" width="12" height="16" viewBox="0 0 12 16"><path fill-rule="evenodd" d="M12 11L6 5l-6 6h12z"/></svg>

test_coverage/html/dashboard.html

@@ -135,7 +135,7 @@ <h3>Project Risks</h3>
    <footer>
     <hr/>
     <p>
-     <small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 9.2.10</a> using <a href="https://secure.php.net/" target="_top">PHP 8.1.2</a> and <a href="https://phpunit.de/">PHPUnit 9.5.13</a> at Tue Feb 15 18:46:59 UTC 2022.</small>
+     <small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 9.2.10</a> using <a href="https://secure.php.net/" target="_top">PHP 8.1.2</a> and <a href="https://phpunit.de/">PHPUnit 9.5.13</a> at Tue Feb 15 19:12:57 UTC 2022.</small>
     </p>
    </footer>
   </div>

test_coverage/html/index.html

@@ -110,7 +110,7 @@ <h4>Legend</h4>
      <span class="success"><strong>High</strong>: 90% to 100%</span>
     </p>
     <p>
-     <small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 9.2.10</a> using <a href="https://secure.php.net/" target="_top">PHP 8.1.2</a> and <a href="https://phpunit.de/">PHPUnit 9.5.13</a> at Tue Feb 15 18:46:59 UTC 2022.</small>
+     <small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 9.2.10</a> using <a href="https://secure.php.net/" target="_top">PHP 8.1.2</a> and <a href="https://phpunit.de/">PHPUnit 9.5.13</a> at Tue Feb 15 19:12:57 UTC 2022.</small>
     </p>
    </footer>
   </div>

test_coverage/report.txt

@@ -1,7 +1,7 @@
 
 
 Code Coverage Report:   
-  2022-02-15 18:46:59   
+  2022-02-15 19:12:57   
 
  Summary:               
   Classes: 100.00% (1/1)

test_coverage/report.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1644950819">
-  <project timestamp="1644950819">
+<coverage generated="1644952377">
+  <project timestamp="1644952377">
     <file name="/testing/src/Traits/EnumEnhancements.php">
       <class name="Othyn\PhpEnumEnhancements\Traits\EnumEnhancements" namespace="global">
         <metrics complexity="3" methods="2" coveredmethods="2" conditionals="0" coveredconditionals="0" statements="4" coveredstatements="4" elements="6" coveredelements="6"/>

tests/Feature/ItExtendsIntBackedEnumsTest.php

@@ -17,6 +17,7 @@ public function test_it_can_produce_a_value_array_for_an_int_backed_enum(): void
 
     public function test_it_can_produce_a_value_list_for_an_int_backed_enum(): void
     {
+        var_dump(TestIntBackedEnum::valueList());
         $this->assertSame(
             TestIntBackedEnum::valueList(),
             '1, 2, 3, 4, 5'
@@ -25,6 +26,7 @@ public function test_it_can_produce_a_value_list_for_an_int_backed_enum(): void
 
     public function test_it_can_produce_a_value_list_with_a_custom_separator_for_an_enum(): void
     {
+        var_dump(TestIntBackedEnum::valueList(separator: ':'));
         $this->assertSame(
             TestIntBackedEnum::valueList(separator: ':'),
             '1:2:3:4:5'