rubocop 0.49.1 → 0.52.0

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
@@ -26,7 +26,7 @@ module RuboCop
 
         def on_percent_literal(node)
           each_unnecessary_space_match(node) do |range|
-            add_offense(node, range, MSG)
+            add_offense(node, location: range)
           end
         end
 

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
@@ -128,9 +210,9 @@ module RuboCop
           end
         end
 
-        def offense(begin_pos, end_pos, msg)
+        def offense(begin_pos, end_pos, msg, &block)
           range = range_between(begin_pos, end_pos)
-          add_offense(range, range, msg) { yield if block_given? }
+          add_offense(range, location: range, message: msg, &block)
         end
 
         def style_for_empty_braces
@@ -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

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

@@ -5,6 +5,37 @@ module RuboCop
     module Layout
       # Checks that braces used for hash literals have or don't have
       # surrounding space depending on configuration.
+      #
+      # @example EnforcedStyle: space
+      #   # The `space` style enforces that hash literals have
+      #   # surrounding space.
+      #
+      #   # bad
+      #   h = {a: 1, b: 2}
+      #
+      #   # good
+      #   h = { a: 1, b: 2 }
+      #
+      # @example EnforcedStyle: no_space
+      #   # The `no_space` style enforces that hash literals have
+      #   # no surrounding space.
+      #
+      #   # bad
+      #   h = { a: 1, b: 2 }
+      #
+      #   # good
+      #   h = {a: 1, b: 2}
+      #
+      # @example EnforcedStyle: compact
+      #   # The `compact` style normally requires a space inside
+      #   # hash braces, with the exception that successive left
+      #   # braces or right braces are collapsed together in nested hashes.
+      #
+      #   # bad
+      #   h = { a: { b: 2 } }
+      #
+      #   # good
+      #   h = { a: { b: 2 }}
       class SpaceInsideHashLiteralBraces < Cop
         include SurroundingSpace
         include ConfigurableEnforcedStyle
@@ -22,36 +53,45 @@ module RuboCop
           end
         end
 
+        def autocorrect(range)
+          lambda do |corrector|
+            # It is possible that BracesAroundHashParameters will remove the
+            # braces while this cop inserts spaces. This can lead to unwanted
+            # changes to the inspected code. If we replace the brace with a
+            # brace plus space (rather than just inserting a space), then any
+            # removal of the same brace will give us a clobbering error. This
+            # in turn will make RuboCop fall back on cop-by-cop
+            # auto-correction.  Problem solved.
+            case range.source
+            when /\s/ then corrector.remove(range)
+            when '{' then corrector.replace(range, '{ ')
+            else corrector.replace(range, ' }')
+            end
+          end
+        end
+
         private
 
         def hash_literal_with_braces(node)
           tokens = processed_source.tokens
           begin_index = index_of_first_token(node)
-          return unless left_brace?(tokens[begin_index])
+          return unless tokens[begin_index].left_brace?
 
           end_index = index_of_last_token(node)
-          return unless right_brace?(tokens[end_index])
+          return unless tokens[end_index].right_curly_brace?
 
           yield begin_index, end_index
         end
 
-        def left_brace?(token)
-          token.type == :tLBRACE
-        end
-
-        def right_brace?(token)
-          token.type == :tRCURLY
-        end
-
         def check(t1, t2)
           # No offense if line break inside.
-          return if t1.pos.line < t2.pos.line
-          return if t2.type == :tCOMMENT # Also indicates there's a line break.
+          return if t1.line < t2.line
+          return if t2.comment? # Also indicates there's a line break.
 
-          is_empty_braces = left_brace?(t1) && right_brace?(t2)
+          is_empty_braces = t1.left_brace? && t2.right_curly_brace?
           expect_space    = expect_space?(t1, t2)
 
-          if offense?(t1, t2, expect_space)
+          if offense?(t1, expect_space)
             incorrect_style_detected(t1, t2, expect_space, is_empty_braces)
           else
             correct_style_detected
@@ -60,7 +100,7 @@ module RuboCop
 
         def expect_space?(t1, t2)
           is_same_braces  = t1.type == t2.type
-          is_empty_braces = left_brace?(t1) && right_brace?(t2)
+          is_empty_braces = t1.left_brace? && t2.right_curly_brace?
 
           if is_same_braces && style == :compact
             false
@@ -74,8 +114,11 @@ module RuboCop
         def incorrect_style_detected(t1, t2, expect_space, is_empty_braces)
           brace = (t1.text == '{' ? t1 : t2).pos
           range = expect_space ? brace : space_range(brace)
-          add_offense(range, range,
-                      message(brace, is_empty_braces, expect_space)) do
+          add_offense(
+            range,
+            location: range,
+            message: message(brace, is_empty_braces, expect_space)
+          ) do
             style = expect_space ? :no_space : :space
             ambiguous_or_unexpected_style_detected(style, t1.text == t2.text)
           end
@@ -89,8 +132,8 @@ module RuboCop
           end
         end
 
-        def offense?(t1, t2, expect_space)
-          has_space = space_between?(t1, t2)
+        def offense?(t1, expect_space)
+          has_space = t1.space_after?
           expect_space ? !has_space : has_space
         end
 
@@ -104,23 +147,6 @@ module RuboCop
           format(MSG, "#{inside_what} #{problem}")
         end
 
