routes_coverage 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 66fbe57b380af966b736a53bfeeccf4c27600825
-  data.tar.gz: aebe5c80b8aac0abdcc4f13f8cade0ea801d4b56
+SHA256:
+  metadata.gz: b697ab555d0362fa18dae5161266efbeb99eff4c1f276f7d06039952a6fc2f7c
+  data.tar.gz: 5e0fbeb4d54958bfb46f307c42ef5a54ceec49af49f699943881c6a665cca251
 SHA512:
-  metadata.gz: 8a64c5c7fc2014e3f6dc6cb530c9aaae53140c6eadcdf8df96ad82d77f6acd7ec94f4a40d815177e503380aa306f5ae4bda1e7b2812850684bfe3c7c36f0cc05
-  data.tar.gz: f5b7376fed952b708fca9747b2e2c0b13a065bd86e8185882b3845dbb27750fbded954007ea5541f9123dc07c04992febeb139343d0a2ed82c58745d3cdd726e
+  metadata.gz: c810351185cd998b8370c357d28bb06736e1c3de4202e12aab641b7ab22ed182f9e9f2b31a4cefe54dd9cdd52fe6a20a0187b088649e6652107b9edfce6bad39
+  data.tar.gz: e7af918230387e897334154962115d6d6f9b6e38d1e870bd5070529cf88d8fc2708cf6c57baf1d9f1f66b14beacd62f5eb1ae21d33de41ed279e671e4dcf7449

data/README.md

@@ -37,10 +37,12 @@ RSpec.configure do |config|
   config.routes_coverage.perform_report = ENV['ROUTES_COVERAGE'] # only generate report if env var is set
 
   config.routes_coverage.exclude_put_fallbacks = true # exclude non-hit PUT-requests where a matching PATCH exists
+  config.routes_coverage.include_from_controller_tests = true # include results from controller tests
   config.routes_coverage.exclude_patterns << %r{PATCH /reqs}   # excludes all requests matching regex
   config.routes_coverage.exclude_namespaces << 'somenamespace' # excludes /somenamespace/*
 
   config.routes_coverage.groups["Some Route group title"] = %r{^/somespace/}
