route_dog 2.0.1

data/.gitignore

@@ -0,0 +1 @@
+test/mock_app/config/route_dog_routes.yml

data/README.md

@@ -0,0 +1,62 @@
+RouteDog for Ruby on Rails
+==========================
+
+RouteDog is a small collection of Rack middlewares to be used with your Ruby On Rails project as a helper to identify not tested routes.
+
+The way that RouteDog knows if you are testing a route is through the Watcher middleware which only runs in Test Environment
+and collects the routes that you've called from your Integrational Tests (See Note About Integrational Tests).
+
+The way that RouteDog shows to you a warning is through a middleware called Notifier which only runs in Developement Enviroment.
+
+
+For What This Is Useful?
+------------------------
+
+* It is useful to me :)
+
+* Suppose that you get a contract to work in a project but that was not started by you, you know that it has some tests, also you have seen
+the coverage results but you want to live the experience using the application and seeing what route is actually tested and what not.
+
+* You were a Rumble Guy that thought that tests were not necessary? ok, may be this is for you if you don't want to drop all your code.
+
+* Even if you are not planning to write Integrational Tests you can take advantage of the route defined, tested and used report.
+
+
+Usage
+-----
+
+Fetch the gem
+
+    sudo gem install route_dog
+
+Create a file RAILS_ROOT/config/initializers/route_dog.rb and put the lines below (see notes)
+
+    Rails.application.config.middleware.use RouteDog::Middleware::Watcher  if Rails.env.test?
+
+    Rails.application.config.middleware.use RouteDog::Middleware::Notifier if Rails.env.development?
+
+Run your Integrational Tests
+
+Run your application in Development Mode
+
+TODO
+----
+
+* Show Notifier warnings for other than regular html responses.
+* Rake task to show stadistics about routes defined, used and tested.
+* Blocker middleware to disallow not tested routes in Production Environment.
+* Blocker middleware also should remove from your page response links to not tested resources.
+
+Notes
+-----
+
+* Watcher middleware don't work with Controller Tests, it only works with Integrational Tests except if you are running RSpec, because RSpec
+controller tests are an extension of Integrational Tests, but this will be not longer supported by RSpec.
+
+* Watcher and Notifier middlewares may need be loaded after or before another middleware, that is the case if you are using Warden.
+
+    `Rails.application.config.middleware.insert_before Warden::Manager, RouteDog::Middleware::Watcher  if Rails.env.test?`
+
+    `Rails.application.config.middleware.insert_before Warden::Manager, RouteDog::Middleware::Notifier if Rails.env.development?`
+
+* Be sure to call `rake route_dog:clean` once in a while to ensure that the tested route list remains updated.

data/Rakefile

@@ -0,0 +1,36 @@
+require "rake/testtask"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "route_dog"
+    gem.summary = %Q{Watch and Notify your not tested routes of a RoR Application}
+    gem.description = %Q{Watch and Notify your not tested routes of a RoR Application}
+    gem.email = "zevarito@gmail.com"
+    gem.homepage = "http://github.com/zevarito/route_dog"
+    gem.authors = ["Alvaro Gil"]
+    gem.add_dependency 'rack'
+    gem.add_dependency 'rails', '>=2.3.8'
+    gem.add_development_dependency "contest", "=0.1.2"
+    gem.add_development_dependency "nokogiri", "=1.4.3.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Default: run tests"
+task :default => :test
+
+namespace :route_dog do
+  desc "Clean Tested Routes File"
+  task :clean do
+    File.delete("test/mock_app/config/route_dog_routes.yml") if File.exists? "test/mock_app/config/route_dog_routes.yml"
+  end
+end
+
+Rake::TestTask.new do |t|
+  Rake::Task["route_dog:clean"].invoke
+  t.libs << "lib" << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.1

data/lib/route_dog/middleware/notifier.rb

