route_mechanic 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce0b5623dd35b2cb758cef52986509c7d95e4c66c15436b426effdf345b83309
-  data.tar.gz: 465c4b75e175e15e5827e2e394fcd553eada07d09cab9028d0975037beee8513
+  metadata.gz: 880e2dd0341ed11d953e4a4d27e71431ef393049153224f62231ba3c527252c8
+  data.tar.gz: '0592972c3d62edf50cbeb1f4bcfee4473921e789c31eff61cd2673927c22013b'
 SHA512:
-  metadata.gz: 3781e74689e0b7f02df2a8828e1ef5f37ce5be2b29201a7b565e2b66aacaefb980b8212684072308de15bb68d512e2cadae0eb7cbd8b38e68b732ed48136b729
-  data.tar.gz: 4f0ceb15174710c11abd26bb080186d1f085c51054970581d9840ea6f986d45904f1c4aa1013767afedadbc8fa9c42ff67c9140c5f884d4941f262f1747df06c
+  metadata.gz: 1a75f67529149119f59e7e78082a4364ea98b15c4906959a75d4970420a877444d36c37e150f21ab4a2a7e347daf80afe2645072f40d93cff18d57a6427fa5e1
+  data.tar.gz: 71dd0672e63045a5c386ce4510712f75472a07abc236a8d73b696a361ef4fd65a394afb2578ac8f8b3c216d9d4f5e7142cc823fbef67e52c99b65a28f129fd8d

data/.github/workflows/test.yml

@@ -0,0 +1,59 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "0 10 * * 5" # JST 19:00 (Fri)
+
+env:
+  CI: "true"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - ruby:2.3
+          - ruby:2.4
+          - ruby:2.5
+          - ruby:2.6
+          - ruby:2.7
+          - rubylang/ruby:master-nightly-bionic
+        test_framework:
+          - rspec
+          - rake
+        include:
+          - ruby: rubylang/ruby:master-nightly-bionic
+            allow_failures: "true"
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache vendor/bundle
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ github.sha }}
+          restore-keys: |
+            v1-gem-${{ runner.os }}-${{ matrix.ruby }}-
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - name: bundle update
+        run: |
+          set -xe
+          bundle config path vendor/bundle
+          bundle update --jobs $(nproc) --retry 3
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - name: Run ${{ matrix.test_framework }}
+        run: |
+          set -xe
+          bundle exec ${{ matrix.test_framework }}
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}

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

@@ -1,4 +1,6 @@
 # RouteMechanic
+[![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.
 
@@ -31,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
 ```
@@ -44,7 +46,7 @@ Just add a test file like below.
 class RoutingTest < Minitest::Test
   include ::RouteMechanic::Testing::Methods
 
-  def test_that_fake_app_has_correct_routes
+  def test_that_application_has_correct_routes
     assert_all_routes
   end
 end
@@ -55,7 +57,7 @@ end
 It tells you broken routes as follows.
 
 ```ruby
-  0) RouteMechanic::RSpec::Matchers fails if application does not have valid routes
+  0) Rail.application fails if application does not have valid routes
      Failure/Error: expect(Rails.application.routes).to have_valid_routes
 
        [Route Mechanic]

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,19 @@ 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'
   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/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>]
@@ -55,19 +78,18 @@ module RouteMechanic
       # If complicated controllers path is used, use Rails.application.eager_load! instead.
       def eager_load_controllers
         load_path = "#{Rails.root.join('app/controllers')}"
-        relname_range = (load_path.to_s.length + 1)...-3
         Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
-          require_dependency file[relname_range]
+          require_dependency file
         end
       end
 
       # @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.0"
+  VERSION = "0.1.5"
 end

data/route_mechanic.gemspec

@@ -8,12 +8,12 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{RouteMechanic detects broken routes with ease}
   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_machanic"
+  spec.homepage      = "https://github.com/ohbarye/route_mechanic"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/ohbarye/route_machanic"
+  spec.metadata["source_code_uri"] = "https://github.com/ohbarye/route_mechanic"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -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.0
+  version: 0.1.5
 platform: ruby
 authors:
 - ohbarye
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-09-21 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.
@@ -39,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -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
@@ -61,12 +82,12 @@ files:
 - lib/route_mechanic/testing/route_wrapper.rb
 - lib/route_mechanic/version.rb
 - route_mechanic.gemspec
-homepage: https://github.com/ohbarye/route_machanic
+homepage: https://github.com/ohbarye/route_mechanic
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ohbarye/route_machanic
-  source_code_uri: https://github.com/ohbarye/route_machanic
+  homepage_uri: https://github.com/ohbarye/route_mechanic
+  source_code_uri: https://github.com/ohbarye/route_mechanic
 post_install_message:
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4