+  config.routes_coverage.groups["Subdomain"] = { constraints: { subdomain: 'some_subdomain' }, path: '/' }
   config.routes_coverage.groups["Admin"] = Regexp.union([
     %r{^/admin/},
     %r{^/secret_place/},
@@ -69,7 +71,9 @@ or
 RoutesCoverage.settings.format = :full_text
 ```
 
-
+Note that coverage from `include_from_controller_tests` (disabled by default) is not a true routes coverage.
+Rounting is not tested in controller tests (which are deprecated in Rails 5),
+but sometimes you may already have a lot of controller tests and an intent to improve green-path/business level coverage
 
 ## Development
 

data/lib/routes_coverage/adapters/atexit.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 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
+      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
 
         RoutesCoverage.reset!
         at_exit do
           next if RoutesCoverage.pid != Process.pid
+
           RoutesCoverage.perform_report
-          exit
+          exit # rubocop:disable Rails/Exit
         end
       end
     end

data/lib/routes_coverage/adapters/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core'
 
 RSpec.configure do |config|

data/lib/routes_coverage/adapters/simplecov.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module RoutesCoverage
   module Adapters
     class SimpleCov
       def self.use
         RoutesCoverage.reset!
         prev_block = ::SimpleCov.at_exit
-        ::SimpleCov.at_exit{
+        ::SimpleCov.at_exit do
           RoutesCoverage.perform_report
           prev_block.call
-        }
+        end
       end
     end
   end

data/lib/routes_coverage/formatters/base.rb

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 module RoutesCoverage
   module Formatters
     class Base
-      def initialize result, groups, settings
+      def initialize(result, groups, settings)
         @result = result
         @groups = groups
         @settings = settings
       end
 
-      attr_reader :result
-      attr_reader :groups
-      attr_reader :settings
+      attr_reader :result, :groups, :settings
     end
   end
 end

data/lib/routes_coverage/formatters/full_text.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 module RoutesCoverage
   module Formatters
     class FullText < SummaryText
-
       class RouteFormatter
         attr_reader :buffer
 
-        def initialize result=nil, _settings=nil, output_hits=false
+        def initialize(result = nil, _settings = nil, output_hits: false)
           @buffer = []
           @result = result
           @output_hits = output_hits
@@ -28,49 +29,47 @@ module RoutesCoverage
           @buffer << draw_header(routes)
         end
 
-        def no_routes _routes_from_rails5=nil
+        def no_routes(_routes_from_rails5 = nil)
           @buffer << "\tNone"
         end
 
         private
-        HEADER = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']
+
+        HEADER = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
         def draw_section(routes)
           header_lengths = HEADER.map(&:length)
           name_width, verb_width, path_width, reqs_width = widths(routes).zip(header_lengths).map(&:max)
 
-          hits = nil
           routes.map do |r|
-            # puts "route is #{r.inspect}"
-            if @output_hits
-              # hits = " ?"
-              if r[:original].respond_to?(:__getobj__)
-                original_route = r[:original].__getobj__ # SimpleDelegator
-              else
-                original_route = r[:original]
-              end
-              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}"
+            # unwrap SimpleDelegator
+            original_route = r[:original].respond_to?(:__getobj__) ? r[:original].__getobj__ : r[:original]
+
+            "#{r[:name].rjust(name_width) if @output_prefix} "\
+              "#{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs].ljust(reqs_width)}"\
+              "#{" #{@result.route_hit_counts[original_route]}" if @output_hits}"
           end
         end
 
         def draw_header(routes)
           name_width, verb_width, path_width, reqs_width = widths(routes)
 
-          "#{"Prefix".rjust(name_width) if @output_prefix} #{"Verb".ljust(verb_width)} #{"URI Pattern".ljust(path_width)} #{"Controller#Action".ljust(reqs_width)}#{' Hits' if @output_hits}"
+          [
+            ('Prefix'.rjust(name_width) if @output_prefix),
+            'Verb'.ljust(verb_width),
+            'URI Pattern'.ljust(path_width),
+            'Controller#Action'.ljust(reqs_width),
+            ('Hits' if @output_hits)
+          ].compact.join(' ')
         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,
-         ]
+          %i[name verb path reqs].map do |key|
+            routes.map { |r| r[key].length }.max.to_i
+          end
         end
       end
 
-
-      def routes_section formatter, title, routes
+      def routes_section(formatter, title, routes)
         formatter.buffer << title
 
         if routes.none?
@@ -83,24 +82,27 @@ module RoutesCoverage
         formatter.result
       end
 
-      def hit_routes
-        routes = result.hit_routes
+      def collect_routes(routes)
+        # rails 3
+        return Result::Inspector.new.collect_all_routes(routes) unless Result::Inspector::NEW_RAILS
+
+        Result::Inspector.new(routes).collect_all_routes
+      end
+
+      def hit_routes_details
         # engine routes now are in the same list
-        if Result::Inspector::NEW_RAILS
-          hit_routes = Result::Inspector.new(result.hit_routes).collect_all_routes
-          pending_routes = Result::Inspector.new(result.pending_routes).collect_all_routes
-        else
-          #rails 3
-          hit_routes = Result::Inspector.new.collect_all_routes(result.hit_routes)
-          pending_routes = Result::Inspector.new.collect_all_routes(result.pending_routes)
-        end
+        hit_routes = collect_routes(result.hit_routes)
+        pending_routes = collect_routes(result.pending_routes)
+
+        <<~TXT
+          #{routes_section(RouteFormatter.new(result, settings, output_hits: true), 'Covered routes:', hit_routes)}
 
-        return routes_section(RouteFormatter.new(result, settings, true), "Covered routes:", hit_routes) + "\n\n" +
-        routes_section(RouteFormatter.new(result, settings), "Pending routes:", pending_routes)
+          #{routes_section(RouteFormatter.new(result, settings), 'Pending routes:', pending_routes)}
+        TXT
       end
 
       def format
-        "#{super}\n\n#{hit_routes}"
+        "#{super}\n\n#{hit_routes_details}"
       end
     end
   end

data/lib/routes_coverage/formatters/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "erb"
 require "cgi"
 require "fileutils"
@@ -23,24 +25,25 @@ module RoutesCoverage
         ERB.new(File.read(File.join(File.dirname(__FILE__), "html_views", "#{name}.erb")))
       end
 
-
       def root(root = nil)
-        #TODO: config for this
+        # TODO: config for this
         return SimpleCov.root if defined? SimpleCov
         return @root if defined?(@root) && root.nil?
+
         @root = File.expand_path(root || Dir.getwd)
       end
 
       def coverage_dir(dir = nil)
-        #TODO: config for this
+        # TODO: config for this
         return SimpleCov.coverage_dir if defined? SimpleCov
         return @coverage_dir if defined?(@coverage_dir) && dir.nil?
-        @coverage_path = nil # invalidate cache
+
+        @output_path = nil # invalidate cache
         @coverage_dir = (dir || "coverage")
       end
 
       def output_path
-        @coverage_path ||= File.expand_path(coverage_dir, root).tap do |path|
+        @output_path ||= File.expand_path(coverage_dir, root).tap do |path|
           FileUtils.mkdir_p path
         end
       end
@@ -51,8 +54,8 @@ module RoutesCoverage
         @project_name ||= File.basename(root.split("/").last).capitalize.tr("_", " ")
       end
 
-      def asset_content name
-        File.read(File.expand_path("../../../compiled_assets/#{name}", File.dirname(__FILE__)))
+      def asset_content(name)
+        File.read(File.expand_path("../../../compiled_assets/#{name}", __dir__))
       end
 
       def style_asset_link
@@ -83,33 +86,23 @@ module RoutesCoverage
         end
       end
 
-      def hits_css_class hits
-        hits > 0 ? 'cov' : 'uncov'
+      def hits_css_class(hits)
+        hits.positive? ? 'cov' : 'uncov'
       end
 
       def timeago(time)
         "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
       end
 
-
       def all_result_groups
-        return @all_result_groups if @all_result_groups
-        @all_result_groups = [
-          {
-            id: 'all_routes',
-            name: 'All Routes',
-            result: result,
-          }
-        ]
-        @all_result_groups += groups.map do |group_name, group_result|
-          {
-            id: group_name.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-\_]/, ""),
-            name: group_name,
-            result: group_result,
-          }
-        end
-
-        @all_result_groups
+        @all_result_groups ||= [{ id: 'all_routes', name: 'All Routes', result: result }] +
+                               groups.map do |group_name, group_result|
+                                 {
+                                   id: group_name.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-_]/, ""),
+                                   name: group_name,
+                                   result: group_result
+                                 }
+                               end
       end
     end
   end

data/lib/routes_coverage/formatters/summary_text.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module RoutesCoverage
   module Formatters
     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}"
+      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.positive?}"
       end
 
       def status
         return unless settings.minimum_coverage
-        unless result.coverage_pass?
-          "Coverage is too low"
-        end
+
+        "Coverage is too low" unless result.coverage_pass?
       end
 
       def format
@@ -18,9 +21,9 @@ module RoutesCoverage
         ]
 
         if groups.any?
-          buffer += groups.map{|group_name, group_result|
+          buffer += groups.map do |group_name, group_result|
             "  #{group_name}: #{group_result.coverage}% (#{hits_count group_result})"
-          }
+          end
         end
 
         buffer << status

data/lib/routes_coverage/middleware.rb

@@ -1,39 +1,18 @@
+# frozen_string_literal: true
+
 module RoutesCoverage
   class Middleware
-    def initialize app
+    def initialize(app)
       @app = app
     end
 
-    def call original_env
+    def call(original_env)
       # router changes env/request during recognition so need a copy:
       env = original_env.dup
-      req = ::Rails.application.routes.request_class.new env
-      ::Rails.application.routes.router.recognize(req) do |route, parameters5, parameters4|
-        parameters = parameters5 || parameters4
-        dispatcher = route.app
-        if dispatcher.respond_to?(:dispatcher?)
-          req.path_parameters = parameters
-          unless dispatcher.matches?(req) # && dispatcher.dispatcher?
-            dispatcher = nil
-          end
-        else # rails < 4.2
-          dispatcher = route.app
-          req.env['action_dispatch.request.path_parameters'] = (env['action_dispatch.request.path_parameters'] || {}).merge(parameters)
-          while dispatcher.is_a?(ActionDispatch::Routing::Mapper::Constraints) do
-            if dispatcher.matches?(env)
-              dispatcher = dispatcher.app
-            else
-              dispatcher = nil
-            end
-          end
-        end
-        next unless dispatcher
+      req = ::Rails.application.routes.request_class.new(env)
+      RoutesCoverage._touch_request(req)
 
-        RoutesCoverage._touch_route(route)
-        # there may be multiple matching routes - we should match only first
-        break
-      end
-      #TODO: detect 404s? and maybe other route errors?
+      # TODO: detect 404s? and maybe other route errors?
       @app.call(original_env)
     end
   end

data/lib/routes_coverage/result.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string' # needed for rails5 version of inspector
 
 module RoutesCoverage
   class Result
-
     begin
       require 'action_dispatch/routing/inspector'
       class Inspector < ActionDispatch::Routing::RoutesInspector
         NEW_RAILS = true
         def collect_all_routes
           res = collect_routes(@routes)
-          #TODO: test with engines
+          # TODO: test with engines
           @engines.each do |engine_name, engine_routes|
-            res += engine_routes.map{|er|
+            res += engine_routes.map  do |er|
               er.merge({ engine_name: engine_name })
-            }
+            end
           end
           res
         end
@@ -21,39 +22,35 @@ module RoutesCoverage
         def collect_routes(routes)
           routes.collect do |route|
             ActionDispatch::Routing::RouteWrapper.new(route)
-          end.reject do |route|
-            route.internal?
-          end.collect do |route|
+          end.reject(&:internal?).collect do |route| # rubocop:disable Style/MultilineBlockChain
             collect_engine_routes(route)
 
-            { name:   route.name,
-              verb:   route.verb,
-              path:   route.path,
-              reqs:   route.reqs,
+            { 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,
-            }
+              original: route }
           end
         end
       end
-
     rescue LoadError
-      #rails 3
+      # rails 3
       require 'rails/application/route_inspector'
       class Inspector < Rails::Application::RouteInspector
         NEW_RAILS = false
-        def collect_all_routes(routes)
+        def collect_all_routes(routes) # rubocop:disable Lint/DuplicateMethods
           res = collect_routes(routes)
           @engines.each do |engine_name, engine_routes|
-            res += engine_routes.map{|er|
+            res += engine_routes.map  do |er|
               er.merge({ engine_name: engine_name })
-            }
+            end
           end
           res
         end
 
-        def collect_routes(routes)
+        def collect_routes(routes) # rubocop:disable Lint/DuplicateMethods
           routes = routes.collect do |route|
             route_reqs = route.requirements
 
@@ -70,47 +67,43 @@ module RoutesCoverage
 
             collect_engine_routes(reqs, rack_app)
 
-            { name:   route.name.to_s,
-              verb:   route.verb.source.gsub(/[$^]/, ''),
-              path:   route.path.spec.to_s,
-              reqs:   reqs,
+            { name: route.name.to_s,
+              verb: route.verb.source.gsub(/[$^]/, ''),
+              path: route.path.spec.to_s,
+              reqs: reqs,
               # added:
-              original: route,
-            }
+              original: route }
           end
 
           # Skip the route if it's internal info route
           routes.reject { |r| r[:path] =~ %r{/rails/info/properties|^#{Rails.application.config.assets.prefix}} }
         end
       end
-
     end
 
-    def initialize all_routes, hit_routes, settings
+    def initialize(all_routes, hit_routes, settings)
       @all_routes = all_routes
       @route_hit_counts = hit_routes
       @settings = settings
     end
 
-    attr_reader :all_routes
-
-    attr_reader :route_hit_counts
+    attr_reader :all_routes, :route_hit_counts
 
     def expected_routes
-      return @expected_routes if @expected_routes
-
-      filter_regex = Regexp.union(@settings.exclude_patterns)
-      namespaces_regex = Regexp.union(@settings.exclude_namespaces.map{|n| /^\/#{n}/})
-
-      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)
-        )
-      }
+      @expected_routes ||= begin
+        filter_regex = Regexp.union(@settings.exclude_patterns)
+        namespaces_regex = Regexp.union(@settings.exclude_namespaces.map { |n| %r{^/#{n}} })
+
+        routes_groups = all_routes.group_by do |r|
+          (
+            ("#{r.verb.to_s[8..-3]} #{r.path.spec}".strip =~ filter_regex) ||
+            (r.path.spec.to_s =~ namespaces_regex)
+          ).present?
+        end
 
-      @excluded_routes = routes_groups[true] || []
-      @expected_routes = routes_groups[false] || []
+        @excluded_routes = routes_groups[true] || []
+        routes_groups[false] || []
+      end
     end
 
     def pending_routes
@@ -123,11 +116,10 @@ module RoutesCoverage
     end
 
     def hit_routes
-      #TODO: sort?
+      # TODO: sort?
       @route_hit_counts.keys
     end
 
-
     def hit_routes_count
       @route_hit_counts.size
     end
@@ -146,6 +138,7 @@ module RoutesCoverage
 
     def coverage
       return 0 unless expected_routes.any?
+
       (hit_routes_count * 100.0 / expected_routes_count).round(@settings.round_precision)
     end
 
@@ -158,16 +151,15 @@ module RoutesCoverage
     end
 
     def all_routes_with_hits
-      if Inspector::NEW_RAILS
-        res = Inspector.new(all_routes).collect_all_routes
-      else
-        res = Inspector.new.collect_all_routes(all_routes)
-      end
-      res.each{|val|
+      res = if Inspector::NEW_RAILS
+              Inspector.new(all_routes).collect_all_routes
+            else
+              Inspector.new.collect_all_routes(all_routes)
+            end
+      res.each do |val|
         val[:hits] = @route_hit_counts[val[:original]] || 0
-      }
+      end
       res
     end
-
   end
 end

data/lib/routes_coverage/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RoutesCoverage
-  VERSION = "0.4.3"
+  VERSION = "0.6.0"
 end

data/lib/routes_coverage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "routes_coverage/version"
 require "routes_coverage/result"
 require "routes_coverage/middleware"
@@ -8,28 +10,43 @@ require "routes_coverage/formatters/full_text"
 require "routes_coverage/formatters/html"
 
 module RoutesCoverage
+  module ActionControllerTestCase
+    def process(action, *args)
+      return super unless RoutesCoverage.settings.include_from_controller_tests
+
+      super.tap { RoutesCoverage._touch_request(@request) }
+    end
+  end
+
+  module ActionControllerTestCaseKvargs
+    def process(action, **kvargs)
+      return super unless RoutesCoverage.settings.include_from_controller_tests
+
+      super.tap { RoutesCoverage._touch_request(@request) }
+    end
+  end
+
   class Railtie < ::Rails::Railtie
     railtie_name :routes_coverage
 
     initializer "request_coverage.inject_test_middleware" do
-      if RoutesCoverage.enabled?
-        ::Rails.application.middleware.use RoutesCoverage::Middleware
+      ::Rails.application.middleware.use RoutesCoverage::Middleware if RoutesCoverage.enabled?
+
+      ActiveSupport.on_load(:action_controller_test_case) do |klass|
+        if Rails.version >= '5.1'
+          klass.prepend RoutesCoverage::ActionControllerTestCaseKvargs
+        else
+          klass.prepend RoutesCoverage::ActionControllerTestCase
+        end
       end
     end
   end
 
   class Settings
-    attr_reader :exclude_patterns
-    attr_reader :exclude_namespaces
-    attr_accessor :exclude_put_fallbacks
-
-    attr_accessor :perform_report
-    attr_accessor :minimum_coverage
-    attr_accessor :round_precision
-
-    attr_accessor :format
-
-    attr_reader :groups
+    attr_reader :exclude_patterns, :exclude_namespaces, :groups
+    attr_accessor :perform_report, :format, :minimum_coverage, :round_precision,
+                  :exclude_put_fallbacks,
+                  :include_from_controller_tests
 
     def initialize
       @exclude_patterns = []
@@ -63,96 +80,143 @@ module RoutesCoverage
   end
 
   def self.settings
-    @@settings ||= Settings.new
+    @settings ||= Settings.new
   end
 
   def self.configure
-    yield self.settings
+    yield settings
   end
 
-  mattr_reader :pid
+  # used in at_exit adapter to skip subprocesses
+  def self.pid
+    @pid
+  end
+
+  def self.route_hit_count
+    @route_hit_count
+  end
 
   def self.reset!
-    @@route_hit_count = Hash.new(0)
-    @@pid = Process.pid
+    @route_hit_count = Hash.new(0)
+    @pid = Process.pid
   end
 
   def self.perform_report
     return unless settings.perform_report
 
+    all_routes = _collect_all_routes
+    all_result = Result.new(all_routes, route_hit_count, settings)
+    groups = _collect_route_groups(all_routes)
+
+    if groups.size > 1
+      ungroupped_routes = all_routes.reject do |r|
+        groups.values.any? do |group_routes|
+          group_routes.all_routes.include? r
+        end
+      end
+
+      if ungroupped_routes.any?
+        groups["Ungroupped"] = Result.new(ungroupped_routes, route_hit_count.slice(*ungroupped_routes), settings)
+      end
+    end
+
+    puts
+    puts settings.formatter_class.new(all_result, groups, settings).format # rubocop:disable Rails/Output
+  end
+
+  def self._collect_all_routes
     all_routes = ::Rails.application.routes.routes.routes.dup
 
     if defined?(::Sprockets) && defined?(::Sprockets::Environment)
-      all_routes.reject!{|r| r.app.is_a?(::Sprockets::Environment) }
+      all_routes.reject! { |r| r.app.is_a?(::Sprockets::Environment) }
     end
 
     if settings.exclude_put_fallbacks
-      all_routes.reject!{|put_route|
+      all_routes.reject! do |put_route|
         (
           put_route.verb == /^PUT$/ ||
           put_route.verb == "PUT" # rails 5
         ) &&
-        put_route.name.nil? &&
-        @@route_hit_count[put_route] == 0 &&
-        all_routes.any?{|patch_route|
-          (
-            patch_route.verb == /^PATCH$/ ||
-            patch_route.verb == "PATCH" # rails5
-          ) &&
-          patch_route.defaults == put_route.defaults &&
-          patch_route.ip == put_route.ip &&
-          patch_route.path.spec.to_s == put_route.path.spec.to_s
-        }
-      }
+          put_route.name.nil? &&
+          route_hit_count[put_route].zero? &&
+          all_routes.any? do |patch_route|
+            (
+              patch_route.verb == /^PATCH$/ ||
+              patch_route.verb == "PATCH" # rails5
+            ) &&
+              patch_route.defaults == put_route.defaults &&
+              patch_route.ip == put_route.ip &&
+              patch_route.path.spec.to_s == put_route.path.spec.to_s
+          end
+      end
     end
+    all_routes
+  end
 
-    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
-        )
-      ]
-    }]
+  def self._collect_route_groups(all_routes)
+    settings.groups.map do |group_name, matcher|
+      group_routes = all_routes.select do |route|
+        if matcher.respond_to?(:call)
+          matcher.call(route)
+        elsif matcher.is_a?(Hash)
+          matcher.all? do |key, value|
+            case key
+            when :path
+              route.path.spec.to_s =~ value
+            when :action
+              route.requirements[:action]&.match(value)
+            when :controller
+              route.requirements[:controller]&.match(value)
+            when :constraints
+              value.all? do |constraint_name, constraint_value|
+                if constraint_value.present?
+                  route.constraints[constraint_name] && route.constraints[constraint_name].match?(constraint_value)
+                else
+                  route.constraints[constraint_name].blank?
+                end
+              end
+            end
+          end
+        else
+          route.path.spec.to_s.match?(matcher)
+        end
+      end
 
-    if groups.size > 1
-      ungroupped_routes = all_routes.reject{|r|
-        groups.values.any?{|group_routes|
-          group_routes.all_routes.include? r
-        }
-      }
+      [group_name, Result.new(group_routes, route_hit_count.slice(*group_routes), settings)]
+    end.to_h
+  end
 
-      if ungroupped_routes.any?
-        groups["Ungroupped"] = Result.new(
-          ungroupped_routes,
-          Hash[@@route_hit_count.select{|r,_hits| ungroupped_routes.include? r}],
-          settings
-        )
+  # NB: router changes env/request during recognition
+  def self._touch_request(req)
+    ::Rails.application.routes.router.recognize(req) do |route, parameters5, parameters4|
+      parameters = parameters5 || parameters4
+      dispatcher = route.app
+      if dispatcher.respond_to?(:dispatcher?)
+        req.path_parameters = parameters
+        dispatcher = nil unless dispatcher.matches?(req) # && dispatcher.dispatcher?
+      else # rails < 4.2
+        dispatcher = route.app
+        req.env['action_dispatch.request.path_parameters'] =
+          (env['action_dispatch.request.path_parameters'] || {}).merge(parameters)
+        while dispatcher.is_a?(ActionDispatch::Routing::Mapper::Constraints)
+          dispatcher = (dispatcher.app if dispatcher.matches?(env))
+        end
       end
-    end
+      next unless dispatcher
 
-    puts
-    puts settings.formatter_class.new(all_result, groups, settings).format
+      RoutesCoverage._touch_route(route)
+      # there may be multiple matching routes - we should match only first
+      break
+    end
   end
 
-
-  def self._touch_route route
-    reset! unless @@route_hit_count
-    @@route_hit_count[route] += 1
+  def self._touch_route(route)
+    reset! unless route_hit_count
+    route_hit_count[route] += 1
   end
 end
 
-if defined? RSpec
-  require "routes_coverage/adapters/rspec"
-end
+require "routes_coverage/adapters/rspec" if defined? RSpec
 
 if RoutesCoverage.enabled?
   if defined?(SimpleCov) && SimpleCov.running

data/routes_coverage.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'routes_coverage/version'
 
@@ -9,18 +10,23 @@ Gem::Specification.new do |spec|
   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.summary       = "Provides coverage report for your rails routes"
+  spec.description   = "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|assets)/})
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|assets|bin|gemfiles)/}) ||
+      f.start_with?('.') ||
+      %w[Appraisals Gemfile Rakefile].include?(f)
   end
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
   spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake", ">= 12.3.3"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: routes_coverage
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Vasily Fedoseyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 description: Generates coverage report for routes hit by your request/integration/feature
   tests including capybara ones
 email:
@@ -74,26 +74,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitattributes"
-- ".gitignore"
-- ".travis.yml"
-- Appraisals
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - compiled_assets/routes.css
 - compiled_assets/routes.js
-- gemfiles/.bundle/config
-- gemfiles/rails_3.gemfile
-- gemfiles/rails_40.gemfile
-- gemfiles/rails_40_rspec.gemfile
-- gemfiles/rails_40_simplecov.gemfile
-- gemfiles/rails_42.gemfile
-- gemfiles/rails_5.gemfile
-- gemfiles/rails_51.gemfile
 - lib/routes_coverage.rb
 - lib/routes_coverage/adapters/atexit.rb
 - lib/routes_coverage/adapters/rspec.rb
@@ -112,7 +96,7 @@ homepage: https://github.com/Vasfed/routes_coverage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,16 +104,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Provides coverage report for your rails routes
 test_files: []

data/.gitattributes

@@ -1 +0,0 @@
-compiled_assets/* linguist-generated

data/.gitignore

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

data/.travis.yml

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

data/Appraisals

@@ -1,33 +0,0 @@
-# to test against all, run: appraisal rake spec
-
-
-appraise "rails-40" do
-  gem "rails", "~>4.0.0"
-end
-
-appraise "rails-42" do
-  gem "rails", "~>4.2.0"
-end
-
-appraise "rails-5" do
-  gem "rails", "~>5.0.0"
-end
-
-appraise "rails-40+rspec" do
-  gem "rails", "~>4.0.0"
-  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
-
-appraise 'rails-3' do
-  gem 'rails', '~>3.2.22'
-  gem 'test-unit'
-end

data/Gemfile

@@ -1,15 +0,0 @@
-source 'https://rubygems.org'
-
-#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
-
-# rails should be included before us
-gem 'rails', '5.2.0.rc1'
-gem 'simplecov', require: false
-
-# for assets:
-gem 'sprockets'
-gem 'sass'
-
-gemspec

data/Rakefile

@@ -1,36 +0,0 @@
-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
-
-Rake::TestTask.new(:dummytest) do |t| t.pattern = 'spec/fixtures/dummy_test.rb' end
-Rake::TestTask.new(:dummytest_html) do |t| t.pattern = 'spec/fixtures/dummy_html.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__)
-require 'routes_coverage/version'
-
-namespace :assets do
-  desc "Compiles all assets"
-  task :compile do
-    puts "Compiling assets"
-    require "sprockets"
-    assets = Sprockets::Environment.new
-    assets.append_path "assets/javascripts"
-    assets.append_path "assets/stylesheets"
-    compiled_path = "compiled_assets"
-    assets["application.js"].write_to("#{compiled_path}/routes.js")
-    assets["application.css"].write_to("#{compiled_path}/routes.css")
-  end
-end

data/bin/console

@@ -1,15 +0,0 @@
-#!/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

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-appraisal

data/gemfiles/.bundle/config

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

data/gemfiles/rails_3.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~>3.2.22"
-gem "simplecov", require: false
-gem "sprockets"
-gem "sass"
-gem "test-unit"
-
-gemspec path: "../"

data/gemfiles/rails_40.gemfile

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

data/gemfiles/rails_40_rspec.gemfile

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

data/gemfiles/rails_40_simplecov.gemfile

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

data/gemfiles/rails_42.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~>4.2.0"
-gem "simplecov", require: false
-gem "sprockets"
-gem "sass"
-
-gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~>5.0.0"
-gem "simplecov", require: false
-gem "sprockets"
-gem "sass"
-
-gemspec path: "../"

data/gemfiles/rails_51.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~>5.1.0"
-gem "simplecov", require: false
-gem "sprockets"
-gem "sass"
-
-gemspec path: "../"