rubocop 1.32.0 → 1.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 270faf06487f8a915ef6293944db136da6fb51ec09b5613be4b848a471c858bb
-  data.tar.gz: 1c61746959019453862c2e90b8d3250ce3f9815b1eae286f1fd5b73fb267a1cb
+  metadata.gz: 11dc3da37672d6576b483ea0d39db975af0044d4c960fa14944fadac1d6f5bd5
+  data.tar.gz: e37200a88a516b923c5c86149de704eec9147f8f35a96df30ced1a0892be8ab4
 SHA512:
-  metadata.gz: 86966e7ff42d0f514a447c8313cc9bdc13020ec1d375e584dba8ebae5bb535a1238380a57d55dfd697c735b3f9259f59939563f4b504f08570304e4ec1c2c7af
-  data.tar.gz: ce35c98b8b51b8b59c6c2aeac880a0618067a68f7080a2e44408a7e283471b2b57f84e57c127144632b61eaa8edf6e4369d4702c2baa222cb3b37fad38606bd5
+  metadata.gz: 42deab573616fd15dfee978f2009b2dafc17b4bb0cf7528c0e0a26f415bad22ede108980403c6036b0b84d28b72981b3862b915a608495bc368935c1bc1ea18b
+  data.tar.gz: 5afa69eeccbcf3ead2bb51f2feaf4dcd81420fa08b0b17b372909647d7b4b559fe1d76d376fec271c7b9d2e8f1ee1cb586075d9a461d5894c1263854fa6f2eea

data/README.md

