Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ohbarye/route_mechanic
RouteMechanic detects broken routes with ease :train:
https://github.com/ohbarye/route_mechanic
automation minitest rails rspec ruby testing
Last synced: about 1 month ago
JSON representation
RouteMechanic detects broken routes with ease :train:
- Host: GitHub
- URL: https://github.com/ohbarye/route_mechanic
- Owner: ohbarye
- License: mit
- Created: 2020-09-06T08:33:11.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T15:10:16.000Z (6 months ago)
- Last Synced: 2024-09-30T11:05:03.225Z (about 2 months ago)
- Topics: automation, minitest, rails, rspec, ruby, testing
- Language: Ruby
- Homepage: https://rubygems.org/gems/route_mechanic
- Size: 63.5 KB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# RouteMechanic
[](https://badge.fury.io/rb/route_mechanic)
[](https://github.com/ohbarye/route_mechanic/actions?query=workflow%3Atest)
No need to maintain Rails' routing tests manually. RouteMechanic automatically detects broken routes and missing action methods in controllers once you've finished installation.
## Installation
Add this line to your application's Gemfile:
```ruby
group :test do
gem 'route_mechanic'
end
```
And then execute:
```shell
$ bundle install
```
## Usage
RouteMechanic is available for both RSpec and MiniTest.
All you have to do is to add just one test case that keeps your application's routes not broken. Then, RouteMechanic will get to report 2 types of broken routes.
1. Unused actions
- Your application has the controller and the action method but `config/routes.rb` doesn't have corresponding settings.
2. Unused routes
- Your application's `config/routes.rb` has a routing declaration but no controller has a corresponding action method.
### RSpec
Just add one test file that has only one test case using `have_valid_routes` matcher.
```ruby
RSpec.describe 'Rails.application', type: :routing do
it "fails if application does not have valid routes" do
expect(Rails.application).to have_valid_routes
end
end
```
If you'd like to test unused actions and unused routes separately or test only one of them, there're matchers to do so.
```ruby
RSpec.describe 'Rails.application', type: :routing do
it "fails if application has unused actions" do
expect(Rails.application).to have_no_unused_actions
end
it "fails if application has unused routes" do
expect(Rails.application).to have_no_unused_routes
end
end
```
### MiniTest
Just add one test file like below.
```ruby
class RoutingTest < Minitest::Test
include ::RouteMechanic::Testing::Methods
def test_that_application_has_correct_routes
assert_all_routes
end
end
```
If you'd like to test unused actions and unused routes separately or test only one of them, there're assertions to do so.
```ruby
class RoutingTest < Minitest::Test
include ::RouteMechanic::Testing::Methods
def test_that_application_has_no_unused_actions
assert_no_unused_actions
end
def test_that_application_has_no_unused_routes
assert_no_unused_routes
end
end
```
### What if RouteMechanic detects broken routes?
It tells you broken routes as follows.
```ruby
0) Rail.application fails if application does not have valid routes
Failure/Error: expect(Rails.application.routes).to have_valid_routes
[Route Mechanic]
No route matches to the controllers and action methods below
UsersController#unknown
No controller and action matches to the routes below
GET /users/:user_id/friends(.:format) users#friends
GET /users(.:format) users#index
DELETE /users/:id(.:format) users#destroy
# ./spec/rspec/matchers_spec.rb:8:in `block (2 levels) in '
1 examples, 1 failure, 0 passed
```
## Motivation
I believe most Rails developers write request specs instead of routing specs, and you might wonder what's worth to automate routing specs. Having said that, I can come up with some use-cases of this gem.
1. When your project is kinda aged and none knows which route is alive and which one is dead.
- => You can detect dead code by using this gem.
2. When your application doesn't have enough request specs (even controller specs).
- => This gem could be a good start point to increase tests to ensure routing is valid.
3. When you try to make a big refactor of `config/routes.rb`.
- => It's a burden to run all request specs during refactoring. This could save your time.
4. When you're compelled to write routing specs by any pressure. ;-)
- => Set you free from tedious work!
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the RouteMechanic project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/route_mechanic/blob/master/CODE_OF_CONDUCT.md).