rubocop 1.18.3 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6123e3d35feebac08e838afcff3f912fa24f7abcc71403f6368fffb346fa9bc
-  data.tar.gz: 40f3ff08e0efc288e7a11af7016d702f743b8ab343de0c3fd045035c7ac7605f
+  metadata.gz: 184ca6701160d34e5fe8f659e159842f397bfe07edbc27df159b7793fd8a0a3c
+  data.tar.gz: d891042df8d86850afbf19b0d0e81f4255e909f0775b32eb675b3766d0266561
 SHA512:
-  metadata.gz: 3ac2d860eccd7ac0d655649d36f64cf52ed1587357b2ef35707a1c2ced408cf645d1a8be2dd6e660c5e338c298adef876814fdf35b22f5c71da4ec5bc830e388
-  data.tar.gz: adab3ee6563260ced11848bc9b1c62ff2641a28a6b4aca80cb703ef9136562bbdc6a2efff4670d12dee329cc7cf5306a8c9d11106ff13d9cbf5539b5094ba388
+  metadata.gz: 6b0ed04638cfa650324684315fcf4c8a99b93fa66c1dce39efa7c76605bbd78a7c4e4b4d6fc6ac608d2ebbb52604f6f9fbccf23e5d097c637b1b6c879601d70b
+  data.tar.gz: f1310e4f3a7285ecf642edf6e99500decb0d1aa74b676adf38ee6c65c9f1f4cf3124853102a50da51e896a6b9780b3db9156fa4e075f60139f01d239d13ab898

data/README.md

@@ -54,7 +54,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.18', require: false
+gem 'rubocop', '~> 1.19', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.

data/config/default.yml

@@ -1434,6 +1434,13 @@ Lint/AmbiguousOperator:
   VersionAdded: '0.17'
   VersionChanged: '0.83'
 
+Lint/AmbiguousRange:
+  Description: Checks for ranges with ambiguous boundaries.
+  Enabled: pending
+  VersionAdded: '1.19'
+  SafeAutoCorrect: false
+  RequireParenthesesForMethodChains: false
+
 Lint/AmbiguousRegexpLiteral:
   Description: >-
                  Checks for ambiguous regexp literals in the first argument of
@@ -1824,7 +1831,6 @@ Lint/MultipleComparison:
   Enabled: true
   VersionAdded: '0.47'
   VersionChanged: '1.1'
-  AllowMethodComparison: true
 
 Lint/NestedMethodDefinition:
   Description: 'Do not use nested method definitions.'
@@ -2557,6 +2563,7 @@ Naming/InclusiveLanguage:
         - denylist
         - block
     slave:
+      WholeWord: true
       Suggestions: ['replica', 'secondary', 'follower']
 
 Naming/MemoizedInstanceVariableName:
@@ -3155,8 +3162,9 @@ Style/CommentAnnotation:
 Style/CommentedKeyword:
   Description: 'Do not place comments on the same line as certain keywords.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.51'
-  VersionChanged: '1.7'
+  VersionChanged: '1.19'
 
 Style/ConditionalAssignment:
   Description: >-
@@ -3603,8 +3611,9 @@ Style/IdenticalConditionalBranches:
                  line at the end of each branch, which can validly be moved
                  out of the conditional.
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.36'
-  VersionChanged: '1.16'
+  VersionChanged: '1.19'
 
 Style/IfInsideElse:
   Description: 'Finds if nodes inside else, which can be converted to elsif.'
@@ -3929,6 +3938,7 @@ Style/MultipleComparison:
   Enabled: true
   VersionAdded: '0.49'
   VersionChanged: '1.1'
+  AllowMethodComparison: true
 
 Style/MutableConstant:
   Description: 'Do not assign mutable objects to constants.'
@@ -4152,6 +4162,7 @@ Style/OptionHash:
     - args
     - params
     - parameters
+  Allowlist: []
 
 Style/OptionalArguments:
   Description: >-
@@ -4404,6 +4415,11 @@ Style/RedundantSelfAssignment:
   Safe: false
   VersionAdded: '0.90'
 
+Style/RedundantSelfAssignmentBranch:
+  Description: 'Checks for places where conditional branch makes redundant self-assignment.'
+  Enabled: pending
+  VersionAdded: '1.19'
+
 Style/RedundantSort:
   Description: >-
                   Use `min` instead of `sort.first`,
@@ -4575,6 +4591,7 @@ Style/SpecialGlobalVars:
   VersionAdded: '0.13'
   VersionChanged: '0.36'
   SafeAutoCorrect: false
