rubocop 0.51.0 → 0.52.0

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

@@ -30,7 +30,7 @@ module RuboCop
           return if node.keywords?
 
           left_brace = node.loc.begin
-          space_plus_brace = range_with_surrounding_space(left_brace)
+          space_plus_brace = range_with_surrounding_space(range: left_brace)
           used_style =
             space_plus_brace.source.start_with?('{') ? :no_space : :space
 
@@ -41,6 +41,15 @@ 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)
@@ -89,15 +98,6 @@ 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
-
         def empty_braces?(loc)
           loc.begin.end_pos == loc.end.begin_pos
         end

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

@@ -4,11 +4,22 @@ module RuboCop
   module Cop
     module Layout
       # Checks for comma (,) preceded by space.
+      #
+      # @example
+      #   # bad
+      #   [1 , 2 , 3]
+      #   a(1 , 2)
+      #   each { |a , b| }
+      #
+      #   # good
+      #   [1, 2, 3]
+      #   a(1, 2)
+      #   each { |a, b| }
       class SpaceBeforeComma < Cop
         include SpaceBeforePunctuation
 
         def kind(token)
-          'comma' if token.type == :tCOMMA
+          'comma' if token.comma?
         end
       end
     end

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

@@ -17,14 +17,12 @@ module RuboCop
 
         def investigate(processed_source)
           processed_source.tokens.each_cons(2) do |t1, t2|
-            next unless t2.type == :tCOMMENT
-            next unless t1.pos.line == t2.pos.line
+            next unless t2.comment?
+            next unless t1.line == t2.line
             add_offense(t2.pos, location: t2.pos) if t1.pos.end == t2.pos.begin
           end
         end
 
-        private
-
         def autocorrect(range)
           ->(corrector) { corrector.insert_before(range, ' ') }
         end

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

@@ -11,12 +11,12 @@ module RuboCop
       # config parameter is true.
       #
       # @example
-      #   @bad
+      #   # bad
       #   something  x
       #   something   y, z
       #   something'hello'
       #
-      #   @good
+      #   # good
       #   something x
       #   something y, z
       #   something 'hello'
@@ -32,7 +32,8 @@ module RuboCop
           return unless expect_params_after_method_name?(node)
 
           first_arg = node.first_argument.source_range
-          first_arg_with_space = range_with_surrounding_space(first_arg, :left)
+          first_arg_with_space = range_with_surrounding_space(range: first_arg,
+                                                              side: :left)
           space = range_between(first_arg_with_space.begin_pos,
                                 first_arg.begin_pos)
 

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

@@ -15,7 +15,7 @@ module RuboCop
         include SpaceBeforePunctuation
 
         def kind(token)
-          'semicolon' if token.type == :tSEMI
+          'semicolon' if token.semicolon?
         end
       end
     end

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

@@ -6,24 +6,18 @@ module RuboCop
       # This cop checks for spaces between -> and opening parameter
       # brace in lambda literals.
       #
-      # @example
-      #
-      #   EnforcedStyle: require_no_space (default)
-      #
-      #     @bad
+      # @example EnforcedStyle: require_no_space (default)
+      #     # bad
       #     a = -> (x, y) { x + y }
       #
-      #     @good
+      #     # good
       #     a = ->(x, y) { x + y }
       #
-      # @example
-      #
-      #   EnforcedStyle: require_space
-      #
-      #     @bad
+      # @example EnforcedStyle: require_space
+      #     # bad
       #     a = ->(x, y) { x + y }
       #
