rubocop 1.10.0 → 1.11.0

data/lib/rubocop/cop/lint/non_local_exit_from_iterator.rb

@@ -73,7 +73,10 @@ module RuboCop
           !return_node.children.empty?
         end
 
+        # @!method chained_send?(node)
         def_node_matcher :chained_send?, '(send !nil? ...)'
+
+        # @!method define_method?(node)
         def_node_matcher :define_method?, <<~PATTERN
           (send _ {:define_method :define_singleton_method} _)
         PATTERN

data/lib/rubocop/cop/lint/number_conversion.rb

@@ -62,10 +62,12 @@ module RuboCop
               '%<corrected_method>s.'
         METHODS = CONVERSION_METHOD_CLASS_MAPPING.keys.map(&:inspect).join(' ')
 
+        # @!method to_method(node)
         def_node_matcher :to_method, <<~PATTERN
           (send $_ ${#{METHODS}})
         PATTERN
 
+        # @!method to_method_symbol(node)
         def_node_matcher :to_method_symbol, <<~PATTERN
           {(send _ $_ ${(sym ${#{METHODS}})} ...)
            (send _ $_ ${(block_pass (sym ${#{METHODS}}))} ...)}

data/lib/rubocop/cop/lint/raise_exception.rb

@@ -33,10 +33,12 @@ module RuboCop
         MSG = 'Use `StandardError` over `Exception`.'
         RESTRICT_ON_SEND = %i[raise fail].freeze
 
+        # @!method exception?(node)
         def_node_matcher :exception?, <<~PATTERN
           (send nil? {:raise :fail} $(const ${cbase nil?} :Exception) ... )
         PATTERN
 
+        # @!method exception_new_with_message?(node)
         def_node_matcher :exception_new_with_message?, <<~PATTERN
           (send nil? {:raise :fail}
             (send $(const ${cbase nil?} :Exception) :new ... ))

data/lib/rubocop/cop/lint/rand_one.rb

@@ -25,6 +25,7 @@ module RuboCop
               'Perhaps you meant `rand(2)` or `rand`?'
         RESTRICT_ON_SEND = %i[rand].freeze
 
+        # @!method rand_one?(node)
         def_node_matcher :rand_one?, <<~PATTERN
           (send {(const {nil? cbase} :Kernel) nil?} :rand {(int {-1 1}) (float {-1.0 1.0})})
         PATTERN

data/lib/rubocop/cop/lint/redundant_require_statement.rb

@@ -28,6 +28,7 @@ module RuboCop
         MSG = 'Remove unnecessary `require` statement.'
         RESTRICT_ON_SEND = %i[require].freeze
 
+        # @!method unnecessary_require_statement?(node)
         def_node_matcher :unnecessary_require_statement?, <<~PATTERN
           (send nil? :require
             (str {"enumerator" "rational" "complex" "thread"}))

data/lib/rubocop/cop/lint/redundant_safe_navigation.rb

@@ -43,6 +43,7 @@ module RuboCop
 
         NIL_SPECIFIC_METHODS = (nil.methods - Object.new.methods).to_set.freeze
 
+        # @!method respond_to_nil_specific_method?(node)
         def_node_matcher :respond_to_nil_specific_method?, <<~PATTERN
           (csend _ :respond_to? (sym %NIL_SPECIFIC_METHODS))
         PATTERN

data/lib/rubocop/cop/lint/redundant_splat_expansion.rb

@@ -79,6 +79,7 @@ module RuboCop
         PERCENT_CAPITAL_I = '%I'
         ASSIGNMENT_TYPES = %i[lvasgn ivasgn cvasgn gvasgn].freeze
 
+        # @!method array_new?(node)
         def_node_matcher :array_new?, <<~PATTERN
           {
             $(send (const {nil? cbase} :Array) :new ...)
@@ -86,6 +87,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method literal_expansion(node)
         def_node_matcher :literal_expansion, <<~PATTERN
           (splat {$({str dstr int float array} ...) (block $#array_new? ...) $#array_new?} ...)
         PATTERN

data/lib/rubocop/cop/lint/redundant_string_coercion.rb

@@ -25,6 +25,7 @@ module RuboCop
         MSG_SELF = 'Use `self` instead of `Object#to_s` in ' \
                    'interpolation.'
 
+        # @!method to_s_without_args?(node)
         def_node_matcher :to_s_without_args?, '(send _ :to_s)'
 
         def on_interpolation(begin_node)

data/lib/rubocop/cop/lint/redundant_with_index.rb

@@ -33,6 +33,7 @@ module RuboCop
         MSG_EACH_WITH_INDEX = 'Use `each` instead of `each_with_index`.'
         MSG_WITH_INDEX = 'Remove redundant `with_index`.'
 
+        # @!method redundant_with_index?(node)
         def_node_matcher :redundant_with_index?, <<~PATTERN
           (block
             $(send

data/lib/rubocop/cop/lint/redundant_with_object.rb

@@ -34,6 +34,7 @@ module RuboCop
 
         MSG_WITH_OBJECT = 'Remove redundant `with_object`.'
 
+        # @!method redundant_with_object?(node)
         def_node_matcher :redundant_with_object?, <<~PATTERN
           (block
             $(send _ {:each_with_object :with_object}

data/lib/rubocop/cop/lint/safe_navigation_chain.rb

@@ -29,6 +29,7 @@ module RuboCop
         MSG = 'Do not chain ordinary method call' \
               ' after safe navigation operator.'
 
+        # @!method bad_method?(node)
         def_node_matcher :bad_method?, <<~PATTERN
           {
             (send $(csend ...) $_ ...)

data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb

@@ -25,6 +25,7 @@ module RuboCop
         MSG = 'Avoid calling `empty?` with the safe navigation operator ' \
           'in conditionals.'
 
+        # @!method safe_navigation_empty_in_conditional?(node)
         def_node_matcher :safe_navigation_empty_in_conditional?, <<~PATTERN
           (if (csend (send ...) :empty?) ...)
         PATTERN

data/lib/rubocop/cop/lint/send_with_mixin_argument.rb

@@ -43,6 +43,7 @@ module RuboCop
         SEND_METHODS = %i[send public_send __send__].freeze
         RESTRICT_ON_SEND = SEND_METHODS
 
+        # @!method send_with_mixin_argument?(node)
         def_node_matcher :send_with_mixin_argument?, <<~PATTERN
           (send
             (const _ _) {:#{SEND_METHODS.join(' :')}}

data/lib/rubocop/cop/lint/shadowed_argument.rb

@@ -67,6 +67,7 @@ module RuboCop
         MSG = 'Argument `%<argument>s` was shadowed by a local variable ' \
               'before it was used.'
 
+        # @!method uses_var?(node)
         def_node_search :uses_var?, '(lvar %)'
 
         def self.joining_forces

data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb

@@ -42,6 +42,7 @@ module RuboCop
       class ShadowingOuterLocalVariable < Base
         MSG = 'Shadowing outer local variable - `%<variable>s`.'
 
+        # @!method ractor_block?(node)
         def_node_matcher :ractor_block?, <<~PATTERN
           (block (send (const nil? :Ractor) :new ...) ...)
         PATTERN

data/lib/rubocop/cop/lint/struct_new_override.rb

@@ -29,6 +29,7 @@ module RuboCop
         STRUCT_METHOD_NAMES = Struct.instance_methods
         STRUCT_MEMBER_NAME_TYPES = %i[sym str].freeze
 
+        # @!method struct_new(node)
         def_node_matcher :struct_new, <<~PATTERN
           (send
             (const ${nil? cbase} :Struct) :new ...)

data/lib/rubocop/cop/lint/to_enum_arguments.rb

@@ -23,14 +23,17 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[to_enum enum_for].freeze
 
+        # @!method enum_conversion_call?(node)
         def_node_matcher :enum_conversion_call?, <<~PATTERN
           (send {nil? self} {:to_enum :enum_for} $_ $...)
         PATTERN
 
+        # @!method method_name?(node, name)
         def_node_matcher :method_name?, <<~PATTERN
           {(send nil? {:__method__ :__callee__}) (sym %1)}
         PATTERN
 
+        # @!method passing_keyword_arg?(node, name)
         def_node_matcher :passing_keyword_arg?, <<~PATTERN
           (pair (sym %1) (lvar %1))
         PATTERN

data/lib/rubocop/cop/lint/unified_integer.rb

@@ -22,6 +22,7 @@ module RuboCop
 
         MSG = 'Use `Integer` instead of `%<klass>s`.'
 
+        # @!method fixnum_or_bignum_const(node)
         def_node_matcher :fixnum_or_bignum_const, <<~PATTERN
           (:const {nil? (:cbase)} ${:Fixnum :Bignum})
         PATTERN

data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb

@@ -66,6 +66,7 @@ module RuboCop
         MSG = 'Ensure the accumulator `%<accum>s` will be modified by `%<method>s`.'
         MSG_INDEX = 'Do not return an element of the accumulator in `%<method>s`.'
 
+        # @!method reduce_with_block?(node)
         def_node_matcher :reduce_with_block?, <<~PATTERN
           {
             (block (send _recv {:reduce :inject} ...) args ...)
@@ -73,10 +74,12 @@ module RuboCop
           }
         PATTERN
 
+        # @!method accumulator_index?(node, accumulator_name)
         def_node_matcher :accumulator_index?, <<~PATTERN
           (send (lvar %1) {:[] :[]=} ...)
         PATTERN
 
+        # @!method element_modified?(node, element_name)
         def_node_search :element_modified?, <<~PATTERN
           {
             (send _receiver !{:[] :[]=} <`(lvar %1) `_ ...>)               # method(el, ...)
@@ -86,6 +89,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method lvar_used?(node, name)
         def_node_matcher :lvar_used?, <<~PATTERN
           {
             (lvar %1)
@@ -96,6 +100,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method expression_values(node)
         def_node_search :expression_values, <<~PATTERN
           {
             (%RuboCop::AST::Node::VARIABLES $_)

data/lib/rubocop/cop/lint/unreachable_code.rb

@@ -51,6 +51,7 @@ module RuboCop
 
         private
 
+        # @!method flow_command?(node)
         def_node_matcher :flow_command?, <<~PATTERN
           {
             return next break retry redo

data/lib/rubocop/cop/lint/unreachable_loop.rb

@@ -131,6 +131,7 @@ module RuboCop
           end
         end
 
+        # @!method break_command?(node)
         def_node_matcher :break_command?, <<~PATTERN
           {
             return break

data/lib/rubocop/cop/lint/unused_method_argument.rb

@@ -62,6 +62,7 @@ module RuboCop
         include UnusedArgument
         extend AutoCorrector
 
+        # @!method not_implemented?(node)
         def_node_matcher :not_implemented?, <<~PATTERN
           {(send nil? :raise (const {nil? cbase} :NotImplementedError))
            (send nil? :fail ...)}

data/lib/rubocop/cop/lint/uri_escape_unescape.rb

@@ -47,6 +47,7 @@ module RuboCop
         METHOD_NAMES = %i[escape encode unescape decode].freeze
         RESTRICT_ON_SEND = METHOD_NAMES
 
+        # @!method uri_escape_unescape?(node)
         def_node_matcher :uri_escape_unescape?, <<~PATTERN
           (send
             (const ${nil? cbase} :URI) ${:#{METHOD_NAMES.join(' :')}}

data/lib/rubocop/cop/lint/useless_access_modifier.rb

@@ -150,18 +150,22 @@ module RuboCop
           corrector.remove(range)
         end
 
+        # @!method static_method_definition?(node)
         def_node_matcher :static_method_definition?, <<~PATTERN
           {def (send nil? {:attr :attr_reader :attr_writer :attr_accessor} ...)}
         PATTERN
 
+        # @!method dynamic_method_definition?(node)
         def_node_matcher :dynamic_method_definition?, <<~PATTERN
           {(send nil? :define_method ...) (block (send nil? :define_method ...) ...)}
         PATTERN
 
+        # @!method class_or_instance_eval?(node)
         def_node_matcher :class_or_instance_eval?, <<~PATTERN
           (block (send _ {:class_eval :instance_eval}) ...)
         PATTERN
 
+        # @!method class_or_module_or_struct_new_call?(node)
         def_node_matcher :class_or_module_or_struct_new_call?, <<~PATTERN
           (block (send (const {nil? cbase} {:Class :Module :Struct}) :new ...) ...)
         PATTERN

data/lib/rubocop/cop/lint/useless_setter_call.rb

@@ -56,6 +56,7 @@ module RuboCop
 
         private
 
+        # @!method setter_call_to_local_variable?(node)
         def_node_matcher :setter_call_to_local_variable?, <<~PATTERN
           [(send (lvar _) ...) setter_method?]
         PATTERN

data/lib/rubocop/cop/lint/useless_times.rb

@@ -27,14 +27,17 @@ module RuboCop
         MSG = 'Useless call to `%<count>i.times` detected.'
         RESTRICT_ON_SEND = %i[times].freeze
 
+        # @!method times_call?(node)
         def_node_matcher :times_call?, <<~PATTERN
           (send (int $_) :times (block-pass (sym $_))?)
         PATTERN
 
+        # @!method block_arg(node)
         def_node_matcher :block_arg, <<~PATTERN
           (block _ (args (arg $_)) ...)
         PATTERN
 
+        # @!method block_reassigns_arg?(node)
         def_node_search :block_reassigns_arg?, <<~PATTERN
           (lvasgn %)
         PATTERN

data/lib/rubocop/cop/metrics/module_length.rb

@@ -44,6 +44,7 @@ module RuboCop
 
         private
 
+        # @!method module_definition?(node)
         def_node_matcher :module_definition?, <<~PATTERN
           (casgn nil? _ (block (send (const {nil? cbase} :Module) :new) ...))
         PATTERN

data/lib/rubocop/cop/metrics/parameter_lists.rb

@@ -90,6 +90,7 @@ module RuboCop
 
         private
 
+        # @!method argument_to_lambda_or_proc?(node)
         def_node_matcher :argument_to_lambda_or_proc?, <<~PATTERN
           ^lambda_or_proc?
         PATTERN

data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb

@@ -26,10 +26,12 @@ module RuboCop
             return length if @foldable_types.empty?
 
             each_top_level_descendant(@node, @foldable_types) do |descendant|
-              if foldable_node?(descendant)
-                descendant_length = code_length(descendant)
-                length = length - descendant_length + 1
-              end
+              next unless foldable_node?(descendant)
+
+              descendant_length = code_length(descendant)
+              length = length - descendant_length + 1
+              # Subtract 2 length of opening and closing brace if method argument omits hash braces.
+              length -= 2 if descendant.hash_type? && !descendant.braces?
             end
 
             length

data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb

@@ -60,6 +60,7 @@ module RuboCop
 
           private
 
+          # @!method attribute_call?(node)
           def_node_matcher :attribute_call?, <<~PATTERN
             ( {csend send} _receiver _method # and no parameters
             )
@@ -90,6 +91,7 @@ module RuboCop
             end
           end
 
+          # @!method root_node?(node)
           def_node_matcher :root_node?, <<~PATTERN
             { nil? | self               # e.g. receiver of `my_method` or `self.my_attr`
             | lvar | ivar | cvar | gvar # e.g. receiver of `var.my_method`

data/lib/rubocop/cop/mixin/def_node.rb

@@ -25,6 +25,7 @@ module RuboCop
         processed_source[0..index].map(&:strip)
       end
 
+      # @!method non_public_modifier?(node)
       def_node_matcher :non_public_modifier?, <<~PATTERN
         (send nil? {:private :protected} ({def defs} ...))
       PATTERN

data/lib/rubocop/cop/mixin/empty_lines_around_body.rb

@@ -18,7 +18,10 @@ module RuboCop
 
         private
 
+        # @!method constant_definition?(node)
         def_node_matcher :constant_definition?, '{class module}'
+
+        # @!method empty_line_required?(node)
         def_node_matcher :empty_line_required?,
                          '{def defs class module (send nil? {:private :protected :public})}'
 

data/lib/rubocop/cop/mixin/empty_parameter.rb

@@ -8,6 +8,7 @@ module RuboCop
 
       private
 
+      # @!method empty_arguments?(node)
       def_node_matcher :empty_arguments?, <<~PATTERN
         (block _ $(args) _)
       PATTERN

data/lib/rubocop/cop/mixin/enforce_superclass.rb

@@ -13,10 +13,12 @@ module RuboCop
     # @api private
     module EnforceSuperclass
       def self.included(base)
+        # @!method class_definition(node)
         base.def_node_matcher :class_definition, <<~PATTERN
           (class (const _ !:#{base::SUPERCLASS}) #{base::BASE_PATTERN} ...)
         PATTERN
 
+        # @!method class_new_definition(node)
         base.def_node_matcher :class_new_definition, <<~PATTERN
           [!^(casgn {nil? cbase} :#{base::SUPERCLASS} ...)
            !^^(casgn {nil? cbase} :#{base::SUPERCLASS} (block ...))

data/lib/rubocop/cop/mixin/hash_transform_method.rb

@@ -9,6 +9,7 @@ module RuboCop
 
       RESTRICT_ON_SEND = %i[[] to_h].freeze
 
+      # @!method array_receiver?(node)
       def_node_matcher :array_receiver?, <<~PATTERN
         {(array ...) (send _ :each_with_index) (send _ :with_index _ ?) (send _ :zip ...)}
       PATTERN

data/lib/rubocop/cop/mixin/method_complexity.rb

@@ -36,6 +36,7 @@ module RuboCop
 
       private
 
+      # @!method define_method?(node)
       def_node_matcher :define_method?, <<~PATTERN
         (block
          (send nil? :define_method ({sym str} $_))

data/lib/rubocop/cop/mixin/negative_conditional.rb

@@ -12,7 +12,10 @@ module RuboCop
 
       private
 
+      # @!method single_negative?(node)
       def_node_matcher :single_negative?, '(send !(send _ :!) :!)'
+
+      # @!method empty_condition?(node)
       def_node_matcher :empty_condition?, '(begin)'
 
       def check_negative_conditional(node, message:, &block)