traceroute 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27509e75b8c7d78e3be8cabd152d8163c42dab05
-  data.tar.gz: 04b04e317cacc030b204c4a03d9d4673b51ffc76
+SHA256:
+  metadata.gz: 90fc80962b328c76194cf2766d02a2c2ad0bd462cb96e26686aeb15779c51085
+  data.tar.gz: 4e3ebbe7177df01147fbc9ce985ed2d94b3ac68c5be95dbf31c6c94955acb42d
 SHA512:
-  metadata.gz: 57a81990feedba666ccc07194640eb900fc8a705f26eef6119911691a02c685d01641dec81fe615f6ef895862aea7c46337aa1defd48924e87c2895b48b53a32
-  data.tar.gz: 0bc718b3c168f82c07e9206aa328c83f0f42375c22ecc9a127df6f3016d8ff0dc19669b87b475bb4d363b81ba02d703ea8a0f1384018a70119fe367cc6cd4fc5
+  metadata.gz: 2feb27fe20d57f5683e396d86393b303fffc7627a5489224c6ca089fa957cb002811f87e5469e2565bea2883b1bf0d025c243429b0a9277733dfa4a20783cad9
+  data.tar.gz: acd2e0940b33e1f0e5c55a9de35251240026bbffbb4fff139690b3ebbd8161d0120562d636500d55d3ddc69e11d9783ef845eb88229dfa271b9177b1972fa59b

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+
+language: ruby
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+rvm:
+  - 2.5.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Akira Matsuda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -10,9 +10,9 @@ This Rake task investigates your Rails application's routes definition, then sho
 
 == Supported versions
 
-* Ruby 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2 (trunk)
+* Ruby 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 (trunk)
 
-* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x, 5.0.x, 5.1.x
 
 
 == Install
@@ -68,6 +68,20 @@ Running the Rake task will print something like this for you:
 
 OMG super helpful, isn't it?
 
+== How do I tell it to ignore routes?
+
+Some gems out there that inject routes or actions into our app for testing. Jasmine-Rails does this. They can give you false negatives when running this in development mode. It can be useful to ignore said routes or actions.
+
+Create a .traceroute.yaml (or .traceroute.yml or .traceroute) file in your root directory.
+
+  # .traceroute.yaml
+  ignore_unreachable_actions:
+  - ^jasmine_rails\/
+  ignore_unused_routes:
+  - ^users#index
+
+Both yaml headers accept a list of regexes.
+
 
 == FAQ
 
@@ -94,4 +108,4 @@ Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda)  ☇3☇3
 
 == Copyright
 
-Copyright (c) 2011 Akira Matsuda. See LICENSE.txt for further details.
+Copyright (c) 2011 Akira Matsuda. See MIT-LICENSE file for further details.

data/lib/tasks/traceroute.rake

@@ -15,7 +15,7 @@ task :traceroute => :environment do
   puts "Unreachable action methods (#{unreachable_action_methods.count}):"
   unreachable_action_methods.each {|action| puts "  #{action}"}
 
-  unless (unused_routes.empty? && unreachable_action_methods.empty?) || ENV['FAIL_ON_ERROR'].blank?
+  unless (unused_routes.empty? && unreachable_action_methods.empty?) || ENV['FAIL_ON_ERROR'] != "1"
     fail "Unused routes or unreachable action methods detected."
   end
 end

data/lib/traceroute.rb

@@ -8,6 +8,7 @@ class Traceroute
 
   def initialize(app)
     @app = app
+    load_ignored_regex!
   end
 
   def load_everything!
@@ -25,7 +26,7 @@ class Traceroute
       controller.action_methods.reject {|a| (a =~ /\A(_conditional)?_callback_/) || (a == '_layout_from_proc')}.map do |action|
         "#{controller.controller_path}##{action}"
       end
-    end.flatten.reject {|r| r.start_with? 'rails/'}
+    end.flatten.reject {|r| @ignored_unreachable_actions.any? { |m| r.match(m) } }
   end
 
   def routed_actions
