traceroute 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3b6798196323becbcafa21da7194fc6f277b76c
-  data.tar.gz: 5bad050aa0eeaac3caafec59897e5accabec0cb6
+  metadata.gz: 27509e75b8c7d78e3be8cabd152d8163c42dab05
+  data.tar.gz: 04b04e317cacc030b204c4a03d9d4673b51ffc76
 SHA512:
-  metadata.gz: c7f1d5534e1c1faf86556feb9a070da0fbe80f56e6515bfec3c77a184d9ea62c77239468f9a5d41919090d5d0761eb1039919f28251dc221672aaeeec93aa5b0
-  data.tar.gz: a703004cd3574d8d6f09a791eb6443e27326ee891c63d2790aa0b0a7a6edd5e37d19929f85d380f18367d88f82d83ef7884716cd3c2da93f0893b94d17e78db5
+  metadata.gz: 57a81990feedba666ccc07194640eb900fc8a705f26eef6119911691a02c685d01641dec81fe615f6ef895862aea7c46337aa1defd48924e87c2895b48b53a32
+  data.tar.gz: 0bc718b3c168f82c07e9206aa328c83f0f42375c22ecc9a127df6f3016d8ff0dc19669b87b475bb4d363b81ba02d703ea8a0f1384018a70119fe367cc6cd4fc5

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.log

data/README.rdoc

@@ -1,6 +1,6 @@
 = Traceroute
 
-A Rake task that helps you find dead routes and unused actions in your Rails 3/4 app.
+A Rake task that helps you find dead routes and unused actions in your Rails 3+ app.
 
 
 == Features
@@ -10,7 +10,7 @@ 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 (trunk)
+* Ruby 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2 (trunk)
 
 * Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x
 
@@ -29,6 +29,9 @@ Then bundle:
 Just run the following command in your Rails app directory.
   % rake traceroute
 
+If you want the rake task to fail when errors are found.
+
+  % FAIL_ON_ERROR=1 rake traceroute
 
 == What's gonna happen then?
 
@@ -75,6 +78,10 @@ OMG super helpful, isn't it?
   A: I'm afraid you're using the wrong operating system.
 
 
+== Notes
+
+  Routes prefix with `rails/` are ignored. These are generated by rails in development mode. We don't want to fail the build on these.
+
 == Questions, Feedback
 
 Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda)  ☇3☇3☇3

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :default => :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/tasks/traceroute.rake

@@ -1,35 +1,11 @@
 desc 'Prints out unused routes and unreachable action methods'
 task :traceroute => :environment do
-  Rails.application.eager_load!
-  ::Rails::InfoController rescue NameError
-  ::Rails::WelcomeController rescue NameError
-  ::Rails::MailersController rescue NameError
-  Rails.application.reload_routes!
+  traceroute = Traceroute.new Rails.application
+  traceroute.load_everything!
 
-  routes = Rails.application.routes.routes.reject {|r| r.name.nil? && r.requirements.blank?}
+  defined_action_methods = traceroute.defined_action_methods
 
