traceroute 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d8b37c9335b489410893260a96d0bd1146358ab4907bfa6593230c126dd1c5
-  data.tar.gz: 1a877a2573c1d01ff38a4e5710ad3854bd4ab9b508165ecf398bba83615c0558
+  metadata.gz: 291c384ad195a4230680d6d2a39d0f408e60d16eb0b51427d9d2fda091c162fb
+  data.tar.gz: 8f23318498f820271d61e9d841d8970e3dbff7de0a9d61708a77bd5243f48f2e
 SHA512:
-  metadata.gz: 0bd199897fcaa8a7b679f29c09031a5a8a24d3e440831fd3e359dcd57e91861b6c36a76276ed2240263eddc638922b4cd076f9d8866893af75deccd08b77e59a
-  data.tar.gz: 3e95179846678c7e1777dc94877ff93f01e4264e3f2c594d8e45221d654c57807969fb8331208ff89347d7b1c09814c7570aa9709f2cec760c60a0cd324c7438
+  metadata.gz: f165fa1c116887d9993c06da4a29872e4f72d816724314878e24d619bc893e074897b36b64ff819656cce2fca14b492664723e3dc7e4d3a28da2e1d39f19b7ab
+  data.tar.gz: '069cf2f92bd6bd7468e64c1b2bbe6f5431b855dc757613ee1aa0b87322fd02d57cbe90e7c813a2e3135e3b7d3237c65a6572e6a72a2b0ecfd721af603ed17ce6'

data/lib/tasks/traceroute.rake

@@ -9,16 +9,35 @@ task :traceroute => :environment do
 
   routed_actions = traceroute.routed_actions
 
-  unused_routes = routed_actions - defined_action_methods
-  unreachable_action_methods = defined_action_methods - routed_actions
+  unless ENV['UNREACHABLE_ACTION_METHODS_ONLY']
+    unused_routes = routed_actions - defined_action_methods
+    puts "Unused routes (#{unused_routes.count}):"
+    unused_routes.each {|route| puts "  #{route}"}
+  end
+
+  puts unless (ENV['UNREACHABLE_ACTION_METHODS_ONLY'] || ENV['UNUSED_ROUTES_ONLY'])
 
-  puts "Unused routes (#{unused_routes.count}):"
-  unused_routes.each {|route| puts "  #{route}"}
-  puts
-  puts "Unreachable action methods (#{unreachable_action_methods.count}):"
-  unreachable_action_methods.each {|action| puts "  #{action}"}
+  unless ENV['UNUSED_ROUTES_ONLY']
+    unreachable_action_methods = defined_action_methods - routed_actions
+    puts "Unreachable action methods (#{unreachable_action_methods.count}):"
+    unreachable_action_methods.each {|action| puts "  #{action}"}
+  end
 
-  unless (unused_routes.empty? && unreachable_action_methods.empty?) || ENV['FAIL_ON_ERROR'] != "1"
+  if ENV['FAIL_ON_ERROR'] && ((!ENV['UNREACHABLE_ACTION_METHODS_ONLY'] && unused_routes.any?) || (!ENV['UNUSED_ROUTES_ONLY'] && unreachable_action_methods.any?))
     fail "Unused routes or unreachable action methods detected."
   end
 end
+
+namespace :traceroute do
+  desc 'Prints out unused routes'
+  task :unused_routes => :environment do
+    ENV['UNUSED_ROUTES_ONLY'] = '1'
+    Rake::Task[:traceroute].invoke
+  end
+
+  desc 'Prints out unreachable action methods'
+  task :unreachable_action_methods => :environment do
+    ENV['UNREACHABLE_ACTION_METHODS_ONLY'] = '1'
+    Rake::Task[:traceroute].invoke
+  end
+end

data/lib/traceroute.rb

@@ -14,7 +14,22 @@ class Traceroute
 
   def initialize(app)
     @app = app