@@ -35,14 +36,68 @@ class Traceroute
       else
         "#{r.requirements[:controller]}##{r.requirements[:action]}"
       end
-    end.reject {|r| r.start_with? 'rails/'}
+    end.flatten.reject {|r| @ignored_unused_routes.any? { |m| r.match(m) } }
   end
 
   private
+  def filenames
+    [".traceroute.yaml", ".traceroute.yml", ".traceroute"].select { |filename|
+      File.exist? filename
+    }.select { |filename|
+      YAML.load_file(filename)
+    }
+  end
+
+  def at_least_one_file_exists?
+    return !filenames.empty?
+  end
+
+  def ignore_config
+    filenames.each do |filename|
+      return YAML.load_file(filename)
+    end
+  end
+
+  def load_ignored_regex!
+    @ignored_unreachable_actions = [/^rails\//]
+    @ignored_unused_routes = [/^rails\//]
+
+    return unless at_least_one_file_exists?
+
+    if ignore_config.has_key? 'ignore_unreachable_actions'
+      unless ignore_config['ignore_unreachable_actions'].nil?
+        ignore_config['ignore_unreachable_actions'].each do |ignored_action|
+          @ignored_unreachable_actions << Regexp.new(ignored_action)
+        end
+      end
+    end
+
+    if ignore_config.has_key? 'ignore_unused_routes'
+      unless ignore_config['ignore_unused_routes'].nil?
+        ignore_config['ignore_unused_routes'].each do |ignored_action|
+          @ignored_unused_routes << Regexp.new(ignored_action)
+        end
+      end
+    end
+  end
+
   def routes
-    routes = @app.routes.routes.reject {|r| r.name.nil? && r.requirements.blank?}
+    collect_routes @app.routes.routes
+  end
+
+  def collect_routes(routes)
+    routes = routes.each_with_object([]) do |r, tmp_routes|
+      next if r.name.nil? && r.requirements.blank?
 
-    routes.reject! {|r| r.app.is_a?(ActionDispatch::Routing::Mapper::Constraints) && r.app.app.respond_to?(:call)}
+      if r.app.is_a?(ActionDispatch::Routing::Mapper::Constraints) && r.app.app.respond_to?(:routes)
+        engine_routes = r.app.app.routes
+        if engine_routes.is_a?(ActionDispatch::Routing::RouteSet)
+          tmp_routes.concat collect_routes(engine_routes.routes)
+        end
+      else
+        tmp_routes << r
+      end
+    end
 
     routes.reject! {|r| r.app.is_a?(ActionDispatch::Routing::Redirect)}
 

data/test/app.rb

@@ -23,5 +23,3 @@ module Admin; class ShopsController < ApplicationController
   def index; end
   def create; end
 end; end
-
-DummyApp::Application.initialize!

data/test/traceroute_test.rb

@@ -1,100 +1,102 @@
 require_relative 'test_helper'
 
-class TracerouteTest < Minitest::Test
-  def setup
-    @traceroute = Traceroute.new Rails.application
-    @traceroute.load_everything!
-  end
+module TracerouteTest
+  class BasicTest < Minitest::Test
+    def setup
+      @traceroute = Traceroute.new Rails.application
+    end
 
-  def test_defined_action_methods
-    assert_equal ['users#index', 'users#index2', 'users#show', 'admin/shops#index', 'admin/shops#create'], @traceroute.defined_action_methods
-  end
+    def test_defined_action_methods
+      assert_equal ['users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index'].sort, @traceroute.defined_action_methods.sort
+    end
 
-  def test_routed_actions
-    assert_empty @traceroute.routed_actions
+    def test_routed_actions
+      assert_empty @traceroute.routed_actions
+    end
   end
-end
 
-class RoutedActionsTest < Minitest::Test
-  def setup
-    DummyApp::Application.routes.draw do
-      resources :users, :only => [:index, :show, :new, :create]
+  class RoutedActionsTest < Minitest::Test
+    def setup
+      DummyApp::Application.routes.draw do
+        resources :users, :only => [:index, :show, :new, :create]
 
-      namespace :admin do
-        resources :shops, :only => :index
+        namespace :admin do
+          resources :shops, :only => :index
+        end
       end
-    end
-    @traceroute = Traceroute.new Rails.application
-  end
 
-  def teardown
-    DummyApp::Application.routes.clear!
-  end
+      @traceroute = Traceroute.new Rails.application
+    end
 
-  def test_routed_actions
-    assert_equal ['admin/shops#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
-  end
-end
+    def teardown
+      DummyApp::Application.routes.clear!
+    end
 
-class TracerouteRakeTests < Minitest::Test
-  def setup
-    require 'rake'
-    load "./lib/tasks/traceroute.rake"
+    def test_routed_actions
+      assert_equal ['admin/shops#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
+    end
   end
 
-  def test_dont_fail_when_envvar_not_set
-    traceroute = Traceroute.new Rails.application
-    traceroute.load_everything!
+  class TracerouteRakeTests < Minitest::Test
+    def setup
+      require 'rake'
+      load "./lib/tasks/traceroute.rake"
+      @fail_on_error_was = ENV['FAIL_ON_ERROR']
+    end
 
-    ENV['FAIL_ON_ERROR'] = ""
-    Rake::Task[:traceroute].execute
-  end
+    def teardown
+      ENV['FAIL_ON_ERROR'] = @fail_on_error_was
+      Rake::Task.clear
+      DummyApp::Application.routes.clear!
+    end
 
-  def test_rake_task_fails_when_unreachable_action_method_detected
-    traceroute = Traceroute.new Rails.application
-    traceroute.load_everything!
+    def test_dont_fail_when_envvar_is_anything_but_1
+      traceroute = Traceroute.new Rails.application
 
-    begin
-      ENV['FAIL_ON_ERROR']="1"
+      ENV['FAIL_ON_ERROR'] = "DERP"
       Rake::Task[:traceroute].execute
-    rescue => e
-      assert_includes e.message, "Unused routes or unreachable action methods detected."
     end
-  end
 
-  def test_rake_task_fails_when_unused_route_detected
-    DummyApp::Application.routes.draw do
-      resources :users, :only => [:index, :show, :new, :create] do
-        member do
-          get :index2
-        end
-      end
+    def test_rake_task_fails_when_unreachable_action_method_detected
+      traceroute = Traceroute.new Rails.application
 
-      namespace :admin do
-        resources :shops, :only => [:index, :create]
+      begin
+        ENV['FAIL_ON_ERROR']="1"
+        Rake::Task[:traceroute].execute
+      rescue => e
+        assert_includes e.message, "Unused routes or unreachable action methods detected."
       end
+    end
 
-      namespace :rails do
-        resources :mailers, only: ["index"] do
+    def test_rake_task_fails_when_unused_route_detected
+      DummyApp::Application.routes.draw do
+        resources :users, :only => [:index, :show, :new, :create] do
           member do
-            get :preview
+            get :index2
+          end
+        end
+
+        namespace :admin do
+          resources :shops, :only => [:index, :create]
+        end
+
+        namespace :rails do
+          resources :mailers, only: ["index"] do
+            member do
+              get :preview
+            end
           end
         end
       end
-    end
 
-    traceroute = Traceroute.new Rails.application
+      traceroute = Traceroute.new Rails.application
 
-    begin
-      ENV['FAIL_ON_ERROR'] = "1"
-      Rake::Task[:traceroute].execute
-    rescue => e
-      assert_includes e.message, "Unused routes or unreachable action methods detected."
+      begin
+        ENV['FAIL_ON_ERROR'] = "1"
+        Rake::Task[:traceroute].execute
+      rescue => e
+        assert_includes e.message, "Unused routes or unreachable action methods detected."
+      end
     end
   end
-
-  def teardown
-    Rake::Task.clear
-    DummyApp::Application.routes.clear!
-  end
 end

data/test/traceroute_with_engine_test.rb

@@ -0,0 +1,91 @@
+require_relative 'test_helper'
+
+module TestEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace TestEngine
+  end
+
+  class TasksController < ApplicationController; end
+end
+
+module EngineTestsCondition
+  def setup
+    TestEngine::TasksController.class_eval { def index() end }
+    super
+  end
+
+  def teardown
+    super
+    TestEngine::TasksController.send :undef_method, :index
+    TestEngine::TasksController.clear_action_methods!
+  end
+end
+
+module TracerouteWithEngineTest
+  class BasicTest < Minitest::Test
+    prepend EngineTestsCondition
+
+    def setup
+      @traceroute = Traceroute.new Rails.application
+    end
+
+    def test_defined_action_methods
+      assert_equal ["admin/shops#create", "admin/shops#index", "test_engine/tasks#index", "users#index", "users#index2", "users#show"].sort, @traceroute.defined_action_methods.sort
+    end
+
+    def test_routed_actions
+      assert_empty @traceroute.routed_actions
+    end
+  end
+
+  class RoutedActionsTest < Minitest::Test
+    prepend EngineTestsCondition
+
+    def setup
+      DummyApp::Application.routes.draw do
+        resources :posts, :only => [:index, :show, :new, :create]
+      end
+
+      @traceroute = Traceroute.new Rails.application
+    end
+
+    def teardown
+      DummyApp::Application.routes.clear!
+    end
+
+    def test_routed_actions
+      assert_equal ['posts#index', 'posts#show', 'posts#new', 'posts#create'].sort, @traceroute.routed_actions.sort
+    end
+  end
+
+  class EngineTest < Minitest::Test
+    prepend EngineTestsCondition
+
+    def setup
+      TestEngine::Engine.routes.draw do
+        resources :tasks, only: :index
+      end
+
+      Rails.application.routes_reloader.route_sets << DummyApp::Application.routes
+      DummyApp::Application.routes.draw do
+        resources :posts, only: [:index, :show]
+
+        mount TestEngine::Engine => '/test_engine'
+      end
+
+      @traceroute = Traceroute.new Rails.application
+    end
+
+    def teardown
+      DummyApp::Application.routes.clear!
+    end
+
+    def test_defined_action_methods
+      assert_equal ["admin/shops#create", "admin/shops#index", "test_engine/tasks#index", "users#index", "users#index2", "users#show"].sort, @traceroute.defined_action_methods.sort
+    end
+
+    def test_routed_actions
+      assert_equal ['posts#index', 'posts#show', 'test_engine/tasks#index'].sort, @traceroute.routed_actions.sort
+    end
+  end
+end

data/test/yaml_test.rb

@@ -0,0 +1,157 @@
+require_relative 'test_helper'
+
+module JasmineRails
+  class SpecRunner < ApplicationController; end
+end
+
+module YamlTestsCondition
+  def setup
+    super
+    JasmineRails::SpecRunner.class_eval { def index() end }
+  end
+
+  def teardown
+    super
+    JasmineRails::SpecRunner.send :undef_method, :index
+    JasmineRails::SpecRunner.clear_action_methods!
+  end
+end
+
+class DotFileTest < Minitest::Test
+  prepend YamlTestsCondition
+
+  def setup
+    File.open ".traceroute.yaml", "w" do |file|
+      file.puts 'ignore_unreachable_actions:'
+      file.puts '- ^jasmine_rails\/'
+      file.puts 'ignore_unused_routes:'
+      file.puts '- ^users'
+    end
+
+    DummyApp::Application.routes.draw do
+      resources :users, :only => [:index, :show, :new, :create]
+
+      namespace :admin do
+        resources :shops, :only => :index
+      end
+    end
+
+    @traceroute = Traceroute.new Rails.application
+  end
+
+  def teardown
+    DummyApp::Application.routes.clear!
+
+    File.delete ".traceroute.yaml"
+  end
+
+  def test_unreachable_actions_are_ignored
+    refute @traceroute.defined_action_methods.include? 'jasmine_rails/spec_runner#index'
+  end
+
+  def test_used_routes_are_ignored
+    assert_equal ['admin/shops#index'].sort, @traceroute.routed_actions.sort
+  end
+end
+
+class EmptyFileTest < Minitest::Test
+  prepend YamlTestsCondition
+
+  def setup
+    File.open ".traceroute.yaml", "w" do |file|
+    end
+
+    DummyApp::Application.routes.draw do
+      resources :users, :only => [:index, :show, :new, :create]
+
+      namespace :admin do
+        resources :shops, :only => :index
+      end
+    end
+
+    @traceroute = Traceroute.new Rails.application
+  end
+
+  def teardown
+    DummyApp::Application.routes.clear!
+
+    File.delete ".traceroute.yaml"
+  end
+
+  def test_empty_yaml_file_is_handled_the_same_as_no_file
+    assert_equal ['users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index', 'jasmine_rails/spec_runner#index'].sort, @traceroute.defined_action_methods.sort
+  end
+
+  def test_property_with_no_key
+    assert_equal ['admin/shops#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
+  end
+end
+
+class InvalidFileTest < Minitest::Test
+  prepend YamlTestsCondition
+
+  def setup
+    File.open ".traceroute.yml", "w" do |file|
+      file.puts 'ignore_unreachable_actions:'
+      file.puts 'ignore_unused_routes:'
+    end
+
+    DummyApp::Application.routes.draw do
+      resources :users, :only => [:index, :show, :new, :create]
+
+      namespace :admin do
+        resources :shops, :only => :index
+      end
+    end
+
+    @traceroute = Traceroute.new Rails.application
+  end
+
+  def teardown
+    DummyApp::Application.routes.clear!
+
+    File.delete ".traceroute.yml"
+  end
+
+  def test_empty_yaml_file_is_handled_the_same_as_no_file
+    assert_equal ['users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index', 'jasmine_rails/spec_runner#index'].sort, @traceroute.defined_action_methods.sort
+  end
+
+  def test_property_with_no_key
+    assert_equal ['admin/shops#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
+  end
+end
+
+class FilenameSupportTest < Minitest::Test
+  prepend YamlTestsCondition
+
+  def test_yml_supported
+    File.open ".traceroute.yml", "w" do |file|
+      file.puts 'ignore_unreachable_actions:'
+      file.puts '- ^jasmine_rails\/'
+      file.puts 'ignore_unused_routes:'
+      file.puts '- ^users'
+    end
+
+    @traceroute = Traceroute.new Rails.application
+
+    refute @traceroute.defined_action_methods.include? 'jasmine_rails/spec_runner#index'
+
+    File.delete ".traceroute.yml"
+  end
+
+  def test_no_extension_supported
+    File.open ".traceroute", "w" do |file|
+      file.puts 'ignore_unreachable_actions:'
+      file.puts '- ^jasmine_rails\/'
+      file.puts 'ignore_unused_routes:'
+      file.puts '- ^users'
+    end
+
+    @traceroute = Traceroute.new Rails.application
+
+    refute @traceroute.defined_action_methods.include? 'jasmine_rails/spec_runner#index'
+
+    File.delete ".traceroute"
+  end
+end

data/traceroute.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "traceroute"
-  s.version     = '0.5.0'
+  s.version     = '0.6.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Akira Matsuda']
   s.email       = ['ronnie@dio.jp']

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: traceroute
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: This Rake task investigates the application's routes definition, then
@@ -33,8 +33,10 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
 - lib/tasks/traceroute.rake
@@ -42,6 +44,8 @@ files:
 - test/app.rb
 - test/test_helper.rb
 - test/traceroute_test.rb
+- test/traceroute_with_engine_test.rb
+- test/yaml_test.rb
 - traceroute.gemspec
 homepage: https://github.com/amatsuda/traceroute
 licenses:
@@ -53,17 +57,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: traceroute
-rubygems_version: 2.4.5
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A Rake task that helps you find the dead routes and actions for your Rails
@@ -72,3 +76,5 @@ test_files:
 - test/app.rb
 - test/test_helper.rb
 - test/traceroute_test.rb
+- test/traceroute_with_engine_test.rb
+- test/yaml_test.rb