rubocop 0.78.0 → 1.13.0

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

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      class MethodCallWithArgsParentheses
+        # Style omit_parentheses
+        # rubocop:disable Metrics/ModuleLength, Metrics/CyclomaticComplexity
+        module OmitParentheses
+          TRAILING_WHITESPACE_REGEX = /\s+\Z/.freeze
+          OMIT_MSG = 'Omit parentheses for method calls with arguments.'
+          private_constant :OMIT_MSG
+
+          private
+
+          def omit_parentheses(node)
+            return unless node.parenthesized?
+            return if inside_endless_method_def?(node)
+            return if syntax_like_method_call?(node)
+            return if super_call_without_arguments?(node)
+            return if allowed_camel_case_method_call?(node)
+            return if legitimate_call_with_parentheses?(node)
+            return if allowed_string_interpolation_method_call?(node)
+
+            add_offense(offense_range(node), message: OMIT_MSG) do |corrector|
+              auto_correct(corrector, node)
+            end
+          end
+
+          def auto_correct(corrector, node)
+            if parentheses_at_the_end_of_multiline_call?(node)
+              corrector.replace(args_begin(node), ' \\')
+            else
+              corrector.replace(args_begin(node), ' ')
+            end
+            corrector.remove(node.loc.end)
+          end
+
+          def offense_range(node)
+            node.loc.begin.join(node.loc.end)
+          end
+
+          def inside_endless_method_def?(node)
+            # parens are required around arguments inside an endless method
+            node.each_ancestor(:def, :defs).any?(&:endless?) && node.arguments.any?
+          end
+
+          def syntax_like_method_call?(node)
+            node.implicit_call? || node.operator_method?
+          end
+
+          def super_call_without_arguments?(node)
+            node.super_type? && node.arguments.none?
+          end
+
+          def allowed_camel_case_method_call?(node)
+            node.camel_case_method? &&
+              (node.arguments.none? || cop_config['AllowParenthesesInCamelCaseMethod'])
+          end
+
+          def allowed_string_interpolation_method_call?(node)
+            cop_config['AllowParenthesesInStringInterpolation'] &&
+              inside_string_interpolation?(node)
+          end
+
+          def parentheses_at_the_end_of_multiline_call?(node)
+            node.multiline? &&
+              node.loc.begin.source_line
+                  .gsub(TRAILING_WHITESPACE_REGEX, '')
+                  .end_with?('(')
+          end
+
+          def legitimate_call_with_parentheses?(node)
+            call_in_literals?(node) ||
+              call_with_ambiguous_arguments?(node) ||
+              call_in_logical_operators?(node) ||
+              call_in_optional_arguments?(node) ||
+              call_in_single_line_inheritance?(node) ||
+              allowed_multiline_call_with_parentheses?(node) ||
+              allowed_chained_call_with_parentheses?(node)
+          end
+
+          def call_in_literals?(node)
+            node.parent &&
+              (node.parent.pair_type? ||
+              node.parent.array_type? ||
+              node.parent.range_type? ||
+              splat?(node.parent) ||
+              ternary_if?(node.parent))
+          end
+
+          def call_in_logical_operators?(node)
+            parent = node.parent&.block_type? ? node.parent.parent : node.parent
+            parent &&
+              (logical_operator?(parent) ||
+              parent.send_type? &&
+              parent.arguments.any? { |argument| logical_operator?(argument) })
+          end
+
+          def call_in_optional_arguments?(node)
+            node.parent && (node.parent.optarg_type? || node.parent.kwoptarg_type?)
+          end
+
+          def call_in_single_line_inheritance?(node)
+            node.parent&.class_type? && node.parent&.single_line?
+          end
+
+          def call_with_ambiguous_arguments?(node)
+            call_with_braced_block?(node) ||
+              call_as_argument_or_chain?(node) ||
+              hash_literal_in_arguments?(node) ||
+              node.descendants.any? do |n|
+                n.forwarded_args_type? || ambigious_literal?(n) || logical_operator?(n) ||
+                  call_with_braced_block?(n)
+              end
+          end
+
+          def call_with_braced_block?(node)
+            (node.send_type? || node.super_type?) && node.block_node && node.block_node.braces?
+          end
+
+          def call_as_argument_or_chain?(node)
+            node.parent &&
+              (node.parent.send_type? && !assigned_before?(node.parent, node) ||
+              node.parent.csend_type? || node.parent.super_type? || node.parent.yield_type?)
+          end
+
+          def hash_literal_in_arguments?(node)
+            node.arguments.any? do |n|
+              hash_literal?(n) ||
+                n.send_type? && node.descendants.any? { |descendant| hash_literal?(descendant) }
+            end
+          end
+
+          def allowed_multiline_call_with_parentheses?(node)
+            cop_config['AllowParenthesesInMultilineCall'] && node.multiline?
+          end
+
+          def allowed_chained_call_with_parentheses?(node)
+            return false unless cop_config['AllowParenthesesInChaining']
+
+            previous = node.descendants.first
+            return false unless previous&.send_type?
+
+            previous.parenthesized? || allowed_chained_call_with_parentheses?(previous)
+          end
+
+          def ambigious_literal?(node)
+            splat?(node) || ternary_if?(node) || regexp_slash_literal?(node) || unary_literal?(node)
+          end
+
+          def splat?(node)
+            node.splat_type? || node.kwsplat_type? || node.block_pass_type?
+          end
+
+          def ternary_if?(node)
+            node.if_type? && node.ternary?
+          end
+
+          def logical_operator?(node)
+            (node.and_type? || node.or_type?) && node.logical_operator?
+          end
+
+          def hash_literal?(node)
+            node.hash_type? && node.braces?
+          end
+
+          def regexp_slash_literal?(node)
+            node.regexp_type? && node.loc.begin.source == '/'
+          end
+
+          def unary_literal?(node)
+            node.numeric_type? && node.sign? ||
+              node.parent&.send_type? && node.parent&.unary_operation?
+          end
+
+          def assigned_before?(node, target)
+            node.assignment? && node.loc.operator.begin < target.loc.begin
+          end
+
+          def inside_string_interpolation?(node)
+            node.ancestors.drop_while { |a| !a.begin_type? }.any?(&:dstr_type?)
+          end
+        end
+        # rubocop:enable Metrics/ModuleLength, Metrics/CyclomaticComplexity
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      class MethodCallWithArgsParentheses
+        # Style require_parentheses
+        module RequireParentheses
+          REQUIRE_MSG = 'Use parentheses for method calls with arguments.'
+          private_constant :REQUIRE_MSG
+
+          private
+
+          def require_parentheses(node)
+            return if ignored_method?(node.method_name)
+            return if matches_ignored_pattern?(node.method_name)
+            return if eligible_for_parentheses_omission?(node)
+            return unless node.arguments? && !node.parenthesized?
+
+            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
+
+          def eligible_for_parentheses_omission?(node)
+            node.operator_method? || node.setter_method? || ignored_macro?(node)
+          end
+
+          def included_macros_list
+            cop_config.fetch('IncludedMacros', []).map(&:to_sym)
+          end
+
+          def ignored_macro?(node)
+            cop_config['IgnoreMacros'] &&
+              node.macro? &&
+              !included_macros_list.include?(node.method_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,39 +11,42 @@ module RuboCop
       #
       #   # good
       #   object.some_method
-      class MethodCallWithoutArgsParentheses < Cop
+      class MethodCallWithoutArgsParentheses < Base
         include IgnoredMethods
+        extend AutoCorrector
 
-        MSG = 'Do not use parentheses for method calls with ' \
-              'no arguments.'
+        MSG = 'Do not use parentheses for method calls with no arguments.'
 
         def on_send(node)
-          return if ineligible_node?(node)
           return unless !node.arguments? && node.parenthesized?
+          return if ineligible_node?(node)
+          return if default_argument?(node)
           return if ignored_method?(node.method_name)
           return if same_name_assignment?(node)
 
-          add_offense(node, location: node.loc.begin.join(node.loc.end))
+          register_offense(node)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
+        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 same_name_assignment?(node)
           any_assignment?(node) do |asgn_node|
-            if asgn_node.masgn_type?
-              next variable_in_mass_assignment?(node.method_name, asgn_node)
-            end
+            next variable_in_mass_assignment?(node.method_name, asgn_node) if asgn_node.masgn_type?
 
             asgn_node.loc.name.source == node.method_name.to_s
           end
@@ -71,6 +74,10 @@ module RuboCop
 
           var_nodes.any? { |n| n.to_a.first == variable_name }
         end
+
+        def offense_range(node)
+          node.loc.begin.join(node.loc.end)
+        end
       end
     end
   end

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

@@ -8,11 +8,20 @@ module RuboCop
       # when reading code.
       #
       # @example
-      #
+      #   # bad
       #   a do
       #     b
       #   end.c
-      class MethodCalledOnDoEndBlock < Cop
+      #
+      #   # good
+      #   a { b }.c
+      #
+      #   # good
+      #   foo = a do
+      #     b
+      #   end
+      #   foo.c
+      class MethodCalledOnDoEndBlock < Base
         include RangeHelp
 
         MSG = 'Avoid chaining a method call on a do...end block.'
@@ -31,13 +40,11 @@ module RuboCop
 
           receiver = node.receiver
 
-          return unless receiver&.block_type? &&
-                        receiver.loc.end.is?('end')
+          return unless receiver&.block_type? && receiver.loc.end.is?('end')
 
-          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(nil, location: range)
+          add_offense(range)
         end
         alias on_csend on_send
       end

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

@@ -6,6 +6,9 @@ module RuboCop
       # This cop checks for parentheses around the arguments in method
       # definitions. Both instance and class/singleton methods are checked.
       #
+      # This cop does not consider endless methods, since parentheses are
+      # always required for them.
+      #
       # @example EnforcedStyle: require_parentheses (default)
       #   # The `require_parentheses` style requires method definitions
       #   # to always use parentheses
@@ -84,15 +87,17 @@ module RuboCop
       #           last_descriptive_var_name)
       #     do_something
       #   end
-      class MethodDefParentheses < Cop
+      class MethodDefParentheses < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
+        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 node.endless?
+
           args = node.arguments
 
           if require_parentheses?(args)
@@ -109,17 +114,6 @@ module RuboCop
         end
         alias on_defs on_def
 
-        def autocorrect(node)
-          lambda do |corrector|
-            if node.args_type?
-              # offense is registered on args node when parentheses are unwanted
-              correct_arguments(node, corrector)
-            else
-              correct_definition(node, corrector)
-            end
-          end
-        end
-
         private
 
         def correct_arguments(arg_node, corrector)
@@ -129,18 +123,15 @@ module RuboCop
 
         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)