-      #     @good
+      #     # good
       #     a = -> (x, y) { x + y }
       class SpaceInLambdaLiteral < Cop
         include ConfigurableEnforcedStyle

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

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks that brackets used for array literals have or don't have
+      # surrounding space depending on configuration.
+      #
+      # @example EnforcedStyle: space
+      #   # The `space` style enforces that array literals have
+      #   # surrounding space.
+      #
+      #   # bad
+      #   array = [a, b, c, d]
+      #
+      #   # good
+      #   array = [ a, b, c, d ]
+      #
+      # @example EnforcedStyle: no_space
+      #   # The `no_space` style enforces that array literals have
+      #   # no surrounding space.
+      #
+      #   # bad
+      #   array = [ a, b, c, d ]
+      #
+      #   # good
+      #   array = [a, b, c, d]
+      #
+      # @example EnforcedStyle: compact
+      #   # The `compact` style normally requires a space inside
+      #   # array brackets, with the exception that successive left
+      #   # or right brackets are collapsed together in nested arrays.
+      #
+      #   # bad
+      #   array = [ a, [ b, c ] ]
+      #
+      #   # good
+      #   array = [ a, [ b, c ]]
+      class SpaceInsideArrayLiteralBrackets < Cop
+        include SurroundingSpace
+        include ConfigurableEnforcedStyle
+
+        MSG = '%<command>s space inside array brackets.'.freeze
+        EMPTY_MSG = '%<command>s space inside empty array brackets.'.freeze
+
+        def on_array(node)
+          return unless node.square_brackets?
+          left, right = array_brackets(node)
+          if empty_brackets?(left, right)
+            return empty_offenses(node, left, right)
+          end
+
+          start_ok = next_to_newline?(node, left)
+          end_ok = node.single_line? ? false : end_has_own_line?(right)
+
+          issue_offenses(node, left, right, start_ok, end_ok)
+        end
+
+        def autocorrect(node)
+          left, right = array_brackets(node)
+
+          lambda do |corrector|
+            if empty_brackets?(left, right)
+              empty_corrections(corrector, left, right)
+            elsif style == :no_space
+              no_space_corrector(corrector, left, right)
+            elsif style == :space
+              space_corrector(corrector, left, right)
+            else
+              compact_corrections(corrector, node, left, right)
+            end
+          end
+        end
+
+        private
+
+        def array_brackets(node)
+          [left_array_bracket(node), right_array_bracket(node)]
+        end
+
+        def left_array_bracket(node)
+          tokens(node).find(&:left_array_bracket?)
+        end
+
+        def right_array_bracket(node)
+          tokens(node).reverse.find(&:right_bracket?)
+        end
+
+        def empty_brackets?(left, right)
+          processed_source.tokens.index(left) ==
+            processed_source.tokens.index(right) - 1
+        end
+
+        def empty_offenses(node, left, right)
+          empty_offense(node, 'Use one') if offending_empty_space?(left, right)
+          return unless offending_empty_no_space?(left, right)
+          empty_offense(node, 'Do not use')
+        end
+
+        def empty_offense(node, command)
+          add_offense(node, message: format(EMPTY_MSG, command: command))
+        end
+
+        def offending_empty_space?(left, right)
+          empty_config == 'space' && !space_between?(left, right)
+        end
+
+        def offending_empty_no_space?(left, right)
+          empty_config == 'no_space' && !no_space_between?(left, right)
+        end
+
+        def space_between?(left, right)
+          left.end_pos + 1 == right.begin_pos
+        end
+
+        def no_space_between?(left, right)
+          left.end_pos == right.begin_pos
+        end
+
+        def empty_config
+          cop_config['EnforcedStyleForEmptyBrackets']
+        end
+
+        def empty_corrections(corrector, left, right)
+          if offending_empty_space?(left, right)
+            range = side_space_range(range: left.pos, side: :right)
+            corrector.remove(range)
+            corrector.insert_after(left.pos, ' ')
+          elsif offending_empty_no_space?(left, right)
+            range = side_space_range(range: left.pos, side: :right)
+            corrector.remove(range)
+          end
+        end
+
+        def next_to_newline?(node, token)
+          tokens(node)[index_for(node, token) + 1].line != token.line
+        end
+
+        def end_has_own_line?(token)
+          line, col = line_and_column_for(token)
+          return true if col == -1
+          processed_source.lines[line][0..col].delete(' ').empty?
+        end
+
+        def index_for(node, token)
+          tokens(node).index(token)
+        end
+
+        def line_and_column_for(token)
+          [token.line - 1, token.column - 1]
+        end
+
+        def issue_offenses(node, left, right, start_ok, end_ok)
+          if style == :no_space
+            start_ok = next_to_comment?(node, left)
+            no_space_offenses(node, left, right, MSG, start_ok: start_ok,
+                                                      end_ok: end_ok)
+          elsif style == :space
+            space_offenses(node, left, right, MSG, start_ok: start_ok,
+                                                   end_ok: end_ok)
+          else
+            compact_offenses(node, left, right, start_ok, end_ok)
+          end
+        end
+
+        def next_to_comment?(node, token)
+          tokens(node)[index_for(node, token) + 1].comment?
+        end
+
+        def compact_offenses(node, left, right, start_ok, end_ok)
+          if qualifies_for_compact?(node, left, side: :left)
+            compact_offense(node, left, side: :left)
+          elsif !multi_dimensional_array?(node, left, side: :left)
+            space_offenses(node, left, nil, MSG, start_ok: start_ok,
+                                                 end_ok: true)
+          end
+          if qualifies_for_compact?(node, right)
+            compact_offense(node, right)
+          elsif !multi_dimensional_array?(node, right)
+            space_offenses(node, nil, right, MSG, start_ok: true,
+                                                  end_ok: end_ok)
+          end
+        end
+
+        def qualifies_for_compact?(node, token, side: :right)
+          if side == :right
+            multi_dimensional_array?(node, token) &&
+              !next_to_bracket?(token)
+          else
+            multi_dimensional_array?(node, token, side: :left) &&
+              !next_to_bracket?(token, side: :left)
+          end
+        end
+
+        def multi_dimensional_array?(node, token, side: :right)
+          i = index_for(node, token)
+          if side == :right
+            tokens(node)[i - 1].right_bracket?
+          else
+            tokens(node)[i + 1].left_array_bracket?
+          end
+        end
+
+        def next_to_bracket?(token, side: :right)
+          line_index, col = line_and_column_for(token)
+          line = processed_source.lines[line_index]
+          side == :right ? line[col] == ']' : line[col + 2] == '['
+        end
+
+        def compact_offense(node, token, side: :right)
+          if side == :right
+            space_offense(node, token, :left, MSG, NO_SPACE_COMMAND)
+          else
+            space_offense(node, token, :right, MSG, NO_SPACE_COMMAND)
+          end
+        end
+
+        def compact_corrections(corrector, node, left, right)
+          if qualifies_for_compact?(node, left, side: :left)
+            range = side_space_range(range: left.pos, side: :right)
+            corrector.remove(range)
+          elsif !left.space_after?
+            corrector.insert_after(left.pos, ' ')
+          end
+          if qualifies_for_compact?(node, right)
+            range = side_space_range(range: right.pos, side: :left)
+            corrector.remove(range)
+          elsif !right.space_before?
+            corrector.insert_before(right.pos, ' ')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,11 @@ module RuboCop
       # (i.e. %i/%w).
       #
       # @example
