routes_coverage 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ca681a352b4b2c633a83b99cc7c5b4334e2e40
-  data.tar.gz: d3d3126f530afe3fff1978c801a5194247b24580
+  metadata.gz: dcc558504676f10b8f11d5c803288084c92b7c84
+  data.tar.gz: 063d639635c7c5b3fbd17396f129882559541cfb
 SHA512:
-  metadata.gz: 9d1a5f0dff0432078c4f359f5feb98e0687a9bb778c9ec6b4fa8de40421eefd92c10b5b61f259556a2ee7be6b9aeefb0fd7286fee5f59a0e1ef56b20e1be61ac
-  data.tar.gz: 5fc59b5bfa01ec2a87c99fb861e67795cd33ebdc167bc03b3923ab50e2216bb6ca3f1b1733a18da5b8f56d3b9c36a5ebabd2469c3f96f56678f0b16d5278bd76
+  metadata.gz: d6dfb367c8a7f0487959ad3ef831cf057ef3a1ea3849583a89b0c52df259ffe58b27ad59a6ec03420d17bbd192f71fed14af2fdfe385de4298960f07db347060
+  data.tar.gz: a5308eb14d95cb0afb8a95221fad4c5ac7f6ef3897d159680ede52d1b6db6e51b77268e52992fa3c0e27986746c1adb823d0bfe687b20fc4bd85e9a6ca769047

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /log/
+/coverage/

data/Appraisals

@@ -18,6 +18,11 @@ appraise "rails-40+rspec" do
   gem "rspec-rails"
 end
 
+appraise "rails-40+simplecov" do
+  gem "rails", "~>4.0.0"
+  gem "simplecov"
+end
+
 appraise "rails-51" do
   gem "rails", "~>5.1.0"
 end

data/Gemfile

@@ -1,7 +1,10 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in routes_coverage.gemspec
-gemspec
+#NB: gem's dependencies are in routes_coverage.gemspec
+#NB: all other non-listed gems should go into Appraisals,
+# this file is only for quick tests
 
-#TODO: appraisal
+# rails should be included before us
 gem 'rails', '4.0.13'
+
+gemspec

data/README.md

@@ -39,6 +39,14 @@ To get more detailed information somewhere in your test helper add
 
 ```ruby
 RoutesCoverage.settings.format = :full_text
+```
+
+or into RSpec config:
+
+```ruby
+RSpec.configure do |config|
+  config.routes_coverage.format = :full_text
+end
 ```
 
     Routes coverage is 11.1% (1 of 9 routes hit at 1.0 hits average)
@@ -59,6 +67,41 @@ RoutesCoverage.settings.format = :full_text
       PUT    /reqs/:id(.:format)      dummy#update
       DELETE /reqs/:id(.:format)      dummy#destroy
 
+### Usage with SimpleCov
+
+Use `RoutesCoverage.settings.format = :simplecov_html` along with simplecov to generate a html report like this:
+
+![Html output example](/assets/html_output_screenshot.png?raw=true "Html Output example")
+
+at the moment it shares styles with simplecov's one,
+code coverage report does not need to be generated each time as long as you have `/coverage` directory with all the resources.
+
+### Configuration
+
+Set options in `RoutesCoverage.settings` or rspec's `config.routes_coverage`:
+
+```ruby
+RSpec.configure do |config|
+  config.routes_coverage.format = :full_text
+  config.routes_coverage.exclude_patterns << %r{PATCH /reqs}   # excludes all requests matching regex
+  config.routes_coverage.exclude_namespaces << 'somenamespace' # excludes /somenamespace/*
+  config.routes_coverage.minimum_coverage = 80 # %, your coverage goal
+  config.routes_coverage.round_precision = 0   # just round to whole percents
+end
+```
+
+or
+
+```ruby
+RoutesCoverage.configure do |config|
+  config.format = :full_text
+  # ...
+end
+```
+
+
+Excluded routes do not show in pending, but are shown if they're hit.
+
 
 ## Development
 

data/Rakefile

@@ -9,6 +9,12 @@ Rake::TestTask.new(:spec) do |t|
   t.libs.push 'spec'
 end
 
