rubocop 0.87.1

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

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks the spacing around the keywords.
+      #
+      # @example
+      #
+      #   # bad
+      #   something 'test'do|x|
+      #   end
+      #
+      #   while(something)
+      #   end
+      #
+      #   something = 123if test
+      #
+      #   # good
+      #   something 'test' do |x|
+      #   end
+      #
+      #   while (something)
+      #   end
+      #
+      #   something = 123 if test
+      class SpaceAroundKeyword < Cop
+        MSG_BEFORE = 'Space before keyword `%<range>s` is missing.'
+        MSG_AFTER = 'Space after keyword `%<range>s` is missing.'
+
+        DO = 'do'
+        SAFE_NAVIGATION = '&.'
+        NAMESPACE_OPERATOR = '::'
+        ACCEPT_LEFT_PAREN =
+          %w[break defined? next not rescue return super yield].freeze
+        ACCEPT_LEFT_SQUARE_BRACKET =
+          %w[super yield].freeze
+        ACCEPT_NAMESPACE_OPERATOR = 'super'
+
+        def on_and(node)
+          check(node, [:operator].freeze) if node.keyword?
+        end
+
+        def on_block(node)
+          check(node, %i[begin end].freeze)
+        end
+
+        def on_break(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_case(node)
+          check(node, %i[keyword else].freeze)
+        end
+
+        def on_ensure(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_for(node)
+          check(node, %i[begin end].freeze)
+        end
+
+        def on_if(node)
+          check(node, %i[keyword else begin end].freeze, 'then')
+        end
+
+        def on_kwbegin(node)
+          check(node, %i[begin end].freeze, nil)
+        end
+
+        def on_next(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_or(node)
+          check(node, [:operator].freeze) if node.keyword?
+        end
+
+        def on_postexe(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_preexe(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_resbody(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_rescue(node)
+          check(node, [:else].freeze)
+        end
+
+        def on_return(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_send(node)
+          check(node, [:selector].freeze) if node.prefix_not?
+        end
+
+        def on_super(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_zsuper(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_until(node)
+          check(node, %i[begin end keyword].freeze)
+        end
+
+        def on_when(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_while(node)
+          check(node, %i[begin end keyword].freeze)
+        end
+
+        def on_yield(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def on_defined?(node)
+          check(node, [:keyword].freeze)
+        end
+
+        def autocorrect(range)
+          if space_before_missing?(range)
+            ->(corrector) { corrector.insert_before(range, ' ') }
+          else
+            ->(corrector) { corrector.insert_after(range, ' ') }
+          end
+        end
+
+        private
+
+        def check(node, locations, begin_keyword = DO)
+          locations.each do |loc|
+            next unless node.loc.respond_to?(loc)
+
+            range = node.loc.public_send(loc)
+            next unless range
+
+            case loc
+            when :begin then check_begin(node, range, begin_keyword)
+            when :end then check_end(node, range, begin_keyword)
+            else check_keyword(node, range)
+            end
+          end
+        end
+
+        def check_begin(node, range, begin_keyword)
+          return if begin_keyword && !range.is?(begin_keyword)
+
+          check_keyword(node, range)
+        end
+
+        def check_end(node, range, begin_keyword)
+          return if begin_keyword == DO && !do?(node)
+
+          offense(range, MSG_BEFORE) if space_before_missing?(range)
+        end
+
+        def do?(node)
+          node.loc.begin&.is?(DO)
+        end
+
+        def check_keyword(node, range)
+          offense(range, MSG_BEFORE) if space_before_missing?(range) &&
+                                        !preceded_by_operator?(node, range)
+          offense(range, MSG_AFTER) if space_after_missing?(range)
+        end
+
+        def offense(range, msg)
+          add_offense(range,
+                      location: range,
+                      message: format(msg, range: range.source))
+        end
+
+        def space_before_missing?(range)
+          pos = range.begin_pos - 1
+          return false if pos.negative?
+
+          !/[\s(|{\[;,*=]/.match?(range.source_buffer.source[pos])
+        end
+
+        def space_after_missing?(range)
+          pos = range.end_pos
+          char = range.source_buffer.source[pos]
+
+          return false if accepted_opening_delimiter?(range, char)
+          return false if safe_navigation_call?(range, pos)
+          return false if accept_namespace_operator?(range) &&
+                          namespace_operator?(range, pos)
+
+          !/[\s;,#\\)}\].]/.match?(char)
+        end
+
+        def accepted_opening_delimiter?(range, char)
+          return true unless char
+
+          accept_left_square_bracket?(range) && char == '[' ||
+            accept_left_parenthesis?(range) && char == '('
+        end
+
+        def accept_left_parenthesis?(range)
+          ACCEPT_LEFT_PAREN.include?(range.source)
+        end
+
+        def accept_left_square_bracket?(range)
+          ACCEPT_LEFT_SQUARE_BRACKET.include?(range.source)
+        end
+
+        def accept_namespace_operator?(range)
+          ACCEPT_NAMESPACE_OPERATOR == range.source
+        end
+
+        def safe_navigation_call?(range, pos)
+          range.source_buffer.source[pos, 2].start_with?(SAFE_NAVIGATION)
+        end
+
+        def namespace_operator?(range, pos)
+          range.source_buffer.source[pos, 2].start_with?(NAMESPACE_OPERATOR)
+        end
+
+        def preceded_by_operator?(node, _range)
+          # regular dotted method calls bind more tightly than operators
+          # so we need to climb up the AST past them
+          node.each_ancestor do |ancestor|
+            return true if ancestor.and_type? || ancestor.or_type?
+            return false unless ancestor.send_type?
+            return true if ancestor.operator_method?
+          end
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks method call operators to not have spaces around them.
+      #
+      # @example
+      #   # bad
+      #   foo. bar
+      #   foo .bar
+      #   foo . bar
+      #   foo. bar .buzz
+      #   foo
+      #     . bar
+      #     . buzz
+      #   foo&. bar
+      #   foo &.bar
+      #   foo &. bar
+      #   foo &. bar&. buzz
+      #   RuboCop:: Cop
+      #   RuboCop:: Cop:: Cop
+      #   :: RuboCop::Cop
+      #
+      #   # good
+      #   foo.bar
+      #   foo.bar.buzz
+      #   foo
+      #     .bar
+      #     .buzz
+      #   foo&.bar
+      #   foo&.bar&.buzz
+      #   RuboCop::Cop
+      #   RuboCop::Cop::Cop
+      #   ::RuboCop::Cop
+      #
+      class SpaceAroundMethodCallOperator < Cop
+        include SurroundingSpace
+
+        MSG = 'Avoid using spaces around a method call operator.'
+
+        def on_send(node)
+          return unless dot_or_safe_navigation_operator?(node)
+
+          check_and_add_offense(node)
+        end
+
+        def on_const(node)
+          return unless node.loc.double_colon
+
+          check_and_add_offense(node, false)
+        end
+
+        def autocorrect(node)
+          operator = operator_token(node)
+          left = left_token_for_auto_correction(node, operator)
+          right = right_token_for_auto_correction(operator)
+
+          lambda do |corrector|
+            SpaceCorrector.remove_space(
+              processed_source, corrector, left, right
+            )
+          end
+        end
+
+        alias on_csend on_send
+
+        private
+
+        def check_and_add_offense(node, add_left_offense = true)
+          operator = operator_token(node)
+          left = previous_token(operator)
+          right = next_token(operator)
+
+          if !right.comment? && valid_right_token?(right, operator)
+            no_space_offenses(node, operator, right, MSG)
+          end
+          return unless valid_left_token?(left, operator)
+
+          no_space_offenses(node, left, operator, MSG) if add_left_offense
+        end
+
+        def operator_token(node)
+          operator_location =
+            node.const_type? ? node.loc.double_colon : node.loc.dot
+
+          processed_source.find_token do |token|
+            token.pos == operator_location
+          end
+        end
+
+        def previous_token(current_token)
+          index = processed_source.tokens.index(current_token)
+          index.zero? ? nil : processed_source.tokens[index - 1]
+        end
+
+        def next_token(current_token)
+          index = processed_source.tokens.index(current_token)
+          processed_source.tokens[index + 1]
+        end
+
+        def dot_or_safe_navigation_operator?(node)
+          node.dot? || node.safe_navigation?
+        end
+
+        def valid_left_token?(left, operator)
+          left && left.line == operator.line
+        end
+
+        def valid_right_token?(right, operator)
+          right && right.line == operator.line
+        end
+
+        def left_token_for_auto_correction(node, operator)
+          left_token = previous_token(operator)
+          return operator if node.const_type?
+          return left_token if valid_left_token?(left_token, operator)
+
+          operator
+        end
+
+        def right_token_for_auto_correction(operator)
+          right_token = next_token(operator)
+          return right_token if !right_token.comment? && valid_right_token?(right_token, operator)
+
+          operator
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,242 @@
+# 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.
+      #
+      # This cop has `AllowForAlignment` option. When `true`, allows most
+      # uses of extra spacing if the intent is to align with an operator on
+      # the previous or next line, not counting empty lines or comment lines.
+      #
+      # @example
+      #   # bad
+      #   total = 3*4
+      #   "apple"+"juice"
+      #   my_number = 38/4
+      #
+      #   # good
+      #   total = 3 * 4
+      #   "apple" + "juice"
+      #   my_number = 38 / 4
+      #
+      # @example AllowForAlignment: true (default)
+      #   # good
+      #   {
+      #     1 =>  2,
+      #     11 => 3
+      #   }
+      #
+      # @example AllowForAlignment: false
+      #   # bad
+      #   {
+      #     1 =>  2,
+      #     11 => 3
+      #   }
+      #
+      # @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 /\*\*/.match?(range.source) && !space_around_exponent_operator?
+              corrector.replace(range, '**')
+            elsif range.source.end_with?("\n")
+              corrector.replace(range, " #{range.source.strip}\n")
+            else
+              enclose_operator_with_space(corrector, range)
+            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 enclose_operator_with_space(corrector, range)
+          operator = range.source
+
+          # If `ForceEqualSignAlignment` is true, `Layout/ExtraSpacing` cop
+          # inserts spaces before operator. If `Layout/SpaceAroundOperators` cop
+          # inserts a space, it collides and raises the infinite loop error.
+          if force_equal_sign_alignment?
+            corrector.insert_after(range, ' ') unless operator.end_with?(' ')
+          else
+            corrector.replace(range, " #{operator.strip} ")
+          end
+        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 !/^\s.*\s$/.match?(with_space.source)
+            "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 force_equal_sign_alignment?
+          config.for_cop('Layout/ExtraSpacing')['ForceEqualSignAlignment']
+        end
+
+        def should_not_have_surrounding_space?(operator)
+          operator.is?('**') ? !space_around_exponent_operator? : false
+        end
+      end
+    end
+  end
+end