Skip to content

Commit c6014ec

Browse files
carlos-granadoscarlos-granados
committed
Add Pure and Impure attributes
1 parent 4ad035e commit c6014ec

File tree

7 files changed

+223
-23
lines changed

7 files changed

+223
-23
lines changed

‎README.md

+25-23
Original file line numberDiff line numberDiff line change
@@ -92,27 +92,29 @@ And then install any needed extensions/plugins for the tools that you use.
9292

9393
These are the available attributes and their corresponding PHPDoc annotations:
9494

95-
| Attribute | PHPDoc Annotations |
96-
|-------------------------------------------------------|-------------------------------------|
97-
| [Deprecated](doc/Deprecated.md) | `@deprecated` |
98-
| [Internal](doc/Internal.md) | `@internal` |
99-
| [IsReadOnly](doc/IsReadOnly.md) | `@readonly` |
100-
| [Method](doc/Method.md) | `@method` |
101-
| [Mixin](doc/Mixin.md) | `@mixin` |
102-
| [Param](doc/Param.md) | `@param` |
103-
| [ParamOut](doc/ParamOut.md) | `@param-out` |
104-
| [Property](doc/Property.md) | `@property` `@var` |
105-
| [PropertyRead](doc/PropertyRead.md) | `@property-read` |
106-
| [PropertyWrite](doc/PropertyWrite.md) | `@property-write` |
107-
| [RequireExtends](doc/RequireExtends.md) | `@require-extends` |
108-
| [RequireImplements](doc/RequireImplements.md) | `@require-implements` |
109-
| [Returns](doc/Returns.md) | `@return` |
110-
| [SelfOut](doc/SelfOut.md) | `@self-out` `@this-out` |
111-
| [Template](doc/Template.md) | `@template` |
112-
| [TemplateContravariant](doc/TemplateContravariant.md) | `@template-contravariant` |
113-
| [TemplateCovariant](doc/TemplateCovariant.md) | `@template-covariant` |
114-
| [TemplateExtends](doc/TemplateExtends.md) | `@extends` `@template-extends` |
115-
| [TemplateImplements](doc/TemplateImplements.md) | `@implements` `@template-implements`|
116-
| [TemplateUse](doc/TemplateUse.md) | `@use` `@template-use` |
117-
| [Type](doc/Type.md) | `@var` `@return` |
95+
| Attribute | PHPDoc Annotations |
96+
|-------------------------------------------------------|--------------------------------------|
97+
| [Deprecated](doc/Deprecated.md) | `@deprecated` |
98+
| [Impure](doc/Impure.md) | `@impure` |
99+
| [Internal](doc/Internal.md) | `@internal` |
100+
| [IsReadOnly](doc/IsReadOnly.md) | `@readonly` |
101+
| [Method](doc/Method.md) | `@method` |
102+
| [Mixin](doc/Mixin.md) | `@mixin` |
103+
| [Param](doc/Param.md) | `@param` |
104+
| [ParamOut](doc/ParamOut.md) | `@param-out` |
105+
| [Property](doc/Property.md) | `@property` `@var` |
106+
| [PropertyRead](doc/PropertyRead.md) | `@property-read` |
107+
| [PropertyWrite](doc/PropertyWrite.md) | `@property-write` |
108+
| [Pure](doc/Pure.md) | `@pure` |
109+
| [RequireExtends](doc/RequireExtends.md) | `@require-extends` |
110+
| [RequireImplements](doc/RequireImplements.md) | `@require-implements` |
111+
| [Returns](doc/Returns.md) | `@return` |
112+
| [SelfOut](doc/SelfOut.md) | `@self-out` `@this-out` |
113+
| [Template](doc/Template.md) | `@template` |
114+
| [TemplateContravariant](doc/TemplateContravariant.md) | `@template-contravariant` |
115+
| [TemplateCovariant](doc/TemplateCovariant.md) | `@template-covariant` |
116+
| [TemplateExtends](doc/TemplateExtends.md) | `@extends` `@template-extends` |
117+
| [TemplateImplements](doc/TemplateImplements.md) | `@implements` `@template-implements` |
118+
| [TemplateUse](doc/TemplateUse.md) | `@use` `@template-use` |
119+
| [Type](doc/Type.md) | `@var` `@return` |
118120

