rubocop 0.93.1 → 1.79.2

data/lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb

@@ -6,28 +6,28 @@ module RuboCop
       class MethodCallWithArgsParentheses
         # Style require_parentheses
         module RequireParentheses
-          def on_send(node)
-            return if ignored_method?(node.method_name)
-            return if matches_ignored_pattern?(node.method_name)
+          REQUIRE_MSG = 'Use parentheses for method calls with arguments.'
+          private_constant :REQUIRE_MSG
+
+          private
+
+          def require_parentheses(node)
+            return if allowed_method_name?(node.method_name)
+            return if matches_allowed_pattern?(node.method_name)
             return if eligible_for_parentheses_omission?(node)
             return unless node.arguments? && !node.parenthesized?
 
-            add_offense(node) do |corrector|
+            add_offense(node, message: REQUIRE_MSG) do |corrector|
               corrector.replace(args_begin(node), '(')
 
               corrector.insert_after(args_end(node), ')') unless args_parenthesized?(node)
             end
           end
-          alias on_csend on_send
-          alias on_super on_send
-          alias on_yield on_send
 
-          def message(_node = nil)
-            'Use parentheses for method calls with arguments.'
+          def allowed_method_name?(name)
+            allowed_method?(name) || matches_allowed_pattern?(name)
           end
 
-          private
-
           def eligible_for_parentheses_omission?(node)
             node.operator_method? || node.setter_method? || ignored_macro?(node)
           end

data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb

@@ -3,25 +3,23 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the presence (default) or absence of parentheses in
-      # method calls containing parameters.
+      # Enforces the presence (default) or absence of parentheses in
+      # method calls containing arguments.
       #
-      # In the default style (require_parentheses), macro methods are ignored.
-      # Additional methods can be added to the `IgnoredMethods`
-      # or `IgnoredPatterns` list. These options are
-      # valid only in the default style. Macros can be included by
-      # either setting `IgnoreMacros` to false or adding specific macros to
-      # the `IncludedMacros` list.
+      # In the default style (require_parentheses), macro methods are allowed.
+      # Additional methods can be added to the `AllowedMethods` or
+      # `AllowedPatterns` list. These options are valid only in the default
+      # style. Macros can be included by either setting `IgnoreMacros` to false
+      # or adding specific macros to the `IncludedMacros` list.
       #
-      # Precedence of options is all follows:
+      # Precedence of options is as follows:
       #
-      # 1. `IgnoredMethods`
-      # 2. `IgnoredPatterns`
+      # 1. `AllowedMethods`
+      # 2. `AllowedPatterns`
       # 3. `IncludedMacros`
       #
-      # eg. If a method is listed in both
-      # `IncludedMacros` and `IgnoredMethods`, then the latter takes
-      # precedence (that is, the method is ignored).
+      # If a method is listed in both `IncludedMacros` and `AllowedMethods`,
+      # then the latter takes precedence (that is, the method is allowed).
       #
       # In the alternative style (omit_parentheses), there are three additional
       # options.
@@ -40,6 +38,32 @@ module RuboCop
       #     to `true` allows the presence of parentheses in such a method call
       #     even with arguments.
       #
+      # NOTE: The style of `omit_parentheses` allows parentheses in cases where
+      # omitting them results in ambiguous or syntactically incorrect code.
+      #
+      # Non-exhaustive list of examples:
+      #
+      # - Parentheses are required allowed in method calls with arguments inside
+      #   literals, logical operators, setting default values in position and
+      #   keyword arguments, chaining and more.
+      # - Parentheses are allowed in method calls with arguments inside
+      #   operators to avoid ambiguity.
+      #   triple-dot syntax introduced in Ruby 2.7 as omitting them starts an
+      #   endless range.
+      # - Parentheses are allowed when forwarding arguments with the
+      #   triple-dot syntax introduced in Ruby 2.7 as omitting them starts an
+      #   endless range.
+      # - Parentheses are required in calls with arguments when inside an
+      #   endless method definition introduced in Ruby 3.0.
+      # - Ruby 3.1's hash omission syntax allows parentheses if the method call
+      #   is in conditionals and requires parentheses if the call
+      #   is not the value-returning expression. See
+      #   https://bugs.ruby-lang.org/issues/18396.
+      # - Parentheses are required in anonymous arguments, keyword arguments
+      #   and block passing in Ruby 3.2.
+      # - Parentheses are required when the first argument is a beginless range or
+      #   the last argument is an endless range.
+      #
       # @example EnforcedStyle: require_parentheses (default)
       #
       #   # bad