+  RequireEnglish: true
   EnforcedStyle: use_english_names
   SupportedStyles:
     - use_perl_names
@@ -4895,7 +4912,7 @@ Style/VariableInterpolation:
 
 Style/WhenThen:
   Description: 'Use when x then ... for one-line cases.'
-  StyleGuide: '#one-line-cases'
+  StyleGuide: '#no-when-semicolons'
   Enabled: true
   VersionAdded: '0.9'
 
@@ -4919,7 +4936,7 @@ Style/WordArray:
   StyleGuide: '#percent-w'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.36'
+  VersionChanged: '1.19'
   EnforcedStyle: percent
   SupportedStyles:
     # percent style: %w(word1 word2)

data/lib/rubocop.rb

@@ -111,6 +111,7 @@ require_relative 'rubocop/cop/mixin/percent_literal'
 require_relative 'rubocop/cop/mixin/preceding_following_alignment'
 require_relative 'rubocop/cop/mixin/preferred_delimiters'
 require_relative 'rubocop/cop/mixin/rational_literal'
+require_relative 'rubocop/cop/mixin/require_library'
 require_relative 'rubocop/cop/mixin/rescue_node'
 require_relative 'rubocop/cop/mixin/safe_assignment'
 require_relative 'rubocop/cop/mixin/space_after_punctuation'
@@ -144,6 +145,7 @@ require_relative 'rubocop/cop/correctors/ordered_gem_corrector'
 require_relative 'rubocop/cop/correctors/parentheses_corrector'
 require_relative 'rubocop/cop/correctors/percent_literal_corrector'
 require_relative 'rubocop/cop/correctors/punctuation_corrector'
+require_relative 'rubocop/cop/correctors/require_library_corrector'
 require_relative 'rubocop/cop/correctors/space_corrector'
 require_relative 'rubocop/cop/correctors/string_literal_corrector'
 require_relative 'rubocop/cop/correctors/unused_arg_corrector'
@@ -260,6 +262,7 @@ require_relative 'rubocop/cop/layout/trailing_whitespace'
 require_relative 'rubocop/cop/lint/ambiguous_assignment'
 require_relative 'rubocop/cop/lint/ambiguous_block_association'
 require_relative 'rubocop/cop/lint/ambiguous_operator'
+require_relative 'rubocop/cop/lint/ambiguous_range'
 require_relative 'rubocop/cop/lint/ambiguous_regexp_literal'
 require_relative 'rubocop/cop/lint/assignment_in_condition'
 require_relative 'rubocop/cop/lint/big_decimal_new'
@@ -510,6 +513,7 @@ require_relative 'rubocop/cop/style/redundant_assignment'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
+require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
 require_relative 'rubocop/cop/style/sole_nested_conditional'
 require_relative 'rubocop/cop/style/static_class'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'

data/lib/rubocop/cli.rb

@@ -8,6 +8,11 @@ module RuboCop
     STATUS_OFFENSES    = 1
     STATUS_ERROR       = 2
     STATUS_INTERRUPTED = 128 + Signal.list['INT']
+    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
+      ignore_disable_comments lint only only_guide_cops require safe
+    ].freeze
 
     class Finished < RuntimeError; end
 
@@ -37,6 +42,7 @@ module RuboCop
       else
         act_on_options
         validate_options_vs_config
+        parallel_by_default!
         apply_default_formatter
         execute_runners
       end
@@ -84,6 +90,18 @@ module RuboCop
                                  'with AllCops: UseCache: false is not allowed.'
     end
 
+    def parallel_by_default!
+      # See https://github.com/rubocop/rubocop/pull/4537 for JRuby and Windows constraints.
+      return if RUBY_ENGINE != 'ruby' || RuboCop::Platform.windows?
+
+      if (@options.keys - DEFAULT_PARALLEL_OPTIONS).empty? &&
+         @config_store.for_pwd.for_all_cops['UseCache'] != false
+        puts 'Use parallel by default.' if @options[:debug]
+
+        @options[:parallel] = true
+      end
+    end
+
     def act_on_options
       set_options_to_config_loader
 

data/lib/rubocop/config_loader_resolver.rb

@@ -108,7 +108,7 @@ module RuboCop
           result.delete(key)
         elsif merge_hashes?(base_hash, derived_hash, key)
           result[key] = merge(base_hash[key], derived_hash[key], **opts)
