rubocop 1.39.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 881807be0f0f6eea20bd13bd8f08fdb158a5b155c8d3a22fd748683a68c1fef1
-  data.tar.gz: 2a8e7d4b02f1ba468e02a4c20f8e3b830ce2a1d8ff0210f86aaeafab597c8c88
+  metadata.gz: e37ffc01dbd2782dd811d4c35129f893502179457e76d8e3501d7c3683563cc2
+  data.tar.gz: 9dba5be8e2168e986170e8366a62c73940262bfffec0a374c3a01b3f207ca291
 SHA512:
-  metadata.gz: 11ea36bec754b07912e06b5481f964d10a6dbf5bfd56f99d8a8842ca46d56ae03a342a283d843336f977760c28a697ee995aa98268254a55b1218fa57a9fb5c7
-  data.tar.gz: b5096cb4589d9bafdab0b6ab409ea9e7841dc06b274aeb7f7d5a26e703cb216c2a428d695fb2a087637467f1cdd5ac005398c66ee3e7d28d49cb4b203a87667d
+  metadata.gz: 23769dc5239a734dc07a859a594e1cc0b732d05d24c61c1887525f9f69f748e0c23cbb84404e865e00a04bfb5c91e73d1e0bdb7908a72340ede4245fc38508c6
+  data.tar.gz: f016891fb54e93a8f6c418d4aa97f7400a74c187c8cf5dbbe274020ea5bda900721f2a7fefbbb368472664cf21a4b586db4fb9373510c27da6428aa490d504e6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-22 Bozhidar Batsov
+Copyright (c) 2012-23 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -53,7 +53,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.39', require: false
+gem 'rubocop', '~> 1.42', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
@@ -246,5 +246,5 @@ RuboCop's changelog is available [here](CHANGELOG.md).
 
 ## Copyright
 
-Copyright (c) 2012-2022 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
+Copyright (c) 2012-2023 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
 further details.

data/config/default.yml

@@ -161,7 +161,9 @@ AllCops:
 Bundler/DuplicatedGem:
   Description: 'Checks for duplicate gem entries in Gemfile.'
   Enabled: true
+  Severity: warning
   VersionAdded: '0.46'
+  VersionChanged: '1.40'
   Include:
     - '**/*.gemfile'
     - '**/Gemfile'
@@ -213,7 +215,9 @@ Bundler/InsecureProtocolSource:
                  because HTTP requests are insecure. Please change your source to
                  'https://rubygems.org' if possible, or 'http://rubygems.org' if not.
   Enabled: true
+  Severity: warning
   VersionAdded: '0.50'
+  VersionChanged: '1.40'
   AllowHttpProtocol: true
   Include:
     - '**/*.gemfile'
@@ -252,14 +256,18 @@ Gemspec/DependencyVersion:
 Gemspec/DeprecatedAttributeAssignment:
   Description: Checks that deprecated attribute assignments are not set in a gemspec file.
   Enabled: pending
+  Severity: warning
   VersionAdded: '1.30'
+  VersionChanged: '1.40'
   Include:
     - '**/*.gemspec'
 
 Gemspec/DuplicatedAssignment:
   Description: 'An attribute assignment method calls should be listed only once in a gemspec.'
   Enabled: true
+  Severity: warning
   VersionAdded: '0.52'
+  VersionChanged: '1.40'
   Include:
     - '**/*.gemspec'
 
@@ -278,7 +286,9 @@ Gemspec/OrderedDependencies:
 Gemspec/RequireMFA:
   Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'
   Enabled: pending
+  Severity: warning
   VersionAdded: '1.23'
+  VersionChanged: '1.40'
   Reference:
     - https://guides.rubygems.org/mfa-requirement-opt-in/
   Include:
@@ -287,8 +297,9 @@ Gemspec/RequireMFA:
 Gemspec/RequiredRubyVersion:
   Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'
   Enabled: true
