Add ShouldNotBeReadonly assertion

.github/workflows/integrate.yaml

@@ -23,6 +23,7 @@ jobs:
  - "7.4"
  - "8.0"
  - "8.1"
+ - "8.2"
  dependencies:
  - "highest"
  steps:
@@ -60,6 +61,7 @@ jobs:
  - "7.4"
  - "8.0"
  - "8.1"
+ - "8.2"
  dependencies:
  - "highest"
  steps:
@@ -95,6 +97,7 @@ jobs:
  - "7.4"
  - "8.0"
  - "8.1"
+ - "8.2"
  dependencies:
  - "highest"
  steps:
@@ -132,6 +135,7 @@ jobs:
  - "7.4"
  - "8.0"
  - "8.1"
+ - "8.2"
  dependencies:
  - "highest"
  steps:

docs/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.10.15
+* Add `shouldNotBeReadonly` assertion.
+
 ## 0.10.14
 * Add `shouldInclude()` and `shouldNotInclude` assertions.
 * Detect catch blocks in dependency assertions.

docs/documentation/assertions.md

@@ -21,6 +21,8 @@ It asserts that the selected classes are **interfaces**.
 ## shouldBeReadonly()
 It asserts that the selected classes are declared as **readonly**.
 
+Also available: `shouldNotBeReadonly()`
+
 ## shouldHaveOnlyOnePublicMethod()
 It asserts that the selected classes only have **one public method** (besides constructor).
 

extension.neon

@@ -30,6 +30,12 @@ services:
  tags:
  - phpstan.rules.rule
 
+ # ShouldNotBeReadonly rules
+ -
+ class: PHPat\Rule\Assertion\Declaration\ShouldNotBeReadonly\IsReadonlyRule
+ tags:
+ - phpstan.rules.rule
+
  # ShouldBeAbstract rules
  -
  class: PHPat\Rule\Assertion\Declaration\ShouldBeAbstract\AbstractRule

src/Rule/Assertion/Declaration/ShouldNotBeReadonly/IsReadonlyRule.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace PHPat\Rule\Assertion\Declaration\ShouldNotBeReadonly;
+
+use PHPat\Rule\Extractor\Declaration\ReadonlyExtractor;
+use PHPStan\Node\InClassNode;
+use PHPStan\Rules\Rule;
+
+/**
+ * @implements Rule<InClassNode>
+ */
+final class IsReadonlyRule extends ShouldNotBeReadonly implements Rule
+{
+ use ReadonlyExtractor;
+}

src/Rule/Assertion/Declaration/ShouldNotBeReadonly/ShouldNotBeReadonly.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types=1);
+
+namespace PHPat\Rule\Assertion\Declaration\ShouldNotBeReadonly;
+
+use PHPat\Configuration;
+use PHPat\Rule\Assertion\Declaration\DeclarationAssertion;
+use PHPat\Rule\Assertion\Declaration\ValidationTrait;
+use PHPat\Statement\Builder\StatementBuilderFactory;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\RuleError;
+use PHPStan\Type\FileTypeMapper;
+
+abstract class ShouldNotBeReadonly extends DeclarationAssertion
+{
+ use ValidationTrait;
+
+ public function __construct(
+ StatementBuilderFactory $statementBuilderFactory,
+ Configuration $configuration,
+ ReflectionProvider $reflectionProvider,
+ FileTypeMapper $fileTypeMapper
+ ) {
+ parent::__construct(
+ __CLASS__,
+ $statementBuilderFactory,
+ $configuration,
+ $reflectionProvider,
+ $fileTypeMapper
+ );
+ }
+
+ /**
+ * @param array<string> $tips
+ * @return array<RuleError>
+ */
+ protected function applyValidation(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips, array $params = []): array
+ {
+ return $this->applyShouldNot($ruleName, $subject, $meetsDeclaration, $tips, $params);
+ }
+
+ protected function getMessage(string $ruleName, string $subject, array $params = []): string
+ {
+ return $this->prepareMessage(
+ $ruleName,
+ sprintf('%s should not be readonly', $subject)
+ );
+ }
+}

src/Test/Builder/AssertionStep.php

@@ -10,6 +10,7 @@
 use PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod\ShouldHaveOnlyOnePublicMethod;
 use PHPat\Rule\Assertion\Declaration\ShouldNotBeAbstract\ShouldNotBeAbstract;
 use PHPat\Rule\Assertion\Declaration\ShouldNotBeFinal\ShouldNotBeFinal;
+use PHPat\Rule\Assertion\Declaration\ShouldNotBeReadonly\ShouldNotBeReadonly;
 use PHPat\Rule\Assertion\Relation\CanOnlyDepend\CanOnlyDepend;
 use PHPat\Rule\Assertion\Relation\ShouldApplyAttribute\ShouldApplyAttribute;
 use PHPat\Rule\Assertion\Relation\ShouldExtend\ShouldExtend;
@@ -52,6 +53,13 @@ public function shouldBeReadonly(): Rule
  return new BuildStep($this->rule);
  }
 
+ public function shouldNotBeReadonly(): Rule
+ {
+ $this->rule->assertion = ShouldNotBeReadonly::class;
+
+ return new BuildStep($this->rule);
+ }
+
  public function shouldBeFinal(): Rule
  {
  $this->rule->assertion = ShouldBeFinal::class;