rubocop 0.51.0 → 0.87.0

data/lib/rubocop/cop/variable_force/variable.rb

@@ -4,14 +4,14 @@ module RuboCop
   module Cop
     class VariableForce
       # A Variable represents existence of a local variable.
-      # This holds a variable declaration node,
-      # and some states of the variable.
+      # This holds a variable declaration node and some states of the variable.
       class Variable
         VARIABLE_DECLARATION_TYPES =
           (VARIABLE_ASSIGNMENT_TYPES + ARGUMENT_DECLARATION_TYPES).freeze
 
         attr_reader :name, :declaration_node, :scope,
                     :assignments, :references, :captured_by_block
+
         alias captured_by_block? captured_by_block
 
         def initialize(name, declaration_node, scope)
@@ -38,6 +38,7 @@ module RuboCop
           !@references.empty?
         end
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
         def reference!(node)
           reference = Reference.new(node, @scope)
           @references << reference
@@ -46,17 +47,27 @@ module RuboCop
           @assignments.reverse_each do |assignment|
             next if consumed_branches.include?(assignment.branch)
 
-            unless assignment.run_exclusively_with?(reference)
-              assignment.reference!
-            end
+            assignment.reference!(node) unless assignment.run_exclusively_with?(reference)
+
+            # Modifier if/unless conditions are special. Assignments made in
+            # them do not put the assigned variable in scope to the left of the
+            # if/unless keyword. A preceding assignment is needed to put the
+            # variable in scope. For this reason we skip to the next assignment
+            # here.
+            next if in_modifier_if?(assignment)
 
             break if !assignment.branch || assignment.branch == reference.branch
 
-            unless assignment.branch.may_run_incompletely?
-              consumed_branches << assignment.branch
-            end
+            consumed_branches << assignment.branch unless assignment.branch.may_run_incompletely?
           end
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+        def in_modifier_if?(assignment)
+          parent = assignment.node.parent
+          parent = parent.parent if parent&.begin_type?
+          parent&.if_type? && parent&.modifier_form?
+        end
 
         def capture_with_block!
           @captured_by_block = true
@@ -67,8 +78,8 @@ module RuboCop
         # For more precise usage check, refer Assignment#used?.
         #
         # Once the variable is captured by a block, we have no idea
-        # when, where and how many times the block would be invoked
-        # and it means we cannot track the usage of the variable.
+        # when, where, and how many times the block would be invoked.
+        # This means we cannot track the usage of the variable.
         # So we consider it's used to suppress false positive offenses.
         def used?
           @captured_by_block || referenced?

data/lib/rubocop/cop/variable_force/variable_table.rb

@@ -5,8 +5,8 @@ module RuboCop
     class VariableForce
       # A VariableTable manages the lifetime of all scopes and local variables
       # in a program.
-      # This holds scopes as stack structure, and provides a way to add local
-      # variables to current scope and find local variables by considering
+      # This holds scopes as stack structure, provides a way to add local
+      # variables to current scope, and find local variables by considering
       # variable visibility of the current scope.
       class VariableTable
         def initialize(hook_receiver = nil)
@@ -14,7 +14,7 @@ module RuboCop
         end
 
         def invoke_hook(hook_name, *args)
-          @hook_receiver.send(hook_name, *args) if @hook_receiver
+          @hook_receiver&.send(hook_name, *args)
         end
 
         def scope_stack
@@ -120,6 +120,7 @@ module RuboCop
         def mark_variable_as_captured_by_block_if_so(variable)
           return unless current_scope.node.block_type?
           return if variable.scope == current_scope
+
           variable.capture_with_block!
         end
       end

data/lib/rubocop/cop/variable_force.rb

@@ -50,8 +50,8 @@ module RuboCop
 
       ZERO_ARITY_SUPER_TYPE = :zsuper
 
