rubocop 1.9.1 → 1.12.0

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

@@ -5,6 +5,7 @@ module RuboCop
     module Style
       class MethodCallWithArgsParentheses
         # Style omit_parentheses
+        # rubocop:disable Metrics/ModuleLength
         module OmitParentheses
           TRAILING_WHITESPACE_REGEX = /\s+\Z/.freeze
           OMIT_MSG = 'Omit parentheses for method calls with arguments.'
@@ -12,18 +13,21 @@ module RuboCop
 
           private
 
+          # rubocop:disable Metrics/CyclomaticComplexity
           def omit_parentheses(node)
             return unless node.parenthesized?
             return if inside_endless_method_def?(node)
-            return if node.implicit_call?
+            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
+          # rubocop:enable Metrics/CyclomaticComplexity
 
           def auto_correct(corrector, node)
             if parentheses_at_the_end_of_multiline_call?(node)
@@ -43,6 +47,10 @@ module RuboCop
             node.each_ancestor(:def).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
@@ -53,6 +61,11 @@ module RuboCop
               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
@@ -114,7 +127,7 @@ module RuboCop
           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.csend_type? || node.parent.super_type? || node.parent.yield_type?)
           end
 
           def hash_literal_in_arguments?(node)
@@ -172,7 +185,12 @@ module RuboCop
             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
       end
     end
   end

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

@@ -34,6 +34,7 @@ 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

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

@@ -45,11 +45,13 @@ module RuboCop
               'or `module`.'
         RESTRICT_ON_SEND = %i[include extend prepend].freeze
 
+        # @!method include_statement(node)
         def_node_matcher :include_statement, <<~PATTERN
           (send nil? ${:include :extend :prepend}
             const)
         PATTERN
 