-      #   @good
-      #   %i(foo bar baz)
       #
-      #   @bad
+      #   # bad
       #   %w(foo  bar  baz)
+      #   # good
+      #   %i(foo bar baz)
       class SpaceInsideArrayPercentLiteral < Cop
         include MatchRange
         include PercentLiteral

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

@@ -7,6 +7,75 @@ module RuboCop
       # them on configuration. For blocks taking parameters, it checks that the
       # left brace has or doesn't have trailing space depending on
       # configuration.
+      #
+      # @example EnforcedStyle: space (default)
+      #   # The `space` style enforces that block braces have
+      #   # surrounding space.
+      #
+      #   # bad
+      #   some_array.each {puts e}
+      #
+      #   # good
+      #   some_array.each { puts e }
+      #
+      # @example EnforcedStyle: no_space
+      #   # The `no_space` style enforces that block braces don't
+      #   # have surrounding space.
+      #
+      #   # bad
+      #   some_array.each { puts e }
+      #
+      #   # good
+      #   some_array.each {puts e}
+      #
+      #
+      # @example EnforcedStyleForEmptyBraces: no_space (default)
+      #   # The `no_space` EnforcedStyleForEmptyBraces style enforces that
+      #   # block braces don't have a space in between when empty.
+      #
+      #   # bad
+      #   some_array.each {   }
+      #   some_array.each {  }
+      #   some_array.each { }
+      #
+      #   # good
+      #   some_array.each {}
+      #
+      # @example EnforcedStyleForEmptyBraces: space
+      #   # The `space` EnforcedStyleForEmptyBraces style enforces that
+      #   # block braces have at least a spece in between when empty.
+      #
+      #   # bad
+      #   some_array.each {}
+      #
+      #   # good
+      #   some_array.each { }
+      #   some_array.each {  }
+      #   some_array.each {   }
+      #
+      #
+      # @example SpaceBeforeBlockParameters: true (default)
+      #   # The SpaceBeforeBlockParameters style set to `true` enforces that
+      #   # there is a space between `{` and `|`. Overrides `EnforcedStyle`
+      #   # if there is a conflict.
+      #
+      #   # bad
+      #   [1, 2, 3].each {|n| n * 2 }
+      #
+      #   # good
+      #   [1, 2, 3].each { |n| n * 2 }
+      #
+      # @example SpaceBeforeBlockParameters: true
+      #   # The SpaceBeforeBlockParameters style set to `false` enforces that
+      #   # there is no space between `{` and `|`. Overrides `EnforcedStyle`
+      #   # if there is a conflict.
+      #
+      #   # bad
+      #   [1, 2, 3].each { |n| n * 2 }
+      #
+      #   # good
+      #   [1, 2, 3].each {|n| n * 2 }
+      #
       class SpaceInsideBlockBraces < Cop
         include ConfigurableEnforcedStyle
         include SurroundingSpace
