routes_coverage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29bd7e16ae5978198cfd1b76f2806ff6261199e9
+  data.tar.gz: 87304e4e85b56a6030420d438b57ed8fb68aa635
+SHA512:
+  metadata.gz: dd7deaa57566e7eef61acb913199e39c3c0b14e5ea017054eb60f60b38901aac11ba57e772da71b6a9d64707f03e60179aa7f39e3386178401a6714411e93b0f
+  data.tar.gz: 5932d5baf88b7e81267d6b8b8995dc865ff9134cea1bcebe20b201f6a49891bcc2dc6617a34a69366cf9cb82674cd15386f31ff9b21e81b0c198d88e17e7064d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in routes_coverage.gemspec
+gemspec
+
+#TODO: appraisal
+gem 'rails', '4.0.13'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vasily Fedoseyev
+
+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,40 @@
+# RoutesCoverage
+
+Sometimes you need to know which routes are covered by your rails test suite.
+
+(more detailed readme coming soon)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'routes_coverage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install routes_coverage
+
+## Usage
+
+Install the gem and run your tests.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Vasfed/routes_coverage.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+task :default => :spec
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'routes_coverage/version'
+
+Bundler::GemHelper.install_tasks

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails"
+require "routes_coverage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/routes_coverage.rb

@@ -0,0 +1,77 @@
+require "routes_coverage/version"
+require "routes_coverage/result"
+require "routes_coverage/middleware"
+
+require "routes_coverage/formatters/summary_text"
+require "routes_coverage/formatters/full_text"
+
+module RoutesCoverage
+  class Railtie < ::Rails::Railtie
+    railtie_name :routes_coverage
+
+    initializer "request_coverage.inject_test_middleware" do
+      if RoutesCoverage.enabled?
+        ::Rails.application.middleware.use RoutesCoverage::Middleware
+      end
+    end
+  end
+
+  class Settings
+    attr_reader :exclude_patterns
+    attr_reader :exclude_namespaces
+    attr_accessor :minimum_coverage
+    attr_accessor :round_precision
+
+    attr_accessor :format
+
+    def initialize
+      @exclude_patterns = []
+      @exclude_namespaces = []
+      @minimum_coverage = 80
+      @round_precision = 1
+      @format = :summary_text
+    end
+  end
+
+  def self.enabled?
+    ::Rails.env.test?
+  end
+
+  def self.settings
+    @@settings ||= Settings.new
+  end
+
+  mattr_reader :current_result
+  mattr_reader :pid
+
+  def self.reset!
+    @@current_result = Result.new
+    @@pid = Process.pid
+  end
+
+  def self.perform_report
+    result = current_result
+
+    formatter_class = case settings.format
+    when :full_text
+      Formatters::FullText
+    when :summary_text
+      Formatters::SummaryText
+    else
+      raise "Unknown formatter #{settings.format.inspect}"
+    end
+
+    formatter = formatter_class.new(result, settings)
+    puts formatter.format
+  end
+
+end
+
+if RoutesCoverage.enabled?
+  if defined? RSpec
+    require "routes_coverage/adapters/rspec"
+  else
+    require "routes_coverage/adapters/atexit"
+    RoutesCoverage::Adapters::AtExit.use
+  end
+end

data/lib/routes_coverage/adapters/atexit.rb

@@ -0,0 +1,18 @@
+module RoutesCoverage
+  module Adapters
+    class AtExit
+      def self.use coverer=nil
+        #NB: at_exit order is important, for example minitest uses it to run, need to install our handler before it
+        # also this may interfere with simplecov, need to use SimpleCov.at_exit do...end if defined
+
+        # puts "Using at_exit, note this may be interfered by simplecov etc."
+        RoutesCoverage.reset!
+        at_exit do
+          next if RoutesCoverage.pid != Process.pid
+          RoutesCoverage.perform_report
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/routes_coverage/adapters/rspec.rb