-      TWISTED_SCOPE_TYPES = %i[block class sclass defs].freeze
-      SCOPE_TYPES = (TWISTED_SCOPE_TYPES + %i[module def]).freeze
+      TWISTED_SCOPE_TYPES = %i[block class sclass defs module].freeze
+      SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:def]).freeze
 
       SEND_TYPE = :send
 
@@ -82,10 +82,9 @@ module RuboCop
       end
 
       def process_node(node)
-        catch(:skip_children) do
-          dispatch_node(node)
-          process_children(node)
-        end
+        method_name = node_handler_method_name(node)
+        retval = send(method_name, node) if method_name
+        process_children(node) unless retval == :skip_children
       end
 
       private
@@ -100,39 +99,40 @@ module RuboCop
       def process_children(origin_node)
         origin_node.each_child_node do |child_node|
           next if scanned_node?(child_node)
+
           process_node(child_node)
         end
       end
 
       def skip_children!
-        throw :skip_children
+        :skip_children
       end
 
       # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
-      def dispatch_node(node)
+      def node_handler_method_name(node)
         case node.type
         when VARIABLE_ASSIGNMENT_TYPE
-          process_variable_assignment(node)
+          :process_variable_assignment
         when REGEXP_NAMED_CAPTURE_TYPE
-          process_regexp_named_captures(node)
+          :process_regexp_named_captures
         when MULTIPLE_ASSIGNMENT_TYPE
-          process_variable_multiple_assignment(node)
+          :process_variable_multiple_assignment
         when VARIABLE_REFERENCE_TYPE
-          process_variable_referencing(node)
+          :process_variable_referencing
         when RESCUE_TYPE
-          process_rescue(node)
+          :process_rescue
         when ZERO_ARITY_SUPER_TYPE
-          process_zero_arity_super(node)
+          :process_zero_arity_super
         when SEND_TYPE
-          process_send(node)
+          :process_send
         when *ARGUMENT_DECLARATION_TYPES
-          process_variable_declaration(node)
+          :process_variable_declaration
         when *OPERATOR_ASSIGNMENT_TYPES
-          process_variable_operator_assignment(node)
+          :process_variable_operator_assignment
         when *LOOP_TYPES
-          process_loop(node)
+          :process_loop
         when *SCOPE_TYPES
-          process_scope(node)
+          :process_scope
         end
       end
       # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
@@ -152,9 +152,7 @@ module RuboCop
       def process_variable_assignment(node)
         name = node.children.first
 
-        unless variable_table.variable_exist?(name)
-          variable_table.declare_variable(name, node)
-        end
+        variable_table.declare_variable(name, node) unless variable_table.variable_exist?(name)
 
         # Need to scan rhs before assignment so that we can mark previous
         # assignments as referenced if rhs has referencing to the variable
@@ -175,6 +173,7 @@ module RuboCop
 
         variable_names.each do |name|
           next if variable_table.variable_exist?(name)
+
           variable_table.declare_variable(name, node)
         end
 
@@ -189,12 +188,16 @@ module RuboCop
       end
 
       def regexp_captured_names(node)
-        regexp_string = node.children[0].children[0] || ''
+        regexp_string = node.children.select(&:str_type?).map do |child|
+          child.children.first
+        end.join || ''
+
         regexp = Regexp.new(regexp_string)
 
         regexp.named_captures.keys
       end
 
+      # rubocop:disable Metrics/AbcSize
       def process_variable_operator_assignment(node)
         if LOGICAL_OPERATOR_ASSIGNMENT_TYPES.include?(node.type)
           asgn_node, rhs_node = *node
@@ -206,9 +209,7 @@ module RuboCop
 
         name = asgn_node.children.first
 
-        unless variable_table.variable_exist?(name)
-          variable_table.declare_variable(name, asgn_node)
-        end
+        variable_table.declare_variable(name, asgn_node) unless variable_table.variable_exist?(name)
 
         # The following statements:
         #
@@ -231,6 +232,7 @@ module RuboCop
 
         skip_children!
       end