+Rake::TestTask.new(:dummytest) do |t| t.pattern = 'spec/fixtures/dummy_test.rb' end
+Rake::TestTask.new(:dummytest_full) do |t| t.pattern = 'spec/fixtures/dummy_test_full.rb' end
+Rake::TestTask.new(:dummytest_filter) do |t| t.pattern = 'spec/fixtures/dummy_test_nsfilters.rb' end
+Rake::TestTask.new(:dummytest_groups) do |t| t.pattern = 'spec/fixtures/dummy_test_groups.rb' end
+
+
 task :default => :spec
 
 $:.push File.expand_path("../lib", __FILE__)

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_40.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~>4.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_40.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routes_coverage (0.0.2)
+    routes_coverage (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_40_rspec.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~>4.0.0"
 gem "rspec-rails"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_40_rspec.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routes_coverage (0.0.2)
+    routes_coverage (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_40_simplecov.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~>4.0.0"
+gem "simplecov"
+
+gemspec path: "../"

data/gemfiles/rails_40_simplecov.gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: ..
+  specs:
+    routes_coverage (0.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.13)
+      actionpack (= 4.0.13)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+    activerecord (4.0.13)
+      activemodel (= 4.0.13)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.13)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.4)
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (4.0.2)
+    builder (3.1.4)
+    concurrent-ruby (1.0.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    i18n (0.8.1)
+    json (1.8.6)
+    mail (2.6.5)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (4.7.5)
+    multi_json (1.12.1)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.0.13)
+      actionmailer (= 4.0.13)
+      actionpack (= 4.0.13)
+      activerecord (= 4.0.13)
+      activesupport (= 4.0.13)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.13)
+      sprockets-rails (~> 2.0)
+    railties (4.0.13)
+      actionpack (= 4.0.13)
+      activesupport (= 4.0.13)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (0.3.53)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 1.14)
+  minitest
+  rails (~> 4.0.0)
+  rake (~> 10.0)
+  routes_coverage!
+  simplecov
+
+BUNDLED WITH
+   1.14.6

