Marking pure API with @psalm-pure for usage in pure downstream cons…

…umers
webmozarts · Dec 11, 2019 · 500f5d2 · 500f5d2
1 parent 0bfafd8
commit 500f5d2
Show file tree

Hide file tree

Showing 39 changed files with 163 additions and 2 deletions.
diff --git a/src/Assert.php b/src/Assert.php
diff --git a/tests/static-analysis/assert-alpha.php b/tests/static-analysis/assert-alpha.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): string
@@ -14,6 +15,9 @@ function consume($value): string
     return $value;
 }
 
+/**
+ * @psalm-pure
+ */
 function consumeNullableString(?string $value): string
 {
     Assert::alpha($value);

diff --git a/tests/static-analysis/assert-boolean.php b/tests/static-analysis/assert-boolean.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): bool

diff --git a/tests/static-analysis/assert-classExists.php b/tests/static-analysis/assert-classExists.php
@@ -6,6 +6,7 @@
 
 
 /**
+ * @psalm-pure
  * @param mixed $value
  *
  * @return string

diff --git a/tests/static-analysis/assert-false.php b/tests/static-analysis/assert-false.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @param mixed $value
  */
 function consume($value): bool

diff --git a/tests/static-analysis/assert-float.php b/tests/static-analysis/assert-float.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): float

diff --git a/tests/static-analysis/assert-implementsInterface.php b/tests/static-analysis/assert-implementsInterface.php
@@ -19,6 +19,8 @@ interface ImplementsInterfaceC
 /**
  * @param mixed $value
  *
+ * @psalm-pure
+ *
  * @psalm-return class-string<ImplementsInterfaceA> $value
  */
 function consumeMixed($value): string
@@ -29,6 +31,8 @@ function consumeMixed($value): string
 }
 
 /**
+ * @psalm-pure
+ *
  * @psalm-param class-string<ImplementsInterfaceB>|class-string<ImplementsInterfaceC> $value
  *
  * @psalm-return class-string<ImplementsInterfaceB> $value

diff --git a/tests/static-analysis/assert-integer.php b/tests/static-analysis/assert-integer.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): int

diff --git a/tests/static-analysis/assert-integerish.php b/tests/static-analysis/assert-integerish.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param string|numeric $value
  *
  * @psalm-return numeric

diff --git a/tests/static-analysis/assert-interfaceExists.php b/tests/static-analysis/assert-interfaceExists.php
@@ -9,6 +9,8 @@
  * @param mixed $value
  *
  * @return string
+ *
+ * @psalm-pure
  * @psalm-return class-string
  */
 function consume($value): string

diff --git a/tests/static-analysis/assert-isArray.php b/tests/static-analysis/assert-isArray.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): array

diff --git a/tests/static-analysis/assert-isArrayAccessible.php b/tests/static-analysis/assert-isArrayAccessible.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  *
  * @return array|\ArrayAccess

diff --git a/tests/static-analysis/assert-isCallable.php b/tests/static-analysis/assert-isCallable.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): callable

diff --git a/tests/static-analysis/assert-isCountable.php b/tests/static-analysis/assert-isCountable.php
@@ -6,6 +6,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param object $value
  */
 function consume($value): Countable

diff --git a/tests/static-analysis/assert-isEmpty.php b/tests/static-analysis/assert-isEmpty.php
@@ -6,7 +6,8 @@
 
 
 /**
-
+ * @psalm-pure
+ *
  * @return null
  */
 function consume(?object $value)

diff --git a/tests/static-analysis/assert-isInstanceOf.php b/tests/static-analysis/assert-isInstanceOf.php
@@ -6,6 +6,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @param mixed $value
  */
 function consume($value) : stdClass

diff --git a/tests/static-analysis/assert-isIterable.php b/tests/static-analysis/assert-isIterable.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): iterable

diff --git a/tests/static-analysis/assert-isList.php b/tests/static-analysis/assert-isList.php
@@ -5,6 +5,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
+ *
  * @psalm-param mixed $value
  *
  * @psalm-return list<mixed>
