routes_coverage 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d242f3f02df2a36688c5237bd56ee2dbae55a6184ea0c8a299ef41fc7c3e42f
-  data.tar.gz: 87fc2c2c37dba09b129fedd1792242f5a94e64651bf8ef744171196d0e166dcc
+  metadata.gz: b697ab555d0362fa18dae5161266efbeb99eff4c1f276f7d06039952a6fc2f7c
+  data.tar.gz: 5e0fbeb4d54958bfb46f307c42ef5a54ceec49af49f699943881c6a665cca251
 SHA512:
-  metadata.gz: 1e3ac519c76267812ef5daf380315895a44e1ae12e396918d299546c04a23359cde49da0728fb0e6f9bda58014d20dd78bf981f08eaa1864e78e3185b9643582
-  data.tar.gz: d10ea82c9e2847bcb280a87a775c391c1c00de44e8e631ae45f9b43d19ca38e075399262c43584c509c069effc8bc2b836cced2c90f3787539d6e8217ee78e64
+  metadata.gz: c810351185cd998b8370c357d28bb06736e1c3de4202e12aab641b7ab22ed182f9e9f2b31a4cefe54dd9cdd52fe6a20a0187b088649e6652107b9edfce6bad39
+  data.tar.gz: e7af918230387e897334154962115d6d6f9b6e38d1e870bd5070529cf88d8fc2708cf6c57baf1d9f1f66b14beacd62f5eb1ae21d33de41ed279e671e4dcf7449

data/README.md

@@ -37,6 +37,7 @@ 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/*
 
@@ -70,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/middleware.rb

@@ -9,27 +9,9 @@ module RoutesCoverage
     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
-          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
-        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?
       @app.call(original_env)
     end

data/lib/routes_coverage/result.rb

@@ -90,20 +90,20 @@ module RoutesCoverage
     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| %r{^/#{n}} })
+      @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
 
-      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?
+        @excluded_routes = routes_groups[true] || []
+        routes_groups[false] || []
       end
-
-      @excluded_routes = routes_groups[true] || []
-      @expected_routes = routes_groups[false] || []
     end
 
     def pending_routes

data/lib/routes_coverage/version.rb

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

data/lib/routes_coverage.rb

@@ -10,17 +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
       ::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, :exclude_namespaces, :groups
-    attr_accessor :exclude_put_fallbacks, :perform_report, :minimum_coverage, :round_precision, :format
+    attr_accessor :perform_report, :format, :minimum_coverage, :round_precision,
+                  :exclude_put_fallbacks,
+                  :include_from_controller_tests
 
     def initialize
       @exclude_patterns = []
@@ -160,6 +186,30 @@ module RoutesCoverage
     end.to_h
   end
 
+  # 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
+      next unless dispatcher
+
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routes_coverage
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Vasily Fedoseyev