rubocop 1.70.0 → 1.71.0

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

@@ -44,146 +44,20 @@ module RuboCop
       #   {foo: 1, bar: 2, baz: 3}.except(:bar)
       #
       class HashExcept < Base
-        include RangeHelp
+        include HashSubset
         extend TargetRubyVersion
         extend AutoCorrector
 
         minimum_target_ruby_version 3.0
 
-        MSG = 'Use `%<prefer>s` instead.'
-        RESTRICT_ON_SEND = %i[reject select filter].freeze
-
-        SUBSET_METHODS = %i[== != eql? include?].freeze
-        ACTIVE_SUPPORT_SUBSET_METHODS = (SUBSET_METHODS + %i[in? exclude?]).freeze
-
-        # @!method block_with_first_arg_check?(node)
-        def_node_matcher :block_with_first_arg_check?, <<~PATTERN
-          (block
-            (call _ _)
-            (args
-              $(arg _key)
-              (arg _))
-            {
-              $(send
-                {(lvar _key) $_ _ | _ $_ (lvar _key)})
-              (send
-                $(send
-                  {(lvar _key) $_ _ | _ $_ (lvar _key)}) :!)
-              })
-        PATTERN
-
-        def on_send(node)
-          block = node.parent
-          return unless extracts_hash_subset?(block) && semantically_except_method?(node, block)
-
-          except_key = except_key(block)
-          return unless safe_to_register_offense?(block, except_key)
-
-          range = offense_range(node)
-          preferred_method = "except(#{except_key_source(except_key)})"
-
-          add_offense(range, message: format(MSG, prefer: preferred_method)) do |corrector|
-            corrector.replace(range, preferred_method)
-          end
-        end
-        alias on_csend on_send
-
         private
 
-        def extracts_hash_subset?(block)
-          block_with_first_arg_check?(block) do |key_arg, send_node, method|
-            return false unless supported_subset_method?(method)
-
-            case method
-            when :include?, :exclude?
-              send_node.first_argument.source == key_arg.source
-            when :in?
-              send_node.receiver.source == key_arg.source
-            else
-              true
-            end
-          end
-        end
-
-        def supported_subset_method?(method)
-          if active_support_extensions_enabled?
-            ACTIVE_SUPPORT_SUBSET_METHODS.include?(method)
-          else
-            SUBSET_METHODS.include?(method)
-          end
-        end
-
-        def semantically_except_method?(node, block)
-          body, negated = extract_body_if_negated(block.body)
-
-          if node.method?('reject')
-            body.method?('==') || body.method?('eql?') || included?(body, negated)
-          else
-            body.method?('!=') || not_included?(body, negated)
-          end
-        end
-
-        def included?(body, negated)
-          if negated
-            body.method?('exclude?')
-          else
-            body.method?('include?') || body.method?('in?')
-          end
-        end
-
-        def not_included?(body, negated)
-          included?(body, !negated)
-        end
-
-        def safe_to_register_offense?(block, except_key)
-          body = block.body
-
-          if body.method?('==') || body.method?('!=')
-            except_key.sym_type? || except_key.str_type?
-          else
-            true
-          end
-        end
-
-        def extract_body_if_negated(body)
-          if body.method?('!')
-            [body.receiver, true]
-          else
-            [body, false]
-          end
-        end
-
-        def except_key_source(key)
-          if key.array_type?
-            key = if key.percent_literal?
-                    key.each_value.map { |v| decorate_source(v) }
-                  else
-                    key.each_value.map(&:source)
-                  end
-            return key.join(', ')
-          end
-
-          key.literal? ? key.source : "*#{key.source}"
-        end
-
-        def decorate_source(value)
-          return ":\"#{value.source}\"" if value.dsym_type?
-          return "\"#{value.source}\"" if value.dstr_type?
-          return ":#{value.source}" if value.sym_type?
-
-          "'#{value.source}'"
-        end
-
-        def except_key(node)
-          key_arg = node.argument_list.first.source
-          body, = extract_body_if_negated(node.body)
-          lhs, _method_name, rhs = *body
-
-          lhs.source == key_arg ? rhs : lhs
+        def semantically_subset_method?(node)
+          semantically_except_method?(node)
         end
 