-        elsif should_union?(base_hash, key, opts[:inherit_mode])
+        elsif should_union?(derived_hash, base_hash, opts[:inherit_mode], key)
           result[key] = base_hash[key] | derived_hash[key]
         elsif opts[:debug]
           warn_on_duplicate_setting(base_hash, derived_hash, key, **opts)
@@ -183,11 +183,26 @@ module RuboCop
       local_inherit || hash['inherit_mode'] || {}
     end
 
-    def should_union?(base_hash, key, inherit_mode)
-      base_hash[key].is_a?(Array) &&
-        inherit_mode &&
-        inherit_mode['merge'] &&
-        inherit_mode['merge'].include?(key)
+    def should_union?(derived_hash, base_hash, root_mode, key)
+      return false unless base_hash[key].is_a?(Array)
+
+      derived_mode = derived_hash['inherit_mode']
+      return false if should_override?(derived_mode, key)
+      return true if should_merge?(derived_mode, key)
+
+      base_mode = base_hash['inherit_mode']
+      return false if should_override?(base_mode, key)
+      return true if should_merge?(base_mode, key)
+
+      should_merge?(root_mode, key)
+    end
+
+    def should_merge?(mode, key)
+      mode && mode['merge'] && mode['merge'].include?(key)
+    end
+
+    def should_override?(mode, key)
+      mode && mode['override'] && mode['override'].include?(key)
     end
 
     def merge_hashes?(base_hash, derived_hash, key)

data/lib/rubocop/config_validator.rb

@@ -104,12 +104,9 @@ module RuboCop
         # to do so than to pass the value around to various methods.
         next if name == 'inherit_mode'
 
-        suggestions = NameSimilarity.find_similar_names(name, Cop::Registry.global.map(&:cop_name))
-        suggestion = "Did you mean `#{suggestions.join('`, `')}`?" if suggestions.any?
-
         message = <<~MESSAGE.rstrip
-          unrecognized cop #{name} found in #{smart_loaded_path}
-          #{suggestion}
+          unrecognized cop or department #{name} found in #{smart_loaded_path}
+          #{suggestion(name)}
         MESSAGE
 
         unknown_cops << message
@@ -117,6 +114,22 @@ module RuboCop
       raise ValidationError, unknown_cops.join("\n") if unknown_cops.any?
     end
 
+    def suggestion(name)
+      registry = Cop::Registry.global
+      departments = registry.departments.map(&:to_s)
+      suggestions = NameSimilarity.find_similar_names(name, departments + registry.map(&:cop_name))
+      if suggestions.any?
+        "Did you mean `#{suggestions.join('`, `')}`?"
+      else
+        # Department names can contain slashes, e.g. Chef/Correctness, but there's no support for
+        # the concept of higher level departments in RuboCop. It's a flat structure. So if the user
+        # tries to configure a "top level department", we hint that it's the bottom level
+        # departments that should be configured.
+        suggestions = departments.select { |department| department.start_with?("#{name}/") }
+        "#{name} is not a department. Use `#{suggestions.join('`, `')}`." if suggestions.any?
+      end
+    end
+
     def validate_syntax_cop
       syntax_config = @config['Lint/Syntax']
       default_config = ConfigLoader.default_configuration['Lint/Syntax']

data/lib/rubocop/cop/bundler/ordered_gems.rb

@@ -24,7 +24,7 @@ module RuboCop
       #   gem 'rubocop'
       #   # For tests
       #   gem 'rspec'
-      class OrderedGems < Cop
+      class OrderedGems < Cop # rubocop:disable InternalAffairs/InheritDeprecatedCopClass
         include ConfigurableEnforcedStyle
         include OrderedGemNode
 

data/lib/rubocop/cop/correctors/require_library_corrector.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This class ensures a require statement is present for a standard library
+    # determined by the variable library_name
+    class RequireLibraryCorrector
+      extend RangeHelp
+
+      class << self
+        def correct(corrector, node, library_name)
+          node = node.parent while node.parent?
+          node = node.children.first if node.begin_type?
+          corrector.insert_before(node, require_statement(library_name))
+        end
+
+        def require_statement(library_name)
+          "require '#{library_name}'\n"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/gemspec/ordered_dependencies.rb

@@ -50,7 +50,7 @@ module RuboCop
       #   spec.add_dependency 'rubocop'
       #   # For tests
       #   spec.add_dependency 'rspec'
-      class OrderedDependencies < Cop
+      class OrderedDependencies < Cop # rubocop:disable InternalAffairs/InheritDeprecatedCopClass
         include ConfigurableEnforcedStyle
         include OrderedGemNode
 

data/lib/rubocop/cop/internal_affairs.rb