@@ -20,6 +89,17 @@ module RuboCop
           check_inside(node, left_brace, right_brace)
         end
 
+        def autocorrect(range)
+          lambda do |corrector|
+            case range.source
+            when /\s/ then corrector.remove(range)
+            when '{}' then corrector.replace(range, '{ }')
+            when '{|' then corrector.replace(range, '{ |')
+            else           corrector.insert_before(range, ' ')
+            end
+          end
+        end
+
         private
 
         def check_inside(node, left_brace, right_brace)
@@ -49,7 +129,7 @@ module RuboCop
           args_delimiter = node.arguments.loc.begin # Can be ( | or nil.
 
           check_left_brace(inner, node.loc.begin, args_delimiter)
-          check_right_brace(inner, node.loc.end, block_length(node))
+          check_right_brace(inner, node.loc.end, node.single_line?)
         end
 
         def check_left_brace(inner, left_brace, args_delimiter)
@@ -60,8 +140,8 @@ module RuboCop
           end
         end
 
-        def check_right_brace(inner, right_brace, block_length)
-          if inner =~ /\S$/ && block_length.zero?
+        def check_right_brace(inner, right_brace, single_line)
+          if single_line && inner =~ /\S$/
             no_space(right_brace.begin_pos, right_brace.end_pos,
                      'Space missing inside }.')
           else
@@ -96,7 +176,8 @@ module RuboCop
               end
             end
           else
-            brace_with_space = range_with_surrounding_space(left_brace, :right)
+            brace_with_space = range_with_surrounding_space(range: left_brace,
+                                                            side: :right)
             space(brace_with_space.begin_pos + 1, brace_with_space.end_pos,
                   'Space inside { detected.')
           end
@@ -107,7 +188,8 @@ module RuboCop
         end
 
         def space_inside_right_brace(right_brace)
-          brace_with_space = range_with_surrounding_space(right_brace, :left)
+          brace_with_space = range_with_surrounding_space(range: right_brace,
+                                                          side: :left)
           space(brace_with_space.begin_pos, brace_with_space.end_pos - 1,
                 'Space inside } detected.')
         end
@@ -140,17 +222,6 @@ module RuboCop
           else raise 'Unknown EnforcedStyleForEmptyBraces selected!'
           end
         end
-
-        def autocorrect(range)
-          lambda do |corrector|
-            case range.source
-            when /\s/ then corrector.remove(range)
-            when '{}' then corrector.replace(range, '{ }')
-            when '{|' then corrector.replace(range, '{ |')
-            else           corrector.insert_before(range, ' ')
-            end
-          end
-        end
       end
     end
   end