rubocop 0.51.0 → 0.87.0

data/lib/rubocop/cop/mixin/surrounding_space.rb

@@ -2,13 +2,32 @@
 
 module RuboCop
   module Cop
-    # Common functionality for checking surrounding space.
+    # Common functionality for checking and correcting surrounding whitespace.
     module SurroundingSpace
-      def space_between?(t1, _t2)
-        # Check if the range between the tokens starts with a space. It can
-        # contain other characters, e.g. a unary plus, but it must start with
-        # space.
-        t1.pos.source_buffer.source.match(/\G\s/, t1.pos.end_pos)
+      include RangeHelp
+
+      NO_SPACE_COMMAND = 'Do not use'
+      SPACE_COMMAND = 'Use'
+
+      SINGLE_SPACE_REGEXP = /[ \t]/.freeze
+
+      private
+
+      def side_space_range(range:, side:)
+        buffer = processed_source.buffer
+        src = buffer.source
+
+        begin_pos = range.begin_pos
+        end_pos = range.end_pos
+        if side == :left
+          end_pos = begin_pos
+          begin_pos = reposition(src, begin_pos, -1)
+        end
+        if side == :right
+          begin_pos = end_pos
+          end_pos = reposition(src, end_pos, 1)
+        end
+        Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
       def index_of_first_token(node)
@@ -28,13 +47,105 @@ module RuboCop
       def token_table
         @token_table ||= begin
           table = {}
-          @processed_source.tokens.each_with_index do |t, ix|
-            table[t.pos.line] ||= {}
-            table[t.pos.line][t.pos.column] = ix
+          processed_source.tokens.each_with_index do |t, ix|
+            table[t.line] ||= {}
+            table[t.line][t.column] = ix
           end
           table
         end
       end
+
+      def on_new_investigation
+        @token_table = nil
+        super
+      end
+
+      def no_space_offenses(node, # rubocop:disable Metrics/ParameterLists
+                            left_token,
+                            right_token,
+                            message,
+                            start_ok: false,
+                            end_ok: false)
+        if extra_space?(left_token, :left) && !start_ok
+          space_offense(node, left_token, :right, message, NO_SPACE_COMMAND)
+        end
+        return if !extra_space?(right_token, :right) || end_ok
+
+        space_offense(node, right_token, :left, message, NO_SPACE_COMMAND)
+      end
+
+      def space_offenses(node, # rubocop:disable Metrics/ParameterLists
+                         left_token,
+                         right_token,
+                         message,
+                         start_ok: false,
+                         end_ok: false)
+        unless extra_space?(left_token, :left) || start_ok
+          space_offense(node, left_token, :none, message, SPACE_COMMAND)
+        end
+        return if extra_space?(right_token, :right) || end_ok
+
+        space_offense(node, right_token, :none, message, SPACE_COMMAND)
+      end
+
+      def extra_space?(token, side)
+        return false unless token
+
+        if side == :left
+          SINGLE_SPACE_REGEXP.match?(String(token.space_after?))
+        else
+          SINGLE_SPACE_REGEXP.match?(String(token.space_before?))
+        end
+      end
+
+      def reposition(src, pos, step)
+        offset = step == -1 ? -1 : 0
+        pos += step while SINGLE_SPACE_REGEXP.match?(src[pos + offset])
+        pos.negative? ? 0 : pos
+      end
+
+      def space_offense(node, token, side, message, command)
+        range = side_space_range(range: token.pos, side: side)
+        add_offense(node, location: range,
+                          message: format(message, command: command))
+      end
+
+      def empty_offenses(node, left, right, message)
+        range = range_between(left.begin_pos, right.end_pos)
+        if offending_empty_space?(empty_config, left, right)
+          empty_offense(node, range, message, 'Use one')
+        end
+        return unless offending_empty_no_space?(empty_config, left, right)
+
+        empty_offense(node, range, message, 'Do not use')
+      end
+
+      def empty_offense(node, range, message, command)
+        add_offense(node, location: range,
+                          message: format(message, command: command))
+      end
+
+      def empty_brackets?(left_bracket_token, right_bracket_token)
+        left_index = processed_source.tokens.index(left_bracket_token)
+        right_index = processed_source.tokens.index(right_bracket_token)
+        right_index && left_index == right_index - 1
+      end
+
+      def offending_empty_space?(config, left_token, right_token)
+        config == 'space' && !space_between?(left_token, right_token)
+      end
+
+      def offending_empty_no_space?(config, left_token, right_token)
+        config == 'no_space' && !no_space_between?(left_token, right_token)
+      end
+
+      def space_between?(left_bracket_token, right_bracket_token)
+        left_bracket_token.end_pos + 1 == right_bracket_token.begin_pos
+      end
+
+      def no_space_between?(left_bracket_token, right_bracket_token)
+        left_bracket_token.end_pos == right_bracket_token.begin_pos
+      end
     end
   end
 end