data/gemfiles/rails_42.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~>4.2.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_42.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routes_coverage (0.0.2)
+    routes_coverage (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_5.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~>5.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routes_coverage (0.0.2)
+    routes_coverage (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_51.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~>5.1.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_51.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routes_coverage (0.0.2)
+    routes_coverage (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/routes_coverage/adapters/simplecov.rb

@@ -0,0 +1,12 @@
+module RoutesCoverage
+  module Adapters
+    class SimpleCov
+      def self.use
+        RoutesCoverage.reset!
+        ::SimpleCov.at_exit{
+          RoutesCoverage.perform_report
+        }
+      end
+    end
+  end
+end

data/lib/routes_coverage/formatters/base.rb

@@ -0,0 +1,15 @@
+module RoutesCoverage
+  module Formatters
+    class Base
+      def initialize result, groups, settings
+        @result = result
+        @groups = groups
+        @settings = settings
+      end
+
+      attr_reader :result
+      attr_reader :groups
+      attr_reader :settings
+    end
+  end
+end

data/lib/routes_coverage/formatters/full_text.rb

@@ -1,29 +1,7 @@
-require 'active_support/core_ext/string' # needed for rails5 version of inspector
-require 'action_dispatch/routing/inspector'
-
 module RoutesCoverage
   module Formatters
     class FullText < SummaryText
 
-      class Inspector < ActionDispatch::Routing::RoutesInspector
-        def collect_routes(routes)
-          routes.collect do |route|
-            ActionDispatch::Routing::RouteWrapper.new(route)
-          end.reject do |route|
-            route.internal?
-          end.collect do |route|
-            collect_engine_routes(route)
-
-            { name:   route.name,
-              verb:   route.verb,
-              path:   route.path,
-              reqs:   route.reqs,
-              # regexp: route.json_regexp, # removed, this is not present in rails5
-              original: route, # added
-            }
-          end
-        end
-      end
 
       class RouteFormatter < ActionDispatch::Routing::ConsoleFormatter
 
@@ -50,7 +28,7 @@ module RoutesCoverage
             if @output_hits
               # hits = " ?"
               original_route = r[:original].__getobj__ # SimpleDelegator
-              hits = " #{@result.route_hits[original_route]}"
+              hits = " #{@result.route_hit_counts[original_route]}"
             end
             "#{r[:name].rjust(name_width) if @output_prefix} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs].ljust(reqs_width)}#{hits}"
           end
@@ -83,15 +61,16 @@ module RoutesCoverage
           # routes.map do |r|
           #   "#{r.verb.ljust(verb_width)} #{r.path.ljust(path_width)} #{r.reqs}"
           # end
-          Inspector.new(routes).format(RouteFormatter.new(result, settings, true)),
+          #TODO: replace formatter
+          Result::Inspector.new(routes).format(RouteFormatter.new(result, settings, true)),
           nil,
           "Pending routes:",
-          Inspector.new(result.pending_routes).format(RouteFormatter.new),
+          Result::Inspector.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}"
+        "#{super}\n\n#{hit_routes}"
       end
     end
   end

data/lib/routes_coverage/formatters/html_views/layout.erb

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title>Code coverage for <%= SimpleCov.project_name %></title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <script src='<%= assets_path('application.js') %>' type='text/javascript'></script>
+    <link href='<%= assets_path('application.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>
+    <link rel="shortcut icon" type="image/png" href="<%= assets_path("favicon_#{coverage_css_class(result.coverage)}.png") %>" />
+    <link rel="icon" type="image/png" href="<%= assets_path('favicon.png') %>" />
+
+    <script>
+      $(document).ready(function() {
+        $('.route_list').dataTable({
+          "aaSorting": [], //[[ 1, "asc" ]],
+          "bPaginate": false,
+          "bJQueryUI": true,
+          "aoColumns": [
+            null, //name
+            null, //verb
+            null, //path
+            null, //action
+            null, //covered yes/no
+            null, //hits count
+          ]
+        });
+      });
+    </script>
+  </head>
+
+  <body>
+    <div id="loading">
+      Loading...
+    </div>
+    <div id="wrapper" style="display:none;">
+      <div class="timestamp">Generated <%= timeago(Time.now) %></div>
+      <ul class="group_tabs"></ul>
+
+      <div id="content">
+        <%= route_group_result("All Routes", result) %>
+
+        <% groups.each do |name, group_result| %>
+          <%= route_group_result(name, group_result) %>
+        <% end %>
+      </div>
+
+      <div id="footer">
+        Generated by <a href="http://github.com/Vasfed/routes_coverage">routes_coverage</a> v<%= RoutesCoverage::VERSION %>
+        and simplecov-html v<%= SimpleCov::Formatter::HTMLFormatter::VERSION %><br/>
+      </div>
+
+    </div>
+  </body>
+</html>

data/lib/routes_coverage/formatters/html_views/route_group.erb

@@ -0,0 +1,48 @@
+<div class="file_list_container" id="<%= title_id %>">
+  <h2>
+    <span class="group_name"><%= title %></span>
+    (<span class="covered_percent"><span class="<%= coverage_css_class(result.coverage.to_f) %>"><%= result.coverage %>%</span></span>
+     covered at
+     <span class="covered_strength">
+       <span class="<%#= strength_css_class(result.avg_hits) %>">
+         <%= result.avg_hits.round(2) %>
+       </span>
+    </span> hits/route)
+  </h2>
+  <a name="<%= title_id %>"></a>
+  <div>
+    <b><%= result.total_count %></b> routes in total.
+    <b><%= result.expected_routes_count %></b> relevant routes.
+    <span class="green"><b><%= result.hit_routes_count %></b> covered</span> and
+    <span class="red"><b><%= result.pending_routes.size %></b> missed </span>
+  </div>
+  <table class="route_list">
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Verb</th>
+        <th>Path</th>
+        <th>Controller</th>
+        <th>Covered</th>
+        <th>Hits</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% result.all_routes_with_hits.each do |route| %>
+      <tr>
+        <td class="strong"><%= route[:name] %></td>
+        <td class="strong"><%= route[:verb] %></td>
+        <td class="strong"><%= route[:path] %></td>
+        <td class="strong">
+          <% if route[:engine_name] %>
+            engine <%= route[:engine_name] %>
+          <% end %>
+          <%= route[:reqs] %>
+        </td>
+        <td class="strong <%= hits_css_class route[:hits] %>"><%= route[:hits] > 0 ? 'Yes' : 'No' %></td>
+        <td class="<%= hits_css_class route[:hits] %> strong"><%= route[:hits] %></td>
+      </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/lib/routes_coverage/formatters/simplecov_html.rb

@@ -0,0 +1,97 @@
+require "erb"
+require "cgi"
+require "fileutils"
+require "digest/sha1"
+require "time"
+
+module RoutesCoverage
+  module Formatters
+    class SimpleCovHtml < Base
+      def format
+        #TODO: copy assets, if simplecov does not generate a report along us
+
+        # Dir[File.join(File.dirname(__FILE__), "../public/*")].each do |path|
+        #   FileUtils.cp_r(path, asset_output_path)
+        # end
+
+        routes_filename = "routes.html"
+
+        File.open(File.join(output_path, routes_filename), "wb") do |file|
+          file.puts template("layout").result(binding)
+        end
+
+        "Routes coverage is #{result.coverage}% Report generated to #{output_path}/#{routes_filename}"
+      end
+
+      private
+
+      def template(name)
+        ERB.new(File.read(File.join(File.dirname(__FILE__), "html_views", "#{name}.erb")))
+      end
+
+      def output_path
+        SimpleCov.coverage_path
+      end
+
+      def asset_output_path
+        return @asset_output_path if defined?(@asset_output_path) && @asset_output_path
+        @asset_output_path = File.join(output_path, "assets", SimpleCov::Formatter::HTMLFormatter::VERSION)
+        FileUtils.mkdir_p(@asset_output_path)
+        @asset_output_path
+      end
+
+      def assets_path(name)
+        File.join("./assets", SimpleCov::Formatter::HTMLFormatter::VERSION, name)
+      end
+
+      # Returns the html for the given source_file
+      def formatted_source_file(source_file)
+        template("source_file").result(binding)
+      end
+
+      # Returns a table containing the given source files
+      def route_group_result(title, result)
+        title_id = title.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-\_]/, "")
+        # Silence a warning by using the following variable to assign to itself:
+        # "warning: possibly useless use of a variable in void context"
+        # The variable is used by ERB via binding.
+        title_id = title_id
+        template("route_group").result(binding)
+      end
+
+      def coverage_css_class(covered_percent)
+        if covered_percent > 90
+          "green"
+        elsif covered_percent > 80
+          "yellow"
+        else
+          "red"
+        end
+      end
+
+      def strength_css_class(covered_strength)
+        if covered_strength > 1
+          "green"
+        elsif covered_strength == 1
+          "yellow"
+        else
+          "red"
+        end
+      end
+
+      def hits_css_class hits
+        hits > 0 ? 'green' : 'red'
+      end
+
+      # Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
+      def id(source_file)
+        Digest::SHA1.hexdigest(source_file.filename)
+      end
+
+      def timeago(time)
+        "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
+      end
+
+    end
+  end
+end

