rubocop 1.10.0 → 1.14.0

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

@@ -18,13 +18,10 @@ module RuboCop
       #   def foobar(a = 1, b = 2, c = 3)
       #   end
       class OptionalArguments < Base
-        MSG = 'Optional arguments should appear at the end ' \
-              'of the argument list.'
+        MSG = 'Optional arguments should appear at the end of the argument list.'
 
         def on_def(node)
-          each_misplaced_optional_arg(node.arguments) do |argument|
-            add_offense(argument)
-          end
+          each_misplaced_optional_arg(node.arguments) { |argument| add_offense(argument) }
         end
 
         private

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?
@@ -49,18 +51,14 @@ module RuboCop
         def on_if(node)
           return unless unless_assignment?(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         def on_lvasgn(node)
           return unless (else_branch = ternary_assignment?(node))
           return if else_branch.if_type?
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         alias on_ivasgn on_lvasgn

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

@@ -36,9 +36,7 @@ module RuboCop
           return if allowed_lhs?(lhs) || allowed_rhs?(rhs) ||
                     allowed_masign?(lhs_elements, rhs_elements)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         private
@@ -72,9 +70,7 @@ module RuboCop
           elements = Array(node).compact
 
           # Account for edge case of `Constant::CONSTANT`
-          !node.array_type? ||
-            return_of_method_call?(node) ||
-            elements.any?(&:splat_type?)
+          !node.array_type? || return_of_method_call?(node) || elements.any?(&:splat_type?)
         end
 
         def return_of_method_call?(node)
@@ -115,6 +111,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 +120,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)
@@ -158,9 +160,10 @@ module RuboCop
           # Does `rhs` access the same value which is assigned by `lhs`?
           def accesses?(rhs, lhs)
             if lhs.method?(:[]=)
-              matching_calls(rhs, lhs.receiver, :[]).any? do |args|
-                args == lhs.arguments
-              end
+              # FIXME: Workaround `rubocop:disable` comment for JRuby.
+              # rubocop:disable Performance/RedundantEqualityComparisonBlock
+              matching_calls(rhs, lhs.receiver, :[]).any? { |args| args == lhs.arguments }
+              # rubocop:enable Performance/RedundantEqualityComparisonBlock
             else
               access_method = lhs.method_name.to_s.chop.to_sym
               matching_calls(rhs, lhs.receiver, access_method).any?

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/percent_literal_delimiters.rb

@@ -72,9 +72,7 @@ module RuboCop
         end
 
         def preferred_delimiters_for(type)
-          PreferredDelimiters
-            .new(type, @config, nil)
-            .delimiters
+          PreferredDelimiters.new(type, @config, nil).delimiters
         end
 
         def uses_preferred_delimiter?(node, type)

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

@@ -30,8 +30,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        LOWER_CASE_Q_MSG = 'Do not use `%Q` unless interpolation is ' \
-                           'needed. Use `%q`.'
+        LOWER_CASE_Q_MSG = 'Do not use `%Q` unless interpolation is needed. Use `%q`.'
         UPPER_CASE_Q_MSG = 'Use `%Q` instead of `%q`.'
 
         def on_str(node)

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

@@ -36,11 +36,7 @@ module RuboCop
         # @param [RuboCop::AST::Node] node
         # @return [Boolean]
         def derived_from_braceless_interpolation?(node)
-          %i[
-            dstr
-            regexp
-            xstr
-          ].include?(node.parent&.type)
+          %i[dstr regexp xstr].include?(node.parent&.type)
         end
 
         # @private
@@ -95,10 +91,7 @@ module RuboCop
 
           add_offense(
             node,
-            message: format_message(
-              node: node,
-              preferred_expression: preferred_expression
-            )
+            message: format_message(node: node, preferred_expression: preferred_expression)
           ) do |corrector|
             if derived_from_braceless_interpolation?(node)
               preferred_expression = "{#{preferred_expression}}"

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

@@ -31,10 +31,7 @@ module RuboCop
 
         MSG = 'Use `Hash#%<prefer>s` instead of `Hash#%<current>s`.'
 
-        OFFENDING_SELECTORS = {
-          short: %i[has_key? has_value?],
-          verbose: %i[key? value?]
-        }.freeze
+        OFFENDING_SELECTORS = { short: %i[has_key? has_value?], verbose: %i[key? value?] }.freeze
 
         RESTRICT_ON_SEND = OFFENDING_SELECTORS.values.flatten.freeze
 

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

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

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

@@ -43,10 +43,8 @@ module RuboCop
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        EXPLODED_MSG = 'Provide an exception class and message ' \
-          'as arguments to `%<method>s`.'
-        COMPACT_MSG = 'Provide an exception object ' \
-          'as an argument to `%<method>s`.'
+        EXPLODED_MSG = 'Provide an exception class and message as arguments to `%<method>s`.'
+        COMPACT_MSG = 'Provide an exception object as an argument to `%<method>s`.'
 
         RESTRICT_ON_SEND = %i[raise fail].freeze
 
@@ -66,8 +64,7 @@ module RuboCop
         def correction_compact_to_exploded(node)
           exception_node, _new, message_node = *node.first_argument
 
-          arguments =
-            [exception_node, message_node].compact.map(&:source).join(', ')
+          arguments = [exception_node, message_node].compact.map(&:source).join(', ')
 
           if node.parent && requires_parens?(node.parent)
             "#{node.method_name}(#{arguments})"