@@ -46,14 +46,14 @@ If you'd rather install RuboCop using `bundler`, add a line for it in your `Gemf
 gem 'rubocop', require: false
 ```
 
-RuboCop is stable between major versions, both in terms of API and cop configuration.
+RuboCop is stable between minor versions, both in terms of API and cop configuration.
 We aim to ease the maintenance of RuboCop extensions and the upgrades between RuboCop
 releases. All big changes are reserved for major releases.
 To prevent an unwanted RuboCop update you might want to use a conservative version lock
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.32', require: false
+gem 'rubocop', '~> 1.34', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.

data/config/default.yml

@@ -1502,7 +1502,9 @@ Lint/AmbiguousBlockAssociation:
   Enabled: true
   VersionAdded: '0.48'
   VersionChanged: '1.13'
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
 
 Lint/AmbiguousOperator:
   Description: >-
@@ -1602,6 +1604,7 @@ Lint/Debugger:
     # a user's configuration, but are otherwise not significant.
     Kernel:
       - binding.irb
+      - Kernel.binding.irb
     Byebug:
       - byebug
       - remote_byebug
@@ -1619,6 +1622,9 @@ Lint/Debugger:
       - binding.pry
       - binding.remote_pry
       - binding.pry_remote
+      - Kernel.binding.pry
+      - Kernel.binding.remote_pry
+      - Kernel.binding.pry_remote
       - Pry.rescue
     Rails:
       - debugger
@@ -1751,8 +1757,10 @@ Lint/EmptyClass:
 Lint/EmptyConditionalBody:
   Description: 'Checks for the presence of `if`, `elsif` and `unless` branches without a body.'
   Enabled: true
+  SafeAutoCorrect: false
   AllowComments: true
   VersionAdded: '0.89'
+  VersionChanged: '1.34'
 
 Lint/EmptyEnsure:
   Description: 'Checks for empty ensure block.'
@@ -1970,6 +1978,7 @@ Lint/NoReturnInBeginEndBlocks:
 
 Lint/NonAtomicFileOperation:
   Description: Checks for non-atomic file operations.
+  StyleGuide: '#atomic-file-operations'
   Enabled: pending
   VersionAdded: '1.31'
   SafeAutoCorrect: false
@@ -1991,7 +2000,9 @@ Lint/NumberConversion:
   VersionAdded: '0.53'
   VersionChanged: '1.1'
   SafeAutoCorrect: false
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   IgnoredClasses:
     - Time
     - DateTime
@@ -2443,7 +2454,9 @@ Metrics/AbcSize:
   VersionChanged: '1.5'
   # The ABC size is a calculated magnitude, so this number can be an Integer or
   # a Float.
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   CountRepeatedAttributes: true
   Max: 17
 
@@ -2456,10 +2469,12 @@ Metrics/BlockLength:
   Max: 25
   CountAsOne: []
   ExcludedMethods: [] # deprecated, retained for backwards compatibility
-  IgnoredMethods:
+  AllowedMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
     - refine
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   Exclude:
     - '**/*.gemspec'
 
@@ -2489,7 +2504,9 @@ Metrics/CyclomaticComplexity:
   Enabled: true
   VersionAdded: '0.25'
   VersionChanged: '0.81'
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   Max: 7
 
 Metrics/MethodLength:
@@ -2502,7 +2519,9 @@ Metrics/MethodLength:
   Max: 10
   CountAsOne: []
   ExcludedMethods: [] # deprecated, retained for backwards compatibility
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
 
 Metrics/ModuleLength:
   Description: 'Avoid modules longer than 100 lines of code.'
@@ -2530,7 +2549,9 @@ Metrics/PerceivedComplexity:
   Enabled: true
   VersionAdded: '0.25'
   VersionChanged: '0.81'
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   Max: 8
 
 ################## Migration #############################
@@ -3061,7 +3082,7 @@ Style/BlockDelimiters:
     # This looks at the usage of a block's method to determine its type (e.g. is
     # the result of a `map` assigned to a variable or passed to another
     # method) but exceptions are permitted in the `ProceduralMethods`,
-    # `FunctionalMethods` and `IgnoredMethods` sections below.
+    # `FunctionalMethods` and `AllowedMethods` sections below.
     - semantic
     # The `braces_for_chaining` style enforces braces around single line blocks
     # and do..end around multi-line blocks, except for multi-line blocks whose
@@ -3102,7 +3123,7 @@ Style/BlockDelimiters:
     - let!
     - subject
     - watch
-  IgnoredMethods:
+  AllowedMethods:
     # Methods that can be either procedural or functional and cannot be
     # categorised from their usage alone, e.g.
     #
@@ -3119,6 +3140,8 @@ Style/BlockDelimiters:
     - lambda
     - proc
     - it
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   # The AllowBracesOnProceduralOneLiners option is ignored unless the
   # EnforcedStyle is set to `semantic`. If so:
   #
@@ -3222,10 +3245,12 @@ Style/ClassEqualityComparison:
   StyleGuide: '#instance-of-vs-class-comparison'
   Enabled: true
   VersionAdded: '0.93'
-  IgnoredMethods:
+  AllowedMethods:
     - ==
     - equal?
     - eql?
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
 
 Style/ClassMethods:
   Description: 'Use self when defining module/class methods.'
@@ -3687,7 +3712,9 @@ Style/FormatStringToken:
   MaxUnannotatedPlaceholdersAllowed: 1
   VersionAdded: '0.49'
   VersionChanged: '1.0'
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
 
 Style/FrozenStringLiteralComment:
   Description: >-
@@ -4006,7 +4033,8 @@ Style/MethodCallWithArgsParentheses:
   VersionAdded: '0.47'
   VersionChanged: '1.7'
   IgnoreMacros: true
-  IgnoredMethods: []
+  AllowedMethods: []
+  IgnoredMethods: [] # deprecated
   AllowedPatterns: []
   IgnoredPatterns: [] # deprecated
   IncludedMacros: []
@@ -4023,7 +4051,9 @@ Style/MethodCallWithoutArgsParentheses:
   Description: 'Do not use parentheses for method calls with no arguments.'
   StyleGuide: '#method-invocation-parens'
   Enabled: true
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   VersionAdded: '0.47'
   VersionChanged: '0.55'
 
@@ -4375,6 +4405,7 @@ Style/NumericLiterals:
   Strict: false
   # You can specify allowed numbers. (e.g. port number 3000, 8080, and etc)
   AllowedNumbers: []
+  AllowedPatterns: []
 
 Style/NumericPredicate:
   Description: >-
@@ -4393,7 +4424,9 @@ Style/NumericPredicate:
   SupportedStyles:
     - predicate
     - comparison
-  IgnoredMethods: []
+  AllowedMethods: []
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   # Exclude RSpec specs because assertions like `expect(1).to be > 0` cause
   # false positives.
   Exclude:
@@ -5030,11 +5063,13 @@ Style/SymbolProc:
   VersionAdded: '0.26'
   VersionChanged: '1.28'
   AllowMethodsWithArguments: false
-  # A list of method names to be ignored by the check.
+  # 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.
-  IgnoredMethods:
+  AllowedMethods:
     - respond_to
     - define_method
+  AllowedPatterns: []
+  IgnoredMethods: [] # deprecated
   AllowComments: false
 
 Style/TernaryParentheses:

data/config/obsoletion.yml

@@ -187,7 +187,9 @@ changed_parameters:
       - Metrics/BlockLength
       - Metrics/MethodLength
     parameters: ExcludedMethods
-    alternative: IgnoredMethods
+    alternatives:
+      - AllowedMethods
+      - AllowedPatterns
     severity: warning
   - cops: Lint/Debugger
     parameters: DebuggerReceivers
@@ -202,6 +204,26 @@ changed_parameters:
     parameters: IgnoredPatterns
     alternative: AllowedPatterns
     severity: warning
+  - cops:
+      - Lint/AmbiguousBlockAssociation
+      - Lint/NumberConversion
+      - Metrics/AbcSize
+      - Metrics/BlockLength
+      - Metrics/CyclomaticComplexity
+      - Metrics/MethodLength
+      - Metrics/PerceivedComplexity
+      - Style/BlockDelimiters
+      - Style/ClassEqualityComparison
+      - Style/FormatStringToken
+      - Style/MethodCallWithArgsParentheses
+      - Style/MethodCallWithoutArgsParentheses
+      - Style/NumericPredicate
+      - Style/SymbolLiteral
+    parameters: IgnoredMethods
+    alternatives:
+      - AllowedMethods
+      - AllowedPatterns
+    severity: warning
 
 # Enforced styles that have been removed or replaced
 changed_enforced_styles:

data/lib/rubocop/cache_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class represents the cache config of the caching RuboCop runs.
+  # @api private
+  class CacheConfig
+    def self.root_dir
+      root = ENV.fetch('RUBOCOP_CACHE_ROOT', nil)
+      root ||= yield
+      root ||= if ENV.key?('XDG_CACHE_HOME')
+                 # Include user ID in the path to make sure the user has write
+                 # access.
+                 File.join(ENV.fetch('XDG_CACHE_HOME'), Process.uid.to_s)
+               else
+                 # On FreeBSD, the /home path is a symbolic link to /usr/home
+                 # and the $HOME environment variable returns the /home path.
+                 #
+                 # As $HOME is a built-in environment variable, FreeBSD users
+                 # always get a warning message.
+                 #
+                 # To avoid raising warn log messages on FreeBSD, we retrieve
+                 # the real path of the home folder.
+                 File.join(File.realpath(Dir.home), '.cache')
+               end
+
+      File.join(root, 'rubocop_cache')
+    end
+  end
+end

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -98,7 +98,7 @@ module RuboCop
         def add_inheritance_from_auto_generated_file(config_file)
           file_string = " #{relative_path_to_todo_from_options_config}"
 
-          config_file ||= ConfigLoader::DOTFILE
+          config_file ||= ConfigFinder::DOTFILE
 
           if File.exist?(config_file)
             files = Array(ConfigLoader.load_yaml_configuration(config_file)['inherit_from'])
@@ -113,7 +113,7 @@ module RuboCop
           write_config_file(config_file, file_string, rubocop_yml_contents)
 
           puts "Added inheritance from `#{relative_path_to_todo_from_options_config}` " \