data/lib/routes_coverage/formatters/summary_text.rb

@@ -1,29 +1,31 @@
 module RoutesCoverage
   module Formatters
-    class SummaryText
-      def initialize result, settings
-        @result = result
-        @settings = settings
-      end
-
-      attr_reader :result
-      attr_reader :settings
-
-      def hits_count
+    class SummaryText < Base
+      def hits_count result
         "#{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
         return unless settings.minimum_coverage
-        if result.coverage_pass?
-          ""
-        else
-          "\nCoverage failed. Need at least #{(settings.minimum_coverage / 100.0 * result.total_count).ceil}"
+        unless result.coverage_pass?
+          "Coverage is too low"
         end
       end
 
       def format
-        "\nRoutes coverage is #{result.coverage}% (#{hits_count})#{status}"
+        buffer = [
+          "Routes coverage is #{result.coverage}% (#{hits_count result})"
+        ]
+
+        if groups.any?
+          buffer += groups.map{|group_name, group_result|
+            "  #{group_name}: #{group_result.coverage}% (#{hits_count group_result})"
+          }
+        end
+
+        buffer << status
+
+        buffer.compact.join("\n")
       end
     end
   end

data/lib/routes_coverage/middleware.rb

@@ -5,13 +5,9 @@ module RoutesCoverage
     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)