+  Severity: warning
   VersionAdded: '0.52'
-  VersionChanged: '1.22'
+  VersionChanged: '1.40'
   Include:
     - '**/*.gemspec'
 
@@ -296,7 +307,9 @@ Gemspec/RubyVersionGlobalsUsage:
   Description: Checks usage of RUBY_VERSION in gemspec.
   StyleGuide: '#no-ruby-version-in-the-gemspec'
   Enabled: true
+  Severity: warning
   VersionAdded: '0.72'
+  VersionChanged: '1.40'
   Include:
     - '**/*.gemspec'
 
@@ -378,8 +391,9 @@ Layout/AssignmentIndentation:
                 Checks the indentation of the first line of the
                 right-hand-side of a multi-line assignment.
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.49'
-  VersionChanged: '0.77'
+  VersionChanged: '1.40'
   # By default the indentation width from `Layout/IndentationWidth` is used,
   # but it can be overridden by setting this parameter.
   IndentationWidth: ~
@@ -748,6 +762,7 @@ Layout/FirstArrayElementLineBreak:
                  multi-line array.
   Enabled: false
   VersionAdded: '0.49'
+  AllowMultilineFinalElement: false
 
 Layout/FirstHashElementIndentation:
   Description: 'Checks the indentation of the first key in a hash literal.'
@@ -780,6 +795,7 @@ Layout/FirstHashElementLineBreak:
                  multi-line hash.
   Enabled: false
   VersionAdded: '0.49'
+  AllowMultilineFinalElement: false
 
 Layout/FirstMethodArgumentLineBreak:
   Description: >-
@@ -787,6 +803,7 @@ Layout/FirstMethodArgumentLineBreak:
                  multi-line method call.
   Enabled: false
   VersionAdded: '0.49'
+  AllowMultilineFinalElement: false
 
 Layout/FirstMethodParameterLineBreak:
   Description: >-
@@ -794,6 +811,7 @@ Layout/FirstMethodParameterLineBreak:
                  multi-line method parameter definition.
   Enabled: false
   VersionAdded: '0.49'
+  AllowMultilineFinalElement: false
 
 Layout/FirstParameterIndentation:
   Description: >-
@@ -1053,6 +1071,7 @@ Layout/MultilineArrayLineBreaks:
                  starts on a separate line.
   Enabled: false
   VersionAdded: '0.67'
+  AllowMultilineFinalElement: false
 
 Layout/MultilineAssignmentLayout:
   Description: 'Check for a newline after the assignment operator in multi-line assignments.'
@@ -1103,6 +1122,7 @@ Layout/MultilineHashKeyLineBreaks:
                  starts on a separate line.
   Enabled: false
   VersionAdded: '0.67'
+  AllowMultilineFinalElement: false
 
 Layout/MultilineMethodArgumentLineBreaks:
   Description: >-
@@ -1110,6 +1130,7 @@ Layout/MultilineMethodArgumentLineBreaks:
                  starts on a separate line.
   Enabled: false
   VersionAdded: '0.67'
+  AllowMultilineFinalElement: false
 
 Layout/MultilineMethodCallBraceLayout:
   Description: >-
@@ -1164,6 +1185,7 @@ Layout/MultilineMethodParameterLineBreaks:
                  starts on a separate line.
   Enabled: false
   VersionAdded: '1.32'
+  AllowMultilineFinalElement: false
 
 Layout/MultilineOperationIndentation:
   Description: >-
@@ -1643,7 +1665,7 @@ Lint/DeprecatedConstants:
   Description: 'Checks for deprecated constants.'
   Enabled: pending
   VersionAdded: '1.8'
-  VersionChanged: '1.22'
+  VersionChanged: '1.40'
   # You can configure deprecated constants.
   # If there is an alternative method, you can set alternative value as `Alternative`.
   # And you can set the deprecated version as `DeprecatedVersion`.
