rails-route-checker 0.2.3 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19d68dcbdd849a080cf1e5d99f1ae4a5835ad770
-  data.tar.gz: eb811f79a36bdf90e44cc440549dd279cc1d8a73
+SHA256:
+  metadata.gz: 83a8db628f8a08403d87c03eb0b33bd1b6de966761b4685d6e0d63b03f39cbb7
+  data.tar.gz: 4c26964a8ebc9494fbb17c20cee37ab71752c41830a53850a495a49c48d232f0
 SHA512:
-  metadata.gz: 545ed87d3c89646a04cf3a7e7aee7b90ee48a16d33d7d8fce0699ec0c0ea01a211b2bd659dd5a85740a2c5ebeadd92cb017cfca426384fd09844700b4149d94c
-  data.tar.gz: 75ea1b5e8b936cb03925fb4c79369e86b9be5643401adda5bc0878689c8f3f6a16494fd74dec7f63307e582b86bd31c083805ed575466b87fa5ba33e56e8b058
+  metadata.gz: 740e34c8e804283c61a8f5d38c0a08ef66d463c06780720bec0bb4cfa18ba4cdb6b2cab24ebf031c1c5fadfb0ac48639a95b25fc20013f65b8c689e1558518d9
+  data.tar.gz: f23cc07438b3cd24a1748ddb64124557066b36d0aceebaeb7e293323901991bafa8a7bc897ada5ec8172e7bb68a8574a67e769ba504f6fbe08b27261054e7f04

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/exe/rails-route-checker

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rails-route-checker'
 require 'optparse'
@@ -24,6 +25,6 @@ end.parse!
 
 options[:config_file] = '.rails-route-checker.yml' if File.exist?('.rails-route-checker.yml') && !options[:config_file]
 
-rrc = RailsRouteChecker::Runner.new(options)
+rrc = RailsRouteChecker::Runner.new(**options)
 puts rrc.output
 exit rrc.issues? ? 1 : 0

data/lib/rails-route-checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'rails-route-checker/app_interface'
 require_relative 'rails-route-checker/config_file'
 require_relative 'rails-route-checker/loaded_app'

data/lib/rails-route-checker/app_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   class AppInterface
     def initialize(**opts)
@@ -10,12 +12,7 @@ module RailsRouteChecker
         action = r.requirements[:action]
 
         next if options[:ignored_controllers].include?(controller)
