rubocop 1.10.0 → 1.11.0

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

@@ -15,7 +15,7 @@ module RuboCop
       end
 
       def delimiters
-        preferred_delimiters[type].split(//)
+        preferred_delimiters[type].split('')
       end
 
       private

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

@@ -8,6 +8,7 @@ module RuboCop
 
       private
 
+      # @!method rational_literal?(node)
       def_node_matcher :rational_literal?, <<~PATTERN
         (send
           (int _) :/

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

@@ -10,8 +10,13 @@ module RuboCop
 
       private
 
+      # @!method empty_condition?(node)
       def_node_matcher :empty_condition?, '(begin)'
+
+      # @!method setter_method?(node)
       def_node_matcher :setter_method?, '[(send ...) setter_method?]'
+
+      # @!method safe_assignment?(node)
       def_node_matcher :safe_assignment?,
                        '(begin {equals_asgn? #setter_method?})'
 

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

@@ -28,6 +28,7 @@ module RuboCop
         end || right.last
       end
 
+      # @!method visibility_block?(node)
       def_node_matcher :visibility_block?, <<~PATTERN
         (send nil? { :private :protected :public })
       PATTERN

data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb

@@ -22,6 +22,7 @@ module RuboCop
         OP_LIKE_METHODS = %i[eql? equal?].freeze
         EXCLUDED = %i[+@ -@ [] []= << === ` =~].freeze
 
+        # @!method op_method_candidate?(node)
         def_node_matcher :op_method_candidate?, <<~PATTERN
           (def [#op_method? $_] (args $(arg [!:other !:_other])) _)
         PATTERN

data/lib/rubocop/cop/naming/constant_name.rb

@@ -23,6 +23,7 @@ module RuboCop
         # than just standard ASCII characters
         SNAKE_CASE = /^[[:digit:][:upper:]_]+$/.freeze
 
+        # @!method class_or_struct_return_method?(node)
         def_node_matcher :class_or_struct_return_method?, <<~PATTERN
           (send
             (const _ {:Class :Struct}) :new
@@ -64,6 +65,7 @@ module RuboCop
             (node.receiver.nil? || !literal_receiver?(node))
         end
 
+        # @!method literal_receiver?(node)
         def_node_matcher :literal_receiver?, <<~PATTERN
           {(send literal? ...)
            (send (begin literal?) ...)}

data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb

@@ -148,6 +148,7 @@ module RuboCop
           'with `_`. Use `@%<suggested_var>s` instead.'
         DYNAMIC_DEFINE_METHODS = %i[define_method define_singleton_method].to_set.freeze
 
+        # @!method method_definition?(node)
         def_node_matcher :method_definition?, <<~PATTERN
           ${
             (block (send _ %DYNAMIC_DEFINE_METHODS ({sym str} $_)) ...)
@@ -179,6 +180,7 @@ module RuboCop
         end
         # rubocop:enable Metrics/AbcSize
 
+        # @!method defined_memoized?(node, ivar)
         def_node_matcher :defined_memoized?, <<~PATTERN
           (begin
             (if (defined $(ivar %1)) (return $(ivar %1)) nil?)

data/lib/rubocop/cop/naming/method_name.rb

@@ -35,7 +35,10 @@ module RuboCop
 
         MSG = 'Use %<style>s for method names.'
 
+        # @!method sym_name(node)
         def_node_matcher :sym_name, '(sym $_name)'
+
+        # @!method str_name(node)
         def_node_matcher :str_name, '(str $_name)'
 
         def on_send(node)

data/lib/rubocop/cop/naming/predicate_name.rb

@@ -30,6 +30,7 @@ module RuboCop
       class PredicateName < Base
         include AllowedMethods
 
+        # @!method dynamic_method_define(node)
         def_node_matcher :dynamic_method_define, <<~PATTERN
           (send nil? #method_definition_macros
             (sym $_)

data/lib/rubocop/cop/security/eval.rb

@@ -15,6 +15,7 @@ module RuboCop
         MSG = 'The use of `eval` is a serious security risk.'
         RESTRICT_ON_SEND = %i[eval].freeze
 
+        # @!method eval?(node)
         def_node_matcher :eval?, <<~PATTERN
           (send {nil? (send nil? :binding)} :eval $!str ...)
         PATTERN

data/lib/rubocop/cop/security/json_load.rb

@@ -28,6 +28,7 @@ module RuboCop
         MSG = 'Prefer `JSON.parse` over `JSON.%<method>s`.'
         RESTRICT_ON_SEND = %i[load restore].freeze
 
+        # @!method json_load(node)
         def_node_matcher :json_load, <<~PATTERN
           (send (const {nil? cbase} :JSON) ${:load :restore} ...)
         PATTERN

data/lib/rubocop/cop/security/marshal_load.rb

@@ -22,6 +22,7 @@ module RuboCop
         MSG = 'Avoid using `Marshal.%<method>s`.'
         RESTRICT_ON_SEND = %i[load restore].freeze
 
+        # @!method marshal_load(node)
         def_node_matcher :marshal_load, <<~PATTERN
           (send (const {nil? cbase} :Marshal) ${:load :restore}
           !(send (const {nil? cbase} :Marshal) :dump ...))

data/lib/rubocop/cop/security/open.rb

@@ -24,6 +24,7 @@ module RuboCop
         MSG = 'The use of `%<receiver>sopen` is a serious security risk.'
         RESTRICT_ON_SEND = %i[open].freeze
 
+        # @!method open?(node)
         def_node_matcher :open?, <<~PATTERN
           (send ${nil? (const {nil? cbase} :URI)} :open $!str ...)
         PATTERN

data/lib/rubocop/cop/security/yaml_load.rb

@@ -21,6 +21,7 @@ module RuboCop
         MSG = 'Prefer using `YAML.safe_load` over `YAML.load`.'
         RESTRICT_ON_SEND = %i[load].freeze
 
+        # @!method yaml_load(node)
         def_node_matcher :yaml_load, <<~PATTERN
           (send (const {nil? cbase} :YAML) :load ...)
         PATTERN

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

@@ -77,6 +77,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[private protected public module_function].freeze
 
+        # @!method access_modifier_with_symbol?(node)
         def_node_matcher :access_modifier_with_symbol?, <<~PATTERN
           (send nil? {:private :protected :public} (sym _))
         PATTERN

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

@@ -145,6 +145,7 @@ module RuboCop
           corrector.replace(node.old_identifier, node.old_identifier.source[1..-1])
         end
 
+        # @!method identifier(node)
         def_node_matcher :identifier, <<~PATTERN
           (sym $_)
         PATTERN

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

@@ -47,14 +47,17 @@ module RuboCop
 
         MSG = 'Use arguments forwarding.'
 
+        # @!method use_rest_arguments?(node)
         def_node_matcher :use_rest_arguments?, <<~PATTERN
           (args (restarg $_) $...)
         PATTERN
 
+        # @!method only_rest_arguments?(node, name)
         def_node_matcher :only_rest_arguments?, <<~PATTERN
           (send _ _ (splat (lvar %1)))
         PATTERN
 
+        # @!method forwarding_method_arguments?(node, rest_name, block_name, kwargs_name)
         def_node_matcher :forwarding_method_arguments?, <<~PATTERN
           {
             (send _ _

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

@@ -26,10 +26,12 @@ module RuboCop
         SPLAT_MSG = 'Use `Array(%<arg>s)` instead of `[*%<arg>s]`.'
         CHECK_MSG = 'Use `Array(%<arg>s)` instead of explicit `Array` check.'
 
+        # @!method array_splat?(node)
         def_node_matcher :array_splat?, <<~PATTERN
           (array (splat $_))
         PATTERN
 
+        # @!method unless_array?(node)
         def_node_matcher :unless_array?, <<~PATTERN
           (if
             (send

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

@@ -23,6 +23,7 @@ module RuboCop
         MSG = 'Favor `Array#join` over `Array#*`.'
         RESTRICT_ON_SEND = %i[*].freeze
 
+        # @!method join_candidate?(node)
         def_node_matcher :join_candidate?, '(send $array :* $str)'
 
         def on_send(node)

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

@@ -62,6 +62,7 @@ module RuboCop
           end
         end
 
+        # @!method class_eval?(node)
         def_node_matcher :class_eval?, <<~PATTERN
           (block (send _ {:class_eval :module_eval}) ...)
         PATTERN

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

@@ -35,6 +35,7 @@ module RuboCop
         MSG = 'Avoid the use of the case equality operator `===`.'
         RESTRICT_ON_SEND = %i[===].freeze
 
+        # @!method case_equality?(node)
         def_node_matcher :case_equality?, '(send $#const? :=== $_)'
 
         def on_send(node)
@@ -64,7 +65,7 @@ module RuboCop
             # The automatic correction from `a === b` to `a.match?(b)` needs to
             # consider `Regexp.last_match?`, `$~`, `$1`, and etc.
             # This correction is expected to be supported by `Performance/Regexp` cop.
-            # See: https://github.com/rubocop-hq/rubocop-performance/issues/152
+            # See: https://github.com/rubocop/rubocop-performance/issues/152
             #
             # So here is noop.
           when :begin

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

@@ -25,6 +25,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[== equal? eql?].freeze
 
+        # @!method class_comparison_candidate?(node)
         def_node_matcher :class_comparison_candidate?, <<~PATTERN
           (send
             {$(send _ :class) (send $(send _ :class) :name)}

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

@@ -35,6 +35,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[reject reject! select select!].freeze
 
+        # @!method reject_method?(node)
         def_node_matcher :reject_method?, <<~PATTERN
           (block
             (send
@@ -44,6 +45,7 @@ module RuboCop
               $(lvar _) :nil?))
         PATTERN
 
+        # @!method select_method?(node)
         def_node_matcher :select_method?, <<~PATTERN
           (block
             (send

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

@@ -22,6 +22,7 @@ module RuboCop
 
         MSG = 'Do not use `::` for method calls.'
 
+        # @!method java_type_node?(node)
         def_node_matcher :java_type_node?, <<~PATTERN
           (send
             (const nil? :Java) _)

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

@@ -165,7 +165,7 @@ module RuboCop
         end
 
         def preferred_delimiter
-          (command_delimiter || default_delimiter).split(//)
+          (command_delimiter || default_delimiter).split('')
         end
 
         def command_delimiter

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

@@ -231,6 +231,7 @@ module RuboCop
 
         # The shovel operator `<<` does not have its own type. It is a `send`
         # type.
+        # @!method assignment_type?(node)
         def_node_matcher :assignment_type?, <<~PATTERN
           {
             #{ASSIGNMENT_TYPES.join(' ')}
@@ -300,6 +301,7 @@ module RuboCop
           style == :assign_inside_condition && assignment_rhs_exist?(node)
         end
 
+        # @!method candidate_condition?(node)
         def_node_matcher :candidate_condition?, '[{if case} !#allowed_ternary?]'
 
         def allowed_ternary?(assignment)

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

@@ -92,6 +92,7 @@ module RuboCop
           end
         end
 
+        # @!method visibility_declaration_for?(node, const_name)
         def_node_matcher :visibility_declaration_for?, <<~PATTERN
           (send nil? {:public_constant :private_constant} ({sym str} #match_name?(%1)))
         PATTERN

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

@@ -47,14 +47,17 @@ module RuboCop
         CLASS_MSG = 'Prefer Time over DateTime.'
         COERCION_MSG = 'Do not use #to_datetime.'
 
+        # @!method date_time?(node)
         def_node_matcher :date_time?, <<~PATTERN
           (send (const {nil? (cbase)} :DateTime) ...)
         PATTERN
 
+        # @!method historic_date?(node)
         def_node_matcher :historic_date?, <<~PATTERN
           (send _ _ _ (const (const {nil? (cbase)} :Date) _))
         PATTERN
 
+        # @!method to_datetime?(node)
         def_node_matcher :to_datetime?, <<~PATTERN
           (send _ :to_datetime)
         PATTERN

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

@@ -22,6 +22,7 @@ module RuboCop
         MSG = "Use `__dir__` to get an absolute path to the current file's directory."
         RESTRICT_ON_SEND = %i[expand_path dirname].freeze
 
+        # @!method dir_replacement?(node)
         def_node_matcher :dir_replacement?, <<~PATTERN
           {(send (const {nil? cbase} :File) :expand_path (send (const {nil? cbase} :File) :dirname  #file_keyword?))
            (send (const {nil? cbase} :File) :dirname     (send (const {nil? cbase} :File) :realpath #file_keyword?))}

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

@@ -65,8 +65,13 @@ module RuboCop
 
         MSG = 'Missing top-level %<type>s documentation comment.'
 
+        # @!method constant_definition?(node)
         def_node_matcher :constant_definition?, '{class module casgn}'
+
+        # @!method outer_module(node)
         def_node_search :outer_module, '(const (const nil? _) _)'
+
+        # @!method constant_visibility_declaration?(node)
         def_node_matcher :constant_visibility_declaration?, <<~PATTERN
           (send nil? {:public_constant :private_constant} ({sym str} _))
         PATTERN

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

@@ -97,6 +97,7 @@ module RuboCop
 
         MSG = 'Missing method documentation comment.'
 
+        # @!method module_function_node?(node)
         def_node_matcher :module_function_node?, <<~PATTERN
           (send nil? :module_function ...)
         PATTERN

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

@@ -39,6 +39,7 @@ module RuboCop
         MSG = 'Avoid the use of double negation (`!!`).'
         RESTRICT_ON_SEND = %i[!].freeze
 
+        # @!method double_negative?(node)
         def_node_matcher :double_negative?, '(send (send _ :!) :!)'
 
         def on_send(node)

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

@@ -46,6 +46,7 @@ module RuboCop
 
         private
 
+        # @!method offending_each_range(node)
         def_node_matcher :offending_each_range, <<~PATTERN
           (block (send (begin (${irange erange} (int $_) (int $_))) :each) (args) ...)
         PATTERN

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

@@ -23,6 +23,7 @@ module RuboCop
         MSG = 'Use `each_with_object` instead of `%<method>s`.'
         METHODS = %i[inject reduce].freeze
 
+        # @!method each_with_object_candidate?(node)
         def_node_matcher :each_with_object_candidate?, <<~PATTERN
           (block $(send _ {:inject :reduce} _) $_ $_)
         PATTERN

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

@@ -27,11 +27,20 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[new].freeze
 
+        # @!method array_node(node)
         def_node_matcher :array_node, '(send (const {nil? cbase} :Array) :new)'
+
+        # @!method hash_node(node)
         def_node_matcher :hash_node, '(send (const {nil? cbase} :Hash) :new)'
+
+        # @!method str_node(node)
         def_node_matcher :str_node, '(send (const {nil? cbase} :String) :new)'
+
+        # @!method array_with_block(node)
         def_node_matcher :array_with_block,
                          '(block (send (const {nil? cbase} :Array) :new) args _)'
+
+        # @!method hash_with_block(node)
         def_node_matcher :hash_with_block, <<~PATTERN
           {
             (block (send (const {nil? cbase} :Hash) :new) args _)

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

@@ -11,6 +11,7 @@ module RuboCop
       # Other method definition types are not considered by this cop.
       #
       # The supported styles are:
+      #
       # * allow_single_line (default) - only single line endless method definitions are allowed.
       # * allow_always - all endless method definitions are allowed.
       # * disallow - all endless method definitions are disallowed.

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

@@ -65,10 +65,12 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[eval class_eval module_eval instance_eval].freeze
 
+        # @!method valid_eval_receiver?(node)
         def_node_matcher :valid_eval_receiver?, <<~PATTERN
           { nil? (const {nil? cbase} :Kernel) }
         PATTERN
 
+        # @!method line_with_offset?(node, sign, num)
         def_node_matcher :line_with_offset?, <<~PATTERN
           {
             (send #special_line_keyword? %1 (int %2))

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

@@ -21,6 +21,7 @@ module RuboCop
         MSG = 'Replace with `Integer#%<method>s?`.'
         RESTRICT_ON_SEND = %i[== !=].freeze
 
+        # @!method even_odd_candidate?(node)
         def_node_matcher :even_odd_candidate?, <<~PATTERN
           (send
             {(send $_ :% (int 2))