Add attributes support by rustamwin · Pull Request #196 · yiisoft/router

rustamwin · 2023-03-28T10:21:17Z

Q	A
Is bugfix?	✔️/❌
New feature?	✔️
Breaks BC?	✔️
Fixed issues	comma-separated list of tickets # fixed by the PR, if any

ℹ️ yiisoft/demo#589

what-the-diff · 2023-03-28T10:21:46Z

PR Summary

🚀 Optimized Middleware Handling
Improved the way middlewares are managed in the Group class to avoid building them multiple times when they don't change, boosting efficiency.
🧹 Code Clean-up
Removed unused classes and fixed some typos for better readability and maintenance.
🛠️ Refactoring
Refactored various methods, attributes, and typehints for improved consistency, readability, and functionality.
✅ Improved Testing
Enhanced the tests for the Group and RouteCollection classes, and fixed the bug in the RouteCollectionTest.
💡 Convenience Enhancements
Added the withMiddlewares method to the DispatcherInterface for easier usage in certain cases.

codecov · 2023-03-28T10:25:01Z

Codecov Report

❌ Patch coverage is 99.50739% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 99.83%. Comparing base (1e9bfd5) to head (bb2a333).

Files with missing lines	Patch %	Lines
src/Provider/FileRoutesProvider.php	97.36%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##              master     #196      +/-   ##
=============================================
- Coverage     100.00%   99.83%   -0.17%     
- Complexity       129      186      +57     
=============================================
  Files             13       23      +10     
  Lines            400      589     +189     
=============================================
+ Hits             400      588     +188     
- Misses             0        1       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

src/MatchingResult.php

src/Route.php

src/Attribute/Delete.php

src/Group.php

src/Route.php

src/RouteAttributesRegistrarInterface.php

src/RouteAttributesRegistrar.php

# Conflicts: # .phpstorm.meta.php/Group.php # .phpstorm.meta.php/Route.php # src/Group.php # src/MatchingResult.php # src/Middleware/Router.php # src/Route.php # tests/GroupTest.php # tests/RouteCollectionTest.php # tests/RouteTest.php

vjik · 2025-11-02T16:47:09Z

Waiting #225

# Conflicts: # composer.json # src/Group.php # src/Route.php # tests/RouteCollectionTest.php # tests/RouteTest.php

…route provider handling; increase MSI

…eware callable in GroupTest

Copilot

Pull request overview

This PR introduces route declaration via PHP attributes and adds a provider abstraction for supplying routes from different sources (arrays and PHP files/directories). It also refactors Route and Group into more DTO-like objects with public constructors and additional validation, and extends the test suite accordingly.

Changes:

Add PHP attribute classes (Get, Post, etc.) to model routes as native PHP attributes.
Add RoutesProviderInterface plus ArrayRoutesProvider and FileRoutesProvider, and extend RouteCollector to accept providers.
Refactor Route and Group constructors (public, validation, caching tweaks) and add/adjust tests + fixtures.

Reviewed changes