-               "in `#{ConfigLoader::DOTFILE}`."
+               "in `#{ConfigFinder::DOTFILE}`."
         end
 
         def existing_configuration(config_file)

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -6,7 +6,7 @@ module RuboCop
       # Generate a .rubocop.yml file in the current directory.
       # @api private
       class InitDotfile < Base
-        DOTFILE = ConfigLoader::DOTFILE
+        DOTFILE = ConfigFinder::DOTFILE
 
         self.command_name = :init
 

data/lib/rubocop/cli/command/suggest_extensions.rb

@@ -17,20 +17,10 @@ module RuboCop
         def run
           return if skip? || extensions.none?
 
-          puts
-          puts 'Tip: Based on detected gems, the following ' \
-               'RuboCop extension libraries might be helpful:'
-
-          extensions.sort.each do |extension|
-            puts "  * #{extension} (https://rubygems.org/gems/#{extension})"
-          end
+          print_install_suggestions if not_installed_extensions.any?
+          print_load_suggestions if installed_and_not_loaded_extensions.any?
 
-          puts
-          puts 'You can opt out of this message by adding the following to your config ' \
-               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions ' \
-               'for more options):'
-          puts '  AllCops:'
-          puts '    SuggestExtensions: false'
+          print_opt_out_instruction
 
           puts if @options[:display_time]
         end
@@ -48,15 +38,63 @@ module RuboCop
             !INCLUDED_FORMATTERS.include?(current_formatter)
         end
 