+      # rubocop:enable Metrics/AbcSize
 
       def process_variable_multiple_assignment(node)
         lhs_node, rhs_node = *node
@@ -273,6 +275,7 @@ module RuboCop
       def process_zero_arity_super(node)
         variable_table.accessible_variables.each do |variable|
           next unless variable.method_argument?
+
           variable.reference!(node)
         end
       end
@@ -280,11 +283,7 @@ module RuboCop
       def process_scope(node)
         if TWISTED_SCOPE_TYPES.include?(node.type)
           # See the comment at the end of file for this behavior.
-          twisted_nodes = [node.children[0]]
-          twisted_nodes << node.children[1] if node.class_type?
-          twisted_nodes.compact!
-
-          twisted_nodes.each do |twisted_node|
+          twisted_nodes(node).each do |twisted_node|
             process_node(twisted_node)
             scanned_nodes << twisted_node
           end
@@ -294,6 +293,12 @@ module RuboCop
         skip_children!
       end
 
+      def twisted_nodes(node)
+        twisted_nodes = [node.children[0]]
+        twisted_nodes << node.children[1] if node.class_type?
+        twisted_nodes.compact
+      end
+
       def process_send(node)
         _receiver, method_name, args = *node
         return unless method_name == :binding
@@ -316,11 +321,13 @@ module RuboCop
           # Non related references which are caught in the above scan
           # would be skipped here.
           next unless variable
+
           variable.assignments.each do |assignment|
             next if assignment_nodes_in_loop.none? do |assignment_node|
                       assignment_node.equal?(assignment.node)
                     end
-            assignment.reference!
+
+            assignment.reference!(node)
           end
         end
       end
@@ -358,9 +365,7 @@ module RuboCop
           AssignmentReference.new(node)
         when *OPERATOR_ASSIGNMENT_TYPES
           asgn_node = node.children.first
-          if asgn_node.lvasgn_type?
-            VariableReference.new(asgn_node.children.first)
-          end
+          VariableReference.new(asgn_node.children.first) if asgn_node.lvasgn_type?
         end
       end
 
@@ -432,7 +437,7 @@ module RuboCop
       #     (send nil :puts
       #       (lvar :foo)))
       #
-      # So the the method argument nodes need to be processed
+      # So the method argument nodes need to be processed
       # in current scope.
       #
       # Same thing.

data/lib/rubocop/core_ext/string.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Extensions to the core String class
+class String
+  unless method_defined? :blank?
+    # Checks whether a string is blank. A string is considered blank if it
+    # is either empty or contains only whitespace characters.
+    #
+    # @return [Boolean] true is the string is blank, false otherwise
+    #
+    # @example
+    #   ''.blank? #=> true
+    #
+    # @example
+    #   '    '.blank? #=> true
+    #
+    # @example
+    #   '  test'.blank? #=> false
+    def blank?
+      empty? || strip.empty?
+    end
+  end
+end

data/lib/rubocop/error.rb

@@ -8,4 +8,27 @@ module RuboCop
   class Error < StandardError; end
 
   class ValidationError < Error; end
+
+  # A wrapper to display errored location of analyzed file.
+  class ErrorWithAnalyzedFileLocation < Error
+    def initialize(cause:, node:, cop:)
+      @cause = cause
+      @cop = cop
+      @location = node.is_a?(RuboCop::AST::Node) ? node.loc : node
+    end
+
+    attr_reader :cause, :cop
+
+    def line
+      @location&.line
+    end
+
+    def column
+      @location&.column
+    end
+
+    def message
+      "cause: #{cause.inspect}"
+    end
+  end
 end

data/lib/rubocop/ext/processed_source.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to AST::ProcessedSource for our cached comment_config
+    module ProcessedSource
+      def comment_config
+        @comment_config ||= CommentConfig.new(self)
+      end
+
+      def disabled_line_ranges
+        comment_config.cop_disabled_line_ranges
+      end
+    end
+  end
+end
+
+RuboCop::ProcessedSource.include RuboCop::Ext::ProcessedSource

