route_mechanic 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ff0ae5fc0f5045075d58e1a353cb60c7dd440a2a964b2990b12f5298493496
-  data.tar.gz: b8b517e7f557d648aee51cb1f6e61cb151058cbf2bd662df11783a67c0d05378
+  metadata.gz: 21e6f6fc80509ba7ce1b98ea9e5cc7f3868b83fde1d287d5d35867802bf73b1d
+  data.tar.gz: '094b2771b33125d34fe4eaa06bf77bc4ba0d6d250fe094b2b68c2794e2a0274c'
 SHA512:
-  metadata.gz: ab4884a5c8f220562e025581a1aad63b66221b15e573a97fc3d0b1517149ff78cb4beb493c1f4ee58077f4ec97ebfc3d81c98673854032c3e23dac132d2368d3
-  data.tar.gz: c054466bbe6a7750fde4eb1563b82d819a51d0f4e638b11309f2ee8962fa67503c3a5f976232d02d68b873f550e7f5aa175ab6b27327942ddb88322b34f7937d
+  metadata.gz: 51fc1082c4c0857485b6d518f40c1cf8539f8509c38c9311bf62b54b0b5875e62358fc990d10aa4c26b8e0b9b9309f71e330d8236c99f4e478b002019184968b
+  data.tar.gz: 13f6e7e2bd77520b1be677d39609c56a68fe5d87ce7eacb70faaca58a310cceeb669f09cf64d3eea071b36dcbf5f42c6886c08b06f4cc30adb148c8ecde47dcf

data/README.md