data/lib/rubocop/cop/mixin/target_ruby_version.rb

@@ -4,12 +4,16 @@ module RuboCop
   module Cop
     # Common functionality for checking target ruby version.
     module TargetRubyVersion
+      def required_minimum_ruby_version
+        @minimum_target_ruby_version
+      end
+
       def minimum_target_ruby_version(version)
         @minimum_target_ruby_version = version
       end
 
       def support_target_ruby_version?(version)
-        @minimum_target_ruby_version <= version
+        required_minimum_ruby_version <= version
       end
     end
   end

data/lib/rubocop/cop/mixin/too_many_lines.rb

@@ -7,32 +7,18 @@ module RuboCop
       include ConfigurableMax
       include CodeLength
 
-      MSG = '%s has too many lines. [%d/%d]'.freeze
+      MSG = '%<label>s has too many lines. [%<length>d/%<max>d]'
 
       private
 
       def message(length, max_length)
-        format(MSG, cop_label, length, max_length)
+        format(MSG, label: cop_label, length: length, max: max_length)
       end
 
       def code_length(node)
-        body = extract_body(node)
-        lines = body && body.source.lines || []
-
-        lines.count { |line| !irrelevant_line(line) }
-      end
-
-      def extract_body(node)
-        case node.type
-        when :block, :def
-          _receiver_or_method, _args, body = *node
-        when :defs
-          _self, _method, _args, body = *node
-        else
-          body = node
-        end
-
-        body
+        Metrics::Utils::CodeLengthCalculator.new(node,
+                                                 count_comments: count_comments?,
+                                                 foldable_types: count_as_one).calculate
       end
     end
   end

data/lib/rubocop/cop/mixin/trailing_body.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common methods shared by TrailingBody cops
+    module TrailingBody
+      def trailing_body?(node)
+        body = node.to_a.reverse[0]
+        body && node.multiline? &&
+          body_on_first_line?(node, body)
+      end
+
+      def body_on_first_line?(node, body)
+        node.source_range.first_line == body.source_range.first_line
+      end
+
+      def first_part_of(body)
+        if body.begin_type?
+          body.children.first.source_range
+        else
+          body.source_range
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/trailing_comma.rb

@@ -6,8 +6,11 @@ module RuboCop
     # Style/TrailingCommaInLiteral
     module TrailingComma
       include ConfigurableEnforcedStyle
+      include RangeHelp
 
-      MSG = '%s comma after the last %s'.freeze
+      MSG = '%<command>s comma after the last %<unit>s.'
+
+      private
 
       def style_parameter_name
         'EnforcedStyleForMultiline'
@@ -15,24 +18,39 @@ module RuboCop
 
       def check(node, items, kind, begin_pos, end_pos)
         after_last_item = range_between(begin_pos, end_pos)
-
-        return if heredoc?(after_last_item.source)
-
-        comma_offset = after_last_item.source =~ /,/
+        comma_offset = comma_offset(items, after_last_item)
 
         if comma_offset && !inside_comment?(after_last_item, comma_offset)
           check_comma(node, kind, after_last_item.begin_pos + comma_offset)
         elsif should_have_comma?(style, node)
