Skip to content

chore: Bump StructArmed to ^0.20 and use ClassNode isApi/isInternal flags #401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roxblnfk merged 1 commit into from
Oct 29, 2026
Merged

chore: Bump StructArmed to ^0.20 and use ClassNode isApi/isInternal flags #401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tools/structarmed/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"require": {
"boundwize/structarmed": "^0.19.0"
"boundwize/structarmed": "^0.20.0"
},
"autoload": {
"psr-4": {
Expand Down
6 changes: 1 addition & 5 deletions tools/structarmed/src/Rule/ClassMustDeclareApiOrInternalRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use Boundwize\StructArmed\Analyser\ClassNode;
use Boundwize\StructArmed\Rule\RuleInterface;
use Boundwize\StructArmed\Rule\RuleViolation;
use Testo\Tools\StructArmed\Support\ClassAnnotations;

/**
* Every class-like must state its audience: @api (part of the public contract) or
Expand All @@ -27,10 +26,7 @@ public function appliesTo(ClassNode $classNode): bool

public function evaluate(ClassNode $classNode): ?RuleViolation
{
if (
ClassAnnotations::hasApi($classNode->file, $classNode->shortName())
|| ClassAnnotations::hasInternal($classNode->file, $classNode->shortName())
) {
if ($classNode->isApi || $classNode->isInternal) {
return null;
}

Expand Down
3 changes: 1 addition & 2 deletions tools/structarmed/src/Rule/InternalClassMustBeFinalRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use Boundwize\StructArmed\Analyser\ClassNode;
use Boundwize\StructArmed\Rule\ExtendedClassAwareRuleInterface;
use Boundwize\StructArmed\Rule\RuleViolation;
use Testo\Tools\StructArmed\Support\ClassAnnotations;

/**
* An @internal class with no subclasses must be final: nothing outside the package
Expand All @@ -25,7 +24,7 @@ public function appliesTo(ClassNode $classNode): bool
return $classNode->isClass()
&& ! $classNode->isAbstract
&& $classNode->isInLayer($this->layer)
&& ClassAnnotations::hasInternal($classNode->file, $classNode->shortName());
&& $classNode->isInternal;
}

public function evaluate(ClassNode $classNode): ?RuleViolation
Expand Down
3 changes: 1 addition & 2 deletions tools/structarmed/src/Rule/InternalMustNotLeakIntoPublicSignatureRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
use Boundwize\StructArmed\Rule\MultipleRuleViolationInterface;
use Boundwize\StructArmed\Rule\RuleInterface;
use Boundwize\StructArmed\Rule\RuleViolation;
use Testo\Tools\StructArmed\Support\ClassAnnotations;
use Testo\Tools\StructArmed\Support\ClassSignatures;

/**
Expand Down Expand Up @@ -69,6 +68,6 @@ className: $classNode->className,
private function isInternal(ClassNode $classNode): bool
{
return \str_contains($classNode->className, self::SEGMENT)
|| ClassAnnotations::hasInternal($classNode->file, $classNode->shortName());
|| $classNode->isInternal;
}
}
3 changes: 1 addition & 2 deletions tools/structarmed/src/Rule/InternalNamespaceMustBeAnnotatedInternalRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use Boundwize\StructArmed\Analyser\ClassNode;
use Boundwize\StructArmed\Rule\RuleInterface;
use Boundwize\StructArmed\Rule\RuleViolation;
use Testo\Tools\StructArmed\Support\ClassAnnotations;

/**
* Anything living under an `Internal` namespace segment is implementation detail and
Expand All @@ -27,7 +26,7 @@ public function appliesTo(ClassNode $classNode): bool

public function evaluate(ClassNode $classNode): ?RuleViolation
{
return ClassAnnotations::hasInternal($classNode->file, $classNode->shortName()) ? null : new RuleViolation(
return $classNode->isInternal ? null : new RuleViolation(
message: \sprintf('%s [%s] lives under an Internal namespace and must be annotated @internal', $classNode->getType(), $classNode->className),
file: $classNode->file,
line: $classNode->line,
Expand Down
68 changes: 0 additions & 68 deletions tools/structarmed/src/Support/ClassAnnotations.php
View file
Open in desktop

This file was deleted.

Loading