rails_routes_analyzer 1.0.4 → 2.0.0

data/lib/rails_routes_analyzer/route_issue/no_action.rb

@@ -0,0 +1,37 @@
+require_relative 'base'
+
+module RailsRoutesAnalyzer
+  module RouteIssue
+
+    class NoAction < Base
+
+      fields :missing_actions
+
+      def human_readable_error_message
+        messages = missing_actions.map do |action|
+          "`#{route_creation_method} :#{action}' call at #{file_location} there is no matching action in #{controller_class_name}"
+        end
+
+        return if messages.empty?
+
+        messages.size == 1 ? messages[0] : messages
+      end
+
+      def error_suggestion(has_present_actions:, num_controllers:)
+        actions = format_actions(missing_actions)
+        if has_present_actions
+          "remove case#{'s' if missing_actions.size > 1} for #{actions}"
+        else
+          "delete line, #{actions} matches nothing"
+        end.tap do |message|
+          message << " for controller #{controller_class_name}" if num_controllers > 1
+        end
+      end
+
+      def try_to_fix_line(_line)
+        '' # Delete
+      end
+    end
+
+  end
+end

data/lib/rails_routes_analyzer/route_issue/no_controller.rb

@@ -0,0 +1,30 @@
+require_relative 'base'
+
+module RailsRoutesAnalyzer
+  module RouteIssue
+
+    class NoController < Base
+
+      fields :error
+
+      def human_readable_error_message
+        "`#{route_creation_method}' call at #{file_location} there is no controller: #{controller_class_name} for '#{controller_name}' (actions: #{action_names.inspect})".tap do |msg|
+          msg << " error: #{error}" if error.present?
+        end
+      end
+
+      def error_suggestion(has_present_actions:, **)
+        if has_present_actions
+          "remove case for #{controller_class_name} as it doesn't exist"
+        else
+          "delete, #{controller_class_name} not found"
+        end
+      end
+
+      def try_to_fix_line(_line)
+        '' # Delete
+      end
+    end
+
+  end
+end

data/lib/rails_routes_analyzer/route_issue/resources.rb