@@ -1670,6 +1692,12 @@ Lint/DeprecatedConstants:
     'Random::DEFAULT':
       Alternative: 'Random.new'
       DeprecatedVersion: '3.0'
+    'Struct::Group':
+      Alternative: 'Etc::Group'
+      DeprecatedVersion: '3.0'
+    'Struct::Passwd':
+      Alternative: 'Etc::Passwd'
+      DeprecatedVersion: '3.0'
 
 Lint/DeprecatedOpenSSLConstant:
   Description: "Don't use algorithm constants for `OpenSSL::Cipher` and `OpenSSL::Digest`."
@@ -1894,11 +1922,11 @@ Lint/InheritException:
     - runtime_error
 
 Lint/InterpolationCheck:
-  Description: 'Raise warning for interpolation in single q strs.'
+  Description: 'Checks for interpolation in a single quoted string.'
   Enabled: true
-  Safe: false
+  SafeAutoCorrect: false
   VersionAdded: '0.50'
-  VersionChanged: '0.87'
+  VersionChanged: '1.40'
 
 Lint/LambdaWithoutLiteralBlock:
   Description: 'Checks uses of lambda without a literal block.'
@@ -2806,6 +2834,7 @@ Naming/MethodParameterName:
     - as
     - at
     - by
+    - cc
     - db
     - id
     - if
@@ -3013,6 +3042,11 @@ Style/ArrayCoercion:
   Enabled: false
   VersionAdded: '0.88'
 
+Style/ArrayIntersect:
+  Description: 'Use `array1.intersect?(array2)` instead of `(array1 & array2).any?`.'
+  Enabled: 'pending'
+  VersionAdded: '1.40'
+
 Style/ArrayJoin:
   Description: 'Use Array#join instead of Array#*.'
   StyleGuide: '#array-join'
@@ -3392,6 +3426,12 @@ Style/CommentedKeyword:
   VersionAdded: '0.51'
   VersionChanged: '1.19'
 
+Style/ConcatArrayLiterals:
+  Description: 'Enforces the use of `Array#push(item)` instead of `Array#concat([item])` to avoid redundant array literals.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.41'
+
 Style/ConditionalAssignment:
   Description: >-
                  Use the return value of `if` and `case` statements for
@@ -3861,7 +3901,7 @@ Style/HashSyntax:
     - never
     # accepts both shorthand and explicit use of hash literal value.
     - either
-    # like "either", but will avoid mixing styles in a single hash
+    # forces use of the 3.1 syntax only if all values can be omitted in the hash.
     - consistent
   # Force hashes that have a symbol value to use hash rockets
   UseHashRocketsWithSymbolValues: false
@@ -4070,6 +4110,12 @@ Style/MapToHash:
   VersionAdded: '1.24'
   Safe: false
 
+Style/MapToSet:
+  Description: 'Prefer `to_set` with a block over `map.to_set`.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.42'
+
 Style/MethodCallWithArgsParentheses:
   Description: 'Use parentheses for method calls with arguments.'
   StyleGuide: '#method-invocation-parens'
@@ -4128,6 +4174,12 @@ Style/MinMax:
   Enabled: true
   VersionAdded: '0.50'
 
+Style/MinMaxComparison:
+  Description: 'Enforces the use of `max` or `min` instead of comparison for greater or less.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.42'
+
 Style/MissingElse:
   Description: >-
                 Require if/case expressions to have an else branches.
@@ -4660,10 +4712,12 @@ Style/RedundantArgument:
   Enabled: pending
   Safe: false
   VersionAdded: '1.4'
-  VersionChanged: '1.7'
+  VersionChanged: '1.40'
   Methods:
     # Array#join
     join: ''
+    # Array#sum
+    sum: 0
     # String#split
     split: ' '
     # String#chomp
@@ -4698,6 +4752,16 @@ Style/RedundantConditional:
   Enabled: true
   VersionAdded: '0.50'
 
