Add shouldBeReadonly assertion

ci/psalm.xml

@@ -51,5 +51,9 @@
         <DeprecatedMethod>
             <errorLevel type="suppress"><file name="../src/Rule/Extractor/Relation/DocComment/ClassScope/PropertyTagExtractor.php" /></errorLevel>
         </DeprecatedMethod>
+
+        <ArgumentTypeCoercion>
+            <errorLevel type="suppress"><directory name="../src/Selector/" /></errorLevel>
+        </ArgumentTypeCoercion>
     </issueHandlers>
 </psalm>

doc/SELECTORS.md

@@ -38,3 +38,9 @@ Select all abstract classes.
 
 ### `Selector::final()`
 Select all final classes.
+
+### `Selector::readonly()`
+Select all readonly classes.
+
+### `Selector::attribute()`
+Select all attribute classes.

extension.neon

@@ -16,7 +16,13 @@ services:
 		show_rule_names: %phpat.show_rule_names%,
 	)
 
-    # # # # # DECLARATION RULES # # # # #
+	# # # # # DECLARATION RULES # # # # #
+
+	# ShouldBeReadonly rules
+	-
+		class: PHPat\Rule\Assertion\Declaration\ShouldBeReadonly\IsReadonlyRule
+		tags:
+			- phpstan.rules.rule
 
 	# ShouldBeAbstract rules
 	-

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

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

src/Rule/Assertion/Declaration/ShouldBeReadonly/ShouldBeReadonly.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPat\Rule\Assertion\Declaration\ShouldBeReadonly;
+
+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 ShouldBeReadonly extends DeclarationAssertion
+{
+    use ValidationTrait;
+
+    public function __construct(
+        StatementBuilderFactory $statementBuilderFactory,
+        Configuration $configuration,
+        ReflectionProvider $reflectionProvider,
+        FileTypeMapper $fileTypeMapper
+    ) {
+        parent::__construct(
+            __CLASS__,
+            $statementBuilderFactory,
+            $configuration,
+            $reflectionProvider,
+            $fileTypeMapper
+        );
+    }
+
+    /**
+     * @param string $ruleName
+     * @param ClassReflection $subject
+     * @param bool $meetsDeclaration
+     * @param string[] $tips
+     * @return array<RuleError>
+     */
+    protected function applyValidation(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array
+    {
+        return $this->applyShould($ruleName, $subject, $meetsDeclaration, $tips);
+    }
+
+    protected function getMessage(string $ruleName, string $subject): string
+    {
+        return $this->prepareMessage(
+            $ruleName,
+            sprintf('%s should be readonly', $subject)
+        );
+    }
+}

src/Rule/Extractor/Declaration/ReadonlyExtractor.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPat\Rule\Extractor\Declaration;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+
+trait ReadonlyExtractor
+{
+    public function getNodeType(): string
+    {
+        return InClassNode::class;
+    }
+
+    /**
+     * @param InClassNode $node
+     */
+    protected function meetsDeclaration(Node $node, Scope $scope): bool
+    {
+        return $node->getClassReflection()->isReadOnly();
+    }
+}

src/Selector/IsReadonly.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPat\Selector;
+
+use PHPStan\Reflection\ClassReflection;
+
+class IsReadonly implements SelectorInterface
+{
+    public function getName(): string
+    {
+        return '-all readonly classes-';
+    }
+
+    public function matches(ClassReflection $classReflection): bool
+    {
+        return $classReflection->isReadOnly();
+    }
+}

src/Selector/SelectorPrimitive.php

@@ -34,6 +34,11 @@ public static function final(): IsFinal
         return new IsFinal();
     }
 
+    public static function readonly(): IsReadonly
+    {
+        return new IsReadonly();
+    }
+
     /**
      * @deprecated use Selector::NOT(Selector::final())
      */
@@ -52,21 +57,33 @@ public static function attribute(): IsAttribute
         return new IsAttribute();
     }
 
+    /**
+     * @param class-string|non-empty-string $namespace
+     */
     public static function namespace(string $namespace, bool $regex = false): ClassNamespace
     {
         return new ClassNamespace($namespace, $regex);
     }
 
+    /**
+     * @param class-string|non-empty-string $fqcn
+     */
     public static function classname(string $fqcn, bool $regex = false): Classname
     {
         return new Classname($fqcn, $regex);
     }
 
+    /**
+     * @param class-string|non-empty-string $fqcn
+     */
     public static function implements(string $fqcn, bool $regex = false): ClassImplements
     {
         return new ClassImplements($fqcn, $regex);
     }
 
+    /**
+     * @param class-string|non-empty-string $fqcn
+     */
     public static function extends(string $fqcn, bool $regex = false): ClassExtends
     {
         return new ClassExtends($fqcn, $regex);

src/Test/Builder/AssertionStep.php

@@ -6,6 +6,7 @@
 
 use PHPat\Rule\Assertion\Declaration\ShouldBeAbstract\ShouldBeAbstract;
 use PHPat\Rule\Assertion\Declaration\ShouldBeFinal\ShouldBeFinal;
+use PHPat\Rule\Assertion\Declaration\ShouldBeReadonly\ShouldBeReadonly;
 use PHPat\Rule\Assertion\Declaration\ShouldNotBeAbstract\ShouldNotBeAbstract;
 use PHPat\Rule\Assertion\Declaration\ShouldNotBeFinal\ShouldNotBeFinal;
 use PHPat\Rule\Assertion\Relation\CanOnlyDepend\CanOnlyDepend;
@@ -32,6 +33,13 @@ public function shouldNotBeAbstract(): Rule
         return new BuildStep($this->rule);
     }
 
+    public function shouldBeReadonly(): Rule
+    {
+        $this->rule->assertion = ShouldBeReadonly::class;
+
+        return new BuildStep($this->rule);
+    }
+
     public function shouldBeFinal(): Rule
     {
         $this->rule->assertion = ShouldBeFinal::class;

tests/unit/rules/ShouldBeReadonly/ReadonlyClassTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\PHPat\unit\rules\ShouldBeReadonly;
+
+use PHPat\Configuration;
+use PHPat\Rule\Assertion\Declaration\ShouldBeReadonly\IsReadonlyRule;
+use PHPat\Rule\Assertion\Declaration\ShouldBeReadonly\ShouldBeReadonly;
+use PHPat\Selector\Classname;
+use PHPat\Statement\Builder\StatementBuilderFactory;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\FileTypeMapper;
+use Tests\PHPat\fixtures\FixtureClass;
+use Tests\PHPat\unit\FakeTestParser;
+
+/**
+ * @extends RuleTestCase<IsReadonlyRule>
+ */
+class ReadonlyClassTest extends RuleTestCase
+{
+    public const RULE_NAME = 'test_FixtureClassShouldBeReadonly';
+    public function testRule(): void
+    {
+        $this->analyse(['tests/fixtures/FixtureClass.php'], [
+            [sprintf('%s should be readonly', FixtureClass::class), 31],
+        ]);
+    }
+
+    protected function getRule(): Rule
+    {
+        $testParser = FakeTestParser::create(
+            self::RULE_NAME,
+            ShouldBeReadonly::class,
+            [new Classname(FixtureClass::class, false)],
+            []
+        );
+
+        return new IsReadonlyRule(
+            new StatementBuilderFactory($testParser),
+            new Configuration(false, true, false),
+            $this->createReflectionProvider(),
+            self::getContainer()->getByType(FileTypeMapper::class)
+        );
+    }
+}