rubocop 0.78.0

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

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks that operators have space around them, except for ** which
+      # should or shouldn't have surrounding space depending on configuration.
+      #
+      # @example
+      #   # bad
+      #   total = 3*4
+      #   "apple"+"juice"
+      #   my_number = 38/4
+      #
+      #   # good
+      #   total = 3 * 4
+      #   "apple" + "juice"
+      #   my_number = 38 / 4
+      #
+      # @example EnforcedStyleForExponentOperator: no_space (default)
+      #   # bad
+      #   a ** b
+      #
+      #   # good
+      #   a**b
+      #
+      # @example EnforcedStyleForExponentOperator: space
+      #   # bad
+      #   a**b
+      #
+      #   # good
+      #   a ** b
+      class SpaceAroundOperators < Cop
+        include PrecedingFollowingAlignment
+        include RangeHelp
+        include RationalLiteral
+
+        IRREGULAR_METHODS = %i[[] ! []=].freeze
+        EXCESSIVE_SPACE = '  '
+
+        def self.autocorrect_incompatible_with
+          [Style::SelfAssignment]
+        end
+
+        def on_pair(node)
+          return unless node.hash_rocket?
+
+          return if hash_table_style? && !node.parent.pairs_on_same_line?
+
+          check_operator(:pair, node.loc.operator, node.source_range)
+        end
+
+        def on_if(node)
+          return unless node.ternary?
+
+          check_operator(:if, node.loc.question, node.if_branch.source_range)
+          check_operator(:if, node.loc.colon, node.else_branch.source_range)
+        end
+
+        def on_resbody(node)
+          return unless node.loc.assoc
+
+          _, variable, = *node
+
+          check_operator(:resbody, node.loc.assoc, variable.source_range)
+        end
+
+        def on_send(node)
+          return if rational_literal?(node)
+
+          if node.setter_method?
+            on_special_asgn(node)
+          elsif regular_operator?(node)
+            check_operator(:send,
+                           node.loc.selector,
+                           node.first_argument.source_range)
+          end
+        end
+
+        def on_assignment(node)
+          _, rhs, = *node
+
+          return unless rhs
+
+          check_operator(:assignment, node.loc.operator, rhs.source_range)
+        end
+
+        def on_binary(node)
+          _, rhs, = *node
+
+          return unless rhs
+
+          check_operator(:binary, node.loc.operator, rhs.source_range)
+        end
+
+        def on_special_asgn(node)
+          _, _, right, = *node
+
+          return unless right
+
+          check_operator(:special_asgn, node.loc.operator, right.source_range)
+        end
+
+        alias on_or       on_binary
+        alias on_and      on_binary
+        alias on_lvasgn   on_assignment
+        alias on_masgn    on_assignment
+        alias on_casgn    on_special_asgn
+        alias on_ivasgn   on_assignment
+        alias on_cvasgn   on_assignment
+        alias on_gvasgn   on_assignment
+        alias on_class    on_binary
+        alias on_or_asgn  on_assignment
+        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)
+        end
+
+        def operator_with_regular_syntax?(send_node)
+          send_node.operator_method? &&
+            !IRREGULAR_METHODS.include?(send_node.method_name)
+        end
+
+        def check_operator(type, operator, right_operand)
+          with_space = range_with_surrounding_space(range: operator)
+          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)
+          end
+        end
+
+        def offense(type, operator, with_space, right_operand)
+          msg = offense_message(type, operator, with_space, right_operand)
+          yield msg if msg
+        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$/
+            "Surrounding space missing for operator `#{operator.source}`."
+          elsif excess_leading_space?(type, operator, with_space) ||
+                excess_trailing_space?(right_operand, with_space)
+            "Operator `#{operator.source}` should be surrounded " \
+            'by a single space.'
+          end
+        end
+
+        def excess_leading_space?(type, operator, with_space)
+          return false unless allow_for_alignment?
+          return false unless with_space.source.start_with?(EXCESSIVE_SPACE)
+
+          return !aligned_with_operator?(operator) unless type == :assignment
+
+          token            = Token.new(operator, nil, operator.source)
+          align_preceding  = aligned_with_preceding_assignment(token)
+
+          return align_preceding == :no unless align_preceding == :none
+
+          aligned_with_subsequent_assignment(token) != :yes
+        end
+
+        def excess_trailing_space?(right_operand, with_space)
+          with_space.source.end_with?(EXCESSIVE_SPACE) &&
+            (!allow_for_alignment? || !aligned_with_something?(right_operand))
+        end
+
+        def align_hash_cop_config
+          config.for_cop('Layout/HashAlignment')
+        end
+
+        def hash_table_style?
+          align_hash_cop_config &&
+            align_hash_cop_config['EnforcedHashRocketStyle'] == 'table'
+        end
+
+        def space_around_exponent_operator?
+          cop_config['EnforcedStyleForExponentOperator'] == 'space'
+        end
+
+        def should_not_have_surrounding_space?(operator)
+          operator.is?('**') ? !space_around_exponent_operator? : false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks that block braces have or don't have a space before the opening
+      # brace depending on configuration.
+      #
+      # @example EnforcedStyle: space (default)
+      #   # bad
+      #   foo.map{ |a|
+      #     a.bar.to_s
+      #   }
+      #
+      #   # good
+      #   foo.map { |a|
+      #     a.bar.to_s
+      #   }
+      #
+      # @example EnforcedStyle: no_space
+      #   # bad
+      #   foo.map { |a|
+      #     a.bar.to_s
+      #   }
+      #
+      #   # good
+      #   foo.map{ |a|
+      #     a.bar.to_s
+      #   }
+      class SpaceBeforeBlockBraces < Cop
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        MISSING_MSG = 'Space missing to the left of {.'
+        DETECTED_MSG = 'Space detected to the left of {.'
+
+        def self.autocorrect_incompatible_with
+          [Style::SymbolProc]
+        end
+
+        def on_block(node)
+          return if node.keywords?
+
+          # Do not register an offense for multi-line braces when specifying
+          # `EnforcedStyle: no_space`. It will conflict with auto-correction
+          # 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?
+
+          left_brace = node.loc.begin
+          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)
+          else             space_missing(left_brace)
+          end
+        end
+
+        def space_missing(left_brace)
+          add_offense(left_brace, location: left_brace, message: MISSING_MSG) do
+            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
+            opposite_style_detected
+          end
+        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 conflict_with_block_delimiters?
+          block_delimiters_style == 'line_count_based' &&
+            style == :no_space && node.multiline?
+        end
+
+        def block_delimiters_style
+          config.for_cop('Style/BlockDelimiters')['EnforcedStyle']
+        end
+
+        def empty_braces?(loc)
+          loc.begin.end_pos == loc.end.begin_pos
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+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 autocorrect(space)
+          PunctuationCorrector.remove_space(space)
+        end
+
+        def kind(token)
+          'comma' if token.comma?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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.'
+
+        def investigate(processed_source)
+          processed_source.tokens.each_cons(2) do |token1, token2|
+            next unless token2.comment?
+            next unless token1.line == token2.line
+
+            if token1.pos.end == token2.pos.begin
+              add_offense(token2.pos, location: token2.pos)
+            end
+          end
+        end
+
+        def autocorrect(range)
+          ->(corrector) { corrector.insert_before(range, ' ') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks that exactly one space is used between a method name and the
+      # first argument for method calls without parentheses.
+      #
+      # Alternatively, extra spaces can be added to align the argument with
+      # something on a preceding or following line, if the AllowForAlignment
+      # config parameter is true.
+      #
+      # @example
+      #   # bad
+      #   something  x
+      #   something   y, z
+      #   something'hello'
+      #
+      #   # good
+      #   something x
+      #   something y, z
+      #   something 'hello'
+      #
+      class SpaceBeforeFirstArg < Cop
+        include PrecedingFollowingAlignment
+        include RangeHelp
+
+        MSG = 'Put one space between the method name and ' \
+              'the first argument.'
+
+        def on_send(node)
+          return unless regular_method_call_with_arguments?(node)
+          return unless expect_params_after_method_name?(node)
+
+          first_arg = node.first_argument.source_range
+          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, location: space) if space.length != 1
+        end
+        alias on_csend on_send
+
+        def autocorrect(range)
+          ->(corrector) { corrector.replace(range, ' ') }
+        end
+
+        private
+
+        def regular_method_call_with_arguments?(node)
+          node.arguments? && !node.operator_method? && !node.setter_method?
+        end
+
+        def expect_params_after_method_name?(node)
+          return false if node.parenthesized?
+
+          first_arg = node.first_argument
+
+          same_line?(first_arg, node) &&
+            !(allow_for_alignment? &&
+              aligned_with_something?(first_arg.source_range))
+        end
+      end
+    end
+  end
+end