rspec-routes_coverage 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-routes_coverage.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Shaydurov
+
+MIT License
+
+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.md

@@ -0,0 +1,81 @@
+# Rspec::RoutesCoverage
+
+Rails-RSpec plugin that will track the coverage of routes among your request specs. Intended for massive Rails JSON backends.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-routes_coverage'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This gem allows tracking both – manual coverage and automatic coverage. Automatic coverage just works – as soon as any route got at least one request it will be considered auto-tested.
+
+To allow manual coverage the gem defines `describe_request` helper. Being an extension of `describe`, this method requires route to be passed. Every route passed to `describe_request` will be considered manually-tested.
+
+spec/requests/items_spec.rb:
+```ruby
+require 'spec_helper'
+
+describe ItemsController do
+
+  describe_request :index, request_path: '/items', method: 'GET' do
+    it 'lists items' do
+      get '/items'
+      # ...
+    end
+  end
+
+  # another style:
+  describe_request 'GET /items/:id' do
+    it 'shows item' do
+      get "/items/#{Item.first.id}"
+      # ...
+    end
+  end
+
+end
+```
+
+Default gem output looks the following way:
+
+    Routes coverage stats:
+      Manually tested: 46/547
+          Auto tested: 34/547
+              Pending: 467/547
+
+By default it contains no details. To get the complete listing of routes belonging to each category, you can use `LIST_ROUTES_COVERAGE=true` environment option:
+
+    $ LIST_ROUTES_COVERAGE=true rake spec
+
+Alternatively you can run the following Rake task (ships with the gem):
+
+    $ rake spec:requests:coverage
+
+## TODO
+
+* Add the possibility to exclude some routes/namespaces from coverage analysis
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+<img src="http://roundlake.ru/assets/logo.png" align="right" />
+
+* Andrew Shaydurov ([@sandrew](https://github.com/sandrew))
+* Boris Staal ([@_inossidabile](http://twitter.com/#!/_inossidabile))
+
+## LICENSE
+
+It is free software, and may be redistributed under the terms of MIT license.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rspec-routes_coverage/dsl.rb

@@ -0,0 +1,24 @@
+module RSpec
+  module RoutesCoverage
+    module DSL
+      def describe_request(*args, &block)
+        verb, path = if args.last.is_a?(Hash) && args.last[:method] && args.last[:request_path]
+          [args.last[:method], args.last[:request_path]]
+        else
+          args[args[1].is_a?(String) ? 1 : 0].split ' '
+        end
+
+        describe *args do
+          before :all do
+            RSpec::RoutesCoverage.manually_remove_pending_route verb, path
+          end
+
+          instance_eval(&block) if block
+        end
+      end
+    end
+  end
+end
+
+extend RSpec::RoutesCoverage::DSL
+Module.send(:include, RSpec::RoutesCoverage::DSL)

data/lib/rspec-routes_coverage/request_override.rb

@@ -0,0 +1,16 @@
+require 'action_dispatch/testing/integration'
+
+module ActionDispatch
+  module Integration
+    class Session
+      private
+
+      alias_method :_old_process_method, :process
+
+      def process(method, path, parameters = nil, rack_env = nil)
+        RSpec::RoutesCoverage.auto_remove_pending_route method, path
+        _old_process_method method, path, parameters, rack_env
+      end
+    end
+  end
+end

data/lib/rspec-routes_coverage/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module RoutesCoverage
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec-routes_coverage.rb

@@ -0,0 +1,115 @@
+require 'colored'
+require 'rspec/rails'
+require 'rspec-routes_coverage/dsl'
+require 'rspec-routes_coverage/request_override'
+
+module RSpec
+  module RoutesCoverage
+    class Railtie < ::Rails::Railtie
+      railtie_name :'rspec-routes_coverage'
+
+      rake_tasks do
+        load "tasks/rspec-routes_coverage.rake"
+      end
+    end
+
+    mattr_accessor :pending_routes
+    mattr_accessor :auto_tested_routes
+    mattr_accessor :manually_tested_routes
+    mattr_accessor :tested_routes_num
+    mattr_accessor :routes_num
+
+    def self.auto_remove_pending_route(verb, path)
+      recognize_route(verb, path) do |route|
+        auto_tested_routes << route unless auto_tested_routes.include?(route)
+        pending_routes.delete route
+      end
+    end
+
+    def self.manually_remove_pending_route(verb, path)
+      recognize_route(verb, path) do |route|
+        manually_tested_routes << route unless manually_tested_routes.include?(route)
+        pending_routes.delete route
+      end
+    end
+
+    def self.recognize_route(verb, path)
+      initialize_routes!
+
+      env = Rack::MockRequest.env_for path, method: verb.upcase
+      req = ::Rails.application.routes.request_class.new env
+      ::Rails.application.routes.router.recognize(req) do |route|
+        yield route
+      end
+    end
+
+    def self.initialize_routes!
+      return if self.pending_routes
+
+      ::Rails.application.reload_routes!
+      self.pending_routes = ::Rails.application.routes.routes.routes.clone
+
+      selector  = []
+      selector += RSpec.configuration.routes_coverage.exclude_namespaces.map do |n|
+        "^/#{n}/"
+      end
+
+      unless selector.blank?
+        selector = /(#{selector.join(')|(')})/
+        self.pending_routes.select!{|x| (x.path.spec.to_s =~ selector).nil?}
+      end
+
+      self.routes_num             = ::Rails.application.routes.routes.routes.length
+      self.tested_routes_num      = self.pending_routes.length
+      self.auto_tested_routes     = []
+      self.manually_tested_routes = []
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.add_setting :routes_coverage
+  config.routes_coverage = OpenStruct.new
+
+  config.routes_coverage.exclude_namespaces = []
+  config.routes_coverage.exclude_routes = []
+
+  config.after(:suite) do
+    inspector = begin
+      require 'rails/application/route_inspector'
+      Rails::Application::RouteInspector
+    rescue
+      require 'action_dispatch/routing/inspector'
+      ActionDispatch::Routing::RoutesInspector
+    end.new
+
+    inspector.instance_eval do
+      def formatted_routes(routes)
+        verb_width = routes.map{ |r| r[:verb].length }.max
+        path_width = routes.map{ |r| r[:path].length }.max
+
+        routes.map do |r|
+          "#{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs]}"
+        end
+      end
+    end
+
+    if ENV['LIST_ROUTES_COVERAGE']
+      { green: :manually_tested_routes, blue: :auto_tested_routes, yellow: :pending_routes }.each do |color, name|
+        puts "\n\n"
+        puts "#{name.to_s.humanize} (#{RSpec::RoutesCoverage.send(name).length}/#{RSpec::RoutesCoverage.routes_num})".send(color).bold
+        puts "\n"
+        inspector.format(RSpec::RoutesCoverage.send(name)).each do |route|
+          puts '  ' + route.send(color)
+        end
+      end
+    else
+      puts  "\n\n"
+      puts  'Routes coverage stats:'
+      puts  "   Routes to test: #{RSpec::RoutesCoverage.tested_routes_num}/#{RSpec::RoutesCoverage.routes_num}".magenta
+      puts  "  Manually tested: #{RSpec::RoutesCoverage.manually_tested_routes.length}/#{RSpec::RoutesCoverage.tested_routes_num}".green
+      puts  "      Auto tested: #{RSpec::RoutesCoverage.auto_tested_routes.length}/#{RSpec::RoutesCoverage.tested_routes_num}".blue
+      print "          Pending: #{RSpec::RoutesCoverage.pending_routes.length}/#{RSpec::RoutesCoverage.tested_routes_num}".yellow
+    end
+  end
+end

data/lib/tasks/rspec-routes_coverage.rake

@@ -0,0 +1,10 @@
+namespace :spec do
+  namespace :requests do
+    desc 'run requests specs with counting of untested routes'
+    task :coverage do
+      files = Dir["spec/requests/**/*_spec.rb"].map{|f| "./"+f}
+      ENV["LIST_ROUTES_COVERAGE"] = 'true'
+      exec "ruby -S rspec #{files.join ' '}"
+    end
+  end
+end

data/rspec-routes_coverage.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rspec-routes_coverage/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Shaydurov", "Boris Staal"]
+  gem.email         = ["a.shaydurov@roundlake.ru", "boris@roundlake.ru"]
+  gem.description   = %q{Rails-RSpec plugin that will track the coverage of routes among your request specs}
+  gem.summary       = %q{Rails-RSpec plugin that will track the coverage of routes among your request specs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rspec-routes_coverage"
+  gem.require_paths = ["lib"]
+  gem.version       = RSpec::RoutesCoverage::VERSION
+
+  gem.add_dependency 'rspec-rails'
+  gem.add_dependency 'colored'
+  gem.add_dependency 'actionpack'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rspec-routes_coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Shaydurov
+- Boris Staal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70214687526240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70214687526240
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: &70214687580880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70214687580880
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70214687579620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70214687579620
+description: Rails-RSpec plugin that will track the coverage of routes among your
+  request specs
+email:
+- a.shaydurov@roundlake.ru
+- boris@roundlake.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec-routes_coverage.rb
+- lib/rspec-routes_coverage/dsl.rb
+- lib/rspec-routes_coverage/request_override.rb
+- lib/rspec-routes_coverage/version.rb
+- lib/tasks/rspec-routes_coverage.rake
+- rspec-routes_coverage.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Rails-RSpec plugin that will track the coverage of routes among your request
+  specs
+test_files: []