@@ -0,0 +1,39 @@
+module RouteDog
+  module Middleware
+    class Notifier < RouteDog
+      def initialize(app)
+        @app = app
+        super
+      end
+
+      def call(env)
+        @env = env
+
+        status, headers, @response = @app.call(env)
+
+        append_warning if !route_tested?
+
+        [status, headers, @response]
+      end
+
+      def append_warning
+        @response.each do |part|
+          part.gsub!("<body>", "<body>#{warning_html}")
+        end
+      end
+
+      def no_test_message
+        "The Route #{request_method.to_s.upcase} #{identify_controller.to_s}##{identify_action.to_s} -- Has Not Integrational Tests!"
+      end
+
+      def warning_html
+        <<-EOT
+          <div style="display: block; height:70px;"></div>
+          <div id="route_dog_warning" style="display: block; width: 100%; height: 70px; text-align: center; margin:0; position:absolute; top:0; background: red; font-size: 18px; font-weight: bold">
+            <h1 style="color: #fff; font-size: 20px; margin: 20px 0 35px">#{no_test_message}</h1>
+          </div>
+        EOT
+      end
+    end
+  end
+end

data/lib/route_dog/middleware/route_dog.rb

@@ -0,0 +1,51 @@
+require 'rack'
+
+module RouteDog
+  module Middleware
+    class RouteDog
+      def initialize(app)
+        require File.join(Rails.root, 'config/routes.rb')
+        initialize_yaml_file
+      end
+
+      def self.config_file
+        File.join(Rails.root, 'config', 'route_dog_routes.yml')
+      end
+
+      def initialize_yaml_file
+        @watched_routes = YAML.load_file(Watcher.config_file)
+      rescue Errno::ENOENT
+        @watched_routes = {}
+      end
+
+      def request_path
+        @env['PATH_INFO']
+      end
+
+      def request_method
+        @env['REQUEST_METHOD'].downcase.to_sym
+      end
+
+      def identify_controller
+        identify_path[:controller]
+      end
+
+      def identify_action
+        identify_path[:action]
+      end
+
+      def route_tested?
+        initialize_yaml_file
+        begin
+          @watched_routes[identify_controller.to_s][identify_action.to_s].include?(request_method.to_s)
+        rescue
+          false
+        end
+      end
+
+      def identify_path
+        Rails.application.routes.recognize_path(request_path, :method => request_method)
+      end
+    end
+  end
+end

data/lib/route_dog/middleware/watcher.rb

@@ -0,0 +1,32 @@
+module RouteDog
+  module Middleware
+    class Watcher < RouteDog
+      def initialize(app)
+        @app = app
+        super
+      end
+
+      def call(env)
+        @env = env
+
+        status, headers, response = @app.call(env)
+
+        store_route if status.to_i < 400
+
+        [status, headers, response]
+      end
+
+    private
+
+      def store_route
+        @watched_routes[identify_controller] ||= {}
+        @watched_routes[identify_controller][identify_action] ||= []
+        @watched_routes[identify_controller][identify_action] << request_method.to_s
+        @watched_routes[identify_controller][identify_action].uniq!
+        File.open(Watcher.config_file, "w+") {|file| file.puts(@watched_routes.to_yaml) }
+      rescue ActionController::RoutingError
+        false
+      end
+    end
+  end
+end

data/lib/route_dog.rb

@@ -0,0 +1,3 @@
+require 'route_dog/middleware/route_dog'
+require 'route_dog/middleware/watcher'
+require 'route_dog/middleware/notifier'

data/route_dog.gemspec