-          put_comma(node, items, kind)
+          put_comma(items, kind)
         end
       end
 
+      def comma_offset(items, range)
+        # If there is any heredoc in items, then match the comma succeeding
+        # any whitespace (except newlines), otherwise allow for newlines
+        comma_regex = any_heredoc?(items) ? /\A[^\S\n]*,/ : /\A\s*,/
+        comma_regex.match?(range.source) && range.source.index(',')
+      end
+
       def check_comma(node, kind, comma_pos)
         return if should_have_comma?(style, node)
 
         avoid_comma(kind, comma_pos, extra_avoid_comma_info)
       end
 
+      def check_literal(node, kind)
+        return if node.children.empty?
+        # A braceless hash is the last parameter of a method call and will be
+        # checked as such.
+        return unless brackets?(node)
+
+        check(node, node.children, kind,
+              node.children.last.source_range.end_pos,
+              node.loc.end.begin_pos)
+      end
+
       def extra_avoid_comma_info
         case style
         when :comma
@@ -49,7 +67,7 @@ module RuboCop
         when :comma
           multiline?(node) && no_elements_on_same_line?(node)
         when :consistent_comma
-          multiline?(node)
+          multiline?(node) && !method_name_and_arguments_on_same_line?(node)
         else
           false
         end
@@ -62,43 +80,45 @@ module RuboCop
         end
       end
 
-      def heredoc?(source_after_last_item)
-        source_after_last_item =~ /\w/
-      end
-
       # Returns true if the node has round/square/curly brackets.
       def brackets?(node)
         node.loc.end
       end
 
       # Returns true if the round/square/curly brackets of the given node are
-      # on different lines, and each item within is on its own line, and the
+      # on different lines, each item within is on its own line, and the
       # closing bracket is on its own line.
       def multiline?(node)
-        # No need to process anything if the whole node is not multiline
-        # Without the 2nd check, Foo.new({}) is considered multiline, which
-        # it should not be. Essentially, if there are no elements, the
-        # expression can not be multiline.
-        return false unless node.multiline?
+        node.multiline? && !allowed_multiline_argument?(node)
+      end
 
-        items = elements(node).map(&:source_range)
-        return false if items.empty?
-        items << node.loc.begin << node.loc.end
-        (items.map(&:first_line) + items.map(&:last_line)).uniq.size > 1
+      def method_name_and_arguments_on_same_line?(node)
+        return false unless node.call_type?
+
+        line = node.loc.selector.nil? ? node.loc.line : node.loc.selector.line
+
+        line == node.last_argument.last_line &&
+          node.last_line == node.last_argument.last_line
+      end
+
+      # A single argument with the closing bracket on the same line as the end
+      # of the argument is not considered multiline, even if the argument
+      # itself might span multiple lines.
+      def allowed_multiline_argument?(node)
+        elements(node).one? && !Util.begins_its_line?(node.loc.end)
       end
 
       def elements(node)
-        return node.children unless node.send_type?
+        return node.children unless %i[csend send].include?(node.type)
 
-        _receiver, _method_name, *args = *node
-        args.flat_map do |a|
+        node.arguments.flat_map do |argument|
           # For each argument, if it is a multi-line hash without braces,
           # then promote the hash elements to method arguments
           # for the purpose of determining multi-line-ness.
-          if a.hash_type? && a.multiline? && !a.braces?
-            a.children
+          if argument.hash_type? && argument.multiline? && !argument.braces?
+            argument.children
           else
-            a
+            argument
           end
         end
       end
@@ -109,26 +129,32 @@ module RuboCop
         items.each_cons(2).none? { |a, b| on_same_line?(a, b) }
       end
 
