None should return never not null (#42)

Signed-off-by: Nathanael Esayeas <nathanael.esayeas@protonmail.com>
ghostwriter · Jul 5, 2023 · e3b4db3 · e3b4db3
2 parents 4c72580 + 461fae3
commit e3b4db3
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ interface SomeInterface extends OptionInterface
 /**
  * @immutable
  *
- * @template TNone of null
+ * @template TNone of never
  *
  * @extends OptionInterface<TNone>
  */

diff --git a/src/AbstractOption.php b/src/AbstractOption.php
@@ -7,19 +7,16 @@
 use Generator;
 use Ghostwriter\Option\Exception\NullPointerException;
 use Ghostwriter\Option\Exception\OptionException;
-use Ghostwriter\Option\Tests\Unit\NoneTest;
-use Ghostwriter\Option\Tests\Unit\OptionTest;
-use Ghostwriter\Option\Tests\Unit\SomeTest;
 use Throwable;
 
 /**
  * @template TOption
  *
  * @implements OptionInterface<TOption>
  *
- * @see OptionTest
- * @see SomeTest
- * @see NoneTest
+ * @see \Ghostwriter\Option\Tests\Unit\OptionTest
+ * @see \Ghostwriter\Option\Tests\Unit\SomeTest
+ * @see \Ghostwriter\Option\Tests\Unit\NoneTest
  */
 abstract class AbstractOption implements OptionInterface
 {

diff --git a/src/None.php b/src/None.php
@@ -4,16 +4,14 @@
 
 namespace Ghostwriter\Option;
 
-use Ghostwriter\Option\Tests\Unit\NoneTest;
-
 /**
- * @template TNone of null
+ * @template TNone of never
  *
  * @extends AbstractOption<TNone>
  *
  * @implements NoneInterface<TNone>
  *
- * @see NoneTest
+ * @see \Ghostwriter\Option\Tests\Unit\NoneTest
  */
 final class None extends AbstractOption implements NoneInterface
 {
@@ -22,6 +20,9 @@ final class None extends AbstractOption implements NoneInterface
     /** @return self<TNone> */
     public static function create(): self
     {
-        return self::$none ??= new self(null);
+        /** @var TNone $none */
+        $none = null;
+
+        return self::$none ??= new self($none);
     }
 }
diff --git a/src/NoneInterface.php b/src/NoneInterface.php
@@ -7,7 +7,7 @@
 /**
  * @immutable
  *
- * @template TNone of null
+ * @template TNone of never
  *
  * @extends OptionInterface<TNone>
  */

diff --git a/src/Option.php b/src/Option.php
@@ -4,7 +4,9 @@
 
 namespace Ghostwriter\Option;
 
-/** @see OptionTest */
+/**
+ * @see \Ghostwriter\Option\Tests\Unit\OptionTest
+ */
 final class Option
 {
     /**

diff --git a/src/Some.php b/src/Some.php
@@ -5,7 +5,6 @@
 namespace Ghostwriter\Option;
 
 use Ghostwriter\Option\Exception\NullPointerException;
-use Ghostwriter\Option\Tests\Unit\SomeTest;
 
 /**
  * @template TSome
@@ -14,7 +13,7 @@
  *
  * @implements SomeInterface<TSome>
  *
- * @see SomeTest
+ * @see \Ghostwriter\Option\Tests\Unit\SomeTest
  */
 final class Some extends AbstractOption implements SomeInterface
 {

diff --git a/tests/Unit/NoneTest.php b/tests/Unit/NoneTest.php
@@ -28,7 +28,9 @@
 final class NoneTest extends TestCase
 {
     /**
-     * @return Generator<array-key, array{0:class-string,1:mixed}>
+     * @template TNone of null
+     *
+     * @return Generator<array-key, array{0:class-string<NoneInterface>,1:None|TNone}>
      */
     public static function ofDataProvider(): Generator
     {