rubocop 0.42.0 → 0.52.1

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

@@ -0,0 +1,236 @@
+# 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
+              SpaceCorrector.remove_space(processed_source, corrector,
+                                          left, right)
+            elsif style == :space
+              SpaceCorrector.add_space(processed_source, 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/{style → layout}/space_inside_array_percent_literal.rb

@@ -1,17 +1,17 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Checks for unnecessary additional spaces inside array percent literals
       # (i.e. %i/%w).
       #
-      # @good
-      # %i(foo bar baz)
+      # @example
       #
-      # @bad
-      # %w(foo  bar  baz)
+      #   # bad
+      #   %w(foo  bar  baz)
+      #   # good
+      #   %i(foo bar baz)
       class SpaceInsideArrayPercentLiteral < Cop
         include MatchRange
         include PercentLiteral
@@ -21,12 +21,12 @@ module RuboCop
           /(?:[\S&&[^\\]](?:\\ )*)( {2,})(?=\S)/
 
         def on_array(node)
-          process(node, *%w(%i %I %w %W))
+          process(node, '%i', '%I', '%w', '%W')
         end
 
         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

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks that block braces have or don't have surrounding space inside
+      # 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
+
+        def on_block(node)
+          return if node.keywords?
+
+          left_brace = node.loc.begin
+          right_brace = node.loc.end
+
+          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)
+          if left_brace.end_pos == right_brace.begin_pos
+            adjacent_braces(left_brace, right_brace)
+          else
+            range = range_between(left_brace.end_pos, right_brace.begin_pos)
+            inner = range.source
+
+            if inner =~ /\S/
+              braces_with_contents_inside(node, inner)
+            elsif style_for_empty_braces == :no_space
+              offense(range.begin_pos, range.end_pos,
+                      'Space inside empty braces detected.')
+            end
+          end
+        end
+
+        def adjacent_braces(left_brace, right_brace)
+          return if style_for_empty_braces != :space
+
+          offense(left_brace.begin_pos, right_brace.end_pos,
+                  'Space missing inside empty braces.')
+        end
+
+        def braces_with_contents_inside(node, inner)
+          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, node.single_line?)
+        end
+
+        def check_left_brace(inner, left_brace, args_delimiter)
+          if inner =~ /\A\S/
+            no_space_inside_left_brace(left_brace, args_delimiter)
+          else
+            space_inside_left_brace(left_brace, args_delimiter)
+          end
+        end
+
+        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
+            space_inside_right_brace(right_brace)
+          end
+        end
+
+        def no_space_inside_left_brace(left_brace, args_delimiter)
+          if pipe?(args_delimiter)
+            if left_brace.end_pos == args_delimiter.begin_pos &&
+               cop_config['SpaceBeforeBlockParameters']
+              offense(left_brace.begin_pos, args_delimiter.end_pos,
+                      'Space between { and | missing.') do
+                opposite_style_detected
+              end
+            end
+          else
+            # We indicate the position after the left brace. Otherwise it's
+            # difficult to distinguish between space missing to the left and to
+            # the right of the brace in autocorrect.
+            no_space(left_brace.end_pos, left_brace.end_pos + 1,
+                     'Space missing inside {.')
+          end
+        end
+
+        def space_inside_left_brace(left_brace, args_delimiter)
+          if pipe?(args_delimiter)
+            unless cop_config['SpaceBeforeBlockParameters']
+              offense(left_brace.end_pos, args_delimiter.begin_pos,
+                      'Space between { and | detected.') do
+                opposite_style_detected
+              end
+            end
+          else
+            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
+        end
+
+        def pipe?(args_delimiter)
+          args_delimiter && args_delimiter.is?('|')
+        end
+
+        def space_inside_right_brace(right_brace)
+          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
+
+        def no_space(begin_pos, end_pos, msg)
+          if style == :space
+            offense(begin_pos, end_pos, msg) { opposite_style_detected }
+          else
+            correct_style_detected
+          end
+        end
+
+        def space(begin_pos, end_pos, msg)
+          if style == :no_space
+            offense(begin_pos, end_pos, msg) { opposite_style_detected }
+          else
+            correct_style_detected
+          end
+        end
+
+        def offense(begin_pos, end_pos, msg, &block)
+          range = range_between(begin_pos, end_pos)
+          add_offense(range, location: range, message: msg, &block)
+        end
+
+        def style_for_empty_braces
+          case cop_config['EnforcedStyleForEmptyBraces']
+          when 'space'    then :space
+          when 'no_space' then :no_space
+          else raise 'Unknown EnforcedStyleForEmptyBraces selected!'
+          end
+        end
+      end
+    end
+  end
+end