Merge pull request #59 from MaxGoryunov/feature/51

Feature/51

fakes/Let.php

@@ -10,7 +10,7 @@
  * 
  * @todo #44:25min Classes Let and The contain some repeated cdde which could
  *  be extracted into a separate class.
- * @template x subject type
+ * @template X subject type
  * @template Y result type
  * @implements \MaxGoryunov\SavingIterator\Src\Scalar<Y>
  */
@@ -20,21 +20,21 @@ class Let implements Scalar
     /**
      * Ctor.
      * 
-     * @param mixed   $subject
-     * @param Closure $context
+     * @param X             $subject
+     * @param Closure(X): Y $context
      */
     public function __construct(
         /**
          * Element to be put into the context.
          * 
-         * @var mixed
+         * @var X
          */
         private mixed $subject,
 
         /**
          * Context for the element.
          * 
-         * @var Closure
+         * @var Closure(X): Y
          */
         private Closure $context
     ) {
@@ -43,7 +43,7 @@ public function __construct(
     /**
      * Returns result of applying context to element.
      *
-     * @return mixed
+     * @return Y
      */
     public function value(): mixed
     {

fakes/The.php

@@ -8,9 +8,6 @@
 /**
  * Class for applying contexts to elements without changing them.
  * 
- * @todo #44:20min Classes Let and The do not have proper type hints in
- *  constructor and methods. Workarounds with `@var` tags must be removed
- *  after that.
  * @template T subject type
  * @implements \MaxGoryunov\SavingIterator\Src\Scalar<T>
  */
@@ -20,21 +17,21 @@ class The implements Scalar
     /**
      * Ctor.
      * 
-     * @param mixed   $subject
-     * @param Closure $context
+     * @param T                 $subject
+     * @param Closure(T): mixed $context
      */
     public function __construct(
         /**
          * Element to be put into the context.
          * 
-         * @var mixed
+         * @var T
          */
         private mixed $subject,
 
         /**
          * Context for the element.
          * 
-         * @var Closure
+         * @var Closure(T): mixed
          */
         private Closure $context
     ) {
@@ -43,7 +40,7 @@ public function __construct(
     /**
      * Applies context to subject and returns subject.
      *
-     * @return mixed
+     * @return T
      */
     public function value(): mixed
     {

tests/src/SavingIteratorTest.php

@@ -16,6 +16,13 @@
 
 /**
  * @coversDefaultClass MaxGoryunov\SavingIterator\Src\SavingIterator
+ * 
+ * @todo #51:30min It seems that The and Let new typehints have a negative
+ *  effect on PHPStan in a way that when type coming to The or Let is not
+ *  typehinted as plain `mixed` or `Closure` PHPStan starts complaining about
+ *  types for `TransparentIterator` for example. It should probably be solved
+ *  by prefixing tags for PHPStan with `phpstan`. It also causes IDE to
+ *  complain about incorrect types(X or T or Y instead of some expected type).
  */
 class SavingIteratorTest extends TestCase
 {
@@ -79,6 +86,7 @@ public function testDoesNotCallOriginIfValuesAreInCache(): void
                         new LimitIterator(
                             new InfiniteIterator(
                                 new SavingIterator(
+                                    /** @phpstan-ignore-next-line */
                                     new TransparentIterator($called)
                                 )
                             ),
@@ -305,6 +313,7 @@ public function testFillsCacheValueOnlyIfItIsNotStoredYet(): void
                         new LimitIterator(
                             new InfiniteIterator(
                                 new SavingIterator(
+                                    /** @phpstan-ignore-next-line */
                                     new TransparentIterator($called)
                                 )
                             ),