-      def on_same_line?(a, b)
-        a.last_line == b.line
+      def on_same_line?(range1, range2)
+        range1.last_line == range2.line
       end
 
       def avoid_comma(kind, comma_begin_pos, extra_info)
         range = range_between(comma_begin_pos, comma_begin_pos + 1)
-        article = kind =~ /array/ ? 'an' : 'a'
-        msg = format(MSG, 'Avoid', format(kind, article)) + "#{extra_info}."
+        article = /array/.match?(kind) ? 'an' : 'a'
+        msg = format(
+          MSG,
+          command: 'Avoid',
+          unit: format(kind, article: article) + extra_info.to_s
+        )
 
         add_offense(range, location: range, message: msg)
       end
 
-      def put_comma(node, items, kind)
-        return if avoid_autocorrect?(elements(node))
-
+      def put_comma(items, kind)
         last_item = items.last
         return if last_item.block_pass_type?
 
         range = autocorrect_range(last_item)
-        msg = format(MSG, 'Put a', format(kind, 'a multiline') + '.')
+        msg = format(
+          MSG,
+          command: 'Put a',
+          unit: format(kind, article: 'a multiline')
+        )
 
         add_offense(range, location: range, message: msg)
       end
@@ -141,20 +167,45 @@ module RuboCop
         range_between(expr.begin_pos + ix, expr.end_pos)
       end
 
-      # By default, there's no reason to avoid auto-correct.
-      def avoid_autocorrect?(_)
+      def any_heredoc?(items)
+        items.any? { |item| heredoc?(item) }
+      end
+
+      def heredoc?(node)
+        return false unless node.is_a?(RuboCop::AST::Node)
+        return true if node.loc.respond_to?(:heredoc_body)
+
+        return heredoc_send?(node) if node.send_type?
+
+        # handle hash values
+        #
+        #   some_method({
+        #     'auth' => <<-SOURCE
+        #       ...
+        #     SOURCE
+        #   })
+        return heredoc?(node.children.last) if node.pair_type? || node.hash_type?
+
         false
       end
 
-      def autocorrect(range)
-        return unless range
+      def heredoc_send?(node)
+        # handle heredocs with methods
+        #
+        #   some_method(<<-CODE.strip.chomp)
+        #     ...
+        #   CODE
+        return heredoc?(node.children.first) if node.children.size == 2
+        # handle nested methods
+        #
+        #   some_method(
+        #     another_method(<<-CODE.strip.chomp)
+        #       ...
+        #     CODE
+        #   )
+        return heredoc?(node.children.last) if node.children.size > 2
 
-        lambda do |corrector|
-          case range.source
-          when ',' then corrector.remove(range)
-          else          corrector.insert_after(range, ',')
-          end
-        end
+        false
       end
     end
   end