-        def offense_range(node)
-          range_between(node.loc.selector.begin_pos, node.parent.loc.end.end_pos)
+        def preferred_method_name
+          'except'
         end
       end
     end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for usages of `Hash#reject`, `Hash#select`, and `Hash#filter` methods
+      # that can be replaced with `Hash#slice` method.
+      #
+      # This cop should only be enabled on Ruby version 2.5 or higher.
+      # (`Hash#slice` was added in Ruby 2.5.)
+      #
+      # For safe detection, it is limited to commonly used string and symbol comparisons
+      # when using `==` or `!=`.
+      #
+      # This cop doesn't check for `Hash#delete_if` and `Hash#keep_if` because they
+      # modify the receiver.
+      #
+      # @safety
+      #   This cop is unsafe because it cannot be guaranteed that the receiver
+      #   is a `Hash` or responds to the replacement method.
+      #
+      # @example
+      #
+      #   # bad
+      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| k == :bar }
+      #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| k != :bar }
+      #   {foo: 1, bar: 2, baz: 3}.filter {|k, v| k == :bar }
+      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| k.eql?(:bar) }
+      #
+      #   # bad
+      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| %i[bar].include?(k) }
+      #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| !%i[bar].include?(k) }
+      #   {foo: 1, bar: 2, baz: 3}.filter {|k, v| %i[bar].include?(k) }
+      #
+      #   # bad
+      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| !%i[bar].exclude?(k) }
+      #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| %i[bar].exclude?(k) }
+      #
+      #   # bad
+      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| k.in?(%i[bar]) }
+      #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| !k.in?(%i[bar]) }
+      #
+      #   # good
+      #   {foo: 1, bar: 2, baz: 3}.slice(:bar)
+      #
+      class HashSlice < Base
+        include HashSubset
+        extend TargetRubyVersion
+        extend AutoCorrector
+
+        minimum_target_ruby_version 2.5
+
+        private
+
+        def semantically_subset_method?(node)
+          semantically_slice_method?(node)
+        end
+
+        def preferred_method_name
+          'slice'
+        end
+      end
+    end
+  end
+end

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

@@ -33,8 +33,8 @@ module RuboCop
         # @!method map_to_set?(node)
         def_node_matcher :map_to_set?, <<~PATTERN
           {
-            $(send ({block numblock} $(send _ {:map :collect}) ...) :to_set)
-            $(send $(send _ {:map :collect} (block_pass sym)) :to_set)
+            $(call ({block numblock} $(call _ {:map :collect}) ...) :to_set)
+            $(call $(call _ {:map :collect} (block_pass sym)) :to_set)
           }
         PATTERN
 
@@ -49,6 +49,7 @@ module RuboCop
             autocorrect(corrector, to_set_node, map_node)
           end
         end
+        alias on_csend on_send
 
         private
 

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

@@ -45,6 +45,7 @@ module RuboCop
           register_offense(node)
         end
         # rubocop:enable Metrics/CyclomaticComplexity
+        alias on_csend on_send
 
         private
 
@@ -100,7 +101,7 @@ module RuboCop
             # `obj.method ||= value` parses as (or-asgn (send ...) ...)
             # which IS an `asgn_node`. Similarly, `obj.method += value` parses
             # as (op-asgn (send ...) ...), which is also an `asgn_node`.
-            next if asgn_node.shorthand_asgn? && asgn_node.lhs.send_type?
+            next if asgn_node.shorthand_asgn? && asgn_node.lhs.call_type?
 
             yield asgn_node
           end

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

@@ -19,7 +19,7 @@ module RuboCop
       # acceptable value other than none, it will suppress the offenses
       # raised by this cop. It enforces frozen state.
       #
-      # NOTE: Regexp and Range literals are frozen objects since Ruby 3.0.
+      # NOTE: `Regexp` and `Range` literals are frozen objects since Ruby 3.0.
       #
       # NOTE: From Ruby 3.0, interpolated strings are not frozen when
       # `# frozen-string-literal: true` is used, so this cop enforces explicit

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

@@ -3,15 +3,15 @@
 module RuboCop
   module Cop
     module Style
-      # Flags uses of OpenStruct, as it is now officially discouraged
+      # Flags uses of `OpenStruct`, as it is now officially discouraged
       # to be used for performance, version compatibility, and potential security issues.
       #
       # @safety