+        def print_install_suggestions
+          puts
+          puts 'Tip: Based on detected gems, the following ' \
+               'RuboCop extension libraries might be helpful:'
+
+          not_installed_extensions.sort.each do |extension|
+            puts "  * #{extension} (https://rubygems.org/gems/#{extension})"
+          end
+        end
+
+        def print_load_suggestions
+          puts
+          puts 'The following RuboCop extension libraries are installed but not loaded in config:'
+
+          installed_and_not_loaded_extensions.sort.each do |extension|
+            puts "  * #{extension}"
+          end
+        end
+
+        def print_opt_out_instruction
+          puts
+          puts 'You can opt out of this message by adding the following to your config ' \
+               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions ' \
+               'for more options):'
+          puts '  AllCops:'
+          puts '    SuggestExtensions: false'
+        end
+
         def current_formatter
           @options[:format] || @config_store.for_pwd.for_all_cops['DefaultFormatter'] || 'p'
         end
 
-        def extensions
+        def all_extensions
           return [] unless lockfile.dependencies.any?
 
           extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions'] || {}
-          extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys - installed_gems
+          extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys
+        end
+
+        def extensions
+          not_installed_extensions + installed_and_not_loaded_extensions
+        end
+
+        def installed_extensions
+          all_extensions & installed_gems
+        end
+
+        def not_installed_extensions
+          all_extensions - installed_gems
+        end
+
+        def loaded_extensions
+          @config_store.for_pwd.loaded_features.to_a
+        end
+
+        def installed_and_not_loaded_extensions
+          installed_extensions - loaded_extensions
         end
 
         def lockfile

data/lib/rubocop/config_finder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'file_finder'
+
+module RuboCop
+  # This class has methods related to finding configuration path.
+  # @api private
+  class ConfigFinder
+    DOTFILE = '.rubocop.yml'
+    XDG_CONFIG = 'config.yml'
+    RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
+    DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
+
+    class << self
+      include FileFinder
+
+      attr_writer :project_root
+
+      def find_config_path(target_dir)
+        find_project_dotfile(target_dir) || find_user_dotfile || find_user_xdg_config ||
+          DEFAULT_FILE
+      end
+
+      # Returns the path RuboCop inferred as the root of the project. No file
+      # searches will go past this directory.
+      def project_root
+        @project_root ||= find_project_root
+      end
+
+      private
+
+      def find_project_root
+        pwd = Dir.pwd
+        gems_file = find_last_file_upwards('Gemfile', pwd) || find_last_file_upwards('gems.rb', pwd)
+        return unless gems_file
+
+        File.dirname(gems_file)
+      end
+
+      def find_project_dotfile(target_dir)
+        find_file_upwards(DOTFILE, target_dir, project_root)
+      end
+
+      def find_user_dotfile
+        return unless ENV.key?('HOME')
+
+        file = File.join(Dir.home, DOTFILE)
+
+        return file if File.exist?(file)
+      end
+
+      def find_user_xdg_config
+        xdg_config_home = expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config'))
+        xdg_config = File.join(xdg_config_home, 'rubocop', XDG_CONFIG)
+
+        return xdg_config if File.exist?(xdg_config)
+      end
+
+      def expand_path(path)
+        File.expand_path(path)
+      rescue ArgumentError
+        # Could happen because HOME or ID could not be determined. Fall back on
+        # using the path literally in that case.
+        path
+      end
+    end
+  end
+end

data/lib/rubocop/config_loader.rb

@@ -3,6 +3,7 @@
 require 'erb'
 require 'yaml'
 require 'pathname'
+require_relative 'config_finder'
 
 module RuboCop
   # Raised when a RuboCop configuration file is not found.
@@ -15,8 +16,7 @@ module RuboCop
   # during a run of the rubocop program, if files in several
   # directories are inspected.
   class ConfigLoader
-    DOTFILE = '.rubocop.yml'
-    XDG_CONFIG = 'config.yml'
+    DOTFILE = ConfigFinder::DOTFILE
     RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
     DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
 
@@ -25,7 +25,7 @@ module RuboCop
 
       attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
                     :ignore_unrecognized_cops
-      attr_writer :default_configuration, :project_root
+      attr_writer :default_configuration
       attr_reader :loaded_features
 
       alias debug? debug
@@ -95,8 +95,7 @@ module RuboCop
       # user's home directory is checked. If there's no .rubocop.yml
       # there either, the path to the default file is returned.
       def configuration_file_for(target_dir)
-        find_project_dotfile(target_dir) || find_user_dotfile ||
-          find_user_xdg_config || DEFAULT_FILE
+        ConfigFinder.find_config_path(target_dir)
       end
 
       def configuration_from_file(config_file, check: true)