+        # @!method in_top_level_scope?(node)
         def_node_matcher :in_top_level_scope?, <<~PATTERN
           {
             root?                        # either at the top level

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

@@ -82,8 +82,13 @@ module RuboCop
         FORBIDDEN_MSG =
           'Do not use `module_function` or `extend self`.'
 
+        # @!method module_function_node?(node)
         def_node_matcher :module_function_node?, '(send nil? :module_function)'
+
+        # @!method extend_self_node?(node)
         def_node_matcher :extend_self_node?, '(send nil? :extend self)'
+
+        # @!method private_directive?(node)
         def_node_matcher :private_directive?, '(send nil? :private ...)'
 
         def on_module(node)

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

@@ -47,11 +47,12 @@ module RuboCop
           'in a conditional, use `Array#include?` instead.'
 
         def on_new_investigation
-          @compared_elements = []
-          @allowed_method_comparison = false
+          @last_comparison = nil
         end
 
         def on_or(node)
+          reset_comparison if switch_comparison?(node)
+
           root_of_or_node = root_of_or_node(node)
 
           return unless node == root_of_or_node
@@ -64,14 +65,21 @@ module RuboCop
 
             corrector.replace(node, prefer_method)
           end
+
+          @last_comparison = node
         end
 
         private
 
+        # @!method simple_double_comparison?(node)
         def_node_matcher :simple_double_comparison?, '(send $lvar :== $lvar)'
+
+        # @!method simple_comparison_lhs?(node)
         def_node_matcher :simple_comparison_lhs?, <<~PATTERN
           (send $lvar :== $_)
         PATTERN
+
+        # @!method simple_comparison_rhs?(node)
         def_node_matcher :simple_comparison_rhs?, <<~PATTERN
           (send $_ :== $lvar)
         PATTERN
@@ -131,6 +139,17 @@ module RuboCop
           end
         end
 
+        def switch_comparison?(node)
+          return true if @last_comparison.nil?
+
+          @last_comparison.descendants.none? { |descendant| descendant == node }
+        end
+
+        def reset_comparison
+          @compared_elements = []
+          @allowed_method_comparison = false
+        end
+
         def allow_method_comparison?
           cop_config.fetch('AllowMethodComparison', true)
         end

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

@@ -154,12 +154,14 @@ module RuboCop
           end
         end
 
+        # @!method splat_value(node)
         def_node_matcher :splat_value, <<~PATTERN
           (array (splat $_))
         PATTERN
 
         # Some of these patterns may not actually return an immutable object,
         # but we want to consider them immutable for this cop.
+        # @!method operation_produces_immutable_object?(node)
         def_node_matcher :operation_produces_immutable_object?, <<~PATTERN
           {
             (const _ _)
@@ -176,6 +178,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method range_enclosed_in_parentheses?(node)
         def_node_matcher :range_enclosed_in_parentheses?, <<~PATTERN
           (begin ({irange erange} _ _))
         PATTERN

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

@@ -29,12 +29,14 @@ module RuboCop
       #
       class NegatedIfElseCondition < Base
         include RangeHelp
+        include CommentsHelp
         extend AutoCorrector
 
         MSG = 'Invert the negated condition and swap the %<type>s branches.'
 
         NEGATED_EQUALITY_METHODS = %i[!= !~].freeze
 
+        # @!method double_negation?(node)
         def_node_matcher :double_negation?, '(send (send _ :!) :!)'
 
         def self.autocorrect_incompatible_with
@@ -96,10 +98,22 @@ module RuboCop
           if node.if_branch.nil?
             corrector.remove(range_by_whole_lines(node.loc.else, include_final_newline: true))
           else
-            corrector.replace(node.if_branch, node.else_branch.source)
-            corrector.replace(node.else_branch, node.if_branch.source)
+            if_range = node_with_comments(node.if_branch)
+            else_range = node_with_comments(node.else_branch)
+
+            corrector.replace(if_range, else_range.source)
+            corrector.replace(else_range, if_range.source)
           end
         end
+
+        def node_with_comments(node)
+          first_statement = node.begin_type? ? node.children[0] : node
+          return node if processed_source.ast_with_comments[first_statement].empty?
+
+          begin_pos = source_range_with_comment(first_statement).begin_pos
+          end_pos = node.source_range.end_pos
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        end
       end
     end
   end

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

@@ -37,7 +37,10 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[== === nil?].freeze
 
+        # @!method nil_comparison?(node)
         def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
 
         def on_send(node)

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

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Use an empty lambda instead of always returning nil.'
 
+        # @!method nil_return?(node)
         def_node_matcher :nil_return?, <<~PATTERN
           { ({return next break} nil) (nil) }
         PATTERN

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

@@ -49,9 +49,16 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[!= nil? !].freeze
 
+        # @!method not_equal_to_nil?(node)
         def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+
+        # @!method unless_check?(node)
         def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        # @!method not_and_nil_check?(node)
         def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
 
         def on_send(node)

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

@@ -115,14 +115,17 @@ module RuboCop
           end
         end
 
+        # @!method predicate(node)
         def_node_matcher :predicate, <<~PATTERN
           (send $(...) ${:zero? :positive? :negative?})
         PATTERN
 
+        # @!method comparison(node)
         def_node_matcher :comparison, <<~PATTERN
           (send [$(...) !gvar_type?] ${:== :> :<} (int 0))
         PATTERN
 
+        # @!method inverted_comparison(node)
         def_node_matcher :inverted_comparison, <<~PATTERN
           (send (int 0) ${:== :> :<} [$(...) !gvar_type?])
         PATTERN

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

@@ -22,6 +22,7 @@ module RuboCop
       class OptionHash < Base
         MSG = 'Prefer keyword arguments to options hashes.'
 
+        # @!method option_hash(node)
         def_node_matcher :option_hash, <<~PATTERN
           (args ... $(optarg [#suspicious_name? _] (hash)))
         PATTERN

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

@@ -31,6 +31,7 @@ module RuboCop
 
         MSG = 'Use the double pipe equals operator `||=` instead.'
 
+        # @!method ternary_assignment?(node)
         def_node_matcher :ternary_assignment?, <<~PATTERN
           ({lvasgn ivasgn cvasgn gvasgn} _var
             (if
@@ -39,6 +40,7 @@ module RuboCop
               $_))
         PATTERN
 
+        # @!method unless_assignment?(node)
         def_node_matcher :unless_assignment?, <<~PATTERN
           (if
             ({lvar ivar cvar gvar} _var) nil?

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

@@ -115,6 +115,7 @@ module RuboCop
           end
         end
 
+        # @!method implicit_self_getter?(node)
         def_node_matcher :implicit_self_getter?, '(send nil? $_)'
 
         # Helper class necessitated by silly design of TSort prior to Ruby 2.1
@@ -123,8 +124,13 @@ module RuboCop
           include TSort
           extend RuboCop::NodePattern::Macros
 
+          # @!method var_name(node)
           def_node_matcher :var_name, '{(casgn _ $_) (_ $_)}'
+
+          # @!method uses_var?(node)
           def_node_search :uses_var?, '{({lvar ivar cvar gvar} %) (const _ %)}'
+
+          # @!method matching_calls(node, receiver, method_name)
           def_node_search :matching_calls, '(send %1 %2 $...)'
 
           def initialize(assignments)

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

@@ -71,6 +71,7 @@ module RuboCop
 
         private
 
+        # @!method control_op_condition(node)
         def_node_matcher :control_op_condition, <<~PATTERN
           (begin $_ ...)
         PATTERN

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

@@ -18,6 +18,7 @@ module RuboCop
 
         MSG = 'Use `proc` instead of `Proc.new`.'
 
+        # @!method proc_new?(node)
         def_node_matcher :proc_new?,
                          '(block $(send (const {nil? cbase} :Proc) :new) ...)'
 

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

@@ -30,6 +30,7 @@ module RuboCop
           'integers with offsets.'
         RESTRICT_ON_SEND = %i[+ - succ pred next].freeze
 
+        # @!method integer_op_rand?(node)
         def_node_matcher :integer_op_rand?, <<~PATTERN
           (send
             int {:+ :-}
@@ -39,6 +40,7 @@ module RuboCop
               {int (irange int int) (erange int int)}))
         PATTERN
 
+        # @!method rand_op_integer?(node)
         def_node_matcher :rand_op_integer?, <<~PATTERN
           (send
             (send
@@ -49,6 +51,7 @@ module RuboCop
             int)
         PATTERN
 
+        # @!method rand_modified?(node)
         def_node_matcher :rand_modified?, <<~PATTERN
           (send
             (send
@@ -71,6 +74,7 @@ module RuboCop
 
         private
 
+        # @!method random_call(node)
         def_node_matcher :random_call, <<~PATTERN
           {(send (send $_ _ $_) ...)
            (send _ _ (send $_ _ $_))}
@@ -144,6 +148,7 @@ module RuboCop
           end
         end
 
+        # @!method to_int(node)
         def_node_matcher :to_int, <<~PATTERN
           (int $_)
         PATTERN

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

@@ -42,6 +42,7 @@ module RuboCop
 
         MSG = 'Redundant assignment before returning detected.'
 
+        # @!method redundant_assignment?(node)
         def_node_matcher :redundant_assignment?, <<~PATTERN
           (... $(lvasgn _name _expression) (lvar _name))
         PATTERN

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

@@ -63,6 +63,7 @@ module RuboCop
       #     end
       #   end
       class RedundantBegin < Base
+        include RangeHelp
         extend AutoCorrector
 
         MSG = 'Redundant `begin` block detected.'
@@ -85,7 +86,9 @@ module RuboCop
         end
 
         def on_kwbegin(node)
-          return if contain_rescue_or_ensure?(node) || valid_context_using_only_begin?(node)
+          return if empty_begin?(node) ||
+                    contain_rescue_or_ensure?(node) ||
+                    valid_context_using_only_begin?(node)
 
           register_offense(node)
         end
@@ -93,12 +96,30 @@ module RuboCop
         private
 
         def register_offense(node)
-          add_offense(node.loc.begin) do |corrector|
-            corrector.remove(node.loc.begin)
+          offense_range = node.loc.begin
+
+          add_offense(offense_range) do |corrector|
+            if any_ancestor_assignment_node?(node)
+              replace_begin_with_statement(corrector, offense_range, node)
+            else
+              corrector.remove(offense_range)
+            end
+
             corrector.remove(node.loc.end)
           end
         end
 
+        def replace_begin_with_statement(corrector, offense_range, node)
+          first_child = node.children.first
+
+          corrector.replace(offense_range, first_child.source)
+          corrector.remove(range_between(offense_range.end_pos, first_child.source_range.end_pos))
+        end
+
+        def empty_begin?(node)
+          node.children.empty?
+        end
+
         def contain_rescue_or_ensure?(node)
           first_child = node.children.first
 
@@ -108,9 +129,17 @@ module RuboCop
         def valid_context_using_only_begin?(node)
           parent = node.parent
 
-          node.each_ancestor.any?(&:assignment?) || parent&.post_condition_loop? ||
+          valid_begin_assignment?(node) || parent&.post_condition_loop? ||
             parent&.send_type? || parent&.operator_keyword?
         end
+
+        def valid_begin_assignment?(node)
+          any_ancestor_assignment_node?(node) && !node.children.one?
+        end
+
+        def any_ancestor_assignment_node?(node)
+          node.each_ancestor.any?(&:assignment?)
+        end
       end
     end
   end