data/lib/rubocop/cop/mixin/uncommunicative_name.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common functionality shared by Uncommunicative cops
+    module UncommunicativeName
+      CASE_MSG = 'Only use lowercase characters for %<name_type>s.'
+      NUM_MSG = 'Do not end %<name_type>s with a number.'
+      LENGTH_MSG = '%<name_type>s must be at least %<min>s ' \
+                   'characters long.'
+      FORBIDDEN_MSG = 'Do not use %<name>s as a name for a ' \
+                      '%<name_type>s.'
+
+      def check(node, args)
+        args.each do |arg|
+          # Argument names might be "_" or prefixed with "_" to indicate they
+          # are unused. Trim away this prefix and only analyse the basename.
+          name_child = arg.children.first
+          next if name_child.nil?
+
+          full_name = name_child.to_s
+          next if full_name == '_'
+
+          name = full_name.gsub(/\A(_+)/, '')
+          next if allowed_names.include?(name)
+
+          range = arg_range(arg, name.size)
+          issue_offenses(node, range, name)
+        end
+      end
+
+      private
+
+      def issue_offenses(node, range, name)
+        forbidden_offense(node, range, name) if forbidden_names.include?(name)
+        case_offense(node, range) if uppercase?(name)
+        length_offense(node, range) unless long_enough?(name)
+        return if allow_nums
+
+        num_offense(node, range) if ends_with_num?(name)
+      end
+
+      def case_offense(node, range)
+        add_offense(node, location: range,
+                          message: format(CASE_MSG, name_type: name_type(node)))
+      end
+
+      def uppercase?(name)
+        /[[:upper:]]/.match?(name)
+      end
+
+      def name_type(node)
+        @name_type ||= begin
+          case node.type
+          when :block then 'block parameter'
+          when :def, :defs then 'method parameter'
+          end
+        end
+      end
+
+      def num_offense(node, range)
+        add_offense(node, location: range,
+                          message: format(NUM_MSG, name_type: name_type(node)))
+      end
+
+      def ends_with_num?(name)
+        /\d/.match?(name[-1])
+      end
+
+      def length_offense(node, range)
+        add_offense(node, location: range,
+                          message: format(LENGTH_MSG,
+                                          name_type: name_type(node).capitalize,
+                                          min: min_length))
+      end
+
+      def long_enough?(name)
+        name.size >= min_length
+      end
+
+      def arg_range(arg, length)
+        begin_pos = arg.source_range.begin_pos
+        Parser::Source::Range.new(processed_source.buffer,
+                                  begin_pos,
+                                  begin_pos + length)
+      end
+
+      def forbidden_offense(node, range, name)
+        add_offense(
+          node,
+          location: range,
+          message: format(FORBIDDEN_MSG, name: name, name_type: name_type(node))
+        )
+      end
+
+      def allowed_names
+        cop_config['AllowedNames']
+      end
+
+      def forbidden_names
+        cop_config['ForbiddenNames']
+      end
+
+      def allow_nums
+        cop_config['AllowNamesEndingInNumbers']
+      end
+
+      def min_length
+        cop_config['MinNameLength']
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/unused_argument.rb

@@ -7,8 +7,6 @@ module RuboCop
       module UnusedArgument
         extend NodePattern::Macros
 
-        def_node_search :uses_var?, '(lvar %)'
-
         def join_force?(force_class)
           force_class == VariableForce
         end
@@ -19,64 +17,16 @@ module RuboCop
           end
         end
 
+        private
+
         def check_argument(variable)
           return if variable.should_be_unused?
-          return if variable_used?(variable)
+          return if variable.referenced?
 
           message = message(variable)
           add_offense(variable.declaration_node, location: :name,
                                                  message: message)
         end
-
-        def autocorrect(node)
-          return if %i[kwarg kwoptarg].include?(node.type)
-
-          if node.blockarg_type?
-            lambda do |corrector|
-              range = range_with_surrounding_space(node.source_range, :left)
-              range = range_with_surrounding_comma(range, :left)
-              corrector.remove(range)
-            end
-          else
-            ->(corrector) { corrector.insert_before(node.loc.name, '_') }
-          end
-        end
-
-        private
-
-        def variable_used?(variable)
-          return false unless variable.referenced?
-
-          assignment_without_usage =
-            find_assignment_without_variable_usage(variable)
-
-          # If variable is either not assigned or assigned with usages,
-          # then it's really used
-          return true unless assignment_without_usage
-
-          assignment_without_usage_pos =
-            assignment_without_usage.node.source_range.begin_pos
-
-          reference_positions =
-            variable.references.map { |var| var.node.source_range.begin_pos }
-
-          # Was variable referenced before it was reassigned?
-          reference_positions.any? { |pos| pos <= assignment_without_usage_pos }
-        end
-
-        # Find the first variable assignment, which doesn't reference the
-        # variable at the rhs.
-        def find_assignment_without_variable_usage(variable)
-          variable.assignments.find do |assignment|
-            # It's impossible to decide whether a branch is executed, so
-            # this case is ignored
-            next if assignment.branch
-
-            assignment_node = assignment.meta_assignment_node || assignment.node
-
-            !uses_var?(assignment_node, assignment.variable.name)
-          end
-        end
       end
     end
   end