@@ -0,0 +1,73 @@
+RSpec.configure do |config|
+  config.add_setting :routes_coverage
+  config.routes_coverage = RoutesCoverage.settings
+
+  config.before(:suite) do
+    RoutesCoverage.reset!
+  end
+
+  config.after(:suite) do
+    RoutesCoverage.perform_report
+  end
+end
+
+# RSpec::RoutesCoverage.initialize_routes!
+#
+#
+# if ENV['LIST_ROUTES_COVERAGE']
+#   # require 'action_dispatch/routing/inspector'
+#
+#   format_routes = ->(routes){
+#     formatter = ActionDispatch::Routing::ConsoleFormatter.new
+#     ActionDispatch::Routing::RoutesInspector.new(routes).format(formatter)
+#   }
+#
+#   # inspector = begin
+#   #   require 'rails/application/route_inspector'
+#   #   Rails::Application::RouteInspector
+#   # rescue LoadError
+#   #   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
+#
+#
+#   legend = {
+#     magenta: :excluded_routes,
+#     green:   :manually_tested_routes,
+#     blue:    :auto_tested_routes,
+#     yellow:  :pending_routes
+#   }
+#
+#   legend.each do |color, name|
+#     total = name == :excluded_routes ? RSpec::RoutesCoverage.routes_num : RSpec::RoutesCoverage.tested_routes_num
+#
+#     puts "\n\n"
+#     puts "#{name.to_s.humanize} (#{RSpec::RoutesCoverage.send(name).length}/#{total})".send(color).bold
+#     puts "\n"
+#     # format_routes.call(RSpec::RoutesCoverage.send(name)).each do |route|
+#     #   puts '  ' + route.send(color)
+#     # end
+#     routes = RSpec::RoutesCoverage.send(name)
+#     if routes.any?
+#       puts format_routes.call(routes).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

data/lib/routes_coverage/formatters/full_text.rb

@@ -0,0 +1,62 @@
+require 'action_dispatch/routing/inspector'
+
+module RoutesCoverage
+  module Formatters
+    class FullText < SummaryText
+
+      class RouteFormatter < ActionDispatch::Routing::ConsoleFormatter
+        def no_routes
+          @buffer << "\tNone"
+        end
+
+        private
+        HEADER = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']
+        def draw_section(routes)
+          header_lengths = HEADER.map(&:length)
+          name_width, verb_width, path_width, reqs_width = widths(routes).zip(header_lengths).map(&:max)
+
+          routes.map do |r|
+            "#{r[:name].rjust(name_width)} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs].ljust(reqs_width)} ?"
+          end
+        end
+
+        def draw_header(routes)
+          name_width, verb_width, path_width, reqs_width = widths(routes)
+
+          "#{"Prefix".rjust(name_width)} #{"Verb".ljust(verb_width)} #{"URI Pattern".ljust(path_width)} #{"Controller#Action".ljust(reqs_width)} Hits"
+        end
+
+        def widths(routes)
+          [routes.map { |r| r[:name].length }.max || 0,
+           routes.map { |r| r[:verb].length }.max || 0,
+           routes.map { |r| r[:path].length }.max || 0,
+           routes.map { |r| r[:reqs].length }.max || 0,
+         ]
+        end
+      end
+
+      def hit_routes
+        routes = result.hit_routes
+
+        # verb_width = routes.map{ |r| r[:verb].length }.max
+        # path_width = routes.map{ |r| r[:path].length }.max
+
+        [
+          "Covered routes:",
+          # "#{"Verb".ljust(verb_width)} #{"Path".ljust(path_width)} Reqs",
+          # routes.map do |r|
+          #   "#{r.verb.ljust(verb_width)} #{r.path.ljust(path_width)} #{r.reqs}"
+          # end
+          ActionDispatch::Routing::RoutesInspector.new(routes).format(RouteFormatter.new),
+          nil,
+          "Pending routes:",
+          ActionDispatch::Routing::RoutesInspector.new(result.pending_routes).format(RouteFormatter.new),
+        ].flatten.join("\n")
+      end
+
+      def format
+        "\nRoutes coverage is #{result.coverage}% (#{hits_count})#{status}\n\n#{hit_routes}"
+      end
+    end
+  end
+end

data/lib/routes_coverage/formatters/summary_text.rb