@@ -56,10 +80,10 @@ module RuboCop
       #   # Setter methods don't need parens
       #   foo.bar = baz
       #
-      #   # okay with `puts` listed in `IgnoredMethods`
+      #   # okay with `puts` listed in `AllowedMethods`
       #   puts 'test'
       #
-      #   # okay with `^assert` listed in `IgnoredPatterns`
+      #   # okay with `^assert` listed in `AllowedPatterns`
       #   assert_equal 'test', x
       #
       # @example EnforcedStyle: omit_parentheses
@@ -71,10 +95,28 @@ module RuboCop
       #   array.delete e
       #
       #   # bad
-      #   foo.enforce(strict: true)
+      #   action.enforce(strict: true)
+      #
+      #   # good
+      #   action.enforce strict: true
+      #
+      #   # good
+      #   # Parentheses are allowed for code that can be ambiguous without
+      #   # them.
+      #   action.enforce(condition) || other_condition
+      #
+      #   # good
+      #   # Parentheses are allowed for calls that won't produce valid Ruby
+      #   # without them.
+      #   yield path, File.basename(path)
       #
       #   # good
-      #   foo.enforce strict: true
+      #   # Omitting the parentheses in Ruby 3.1 hash omission syntax can lead
+      #   # to ambiguous code. We allow them in conditionals and non-last
+      #   # expressions. See https://bugs.ruby-lang.org/issues/18396
+      #   if meets(criteria:, action:)
+      #     safe_action(action) || dangerous_action(action)
+      #   end
       #
       # @example IgnoreMacros: true (default)
       #
@@ -90,6 +132,22 @@ module RuboCop
       #     bar :baz
       #   end
       #
+      # @example AllowedMethods: ["puts", "print"]
+      #
+      #   # good
+      #   puts "Hello world"
+      #   print "Hello world"
+      #   # still enforces parentheses on other methods
+      #   array.delete(e)
+      #
+      # @example AllowedPatterns: ["^assert"]
+      #
+      #   # good
+      #   assert_equal 'test', x
+      #   assert_match(/foo/, bar)
+      #   # still enforces parentheses on other methods
+      #   array.delete(e)
+      #
       # @example AllowParenthesesInMultilineCall: false (default)
       #
       #   # bad
@@ -143,46 +201,61 @@ module RuboCop
       #
       #   # good
       #   Array 1
+      #
+      # @example AllowParenthesesInStringInterpolation: false (default)
+      #
+      #   # bad
+      #   "#{t('this.is.bad')}"
+      #
+      #   # good
+      #   "#{t 'this.is.better'}"
+      #
+      # @example AllowParenthesesInStringInterpolation: true
+      #
+      #   # good
+      #   "#{t('this.is.good')}"
+      #
+      #   # good
+      #   "#{t 'this.is.also.good'}"
       class MethodCallWithArgsParentheses < Base
+        require_relative 'method_call_with_args_parentheses/omit_parentheses'
+        require_relative 'method_call_with_args_parentheses/require_parentheses'
+
         include ConfigurableEnforcedStyle
-        include IgnoredMethods
-        include IgnoredPattern
+        include AllowedMethods
+        include AllowedPattern
+        include RequireParentheses
+        include OmitParentheses
         extend AutoCorrector
 
-        def initialize(*)
-          super
-          return unless style_configured?
-
-          case style
-          when :require_parentheses
-            extend RequireParentheses
-          when :omit_parentheses
-            extend OmitParentheses
-          end
+        def self.autocorrect_incompatible_with
+          [Style::NestedParenthesizedCalls, Style::RescueModifier]
         end
 
-        # @abstract Overridden in style modules
-        def autocorrect(_node); end
+        def on_send(node)
+          send(style, node) # call require_parentheses or omit_parentheses
+        end
+        alias on_csend on_send
+        alias on_yield on_send
 
         private
 
         def args_begin(node)
           loc = node.loc
-          selector =
-            node.super_type? || node.yield_type? ? loc.keyword : loc.selector
+          selector = node.yield_type? ? loc.keyword : loc.selector
 
           resize_by = args_parenthesized?(node) ? 2 : 1
           selector.end.resize(resize_by)
         end
 
         def args_end(node)
