rubocop 0.78.0 → 1.13.0

data/lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb

@@ -27,54 +27,50 @@ module RuboCop
       #   def some_method(arg1=:default, arg2=nil, arg3=[])
       #     # do something...
       #   end
-      class SpaceAroundEqualsInParameterDefault < Cop
+      class SpaceAroundEqualsInParameterDefault < Base
         include SurroundingSpace
         include ConfigurableEnforcedStyle
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Surrounding space %<type>s in default value assignment.'
 
         def on_optarg(node)
-          index = index_of_first_token(node)
-          arg, equals, value = processed_source.tokens[index, 3]
+          tokens = processed_source.tokens_within(node)
+          arg, equals, value = tokens.take(3)
           check_optarg(arg, equals, value)
         end
 
-        def autocorrect(range)
-          m = range.source.match(/=\s*(\S+)/)
-          rest = m ? m.captures[0] : ''
-          replacement = style == :space ? ' = ' : '='
-          ->(corrector) { corrector.replace(range, replacement + rest) }
-        end
-
         private
 
         def check_optarg(arg, equals, value)
           space_on_both_sides = space_on_both_sides?(arg, equals)
           no_surrounding_space = no_surrounding_space?(arg, equals)
 
-          if style == :space && space_on_both_sides ||
-             style == :no_space && no_surrounding_space
+          if style == :space && space_on_both_sides || style == :no_space && no_surrounding_space
             correct_style_detected
           else
-            incorrect_style_detected(arg, value, space_on_both_sides,
-                                     no_surrounding_space)
+            incorrect_style_detected(arg, value)
           end
         end
 
-        def incorrect_style_detected(arg, value, space_on_both_sides,
-                                     no_surrounding_space)
+        def incorrect_style_detected(arg, value)
           range = range_between(arg.end_pos, value.begin_pos)
-          add_offense(range, location: range) do
-            if style == :space && no_surrounding_space ||
-               style == :no_space && space_on_both_sides
-              opposite_style_detected
-            else
-              unrecognized_style_detected
-            end
+
+          add_offense(range) do |corrector|
+            autocorrect(corrector, range)
+            opposite_style_detected
           end
         end
 
+        def autocorrect(corrector, range)
+          m = range.source.match(/=\s*(\S+)/)
+          rest = m ? m.captures[0] : ''
+          replacement = style == :space ? ' = ' : '='
+
+          corrector.replace(range, replacement + rest)
+        end
+
         def space_on_both_sides?(arg, equals)
           arg.space_after? && equals.space_after?
         end

data/lib/rubocop/cop/layout/space_around_keyword.rb

@@ -24,17 +24,17 @@ module RuboCop
       #   end
       #
       #   something = 123 if test
-      class SpaceAroundKeyword < Cop
+      class SpaceAroundKeyword < Base
+        extend AutoCorrector
+
         MSG_BEFORE = 'Space before keyword `%<range>s` is missing.'
         MSG_AFTER = 'Space after keyword `%<range>s` is missing.'
 
         DO = 'do'
         SAFE_NAVIGATION = '&.'
         NAMESPACE_OPERATOR = '::'
-        ACCEPT_LEFT_PAREN =
-          %w[break defined? next not rescue return super yield].freeze
-        ACCEPT_LEFT_SQUARE_BRACKET =
-          %w[super yield].freeze
+        ACCEPT_LEFT_PAREN = %w[break defined? next not rescue return super yield].freeze
+        ACCEPT_LEFT_SQUARE_BRACKET = %w[super yield].freeze
         ACCEPT_NAMESPACE_OPERATOR = 'super'
 
         def on_and(node)
@@ -129,14 +129,6 @@ module RuboCop
           check(node, [:keyword].freeze)
         end
 
-        def autocorrect(range)
-          if space_before_missing?(range)
-            ->(corrector) { corrector.insert_before(range, ' ') }
-          else
-            ->(corrector) { corrector.insert_after(range, ' ') }
-          end
-        end
-
         private
 
         def check(node, locations, begin_keyword = DO)
@@ -162,8 +154,11 @@ module RuboCop
 
         def check_end(node, range, begin_keyword)
           return if begin_keyword == DO && !do?(node)
+          return unless space_before_missing?(range)
 
-          offense(range, MSG_BEFORE) if space_before_missing?(range)
+          add_offense(range, message: format(MSG_BEFORE, range: range.source)) do |corrector|
+            corrector.insert_before(range, ' ')
+          end
         end
 
         def do?(node)
@@ -171,22 +166,24 @@ module RuboCop
         end
 
         def check_keyword(node, range)
