rubocop 1.29.1 → 1.36.0

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

@@ -3,19 +3,16 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of `and` and `or`, and suggests using `&&` and
+      # Checks for uses of `and` and `or`, and suggests using `&&` and
       # `||` instead. It can be configured to check only in conditions or in
       # all contexts.
       #
       # @safety
-      #   Auto-correction is unsafe because there is a different operator precedence
+      #   Autocorrection is unsafe because there is a different operator precedence
       #   between logical operators (`&&` and `||`) and semantic operators (`and` and `or`),
       #   and that might change the behavior.
       #
-      # @example EnforcedStyle: always
-      #   # bad
-      #   foo.save and return
-      #
+      # @example EnforcedStyle: conditionals (default)
       #   # bad
       #   if foo and bar
       #   end
@@ -24,10 +21,16 @@ module RuboCop
       #   foo.save && return
       #
       #   # good
+      #   foo.save and return
+      #
+      #   # good
       #   if foo && bar
       #   end
       #
-      # @example EnforcedStyle: conditionals (default)
+      # @example EnforcedStyle: always
+      #   # bad
+      #   foo.save and return
+      #
       #   # bad
       #   if foo and bar
       #   end
@@ -36,9 +39,6 @@ module RuboCop
       #   foo.save && return
       #
       #   # good
-      #   foo.save and return
-      #
-      #   # good
       #   if foo && bar
       #   end
       class AndOr < Base
@@ -111,7 +111,7 @@ module RuboCop
         end
 
         # ! is a special case:
-        # 'x and !obj.method arg' can be auto-corrected if we
+        # 'x and !obj.method arg' can be autocorrected if we
         # recurse down a level and add parens to 'obj.method arg'
         # however, 'not x' also parses as (send x :!)
         def correct_not(node, receiver, corrector)

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

@@ -73,11 +73,11 @@ module RuboCop
           {
             (send _ _
               (splat (lvar %1))
-              (block-pass (lvar %2)))
+              (block-pass {(lvar %2) nil?}))
             (send _ _
               (splat (lvar %1))
               (hash (kwsplat (lvar %3)))
-              (block-pass (lvar %2)))
+              (block-pass {(lvar %2) nil?}))
           }
         PATTERN
 
@@ -133,7 +133,7 @@ module RuboCop
         def register_offense_to_method_definition_arguments(method_definition)
           add_offense(arguments_range(method_definition)) do |corrector|
             arguments_range = range_with_surrounding_space(
-              range: method_definition.arguments.source_range, side: :left
+              method_definition.arguments.source_range, side: :left
             )
             corrector.replace(arguments_range, '(...)')
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of `Array()` instead of explicit `Array` check or `[*var]`.
+      # Enforces the use of `Array()` instead of explicit `Array` check or `[*var]`.
       #
       # The cop is disabled by default due to safety concerns.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of "*" as a substitute for _join_.
+      # Checks for uses of "*" as a substitute for _join_.
       #
       # Not all cases can reliably checked, due to Ruby's dynamic
       # types, so we consider only cases when the first argument is an

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for non-ascii (non-English) characters
+      # Checks for non-ascii (non-English) characters
       # in comments. You could set an array of allowed non-ascii chars in
       # `AllowedChars` attribute (copyright notice "©" by default).
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of Module#attr.
+      # Checks for uses of Module#attr.
       #
       # @example
       #   # bad - creates a single attribute accessor (deprecated in Ruby 1.9)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for cases when you could use a block
+      # Checks for cases when you could use a block
       # accepting version of a method that does automatic
       # resource cleanup.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks if usage of %() or %Q() matches configuration.
+      # Checks if usage of %() or %Q() matches configuration.
       #
       # @example EnforcedStyle: bare_percent (default)
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where `attr_reader` and `attr_writer`
+      # Checks for places where `attr_reader` and `attr_writer`
       # for the same method can be combined into single `attr_accessor`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for uses of block comments (=begin...=end).
+      # Looks for uses of block comments (=begin...=end).
       #
       # @example
       #   # bad

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

@@ -10,7 +10,7 @@ module RuboCop
       # Methods that can be either procedural or functional and cannot be
       # categorised from their usage alone is ignored.
       # `lambda`, `proc`, and `it` are their defaults.
-      # Additional methods can be added to the `IgnoredMethods`.
+      # Additional methods can be added to the `AllowedMethods`.
       #
       # @example EnforcedStyle: line_count_based (default)
       #   # bad - single line block
@@ -66,7 +66,7 @@ module RuboCop
       #     x
       #   }.inspect
       #