@@ -122,7 +121,7 @@ module RuboCop
       end
 
       def add_excludes_from_files(config, config_file)
-        exclusion_file = find_last_file_upwards(DOTFILE, config_file, project_root)
+        exclusion_file = find_last_file_upwards(DOTFILE, config_file, ConfigFinder.project_root)
 
         return unless exclusion_file
         return if PathUtil.relative_path(exclusion_file) == PathUtil.relative_path(config_file)
@@ -140,8 +139,14 @@ module RuboCop
 
       # 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.
       def project_root
-        @project_root ||= find_project_root
+        warn Rainbow(<<~WARNING).yellow
+          `RuboCop::ConfigLoader.project_root` is deprecated and will be removed in RuboCop 2.0. \
+          Use `RuboCop::ConfigFinder.project_root` instead.
+        WARNING
+
+        ConfigFinder.project_root
       end
 
       PENDING_BANNER = <<~BANNER
@@ -187,39 +192,6 @@ module RuboCop
         File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
       end
 
-      def find_project_dotfile(target_dir)
-        find_file_upwards(DOTFILE, target_dir, project_root)
-      end
-
-      def find_project_root
-        pwd = Dir.pwd
-        gems_file = find_last_file_upwards('Gemfile', pwd) || find_last_file_upwards('gems.rb', pwd)
-        return unless gems_file
-
-        File.dirname(gems_file)
-      end
-
-      def find_user_dotfile
-        return unless ENV.key?('HOME')
-
-        file = File.join(Dir.home, DOTFILE)
-        return file if File.exist?(file)
-      end
-
-      def find_user_xdg_config
-        xdg_config_home = expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config'))
-        xdg_config = File.join(xdg_config_home, 'rubocop', XDG_CONFIG)
-        return xdg_config if File.exist?(xdg_config)
-      end
-
-      def expand_path(path)
-        File.expand_path(path)
-      rescue ArgumentError
-        # Could happen because HOME or ID could not be determined. Fall back on
-        # using the path literally in that case.
-        path
-      end
-
       def resolver
         @resolver ||= ConfigLoaderResolver.new
       end

data/lib/rubocop/config_loader_resolver.rb

@@ -11,11 +11,7 @@ module RuboCop
       config_dir = File.dirname(path)
       hash.delete('require').tap do |loaded_features|
         Array(loaded_features).each do |feature|
-          if feature.start_with?('.')
-            require(File.join(config_dir, feature))
-          else
-            require(feature)
-          end
+          FeatureLoader.load(config_directory_path: config_dir, feature: feature)
         end
       end
     end

data/lib/rubocop/config_obsoletion/changed_parameter.rb

@@ -12,6 +12,11 @@ module RuboCop
 
         if alternative
           "#{base}\n`#{parameter}` has been renamed to `#{alternative.chomp}`."
+        elsif alternatives
+          "#{base}\n`#{parameter}` has been renamed to #{to_sentence(alternatives.map do |item|
+                                                                       "`#{item}`"
+                                                                     end,
+                                                                     connector: 'and/or')}."
         else
           "#{base}\n#{reason.chomp}"
         end

data/lib/rubocop/config_obsoletion/parameter_rule.rb

@@ -32,6 +32,10 @@ module RuboCop
         metadata['alternative']
       end
 
+      def alternatives
+        metadata['alternatives']
+      end
+
       def reason
         metadata['reason']
       end

data/lib/rubocop/config_obsoletion.rb

@@ -47,10 +47,15 @@ module RuboCop
 
     # Default rules for obsoletions are in config/obsoletion.yml
     # Additional rules files can be added with `RuboCop::ConfigObsoletion.files << filename`
-    def load_rules
+    def load_rules # rubocop:disable Metrics/AbcSize
       rules = self.class.files.each_with_object({}) do |filename, hash|
         hash.merge!(YAML.safe_load(File.read(filename))) do |_key, first, second|
-          first.merge(second)
+          case first
+          when Hash
+            first.merge(second)
+          when Array
+            first.concat(second)
+          end
         end
       end
 

data/lib/rubocop/cop/cop.rb

@@ -7,7 +7,7 @@ module RuboCop
   module Cop
     # @deprecated Use Cop::Base instead
     # Legacy scaffold for Cops.
-    # See https://docs.rubocop.org/rubocop/cop_api_v1_changelog.html
+    # See https://docs.rubocop.org/rubocop/v1_upgrade_notes.html
     class Cop < Base
       attr_reader :offenses