@@ -0,0 +1,130 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{route_dog}
+  s.version = "2.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alvaro Gil"]
+  s.date = %q{2010-10-23}
+  s.description = %q{Watch and Notify your not tested routes of a RoR Application}
+  s.email = %q{zevarito@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/route_dog.rb",
+     "lib/route_dog/middleware/notifier.rb",
+     "lib/route_dog/middleware/route_dog.rb",
+     "lib/route_dog/middleware/watcher.rb",
+     "route_dog.gemspec",
+     "test/integration/products_controller_test.rb",
+     "test/integration/sessions_controller.rb",
+     "test/integration/users_controller_test.rb",
+     "test/mock_app/.gitignore",
+     "test/mock_app/Gemfile",
+     "test/mock_app/Gemfile.lock",
+     "test/mock_app/Rakefile",
+     "test/mock_app/app/controllers/application_controller.rb",
+     "test/mock_app/app/controllers/products_controller.rb",
+     "test/mock_app/app/controllers/sessions_controller_test.rb",
+     "test/mock_app/app/controllers/users_controller.rb",
+     "test/mock_app/app/helpers/application_helper.rb",
+     "test/mock_app/app/views/layouts/application.html.erb",
+     "test/mock_app/app/views/users/index.html.erb",
+     "test/mock_app/config.ru",
+     "test/mock_app/config/application.rb",
+     "test/mock_app/config/boot.rb",
+     "test/mock_app/config/database.yml",
+     "test/mock_app/config/environment.rb",
+     "test/mock_app/config/environments/development.rb",
+     "test/mock_app/config/environments/production.rb",
+     "test/mock_app/config/environments/test.rb",
+     "test/mock_app/config/initializers/backtrace_silencers.rb",
+     "test/mock_app/config/initializers/inflections.rb",
+     "test/mock_app/config/initializers/mime_types.rb",
+     "test/mock_app/config/initializers/route_dog.rb",
+     "test/mock_app/config/initializers/secret_token.rb",
+     "test/mock_app/config/initializers/session_store.rb",
+     "test/mock_app/config/locales/en.yml",
+     "test/mock_app/config/routes.rb",
+     "test/mock_app/db/seeds.rb",
+     "test/mock_app/public/404.html",
+     "test/mock_app/public/422.html",
+     "test/mock_app/public/500.html",
+     "test/mock_app/public/favicon.ico",
+     "test/mock_app/public/images/rails.png",
+     "test/mock_app/public/index.html",
+     "test/mock_app/public/javascripts/application.js",
+     "test/mock_app/public/javascripts/controls.js",
+     "test/mock_app/public/javascripts/dragdrop.js",
+     "test/mock_app/public/javascripts/effects.js",
+     "test/mock_app/public/javascripts/prototype.js",
+     "test/mock_app/public/javascripts/rails.js",
+     "test/mock_app/public/robots.txt",
+     "test/mock_app/public/stylesheets/.gitkeep",
+     "test/support/assertions.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/zevarito/route_dog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Watch and Notify your not tested routes of a RoR Application}
+  s.test_files = [
+    "test/integration/products_controller_test.rb",
+     "test/integration/sessions_controller.rb",
+     "test/integration/users_controller_test.rb",
+     "test/mock_app/app/controllers/application_controller.rb",
+     "test/mock_app/app/controllers/products_controller.rb",
+     "test/mock_app/app/controllers/sessions_controller_test.rb",
+     "test/mock_app/app/controllers/users_controller.rb",
+     "test/mock_app/app/helpers/application_helper.rb",
+     "test/mock_app/config/application.rb",
+     "test/mock_app/config/boot.rb",
+     "test/mock_app/config/environment.rb",
+     "test/mock_app/config/environments/development.rb",
+     "test/mock_app/config/environments/production.rb",
+     "test/mock_app/config/environments/test.rb",
+     "test/mock_app/config/initializers/backtrace_silencers.rb",
+     "test/mock_app/config/initializers/inflections.rb",
+     "test/mock_app/config/initializers/mime_types.rb",
+     "test/mock_app/config/initializers/route_dog.rb",
+     "test/mock_app/config/initializers/secret_token.rb",
+     "test/mock_app/config/initializers/session_store.rb",
+     "test/mock_app/config/routes.rb",
+     "test/mock_app/db/seeds.rb",
+     "test/support/assertions.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.3.8"])
+      s.add_development_dependency(%q<contest>, ["= 0.1.2"])
+      s.add_development_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 2.3.8"])
+      s.add_dependency(%q<contest>, ["= 0.1.2"])
+      s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 2.3.8"])
+    s.add_dependency(%q<contest>, ["= 0.1.2"])
+    s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+  end
+end
+