-          node.loc.expression.end
+          node.source_range.end
         end
 
         def args_parenthesized?(node)
           return false unless node.arguments.one?
 
-          first_node = node.arguments.first
+          first_node = node.first_argument
           first_node.begin_type? && first_node.parenthesized_call?
         end
       end

data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb

@@ -3,7 +3,13 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for unwanted parentheses in parameterless method calls.
+      # Checks for unwanted parentheses in parameterless method calls.
+      #
+      # This cop's allowed methods can be customized with `AllowedMethods`.
+      # By default, there are no allowed methods.
+      #
+      # NOTE: This cop allows the use of `it()` without arguments in blocks,
+      # as in `0.times { it() }`, following `Lint/ItWithoutArgumentsInBlock` cop.
       #
       # @example
       #   # bad
@@ -11,39 +17,83 @@ module RuboCop
       #
       #   # good
       #   object.some_method
+      #
+      # @example AllowedMethods: [] (default)
+      #   # bad
+      #   object.foo()
+      #
+      # @example AllowedMethods: [foo]
+      #   # good
+      #   object.foo()
+      #
       class MethodCallWithoutArgsParentheses < Base
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
         extend AutoCorrector
 
-        MSG = 'Do not use parentheses for method calls with ' \
-              'no arguments.'
+        MSG = 'Do not use parentheses for method calls with no arguments.'
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def on_send(node)
           return unless !node.arguments? && node.parenthesized?
           return if ineligible_node?(node)
-          return if ignored_method?(node.method_name)
+          return if default_argument?(node)
+          return if allowed_method_name?(node.method_name)
           return if same_name_assignment?(node)
+          return if parenthesized_it_method_in_block?(node)
 
+          register_offense(node)
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+        alias on_csend on_send
+
+        private
+
+        def register_offense(node)
           add_offense(offense_range(node)) do |corrector|
             corrector.remove(node.loc.begin)
             corrector.remove(node.loc.end)
           end
         end
 
-        private
-
         def ineligible_node?(node)
           node.camel_case_method? || node.implicit_call? || node.prefix_not?
         end
 
+        def default_argument?(node)
+          node.parent&.optarg_type?
+        end
+
+        def allowed_method_name?(name)
+          allowed_method?(name) || matches_allowed_pattern?(name)
+        end
+
         def same_name_assignment?(node)
-          any_assignment?(node) do |asgn_node|
-            next variable_in_mass_assignment?(node.method_name, asgn_node) if asgn_node.masgn_type?
+          return false if node.receiver
 
-            asgn_node.loc.name.source == node.method_name.to_s
+          any_assignment?(node) do |asgn_node|
+            if asgn_node.masgn_type?
+              variable_in_mass_assignment?(node.method_name, asgn_node)
+            else
+              asgn_node.loc.name.source == node.method_name.to_s
+            end
           end
         end
 
+        # Respects `Lint/ItWithoutArgumentsInBlock` cop and the following Ruby 3.3's warning:
+        #
+        # $ ruby -e '0.times { begin; it; end }'
+        # -e:1: warning: `it` calls without arguments will refer to the first block param in
+        # Ruby 3.4; use it() or self.it
+        #
+        def parenthesized_it_method_in_block?(node)
+          return false unless node.method?(:it)
+          return false unless (block_node = node.each_ancestor(:block).first)
+          return false unless block_node.arguments.empty_and_without_delimiters?
+
+          !node.receiver && node.arguments.empty? && !node.block_literal?
+        end
+
         def any_assignment?(node)
           node.each_ancestor(*AST::Node::ASSIGNMENTS).any? do |asgn_node|
             # `obj.method = value` parses as (send ... :method= ...), and will
@@ -51,20 +101,14 @@ module RuboCop
             # `obj.method ||= value` parses as (or-asgn (send ...) ...)
             # which IS an `asgn_node`. Similarly, `obj.method += value` parses
             # as (op-asgn (send ...) ...), which is also an `asgn_node`.
-            if asgn_node.shorthand_asgn?
-              asgn_node, _value = *asgn_node
-              next if asgn_node.send_type?
-            end
+            next if asgn_node.shorthand_asgn? && asgn_node.lhs.call_type?
 
             yield asgn_node
           end
         end
 
         def variable_in_mass_assignment?(variable_name, node)