-      #
       #   Note that this cop may flag false positives; for instance, the following legal
       #   use of a hand-rolled `OpenStruct` type would be considered an offense:
       #
-      #   ```
+      #   [source,ruby]
+      #   -----
       #   module MyNamespace
       #     class OpenStruct # not the OpenStruct we're looking for
       #     end
@@ -20,7 +20,7 @@ module RuboCop
       #       OpenStruct.new # resolves to MyNamespace::OpenStruct
       #     end
       #   end
-      #   ```
+      #   -----
       #
       # @example
       #

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

@@ -14,7 +14,7 @@ module RuboCop
       # passed multiple arguments.
       #
       # The exploded style has an `AllowedCompactTypes` configuration
-      # option that takes an Array of exception name Strings.
+      # option that takes an `Array` of exception name Strings.
       #
       # @safety
       #   This cop is unsafe because `raise Foo` calls `Foo.exception`, not `Foo.new`.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for RuntimeError as the argument of raise/fail.
+      # Checks for `RuntimeError` as the argument of `raise`/`fail`.
       #
       # @example
       #   # bad

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

@@ -5,7 +5,7 @@ module RuboCop
     module Style
       # Check for uses of `Object#freeze` on immutable objects.
       #
-      # NOTE: Regexp and Range literals are frozen objects since Ruby 3.0.
+      # NOTE: `Regexp` and `Range` literals are frozen objects since Ruby 3.0.
       #
       # NOTE: From Ruby 3.0, this cop allows explicit freezing of interpolated
       # string literals when `# frozen-string-literal: true` is used.

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

@@ -73,10 +73,15 @@ module RuboCop
         LINE_CONTINUATION_PATTERN = /(\\\n)/.freeze
         ALLOWED_STRING_TOKENS = %i[tSTRING tSTRING_CONTENT].freeze
         ARGUMENT_TYPES = %i[
-          kDEF kFALSE kNIL kSELF kTRUE tCONSTANT tCVAR tFLOAT tGVAR tIDENTIFIER tINTEGER tIVAR
-          tLBRACK tLCURLY tLPAREN_ARG tSTRING tSTRING_BEG tSYMBOL tXSTRING_BEG
+          kDEF kDEFINED kFALSE kNIL kSELF kTRUE tAMPER tBANG tCARET tCHARACTER tCOLON3 tCONSTANT
+          tCVAR tDOT2 tDOT3 tFLOAT tGVAR tIDENTIFIER tINTEGER tIVAR tLAMBDA tLBRACK tLCURLY
+          tLPAREN_ARG tPIPE tQSYMBOLS_BEG tQWORDS_BEG tREGEXP_BEG tSTAR tSTRING tSTRING_BEG tSYMBEG
+          tSYMBOL tSYMBOLS_BEG tTILDE tUMINUS tUNARY_NUM tUPLUS tWORDS_BEG tXSTRING_BEG
         ].freeze
-        ARGUMENT_TAKING_FLOW_TOKEN_TYPES = %i[tIDENTIFIER kRETURN kBREAK kNEXT kYIELD].freeze
+        ARGUMENT_TAKING_FLOW_TOKEN_TYPES = %i[
+          tIDENTIFIER kBREAK kNEXT kRETURN kSUPER kYIELD
+        ].freeze
+        ARITHMETIC_OPERATOR_TOKENS = %i[tDIVIDE tDSTAR tMINUS tPERCENT tPLUS tSTAR2].freeze
 
         def on_new_investigation
           return unless processed_source.ast
@@ -96,15 +101,20 @@ module RuboCop
         private
 
         def require_line_continuation?(range)
-          !ends_with_backslash_without_comment?(range.source_line) ||
+          !ends_with_uncommented_backslash?(range) ||
             string_concatenation?(range.source_line) ||
-            start_with_arithmetic_operator?(processed_source[range.line]) ||
+            start_with_arithmetic_operator?(range) ||
             inside_string_literal_or_method_with_argument?(range) ||
             leading_dot_method_chain_with_blank_line?(range)
         end
 