-          offense(range, MSG_BEFORE) if space_before_missing?(range) &&
-                                        !preceded_by_operator?(node, range)
-          offense(range, MSG_AFTER) if space_after_missing?(range)
-        end
+          if space_before_missing?(range) && !preceded_by_operator?(node, range)
+            add_offense(range, message: format(MSG_BEFORE, range: range.source)) do |corrector|
+              corrector.insert_before(range, ' ')
+            end
+          end
 
-        def offense(range, msg)
-          add_offense(range,
-                      location: range,
-                      message: format(msg, range: range.source))
+          return unless space_after_missing?(range)
+
+          add_offense(range, message: format(MSG_AFTER, range: range.source)) do |corrector|
+            corrector.insert_after(range, ' ')
+          end
         end
 
         def space_before_missing?(range)
           pos = range.begin_pos - 1
           return false if pos.negative?
 
-          range.source_buffer.source[pos] !~ /[\s\(\|\{\[;,\*\=]/
+          !/[\s(|{\[;,*=]/.match?(range.source_buffer.source[pos])
         end
 
         def space_after_missing?(range)
@@ -195,10 +192,9 @@ module RuboCop
 
           return false if accepted_opening_delimiter?(range, char)
           return false if safe_navigation_call?(range, pos)
-          return false if accept_namespace_operator?(range) &&
-                          namespace_operator?(range, pos)
+          return false if accept_namespace_operator?(range) && namespace_operator?(range, pos)
 
-          char !~ /[\s;,#\\\)\}\]\.]/
+          !/[\s;,#\\)}\].]/.match?(char)
         end
 
         def accepted_opening_delimiter?(range, char)

data/lib/rubocop/cop/layout/space_around_method_call_operator.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks method call operators to not have spaces around them.
+      #
+      # @example
+      #   # bad
+      #   foo. bar
+      #   foo .bar
+      #   foo . bar
+      #   foo. bar .buzz
+      #   foo
+      #     . bar
+      #     . buzz
+      #   foo&. bar
+      #   foo &.bar
+      #   foo &. bar
+      #   foo &. bar&. buzz
+      #   RuboCop:: Cop
+      #   RuboCop:: Cop:: Cop
+      #   :: RuboCop::Cop
+      #
+      #   # good
+      #   foo.bar
+      #   foo.bar.buzz
+      #   foo
+      #     .bar
+      #     .buzz
+      #   foo&.bar
+      #   foo&.bar&.buzz
+      #   RuboCop::Cop
+      #   RuboCop::Cop::Cop
+      #   ::RuboCop::Cop
+      #
+      class SpaceAroundMethodCallOperator < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        SPACES_REGEXP = /\A[ \t]+\z/.freeze
+
+        MSG = 'Avoid using spaces around a method call operator.'
+
+        def on_send(node)
+          return unless node.dot? || node.safe_navigation?
+
+          check_space_before_dot(node)
+          check_space_after_dot(node)
+        end
+        alias on_csend on_send
+
+        def on_const(node)
+          return unless node.loc.respond_to?(:double_colon) && node.loc.double_colon
+
+          check_space_after_double_colon(node)
+        end
+
+        private
+
+        def check_space_before_dot(node)
+          receiver_pos = node.receiver.source_range.end_pos
+          dot_pos = node.loc.dot.begin_pos
+          check_space(receiver_pos, dot_pos)
+        end
+
+        def check_space_after_dot(node)
+          dot_pos = node.loc.dot.end_pos
+
+          selector_pos =
+            # `Proc#call` shorthand syntax
+            if node.method?(:call) && !node.loc.selector
+              node.loc.begin.begin_pos
+            else
+              node.loc.selector.begin_pos
+            end
+
+          check_space(dot_pos, selector_pos)
+        end
+
+        def check_space_after_double_colon(node)
+          double_colon_pos = node.loc.double_colon.end_pos
+          name_pos = node.loc.name.begin_pos
+          check_space(double_colon_pos, name_pos)
+        end
+
+        def check_space(begin_pos, end_pos)
+          return if end_pos <= begin_pos
+
+          range = range_between(begin_pos, end_pos)
+          return unless range.source.match?(SPACES_REGEXP)
+
+          add_offense(range) { |corrector| corrector.remove(range) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_around_operators.rb

@@ -5,6 +5,12 @@ module RuboCop
     module Layout
       # Checks that operators have space around them, except for ** which
       # should or shouldn't have surrounding space depending on configuration.
+      # It allows vertical alignment consisting of one or more whitespace
+      # around operators.
+      #
+      # This cop has `AllowForAlignment` option. When `true`, allows most
+      # uses of extra spacing if the intent is to align with an operator on
+      # the previous or next line, not counting empty lines or comment lines.
       #
       # @example
       #   # bad
@@ -17,6 +23,20 @@ module RuboCop
       #   "apple" + "juice"
       #   my_number = 38 / 4
       #
+      # @example AllowForAlignment: true (default)
+      #   # good
+      #   {
+      #     1 =>  2,
+      #     11 => 3
+      #   }
+      #
+      # @example AllowForAlignment: false
+      #   # bad
+      #   {
+      #     1 =>  2,
+      #     11 => 3
+      #   }
+      #
       # @example EnforcedStyleForExponentOperator: no_space (default)
       #   # bad
       #   a ** b
@@ -30,10 +50,11 @@ module RuboCop
       #
       #   # good
       #   a ** b
-      class SpaceAroundOperators < Cop
+      class SpaceAroundOperators < Base
         include PrecedingFollowingAlignment
         include RangeHelp
         include RationalLiteral
+        extend AutoCorrector
 
         IRREGULAR_METHODS = %i[[] ! []=].freeze
         EXCESSIVE_SPACE = '  '
@@ -71,9 +92,7 @@ module RuboCop
           if node.setter_method?
             on_special_asgn(node)
           elsif regular_operator?(node)
-            check_operator(:send,
-                           node.loc.selector,
-                           node.first_argument.source_range)
+            check_operator(:send, node.loc.selector, node.first_argument.source_range)
           end
         end
 
@@ -114,28 +133,14 @@ module RuboCop
         alias on_and_asgn on_assignment
         alias on_op_asgn  on_special_asgn
 
-        def autocorrect(range)
-          lambda do |corrector|
-            if range.source =~ /\*\*/ && !space_around_exponent_operator?
-              corrector.replace(range, '**')
-            elsif range.source.end_with?("\n")
-              corrector.replace(range, " #{range.source.strip}\n")
-            else
-              corrector.replace(range, " #{range.source.strip} ")
-            end
-          end
-        end
-
         private
 
         def regular_operator?(send_node)
-          !send_node.unary_operation? && !send_node.dot? &&
-            operator_with_regular_syntax?(send_node)
+          !send_node.unary_operation? && !send_node.dot? && operator_with_regular_syntax?(send_node)
         end
 
         def operator_with_regular_syntax?(send_node)
-          send_node.operator_method? &&
-            !IRREGULAR_METHODS.include?(send_node.method_name)
+          send_node.operator_method? && !IRREGULAR_METHODS.include?(send_node.method_name)
         end
 
         def check_operator(type, operator, right_operand)
@@ -143,7 +148,9 @@ module RuboCop
           return if with_space.source.start_with?("\n")
 
           offense(type, operator, with_space, right_operand) do |msg|
-            add_offense(with_space, location: operator, message: msg)
+            add_offense(operator, message: msg) do |corrector|
+              autocorrect(corrector, with_space)
+            end
           end
         end
 
@@ -152,12 +159,35 @@ module RuboCop
           yield msg if msg
         end
 
+        def autocorrect(corrector, range)
+          if /\*\*/.match?(range.source) && !space_around_exponent_operator?
+            corrector.replace(range, '**')
+          elsif range.source.end_with?("\n")
+            corrector.replace(range, " #{range.source.strip}\n")
+          else
+            enclose_operator_with_space(corrector, range)
+          end
+        end
+
+        def enclose_operator_with_space(corrector, range)
+          operator = range.source
+
+          # If `ForceEqualSignAlignment` is true, `Layout/ExtraSpacing` cop
+          # inserts spaces before operator. If `Layout/SpaceAroundOperators` cop
+          # inserts a space, it collides and raises the infinite loop error.
+          if force_equal_sign_alignment? && !operator.end_with?(' ')
+            corrector.insert_after(range, ' ')
+          else
+            corrector.replace(range, " #{operator.strip} ")
+          end
+        end
+
         def offense_message(type, operator, with_space, right_operand)
           if should_not_have_surrounding_space?(operator)
             return if with_space.is?(operator.source)
 
             "Space around operator `#{operator.source}` detected."
-          elsif with_space.source !~ /^\s.*\s$/
+          elsif !/^\s.*\s$/.match?(with_space.source)
             "Surrounding space missing for operator `#{operator.source}`."
           elsif excess_leading_space?(type, operator, with_space) ||
                 excess_trailing_space?(right_operand, with_space)
@@ -175,7 +205,8 @@ module RuboCop
           token            = Token.new(operator, nil, operator.source)
           align_preceding  = aligned_with_preceding_assignment(token)
 
-          return align_preceding == :no unless align_preceding == :none
+          return false if align_preceding == :yes ||
+                          aligned_with_subsequent_assignment(token) == :none
 
           aligned_with_subsequent_assignment(token) != :yes
         end
@@ -190,14 +221,17 @@ module RuboCop
         end
 
         def hash_table_style?
-          align_hash_cop_config &&
-            align_hash_cop_config['EnforcedHashRocketStyle'] == 'table'
+          align_hash_cop_config && align_hash_cop_config['EnforcedHashRocketStyle'] == 'table'
         end
 
         def space_around_exponent_operator?
           cop_config['EnforcedStyleForExponentOperator'] == 'space'
         end
 
+        def force_equal_sign_alignment?
+          config.for_cop('Layout/ExtraSpacing')['ForceEqualSignAlignment']
+        end
+
         def should_not_have_surrounding_space?(operator)
           operator.is?('**') ? !space_around_exponent_operator? : false
         end

data/lib/rubocop/cop/layout/space_before_block_braces.rb

@@ -27,9 +27,24 @@ module RuboCop
       #   foo.map{ |a|
       #     a.bar.to_s
       #   }
-      class SpaceBeforeBlockBraces < Cop
+      #
+      # @example EnforcedStyleForEmptyBraces: space (default)
+      #   # bad
+      #   7.times{}
+      #
+      #   # good
+      #   7.times {}
+      #
+      # @example EnforcedStyleForEmptyBraces: no_space
+      #   # bad
+      #   7.times {}
+      #
+      #   # good
+      #   7.times{}
+      class SpaceBeforeBlockBraces < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
+        extend AutoCorrector
 
         MISSING_MSG = 'Space missing to the left of {.'
         DETECTED_MSG = 'Space detected to the left of {.'
@@ -46,8 +61,8 @@ module RuboCop
           # by `EnforcedStyle: line_count_based` of `Style/BlockDelimiters` cop.
           # That means preventing auto-correction to incorrect auto-corrected
           # code.
-          # See: https://github.com/rubocop-hq/rubocop/issues/7534
-          return if conflict_with_block_delimiters?
+          # See: https://github.com/rubocop/rubocop/issues/7534
+          return if conflict_with_block_delimiters?(node)
 
           left_brace = node.loc.begin
           space_plus_brace = range_with_surrounding_space(range: left_brace)
@@ -61,29 +76,22 @@ module RuboCop
           end
         end
 
-        def autocorrect(range)
-          lambda do |corrector|
-            case range.source
-            when /\s/ then corrector.remove(range)
-            else           corrector.insert_before(range, ' ')
-            end
-          end
-        end
-
         private
 
         def check_empty(left_brace, space_plus_brace, used_style)
           return if style_for_empty_braces == used_style
 
-          config_to_allow_offenses['EnforcedStyleForEmptyBraces'] =
-            used_style.to_s
+          config_to_allow_offenses['EnforcedStyleForEmptyBraces'] = used_style.to_s
 
           if style_for_empty_braces == :space
-            add_offense(left_brace, location: left_brace, message: MISSING_MSG)
+            add_offense(left_brace, message: MISSING_MSG) do |corrector|
+              autocorrect(corrector, left_brace)
+            end
           else
-            space = range_between(space_plus_brace.begin_pos,
-                                  left_brace.begin_pos)
-            add_offense(space, location: space, message: DETECTED_MSG)
+            space = range_between(space_plus_brace.begin_pos, left_brace.begin_pos)
+            add_offense(space, message: DETECTED_MSG) do |corrector|
+              autocorrect(corrector, space)
+            end
           end
         end
 
@@ -96,19 +104,28 @@ module RuboCop
         end
 
         def space_missing(left_brace)
-          add_offense(left_brace, location: left_brace, message: MISSING_MSG) do
+          add_offense(left_brace, message: MISSING_MSG) do |corrector|
+            autocorrect(corrector, left_brace)
             opposite_style_detected
           end
         end
 
         def space_detected(left_brace, space_plus_brace)
-          space = range_between(space_plus_brace.begin_pos,
-                                left_brace.begin_pos)
-          add_offense(space, location: space, message: DETECTED_MSG) do
+          space = range_between(space_plus_brace.begin_pos, left_brace.begin_pos)
+
+          add_offense(space, message: DETECTED_MSG) do |corrector|
+            autocorrect(corrector, space)
             opposite_style_detected
           end
         end
 
+        def autocorrect(corrector, range)
+          case range.source
+          when /\s/ then corrector.remove(range)
+          else           corrector.insert_before(range, ' ')
+          end
+        end
+
         def style_for_empty_braces
           case cop_config['EnforcedStyleForEmptyBraces']
           when 'space'    then :space
@@ -118,9 +135,8 @@ module RuboCop
           end
         end
 
-        def conflict_with_block_delimiters?
-          block_delimiters_style == 'line_count_based' &&
-            style == :no_space && node.multiline?
+        def conflict_with_block_delimiters?(node)
+          block_delimiters_style == 'line_count_based' && style == :no_space && node.multiline?
         end
 
         def block_delimiters_style