data/lib/rubocop/file_finder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RuboCop
+  # Common methods for finding files.
+  module FileFinder
+    def self.root_level=(level)
+      @root_level = level
+    end
+
+    def self.root_level?(path)
+      @root_level == path.to_s
+    end
+
+    def find_file_upwards(filename, start_dir)
+      traverse_files_upwards(filename, start_dir) do |file|
+        # minimize iteration for performance
+        return file if file
+      end
+    end
+
+    def find_files_upwards(filename, start_dir)
+      files = []
+      traverse_files_upwards(filename, start_dir) do |file|
+        files << file
+      end
+      files
+    end
+
+    private
+
+    def traverse_files_upwards(filename, start_dir)
+      Pathname.new(start_dir).expand_path.ascend do |dir|
+        break if FileFinder.root_level?(dir)
+
+        file = dir + filename
+        yield(file.to_s) if file.exist?
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/auto_gen_config_formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # Does not show individual offenses in the console.
+    class AutoGenConfigFormatter < ProgressFormatter
+      def finished(inspected_files)
+        output.puts
+
+        report_summary(inspected_files.size,
+                       @total_offense_count,
+                       @total_correction_count)
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/base_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/LineLength
-
 module RuboCop
   module Formatter
     # Abstract base class for formatter, implements all public API methods.
@@ -9,7 +7,7 @@ module RuboCop
     # ## Creating Custom Formatter
     #
     # You can create a custom formatter by subclassing
-    # `RuboCop::Formatter::BaseFormatter` and overriding some methods,
+    # `RuboCop::Formatter::BaseFormatter` and overriding some methods
     # or by implementing all the methods by duck typing.
     #
     # ## Using Custom Formatter in Command Line
@@ -25,7 +23,7 @@ module RuboCop
     # `Kernel.require`.
     # If your custom formatter file is not in `$LOAD_PATH`,
     # you need to specify the path as relative path prefixed with `./`
-    # explicitly, or absolute path.
+    # explicitly or absolute path.
     #
     # ## Method Invocation Order
     #
@@ -41,8 +39,6 @@ module RuboCop
     # * `#finished`
     #
     class BaseFormatter
-      # rubocop:enable Metrics/LineLength
-
       # @api public
       #
       # @!attribute [r] output
@@ -109,7 +105,7 @@ module RuboCop
 
       # @api public
       #
-      # Invoked after all files are inspected, or interrupted by user.
+      # Invoked after all files are inspected or interrupted by user.
       #
       # @param inspected_files [Array(String)]
       #   the inspected file paths.

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -6,7 +6,7 @@ module RuboCop
     # The precise location of the problem is shown together with the
     # relevant source code.
     class ClangStyleFormatter < SimpleTextFormatter
-      ELLIPSES = '...'.freeze
+      ELLIPSES = '...'
 
       def report_file(file, offenses)
         offenses.each { |offense| report_offense(file, offense) }
@@ -15,11 +15,15 @@ module RuboCop
       private
 
       def report_offense(file, offense)
-        output.printf("%s:%d:%d: %s: %s\n",
-                      cyan(smart_path(file)), offense.line, offense.real_column,
-                      colored_severity_code(offense), message(offense))
+        output.printf(
+          "%<path>s:%<line>d:%<column>d: %<severity>s: %<message>s\n",
+          path: cyan(smart_path(file)),
+          line: offense.line,
+          column: offense.real_column,
+          severity: colored_severity_code(offense),
+          message: message(offense)
+        )
 
-        # rubocop:disable Lint/HandleExceptions
         begin
           return unless valid_line?(offense)
 
@@ -28,7 +32,6 @@ module RuboCop
         rescue IndexError
           # range is not on a valid line; perhaps the source file is empty
         end
-        # rubocop:enable Lint/HandleExceptions
       end
 
       def valid_line?(offense)