@@ -142,8 +139,7 @@ module RuboCop
         end
 
         def requires_parens?(parent)
-          parent.and_type? || parent.or_type? ||
-            parent.if_type? && parent.ternary?
+          parent.and_type? || parent.or_type? || parent.if_type? && parent.ternary?
         end
       end
     end

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

@@ -26,10 +26,10 @@ module RuboCop
       class RandomWithOffset < Base
         extend AutoCorrector
 
-        MSG = 'Prefer ranges when generating random numbers instead of ' \
-          'integers with offsets.'
+        MSG = 'Prefer ranges when generating random numbers instead of 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 +39,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 +50,7 @@ module RuboCop
             int)
         PATTERN
 
+        # @!method rand_modified?(node)
         def_node_matcher :rand_modified?, <<~PATTERN
           (send
             (send
@@ -60,17 +62,14 @@ module RuboCop
 
         def on_send(node)
           return unless node.receiver
-          return unless integer_op_rand?(node) ||
-                        rand_op_integer?(node) ||
-                        rand_modified?(node)
+          return unless integer_op_rand?(node) || rand_op_integer?(node) || rand_modified?(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         private
 
+        # @!method random_call(node)
         def_node_matcher :random_call, <<~PATTERN
           {(send (send $_ _ $_) ...)
            (send _ _ (send $_ _ $_))}
@@ -144,6 +143,7 @@ module RuboCop
           end
         end
 
+        # @!method to_int(node)
         def_node_matcher :to_int, <<~PATTERN
           (int $_)
         PATTERN

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'parser/current'
-
 module RuboCop
   module Cop
     module Style
@@ -68,17 +66,10 @@ module RuboCop
         end
 
         def redundant_arg_for_method(method_name)
-          return nil unless cop_config['Methods'].key?(method_name)
+          arg = cop_config['Methods'].fetch(method_name) { return }
 
           @mem ||= {}
-          @mem[method_name] ||=
-            begin
-              arg = cop_config['Methods'].fetch(method_name)
-              buffer = Parser::Source::Buffer.new('(string)', 1)
-              buffer.source = arg.inspect
-              builder = RuboCop::AST::Builder.new
-              Parser::CurrentRuby.new(builder).parse(buffer)
-            end
+          @mem[method_name] ||= parse(arg.inspect).ast
         end
 
         def argument_range(node)

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
@@ -80,9 +81,7 @@ module RuboCop
         end
 
         def check_rescue_node(node)
-          node.child_nodes.each do |child_node|
-            check_branch(child_node)
-          end
+          node.child_nodes.each { |child_node| check_branch(child_node) }
         end
 
         def check_ensure_node(node)

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

@@ -36,7 +36,6 @@ module RuboCop
       #   do_something
       #
       #   # bad
-      #   # When using Ruby 2.5 or later.
       #   do_something do
       #     begin
       #       something
@@ -63,6 +62,7 @@ module RuboCop
       #     end
       #   end
       class RedundantBegin < Base
+        include RangeHelp
         extend AutoCorrector
 
         MSG = 'Redundant `begin` block detected.'
@@ -75,8 +75,6 @@ module RuboCop
         alias on_defs on_def
 
         def on_block(node)
-          return if target_ruby_version < 2.5
-
           return if node.send_node.lambda_literal?
           return if node.braces?
           return unless node.body&.kwbegin_type?
@@ -85,7 +83,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 +93,44 @@ 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
+
+          source = first_child.source
+          source = "(#{source})" if first_child.if_type?
+
+          corrector.replace(offense_range, source)
+          corrector.remove(range_between(offense_range.end_pos, first_child.source_range.end_pos))
+
+          restore_removed_comments(corrector, offense_range, node, first_child)
+        end
+
+        # Restore comments that occur between "begin" and "first_child".
+        # These comments will be moved to above the assignment line.
+        def restore_removed_comments(corrector, offense_range, node, first_child)
+          comments_range = range_between(offense_range.end_pos, first_child.source_range.begin_pos)
+          comments = comments_range.source
+
+          corrector.insert_before(node.parent, comments) unless comments.blank?
+        end
+
+        def empty_begin?(node)
+          node.children.empty?
+        end
+
         def contain_rescue_or_ensure?(node)
           first_child = node.children.first
 
@@ -108,9 +140,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

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

@@ -18,8 +18,7 @@ module RuboCop
         include PercentLiteral
         extend AutoCorrector
 
-        MSG = 'Do not use `%W` unless interpolation is needed. ' \
-              'If not, use `%w`.'
+        MSG = 'Do not use `%W` unless interpolation is needed. If not, use `%w`.'
 
         def on_array(node)
           process(node, '%W')

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

@@ -78,9 +78,7 @@ module RuboCop
           return false if use_if_branch?(else_branch) || use_hash_key_assignment?(else_branch)
 
           condition == if_branch && !node.elsif? && (
-            node.ternary? ||
-            !else_branch.instance_of?(AST::Node) ||
-            else_branch.single_line?
+            node.ternary? || !else_branch.instance_of?(AST::Node) || else_branch.single_line?
           )
         end
 
@@ -104,8 +102,7 @@ module RuboCop
 
         def make_ternary_form(node)
           _condition, if_branch, else_branch = *node
-          ternary_form = [if_branch.source,
-                          else_source(else_branch)].join(' || ')
+          ternary_form = [if_branch.source, else_source(else_branch)].join(' || ')
 
           if node.parent&.send_type?
             "(#{ternary_form})"