-        def ends_with_backslash_without_comment?(source_line)
-          source_line.gsub(/#.+/, '').end_with?('\\')
+        def ends_with_uncommented_backslash?(range)
+          # A line continuation always needs to be the last character on the line, which
+          # means that it is impossible to have a comment following a continuation.
+          # Therefore, if the line contains a comment, it cannot end with a continuation.
+          return false if processed_source.line_with_comment?(range.line)
+
+          range.source_line.end_with?(LINE_CONTINUATION)
         end
 
         def string_concatenation?(source_line)
@@ -140,7 +150,7 @@ module RuboCop
 
         def inspect_end_of_ruby_code_line_continuation
           last_line = processed_source.lines[processed_source.ast.last_line - 1]
-          return unless last_line.end_with?(LINE_CONTINUATION)
+          return unless code_ends_with_continuation?(last_line)
 
           last_column = last_line.length
           line_continuation_range = range_between(last_column - 1, last_column)
@@ -150,6 +160,12 @@ module RuboCop
           end
         end
 
+        def code_ends_with_continuation?(last_line)
+          return false if processed_source.line_with_comment?(processed_source.ast.last_line)
+
+          last_line.end_with?(LINE_CONTINUATION)
+        end
+
         def inside_string_literal?(range, token)
           ALLOWED_STRING_TOKENS.include?(token.type) && token.pos.overlaps?(range)
         end
@@ -213,8 +229,9 @@ module RuboCop
           node.call_type? && !node.arguments.empty?
         end
 
-        def start_with_arithmetic_operator?(source_line)
-          %r{\A\s*[+\-*/%]}.match?(source_line)
+        def start_with_arithmetic_operator?(range)
+          line_range = processed_source.buffer.line_range(range.line + 1)
+          ARITHMETIC_OPERATOR_TOKENS.include?(processed_source.first_token_of(line_range).type)
         end
       end
     end

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

@@ -140,6 +140,9 @@ module RuboCop
           return 'a literal' if disallowed_literal?(begin_node, node)
           return 'a variable' if node.variable?
           return 'a constant' if node.const_type?
+          if node.assignment? && (begin_node.parent.nil? || begin_node.parent.begin_type?)
+            return 'an assignment'
+          end
           if node.lambda_or_proc? && (node.braces? || node.send_node.lambda_literal?)
             return 'an expression'
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for unnecessary single-element Regexp character classes.
+      # Checks for unnecessary single-element `Regexp` character classes.
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for redundant escapes inside Regexp literals.
+      # Checks for redundant escapes inside `Regexp` literals.
       #
       # @example
       #   # bad

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

@@ -10,7 +10,7 @@ module RuboCop
       # parameters.
       #
       # Configuration option: Methods
-      # Should be set to use this cop. Array of hashes, where each key is the
+      # Should be set to use this cop. `Array` of hashes, where each key is the
       # method name and value - array of argument names.
       #
       # @example Methods: [{reduce: %w[a b]}]

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

@@ -243,7 +243,7 @@ module RuboCop
         def replace_condition(condition)
           return condition.source unless wrap_condition?(condition)
 
-          if condition.call_type?
+          if condition.call_type? && !condition.comparison_method?
             parenthesized_method_arguments(condition)
           else
             "(#{condition.source})"

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Style
       # Enforces the use of consistent method names
-      # from the String class.
+      # from the `String` class.
       #
       # @example
       #   # bad

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

@@ -7,12 +7,15 @@ module RuboCop
       # The supported styles are:
       #
       # * `consistent_comma`: Requires a comma after the last argument,
-      # for all parenthesized method calls with arguments.
+      # for all parenthesized multi-line method calls with arguments.
       # * `comma`: Requires a comma after the last argument, but only for
       # parenthesized method calls where each argument is on its own line.
       # * `no_comma`: Requires that there is no comma after the last
       # argument.
       #
+      # Regardless of style, trailing commas are not allowed in
+      # single-line method calls.
+      #
       # @example EnforcedStyleForMultiline: consistent_comma
       #   # bad
       #   method(1, 2,)

data/lib/rubocop/cops_documentation_generator.rb

@@ -18,7 +18,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     description:           ->(data) { "#{data.description}\n" },
     safety:                ->(data) { safety_object(data.safety_objects, data.cop) },
     examples:              ->(data) { examples(data.example_objects, data.cop) },
-    configuration:         ->(data) { configurations(data.cop.department, data.config, data.cop) },
+    configuration:         ->(data) { configurations(data.cop.department, data.cop, data.config) },
     references:            ->(data) { references(data.cop, data.see_objects) }
   }.freeze
 