-  if Rails.application.config.respond_to?(:assets)
-    exclusion_regexp = %r{^#{Rails.application.config.assets.prefix}}
-
-    routes.reject! do |route|
-      path = (defined?(ActionDispatch::Journey::Route) || defined?(Journey::Route)) ? route.path.spec.to_s : route.path
-      path =~ exclusion_regexp
-    end
-  end
-
-  defined_action_methods = ActionController::Base.descendants.map do |controller|
-    controller.action_methods.reject {|a| (a =~ /\A(_conditional)?_callback_/) || (a == '_layout_from_proc')}.map do |action|
-      "#{controller.controller_path}##{action}"
-    end
-  end.flatten
-
-  routed_actions = routes.map do |r|
-    if r.requirements[:controller].blank? && r.requirements[:action].blank? && (r.path == '/:controller(/:action(/:id(.:format)))')
-      %Q["#{r.path}"  This is a legacy wild controller route that's not recommended for RESTful applications.]
-    else
-      "#{r.requirements[:controller]}##{r.requirements[:action]}"
-    end
-  end
+  routed_actions = traceroute.routed_actions
 
   unused_routes = routed_actions - defined_action_methods
   unreachable_action_methods = defined_action_methods - routed_actions
@@ -38,4 +14,8 @@ task :traceroute => :environment do
   unused_routes.each {|route| puts "  #{route}"}
   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?
+    fail "Unused routes or unreachable action methods detected."
+  end
 end

data/lib/traceroute.rb

@@ -1,7 +1,59 @@
-module Traceroute
+class Traceroute
+  VERSION = Gem.loaded_specs['traceroute'].version.to_s
   class Railtie < ::Rails::Railtie
     rake_tasks do
       load File.join(File.dirname(__FILE__), 'tasks/traceroute.rake')
     end
   end
+
+  def initialize(app)
+    @app = app
+  end
+
+  def load_everything!
+    @app.eager_load!
+    ::Rails::InfoController rescue NameError
+    ::Rails::WelcomeController rescue NameError
+    ::Rails::MailersController rescue NameError
+    @app.reload_routes!
+
+    Rails::Engine.subclasses.each(&:eager_load!)
+  end
+
+  def defined_action_methods
+    ActionController::Base.descendants.map do |controller|
+      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
+
+  def routed_actions
+    routes.map do |r|
+      if r.requirements[:controller].blank? && r.requirements[:action].blank? && (r.path == '/:controller(/:action(/:id(.:format)))')
+        %Q["#{r.path}"  This is a legacy wild controller route that's not recommended for RESTful applications.]
+      else
+        "#{r.requirements[:controller]}##{r.requirements[:action]}"
+      end
+    end.reject {|r| r.start_with? 'rails/'}
+  end
+
+  private
+  def routes
+    routes = @app.routes.routes.reject {|r| r.name.nil? && r.requirements.blank?}
+
+    routes.reject! {|r| r.app.is_a?(ActionDispatch::Routing::Mapper::Constraints) && r.app.app.respond_to?(:call)}
+
+    routes.reject! {|r| r.app.is_a?(ActionDispatch::Routing::Redirect)}
+
+    if @app.config.respond_to?(:assets)
+      exclusion_regexp = %r{^#{@app.config.assets.prefix}}
+
+      routes.reject! do |route|
+        path = (defined?(ActionDispatch::Journey::Route) || defined?(Journey::Route)) ? route.path.spec.to_s : route.path
+        path =~ exclusion_regexp
+      end
+    end
+    routes
+  end
 end

data/test/app.rb

@@ -0,0 +1,27 @@
+require 'rails'
+require 'action_controller/railtie'
+
+require 'traceroute'
+
+module DummyApp
+  class Application < Rails::Application
+    config.root = File.expand_path('..', __FILE__)
+    config.eager_load = false
+    config.secret_key_base = '1234567890'
+  end
+end
+
+class ApplicationController < ActionController::Base; end
+
+class UsersController < ApplicationController
+  def index; end
+  def index2; end
+  def show; end
+end
+
+module Admin; class ShopsController < ApplicationController
+  def index; end
+  def create; end
+end; end
+
+DummyApp::Application.initialize!

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'rails'
+require 'traceroute'
+require_relative 'app'

data/test/traceroute_test.rb

@@ -0,0 +1,100 @@
+require_relative 'test_helper'
+
+class TracerouteTest < Minitest::Test
+  def setup
+    @traceroute = Traceroute.new Rails.application
+    @traceroute.load_everything!
+  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_routed_actions
+    assert_empty @traceroute.routed_actions
+  end
+end
+
+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
+      end
+    end
+    @traceroute = Traceroute.new Rails.application
+  end
+
+  def teardown
+    DummyApp::Application.routes.clear!
+  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
+
+class TracerouteRakeTests < Minitest::Test
+  def setup
+    require 'rake'
+    load "./lib/tasks/traceroute.rake"
+  end
+
+  def test_dont_fail_when_envvar_not_set
+    traceroute = Traceroute.new Rails.application
+    traceroute.load_everything!
+
+    ENV['FAIL_ON_ERROR'] = ""
+    Rake::Task[:traceroute].execute
+  end
+
+  def test_rake_task_fails_when_unreachable_action_method_detected
+    traceroute = Traceroute.new Rails.application
+    traceroute.load_everything!
+
+    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
+
+  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
+
+      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
+
+    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."
+    end
+  end
+
+  def teardown
+    Rake::Task.clear
+    DummyApp::Application.routes.clear!
+  end
+end

data/traceroute.gemspec

@@ -1,10 +1,9 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "traceroute/version"
 
 Gem::Specification.new do |s|
   s.name        = "traceroute"
-  s.version     = Traceroute::VERSION
+  s.version     = '0.5.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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2015-04-17 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,13 +33,15 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - README.rdoc
 - Rakefile
 - lib/tasks/traceroute.rake
 - lib/traceroute.rb
-- lib/traceroute/version.rb
+- test/app.rb
+- test/test_helper.rb
+- test/traceroute_test.rb
 - traceroute.gemspec
 homepage: https://github.com/amatsuda/traceroute
 licenses:
@@ -51,19 +53,22 @@ 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.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Rake task that helps you find the dead routes and actions for your Rails
   3 app
-test_files: []
+test_files:
+- test/app.rb
+- test/test_helper.rb
+- test/traceroute_test.rb

data/lib/traceroute/version.rb

@@ -1,3 +0,0 @@
-module Traceroute
-  VERSION = '0.4.0'
-end