routes_coverage 0.4.0 → 0.5.0

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"
@@ -12,24 +14,13 @@ module RoutesCoverage
     railtie_name :routes_coverage
 
     initializer "request_coverage.inject_test_middleware" do
-      if RoutesCoverage.enabled?
-        ::Rails.application.middleware.use RoutesCoverage::Middleware
-      end
+      ::Rails.application.middleware.use RoutesCoverage::Middleware if RoutesCoverage.enabled?
     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 :exclude_put_fallbacks, :perform_report, :minimum_coverage, :round_precision, :format
 
     def initialize
       @exclude_patterns = []
@@ -63,100 +54,122 @@ 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
-        )
-      ]
-    }]
-
-    if groups.size > 1
-      ungroupped_routes = all_routes.reject{|r|
-        groups.values.any?{|group_routes|
-          group_routes.all_routes.include? r
-        }
-      }
-
-      if ungroupped_routes.any?
-        groups["Ungroupped"] = Result.new(
-          ungroupped_routes,
-          Hash[@@route_hit_count.select{|r,_hits| ungroupped_routes.include? r}],
-          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 :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
-    end
 
-    puts
-    puts settings.formatter_class.new(all_result, groups, settings).format
+      [group_name, Result.new(group_routes, route_hit_count.slice(group_routes), settings)]
+    end.to_h
   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 RoutesCoverage.enabled?
-  if defined? SimpleCov
-    #TODO: use SimpleCov.at_exit
-  end
+require "routes_coverage/adapters/rspec" if defined? RSpec
 
-  if defined? RSpec
-    require "routes_coverage/adapters/rspec"
+if RoutesCoverage.enabled?
+  if defined?(SimpleCov) && SimpleCov.running
+    require 'routes_coverage/adapters/simplecov'
+    RoutesCoverage::Adapters::SimpleCov.use
+  elsif defined? RSpec
+    RoutesCoverage::Adapters::RSpec.use
   else
     require "routes_coverage/adapters/atexit"
     RoutesCoverage::Adapters::AtExit.use

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 'appraisal'
   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 "rake", "~> 10.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: routes_coverage
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vasily Fedoseyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2021-11-13 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: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.14'
 - !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: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 description: Generates coverage report for routes hit by your request/integration/feature
   tests including capybara ones
 email:
@@ -74,33 +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_3.gemfile.lock
-- 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
-- gemfiles/rails_5.gemfile.lock
-- gemfiles/rails_51.gemfile
-- gemfiles/rails_51.gemfile.lock
 - lib/routes_coverage.rb
 - lib/routes_coverage/adapters/atexit.rb
 - lib/routes_coverage/adapters/rspec.rb
@@ -119,7 +96,7 @@ homepage: https://github.com/Vasfed/routes_coverage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,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.5.1
-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,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/log/
-/coverage/

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', '4.0.13'
-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_3.gemfile.lock

@@ -1,117 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    routes_coverage (0.4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (3.2.22.5)
-      actionpack (= 3.2.22.5)
-      mail (~> 2.5.4)
-    actionpack (3.2.22.5)
-      activemodel (= 3.2.22.5)
-      activesupport (= 3.2.22.5)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.5)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.22.5)
-      activesupport (= 3.2.22.5)
-      builder (~> 3.0.0)
-    activerecord (3.2.22.5)
-      activemodel (= 3.2.22.5)
-      activesupport (= 3.2.22.5)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.22.5)
-      activemodel (= 3.2.22.5)
-      activesupport (= 3.2.22.5)
-    activesupport (3.2.22.5)
-      i18n (~> 0.6, >= 0.6.4)
-      multi_json (~> 1.0)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (3.0.3)
-    builder (3.0.4)
-    docile (1.1.5)
-    erubis (2.7.0)
-    hike (1.2.3)
-    i18n (0.8.4)
-    journey (1.0.4)
-    json (1.8.6)
-    mail (2.5.4)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.25.1)
-    minitest (5.10.2)
-    multi_json (1.12.1)
-    polyglot (0.3.5)
-    power_assert (0.3.1)
-    rack (1.4.7)
-    rack-cache (1.6.1)
-      rack (>= 0.4)
-    rack-ssl (1.3.4)
-      rack
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (3.2.22.5)
-      actionmailer (= 3.2.22.5)
-      actionpack (= 3.2.22.5)
-      activerecord (= 3.2.22.5)
-      activeresource (= 3.2.22.5)
-      activesupport (= 3.2.22.5)
-      bundler (~> 1.0)
-      railties (= 3.2.22.5)
-    railties (3.2.22.5)
-      actionpack (= 3.2.22.5)
-      activesupport (= 3.2.22.5)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.5.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    sass (3.4.24)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.1)
-    sprockets (2.2.3)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    test-unit (3.2.2)
-      power_assert
-    thor (0.19.4)
-    tilt (1.4.1)
-    treetop (1.4.15)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.53)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal
-  bundler (~> 1.14)
-  minitest
-  rails (~> 3.2.22)
-  rake (~> 10.0)
-  routes_coverage!
-  sass
-  simplecov
-  sprockets
-  test-unit
-
-BUNDLED WITH
-   1.15.1

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: "../"