@@ -0,0 +1,133 @@
+require_relative 'base'
+
+module RailsRoutesAnalyzer
+  module RouteIssue
+
+    class Resources < Base
+
+      fields :suggested_param
+
+      def human_readable_error_message
+        "`#{route_creation_method}' call at #{file_location} for #{controller_class_name} should use #{suggested_param}"
+      end
+
+      def error_suggestion(num_controllers:, **)
+        "use #{suggested_param}".tap do |message|
+          message << " only for #{controller_class_name}" if num_controllers > 1
+        end
+      end
+
+      def verbose_message
+        "This route currently covers unimplemented actions: #{format_actions(missing_actions.sort)}"
+      end
+
+      # This is horrible but just maybe works well enough most of the time to be useful.
+      RESOURCES_PARSE_REGEX = %r%
+        \A
+        (?<beginning>       # contains the part that looks like:  resources :some_things
+          \s*
+          resources?
+          \(?
+          \s*
+          :\w+              # the name of the resource as a symbol
+        )
+        (?<separator>,\s*)? # something optional that separates "resources :some_things" from its parameters
+        (?<params>.*?)      # all the parameters whatever they might be, if present at all
+        (?<end>
+          \)?
+          (\s+(do|{))?      # optional block, either " do" or " {"
+          [\t ]*            # any whitespace, except linebreak (not sure why it's matched without 'm' modifier here)
+          (\#.*)?           # an optional comment
+        )
+        $
+      %x
+
+      ONLY_EXCEPT_PARAM_REGEX = %r{
+        (
+          (:(?<key>only|except)\s*=>)  # ":only =>" or ":except =>"
+          |
+          (?<key>only|except):         # "only:" or "except:"
+        )
+        \s*
+        (
+          \[[^\]]*\]  # anything between [ and ]
+          |
+          :\w+        # or a symbol
+        )
+      }x
+
+      RESOURCE_OTHER_PARAM_REGEX = %r{
+        (
+          (:(?<key>\w+)\s*=>)
+          |
+          (?<key>\w+):
+        )
+        \s*
+        (
+          \[[^\]]*\]  # anything between [ and ]
+          |
+          :\w+        # or a symbol
+          |
+          '[^']*'     # a limited single-quote string
+          |
+          "[^"]*"     # a limited double-quote string
+          |
+          true
+          |
+          false
+        )
+      }x
+
+      def try_to_fix_line(line, suggestion: suggested_param)
+        self.class.try_to_fix_resources_line(line, suggestion)
+      end
+
+      def self.try_to_fix_resources_line(line, suggestion)
+        data = line.match(RESOURCES_PARSE_REGEX)
+        line_break = line[/$(.*)\z/m, 1]
+
+        return unless data
+
+        separator = data[:separator].presence || ', '
+
+        params = \
+          if [nil, ''].include?(data[:params])
+            suggestion
+          elsif (existing = data[:params][ONLY_EXCEPT_PARAM_REGEX]).present?
+            # We get here if the only/except parameter already exists and
+            # our only task is to replace it, should generally be ok.
+            data[:params].sub(existing, suggestion)
+          elsif does_params_look_like_a_safe_hash?(data[:params])
+            # If params looks like a hash it should be safe to append the suggestion
+            "#{data[:params]}, #{suggestion}"
+          elsif (match = data[:params].match(/\A(?<opening>\s*{\s*)(?<inner_data>.*?)(?<closing>\s*}\s*)\z/))
+            # If params looks like a safe hash between { and } then add they key inside the hash
+            if does_params_look_like_a_safe_hash?(match[:inner_data])
+              "#{match[:opening]}#{match[:inner_data]}, #{suggestion}#{match[:closing]}"
+            end
+          end
+
+        return unless params
+
+        "#{data[:beginning]}#{separator}#{params}#{data[:end]}#{line_break}"
+      end
+
+      # Check if the parameter string contains only a limited set of known
+      # resource hash keys in which case it should generally be safe to
+      # append only:/except: to it.
+      def self.does_params_look_like_a_safe_hash?(params)
+        return false if params =~ /[{}]/ # definitely can't handle: "resources :name, { key: val }"
+
+        # Replace all known "key: simple_value" pairs with 'X'
+        result = params.gsub(RESOURCE_OTHER_PARAM_REGEX, 'X')
+
+        # Remove all whitespace
+        result.gsub!(/\s/, '')
+
+        # check that the result string looks like: "X" or "X,X", "X,X,X" depending on how many parameters there were
+        result.split(',').uniq == %w(X)
+      end
+    end
+
+  end
+end

data/lib/rails_routes_analyzer/route_line.rb