+Style/RedundantConstantBase:
+  Description: Avoid redundant `::` prefix on constant.
+  Enabled: pending
+  VersionAdded: '1.40'
+
+Style/RedundantDoubleSplatHashBraces:
+  Description: 'Checks for redundant uses of double splat hash braces.'
+  Enabled: pending
+  VersionAdded: '1.41'
+
 Style/RedundantEach:
   Description: 'Checks for redundant `each`.'
   Enabled: pending
@@ -4838,6 +4902,12 @@ Style/RegexpLiteral:
   # are found in the regexp string.
   AllowInnerSlashes: false
 
+Style/RequireOrder:
+  Description: Sort `require` and `require_relative` in alphabetical order.
+  Enabled: false
+  SafeAutoCorrect: false
+  VersionAdded: '1.40'
+
 Style/RescueModifier:
   Description: 'Avoid using rescue in its modifier form.'
   StyleGuide: '#no-rescue-modifiers'
@@ -5122,12 +5192,11 @@ Style/SymbolProc:
   Enabled: true
   Safe: false
   VersionAdded: '0.26'
-  VersionChanged: '1.28'
+  VersionChanged: '1.40'
   AllowMethodsWithArguments: false
   # A list of method names to be always allowed by the check.
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   AllowedMethods:
-    - respond_to
     - define_method
   AllowedPatterns: []
   IgnoredMethods: [] # deprecated
@@ -5369,6 +5438,18 @@ Style/YodaCondition:
   VersionAdded: '0.49'
   VersionChanged: '0.75'
 
+Style/YodaExpression:
+  Description: 'Forbid the use of yoda expressions.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.42'
+  SupportedOperators:
+    - '*'
+    - '+'
+    - '&'
+    - '|'
+    - '^'
+
 Style/ZeroLengthPredicate:
   Description: 'Use #empty? when testing for objects of length 0.'
   Enabled: true

data/exe/rubocop

@@ -11,8 +11,8 @@ exit exit_status if server_cli.exit?
 if RuboCop::Server.running?
   exit_status = RuboCop::Server::ClientCommand::Exec.new.run
 else
-  require 'rubocop'
   require 'benchmark'
+  require 'rubocop'
 
   cli = RuboCop::CLI.new
 

data/lib/rubocop/cli.rb

@@ -7,7 +7,7 @@ module RuboCop
     STATUS_SUCCESS     = 0
     STATUS_OFFENSES    = 1
     STATUS_ERROR       = 2