@@ -180,17 +180,17 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     content
   end
 
-  def configurations(department, pars, cop)
-    return '' if pars.empty?
-
+  def configurations(department, cop, cop_config)
     header = ['Name', 'Default value', 'Configurable values']
-    configs = pars
+    configs = cop_config
               .each_key
               .reject { |key| key.start_with?('Supported') }
               .reject { |key| key.start_with?('AllowMultipleStyles') }
+    return '' if configs.empty?
+
     content = configs.map do |name|
-      configurable = configurable_values(pars, name)
-      default = format_table_value(pars[name])
+      configurable = configurable_values(cop_config, name)
+      default = format_table_value(cop_config[name])
 
       [configuration_name(department, name), default, configurable]
     end
@@ -206,17 +206,17 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
-  def configurable_values(pars, name)
+  def configurable_values(cop_config, name)
     case name
     when /^Enforced/
       supported_style_name = RuboCop::Cop::Util.to_supported_styles(name)
-      format_table_value(pars[supported_style_name])
+      format_table_value(cop_config[supported_style_name])
     when 'IndentationWidth'
       'Integer'
     when 'Database'
-      format_table_value(pars['SupportedDatabases'])
+      format_table_value(cop_config['SupportedDatabases'])
     else
-      case pars[name]
+      case cop_config[name]
       when String
         'String'
       when Integer
@@ -319,7 +319,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       AutoCorrect Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
       VersionChanged
     ]
-    pars = cop_config.reject { |k| non_display_keys.include? k }
+    parameters = cop_config.reject { |k| non_display_keys.include? k }
     description = 'No documentation'
     example_objects = safety_objects = see_objects = []
     cop_code(cop) do |code_object|
@@ -329,7 +329,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       see_objects = code_object.tags('see')
     end
     data = CopData.new(cop: cop, description: description, example_objects: example_objects,
-                       safety_objects: safety_objects, see_objects: see_objects, config: pars)
+                       safety_objects: safety_objects, see_objects: see_objects, config: parameters)
     cops_body(data)
   end
 

data/lib/rubocop/directive_comment.rb

@@ -88,10 +88,15 @@ module RuboCop
       @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
     end
 
+    # Returns an array of cops for this directive comment, without resolving departments
+    def raw_cop_names
+      @raw_cop_names ||= (cops || '').split(/,\s*/)
+    end
+
     # Returns array of specified in this directive department names
     # when all department disabled
     def department_names
-      splitted_cops_string.select { |cop| department?(cop) }
+      raw_cop_names.select { |cop| department?(cop) }
     end
 
     # Checks if directive departments include cop
@@ -101,11 +106,11 @@ module RuboCop
 
     # Checks if cop department has already used in directive comment
     def overridden_by_department?(cop)
-      in_directive_department?(cop) && splitted_cops_string.include?(cop)
+      in_directive_department?(cop) && raw_cop_names.include?(cop)
     end
 
     def directive_count
-      splitted_cops_string.count
+      raw_cop_names.count
     end
 
     # Returns line number for directive
@@ -115,12 +120,8 @@ module RuboCop
 
     private
 
-    def splitted_cops_string
-      (cops || '').split(/,\s*/)
-    end
-
     def parsed_cop_names
-      cops = splitted_cops_string.map do |name|
+      cops = raw_cop_names.map do |name|
         department?(name) ? cop_names_for_department(name) : name
       end.flatten
       cops - [LINT_SYNTAX_COP]

data/lib/rubocop/options.rb

@@ -579,7 +579,8 @@ module RuboCop
                                          'when combined with --display-only-correctable.'],
       show_cops:                        ['Shows the given cops, or all cops by',
                                          'default, and their configurations for the',
-                                         'current directory.'],
+                                         'current directory.',
+                                         'You can use `*` as a wildcard.'],
       show_docs_url:                    ['Display url to documentation for the given',
                                          'cops, or base url by default.'],
       fail_fast:                        ['Inspect files in order of modification',