-      #   # The AllowBracesOnProceduralOneLiners option is ignored unless the
+      #   # The AllowBracesOnProceduralOneLiners option is allowed unless the
       #   # EnforcedStyle is set to `semantic`. If so:
       #
       #   # If the AllowBracesOnProceduralOneLiners option is unspecified, or
@@ -116,7 +116,7 @@ module RuboCop
       #
       #   # Methods listed in the BracesRequiredMethods list, such as 'sig'
       #   # in this example, will require `{...}` braces. This option takes
-      #   # precedence over all other configurations except IgnoredMethods.
+      #   # precedence over all other configurations except AllowedMethods.
       #
       #   # bad
       #   sig do
@@ -138,7 +138,7 @@ module RuboCop
       #     puts foo
       #   end
       #
-      # @example IgnoredMethods: ['lambda', 'proc', 'it' ] (default)
+      # @example AllowedMethods: ['lambda', 'proc', 'it' ] (default)
       #
       #   # good
       #   foo = lambda do |x|
@@ -149,9 +149,26 @@ module RuboCop
       #     x * 100
       #   end
       #
+      # @example AllowedPatterns: [] (default)
+      #
+      #   # bad
+      #   things.map { |thing|
+      #     something = thing.some_method
+      #     process(something)
+      #   }
+      #
+      # @example AllowedPatterns: [/map/]
+      #
+      #   # good
+      #   things.map { |thing|
+      #     something = thing.some_method
+      #     process(something)
+      #   }
+      #
       class BlockDelimiters < Base
         include ConfigurableEnforcedStyle
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
         include RangeHelp
         extend AutoCorrector
 
@@ -184,6 +201,8 @@ module RuboCop
           end
         end
 
+        alias on_numblock on_block
+
         private
 
         def autocorrect(corrector, node)
@@ -281,7 +300,7 @@ module RuboCop
         def move_comment_before_block(corrector, comment, block_node, closing_brace)
           range = block_node.chained? ? end_of_chain(block_node.parent).source_range : closing_brace
           comment_range = range_between(range.end_pos, comment.loc.expression.end_pos)
-          corrector.remove(range_with_surrounding_space(range: comment_range, side: :right))
+          corrector.remove(range_with_surrounding_space(comment_range, side: :right))
           corrector.insert_after(range, "\n")
 
           corrector.insert_before(block_node, "#{comment.text}\n")
@@ -300,7 +319,7 @@ module RuboCop
 
         def get_blocks(node, &block)
           case node.type
-          when :block
+          when :block, :numblock
             yield node
           when :send
             get_blocks(node.receiver, &block) if node.receiver
@@ -328,12 +347,14 @@ module RuboCop
         end
 
         def special_method?(method_name)
-          ignored_method?(method_name) || braces_required_method?(method_name)
+          allowed_method?(method_name) ||
+            matches_allowed_pattern?(method_name) ||
+            braces_required_method?(method_name)
         end
 
         def special_method_proper_block_style?(node)
           method_name = node.method_name
-          return true if ignored_method?(method_name)
+          return true if allowed_method?(method_name) || matches_allowed_pattern?(method_name)
           return node.braces? if braces_required_method?(method_name)
         end
 

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

@@ -3,10 +3,13 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of the case equality operator(===).
+      # Checks for uses of the case equality operator(===).
       #
       # If `AllowOnConstant` option is enabled, the cop will ignore violations when the receiver of
       # the case equality operator is a constant.
+
+      # If `AllowOnSelfClass` option is enabled, the cop will ignore violations when the receiver of
+      # the case equality operator is `self.class`. Note intermediate variables are not accepted.
       #
       # @example
       #   # bad
@@ -26,6 +29,14 @@ module RuboCop
       #   # good
       #   Array === something
       #
+      # @example AllowOnSelfClass: false (default)
+      #   # bad
+      #   self.class === something
+      #
+      # @example AllowOnSelfClass: true
+      #   # good
+      #   self.class === something
+      #
       class CaseEquality < Base
         extend AutoCorrector
 
@@ -33,7 +44,10 @@ module RuboCop
         RESTRICT_ON_SEND = %i[===].freeze
 
         # @!method case_equality?(node)
-        def_node_matcher :case_equality?, '(send $#const? :=== $_)'
+        def_node_matcher :case_equality?, '(send $#offending_receiver? :=== $_)'
+
+        # @!method self_class?(node)
+        def_node_matcher :self_class?, '(send (self) :class)'
 
         def on_send(node)
           case_equality?(node) do |lhs, rhs|
@@ -48,12 +62,11 @@ module RuboCop
 
         private
 
