Add ShouldNotBeReadonly assertion

.github/workflows/integrate.yaml

@@ -23,6 +23,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.

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)
+ );
+ }
+}

tests/fixtures/Simple/SimpleReadonlyClass.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Tests\PHPat\fixtures\Simple;
+
+if (PHP_VERSION < 80200) {
+ class SimpleReadonlyClass {}
+} else {
+ readonly class SimpleReadonlyClass {}
+}

tests/unit/rules/ShouldNotBeReadonly/ReadonlyClassTest.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types=1);
+
+namespace Tests\PHPat\unit\rules\ShouldNotBeReadonly;
+
+use PHPat\Configuration;
+use PHPat\Rule\Assertion\Declaration\ShouldNotBeReadonly\IsReadonlyRule;
+use PHPat\Rule\Assertion\Declaration\ShouldNotBeReadonly\ShouldNotBeReadonly;
+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\fixtures\Simple\SimpleReadonlyClass;
+use Tests\PHPat\unit\FakeTestParser;
+
+/**
+ * @extends RuleTestCase<IsReadonlyRule>
+ * @internal
+ * @coversNothing
+ */
+class ReadonlyClassTest extends RuleTestCase
+{
+ public const RULE_NAME = 'test_FixtureClassShouldNotBeReadonly';
+
+ public function testRule(): void
+ {
+ if (PHP_VERSION_ID < 80200) {
+ self::markTestSkipped('PHP version does not support readonly classes');
+ }
+
+ $this->analyse(['tests/fixtures/Simple/SimpleReadonlyClass.php'], [
+ [sprintf('%s should not be readonly', SimpleReadonlyClass::class), 29],
+ ]);
+ }
+
+ protected function getRule(): Rule
+ {
+ $testParser = FakeTestParser::create(
+ self::RULE_NAME,
+ ShouldNotBeReadonly::class,
+ [new Classname(FixtureClass::class, false)],
+ []
+ );
+
+ return new IsReadonlyRule(
+ new StatementBuilderFactory($testParser),
+ new Configuration(false, true, false),
+ self::createReflectionProvider(),
+ self::getContainer()->getByType(FileTypeMapper::class)
+ );
+ }
+}