data/test/integration/products_controller_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+
+class ProductsControllerTest < ActionController::IntegrationTest
+
+  def setup
+    @controller = ProductsController.new
+  end
+
+  context "Notifier Middleware" do
+    test "Show notification of a not tested GET request" do
+      get "/products/new"
+
+      assert_notify_for(:products, :new, :get)
+    end
+
+    test "Show notification of a not tested POST request" do
+      post "/products"
+
+      assert_notify_for(:products, :create, :post)
+    end
+
+    test "Show notification of a not tested DELETE request" do
+      delete "/products/1"
+
+      assert_notify_for(:products, :destroy, :delete)
+    end
+
+    test "Show notification of a not tested PUT request" do
+      put "/products/1"
+
+      assert_notify_for(:products, :update, :put)
+    end
+
+    test "Not show notifications for tested routes" do
+      get "/products"
+      assert_watched_routes_include(:products, :index, :get)
+      get "/products"
+      assert_not_notify_for(:products, :index, :get)
+    end
+  end
+end

data/test/integration/sessions_controller.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+
+class SessionsControllerTest < ActionController::IntegrationTest
+
+  def setup
+    @controller = SessionsController.new
+  end
+
+  context "Watcher Middleware" do
+    test "Identifying routes of actions that respond to more than one method" do
+      get "/sessions/1/logout"
+      delete "/sessions/1/logout"
+
+      assert_watched_routes_include(:sessions, :logout, :delete)
+      assert_watched_routes_include(:sessions, :logout, :delete)
+    end
+  end
+end

data/test/integration/users_controller_test.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+
+class UsersControllerTest < ActionController::IntegrationTest
+
+  def setup
+    @controller = UsersController.new
+  end
+
+  context "Watcher Middleware" do
+    context "Not Tested Routes" do
+      test "users#index" do
+        assert_watched_routes_not_include(:users, :index, :get)
+      end
+
+      test "users#new" do
+        assert_watched_routes_not_include(:users, :new, :get)
+      end
+
+      test "users#create" do
+        assert_watched_routes_not_include(:users, :create, :post)
+      end
+
+      test "users#show" do
+        assert_watched_routes_not_include(:users, :show, :get)
+      end
+
+      test "users#edit" do
+        assert_watched_routes_not_include(:users, :edit, :get)
+      end
+
+      test "users#update" do
+        assert_watched_routes_not_include(:users, :update, :put)
+      end
+
+      test "users#destroy" do
+        assert_watched_routes_not_include(:users, :destroy, :delete)
+      end
+    end
+
+    context "Tested Routes" do
+      test "users#index" do
+        get '/users'
+        assert_watched_routes_include(:users, :index, :get)
+      end
+
+      test "users#new" do
+        get '/users/new'
+        assert_watched_routes_include(:users, :new, :get)
+      end
+
+      test "users#create" do
+        post '/users'
+        assert_watched_routes_include(:users, :create, :post)
+      end
+
+      test "users#show" do
+        get '/users/1'
+        assert_watched_routes_include(:users, :show, :get)
+      end
+
+      test "users#edit" do
+        get '/users/1/edit'
+        assert_watched_routes_include(:users, :edit, :get)
+      end
+
+      test "users#update" do
+        put '/users/1'
+        assert_watched_routes_include(:users, :update, :put)
+      end
+
+      test "users#destroy" do
+        delete '/users/1'
+        assert_watched_routes_include(:users, :destroy, :delete)
+      end
+
+      context "Duplicated Routes" do
+        test "routes should not be duplicated in the watched list" do
+          get '/users/1/edit'
+          get '/users/1/edit'
+          assert_watched_routes_include(:users, :destroy, :delete)
+        end
+      end
+    end
+  end
+end

data/test/mock_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/**/*

data/test/mock_app/Gemfile

@@ -0,0 +1,30 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.1'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/test/mock_app/Gemfile.lock

@@ -0,0 +1,73 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    mail (2.2.7)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (= 3.0.1)
+  sqlite3-ruby

data/test/mock_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+MockApp::Application.load_tasks

data/test/mock_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/mock_app/app/controllers/products_controller.rb

@@ -0,0 +1,21 @@
+class ProductsController < ApplicationController
+  def new
+    redirect_to users_path
+  end
+
+  def create
+    redirect_to users_path
+  end
+
+  def index
+    redirect_to users_path
+  end
+
+  def update
+    redirect_to users_path
+  end
+
+  def destroy
+    redirect_to users_path
+  end
+end

data/test/mock_app/app/controllers/sessions_controller_test.rb

@@ -0,0 +1,5 @@
+class SessionsController < ApplicationController
+  def logout
+    redirect_to '/'
+  end
+end