-        def autocorrect(range)
-          lambda do |corrector|
-            # It is possible that BracesAroundHashParameters will remove the
-            # braces while this cop inserts spaces. This can lead to unwanted
-            # changes to the inspected code. If we replace the brace with a
-            # brace plus space (rather than just inserting a space), then any
-            # removal of the same brace will give us a clobbering error. This
-            # in turn will make RuboCop fall back on cop-by-cop
-            # auto-correction.  Problem solved.
-            case range.source
-            when /\s/ then corrector.remove(range)
-            when '{' then corrector.replace(range, '{ ')
-            else corrector.replace(range, ' }')
-            end
-          end
-        end
-
         def space_range(token_range)
           if token_range.source == '{'
             range_of_space_to_the_right(token_range)

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

@@ -4,11 +4,48 @@ module RuboCop
   module Cop
     module Layout
       # Checks for spaces inside ordinary round parentheses.
+      #
+      # @example
+      #   # bad
+      #   f( 3)
+      #   g = (a + 3 )
+      #
+      #   # good
+      #   f(3)
+      #   g = (a + 3)
       class SpaceInsideParens < Cop
-        include SpaceInside
+        include SurroundingSpace
 
-        def specifics
-          [%i[tLPAREN tLPAREN2], :tRPAREN, 'parentheses']
+        MSG = 'Space inside parentheses detected.'.freeze
+
+        def investigate(processed_source)
+          @processed_source = processed_source
+          each_extraneous_space(processed_source.tokens) do |range|
+            add_offense(range, location: range)
+          end
+        end
+
+        def autocorrect(range)
+          ->(corrector) { corrector.remove(range) }
+        end
+
+        private
+
+        def each_extraneous_space(tokens)
+          tokens.each_cons(2) do |t1, t2|
+            next unless parens?(t1, t2)
+
+            # If the second token is a comment, that means that a line break
+            # follows, and that the rules for space inside don't apply.
+            next if t2.comment?
+            next unless t2.line == t1.line && t1.space_after?
+
+            yield range_between(t1.end_pos, t2.begin_pos)
+          end
+        end
+
+        def parens?(t1, t2)
+          t1.left_parens? || t2.right_parens?
         end
       end
     end

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

@@ -50,7 +50,7 @@ module RuboCop
           return unless node.single_line?
 
           regex_matches(node) do |match_range|
-            add_offense(node, match_range, MSG)
+            add_offense(node, location: match_range)
           end
         end
 

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

@@ -28,21 +28,6 @@ module RuboCop
           check(node)
         end
 
-        private
-
-        def check(node)
-          expression = node.source
-          op = node.loc.operator.source
-          escaped_op = op.gsub(/\./, '\.')
-
-          # account for multiline range literals
-          expression.sub!(/#{escaped_op}\n\s*/, op)
-
-          return unless expression =~ /(\s#{escaped_op})|(#{escaped_op}\s)/
-
-          add_offense(node, :expression)
-        end
-
         def autocorrect(node)
           expression = node.source
           operator = node.loc.operator.source
@@ -57,6 +42,21 @@ module RuboCop
             )
           end
         end
+
+        private
+
+        def check(node)
+          expression = node.source
+          op = node.loc.operator.source
+          escaped_op = op.gsub(/\./, '\.')
+
+          # account for multiline range literals
+          expression.sub!(/#{escaped_op}\n\s*/, op)
+
+          return unless expression =~ /(\s#{escaped_op})|(#{escaped_op}\s)/
+
+          add_offense(node)
+        end
       end
     end
   end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks that reference brackets have or don't have
+      # surrounding space depending on configuration.
+      #
+      # @example EnforcedStyle: no_space (default)
+      #   # The `no_space` style enforces that reference brackets have
+      #   # no surrounding space.
+      #
+      #   # bad
+      #   hash[ :key ]
+      #   array[ index ]
+      #
+      #   # good
+      #   hash[:key]
+      #   array[index]
+      #
+      # @example EnforcedStyle: space
+      #   # The `space` style enforces that reference brackets have
+      #   # surrounding space.
+      #
+      #   # bad
+      #   hash[:key]
+      #   array[index]
+      #
+      #   # good
+      #   hash[ :key ]
+      #   array[ index ]
+      class SpaceInsideReferenceBrackets < Cop
+        include SurroundingSpace
+        include ConfigurableEnforcedStyle
+
+        MSG = '%<command>s space inside reference brackets.'.freeze
+
+        def on_send(node)
+          return if node.multiline?
+          return unless left_ref_bracket(node)
+          left_token = left_ref_bracket(node)
+          right_token = right_ref_bracket(node, left_token)
+
+          if style == :no_space
+            no_space_offenses(node, left_token, right_token, MSG)
+          else
+            space_offenses(node, left_token, right_token, MSG)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            left, right = reference_brackets(node)
+
+            if style == :no_space
+              no_space_corrector(corrector, left, right)
+            else
+              space_corrector(corrector, left, right)
+            end
+          end
+        end
+
+        private
+
+        def reference_brackets(node)
+          left = left_ref_bracket(node)
+          [left, right_ref_bracket(node, left)]
+        end
+
+        def left_ref_bracket(node)
+          tokens(node).reverse.find(&:left_ref_bracket?)
+        end
+
+        def right_ref_bracket(node, token)
+          i = tokens(node).index(token)
+          tokens(node).slice(i..-1).find(&:right_bracket?)
+        end
+      end
+    end
+  end
+end