-        def const?(node)
-          if cop_config.fetch('AllowOnConstant', false)
-            !node&.const_type?
-          else
-            true
-          end
+        def offending_receiver?(node)
+          return false if node&.const_type? && cop_config.fetch('AllowOnConstant', false)
+          return false if self_class?(node) && cop_config.fetch('AllowOnSelfClass', false)
+
+          true
         end
 
         def replacement(lhs, rhs)
@@ -66,12 +79,29 @@ module RuboCop
             #
             # So here is noop.
           when :begin
-            child = lhs.children.first
-            "#{lhs.source}.include?(#{rhs.source})" if child&.range_type?
+            begin_replacement(lhs, rhs)
           when :const
-            "#{rhs.source}.is_a?(#{lhs.source})"
+            const_replacement(lhs, rhs)
+          when :send
+            send_replacement(lhs, rhs)
           end
         end
+
+        def begin_replacement(lhs, rhs)
+          return unless lhs.children.first&.range_type?
+
+          "#{lhs.source}.include?(#{rhs.source})"
+        end
+
+        def const_replacement(lhs, rhs)
+          "#{rhs.source}.is_a?(#{lhs.source})"
+        end
+
+        def send_replacement(lhs, rhs)
+          return unless self_class?(lhs)
+
+          "#{rhs.source}.is_a?(#{lhs.source})"
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop identifies places where `if-elsif` constructions
+      # Identifies places where `if-elsif` constructions
       # can be replaced with `case-when`.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks the style of children definitions at classes and
+      # Checks the style of children definitions at classes and
       # modules. Basically there are two different styles:
       #
       # @safety
@@ -117,10 +117,10 @@ module RuboCop
         end
 
         def remove_end(corrector, body)
-          range = range_between(
-            body.loc.end.begin_pos - leading_spaces(body).size,
-            body.loc.end.end_pos + 1
-          )
+          remove_begin_pos = body.loc.end.begin_pos - leading_spaces(body).size
+          adjustment = processed_source.raw_source[remove_begin_pos] == ';' ? 0 : 1
+          range = range_between(remove_begin_pos, body.loc.end.end_pos + adjustment)
+
           corrector.remove(range)
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
+      # Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
       #
       # @example EnforcedStyle: is_a? (default)
       #   # bad

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

@@ -3,8 +3,10 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of `Object#instance_of?` instead of class comparison
+      # Enforces the use of `Object#instance_of?` instead of class comparison
       # for equality.
+      # `==`, `equal?`, and `eql?` methods are allowed by default.
+      # These are customizable with `AllowedMethods` option.
       #
       # @example
       #   # bad
@@ -16,9 +18,50 @@ module RuboCop
       #   # good
       #   var.instance_of?(Date)
       #
+      # @example AllowedMethods: [] (default)
+      #   # good
+      #   var.instance_of?(Date)
+      #
+      #   # bad
+      #   var.class == Date
+      #   var.class.equal?(Date)
+      #   var.class.eql?(Date)
+      #   var.class.name == 'Date'
+      #
+      # @example AllowedMethods: [`==`]
+      #   # good
+      #   var.instance_of?(Date)
+      #   var.class == Date
+      #   var.class.name == 'Date'
+      #
+      #   # bad
+      #   var.class.equal?(Date)
+      #   var.class.eql?(Date)
+      #
+      # @example AllowedPatterns: [] (default)
+      #   # good
+      #   var.instance_of?(Date)
+      #
+      #   # bad
+      #   var.class == Date
+      #   var.class.equal?(Date)
+      #   var.class.eql?(Date)
+      #   var.class.name == 'Date'
+      #
+      # @example AllowedPatterns: [`/eq/`]
+      #   # good
+      #   var.instance_of?(Date)
+      #   var.class.equal?(Date)
+      #   var.class.eql?(Date)
+      #
+      #   # bad
+      #   var.class == Date
+      #   var.class.name == 'Date'
+      #
       class ClassEqualityComparison < Base
         include RangeHelp
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
         extend AutoCorrector
 
         MSG = 'Use `instance_of?(%<class_name>s)` instead of comparing classes.'
@@ -34,7 +77,9 @@ module RuboCop
 
         def on_send(node)
           def_node = node.each_ancestor(:def, :defs).first
-          return if def_node && ignored_method?(def_node.method_name)
+          return if def_node &&
+                    (allowed_method?(def_node.method_name) ||
+                    matches_allowed_pattern?(def_node.method_name))
 
           class_comparison_candidate?(node) do |receiver_node, class_node|
             range = offense_range(receiver_node, node)