@@ -0,0 +1,29 @@
+module RoutesCoverage
+  module Formatters
+    class SummaryText
+      def initialize result, settings
+        @result = result
+        @settings = settings
+      end
+
+      attr_reader :result
+      attr_reader :settings
+
+      def hits_count
+        "#{result.hit_routes_count} of #{result.expected_routes_count}#{"(#{result.total_count} total)" if result.expected_routes_count != result.total_count} routes hit#{ " at #{result.avg_hits} hits average" if result.hit_routes_count > 0}"
+      end
+
+      def status
+        if result.coverage_pass?
+          ""
+        else
+          "\nCoverage failed. Need at least #{(settings.minimum_coverage / 100.0 * result.total_count).ceil}"
+        end
+      end
+
+      def format
+        "Routes coverage is #{result.coverage}% (#{hits_count})#{status}"
+      end
+    end
+  end
+end

data/lib/routes_coverage/middleware.rb

@@ -0,0 +1,20 @@
+module RoutesCoverage
+  class Middleware
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      # method = env["REQUEST_METHOD"]
+      # path = env["REQUEST_PATH"] || env["PATH_INFO"] || env["ORIGINAL_FULLPATH"]
+      # puts "req #{method} #{env["REQUEST_PATH"]} || #{env["ORIGINAL_FULLPATH"]} || #{env["PATH_INFO"]}"
+      # puts "env is #{env.inspect}"
+      req = ::Rails.application.routes.request_class.new env
+      ::Rails.application.routes.router.recognize(req) do |route|
+        RoutesCoverage.current_result.touch_route(route)
+      end
+      #TODO: detect 404s? and maybe other route errors?
+      @app.call(env)
+    end
+  end
+end

data/lib/routes_coverage/result.rb

@@ -0,0 +1,89 @@
+module RoutesCoverage
+  class Result
+    def initialize
+      @route_hits = Hash.new(0)
+    end
+
+    attr_reader :route_hits
+
+    def touch_route route
+      @route_hits[route] += 1
+    end
+
+    def all_routes
+      ::Rails.application.routes.routes.routes
+    end
+
+    def expected_routes
+      return @expected_routes if @expected_routes
+
+      routes = all_routes.dup
+
+      if defined?(::Sprockets) && defined?(::Sprockets::Environment)
+        routes.reject!{|r| r.app.is_a?(::Sprockets::Environment) }
+      end
+
+      excluded_routes = []
+      regex = Regexp.union(RoutesCoverage.settings.exclude_patterns)
+      routes.reject!{|r|
+        if "#{r.verb.to_s[8..-3]} #{r.path.spec}".strip =~ regex
+          excluded_routes << r
+        end
+      }
+
+      namespaces_regex = Regexp.union(RoutesCoverage.settings.exclude_namespaces.map{|n| /^\/#{n}/})
+      routes.reject!{|r|
+        if r.path.spec.to_s =~ namespaces_regex
+          excluded_routes << r
+        end
+      }
+
+      @excluded_routes = excluded_routes
+      @expected_routes = routes
+    end
+
+    def pending_routes
+      expected_routes - hit_routes
+    end
+
+    def excluded_routes
+      expected_routes
+      @excluded_routes
+    end
+
+    def hit_routes
+      #TODO: sort?
+      route_hits.keys
+    end
+
+
+    def hit_routes_count
+      route_hits.size
+    end
+
+    def expected_routes_count
+      expected_routes.size
+    end
+
+    def excluded_routes_count
+      excluded_routes.size
+    end
+
+    def total_count
+      all_routes.size
+    end
+
+    def coverage
+      return 'n/a' unless expected_routes.any?
+      (hit_routes_count * 100.0 / expected_routes_count).round(RoutesCoverage.settings.round_precision)
+    end
+
+    def avg_hits
+      (route_hits.values.sum.to_f / hit_routes_count).round(RoutesCoverage.settings.round_precision)
+    end
+
+    def coverage_pass?
+      coverage >= RoutesCoverage.settings.minimum_coverage
+    end
+  end
+end

data/lib/routes_coverage/version.rb

@@ -0,0 +1,3 @@
+module RoutesCoverage
+  VERSION = "0.0.1"
+end

data/routes_coverage.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'routes_coverage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "routes_coverage"
+  spec.version       = RoutesCoverage::VERSION
+  spec.authors       = ["Vasily Fedoseyev"]
+  spec.email         = ["vasilyfedoseyev@gmail.com"]
+
+  spec.summary       = %q{Provides coverage report for your rails routes}
+  spec.description   = %q{Generates coverage report for routes hit by your request/integration/feature tests including capybara ones}
+  spec.homepage      = "https://github.com/Vasfed/routes_coverage"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  # spec.add_development_dependency "minitest", "~> 4.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: routes_coverage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vasily Fedoseyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Generates coverage report for routes hit by your request/integration/feature
+  tests including capybara ones
+email:
+- vasilyfedoseyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/routes_coverage.rb
+- lib/routes_coverage/adapters/atexit.rb
+- lib/routes_coverage/adapters/rspec.rb
+- lib/routes_coverage/formatters/full_text.rb
+- lib/routes_coverage/formatters/summary_text.rb
+- lib/routes_coverage/middleware.rb
+- lib/routes_coverage/result.rb
+- lib/routes_coverage/version.rb
+- routes_coverage.gemspec
+homepage: https://github.com/Vasfed/routes_coverage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides coverage report for your rails routes
+test_files: []