@@ -0,0 +1,85 @@
+module RailsRoutesAnalyzer
+
+  # Represents a single line in Rails routes file with all
+  # the collected information about that line.
+  class RouteLine
+
+    attr_reader :full_filename, :line_number, :records
+
+    def initialize(full_filename:, line_number:, records:)
+      @full_filename = full_filename
+      @line_number   = line_number
+      @records       = records
+    end
+
+    def file_location
+      @file_location ||= "#{full_filename}:#{line_number}"
+    end
+
+    def present_actions?
+      records.any?(&:present_actions?)
+    end
+
+    def issues
+      @issues ||= records.select(&:issue?)
+    end
+
+    def issues?
+      issues.any?
+    end
+
+    def annotate(line, try_to_fix:, allow_deleting:)
+      suggestions = combined_suggestions
+      if try_to_fix && !(fix_for_line = try_to_fix_line(line, allow_deleting: allow_deleting,
+                                                              suggestion_comment: "# SUGGESTION #{suggestions}")).nil?
+        fix_for_line
+      else
+        add_suggestions_to(line, suggestions)
+      end
+    end
+
+    # Try to generate an automatic fix for the line, this does not
+    # apply to lines with multiple issues (iterations) as those
+    # will most likely require changes to the surrounding code.
+    def try_to_fix_line(line, allow_deleting:, suggestion_comment:)
+      has_one_issue = issues.size == 1
+      has_one_iteration = records.size == 1
+
+      return unless has_one_issue && has_one_iteration
+
+      fix = issues[0].try_to_fix_line(line)
+
+      return unless fix.present? || (fix == '' && allow_deleting && safely_deletable_line?(line))
+
+      fix.gsub(suggestion_comment, '').gsub(/\ +$/, '')
+    end
+
+    # Should avoid deleting lines that look like they might start a block because
+    # we're not smart enough to also be able to delete the end of that block.
+    def safely_deletable_line?(line)
+      line !~ /( do(\s|$)|{)/
+    end
+
+    def add_suggestions_to(line, suggestions)
+      line.sub(/( # SUGGESTION.*)?$/,
+               suggestions.present? ? " # SUGGESTION #{suggestions}" : "")
+    end
+
+    def all_controller_class_names
+      records.map(&:controller_class_name).uniq
+    end
+
+    def combined_suggestions
+      return unless issues?
+
+      context = {
+        has_present_actions: present_actions?,
+        num_controllers:     all_controller_class_names.count,
+      }
+
+      issues.map { |issue| issue.suggestion(**context) }.flatten.join(', ')
+    end
+
+  end
+
+end

data/lib/rails_routes_analyzer/version.rb

@@ -1,3 +1,3 @@
 module RailsRoutesAnalyzer
-  VERSION = "1.0.4"
+  VERSION = "2.0.0".freeze
 end

data/lib/tasks/rails_routes_analyzer.rake

@@ -1,62 +1,40 @@
 namespace :routes do
-
-  desc 'Scan for dead-end routes including bad map.resource(s) :only/:except parameters'
+  desc 'Scan for dead-end routes'
   task dead: :environment do
-    analysis = RailsRoutesAnalyzer::RouteAnalysis.new(
-                 verbose:     !ENV['VERBOSE'].nil?,
-                 only_only:   !ENV['ONLY_ONLY'].nil?,
-                 only_except: !ENV['ONLY_EXCEPT'].nil?)
+    RailsRoutesAnalyzer.routes_dead(ENV)
+  end
 
-    if analysis.issues.empty?
-      puts "No route issues found"
-      exit 0
+  namespace :dead do
+    desc "Output a routes file with suggested modifications in comments (doesn't change the original file)"
+    task annotate: :environment do
+      RailsRoutesAnalyzer.routes_dead_annotate(ENV)
     end
 
-    analysis.issues.each do |issue|
-      puts issue.human_readable
+    desc "Updates routes file(s) with suggestions for fixes in comments, requires unmodified git-controlled file(s)"
+    task :"annotate:inplace" => :environment do |_, args|
+      RailsRoutesAnalyzer.routes_dead_annotate_inplace(ENV, args.extras)
     end
-  end
-
-  desc "Output a routes file with suggested modifications in comments (NOTE: doesn't touch the original file)"
-  task annotate_dead: :environment do
-    annotator = RailsRoutesAnalyzer::RouteFileAnnotator.new
-    annotator.annotate_routes_file(ENV['ANNOTATE'])
-  end
-
-  desc 'Scan for controller action methods that are missing a route (pass STRICT=1 to account for inherited actions)'
-  task missing: :environment do
-    analysis = RailsRoutesAnalyzer::RouteAnalysis.new
-    implemented_routes = analysis.implemented_routes
-    all_action_methods = RailsRoutesAnalyzer.get_all_action_methods(ignore_parent_provided: ENV['STRICT'].blank?)
-
-    missing = all_action_methods.to_a - implemented_routes.to_a
 
-    if missing.any?
-      puts "NOTE Some gems, such as Devise, are expected to provide actions that have no matching"
-      puts "     routes in case a particular feature is not enabled, this is normal and expected."
-      puts "NOTE If any non-action methods are reported please consider making those non-public"
-      puts "     or using another solution that would make #action_methods not return those."
-      puts ""
-
-      unused_controllers = Set.new(all_action_methods.to_a.map(&:first) - implemented_routes.to_a.map(&:first))
-
-      if unused_controllers.any?
-        puts "Controllers with no routes pointing to them:"
-        unused_controllers.to_a.sort.each do |controller_name|
-          puts "  #{controller_name}"
-        end
-        puts ""
-      end
+    desc "Outputs a routes file with simple fixes auto-applied others suggested in comments (doesn't change the original file)"
+    task fix: :environment do
+      RailsRoutesAnalyzer.routes_dead_fix(ENV)
+    end
 
-      puts "Actions without a route:"
-      missing.sort.each do |(controller_name, action_name)|
-        unless unused_controllers.include?(controller_name)
-          puts "  #{controller_name}::#{action_name}"
-        end
-      end
-    else
-      puts "There are no actions without a route"
+    desc "Updates routes file(s) with simple fixes auto-applied others suggested in comments, requires unmodified git-controlled file(s)"
+    task :"fix:inplace" => :environment do |_, args|
+      RailsRoutesAnalyzer.routes_dead_fix_inplace(ENV, args.extras)
     end
   end
+end
 
+namespace :actions do
+  desc 'List application actions which have no routes mapped to them'
+  task missing_route: :environment do |_, args|
+    RailsRoutesAnalyzer.routes_actions_missing_route(ENV, args.extras)
+  end
+
+  desc 'List all actions provided by the application'
+  task list_all: :environment do |_, args|
+    RailsRoutesAnalyzer.routes_actions_list_all(ENV, args.extras)
+  end
 end

data/rails_routes_analyzer.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = RailsRoutesAnalyzer::VERSION
   spec.authors       = ["Bear Metal OÜ", "Tarmo Tänav"]
   spec.email         = ["tarmo@bearmetal.eu"]
+  spec.required_ruby_version = ">= 2.1.0"
 
-  spec.summary       = %q{Helps clean up rails routes}
-  #spec.description   = %q{}
+  spec.summary       = "Helps clean up rails routes"
+  spec.description   = "Tools to identify and in some cases automatically remove unused Rails routes.\nAlso includes a tool to find action methods without routes and list all action methods provided by the application."
   spec.homepage      = "https://github.com/bear-metal/rails_routes_analyzer"
   spec.license       = "MIT"
 
@@ -21,11 +22,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "actionpack", ">= 3.2"
+  spec.add_runtime_dependency "git"
+
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rails", "~> 5.0"
+  spec.add_development_dependency "minitest", "~> 5.10.1"
   spec.add_development_dependency "minitest-reporters", "~> 1.1.12"
   spec.add_development_dependency "minitest-color", "~> 0.0.2"
+  spec.add_development_dependency "minitest-focus"
+  spec.add_development_dependency "minitest-autotest"
+  spec.add_development_dependency "autotest-suffix"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_routes_analyzer
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Bear Metal OÜ
@@ -9,8 +9,36 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-12-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -45,56 +73,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.10.1
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 1.1.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 1.1.12
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: minitest-color
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.12
+        version: 0.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.12
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
-  name: minitest-color
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest-suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +165,51 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Tools to identify and in some cases automatically remove unused Rails routes.
+  Also includes a tool to find action methods without routes and list all action methods provided by the application.
 email:
 - tarmo@bearmetal.eu
 executables: []
@@ -118,6 +218,7 @@ extra_rdoc_files: []
 files:
 - ".autotest"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile_3.2
@@ -128,11 +229,21 @@ files:
 - bin/console
 - bin/setup
 - lib/rails_routes_analyzer.rb
+- lib/rails_routes_analyzer/action_analysis.rb
+- lib/rails_routes_analyzer/gem_manager.rb
+- lib/rails_routes_analyzer/parameter_handler.rb
 - lib/rails_routes_analyzer/rails_routes_analyzer.rb
+- lib/rails_routes_analyzer/railtie.rb
 - lib/rails_routes_analyzer/route_analysis.rb
+- lib/rails_routes_analyzer/route_call.rb
 - lib/rails_routes_analyzer/route_file_annotator.rb
 - lib/rails_routes_analyzer/route_interceptor.rb
 - lib/rails_routes_analyzer/route_issue.rb
+- lib/rails_routes_analyzer/route_issue/base.rb
+- lib/rails_routes_analyzer/route_issue/no_action.rb
+- lib/rails_routes_analyzer/route_issue/no_controller.rb
+- lib/rails_routes_analyzer/route_issue/resources.rb
+- lib/rails_routes_analyzer/route_line.rb
 - lib/rails_routes_analyzer/version.rb
 - lib/tasks/rails_routes_analyzer.rake
 - rails_routes_analyzer.gemspec
@@ -148,7 +259,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Helps clean up rails routes