route_mechanic 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2378e095ad88def369adb3b2b271a9e324a853b535670e3b1be95f4e98d2ee0
-  data.tar.gz: 12f172bb4021e0c56e4ea740a269d10e41a2c67d2f3f040137882dc414ffe448
+  metadata.gz: a9ff0ae5fc0f5045075d58e1a353cb60c7dd440a2a964b2990b12f5298493496
+  data.tar.gz: b8b517e7f557d648aee51cb1f6e61cb151058cbf2bd662df11783a67c0d05378
 SHA512:
-  metadata.gz: 3ee458593e8f2e095c11cb2ce1f36095c50d53eacab10e72032429b4514641d1afe676a37082121c629ba7c23e1ede37362a3ee0ce563caf35f76bf0760bb2ae
-  data.tar.gz: 3079f7b95a27e7c2c3bddd735352283f85cd6f83e362398406c70206160783dba53a83cfe35daf42ab2965857b445dac148d53cbf1cff29fbbb338443c9f7bde
+  metadata.gz: ab4884a5c8f220562e025581a1aad63b66221b15e573a97fc3d0b1517149ff78cb4beb493c1f4ee58077f4ec97ebfc3d81c98673854032c3e23dac132d2368d3
+  data.tar.gz: c054466bbe6a7750fde4eb1563b82d819a51d0f4e638b11309f2ee8962fa67503c3a5f976232d02d68b873f550e7f5aa175ab6b27327942ddb88322b34f7937d

data/.github/workflows/test.yml

@@ -23,7 +23,6 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - ruby:2.3
           - ruby:2.4
           - ruby:2.5
           - ruby:2.6

data/.gitignore

@@ -10,3 +10,4 @@
 /fixtures/fake_app/log/
 /fixtures/fake_app/tmp/
 /.rspec_status
+/.byebug_history

data/Gemfile

@@ -7,3 +7,4 @@ gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "rspec", "~> 3.0"
 gem "rails"
+gem "byebug"

data/README.md

@@ -33,7 +33,7 @@ Just add a test file which has only one test case using `have_valid_routes` matc
 ```ruby
 RSpec.describe 'Rails.application', type: :routing do
   it "fails if application does not have valid routes" do
-   expect(Rails.application.routes).to have_valid_routes
+    expect(Rails.application).to have_valid_routes
   end
 end
 ```

data/fixtures/fake_app/lib/engine.rb

@@ -0,0 +1,5 @@
+module FakeEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace FakeEngine
+  end
+end

data/fixtures/fake_app/rails_app.rb

@@ -1,6 +1,8 @@
 require 'rails/application'
 require "action_controller/railtie"
 
+require_relative './lib/engine'
+
 FakeApp = Class.new(Rails::Application)
 FakeApp.config.eager_load = false
 FakeApp.config.hosts << 'www.example.com' if FakeApp.config.respond_to?(:hosts)
@@ -8,7 +10,20 @@ FakeApp.config.root = File.dirname(__FILE__)
 FakeApp.initialize!
 
 FakeApp.routes.draw do
+  constraints subdomain: /\A[0-9a-z-]+\z/ do
+    get '/constraints_test' => 'users#index'
+  end
+
+  scope ':locale', locale: /en|ja/ do
+    get '/locale_test', to: 'photos#index'
+    get '/photos/:id', to: 'photos#show', constraints: { id: /[A-Z]\d{5}/ }
+  end
+
+  get 'organizations/:id', to: 'organizations#show', id: /[A-Z]\d{5}/
+
   resources :users do
     get 'friends', to: :friends
+    mount FakeEngine::Engine, at: "/fake_engine", fake_default_param: 'FAKE'
+    post 'create_as_another_name', to: 'users#create'
   end
 end

data/lib/route_mechanic/rspec/matchers.rb

@@ -8,7 +8,7 @@ module RouteMechanic
         include ::RSpec::Matchers::Composable
         include RouteMechanic::Testing::Methods
 
-        # @param [ActionDispatch::Routing::RouteSet] expected
+        # @param [Rails::Application] expected
         def initialize(expected)
           @expected = expected
         end
@@ -42,8 +42,8 @@ module RouteMechanic
         end
       end
 
-      def have_valid_routes(routes=Rails.application.routes)
-        HaveValidRoutes.new(routes)
+      def have_valid_routes(application=Rails.application)
+        HaveValidRoutes.new(application)
       end
     end
   end

data/lib/route_mechanic/testing/error_aggregator.rb

@@ -40,15 +40,15 @@ module RouteMechanic
         @controllers.each do |controller|
           controller_path = controller.controller_path
           controller.action_methods.each do |action_method|
-            journey_route = @routes.detect do |route|
+            journey_routes = @routes.select do |route|
               route.defaults[:controller].to_sym == controller_path.to_sym && route.defaults[:action].to_sym == action_method.to_sym
             end
 
-            if journey_route
-              wrapper = RouteWrapper.new journey_route
-              @controller_routes << wrapper
-            else
+            if journey_routes.empty?
               @controller_routes_errors << { controller: controller, action: action_method }