+        RoutesCoverage._touch_route(route)
       end
       #TODO: detect 404s? and maybe other route errors?
       @app.call(env)

data/lib/routes_coverage/result.rb

@@ -1,45 +1,33 @@
+require 'active_support/core_ext/string' # needed for rails5 version of inspector
+require 'action_dispatch/routing/inspector'
+
 module RoutesCoverage
   class Result
-    def initialize
-      @route_hits = Hash.new(0)
+    def initialize all_routes, hit_routes, settings
+      @all_routes = all_routes
+      @route_hit_counts = hit_routes
+      @settings = settings
     end
 
-    attr_reader :route_hits
-
-    def touch_route route
-      @route_hits[route] += 1
-    end
+    attr_reader :all_routes
 
-    def all_routes
-      ::Rails.application.routes.routes.routes
-    end
+    attr_reader :route_hit_counts
 
     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
+      filter_regex = Regexp.union(@settings.exclude_patterns)
+      namespaces_regex = Regexp.union(@settings.exclude_namespaces.map{|n| /^\/#{n}/})
 
-      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
+      routes_groups = all_routes.group_by{|r|
+        !!(
+          ("#{r.verb.to_s[8..-3]} #{r.path.spec}".strip =~ filter_regex) ||
+          (r.path.spec.to_s =~ namespaces_regex)
+        )
       }
 
-      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
+      @excluded_routes = routes_groups[true] || []
+      @expected_routes = routes_groups[false] || []
     end
 
     def pending_routes
@@ -53,12 +41,12 @@ module RoutesCoverage
 
     def hit_routes
       #TODO: sort?
-      route_hits.keys
+      @route_hit_counts.keys
     end
 
 
     def hit_routes_count
-      route_hits.size
+      @route_hit_counts.size
     end
 
     def expected_routes_count
@@ -75,15 +63,56 @@ module RoutesCoverage
 
     def coverage
       return 'n/a' unless expected_routes.any?
-      (hit_routes_count * 100.0 / expected_routes_count).round(RoutesCoverage.settings.round_precision)
+      (hit_routes_count * 100.0 / expected_routes_count).round(@settings.round_precision)
     end
 
     def avg_hits
-      (route_hits.values.sum.to_f / hit_routes_count).round(RoutesCoverage.settings.round_precision)
+      (@route_hit_counts.values.sum.to_f / hit_routes_count).round(@settings.round_precision)
     end
 
     def coverage_pass?
-      !RoutesCoverage.settings.minimum_coverage || (coverage >= RoutesCoverage.settings.minimum_coverage)
+      !@settings.minimum_coverage || (coverage.to_f >= @settings.minimum_coverage)
     end
+
+    def all_routes_with_hits
+      res = Inspector.new(all_routes).collect_all_routes
+      res.each{|val|
+        val[:hits] = @route_hit_counts[val[:original]] || 0
+      }
+      res
+    end
+
+    class Inspector < ActionDispatch::Routing::RoutesInspector
+      def collect_all_routes
+        res = collect_routes(@routes)
+        #TODO: test with engines
+        @engines.each do |engine_name, engine_routes|
+          res += engine_routes.map{|er|
+            er.merge({ engine_name: engine_name })
+          }
+        end
+        res
+      end
+
+      def collect_routes(routes)
+        routes.collect do |route|
+          ActionDispatch::Routing::RouteWrapper.new(route)
+        end.reject do |route|
+          route.internal?
+        end.collect do |route|
+          collect_engine_routes(route)
+
+          { name:   route.name,
+            verb:   route.verb,
+            path:   route.path,
+            reqs:   route.reqs,
+            # regexp: route.json_regexp, # removed, this is not present in rails5
+            # added:
+            original: route,
+          }
+        end
+      end
+    end
+
   end
 end

data/lib/routes_coverage/version.rb

@@ -1,3 +1,3 @@
 module RoutesCoverage
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/routes_coverage.rb

@@ -2,8 +2,10 @@ require "routes_coverage/version"
 require "routes_coverage/result"
 require "routes_coverage/middleware"
 
+require "routes_coverage/formatters/base"
 require "routes_coverage/formatters/summary_text"
 require "routes_coverage/formatters/full_text"
+require "routes_coverage/formatters/simplecov_html"
 
 module RoutesCoverage
   class Railtie < ::Rails::Railtie
@@ -24,12 +26,30 @@ module RoutesCoverage
 
     attr_accessor :format
 
+    attr_reader :groups
+
     def initialize
       @exclude_patterns = []
       @exclude_namespaces = []
-      @minimum_coverage = 80
+      @minimum_coverage = 1
       @round_precision = 1
       @format = :summary_text
+      @groups = {}
+    end
+
+    def formatter_class
+      case format
+      when :full_text
+        Formatters::FullText
+      when :summary_text
+        Formatters::SummaryText
+      when :simplecov_html
+        Formatters::SimpleCovHtml
+      when Formatters::Base
+        format
+      else
+        raise "Unknown formatter #{settings.format.inspect}"
+      end
     end
   end
 
@@ -41,33 +61,60 @@ module RoutesCoverage
     @@settings ||= Settings.new
   end
 
-  mattr_reader :current_result
+  def self.configure
+    yield self.settings
+  end
+
   mattr_reader :pid
 
   def self.reset!
-    @@current_result = Result.new
+    @@route_hit_count = Hash.new(0)
     @@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}"
+
+    all_routes = ::Rails.application.routes.routes.routes.dup
+
+    if defined?(::Sprockets) && defined?(::Sprockets::Environment)
+      all_routes.reject!{|r| r.app.is_a?(::Sprockets::Environment) }
     end
 
-    formatter = formatter_class.new(result, settings)
-    puts formatter.format
+    all_result = Result.new(
+      all_routes,
+      @@route_hit_count,
+      settings
+    )
+
+
+    groups = Hash[settings.groups.map{|group_name, regex|
+      [group_name,
+        Result.new(
+          all_routes.select{|r| r.path.spec.to_s =~ regex},
+          Hash[@@route_hit_count.select{|r,_hits| r.path.spec.to_s =~ regex}],
+          settings
+        )
+      ]
+    }]
+
+    #TODO: group 'ungroupped'
+
+    puts
+    puts settings.formatter_class.new(all_result, groups, settings).format
   end
 
+
+  def self._touch_route route
+    reset! unless @@route_hit_count
+    @@route_hit_count[route] += 1
+  end
 end
 
 if RoutesCoverage.enabled?
+  if defined? SimpleCov
+    #TODO: use SimpleCov.at_exit
+  end
+
   if defined? RSpec
     require "routes_coverage/adapters/rspec"
   else

data/routes_coverage.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|assets)/})
   end
   spec.require_paths = ["lib"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routes_coverage
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2017-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,10 +83,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/.bundle/config
 - gemfiles/rails_40.gemfile
 - gemfiles/rails_40.gemfile.lock
 - gemfiles/rails_40_rspec.gemfile
 - gemfiles/rails_40_rspec.gemfile.lock
+- gemfiles/rails_40_simplecov.gemfile
+- gemfiles/rails_40_simplecov.gemfile.lock
 - gemfiles/rails_42.gemfile
 - gemfiles/rails_42.gemfile.lock
 - gemfiles/rails_5.gemfile
@@ -96,7 +99,12 @@ files:
 - lib/routes_coverage.rb
 - lib/routes_coverage/adapters/atexit.rb
 - lib/routes_coverage/adapters/rspec.rb
+- lib/routes_coverage/adapters/simplecov.rb
+- lib/routes_coverage/formatters/base.rb
 - lib/routes_coverage/formatters/full_text.rb
+- lib/routes_coverage/formatters/html_views/layout.erb
+- lib/routes_coverage/formatters/html_views/route_group.erb
+- lib/routes_coverage/formatters/simplecov_html.rb
 - lib/routes_coverage/formatters/summary_text.rb
 - lib/routes_coverage/middleware.rb
 - lib/routes_coverage/result.rb