@@ -2,6 +2,7 @@
 
 require_relative 'internal_affairs/empty_line_between_expect_offense_and_correction'
 require_relative 'internal_affairs/example_description'
+require_relative 'internal_affairs/inherit_deprecated_cop_class'
 require_relative 'internal_affairs/method_name_equal'
 require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_matcher_directive'
@@ -12,4 +13,5 @@ require_relative 'internal_affairs/redundant_let_rubocop_config_new'
 require_relative 'internal_affairs/redundant_location_argument'
 require_relative 'internal_affairs/redundant_message_argument'
 require_relative 'internal_affairs/style_detected_api_use'
+require_relative 'internal_affairs/undefined_config'
 require_relative 'internal_affairs/useless_message_assertion'

data/lib/rubocop/cop/internal_affairs/inherit_deprecated_cop_class.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # `RuboCop::Cop::Cop` is deprecated and will be removed in Rubocop 2.0.
+      # Your custom cop class should inherit from `RuboCop::Cop::Base` instead of
+      # `RuboCop::Cop::Cop`.
+      #
+      # See "v1 Upgrade Notes" for more details:
+      # https://docs.rubocop.org/rubocop/v1_upgrade_notes.html
+      #
+      # @example
+      #   # bad
+      #   class Foo < Cop
+      #   end
+      #
+      #   # good
+      #   class Foo < Base
+      #   end
+      #
+      class InheritDeprecatedCopClass < Base
+        MSG = 'Use `Base` instead of `Cop`.'
+
+        def on_class(node)
+          return unless (parent_class = node.parent_class)
+          return unless parent_class.children.last == :Cop
+
+          add_offense(parent_class)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs/undefined_config.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Looks for references to a cop configuration key that isn't defined in config/default.yml.
+      class UndefinedConfig < Base
+        ALLOWED_CONFIGURATIONS = %w[
+          Safe SafeAutoCorrect AutoCorrect Severity StyleGuide Details Reference Include Exclude
+        ].freeze
+        RESTRICT_ON_SEND = %i[[] fetch].freeze
+        MSG = '`%<name>s` is not defined in the configuration for `%<cop>s` ' \
+              'in `config/default.yml`.'
+
+        # @!method cop_class_def(node)
+        def_node_search :cop_class_def, <<~PATTERN
+          (class _ (const _ {:Base :Cop}) ...)
+        PATTERN
+
+        # @!method cop_config_accessor?(node)
+        def_node_matcher :cop_config_accessor?, <<~PATTERN
+          (send (send nil? :cop_config) {:[] :fetch} ${str sym}...)
+        PATTERN
+
+        def on_new_investigation
+          super
+          return unless processed_source.ast
+
+          cop_class = cop_class_def(processed_source.ast).first
+          return unless (@cop_class_name = extract_cop_name(cop_class))
+
+          @config_for_cop = RuboCop::ConfigLoader.default_configuration.for_cop(@cop_class_name)
+        end
+
+        def on_send(node)
+          return unless cop_class_name
+          return unless (config_name_node = cop_config_accessor?(node))
+          return if always_allowed?(config_name_node)
+          return if configuration_key_defined?(config_name_node)
+
+          message = format(MSG, name: config_name_node.value, cop: cop_class_name)
+          add_offense(config_name_node, message: message)
+        end
+
+        private
+
+        attr_reader :config_for_cop, :cop_class_name
+
+        def extract_cop_name(class_node)
+          return unless class_node
+
+          segments = [class_node].concat(
+            class_node.each_ancestor(:class, :module).take_while do |n|
+              n.identifier.short_name != :Cop
+            end
+          )
+
+          segments.reverse_each.map { |s| s.identifier.short_name }.join('/')
+        end
+
+        def always_allowed?(node)
+          ALLOWED_CONFIGURATIONS.include?(node.value)
+        end
+
+        def configuration_key_defined?(node)
+          config_for_cop.key?(node.value)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/class_structure.rb

@@ -289,12 +289,16 @@ module RuboCop
           (node.first_line - 1).downto(1) do |annotation_line|
             break unless (comment = processed_source.comment_at_line(annotation_line))
 
-            first_comment = comment
+            first_comment = comment if whole_line_comment_at_line?(annotation_line)
           end
 
           start_line_position(first_comment || node)
         end
 
+        def whole_line_comment_at_line?(line)
+          /\A\s*#/.match?(processed_source.lines[line - 1])
+        end
+
         def start_line_position(node)
           buffer.line_range(node.loc.line).begin_pos - 1
         end