Copilot reviewed 39 out of 40 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
tests/Support/resources/test.php	Adds a simple test fixture file.
tests/Support/resources/scope/scope_routes.php	Adds scoped route fixture to test providing routes with extracted variables.
tests/Support/resources/routes.php	Adds routes fixture used by provider tests.
tests/Support/resources/mixed_dir/valid_routes.php	Adds valid PHP routes fixture for directory scanning tests.
tests/Support/resources/mixed_dir/not_routes.txt	Adds non-PHP fixture to verify directory scanning ignores it.
tests/Support/resources/foo.php	Adds fixture returning non-routes to validate provider filtering.
tests/Support/TestController.php	Adds attribute usage examples with `#[Group]` and `#[Get]`.
tests/RouteTest.php	Adds/updates tests for new `Route` constructor behavior and validation.
tests/RouteCollectorTest.php	Adds tests for collecting routes from providers.
tests/RouteCollectionTest.php	Mostly formatting adjustments in chained calls.
tests/Provider/FileRoutesProviderTest.php	Adds tests for file/directory-based route provider behavior.
tests/Provider/ArrayRoutesProviderTest.php	Adds tests for array-based route provider behavior.
tests/GroupTest.php	Adds tests for `Group` constructor validation and caching behavior.
tests/Attribute/RouteTest.php	Adds tests for generic `#[Route]` attribute.
tests/Attribute/PutTest.php	Adds tests for `#[Put]` attribute.
tests/Attribute/PostTest.php	Adds tests for `#[Post]` attribute.
tests/Attribute/PatchTest.php	Adds tests for `#[Patch]` attribute.
tests/Attribute/OptionsTest.php	Adds tests for `#[Options]` attribute.
tests/Attribute/HeadTest.php	Adds tests for `#[Head]` attribute.
tests/Attribute/GetTest.php	Adds tests for `#[Get]` attribute.
tests/Attribute/DeleteTest.php	Adds tests for `#[Delete]` attribute.
src/RouteCollector.php	Adds route providers support in the collector.
src/RouteCollection.php	Small docblock wording adjustment.
src/Route.php	Makes constructor public, adds validation and defaults normalization, adjusts cache invalidation.
src/Provider/RoutesProviderInterface.php	Introduces the provider interface contract.
src/Provider/FileRoutesProvider.php	Implements loading routes from a file or directory.
src/Provider/ArrayRoutesProvider.php	Implements loading routes from an in-memory array.
src/MatchingResult.php	Adds a Psalm assertion for `route()` nullability.
src/Group.php	Makes constructor public, adds validation, and marks `Group` as a PHP attribute.
src/Attribute/RouteAttributeInterface.php	Introduces an interface for route attribute classes.
src/Attribute/Route.php	Adds a generic `#[Route]` attribute implementation.
src/Attribute/Put.php	Adds `#[Put]` attribute implementation.
src/Attribute/Post.php	Adds `#[Post]` attribute implementation.
src/Attribute/Patch.php	Adds `#[Patch]` attribute implementation.
src/Attribute/Options.php	Adds `#[Options]` attribute implementation.
src/Attribute/Head.php	Adds `#[Head]` attribute implementation.
src/Attribute/Get.php	Adds `#[Get]` attribute implementation.
src/Attribute/Delete.php	Adds `#[Delete]` attribute implementation.
README.md	Documents support for attribute-based route declaration.
CHANGELOG.md	Adds release notes for attributes/providers/DTO refactor.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/RouteCollector.php

src/Provider/FileRoutesProvider.php

Copilot · 2026-03-25T19:03:40Z

src/Provider/FileRoutesProvider.php

