rubocop 1.9.0 → 1.12.1

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

@@ -8,7 +8,7 @@ module RuboCop
       # These can be replaced by their respective predicate methods.
       # The cop can also be configured to do the reverse.
       #
-      # The cop disregards `#nonzero?` as it its value is truthy or falsey,
+      # The cop disregards `#nonzero?` as its value is truthy or falsey,
       # but not `true` and `false`, and thus not always interchangeable with
       # `!= 0`.
       #
@@ -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,41 @@ 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))
+
+          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_conditional.rb

@@ -53,10 +53,12 @@ module RuboCop
           format(MSG, msg: msg)
         end
 
+        # @!method redundant_condition?(node)
         def_node_matcher :redundant_condition?, <<~RUBY
           (if (send _ #{COMPARISON_OPERATOR_MATCHER} _) true false)
         RUBY
 
+        # @!method redundant_condition_inverted?(node)
         def_node_matcher :redundant_condition_inverted?, <<~RUBY
           (if (send _ #{COMPARISON_OPERATOR_MATCHER} _) false true)
         RUBY

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

@@ -53,10 +53,12 @@ module RuboCop
           end
         end
 
+        # @!method exploded?(node)
         def_node_matcher :exploded?, <<~PATTERN
           (send nil? ${:raise :fail} (const {nil? cbase} :RuntimeError) $_)
         PATTERN
 
+        # @!method compact?(node)
         def_node_matcher :compact?, <<~PATTERN
           (send nil? {:raise :fail} $(send (const {nil? cbase} :RuntimeError) :new $_))
         PATTERN

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

@@ -38,6 +38,7 @@ module RuboCop
 
         MSG = 'Use `%<good>s` instead of `%<bad>s`.'
 
+        # @!method redundant_fetch_block_candidate?(node)
         def_node_matcher :redundant_fetch_block_candidate?, <<~PATTERN
           (block
             $(send _ :fetch _)
@@ -78,6 +79,7 @@ module RuboCop
             rails_cache?(send.receiver)
         end
 
+        # @!method rails_cache?(node)
         def_node_matcher :rails_cache?, <<~PATTERN
           (send (const _ :Rails) :cache)
         PATTERN

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

@@ -30,6 +30,7 @@ module RuboCop
         MSG = 'Redundant `.rb` file extension detected.'
         RESTRICT_ON_SEND = %i[require require_relative].freeze
 
+        # @!method require_call?(node)
         def_node_matcher :require_call?, <<~PATTERN
           (send nil? {:require :require_relative} $str_type?)
         PATTERN

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

@@ -53,6 +53,7 @@ module RuboCop
           end
         end
 
+        # @!method operation_produces_immutable_object?(node)
         def_node_matcher :operation_produces_immutable_object?, <<~PATTERN
           {
             (begin (send {float int} {:+ :- :* :** :/ :% :<<} _))

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

@@ -17,11 +17,20 @@ module RuboCop
         include Parentheses
         extend AutoCorrector
 
+        # @!method square_brackets?(node)
         def_node_matcher :square_brackets?,
                          '(send {(send _recv _msg) str array hash} :[] ...)'
+
+        # @!method range_end?(node)
         def_node_matcher :range_end?, '^^{irange erange}'
+
+        # @!method method_node_and_args(node)
         def_node_matcher :method_node_and_args, '$(call _recv _msg $...)'
+
+        # @!method rescue?(node)
         def_node_matcher :rescue?, '{^resbody ^^resbody}'
+
+        # @!method arg_in_call_with_block?(node)
         def_node_matcher :arg_in_call_with_block?,
                          '^^(block (send _ _ equal?(%0) ...) ...)'
 
@@ -109,6 +118,7 @@ module RuboCop
           check_send(begin_node, node) if node.call_type?
         end
 
+        # @!method interpolation?(node)
         def_node_matcher :interpolation?, '[^begin ^^dstr]'
 
         def check_send(begin_node, node)
@@ -220,14 +230,17 @@ module RuboCop
             first_yield_argument?(node)
         end
 
+        # @!method first_send_argument?(node)
         def_node_matcher :first_send_argument?, <<~PATTERN
           ^(send _ _ equal?(%0) ...)
         PATTERN
 
+        # @!method first_super_argument?(node)
         def_node_matcher :first_super_argument?, <<~PATTERN
           ^(super equal?(%0) ...)
         PATTERN
 
+        # @!method first_yield_argument?(node)
         def_node_matcher :first_yield_argument?, <<~PATTERN
           ^(yield equal?(%0) ...)
         PATTERN

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

@@ -71,6 +71,10 @@ module RuboCop
           elsif hash_without_braces?(return_node.first_argument)
             add_braces(corrector, return_node.first_argument)
           end
+          if return_node.splat_argument?
+            first_argument = return_node.first_argument
+            corrector.replace(first_argument, first_argument.source.gsub(/\A\*/, ''))
+          end
 
           keyword = range_with_surrounding_space(range: return_node.loc.keyword,
                                                  side: :right)

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

@@ -11,7 +11,7 @@ module RuboCop
       #   presence of a method name clash with an argument or a local
       #   variable.
       #
-      # * Calling an attribute writer to prevent an local variable assignment.
+      # * Calling an attribute writer to prevent a local variable assignment.
       #
       # Note, with using explicit self you can only send messages with public or
       # protected scope, you cannot send private messages this way.
@@ -144,8 +144,12 @@ module RuboCop
         end
 
         def on_argument(node)
-          name, = *node
-          @local_variables_scopes[node] << name
+          if node.mlhs_type?
+            on_args(node)
+          else
+            name, = *node
+            @local_variables_scopes[node] << name
+          end
         end
 
         def allow_self(node)

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

@@ -82,6 +82,7 @@ module RuboCop
           METHODS_RETURNING_SELF.include?(method_name)
         end
 
+        # @!method redundant_self_assignment?(node, method_name)
         def_node_matcher :redundant_self_assignment?, <<~PATTERN
           (send
             (self) _
@@ -91,6 +92,7 @@ module RuboCop
               ...))
         PATTERN
 
+        # @!method redundant_nonself_assignment?(node, receiver, method_name)
         def_node_matcher :redundant_nonself_assignment?, <<~PATTERN
           (send
             %1 _

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

@@ -58,6 +58,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[sort sort_by].freeze
 
+        # @!method redundant_sort?(node)
         def_node_matcher :redundant_sort?, <<~MATCHER
           {
             (send $(send _ $:sort ...) ${:last :first})

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

@@ -21,6 +21,7 @@ module RuboCop
 
         MSG = 'Use `sort` instead of `sort_by { |%<var>s| %<var>s }`.'
 
+        # @!method redundant_sort_by(node)
         def_node_matcher :redundant_sort_by, <<~PATTERN
           (block $(send _ :sort_by) (args (arg $_x)) (lvar _x))
         PATTERN

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

@@ -150,7 +150,7 @@ module RuboCop
 
         def preferred_delimiters
           config.for_cop('Style/PercentLiteralDelimiters') \
-            ['PreferredDelimiters']['%r'].split(//)
+            ['PreferredDelimiters']['%r'].chars
         end
 
         def correct_delimiters(node, corrector)

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

@@ -39,23 +39,23 @@ module RuboCop
       #   rescue SomeException
       #     handle_error
       #   end
-      class RescueModifier < Cop
+      class RescueModifier < Base
         include Alignment
+        include RangeHelp
         include RescueNode
+        extend AutoCorrector
 
         MSG = 'Avoid using `rescue` in its modifier form.'
 
         def on_resbody(node)
           return unless rescue_modifier?(node)
 
-          add_offense(node.parent)
-        end
+          rescue_node = node.parent
+          add_offense(rescue_node) do |corrector|
+            parenthesized = parenthesized?(rescue_node)
 
-        def autocorrect(node)
-          parenthesized = parenthesized?(node)
-          lambda do |corrector|
-            corrector.replace(node, corrected_block(node, parenthesized))
-            ParenthesesCorrector.correct(corrector, node.parent) if parenthesized
+            correct_rescue_block(corrector, rescue_node, parenthesized)
+            ParenthesesCorrector.correct(corrector, rescue_node.parent) if parenthesized
           end
         end
 
@@ -65,17 +65,20 @@ module RuboCop
           node.parent && parentheses?(node.parent)
         end
 
-        def corrected_block(node, parenthesized)
+        def correct_rescue_block(corrector, node, parenthesized)
           operation, rescue_modifier, = *node
           *_, rescue_args = *rescue_modifier
 
           node_indentation, node_offset = indentation_and_offset(node, parenthesized)
 
-          "begin\n" \
-            "#{operation.source.gsub(/^/, node_indentation)}" \
-            "\n#{node_offset}rescue\n" \
-            "#{rescue_args.source.gsub(/^/, node_indentation)}" \
-            "\n#{node_offset}end"
+          corrector.remove(range_between(operation.source_range.end_pos, node.source_range.end_pos))
+          corrector.insert_before(operation, "begin\n#{node_indentation}")
+          corrector.insert_after(operation, <<~RESCUE_CLAUSE.chop)
+
+            #{node_offset}rescue
+            #{node_indentation}#{rescue_args.source}
+            #{node_offset}end
+          RESCUE_CLAUSE
         end
 
         def indentation_and_offset(node, parenthesized)