@@ -17,6 +19,8 @@ function consume($value): array
 }
 
 /**
+ * @psalm-pure
+ *
  * @psalm-param array<\stdClass> $value
  *
  * @psalm-return list<\stdClass>

diff --git a/tests/static-analysis/assert-isMap.php b/tests/static-analysis/assert-isMap.php
@@ -5,6 +5,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
+ *
  * @param mixed $value
  *
  * @return array<string, mixed>
@@ -19,6 +21,8 @@ function consume($value): array
 /**
  * Verifying that the type of the elements in the array is preserved by the assertion
  *
+ * @psalm-pure
+ *
  * @param array<int|string, \stdClass> $value
  *
  * @return array<string, \stdClass>

diff --git a/tests/static-analysis/assert-isNonEmptyList.php b/tests/static-analysis/assert-isNonEmptyList.php
@@ -5,6 +5,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
+ *
  * @psalm-param mixed $value
  *
  * @psalm-return non-empty-list<mixed>

diff --git a/tests/static-analysis/assert-isNonEmptyMap.php b/tests/static-analysis/assert-isNonEmptyMap.php
@@ -5,6 +5,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
+ *
  * @param mixed $value
  *
  * @return array<string, mixed>
@@ -19,6 +21,8 @@ function consume($value): array
 /**
  * Verifying that the type of the elements in the array is preserved by the assertion
  *
+ * @psalm-pure
+ *
  * @param array<int|string, \stdClass> $value
  *
  * @return array<string, \stdClass>

diff --git a/tests/static-analysis/assert-isTraversable.php b/tests/static-analysis/assert-isTraversable.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): iterable

diff --git a/tests/static-analysis/assert-natural.php b/tests/static-analysis/assert-natural.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): int

diff --git a/tests/static-analysis/assert-notEmpty.php b/tests/static-analysis/assert-notEmpty.php
@@ -4,6 +4,9 @@
 
 use Webmozart\Assert\Assert;
 
+/**
+ * @psalm-pure
+ */
 function consume(?object $value): object
 {
     Assert::notEmpty($value);

diff --git a/tests/static-analysis/assert-notInstanceOf.php b/tests/static-analysis/assert-notInstanceOf.php
@@ -8,6 +8,7 @@ class NotA {}
 class NotB {}
 
 /**
+ * @psalm-pure
  * @param NotA|NotB $value
  */
 function consume($value): NotA

diff --git a/tests/static-analysis/assert-notNull.php b/tests/static-analysis/assert-notNull.php
@@ -4,6 +4,9 @@
 
 use Webmozart\Assert\Assert;
 
+/**
+ * @psalm-pure
+ */
 function consume(?object $value): object
 {
     Assert::notNull($value);

diff --git a/tests/static-analysis/assert-null.php b/tests/static-analysis/assert-null.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @return null
  */
 function consume(?object $value)

diff --git a/tests/static-analysis/assert-numeric.php b/tests/static-analysis/assert-numeric.php
@@ -5,7 +5,8 @@
 use Webmozart\Assert\Assert;
 
 /**
- * @psalm-param string|numeric $value
+ * @psalm-pure
+ * @psalm-param mixed $value
  *
  * @psalm-return numeric
  */

diff --git a/tests/static-analysis/assert-object.php b/tests/static-analysis/assert-object.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): object

diff --git a/tests/static-analysis/assert-resource.php b/tests/static-analysis/assert-resource.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  *
  * @return resource

diff --git a/tests/static-analysis/assert-same.php b/tests/static-analysis/assert-same.php
@@ -6,6 +6,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): string
@@ -16,6 +17,7 @@ function consume($value): string
 }
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consumeWillInferObject($value): stdClass
@@ -26,6 +28,7 @@ function consumeWillInferObject($value): stdClass
 }
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consumeWillInferArray($value): array

diff --git a/tests/static-analysis/assert-scalar.php b/tests/static-analysis/assert-scalar.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param \Exception|bool $value
  */
 function consume($value): bool

diff --git a/tests/static-analysis/assert-startsWithLetter.php b/tests/static-analysis/assert-startsWithLetter.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): string

diff --git a/tests/static-analysis/assert-string.php b/tests/static-analysis/assert-string.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): string

diff --git a/tests/static-analysis/assert-stringNotEmpty.php b/tests/static-analysis/assert-stringNotEmpty.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): string

diff --git a/tests/static-analysis/assert-subclassOf.php b/tests/static-analysis/assert-subclassOf.php
@@ -19,6 +19,7 @@ class SubclassOfC
 /**
  * @param mixed $value
  *
+ * @psalm-pure
  * @psalm-return class-string<SubclassOfA> $value
  */
 function consumeMixed($value): string
@@ -29,6 +30,7 @@ function consumeMixed($value): string
 }
 
 /**
+ * @psalm-pure
  * @psalm-param class-string<SubclassOfB>|class-string<SubclassOfC> $value
  *
  * @psalm-return class-string<SubclassOfB> $value

diff --git a/tests/static-analysis/assert-true.php b/tests/static-analysis/assert-true.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @param mixed $value
  */
 function consume($value): bool

diff --git a/tests/static-analysis/assert-unicodeLetters.php b/tests/static-analysis/assert-unicodeLetters.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  */
 function consume($value): string

diff --git a/tests/static-analysis/assert-validArrayKey.php b/tests/static-analysis/assert-validArrayKey.php
@@ -5,6 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @psalm-pure
  * @psalm-param mixed $value
  * @param array<int> $array
  *
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ @@
     /**
+     * @psalm-pure
      * @param mixed $value
      *
      * @return string
@@ Expand Down @@