-
-        if controller_information.key?(controller)
-          info = controller_information[controller]
-          next if info[:actions].include?(action)
-          next if info[:lookup_context] && info[:lookup_context].template_exists?("#{controller}/#{action}")
-        end
+        next if controller_has_action?(controller, action)
 
         {
           controller: controller,
@@ -42,6 +39,16 @@ module RailsRouteChecker
       end
     end
 
+    def controller_has_action?(controller, action)
+      return false unless controller_information.key?(controller)
+
+      info = controller_information[controller]
+      return true if info[:actions].include?(action)
+      return true if info[:lookup_context]&.template_exists?("#{controller}/#{action}")
+
+      false
+    end
+
     def generate_undef_view_path_calls
       generate_undef_view_path_calls_erb + generate_undef_view_path_calls_haml
     end
@@ -59,6 +66,7 @@ module RailsRouteChecker
         filter = lambda do |path_or_url|
           return false if match_in_whitelist?(filename, path_or_url)
           return false if match_defined_in_view?(controller, path_or_url)
+
           true
         end
 
@@ -85,6 +93,7 @@ module RailsRouteChecker
         filter = lambda do |path_or_url|
           return false if match_in_whitelist?(filename, path_or_url)
           return false if match_defined_in_view?(controller, path_or_url)
+
           true
         end
 
@@ -105,6 +114,7 @@ module RailsRouteChecker
         filter = lambda do |path_or_url|
           return false if match_in_whitelist?(filename, path_or_url)
           return false if match_defined_in_ruby?(controller, path_or_url)
+
           return true
         end
 
@@ -115,18 +125,21 @@ module RailsRouteChecker
     def match_in_whitelist?(filename, path_or_url)
       possible_route_name = path_or_url.sub(/_(?:url|path)$/, '')
       return true if options[:ignored_paths].include?(possible_route_name)
+
       (options[:ignored_path_whitelist][filename] || []).include?(path_or_url)
     end
 
     def match_defined_in_view?(controller, path_or_url)
       possible_route_name = path_or_url.sub(/_(?:url|path)$/, '')
       return true if loaded_app.all_route_names.include?(possible_route_name)
+
       controller && controller[:helpers].include?(path_or_url)
     end
 
     def match_defined_in_ruby?(controller, path_or_url)
       possible_route_name = path_or_url.sub(/_(?:url|path)$/, '')
       return true if loaded_app.all_route_names.include?(possible_route_name)
+
       controller && controller[:instance_methods].include?(path_or_url)
     end
 
@@ -137,6 +150,7 @@ module RailsRouteChecker
       while possible_controller_path.any?
         controller_name = possible_controller_path.join('/')
         return controller_information[controller_name] if controller_exists?(controller_name)
+
         possible_controller_path = possible_controller_path[0..-2]
       end
       controller_information['application']
@@ -145,12 +159,14 @@ module RailsRouteChecker
     def controller_from_ruby_file(filename)
       controller_name = (filename.match(%r{app/controllers/(.*)_controller.rb}) || [])[1]
       return controller_information[controller_name] if controller_exists?(controller_name)
+
       controller_information['application']
     end
 
     def controller_exists?(controller_name)
       return false unless controller_name
-      File.exists?("app/controllers/#{controller_name}_controller.rb")
+
+      File.exist?("app/controllers/#{controller_name}_controller.rb")
     end
   end
 end

data/lib/rails-route-checker/config_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   class ConfigFile
     def initialize(filename)

data/lib/rails-route-checker/loaded_app.rb

@@ -1,18 +1,31 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   class LoadedApp
     def initialize
-      @app = suppress_output do
-        app_base_path = Dir.pwd
+      app_base_path = Dir.pwd
+      suppress_output do
         require_relative "#{app_base_path}/config/boot"
-        require_relative "#{Dir.pwd}/config/environment"
+      end
 
-        a = Rails.application
-        a.eager_load!
+      begin
+        suppress_output do
+          require_relative "#{Dir.pwd}/config/environment"
+        end
+      rescue Exception => e
+        puts "Requiring your config/environment.rb file failed."
+        puts "This means that something raised while trying to start Rails."
+        puts ""
+        puts e.backtrace
+        raise(e)
+      end
+
+      suppress_output do
+        @app = Rails.application
+        @app.eager_load!
         attempt_to_load_default_controllers
-        a.reload_routes!
+        @app.reload_routes!
         Rails::Engine.subclasses.each(&:eager_load!)
-
-        a
       end
     end
 
@@ -23,7 +36,7 @@ module RailsRouteChecker
         reject_route?(r)
       end.uniq
 
-      return @routes unless @app.config.respond_to?(:assets)
+      return @routes unless app.config.respond_to?(:assets)
 
       use_spec = defined?(ActionDispatch::Journey::Route) || defined?(Journey::Route)
       @routes.reject do |route|
@@ -40,18 +53,13 @@ module RailsRouteChecker
       @controller_information ||= ActionController::Base.descendants.map do |controller|
         next if controller.controller_path.start_with?('rails/')
 
-        instance_methods = (controller.instance_methods.map(&:to_s) + controller.private_instance_methods.map(&:to_s))
-        lookup_context = ActionView::LookupContext.new(
-          controller._view_paths, {}, controller._prefixes
-        ) if controller.instance_methods.include?(:default_render)
-
         [
           controller.controller_path,
           {
             helpers: controller.helpers.methods.map(&:to_s),
             actions: controller.action_methods.to_a,
-            instance_methods: instance_methods.compact.uniq,
-            lookup_context: lookup_context
+            instance_methods: instance_methods(controller),
+            lookup_context: lookup_context(controller)
           }
         ]
       end.compact.to_h
@@ -61,6 +69,16 @@ module RailsRouteChecker
 
     attr_reader :app
 
+    def lookup_context(controller)
+      return nil unless controller.instance_methods.include?(:default_render)
+
+      ActionView::LookupContext.new(controller._view_paths, {}, controller._prefixes)
+    end
+
+    def instance_methods(controller)
+      (controller.instance_methods.map(&:to_s) + controller.private_instance_methods.map(&:to_s)).compact.uniq
+    end
+
     def suppress_output
       begin
         original_stderr = $stderr.clone
@@ -80,7 +98,7 @@ module RailsRouteChecker
     end
 
     def attempt_to_load_default_controllers
-      # rubocop:disable Lint/HandleExceptions
+      # rubocop:disable Lint/SuppressedException
       begin
         ::Rails::InfoController
       rescue NameError # ignored
@@ -93,7 +111,7 @@ module RailsRouteChecker
         ::Rails::MailersController
       rescue NameError # ignored
       end
-      # rubocop:enable Lint/HandleExceptions
+      # rubocop:enable Lint/SuppressedException
     end
 
     def reject_route?(route)
@@ -106,6 +124,7 @@ module RailsRouteChecker
       action = route.requirements[:action]
       return true unless controller && action
       return true if controller.start_with?('rails/')
+
       false
     end
   end

data/lib/rails-route-checker/parsers/erb_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module ErbParser
@@ -5,23 +7,7 @@ module RailsRouteChecker
         def run(filename, **opts)
           file_source = opts[:source] || File.read(filename)
 
-          next_ruby_source_line_num = 1
-          ruby_source = ''
-          source_map = {}
-
-          file_source.split("\n").each_with_index do |line, line_num|
-            ruby_lines = process_line(line)
-            next unless ruby_lines.any?
-
-            ruby_source += ruby_lines.join("\n") + "\n"
-            ruby_lines.length.times do |i|
-              source_map[next_ruby_source_line_num + i] = line_num + 1
-            end
-            next_ruby_source_line_num += ruby_lines.length
-          end
-
-          opts[:source] = ruby_source
-          opts[:source_map] = source_map
+          opts.merge!(process_file(file_source))
 
           RailsRouteChecker::Parsers::RubyParser.run(filename, **opts)
         end
@@ -46,6 +32,28 @@ module RailsRouteChecker
           end
           ruby_lines
         end
+
+        def process_file(source)
+          next_ruby_source_line_num = 1
+          ruby_source = ''
+          source_map = {}
+
+          source.split("\n").each_with_index do |line, line_num|
+            ruby_lines = process_line(line)
+            next unless ruby_lines.any?
+
+            ruby_source += ruby_lines.join("\n") + "\n"
+            ruby_lines.length.times do |i|
+              source_map[next_ruby_source_line_num + i] = line_num + 1
+            end
+            next_ruby_source_line_num += ruby_lines.length
+          end
+
+          {
+            source: ruby_source,
+            source_map: source_map
+          }
+        end
       end
     end
   end

data/lib/rails-route-checker/parsers/haml_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'haml_parser/document'
 require_relative 'haml_parser/tree/node'
 require_relative 'haml_parser/tree/filter_node'

data/lib/rails-route-checker/parsers/haml_parser/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser
@@ -9,9 +11,10 @@ module RailsRouteChecker
           @source_lines = @source.split(/\r\n|\r|\n/)
 
           version = Gem::Version.new(Haml::VERSION).approximate_recommendation
+          options = Haml::Options.new
           original_tree = case version
-                          when '~> 4.0', '~> 4.1' then Haml::Parser.new(@source, Haml::Options.new).parse
-                          when '~> 5.0' then Haml::Parser.new(options).call(@source)
+                          when '~> 4.0', '~> 4.1' then Haml::Parser.new(@source, options).parse
+                          when '~> 5.0', '~> 5.1', '~> 5.2' then Haml::Parser.new(options).call(@source)
                           else raise "Cannot handle Haml version: #{version}"
                           end
 
@@ -21,9 +24,7 @@ module RailsRouteChecker
         private
 
         def process_tree(original_tree)
-          if Gem::Requirement.new('~> 4.0.0').satisfied_by?(Gem.loaded_specs['haml'].version)
-            original_tree.children.pop
-          end
+          original_tree.children.pop if Gem::Requirement.new('~> 4.0.0').satisfied_by?(Gem.loaded_specs['haml'].version)
 
           convert_tree(original_tree)
         end

data/lib/rails-route-checker/parsers/haml_parser/ruby_extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser
@@ -53,6 +55,7 @@ module RailsRouteChecker
           yield
 
           return unless start_block
+
           @indent_level -= 1
           add_line('end', node)
         end

data/lib/rails-route-checker/parsers/haml_parser/tree/filter_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser

data/lib/rails-route-checker/parsers/haml_parser/tree/node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser
@@ -68,7 +70,7 @@ module RailsRouteChecker
             next_sibling = siblings.next(self)
             return next_sibling if next_sibling
 
-            parent.successor if parent
+            parent&.successor
           end
 
           def next_node

data/lib/rails-route-checker/parsers/haml_parser/tree/root_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser

data/lib/rails-route-checker/parsers/haml_parser/tree/script_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser

data/lib/rails-route-checker/parsers/haml_parser/tree/silent_script_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser

data/lib/rails-route-checker/parsers/haml_parser/tree/tag_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module HamlParser
@@ -18,7 +20,7 @@ module RailsRouteChecker
           end
 
           def attributes_source
-            @attr_source ||=
+            @attr_source ||= # rubocop:disable Naming/MemoizedInstanceVariableName
               begin
                 _explicit_tag, static_attrs, rest =
                   source_code.scan(/\A\s*(%[-:\w]+)?([-:\w\.\#]*)(.*)/m)[0]

data/lib/rails-route-checker/parsers/loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   module Parsers
     module Loader
@@ -21,6 +23,7 @@ module RailsRouteChecker
 
         def haml_available?
           return @haml_available if defined?(@haml_available)
+
           @haml_available = gem_installed?('haml')
         end
 
@@ -46,6 +49,7 @@ module RailsRouteChecker
         def if_unloaded(parser)
           @loaded_parsers ||= {}
           return false if @loaded_parsers[parser]
+
           yield
           @loaded_parsers[parser] = true
         end

data/lib/rails-route-checker/parsers/ruby_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ripper'
 
 module RailsRouteChecker
@@ -6,15 +8,16 @@ module RailsRouteChecker
       class << self
         def run(filename, **opts)
           file_source = opts[:source] || File.read(filename)
+          process_file(filename, file_source, opts)
+        end
 
-          items = []
+        private
 
-          deep_iterator(Ripper.sexp(file_source)) do |item, extra_data|
-            scope = extra_data[:scope]
-            next unless %i[vcall fcall].include?(scope[-2])
-            next unless scope[-1] == :@ident
-            next unless item.end_with?('_path', '_url')
+        def process_file(filename, source, opts)
+          items = []
 
+          deep_iterator(Ripper.sexp(source)) do |item, extra_data|
+            next unless item_is_url_call?(item, extra_data)
             next if opts[:filter].respond_to?(:call) && !opts[:filter].call(item)
 
             line = extra_data[:position][0]
@@ -26,30 +29,43 @@ module RailsRouteChecker
           items
         end
 
-        private
+        def item_is_url_call?(item, extra_data)
+          scope = extra_data[:scope]
+          return false unless %i[vcall fcall].include?(scope[-2])
+          return false unless scope[-1] == :@ident
+          return false unless item.end_with?('_path', '_url')
+
+          true
+        end
 
         def deep_iterator(list, current_scope = [], current_line_num = [], &block)
-          if list.is_a?(Array)
-            if list[0].is_a?(Symbol)
-              current_scope << list[0]
-
-              if list[-1].is_a?(Array) && list[-1].length == 2 && list[-1].all? { |item| item.is_a?(Integer) }
-                current_line_num = list[-1]
-                list = list[0..-2]
-              end
-
-              list[1..-1].each do |item|
-                deep_iterator(item, current_scope, current_line_num, &block)
-              end
-              current_scope.pop
-            else
-              list.each do |item|
-                deep_iterator(item, current_scope, current_line_num, &block)
-              end
+          return deep_iterate_array(list, current_scope, current_line_num, &block) if list.is_a?(Array)
+
+          yield(list, { scope: current_scope, position: current_line_num }) unless list.nil?
+        end
+
+        def deep_iterate_array(list, current_scope, current_line_num, &block)
+          unless list[0].is_a?(Symbol)
+            list.each do |item|
+              deep_iterator(item, current_scope, current_line_num, &block)
             end
-          elsif !list.nil?
-            yield(list, { scope: current_scope, position: current_line_num })
+            return
+          end
+
+          current_scope << list[0]
+
+          last_list_item = list[-1]
+          if last_list_item.is_a?(Array) &&
+             last_list_item.length == 2 &&
+             last_list_item.all? { |item| item.is_a?(Integer) }
+            current_line_num = last_list_item
+            list = list[0..-2]
+          end
+
+          list[1..-1].each do |item|
+            deep_iterator(item, current_scope, current_line_num, &block)
           end
+          current_scope.pop
         end
       end
     end

data/lib/rails-route-checker/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
   class Runner
     def initialize(**opts)
@@ -14,7 +16,7 @@ module RailsRouteChecker
     end
 
     def issues?
-      issues.values.flatten(1).count > 0
+      issues.values.flatten(1).count.positive?
     end
 
     def output
@@ -31,7 +33,7 @@ module RailsRouteChecker
     private
 
     def app_interface
-      @app_interface ||= RailsRouteChecker::AppInterface.new(@options)
+      @app_interface ||= RailsRouteChecker::AppInterface.new(**@options)
     end
 
     def missing_actions_output

data/lib/rails-route-checker/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsRouteChecker
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.2.8'
 end

data/rails-route-checker.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rails-route-checker/version'
 
@@ -22,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.51'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.86'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-route-checker
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.8
 platform: ruby
 authors:
 - Dave Allie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.86'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.86'
 description: A linting tool that helps you find any routes defined in your routes.rb
   file that don't have a corresponding controller action, and find any _path or _url
   calls that don't have a corresponding route in the routes.rb file.
@@ -102,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A linting tool for your Rails routes