-    STATUS_INTERRUPTED = 128 + Signal.list['INT']
+    STATUS_INTERRUPTED = Signal.list['INT'] + 128
     DEFAULT_PARALLEL_OPTIONS = %i[
       color debug display_style_guide display_time display_only_fail_level_offenses
       display_only_failed except extra_details fail_level fix_layout format

data/lib/rubocop/comment_config.rb

@@ -31,6 +31,7 @@ module RuboCop
 
     def initialize(processed_source)
       @processed_source = processed_source
+      @no_directives = !processed_source.raw_source.include?('rubocop')
     end
 
     def cop_enabled_at_line?(cop, line_number)
@@ -74,6 +75,8 @@ module RuboCop
     end
 
     def analyze # rubocop:todo Metrics/AbcSize
+      return {} if @no_directives
+
       analyses = Hash.new { |hash, key| hash[key] = CopAnalysis.new([], nil) }
       inject_disabled_cops_directives(analyses)
 
@@ -146,6 +149,8 @@ module RuboCop
     end
 
     def each_directive
+      return if @no_directives
+
       processed_source.comments.each do |comment|
         directive = DirectiveComment.new(comment)
         yield directive if directive.cop_names

data/lib/rubocop/config.rb

@@ -21,24 +21,30 @@ module RuboCop
     DEFAULT_RAILS_VERSION = 5.0
     attr_reader :loaded_path
 
+    def self.create(hash, path, check: true)
+      config = new(hash, path)
+      config.check if check
+
+      config
+    end
+
+    # rubocop:disable Metrics/AbcSize
     def initialize(hash = {}, loaded_path = nil)
       @loaded_path = loaded_path
       @for_cop = Hash.new do |h, cop|
-        qualified_cop_name = Cop::Registry.qualified_cop_name(cop, loaded_path)
+        cop_name = cop.respond_to?(:cop_name) ? cop.cop_name : cop
+        qualified_cop_name = Cop::Registry.qualified_cop_name(cop_name, loaded_path)
         cop_options = self[qualified_cop_name].dup || {}
         cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
-        h[cop] = cop_options
+        h[cop] = h[cop_name] = cop_options
       end
       @hash = hash
       @validator = ConfigValidator.new(self)
-    end
 
-    def self.create(hash, path, check: true)
-      config = new(hash, path)
-      config.check if check
-
-      config
+      @badge_config_cache = {}.compare_by_identity
+      @clusivity_config_exists_cache = {}
     end
+    # rubocop:enable Metrics/AbcSize
 
     def loaded_features
       @loaded_features ||= ConfigLoader.loaded_features
@@ -116,14 +122,31 @@ module RuboCop
     # Note: the 'Enabled' attribute is calculated according to the department's
     # and 'AllCops' configuration; other attributes are not inherited.
     def for_cop(cop)
-      @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
+      @for_cop[cop]
     end
 
     # @return [Config] for the given cop merged with that of its department (if any)
     # Note: the 'Enabled' attribute is same as that returned by `for_cop`
     def for_badge(badge)
-      cop_config = for_cop(badge.to_s)
-      fetch(badge.department.to_s) { return cop_config }.merge(cop_config)
+      @badge_config_cache[badge] ||= begin
+        department_config = self[badge.department_name]
+        cop_config = for_cop(badge.to_s)
+        if department_config
+          department_config.merge(cop_config)
+        else
+          cop_config
+        end
+      end
+    end
+
+    # @return [Boolean] whether config for this badge has 'Include' or 'Exclude' keys
+    # @api private
+    def clusivity_config_for_badge?(badge)
+      exists = @clusivity_config_exists_cache[badge.to_s]
+      return exists unless exists.nil?
+
+      cop_config = for_badge(badge)
+      @clusivity_config_exists_cache[badge.to_s] = cop_config['Include'] || cop_config['Exclude']
     end
 
     # @return [Config] for the given department name.
@@ -215,7 +238,7 @@ module RuboCop
     # directory since that wouldn't work.
     def base_dir_for_path_parameters
       @base_dir_for_path_parameters ||=
-        if File.basename(loaded_path).start_with?('.rubocop') &&
+        if loaded_path && File.basename(loaded_path).start_with?('.rubocop') &&
            loaded_path != File.join(Dir.home, ConfigLoader::DOTFILE)
           File.expand_path(File.dirname(loaded_path))
         else
@@ -272,9 +295,10 @@ module RuboCop
       return nil unless lock_file_path
 
       File.foreach(lock_file_path) do |line|
-        # If rails is in Gemfile.lock or gems.lock, there should be a line like:
-        #         rails (X.X.X)
-        result = line.match(/^\s+rails\s+\((\d+\.\d+)/)
+        # If Rails (or one of its frameworks) is in Gemfile.lock or gems.lock, there should be
+        # a line like:
+        #         railties (X.X.X)
+        result = line.match(/^\s+railties\s+\((\d+\.\d+)/)
         return result.captures.first.to_f if result
       end
     end

data/lib/rubocop/config_loader.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'erb'
-require 'yaml'
 require 'pathname'
+require 'yaml'
 require_relative 'config_finder'
 
 module RuboCop
@@ -42,18 +42,18 @@ module RuboCop
 
         hash = load_yaml_configuration(path)
 
-        # Resolve requires first in case they define additional cops
         loaded_features = resolver.resolve_requires(path, hash)
         add_loaded_features(loaded_features)
 
-        add_missing_namespaces(path, hash)
-
         resolver.override_department_setting_for_cops({}, hash)
         resolver.resolve_inheritance_from_gems(hash)
         resolver.resolve_inheritance(path, hash, file, debug?)
-
         hash.delete('inherit_from')
 
+        # Adding missing namespaces only after resolving requires & inheritance,
+        # since both can introduce new cops that need to be considered here.
+        add_missing_namespaces(path, hash)
+
         Config.create(hash, path, check: check)
       end
 
@@ -137,6 +137,15 @@ module RuboCop
         end
       end
 
+      # @api private
+      def inject_defaults!(project_root)
+        path = File.join(project_root, 'config', 'default.yml')
+        config = load_file(path)
+        new_config = ConfigLoader.merge_with_default(config, path)
+        puts "configuration from #{path}" if debug?
+        @default_configuration = new_config
+      end
+
       # Returns the path RuboCop inferred as the root of the project. No file
       # searches will go past this directory.
       # @deprecated Use `RuboCop::ConfigFinder.project_root` instead.

data/lib/rubocop/config_loader_resolver.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'pathname'
+require 'yaml'
 
 module RuboCop
   # A help class for ConfigLoader that handles configuration resolution.
@@ -206,7 +206,11 @@ module RuboCop
     end
 
     def base_configs(path, inherit_from, file)
-      configs = Array(inherit_from).compact.map do |f|
+      inherit_froms = Array(inherit_from).compact.flat_map do |f|
+        PathUtil.glob?(f) ? Dir.glob(f) : f
+      end
+
+      configs = inherit_froms.map do |f|
         ConfigLoader.load_file(inherited_file(path, f, file))
       end
 

data/lib/rubocop/config_validator.rb

@@ -162,7 +162,7 @@ module RuboCop
       return unless syntax_config && default_config.merge(syntax_config) != default_config
 
       raise ValidationError,
-            "configuration for Syntax cop found in #{smart_loaded_path}\n" \
+            "configuration for Lint/Syntax cop found in #{smart_loaded_path}\n" \
             'It\'s not possible to disable this cop.'
     end
 

data/lib/rubocop/cop/badge.rb

@@ -10,7 +10,7 @@ module RuboCop
     # allow for badge references in source files that omit the department for
     # RuboCop to infer.
     class Badge
-      attr_reader :department, :cop_name
+      attr_reader :department, :department_name, :cop_name
 
       def self.for(class_name)
         parts = class_name.split('::')
@@ -18,19 +18,23 @@ module RuboCop
         new(name_deep_enough ? parts[2..] : parts.last(2))
       end
 
+      @parse_cache = {}
+
       def self.parse(identifier)
-        new(identifier.split('/').map { |i| camel_case(i) })
+        @parse_cache[identifier] ||= new(identifier.split('/').map! { |i| camel_case(i) })
       end
 
       def self.camel_case(name_part)
         return 'RSpec' if name_part == 'rspec'
+        return name_part unless name_part.match?(/^[a-z]|_[a-z]/)
 
-        name_part.gsub(/^\w|_\w/) { |match| match[-1, 1].upcase }
+        name_part.gsub(/^[a-z]|_[a-z]/) { |match| match[-1, 1].upcase }
       end
 
       def initialize(class_name_parts)
         department_parts = class_name_parts[0...-1]
         @department = (department_parts.join('/').to_sym unless department_parts.empty?)
+        @department_name = @department&.to_s
         @cop_name = class_name_parts.last
       end
 
@@ -40,7 +44,8 @@ module RuboCop
       alias eql? ==
 
       def hash
-        [department, cop_name].hash
+        # Do hashing manually to reduce Array allocations.
+        department.hash ^ cop_name.hash # rubocop:disable Security/CompoundHash
       end
 
       def match?(other)