-          mlhs_node, _mrhs_node = *node
-          var_nodes = *mlhs_node
-
-          var_nodes.any? { |n| n.to_a.first == variable_name }
+          node.assignments.reject(&:send_type?).any? { |n| n.name == variable_name }
         end
 
         def offense_range(node)

data/lib/rubocop/cop/style/method_called_on_do_end_block.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for methods called on a do...end block. The point of
+      # Checks for methods called on a do...end block. The point of
       # this check is that it's easy to miss the call tacked on to the block
       # when reading code.
       #
@@ -35,16 +35,16 @@ module RuboCop
           ignore_node(node.send_node)
         end
 
+        alias on_numblock on_block
+        alias on_itblock on_block
+
         def on_send(node)
           return if ignored_node?(node)
 
-          receiver = node.receiver
-
-          return unless receiver&.block_type? &&
-                        receiver.loc.end.is?('end')
+          return unless (receiver = node.receiver)
+          return unless receiver.any_block_type? && receiver.keywords?
 
-          range = range_between(receiver.loc.end.begin_pos,
-                                node.source_range.end_pos)
+          range = range_between(receiver.loc.end.begin_pos, node.source_range.end_pos)
 
           add_offense(range)
         end

data/lib/rubocop/cop/style/method_def_parentheses.rb

@@ -3,9 +3,19 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for parentheses around the arguments in method
+      # Checks for parentheses around the arguments in method
       # definitions. Both instance and class/singleton methods are checked.
       #
+      # Regardless of style, parentheses are necessary for:
+      #
+      # 1. Endless methods
+      # 2. Argument lists containing a `forward-arg` (`...`)
+      # 3. Argument lists containing an anonymous rest arguments forwarding (`*`)
+      # 4. Argument lists containing an anonymous keyword rest arguments forwarding (`**`)
+      # 5. Argument lists containing an anonymous block forwarding (`&`)
+      #
+      # Removing the parens would be a syntax error here.
+      #
       # @example EnforcedStyle: require_parentheses (default)
       #   # The `require_parentheses` style requires method definitions
       #   # to always use parentheses
@@ -90,10 +100,11 @@ module RuboCop
         extend AutoCorrector
 
         MSG_PRESENT = 'Use def without parentheses.'
-        MSG_MISSING = 'Use def with parentheses when there are ' \
-                      'parameters.'
+        MSG_MISSING = 'Use def with parentheses when there are parameters.'
 
         def on_def(node)
+          return if forced_parentheses?(node)
+
           args = node.arguments
 
           if require_parentheses?(args)
@@ -117,20 +128,20 @@ module RuboCop
           corrector.remove(arg_node.loc.end)
         end
 
-        def correct_definition(def_node, corrector)
-          arguments_range = def_node.arguments.source_range
-          args_with_space = range_with_surrounding_space(range: arguments_range,
-                                                         side: :left)
-          leading_space = range_between(args_with_space.begin_pos,
-                                        arguments_range.begin_pos)
-          corrector.replace(leading_space, '(')
-          corrector.insert_after(arguments_range, ')')
+        def forced_parentheses?(node)
+          # Regardless of style, parentheses are necessary for:
+          # 1. Endless methods
+          # 2. Argument lists containing a `forward-arg` (`...`)
+          # 3. Argument lists containing an anonymous rest arguments forwarding (`*`)
+          # 4. Argument lists containing an anonymous keyword rest arguments forwarding (`**`)
+          # 5. Argument lists containing an anonymous block forwarding (`&`)
+          # Removing the parens would be a syntax error here.
+          node.endless? || anonymous_arguments?(node)
         end
 
         def require_parentheses?(args)
           style == :require_parentheses ||
-            (style == :require_no_parentheses_except_multiline &&
-             args.multiline?)
+            (style == :require_no_parentheses_except_multiline && args.multiline?)
         end
 
         def arguments_without_parentheses?(node)
@@ -141,7 +152,9 @@ module RuboCop
           location = node.arguments.source_range
 
           add_offense(location, message: MSG_MISSING) do |corrector|
-            correct_definition(node, corrector)
+            add_parentheses(node.arguments, corrector)
+
+            unexpected_style_detected 'require_no_parentheses'
           end
         end
 
@@ -149,8 +162,18 @@ module RuboCop
           add_offense(args, message: MSG_PRESENT) do |corrector|
             # offense is registered on args node when parentheses are unwanted
             correct_arguments(args, corrector)
+            unexpected_style_detected 'require_parentheses'
           end
         end
