Merge pull request #10 from Innmind/no-discard-attributes

Add `NoDiscard` attribute on mutation free methods

Author: Baptouuuu

psalm.xml

@@ -14,4 +14,7 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <issueHandlers>
+        <UndefinedAttributeClass errorLevel="suppress" />
+    </issueHandlers>
 </psalm>

src/Allow.php

@@ -18,16 +18,19 @@ private function __construct(UrlPattern $pattern)
     /**
      * @psalm-pure
      */
+    #[\NoDiscard]
     public static function of(UrlPattern $pattern): self
     {
         return new self($pattern);
     }
 
+    #[\NoDiscard]
     public function matches(string $url): bool
     {
         return $this->pattern->matches($url);
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return 'Allow: '.$this->pattern->toString();

src/CrawlDelay.php

@@ -26,6 +26,7 @@ private function __construct(int $value)
      *
      * @param 0|positive-int $value
      */
+    #[\NoDiscard]
     public static function of(int $value): self
     {
         return new self($value);
@@ -36,6 +37,7 @@ public static function of(int $value): self
      *
      * @return Maybe<self>
      */
+    #[\NoDiscard]
     public static function maybe(string $value): Maybe
     {
         /** @psalm-suppress ArgumentTypeCoercion It doesn't understand the last filter */
@@ -49,11 +51,13 @@ public static function maybe(string $value): Maybe
     /**
      * @return 0|positive-int
      */
+    #[\NoDiscard]
     public function toInt(): int
     {
         return $this->value;
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return 'Crawl-delay: '.$this->value;

src/Directives.php

@@ -47,6 +47,7 @@ private function __construct(
      * @param Sequence<Allow> $allow
      * @param Sequence<Disallow> $disallow
      */
+    #[\NoDiscard]
     public static function of(
         UserAgent $userAgent,
         ?Sequence $allow = null,
@@ -61,6 +62,7 @@ public static function of(
         );
     }
 
+    #[\NoDiscard]
     public function withAllow(Allow $allow): self
     {
         return new self(
@@ -71,6 +73,7 @@ public function withAllow(Allow $allow): self
         );
     }
 
+    #[\NoDiscard]
     public function withDisallow(Disallow $disallow): self
     {
         return new self(
@@ -81,6 +84,7 @@ public function withDisallow(Disallow $disallow): self
         );
     }
 
+    #[\NoDiscard]
     public function withCrawlDelay(CrawlDelay $crawlDelay): self
     {
         return self::of(
@@ -91,11 +95,13 @@ public function withCrawlDelay(CrawlDelay $crawlDelay): self
         );
     }
 
+    #[\NoDiscard]
     public function targets(string $userAgent): bool
     {
         return $this->userAgent->matches($userAgent);
     }
 
+    #[\NoDiscard]
     public function disallows(Url $url): bool
     {
         $url = $this->clean($url)->toString();
@@ -115,11 +121,13 @@ public function disallows(Url $url): bool
     /**
      * @return Maybe<CrawlDelay>
      */
+    #[\NoDiscard]
     public function crawlDelay(): Maybe
     {
         return $this->crawlDelay;
     }
 
+    #[\NoDiscard]
     public function asContent(): Content
     {
         $lines = $this

src/Disallow.php

@@ -20,11 +20,13 @@ private function __construct(UrlPattern $pattern)
     /**
      * @psalm-pure
      */
+    #[\NoDiscard]
     public static function of(UrlPattern $pattern): self
     {
         return new self($pattern);
     }
 
+    #[\NoDiscard]
     public function matches(string $url): bool
     {
         if (Str::of($this->pattern->toString())->empty()) {
@@ -34,6 +36,7 @@ public function matches(string $url): bool
         return $this->pattern->matches($url);
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return 'Disallow: '.$this->pattern->toString();

src/Parser.php

@@ -34,6 +34,7 @@ private function __construct(
     /**
      * @return Maybe<RobotsTxt>
      */
+    #[\NoDiscard]
     public function __invoke(Url $url): Maybe
     {
         return ($this->fulfill)(

src/Parser/Walker.php

@@ -33,6 +33,7 @@ private function __construct()
      *
      * @return Sequence<Directives>
      */
+    #[\NoDiscard]
     public function __invoke(Sequence $lines): Sequence
     {
         return $lines

src/RobotsTxt.php

@@ -33,21 +33,25 @@ private function __construct(Url $url, Sequence $directives)
      *
      * @param Sequence<Directives> $directives
      */
+    #[\NoDiscard]
     public static function of(Url $url, Sequence $directives): self
     {
         return new self($url, $directives);
     }
 
+    #[\NoDiscard]
     public function url(): Url
     {
         return $this->url;
     }
 
+    #[\NoDiscard]
     public function directives(): Sequence
     {
         return $this->directives;
     }
 
+    #[\NoDiscard]
     public function disallows(string $userAgent, Url $url): bool
     {
         return $this
@@ -62,6 +66,7 @@ public function disallows(string $userAgent, Url $url): bool
             );
     }
 
+    #[\NoDiscard]
     public function asContent(): Content
     {
         return Content::ofLines(

src/UrlPattern.php

@@ -24,11 +24,13 @@ private function __construct(string $pattern)
     /**
      * @psalm-pure
      */
+    #[\NoDiscard]
     public static function of(string $pattern): self
     {
         return new self($pattern);
     }
 
+    #[\NoDiscard]
     public function matches(string $url): bool
     {
         if ($this->pattern === '*' || Str::of($this->pattern)->empty()) {
@@ -48,6 +50,7 @@ public function matches(string $url): bool
         return $this->fallUnder($url);
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return $this->pattern;

src/UserAgent.php

@@ -28,21 +28,25 @@ private function __construct(Sequence $agents)
     /**
      * @psalm-pure
      */
+    #[\NoDiscard]
     public static function of(string $agent): self
     {
         return new self(Sequence::of(Str::of($agent)));
     }
 
+    #[\NoDiscard]
     public function and(string $agent): self
     {
         return new self(($this->agents)(Str::of($agent)));
     }
 
+    #[\NoDiscard]
     public function merge(self $agents): self
     {
         return new self($this->agents->append($agents->agents));
     }
 
+    #[\NoDiscard]
     public function matches(string $userAgent): bool
     {
         $userAgent = Str::of($userAgent)->toLower();
@@ -56,6 +60,7 @@ public function matches(string $userAgent): bool
             );
     }
 
+    #[\NoDiscard]
     public function asContent(): Content
     {
         return Content::ofLines(