+            else
+              wrappers = journey_routes.map { |r| RouteWrapper.new(r) }
+              @controller_routes.concat(wrappers)
             end
           end
         end

data/lib/route_mechanic/testing/methods.rb

@@ -3,6 +3,7 @@ require "route_mechanic/testing/error_aggregator"
 require "route_mechanic/testing/minitest_assertion_adopter"
 require "action_controller"
 require "action_controller/test_case"
+require "regexp-examples"
 
 module RouteMechanic
   module Testing
@@ -10,12 +11,10 @@ module RouteMechanic
       include MinitestAssertionAdapter if defined?(RSpec)
       include ActionDispatch::Assertions
 
-      # @param [ActionDispatch::Routing::RouteSet] routes
+      # @param [Rails::Application] application
       # @raise [Minitest::Assertion]
-      def assert_all_routes(routes=Rails.application.routes)
-        # assert_routing expect @routes to exists as like this class inherits ActionController::TestCase.
-        # If user already defines @routes, do not override
-        @routes ||= routes
+      def assert_all_routes(application=Rails.application)
+        @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
@@ -29,19 +28,43 @@ module RouteMechanic
 
       private
 
+      def routes
+        # assert_routing expect @routes to exists as like this class inherits ActionController::TestCase.
+        # If user already defines @routes, do not override
+        @routes ||= @application.routes
+
+        return @routes if @routes.routes.size > 0
+
+        # If routes setting is not loaded when running test, it automatically loads config/routes as Rails does.
+        load_path = "#{Rails.root.join('config/routes.rb')}"
+        @application.routes_reloader.paths << load_path unless @application.routes_reloader.paths.include? load_path
+        @application.reload_routes!
+        @routes
+      end
+
       # @param [RouteMechanic::Testing::RouteWrapper] wrapper
       # @raise [Minitest::Assertion]
       def assert_routes(wrapper)
         required_parts = wrapper.required_parts.reduce({}) do |memo, required_part|
-          memo.merge({ required_part => '1' }) # '1' is pseudo id
+          dummy = if wrapper.requirements[required_part].is_a?(Regexp)
+                    wrapper.requirements[required_part].examples.last
+                  else
+                    '1'
+                  end
+          memo.merge({ required_part => dummy }) # Set pseudo params to meets requirements
         end
 
         base_option = { controller: wrapper.controller, action: wrapper.action }
-        url = @routes.url_helpers.url_for(
+        url = routes.url_helpers.url_for(
           base_option.merge({ only_path: true }).merge(required_parts))
         expected_options = base_option.merge(required_parts)
 
-        assert_routing({ path: url, method: wrapper.verb }, expected_options)
+        assert_generates(url, expected_options)
+        # Q. Why not using `assert_routing` or `assert_recognize`?
+        # A. They strictly checks `constraints` in routes.rb and
+        #    this gem can't generate a request that meets whole constraints just in time.
+        # https://github.com/ohbarye/route_mechanic/issues/7#issuecomment-695957142
+        # https://guides.rubyonrails.org/routing.html#specifying-constraints
       end
 
       # @return [Array<Controller>]
@@ -62,11 +85,11 @@ module RouteMechanic
 
       # @return [Array<ActionDispatch::Journey::Route>]
       def target_routes
-        @routes.routes.reject do |journey_route|
+        routes.routes.reject do |journey_route|
           # Skip internals, endpoints that Rails adds by default
           # Also Engines should be skipped since Engine's tests should be done in Engine
           wrapper = RouteWrapper.new(journey_route)
-          wrapper.internal? || wrapper.required_defaults.empty? || wrapper.path.start_with?('/rails/')
+          wrapper.internal? || !wrapper.defaults[:controller] || !wrapper.defaults[:action] || wrapper.path.start_with?('/rails/')
         end
       end
     end

data/lib/route_mechanic/version.rb

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

data/route_mechanic.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{No need to maintain Rails' routing tests manually. RouteMechanic automatically detects broken routes and missing action methods in controller once you've finished installation.}
   spec.homepage      = "https://github.com/ohbarye/route_mechanic"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ohbarye/route_mechanic"
@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "actionpack", ">= 4.2", "< 6.1"
+  spec.add_runtime_dependency "regexp-examples", ">= 1.5", "< 2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: route_mechanic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - ohbarye
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: regexp-examples
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: No need to maintain Rails' routing tests manually. RouteMechanic automatically
   detects broken routes and missing action methods in controller once you've finished
   installation.
@@ -51,6 +71,7 @@ files:
 - bin/setup
 - fixtures/fake_app/app/controllers/application_controller.rb
 - fixtures/fake_app/app/controllers/users_controller.rb
+- fixtures/fake_app/lib/engine.rb
 - fixtures/fake_app/rails_app.rb
 - lib/route_mechanic.rb
 - lib/route_mechanic/rspec/matchers.rb
@@ -75,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="