+
+        def anonymous_arguments?(node)
+          return true if node.arguments.any? do |arg|
+            arg.type?(:forward_arg, :restarg, :kwrestarg)
+          end
+          return false unless (last_argument = node.last_argument)
+
+          last_argument.blockarg_type? && last_argument.name.nil?
+        end
       end
     end
   end

data/lib/rubocop/cop/style/min_max.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for potential uses of `Enumerable#minmax`.
+      # Checks for potential uses of `Enumerable#minmax`.
       #
       # @example
       #
@@ -34,13 +34,13 @@ module RuboCop
 
         private
 
+        # @!method min_max_candidate(node)
         def_node_matcher :min_max_candidate, <<~PATTERN
           ({array return} (send [$_receiver !nil?] :min) (send [$_receiver !nil?] :max))
         PATTERN
 
         def message(offender, receiver)
-          format(MSG, offender: offender.source,
-                      receiver: receiver.source)
+          format(MSG, offender: offender.source, receiver: receiver.source)
         end
 
         def offending_range(node)
@@ -48,13 +48,13 @@ module RuboCop
           when :return
             argument_range(node)
           else
-            node.loc.expression
+            node.source_range
           end
         end
 
         def argument_range(node)
-          first_argument_range = node.children.first.loc.expression
-          last_argument_range  = node.children.last.loc.expression
+          first_argument_range = node.children.first.source_range
+          last_argument_range  = node.children.last.source_range
 
           first_argument_range.join(last_argument_range)
         end

data/lib/rubocop/cop/style/min_max_comparison.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Enforces the use of `max` or `min` instead of comparison for greater or less.
+      #
+      # NOTE: It can be used if you want to present limit or threshold in Ruby 2.7+.
+      # That it is slow though. So autocorrection will apply generic `max` or `min`:
+      #
+      # [source,ruby]
+      # ----
+      # a.clamp(b..) # Same as `[a, b].max`
+      # a.clamp(..b) # Same as `[a, b].min`
+      # ----
+      #
+      # @safety
+      #   This cop is unsafe because even if a value has `<` or `>` method,
+      #   it is not necessarily `Comparable`.
+      #
+      # @example
+      #
+      #   # bad
+      #   a > b ? a : b
+      #   a >= b ? a : b
+      #
+      #   # good
+      #   [a, b].max
+      #
+      #   # bad
+      #   a < b ? a : b
+      #   a <= b ? a : b
+      #
+      #   # good
+      #   [a, b].min
+      #
+      class MinMaxComparison < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `%<prefer>s` instead.'
+        GREATER_OPERATORS = %i[> >=].freeze
+        LESS_OPERATORS = %i[< <=].freeze
+        COMPARISON_OPERATORS = (GREATER_OPERATORS + LESS_OPERATORS).to_set.freeze
+
+        # @!method comparison_condition(node, name)
+        def_node_matcher :comparison_condition, <<~PATTERN
+          {
+            (send $_lhs $COMPARISON_OPERATORS $_rhs)
+            (begin (send $_lhs $COMPARISON_OPERATORS $_rhs))
+          }
+        PATTERN
+
+        def on_if(node)
+          lhs, operator, rhs = comparison_condition(node.condition)
+          return unless operator
+
+          if_branch = node.if_branch
+          else_branch = node.else_branch
+          preferred_method = preferred_method(operator, lhs, rhs, if_branch, else_branch)
+          return unless preferred_method
+
+          replacement = "[#{lhs.source}, #{rhs.source}].#{preferred_method}"
+
+          add_offense(node, message: format(MSG, prefer: replacement)) do |corrector|
+            autocorrect(corrector, node, replacement)
+          end
+        end
+
+        private
+
+        def preferred_method(operator, lhs, rhs, if_branch, else_branch)
+          if lhs == if_branch && rhs == else_branch
+            GREATER_OPERATORS.include?(operator) ? 'max' : 'min'
+          elsif lhs == else_branch && rhs == if_branch
+            LESS_OPERATORS.include?(operator) ? 'max' : 'min'
+          end
+        end
+
+        def autocorrect(corrector, node, replacement)
+          if node.elsif?
+            corrector.remove(range_between(node.parent.loc.else.begin_pos, node.loc.else.begin_pos))
+            corrector.replace(node.else_branch, replacement)
+          else
+            corrector.replace(node, replacement)
+          end
+        end
+      end
+    end
+  end
+end