Skip to content
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

Jump to bottom

Pseudo-routing take two #168

Merged
merged 54 commits into from
Jul 4, 2022
Merged

Pseudo-routing take two #168

merged 54 commits into from
Jul 4, 2022

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented Jul 4, 2022 •
edited
Loading

A simpler, less prematurely abstracted, and more tested, take on #112

Pseudo-Router for Hyde.

This is not a router in the traditional sense that it decides where to go.
Instead, it creates a pre-generated object encapsulating the Hyde autodiscovery.

If successful, this will not only let us emulate Laravel route helpers, but also
serve as the canonical source of truth for the Hyde autodiscovery process.

The routes defined can then also be used to power the RealtimeCompiler without
having to reverse-engineer the source file mapping.

Routes cannot be added manually, instead the route index is created using the
exact same rules as the current autodiscovery process and compiled file output.

The route index shall serve as a multidimensional mapping allowing you to
determine where a source file will be compiled to, and where a compiled
file was generated from.

caendesilva added 30 commits July 3, 2022 22:19
@caendesilva
Update test content sources configuration
6b95bb4
@caendesilva
Create Router.php
6b37b5b
@caendesilva
Reorder methods
48c17e3
@caendesilva
Add AbstractPage::getSourceFilePath() method
c94a57a
@caendesilva
Normalize PHPDoc return comment
c3c6e31
@caendesilva
Create RouteContract.php
5708dd7
@caendesilva
Create Route.php
06f0bef
@caendesilva
Add constructor to route contract
7a4ca30
@caendesilva
Make the Route class abstract
44075c8
@caendesilva
Add PHPDocs
55927c4
@caendesilva
Rename method to match related output path helper
b9ba52c
@caendesilva
Implement the method stubs
89e26f5
@caendesilva
Create RouterContract.php
f16db95
@caendesilva
Add the route collection property
4bb0a7a
@caendesilva
Add Router::discover() method
3891ee8
@caendesilva
Revert "Make the Route class abstract"
e440266 
This reverts commit 44075c8.
@caendesilva
Add unique route key property
36ebe3b
@caendesilva
Implement discover() method
78402ca
@caendesilva
Move module into the proper namespace
deec964
@caendesilva
Create RouterTest.php
a2f16d7 
Update Router.php
@caendesilva
Add Route constructor
65062fa
@caendesilva
Construct the route key
c8a41d6
@caendesilva
Replace makeRouteArray with using the Collection put method
be75f4a
@caendesilva
Annotate the collection contents type
e210bef
@caendesilva
Mark discover() method as internal
dbfd3d3
@caendesilva
Implement route autodiscovery
3d50bd9
@caendesilva
Unit test discover() helper method
859fbbf
@caendesilva
Add helper to assert a collection contains the given route
189e6cf
@caendesilva
Test Route autodiscovery
e0e5ae8
@caendesilva
Make internal discover method protected
ceaab9c 
    /**
     * Construct a new Route instance for the given page model and add it to the router.
     *
     * @internal This is an internal helper method.
     * @param \Hyde\Framework\Contracts\PageContract $page
     * @return $this<\Hyde\Framework\Modules\Routing\RouteContract>
     */
    public function discover(PageContract $page): self;
caendesilva and others added 21 commits July 4, 2022 10:52
@caendesilva
Replace void return with method chaining
28d63de
@caendesilva
Create discoverPageRoutes() helper to dynamically discover routes
e315dbf 
This will make it easier to add a hook later on that can extend the page types that are routable
@caendesilva
Add todo tests
46249b6
@caendesilva
Add todo: Convert into Singleton
3d7e0ef
@caendesilva
Create RouteTest.php
a2684e5 
Update Route.php
@caendesilva
Create tests for the Route class
c63fb46
@caendesilva
Disable global namespace inspection
b4d6664
@caendesilva
Define RouteContract::get() and RouteContract::getOrFail() helpers
f7d453a
@caendesilva
Create RouteNotFoundException.php
150b0fe
@caendesilva
Merge branch 'master' into pseudo-routing-take-two
401b215
@caendesilva
Create pseudo-singleton helper
62af091 
Keeping it simple for now
@caendesilva
Annotate the collection contents type
d2140a2
@caendesilva
Remove unused import
74db284
@caendesilva
Add helper method stubs defined in contract
002f69f
@caendesilva
Make return value nullable
f53b543
@caendesilva
Update exception message
b209f1e
@caendesilva
Implement Route::get() method
5207ee0
@caendesilva
Implement Route::getOrFail() method
ef3c0e1
@caendesilva
Add covers annotation for the exception
add1c31
@caendesilva
Update Router.php
975b4a7
@StyleCIBot
Apply fixes from StyleCI
fd9dbfc
@codecov
Copy link

codecov bot commented Jul 4, 2022 •
edited
Loading

Codecov Report

Merging #168 (df4eee3) into master (6d2a973) will not change coverage.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##              master      #168   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       751       769   +18     
===========================================
  Files             97       100    +3     
  Lines           1949      1991   +42     
===========================================
+ Hits            1949      1991   +42
Impacted Files Coverage Δ
packages/framework/src/Contracts/AbstractPage.php 100.00% <100.00%> (ø)
packages/framework/src/Modules/Routing/Route.php 100.00% <100.00%> (ø)
...ork/src/Modules/Routing/RouteNotFoundException.php 100.00% <100.00%> (ø)
packages/framework/src/Modules/Routing/Router.php 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d2a973...df4eee3. Read the comment docs.

@caendesilva
Copy link
Member Author

Would be neat with a Route facade (basically, just class aliasing the route class), and a route() helper method as well?

@caendesilva caendesilva marked this pull request as ready for review July 4, 2022 10:09
@caendesilva caendesilva merged commit f1a3be1 into master Jul 4, 2022
@caendesilva caendesilva deleted the pseudo-routing-take-two branch July 4, 2022 10:09
This was referenced Jul 4, 2022
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@caendesilva @StyleCIBot