+            $files = new CallbackFilterIterator(
+                new FilesystemIterator(
+                    $this->file,
+                    /** @infection-ignore-all Bitwise flags; CallbackFilterIterator already filters by extension */
+                    FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS,
+                ),
+                fn(SplFileInfo $fileInfo) => $fileInfo->isFile() && $fileInfo->getExtension() === 'php',
+            );
+            /** @var SplFileInfo[] $files */
+            foreach ($files as $file) {


When a directory is provided, iteration order of FilesystemIterator is filesystem-dependent. Because route order typically affects matching/precedence, the resulting route set can become non-deterministic across environments. Consider collecting filenames and sorting them (or otherwise enforcing a stable order) before requiring files.

src/Provider/FileRoutesProvider.php

Copilot · 2026-03-25T19:03:41Z

src/Route.php

    /**
-     * @param string[] $methods
+     * @param array|callable|string|null $action Action handler. It is a primary middleware definition that
+     * should be invoked last for a matched route.
+     * @param array[]|callable[]|string[] $middlewares Middleware definitions.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param bool $override Marks route as override. When added it will replace existing route with the same name.
+     * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.


Docblocks/types for $defaults allow scalar|Stringable|null, but both the constructor and defaults() cast values via strval(), which turns null into '' and Stringable into its string representation. Either adjust the docs/psalm types to reflect array<string,string>, or preserve null/Stringable values instead of forcing strings.

src/Group.php

src/RouteCollector.php

src/Route.php

CHANGELOG.md

…; improve handling of route providers and test cases

rustamwin and others added 2 commits March 28, 2023 15:20

Add attributes support

a60d03b

Apply fixes from StyleCI

b328c82

rustamwin changed the title ~~Add attributes support~~ Add attributes support & improve MatchingResult Mar 28, 2023

vjik reviewed Mar 28, 2023

View reviewed changes

src/MatchingResult.php Outdated Show resolved Hide resolved

rustamwin added 2 commits March 28, 2023 16:54

Fix psalm annotation

3496866

Add tests

69d9832

samdark mentioned this pull request Apr 2, 2023

Support Attributes #194

Closed

Merge branch 'master' into add-attributes

bc421e9

vjik added the status:under development Someone is working on a pull request. label Jun 2, 2023

xepozz mentioned this pull request Jun 8, 2023

Remove usage middleware dispatcher in Route, Group and MatchingResult #210

Closed

xepozz and others added 6 commits June 8, 2023 21:50

Merge branch 'master' into add-attributes

875d7fd

Add attributes registrar

777ff54

Apply fixes from StyleCI

3959325

Add tests

1651071

Fix tests & psalm issues

838bbc4

Apply fixes from StyleCI

4e63476

rustamwin added status:code review The pull request needs review. and removed status:under development Someone is working on a pull request. labels Jun 15, 2023

rustamwin requested a review from a team June 15, 2023 14:40

rustamwin and others added 2 commits June 15, 2023 22:55

Add test cases

a0fb7a2

Apply fixes from StyleCI

ed2f60f

vjik reviewed Jun 15, 2023

View reviewed changes

src/Route.php Outdated Show resolved Hide resolved

src/Attribute/Delete.php Outdated Show resolved Hide resolved

src/Group.php Show resolved Hide resolved

src/Route.php Outdated Show resolved Hide resolved

src/RouteAttributesRegistrarInterface.php Outdated Show resolved Hide resolved

vjik added status:under development Someone is working on a pull request. and removed status:code review The pull request needs review. labels Jun 16, 2023

samdark reviewed Jun 20, 2023

View reviewed changes

src/RouteAttributesRegistrar.php Outdated Show resolved Hide resolved

rustamwin and others added 3 commits August 19, 2023 10:28

Improve Route

c239d53

Add test

e8367aa

Merge branch 'master' into add-attributes

2ab8dc2

rustamwin and others added 5 commits October 23, 2023 11:53

Move attribute collector it's own package

0ebcb5a

Cleanup

3ff6921

Minor

a81c91a

Add changelog

5be62b4

Apply Rector changes (CI)

63467dc

vjik mentioned this pull request Nov 2, 2023

Make Route, Group and MatchingResult dispatcher independent #222

Merged

rustamwin and others added 5 commits October 21, 2025 22:27

Fixes

81a5858

Apply Rector changes (CI)

b44cd31

Apply fixes from StyleCI

d3bc8e4

Fix psalm issues

f4b3020

rustamwin added status:code review The pull request needs review. and removed status:under development Someone is working on a pull request. labels Oct 22, 2025

rustamwin requested a review from a team October 22, 2025 09:24

rustamwin changed the title ~~Add attributes support & improve MatchingResult~~ Add attributes support Oct 27, 2025

rustamwin and others added 7 commits February 11, 2026 14:07

Merge remote-tracking branch 'origin/master' into add-attributes

333edf7

# Conflicts: # composer.json # src/Group.php # src/Route.php # tests/RouteCollectionTest.php # tests/RouteTest.php

Apply PHP CS Fixer and Rector changes (CI)

5a0221d

Merge remote-tracking branch 'origin/master' into add-attributes

26ea39e

Fix: BC

00bf155

Add tests for default override and middleware behavior; enhance file …

3326413

…route provider handling; increase MSI

Refactor: remove unused properties in Group; add return type to middl…

72c9f66

…eware callable in GroupTest

Merge branch 'master' into add-attributes

24f5323

samdark requested a review from Copilot March 25, 2026 18:57

Copilot started reviewing on behalf of samdark March 25, 2026 18:58 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

rustamwin and others added 4 commits March 26, 2026 18:35

Refactor: extract host normalization logic to a shared private method…

302fae5

…; improve handling of route providers and test cases

Apply PHP CS Fixer and Rector changes (CI)

f38b6da

Apply PHP CS Fixer and Rector changes (CI)

b7f262f

Update CHANGELOG: consolidate duplicate entries for #196

bb2a333

Uh oh!

Conversation

rustamwin commented Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

what-the-diff bot commented Mar 28, 2023

PR Summary

Uh oh!

codecov bot commented Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vjik commented Nov 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rustamwin commented Mar 28, 2023 •

edited

Loading

codecov bot commented Mar 28, 2023 •

edited

Loading