@@ -2,7 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/route_mechanic.svg)](https://badge.fury.io/rb/route_mechanic)
 [![Build Status](https://github.com/ohbarye/route_mechanic/workflows/test/badge.svg?branch=master)](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 controller once you've finished installation.
+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
 
@@ -24,11 +24,16 @@ $ bundle install
 
 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.
+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 a test file which has only one test case using `have_valid_routes` matcher.
+Just add one test file that has only one test case using `have_valid_routes` matcher.
 
 ```ruby
 RSpec.describe 'Rails.application', type: :routing do
@@ -38,9 +43,23 @@ RSpec.describe 'Rails.application', type: :routing do
 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 a test file like below.
+Just add one test file like below.
 
 ```ruby
 class RoutingTest < Minitest::Test
@@ -52,6 +71,22 @@ class RoutingTest < Minitest::Test
 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.
@@ -72,31 +107,23 @@ It tells you broken routes as follows.
 1 examples, 1 failure, 0 passed
 ```
 
-RouteMechanic reports 2 types of broken routes.
-
-1. Missing routes
-    - Your application has the controller and the action method but `config/routes.rb` doesn't have corresponds settings.
-2. Missing action methods
-    - Your application's `config/routes.rb` has routing declaration but no controller has a correspond action method.
-
 ## Motivation
 
-I believe most Rails developers write request specs instead of routing specs, and you might wonder what's worth to automate routing spec. Having said that, I can come up with some use-cases of this gem.
+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 big refactor of `config/routes.rb`.
-    - => It's burden to run all request specs during refactoring. This could save your time.
+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).
+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).

data/lib/route_mechanic/rspec/matchers.rb

@@ -1,49 +1,20 @@
-require 'route_mechanic/testing/methods'
-require 'rspec/matchers/composable'
+require 'route_mechanic/rspec/matchers/have_valid_routes'
+require 'route_mechanic/rspec/matchers/have_no_unused_actions'
+require 'route_mechanic/rspec/matchers/have_no_unused_routes'
 
 module RouteMechanic
   module RSpec
     module Matchers
-      class HaveValidRoutes
-        include ::RSpec::Matchers::Composable
-        include RouteMechanic::Testing::Methods
-
-        # @param [Rails::Application] expected
-        def initialize(expected)
-          @expected = expected
-        end
-
-        def matches?(_actual)
-          # assert_recognizes does not consider ActionController::RoutingError an
-          # assertion failure, so we have to capture that and Assertion here.
-          match_unless_raises Minitest::Assertion, ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
-            assert_all_routes(@expected)
-          end
-        end
-
-        def failure_message
-          @rescued_exception.message
-        end
-
-        def description
-          "have valid routes"
-        end
-
-        private
+      def have_valid_routes(application=Rails.application)
+        HaveValidRoutes.new(application)
+      end
 
-        def match_unless_raises(*exceptions)
-          exceptions.unshift Exception if exceptions.empty?
-          begin
-            yield
-            true
-          rescue *exceptions => @rescued_exception
-            false
-          end
-        end
+      def have_no_unused_actions(application=Rails.application)
+        HaveNoUnusedActions.new(application)
       end
 
-      def have_valid_routes(application=Rails.application)
-        HaveValidRoutes.new(application)
+      def have_no_unused_routes(application=Rails.application)
+        HaveNoUnusedRoutes.new(application)
       end
     end
   end

data/lib/route_mechanic/rspec/matchers/base_matcher.rb

@@ -0,0 +1,42 @@
+require 'route_mechanic/testing/methods'
+require 'rspec/matchers/composable'
+
+module RouteMechanic
+  module RSpec
+    module Matchers
+      class BaseMatcher
+        include ::RSpec::Matchers::Composable
+        include RouteMechanic::Testing::Methods
+
+        # @param [Rails::Application] expected
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(_actual)
+          raise NotImplementedError
+        end
+
+        def failure_message
+          @rescued_exception.message
+        end
+
+        def description
+          raise NotImplementedError
+        end
+
+        private
+
+        def match_unless_raises(*exceptions)
+          exceptions.unshift Exception if exceptions.empty?
+          begin
+            yield
+            true
+          rescue *exceptions => @rescued_exception
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/route_mechanic/rspec/matchers/have_no_unused_actions.rb

@@ -0,0 +1,21 @@
+require 'route_mechanic/rspec/matchers/base_matcher'
+
+module RouteMechanic
+  module RSpec
+    module Matchers
+      class HaveNoUnusedActions < BaseMatcher
+        def matches?(_actual)
+          # assert_recognizes does not consider ActionController::RoutingError an
+          # assertion failure, so we have to capture that and Assertion here.
+          match_unless_raises Minitest::Assertion, ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
+            assert_no_unused_actions(@expected)
+          end
+        end
+
+        def description
+          "have no unused actions"
+        end
+      end
+    end
+  end
+end

data/lib/route_mechanic/rspec/matchers/have_no_unused_routes.rb

@@ -0,0 +1,21 @@
+require 'route_mechanic/rspec/matchers/base_matcher'
+
+module RouteMechanic
+  module RSpec
+    module Matchers
+      class HaveNoUnusedRoutes < BaseMatcher
+        def matches?(_actual)
+          # assert_recognizes does not consider ActionController::RoutingError an
+          # assertion failure, so we have to capture that and Assertion here.
+          match_unless_raises Minitest::Assertion, ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
+            assert_no_unused_routes(@expected)
+          end
+        end
+
+        def description
+          "have no unused routes"
+        end
+      end
+    end
+  end
+end

data/lib/route_mechanic/rspec/matchers/have_valid_routes.rb

@@ -0,0 +1,21 @@
+require 'route_mechanic/rspec/matchers/base_matcher'
+
+module RouteMechanic
+  module RSpec
+    module Matchers
+      class HaveValidRoutes < BaseMatcher
+        def matches?(_actual)
+          # assert_recognizes does not consider ActionController::RoutingError an
+          # assertion failure, so we have to capture that and Assertion here.
+          match_unless_raises Minitest::Assertion, ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
+            assert_all_routes(@expected)
+          end
+        end
+
+        def description
+          "have valid routes"
+        end
+      end
+    end
+  end
+end

data/lib/route_mechanic/testing/error_aggregator.rb

@@ -3,7 +3,7 @@ require "route_mechanic/testing/error_inspector"
 module RouteMechanic
   module Testing
     class ErrorAggregator
-      attr_reader :controller_routes_errors, :config_routes_errors
+      attr_reader :unused_actions_errors, :unused_routes_errors
 
       # @param [Array<ActionDispatch::Journey::Route>] routes
       # @param [Array<Controller>] controllers
@@ -12,31 +12,36 @@ module RouteMechanic
         @controllers = controllers
         @config_routes = []
         @controller_routes = []
-        @config_routes_errors = []
-        @controller_routes_errors = []
+        @unused_routes_errors = []
+        @unused_actions_errors = []
       end
 
-      def aggregate
-        collect_controller_routes_errors
-        collect_config_routes_errors
+      # @param [Boolean] unused_actions
+      # @param [Boolean] unused_routes
+      def aggregate(unused_actions: true, unused_routes: true)
+        collect_unused_actions_errors(unused_actions)
+        collect_unused_routes_errors(unused_routes)
         self
       end
 
+      # @return [Array<ActionDispatch::Journey::Route>]
       def all_routes
         @config_routes + @controller_routes
       end
 
+      # @return [Boolean]
       def no_error?
-        [@config_routes_errors, @controller_routes_errors].all?(&:empty?)
+        [@unused_routes_errors, @unused_actions_errors].all?(&:empty?)
       end
 
+      # @return [String]
       def error_message
         ErrorInspector.new(self).message
       end
 
       private
 
-      def collect_controller_routes_errors
+      def collect_unused_actions_errors(report_error)
         @controllers.each do |controller|
           controller_path = controller.controller_path
           controller.action_methods.each do |action_method|
@@ -45,7 +50,7 @@ module RouteMechanic
             end
 
             if journey_routes.empty?
-              @controller_routes_errors << { controller: controller, action: action_method }
+              @unused_actions_errors << { controller: controller, action: action_method } if report_error
             else
               wrappers = journey_routes.map { |r| RouteWrapper.new(r) }
               @controller_routes.concat(wrappers)
@@ -54,7 +59,7 @@ module RouteMechanic
         end
       end
 
-      def collect_config_routes_errors
+      def collect_unused_routes_errors(report_error)
         @routes.each do |journey_route|
           wrapper = RouteWrapper.new journey_route
           @config_routes << wrapper
@@ -63,7 +68,7 @@ module RouteMechanic
             wrapper.controller == w.controller && wrapper.action == w.action && wrapper.path == w.path
           end
 
-          @config_routes_errors << wrapper unless matched_controller_exist
+          @unused_routes_errors << wrapper if !matched_controller_exist && report_error
         end
       end
     end

data/lib/route_mechanic/testing/error_inspector.rb

@@ -4,7 +4,7 @@ module RouteMechanic
   module Testing
     class ErrorInspector
       extend Forwardable
-      def_delegators :@aggregator, :controller_routes_errors, :config_routes_errors
+      def_delegators :@aggregator, :unused_actions_errors, :unused_routes_errors
 
       # @param [RouteMechanic::Testing::ErrorAggregator] aggregator
       def initialize(aggregator)
@@ -15,27 +15,26 @@ module RouteMechanic
       def message
         buffer = []
 
-        if controller_routes_errors.present?
+        if unused_actions_errors.present?
           buffer << "  No route matches to the controllers and action methods below"
-          buffer << controller_routes_errors.map {|r| "    #{r[:controller]}##{r[:action]}" }
+          buffer << unused_actions_errors.map {|r| "    #{r[:controller]}##{r[:action]}" }
         end
 
-        if config_routes_errors.present?
+        if unused_routes_errors.present?
           verb_width, path_width = widths
           buffer << "  No controller and action matches to the routes below"
-          buffer << config_routes_errors.map { |w| "    #{w.verb.ljust(verb_width)} #{w.path.ljust(path_width)} #{w.reqs}" }
-          buffer << "\n"
+          buffer << unused_routes_errors.map { |w| "    #{w.verb.ljust(verb_width)} #{w.path.ljust(path_width)} #{w.reqs}" }
         end
 
-        ["[Route Mechanic]", buffer].join("\n")
+        ["[Route Mechanic]", buffer].join("\n") + "\n"
       end
 
       private
 
       def widths
         [
-          config_routes_errors.map { |w| w.verb.length }.max || 0,
-          config_routes_errors.map { |w| w.path.length }.max || 0
+          unused_routes_errors.map { |w| w.verb.length }.max || 0,
+          unused_routes_errors.map { |w| w.path.length }.max || 0
         ]
       end
     end

data/lib/route_mechanic/testing/methods.rb

@@ -14,20 +14,41 @@ module RouteMechanic
       # @param [Rails::Application] application
       # @raise [Minitest::Assertion]
       def assert_all_routes(application=Rails.application)
+        assert_targets(application, unused_actions: true, unused_routes: true)
+      end
+
+      # @param [Rails::Application] application
+      # @raise [Minitest::Assertion]
+      def assert_no_unused_actions(application=Rails.application)
+        assert_targets(application, unused_actions: true, unused_routes: false)
+      end
+
+      # @param [Rails::Application] application
+      # @raise [Minitest::Assertion]
+      def assert_no_unused_routes(application=Rails.application)
+        assert_targets(application, unused_actions: false, unused_routes: true)
+      end
+
+      private
+
+      # @param [Rails::Application] application
+      # @param [Boolean] unused_actions
+      # @param [Boolean] unused_routes
+      # @raise [Minitest::Assertion]
+      def assert_targets(application, unused_actions:, unused_routes:)
         @application = application
 
         # Instead of including ActionController::TestCase::Behavior, set up
         # https://github.com/rails/rails/blob/5b6aa8c20a3abfd6274c83f196abf73cacb3400b/actionpack/lib/action_controller/test_case.rb#L519-L520
         @controller = nil unless defined? @controller
 
-        aggregator = ErrorAggregator.new(target_routes, controllers).aggregate
+        aggregator = ErrorAggregator.new(target_routes, controllers).aggregate(
+          unused_actions: unused_actions, unused_routes: unused_routes)
         aggregator.all_routes.each { |wrapper| assert_routes(wrapper) }
 
         assert(aggregator.no_error?, ->{ aggregator.error_message })
       end
 
-      private
-
       def routes
         # assert_routing expect @routes to exists as like this class inherits ActionController::TestCase.
         # If user already defines @routes, do not override

data/lib/route_mechanic/version.rb

@@ -1,3 +1,3 @@
 module RouteMechanic
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: route_mechanic
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - ohbarye
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -75,6 +75,10 @@ files:
 - fixtures/fake_app/rails_app.rb
 - lib/route_mechanic.rb
 - lib/route_mechanic/rspec/matchers.rb
+- lib/route_mechanic/rspec/matchers/base_matcher.rb
+- lib/route_mechanic/rspec/matchers/have_no_unused_actions.rb
+- lib/route_mechanic/rspec/matchers/have_no_unused_routes.rb
+- lib/route_mechanic/rspec/matchers/have_valid_routes.rb
 - lib/route_mechanic/testing/error_aggregator.rb
 - lib/route_mechanic/testing/error_inspector.rb
 - lib/route_mechanic/testing/methods.rb