‎doc/Impure.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# `Impure` Attribute
2+
3+
This attribute is the equivalent of the `@impure` annotation for class methods and functions.
4+
5+
## Arguments
6+
7+
The attribute accepts no arguments.
8+
9+
## Example usage
10+
11+
```php
12+
<?php
13+
14+
use PhpStaticAnalysis\Attributes\Impure;
15+
16+
class ImpureExample
17+
{
18+
public static int $i = 0;
19+
20+
#[Impure]
21+
public static function addCumulative(int $left) : int
22+
{
23+
self::$i += $left;
24+
return self::$i;
25+
}
26+
27+
...
28+
}
29+
```

‎doc/Pure.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# `Pure` Attribute
2+
3+
This attribute is the equivalent of the `@pure` annotation for class methods and functions.
4+
5+
## Arguments
6+
7+
The attribute accepts no arguments.
8+
9+
## Example usage
10+
11+
```php
12+
<?php
13+
14+
use PhpStaticAnalysis\Attributes\Pure;
15+
16+
class PureExample
17+
{
18+
#[Pure]
19+
public static function add(int $left, int $right) : int
20+
{
21+
return $left + $right;
22+
}
23+
24+
...
25+
}
26+
```

‎src/Impure.php

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpStaticAnalysis\Attributes;
6+
7+
use Attribute;
8+
9+
#[Attribute(
10+
Attribute::TARGET_METHOD |
11+
Attribute::TARGET_FUNCTION
12+
)]
13+
final class Impure
14+
{
15+
public function __construct()
16+
{
17+
}
18+
}

‎src/Pure.php

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpStaticAnalysis\Attributes;
6+
7+
use Attribute;
8+
9+
#[Attribute(
10+
Attribute::TARGET_METHOD |
11+
Attribute::TARGET_FUNCTION
12+
)]
13+
final class Pure
14+
{
15+
#[Pure]
16+
public function __construct()
17+
{
18+
}
19+
}

‎tests/ImpureTest.php

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use PhpStaticAnalysis\Attributes\Impure;
6+
use PHPUnit\Framework\TestCase;
7+
8+
class ImpureTest extends TestCase
9+
{
10+
public function testImpureMethod(): void
11+
{
12+
$this->assertTrue($this->methodImpure());
13+
}
14+
15+
public function testImpureFunction(): void
16+
{
17+
$this->assertTrue(functionImpure());
18+
}
19+
20+
#[Impure]
21+
private function methodImpure(): bool
22+
{
23+
return $this->getImpure(__FUNCTION__);
24+
}
25+
26+
private function getImpure(string $methodName): bool
27+
{
28+
$reflection = new ReflectionMethod($this, $methodName);
29+
return self::getImpureFromReflection($reflection);
30+
}
31+
32+
public static function getImpureFromReflection(
33+
ReflectionMethod | ReflectionFunction $reflection
34+
): bool {
35+
$attributes = $reflection->getAttributes();
36+
$impure = false;
37+
foreach ($attributes as $attribute) {
38+
if ($attribute->getName() === Impure::class) {
39+
$attribute->newInstance();
40+
$impure = true;
41+
}
42+
}
43+
44+
return $impure;
45+
}
46+
}
47+
48+
#[Impure]
49+
function functionImpure(): bool
50+
{
51+
$reflection = new ReflectionFunction(__FUNCTION__);
52+
return ImpureTest::getImpureFromReflection($reflection);
53+
}

‎tests/PureTest.php

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use PhpStaticAnalysis\Attributes\Pure;
6+
use PHPUnit\Framework\TestCase;
7+
8+
class PureTest extends TestCase
9+
{
10+
public function testPureMethod(): void
11+
{
12+
$this->assertTrue($this->methodPure());
13+
}
14+
15+
public function testPureFunction(): void
16+
{
17+
$this->assertTrue(functionPure());
18+
}
19+
20+
#[Pure]
21+
private function methodPure(): bool
22+
{
23+
return $this->getPure(__FUNCTION__);
24+
}
25+
26+
private function getPure(string $methodName): bool
27+
{
28+
$reflection = new ReflectionMethod($this, $methodName);
29+
return self::getPureFromReflection($reflection);
30+
}
31+
32+
public static function getPureFromReflection(
33+
ReflectionMethod | ReflectionFunction $reflection
34+
): bool {
35+
$attributes = $reflection->getAttributes();
36+
$pure = false;
37+
foreach ($attributes as $attribute) {
38+
if ($attribute->getName() === Pure::class) {
39+
$attribute->newInstance();
40+
$pure = true;
41+
}
42+
}
43+
44+
return $pure;
45+
}
46+
}
47+
48+
#[Pure]
49+
function functionPure(): bool
50+
{
51+
$reflection = new ReflectionFunction(__FUNCTION__);
52+
return PureTest::getPureFromReflection($reflection);
53+
}

0 commit comments

Comments
 (0)