+          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, ')')
         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)
@@ -150,14 +141,17 @@ module RuboCop
         def missing_parentheses(node)
           location = node.arguments.source_range
 
-          add_offense(node, location: location, message: MSG_MISSING) do
-            unexpected_style_detected(:require_no_parentheses)
+          add_offense(location, message: MSG_MISSING) do |corrector|
+            correct_definition(node, corrector)
+            unexpected_style_detected 'require_no_parentheses'
           end
         end
 
         def unwanted_parentheses(args)
-          add_offense(args, message: MSG_PRESENT) do
-            unexpected_style_detected(:require_parentheses)
+          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
       end

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

@@ -14,37 +14,33 @@ module RuboCop
       #   # good
       #   bar = foo.minmax
       #   return foo.minmax
-      class MinMax < Cop
+      class MinMax < Base
+        extend AutoCorrector
+
         MSG = 'Use `%<receiver>s.minmax` instead of `%<offender>s`.'
 
         def on_array(node)
           min_max_candidate(node) do |receiver|
             offender = offending_range(node)
 
-            add_offense(node, location: offender,
-                              message: message(offender, receiver))
-          end
-        end
-        alias on_return on_array
-
-        def autocorrect(node)
-          receiver = node.children.first.receiver
+            add_offense(offender, message: message(offender, receiver)) do |corrector|
+              receiver = node.children.first.receiver
 
-          lambda do |corrector|
-            corrector.replace(offending_range(node),
-                              "#{receiver.source}.minmax")
+              corrector.replace(offending_range(node), "#{receiver.source}.minmax")
+            end
           end
         end
+        alias on_return on_array
 
         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)