@@ -52,7 +97,9 @@ module RuboCop
           if node.children.first.method?(:name)
             return class_node.receiver.source if class_node.receiver
 
-            class_node.source.delete('"').delete("'")
+            value = class_node.source.delete('"').delete("'")
+            value.prepend('::') if class_node.each_ancestor(:class, :module).any?
+            value
           else
             class_node.source
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of the class/module name instead of
+      # Checks for uses of the class/module name instead of
       # self, when defining class/module methods.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces using `def self.method_name` or `class << self` to define class methods.
+      # Enforces using `def self.method_name` or `class << self` to define class methods.
       #
       # @example EnforcedStyle: def_self (default)
       #   # bad
@@ -70,7 +70,7 @@ module RuboCop
 
         def on_sclass(node)
           return unless def_self_style?
-          return unless node.identifier.source == 'self'
+          return unless node.identifier.self_type?
           return unless all_methods_public?(node)
 
           add_offense(node, message: MSG_SCLASS) do |corrector|
@@ -80,6 +80,7 @@ module RuboCop
 
         def on_defs(node)
           return if def_self_style?
+          return unless node.receiver.self_type?
 
           message = format(MSG, preferred: 'class << self')
           add_offense(node, message: message)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of class variables. Offenses
+      # Checks for uses of class variables. Offenses
       # are signaled only on assignment to class variables to
       # reduce the number of offenses that would be reported.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where custom logic on rejection nils from arrays
+      # Checks for places where custom logic on rejection nils from arrays
       # and hashes can be replaced with `{Array,Hash}#{compact,compact!}`.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of consistent method names
+      # Enforces the use of consistent method names
       # from the Enumerable module.
       #
       # You can customize the mapping from undesired method to desired method.
@@ -48,6 +48,8 @@ module RuboCop
           check_method_node(node.send_node)
         end
 
+        alias on_numblock on_block
+
         def on_send(node)
           return unless implicit_block?(node)
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for methods invoked via the :: operator instead
+      # Checks for methods invoked via the :: operator instead
       # of the . operator (like FileUtils::rmdir instead of FileUtils.rmdir).
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for class methods that are defined using the `::`
+      # Checks for class methods that are defined using the `::`
       # operator instead of the `.` operator.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where multiple consecutive loops over the same data
+      # Checks for places where multiple consecutive loops over the same data
       # can be combined into a single loop. It is very likely that combining them
       # will make the code more efficient and more concise.
       #
@@ -66,6 +66,8 @@ module RuboCop
           add_offense(node) if same_collection_looping?(node, node.left_sibling)
         end
 
+        alias on_numblock on_block
+
         def on_for(node)
           return unless node.parent&.begin_type?
 
@@ -82,7 +84,7 @@ module RuboCop
         end
 
         def same_collection_looping?(node, sibling)
-          sibling&.block_type? &&
+          (sibling&.block_type? || sibling&.numblock_type?) &&
             sibling.send_node.method?(node.method_name) &&
             sibling.receiver == node.receiver &&
             sibling.send_node.arguments == node.send_node.arguments

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces using `` or %x around command literals.
+      # Enforces using `` or %x around command literals.
       #
       # @example EnforcedStyle: backticks (default)
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks that comment annotation keywords are written according
+      # Checks that comment annotation keywords are written according
       # to guidelines.
       #
       # Annotation keywords can be specified by overriding the cop's `Keywords`

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

@@ -3,18 +3,18 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for comments put on the same line as some keywords.
+      # Checks for comments put on the same line as some keywords.
       # These keywords are: `class`, `module`, `def`, `begin`, `end`.
       #
       # Note that some comments
       # (`:nodoc:`, `:yields:`, `rubocop:disable` and `rubocop:todo`)
       # are allowed.
       #
-      # Auto-correction removes comments from `end` keyword and keeps comments
+      # Autocorrection removes comments from `end` keyword and keeps comments
       # for `class`, `module`, `def` and `begin` above the keyword.
       #
       # @safety
-      #   Auto-correction is unsafe because it may remove a comment that is
+      #   Autocorrection is unsafe because it may remove a comment that is
       #   meaningful.
       #
       # @example
@@ -66,7 +66,7 @@ module RuboCop
 
         def register_offense(comment, matched_keyword)
           add_offense(comment, message: format(MSG, keyword: matched_keyword)) do |corrector|
-            range = range_with_surrounding_space(range: comment.loc.expression, newlines: false)
+            range = range_with_surrounding_space(comment.loc.expression, newlines: false)
             corrector.remove(range)
 
             unless matched_keyword == 'end'