-    load_ignored_regex!
+
+    @ignored_unreachable_actions = []
+    @ignored_unused_routes = [/^\/cable$/]
+
+    @ignored_unused_routes << %r{^#{@app.config.assets.prefix}} if @app.config.respond_to? :assets
+
+    config_filename = %w(.traceroute.yaml .traceroute.yml .traceroute).detect {|f| File.exist?(f)}
+    if config_filename && (config = YAML.load_file(config_filename))
+      (config['ignore_unreachable_actions'] || []).each do |ignored_action|
+        @ignored_unreachable_actions << Regexp.new(ignored_action)
+      end
+
+      (config['ignore_unused_routes'] || []).each do |ignored_action|
+        @ignored_unused_routes << Regexp.new(ignored_action)
+      end
+    end
   end
 
   def load_everything!
@@ -51,50 +66,6 @@ class Traceroute
     end.compact.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\//, /^\/cable$/]
-
-    @ignored_unused_routes << %r{^#{@app.config.assets.prefix}} if @app.config.respond_to? :assets
-
-    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
     collect_routes @app.routes.routes
   end

data/test/test_helper.rb

@@ -5,3 +5,13 @@ require 'minitest/autorun'
 require 'rails'
 require 'traceroute'
 require_relative 'app'
+
+Minitest::Test.class_eval do
+  def assert_defined_action_methods(*actions)
+    assert_equal actions.sort, @traceroute.defined_action_methods.reject {|a| a =~ /^rails/}.sort
+  end
+
+  def assert_routed_actions(*actions)
+    assert_equal actions.sort, @traceroute.routed_actions.sort
+  end
+end

data/test/traceroute_test.rb

@@ -9,7 +9,7 @@ module TracerouteTest
     end
 
     def test_defined_action_methods
-      assert_equal ['users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index', 'api/books#create', 'api/books#index'].sort, @traceroute.defined_action_methods.sort
+      assert_defined_action_methods 'users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index', 'api/books#create', 'api/books#index'
     end
 
     def test_routed_actions
@@ -39,7 +39,7 @@ module TracerouteTest
     end
 
     def test_routed_actions
-      assert_equal ['admin/shops#index', 'api/books#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
+      assert_routed_actions 'admin/shops#index', 'api/books#index', 'users#index', 'users#show', 'users#new', 'users#create'
     end
   end
 
@@ -56,11 +56,6 @@ module TracerouteTest
       DummyApp::Application.routes.clear!
     end
 
-    def test_dont_fail_when_envvar_is_anything_but_1
-      ENV['FAIL_ON_ERROR'] = "DERP"
-      Rake::Task[:traceroute].execute
-    end
-
     def test_rake_task_fails_when_unreachable_action_method_detected
       ENV['FAIL_ON_ERROR']="1"
       Rake::Task[:traceroute].execute

data/test/traceroute_with_engine_test.rb

@@ -32,7 +32,7 @@ module TracerouteWithEngineTest
     end
 
     def test_defined_action_methods
-      assert_equal ["admin/shops#create", "admin/shops#index", "api/books#create", "api/books#index", "test_engine/tasks#index", "users#index", "users#index2", "users#show"].sort, @traceroute.defined_action_methods.sort
+      assert_defined_action_methods 'admin/shops#create', 'admin/shops#index', 'api/books#create', 'api/books#index', 'test_engine/tasks#index', 'users#index', 'users#index2', 'users#show'
     end
 
     def test_routed_actions
@@ -56,7 +56,7 @@ module TracerouteWithEngineTest
     end
 
     def test_routed_actions
-      assert_equal ['posts#index', 'posts#show', 'posts#new', 'posts#create'].sort, @traceroute.routed_actions.sort
+      assert_routed_actions 'posts#index', 'posts#show', 'posts#new', 'posts#create'
     end
   end
 
@@ -83,11 +83,11 @@ module TracerouteWithEngineTest
     end
 
     def test_defined_action_methods
-      assert_equal ["admin/shops#create", "admin/shops#index", "api/books#create", "api/books#index", "test_engine/tasks#index", "users#index", "users#index2", "users#show"].sort, @traceroute.defined_action_methods.sort
+      assert_defined_action_methods 'admin/shops#create', 'admin/shops#index', 'api/books#create', 'api/books#index', 'test_engine/tasks#index', 'users#index', 'users#index2', 'users#show'
     end
 
     def test_routed_actions
-      assert_equal ['posts#index', 'posts#show', 'test_engine/tasks#index'].sort, @traceroute.routed_actions.sort
+      assert_routed_actions 'posts#index', 'posts#show', 'test_engine/tasks#index'
     end
   end
 end

data/test/yaml_test.rb

@@ -56,7 +56,7 @@ class DotFileTest < Minitest::Test
   end
 
   def test_used_routes_are_ignored
-    assert_equal ['admin/shops#index', 'api/books#index'].sort, @traceroute.routed_actions.sort
+    assert_routed_actions 'admin/shops#index', 'api/books#index'
   end
 end
 
@@ -88,11 +88,11 @@ class EmptyFileTest < Minitest::Test
   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', 'api/books#create', 'api/books#index', 'jasmine_rails/spec_runner#index'].sort, @traceroute.defined_action_methods.sort
+    assert_defined_action_methods 'users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index', 'api/books#create', 'api/books#index', 'jasmine_rails/spec_runner#index'
   end
 
   def test_property_with_no_key
-    assert_equal ['admin/shops#index', 'api/books#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
+    assert_routed_actions 'admin/shops#index', 'api/books#index', 'users#index', 'users#show', 'users#new', 'users#create'
   end
 end
 
@@ -127,11 +127,11 @@ class InvalidFileTest < Minitest::Test
   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', 'api/books#create', 'api/books#index', 'jasmine_rails/spec_runner#index'].sort, @traceroute.defined_action_methods.sort
+    assert_defined_action_methods 'users#index', 'users#show', 'users#index2', 'admin/shops#create', 'admin/shops#index', 'api/books#create', 'api/books#index', 'jasmine_rails/spec_runner#index'
   end
 
   def test_property_with_no_key
-    assert_equal ['admin/shops#index', 'api/books#index', 'users#index', 'users#show', 'users#new', 'users#create'].sort, @traceroute.routed_actions.sort
+    assert_routed_actions 'admin/shops#index', 'api/books#index', 'users#index', 'users#show', 'users#new', 'users#create'
   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.7.1'
+  s.version     = '0.8.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Akira Matsuda']
   s.email       = ['ronnie@dio.jp']
@@ -11,8 +11,6 @@ Gem::Specification.new do |s|
   s.summary     = 'A Rake task that helps you find the dead routes and actions for your Rails 3 app'
   s.description =  "This Rake task investigates the application's routes definition, then tells you unused routes and unreachable action methods"
 
-  s.rubyforge_project = 'traceroute'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traceroute
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: traceroute
-rubygems_version: 2.7.7
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Rake task that helps you find the dead routes and actions for your Rails