rubocop 0.49.1 → 0.52.0

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

@@ -5,6 +5,19 @@ module RuboCop
     module Layout
       # Checks that operators have space around them, except for **
       # which should not have surrounding space.
+      #
+      # @example
+      #   # bad
+      #   total = 3*4
+      #   "apple"+"juice"
+      #   my_number = 38/4
+      #   a ** b
+      #
+      #   # good
+      #   total = 3 * 4
+      #   "apple" + "juice"
+      #   my_number = 38 / 4
+      #   a**b
       class SpaceAroundOperators < Cop
         include PrecedingFollowingAlignment
 
@@ -73,6 +86,18 @@ module RuboCop
         alias on_and_asgn on_binary
         alias on_op_asgn  on_special_asgn
 
+        def autocorrect(range)
+          lambda do |corrector|
+            if range.source =~ /\*\*/
+              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)
@@ -86,11 +111,11 @@ module RuboCop
         end
 
         def check_operator(op, right_operand)
-          with_space = range_with_surrounding_space(op)
+          with_space = range_with_surrounding_space(range: op)
           return if with_space.source.start_with?("\n")
 
           offense(op, with_space, right_operand) do |msg|
-            add_offense(with_space, op, msg)
+            add_offense(with_space, location: op, message: msg)
           end
         end
 
@@ -120,18 +145,6 @@ module RuboCop
             (!allow_for_alignment? || !aligned_with_something?(right_operand))
         end
 
-        def autocorrect(range)
-          lambda do |corrector|
-            if range.source =~ /\*\*/
-              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
-
         def align_hash_cop_config
           config.for_cop('Layout/AlignHash')
         end

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

@@ -5,9 +5,23 @@ module RuboCop
     module Layout
       # Checks that block braces have or don't have a space before the opening
       # brace depending on configuration.
+      #
+      # @example
+      #   # bad
+      #   foo.map{ |a|
+      #     a.bar.to_s
+      #   }
+      #
+      #   # good
+      #   foo.map { |a|
+      #     a.bar.to_s
+      #   }
       class SpaceBeforeBlockBraces < Cop
         include ConfigurableEnforcedStyle
 
+        MISSING_MSG = 'Space missing to the left of {.'.freeze
+        DETECTED_MSG = 'Space detected to the left of {.'.freeze
+
         def self.autocorrect_incompatible_with
           [Style::SymbolProc]
         end
@@ -16,10 +30,44 @@ 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
 
+          if empty_braces?(node.loc)
+            check_empty(left_brace, space_plus_brace, used_style)
+          else
+            check_non_empty(left_brace, space_plus_brace, used_style)
+          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
+
+          if style_for_empty_braces == :space
+            add_offense(left_brace, location: left_brace, message: MISSING_MSG)
+          else
+            space = range_between(space_plus_brace.begin_pos,
+                                  left_brace.begin_pos)
+            add_offense(space, location: space, message: DETECTED_MSG)
+          end
+        end
+
+        def check_non_empty(left_brace, space_plus_brace, used_style)
           case used_style
           when style  then correct_style_detected
           when :space then space_detected(left_brace, space_plus_brace)
@@ -27,11 +75,8 @@ module RuboCop
           end
         end
 
-        private
-
         def space_missing(left_brace)
-          add_offense(left_brace, left_brace,
-                      'Space missing to the left of {.') do
+          add_offense(left_brace, location: left_brace, message: MISSING_MSG) do
             opposite_style_detected
           end
         end
@@ -39,19 +84,23 @@ module RuboCop
         def space_detected(left_brace, space_plus_brace)
           space = range_between(space_plus_brace.begin_pos,
                                 left_brace.begin_pos)
-          add_offense(space, space, 'Space detected to the left of {.') do
+          add_offense(space, location: space, message: DETECTED_MSG) do
             opposite_style_detected
           end
         end
 
-        def autocorrect(range)
-          lambda do |corrector|
-            case range.source
-            when /\s/ then corrector.remove(range)
-            else           corrector.insert_before(range, ' ')
-            end
+        def style_for_empty_braces
+          case cop_config['EnforcedStyleForEmptyBraces']
+          when 'space'    then :space
+          when 'no_space' then :no_space
+          when nil then style
+          else raise 'Unknown EnforcedStyleForEmptyBraces selected!'
           end
         end
+
+        def empty_braces?(loc)
+          loc.begin.end_pos == loc.end.begin_pos
+        end
       end
     end
   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

@@ -5,19 +5,24 @@ module RuboCop
     module Layout
       # This cop checks for missing space between a token and a comment on the
       # same line.
+      #
+      # @example
+      #   # bad
+      #   1 + 1# this operation does ...
+      #
+      #   # good
+      #   1 + 1 # this operation does ...
       class SpaceBeforeComment < Cop
         MSG = 'Put a space before an end-of-line comment.'.freeze
 
         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
-            add_offense(t2.pos, t2.pos) if t1.pos.end == t2.pos.begin
+            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,11 +32,12 @@ 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)
 
-          add_offense(space, space) if space.length != 1
+          add_offense(space, location: space) if space.length != 1
         end
 
         def autocorrect(range)

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

@@ -4,11 +4,18 @@ module RuboCop
   module Cop
     module Layout
       # Checks for semicolon (;) preceded by space.
+      #
+      # @example
+      #   # bad
+      #   x = 1 ; y = 2
+      #
+      #   # good
+      #   x = 1; y = 2
       class SpaceBeforeSemicolon < Cop
         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
@@ -37,9 +31,13 @@ module RuboCop
         def on_send(node)
           return unless arrow_lambda_with_args?(node)
           if style == :require_space && !space_after_arrow?(node)
-            add_offense(node, node.parent.loc.expression, MSG_REQUIRE_SPACE)
+            add_offense(node,
+                        location: node.parent.loc.expression,
+                        message: MSG_REQUIRE_SPACE)
           elsif style == :require_no_space && space_after_arrow?(node)
-            add_offense(node, node.parent.loc.expression, MSG_REQUIRE_NO_SPACE)
+            add_offense(node,
+                        location: node.parent.loc.expression,
+                        message: MSG_REQUIRE_NO_SPACE)
           end
         end
 

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