routes_coverage 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb3534646a507fefba0989e3257bb6848dc92d3
-  data.tar.gz: 68f609a43165593a150a252260ea4780a6b70c07
+  metadata.gz: 899581bd48d52230827553a1a8f94428f7c224cc
+  data.tar.gz: debceb6a0e49ef3d7b313c2733fc20ce3b08d428
 SHA512:
-  metadata.gz: ebb1acac5797622c4155d74875953b535cb48f8fafc2d9b7749a8087ab49fc1cbedd9be15820bb50976c04002ed1794b0d3e2a69fc6c7edf15a3ab87805959a7
-  data.tar.gz: 49505c2171c86c1b0dc473bb6636db8a1b15a61f224f89d623ffa0a5211232dd37bf2d3e69233d9d5e779e0ef38ee88026e65a9534ab9b4e9507aa19096b8747
+  metadata.gz: 452ab35f957e94c2122f89cb8c85599da67ea5ee8710c5090fe236d7b50a83d135221d42764fdb00d72309ebf85ea29b3e6047e30e1ef1b02dd4bc7e7ffd46f6
+  data.tar.gz: d0288d1afe2888e8118d09f2758acf8847cab1567b88dad93d59cfd5a84423095f2a6a6af4f4dd2206dbbc33f50d1556b40667611e93c491d3f8313fe5e2c924

data/Appraisals

@@ -26,3 +26,8 @@ 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/gemfiles/rails_3.gemfile

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,117 @@
+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.lock

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

data/gemfiles/rails_40_rspec.gemfile.lock

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

data/gemfiles/rails_40_simplecov.gemfile.lock

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

data/gemfiles/rails_42.gemfile.lock

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

data/gemfiles/rails_5.gemfile.lock

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

data/gemfiles/rails_51.gemfile.lock

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

data/lib/routes_coverage/formatters/full_text.rb

@@ -2,14 +2,30 @@ module RoutesCoverage
   module Formatters
     class FullText < SummaryText
 
-
-      class RouteFormatter < ActionDispatch::Routing::ConsoleFormatter
+      class RouteFormatter
+        attr_reader :buffer
 
         def initialize result=nil, _settings=nil, output_hits=false
+          @buffer = []
           @result = result
           @output_hits = output_hits
           @output_prefix = false
-          super()
+        end
+
+        def result
+          @buffer.join("\n")
+        end
+
+        def section_title(title)
+          @buffer << "\n#{title}:"
+        end
+
+        def section(routes)
+          @buffer << draw_section(routes)
+        end
+
+        def header(routes)
+          @buffer << draw_header(routes)
         end
 
         def no_routes _routes_from_rails5=nil
@@ -27,7 +43,11 @@ module RoutesCoverage
             # puts "route is #{r.inspect}"
             if @output_hits
               # hits = " ?"
-              original_route = r[:original].__getobj__ # SimpleDelegator
+              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}"
@@ -49,24 +69,34 @@ module RoutesCoverage
         end
       end
 
+
+      def routes_section formatter, title, routes
+        formatter.buffer << title
+
+        if routes.none?
+          formatter.no_routes
+        else
+          formatter.header routes
+          formatter.section routes
+        end
+
+        formatter.result
+      end
+
       def hit_routes
         routes = result.hit_routes
+        # 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
 
-        # verb_width = routes.map{ |r| r[:verb].length }.max
-        # path_width = routes.map{ |r| r[:path].length }.max
-
-        [
-          "Covered routes:",
-          # "#{"Verb".ljust(verb_width)} #{"Path".ljust(path_width)} Reqs",
-          # routes.map do |r|
-          #   "#{r.verb.ljust(verb_width)} #{r.path.ljust(path_width)} #{r.reqs}"
-          # end
-          #TODO: replace formatter
-          Result::Inspector.new(routes).format(RouteFormatter.new(result, settings, true)),
-          nil,
-          "Pending routes:",
-          Result::Inspector.new(result.pending_routes).format(RouteFormatter.new),
-        ].flatten.join("\n")
+        return routes_section(RouteFormatter.new(result, settings, true), "Covered routes:", hit_routes) + "\n\n" +
+        routes_section(RouteFormatter.new(result, settings), "Pending routes:", pending_routes)
       end
 
       def format

data/lib/routes_coverage/result.rb

@@ -1,8 +1,91 @@
 require 'active_support/core_ext/string' # needed for rails5 version of inspector
-require 'action_dispatch/routing/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
+          @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
+
+    rescue LoadError
+      #rails 3
+      require 'rails/application/route_inspector'
+      class Inspector < Rails::Application::RouteInspector
+        NEW_RAILS = false
+        def collect_all_routes(routes)
+          res = collect_routes(routes)
+          @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 = routes.collect do |route|
+            route_reqs = route.requirements
+
+            rack_app = discover_rack_app(route.app)
+
+            controller = route_reqs[:controller] || ':controller'
+            action     = route_reqs[:action]     || ':action'
+
+            endpoint = rack_app ? rack_app.inspect : "#{controller}##{action}"
+            constraints = route_reqs.except(:controller, :action)
+
+            reqs = endpoint
+            reqs += " #{constraints.inspect}" unless constraints.empty?
+
+            collect_engine_routes(reqs, rack_app)
+
+            { name:   route.name.to_s,
+              verb:   route.verb.source.gsub(/[$^]/, ''),
+              path:   route.path.spec.to_s,
+              reqs:   reqs,
+              # added:
+              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
       @all_routes = all_routes
       @route_hit_counts = hit_routes
@@ -75,44 +158,16 @@ module RoutesCoverage
     end
 
     def all_routes_with_hits
-      res = Inspector.new(all_routes).collect_all_routes
+      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|
         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.3.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routes_coverage
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,8 @@ files:
 - 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