rubocop 1.12.1 → 1.16.1

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

@@ -31,9 +31,7 @@ module RuboCop
               # See https://docs.rubocop.org/rubocop/configuration
             DESC
 
-            File.open(DOTFILE, 'w') do |f|
-              f.write(description)
-            end
+            File.open(DOTFILE, 'w') { |f| f.write(description) }
 
             puts "Writing new #{DOTFILE} to #{path}"
 

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

@@ -26,10 +26,7 @@ module RuboCop
           registry = Cop::Registry.global
           show_all = @options[:show_cops].empty?
 
-          if show_all
-            puts "# Available cops (#{registry.length}) " \
-                 "+ config for #{Dir.pwd}: "
-          end
+          puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: " if show_all
 
           registry.departments.sort!.each do |department|
             print_cops_of_department(registry, department, show_all)

data/lib/rubocop/comment_config.rb

@@ -25,16 +25,11 @@ module RuboCop
     end
 
     def extra_enabled_comments
-      extra_enabled_comments_with_names(
-        extras: Hash.new { |h, k| h[k] = [] },
-        names: Hash.new(0)
-      )
+      extra_enabled_comments_with_names(extras: Hash.new { |h, k| h[k] = [] }, names: Hash.new(0))
     end
 
     def comment_only_line?(line_number)
-      non_comment_token_line_numbers.none? do |non_comment_line_number|
-        non_comment_line_number == line_number
-      end
+      non_comment_token_line_numbers.none?(line_number)
     end
 
     private

data/lib/rubocop/config.rb

@@ -45,9 +45,7 @@ module RuboCop
     end
 
     def check
-      deprecation_check do |deprecation_message|
-        warn("#{loaded_path} - #{deprecation_message}")
-      end
+      deprecation_check { |deprecation_message| warn("#{loaded_path} - #{deprecation_message}") }
       @validator.validate
       make_excludes_absolute
       self
@@ -67,8 +65,7 @@ module RuboCop
 
     # True if this is a config file that is shipped with RuboCop
     def internal?
-      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
-                                                    'config'))
+      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME, 'config'))
       File.expand_path(loaded_path).start_with?(base_config_path)
     end
 
@@ -79,8 +76,7 @@ module RuboCop
 
         self[key]['Exclude'].map! do |exclude_elem|
           if exclude_elem.is_a?(String) && !absolute?(exclude_elem)
-            File.expand_path(File.join(base_dir_for_path_parameters,
-                                       exclude_elem))
+            File.expand_path(File.join(base_dir_for_path_parameters, exclude_elem))
           else
             exclude_elem
           end
@@ -122,17 +118,14 @@ module RuboCop
     # 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)
+      fetch(badge.department.to_s) { return cop_config }.merge(cop_config)
     end
 
     # @return [Config] for the given department name.
     # Note: the 'Enabled' attribute will be present only if specified
     # at the department's level
     def for_department(department_name)
-      @for_department ||= Hash.new do |h, dept|
-        h[dept] = self[dept] || {}
-      end
+      @for_department ||= Hash.new { |h, dept| h[dept] = self[dept] || {} }
       @for_department[department_name.to_s]
     end
 
@@ -153,8 +146,7 @@ module RuboCop
 
       # Optimization to quickly decide if the given file is hidden (on the top
       # level) and cannot be matched by any pattern.
-      is_hidden = relative_file_path.start_with?('.') &&
-                  !relative_file_path.start_with?('..')
+      is_hidden = relative_file_path.start_with?('.') && !relative_file_path.start_with?('..')
       return false if is_hidden && !possibly_include_hidden?
 
       absolute_file_path = File.expand_path(file)
@@ -163,8 +155,7 @@ module RuboCop
         if block_given?
           yield pattern, relative_file_path, absolute_file_path
         else
-          match_path?(pattern, relative_file_path) ||
-            match_path?(pattern, absolute_file_path)
+          match_path?(pattern, relative_file_path) || match_path?(pattern, absolute_file_path)
         end
       end
     end
@@ -177,8 +168,7 @@ module RuboCop
 
       file_to_include?(file) do |pattern, relative_path, absolute_path|
         /[A-Z]/.match?(pattern.to_s) &&
-          (match_path?(pattern, relative_path) ||
-           match_path?(pattern, absolute_path))
+          (match_path?(pattern, relative_path) || match_path?(pattern, absolute_path))
       end
     end
 
@@ -194,9 +184,7 @@ module RuboCop
 
     def file_to_exclude?(file)
       file = File.expand_path(file)
-      patterns_to_exclude.any? do |pattern|
-        match_path?(pattern, file)
-      end
+      patterns_to_exclude.any? { |pattern| match_path?(pattern, file) }
     end
 
     def patterns_to_include
@@ -267,8 +255,7 @@ module RuboCop
     private
 
     def target_rails_version_from_bundler_lock_file
-      @target_rails_version_from_bundler_lock_file ||=
-        read_rails_version_from_bundler_lock_file
+      @target_rails_version_from_bundler_lock_file ||= read_rails_version_from_bundler_lock_file
     end
 
     def read_rails_version_from_bundler_lock_file
@@ -288,9 +275,7 @@ module RuboCop
       return true if cop_options['Enabled'] == true
 
       department = department_of(qualified_cop_name)
-      cop_enabled = cop_options.fetch('Enabled') do
-        !for_all_cops['DisabledByDefault']
-      end
+      cop_enabled = cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
       return true if cop_enabled == 'override_department'
       return false if department && department['Enabled'] == false
 

data/lib/rubocop/config_loader.rb

@@ -22,8 +22,7 @@ module RuboCop
     class << self
       include FileFinder
 
-      attr_accessor :debug, :ignore_parent_exclusion,
-                    :disable_pending_cops, :enable_pending_cops
+      attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops
       attr_writer :default_configuration, :project_root
       attr_reader :loaded_features
 
@@ -58,9 +57,7 @@ module RuboCop
 
       def load_yaml_configuration(absolute_path)
         file_contents = read_file(absolute_path)
-        yaml_code = Dir.chdir(File.dirname(absolute_path)) do
-          ERB.new(file_contents).result
-        end
+        yaml_code = Dir.chdir(File.dirname(absolute_path)) { ERB.new(file_contents).result }
         check_duplication(yaml_code, absolute_path)
         hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
@@ -156,9 +153,7 @@ module RuboCop
 
         warn Rainbow(PENDING_BANNER).yellow
 
-        pending_cops.each do |cop|
-          warn_pending_cop cop
-        end
+        pending_cops.each { |cop| warn_pending_cop cop }
 
         warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
       end
@@ -246,10 +241,9 @@ module RuboCop
       # stderr. Care is taken to use the standard OS exit code for a "file not
       # found" error.
       def read_file(absolute_path)
-        IO.read(absolute_path, encoding: Encoding::UTF_8)
+        File.read(absolute_path, encoding: Encoding::UTF_8)
       rescue Errno::ENOENT
-        raise ConfigNotFoundError,
-              "Configuration file not found: #{absolute_path}"
+        raise ConfigNotFoundError, "Configuration file not found: #{absolute_path}"
       end
 
       def yaml_safe_load(yaml_code, filename)

data/lib/rubocop/config_loader_resolver.rb

@@ -37,16 +37,30 @@ module RuboCop
                       inherit_mode: determine_inherit_mode(hash, k))
           end
           hash[k] = v
+          fix_include_paths(base_config.loaded_path, hash, path, k, v) if v.key?('Include')
         end
       end
     end
 
+    # When one .rubocop.yml file inherits from another .rubocop.yml file, the Include paths in the
+    # base configuration are relative to the directory where the base configuration file is. For the
+    # derived configuration, we need to make those paths relative to where the derived configuration
+    # file is.
+    def fix_include_paths(base_config_path, hash, path, key, value)
+      return unless File.basename(base_config_path).start_with?('.rubocop')
+
+      base_dir = File.dirname(base_config_path)
+      derived_dir = File.dirname(path)
+      hash[key]['Include'] = value['Include'].map do |include_path|
+        PathUtil.relative_path(File.join(base_dir, include_path), derived_dir)
+      end
+    end
+
     def resolve_inheritance_from_gems(hash)
       gems = hash.delete('inherit_gem')
       (gems || {}).each_pair do |gem_name, config_path|
         if gem_name == 'rubocop'
-          raise ArgumentError,
-                "can't inherit configuration from the rubocop gem"
+          raise ArgumentError, "can't inherit configuration from the rubocop gem"
         end
 
         hash['inherit_from'] = Array(hash['inherit_from'])
@@ -77,8 +91,7 @@ module RuboCop
       config = handle_disabled_by_default(config, default_configuration) if disabled_by_default
       override_enabled_for_disabled_departments(default_configuration, config)
 
-      opts = { inherit_mode: config['inherit_mode'] || {},
-               unset_nil: unset_nil }
+      opts = { inherit_mode: config['inherit_mode'] || {}, unset_nil: unset_nil }
       Config.new(merge(default_configuration, config, **opts), config_file)
     end
 
@@ -112,8 +125,7 @@ module RuboCop
         next unless key =~ %r{(.*)/.*}
 
         department = Regexp.last_match(1)
-        next unless disabled?(derived_hash, department) ||
-                    disabled?(base_hash, department)
+        next unless disabled?(derived_hash, department) || disabled?(base_hash, department)
 
         # The `override_department` setting for the `Enabled` parameter is an
         # internal setting that's not documented in the manual. It will cause a
@@ -155,13 +167,10 @@ module RuboCop
     end
 
     def warn_on_duplicate_setting(base_hash, derived_hash, key, **opts)
-      return unless duplicate_setting?(base_hash, derived_hash,
-                                       key, opts[:inherited_file])
+      return unless duplicate_setting?(base_hash, derived_hash, key, opts[:inherited_file])
 
-      inherit_mode = opts[:inherit_mode]['merge'] ||
-                     opts[:inherit_mode]['override']
-      return if base_hash[key].is_a?(Array) &&
-                inherit_mode && inherit_mode.include?(key)
+      inherit_mode = opts[:inherit_mode]['merge'] || opts[:inherit_mode]['override']
+      return if base_hash[key].is_a?(Array) && inherit_mode && inherit_mode.include?(key)
 
       puts "#{PathUtil.smart_path(opts[:file])}: " \
            "#{opts[:cop_name]}:#{key} overrides " \
@@ -251,8 +260,7 @@ module RuboCop
 
       File.join(gem_path, relative_config_path)
     rescue Gem::LoadError => e
-      raise Gem::LoadError,
-            "Unable to find gem #{gem_name}; is the gem installed? #{e}"
+      raise Gem::LoadError, "Unable to find gem #{gem_name}; is the gem installed? #{e}"
     end
   end
 end

data/lib/rubocop/config_obsoletion/cop_rule.rb

@@ -17,8 +17,7 @@ module RuboCop
       end
 
       def message
-        rule_message + "\n(obsolete configuration found in " \
-                       "#{smart_loaded_path}, please update it)"
+        rule_message + "\n(obsolete configuration found in #{smart_loaded_path}, please update it)"
       end
 
       # Cop rules currently can only be failures, not warnings

data/lib/rubocop/config_store.rb

@@ -27,8 +27,7 @@ module RuboCop
 
     def options_config=(options_config)
       loaded_config = ConfigLoader.load_file(options_config)
-      @options_config = ConfigLoader.merge_with_default(loaded_config,
-                                                        options_config)
+      @options_config = ConfigLoader.merge_with_default(loaded_config, options_config)
     end
 
     def force_default_config!

data/lib/rubocop/config_validator.rb

@@ -9,8 +9,7 @@ module RuboCop
     extend Forwardable
 
     # @api private
-    COMMON_PARAMS = %w[Exclude Include Severity inherit_mode
-                       AutoCorrect StyleGuide Details].freeze
+    COMMON_PARAMS = %w[Exclude Include Severity inherit_mode AutoCorrect StyleGuide Details].freeze
     # @api private
     INTERNAL_PARAMS = %w[Description StyleGuide
                          VersionAdded VersionChanged VersionRemoved
@@ -60,8 +59,7 @@ module RuboCop
     def validate_section_presence(name)
       return unless @config.key?(name) && @config[name].nil?
 
-      raise ValidationError,
-            "empty section #{name} found in #{smart_loaded_path}"
+      raise ValidationError, "empty section #{name} found in #{smart_loaded_path}"
     end
 
     private
@@ -123,8 +121,7 @@ module RuboCop
       syntax_config = @config['Lint/Syntax']
       default_config = ConfigLoader.default_configuration['Lint/Syntax']
 
-      return unless syntax_config &&
-                    default_config.merge(syntax_config) != default_config
+      return unless syntax_config && default_config.merge(syntax_config) != default_config
 
       raise ValidationError,
             "configuration for Syntax cop found in #{smart_loaded_path}\n" \
@@ -133,8 +130,7 @@ module RuboCop
 
     def validate_new_cops_parameter
       new_cop_parameter = @config.for_all_cops['NewCops']
-      return if new_cop_parameter.nil? ||
-                NEW_COPS_VALUES.include?(new_cop_parameter)
+      return if new_cop_parameter.nil? || NEW_COPS_VALUES.include?(new_cop_parameter)
 
       message = "invalid #{new_cop_parameter} for `NewCops` found in" \
                 "#{smart_loaded_path}\n" \
@@ -208,8 +204,7 @@ module RuboCop
     def reject_conflicting_safe_settings
       @config.each do |name, cop_config|
         next unless cop_config.is_a?(Hash)
-        next unless cop_config['Safe'] == false &&
-                    cop_config['SafeAutoCorrect'] == true
+        next unless cop_config['Safe'] == false && cop_config['SafeAutoCorrect'] == true
 
         msg = 'Unsafe cops cannot have a safe auto-correction ' \
               "(section #{name} in #{smart_loaded_path})"

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -21,8 +21,7 @@ module RuboCop
       end
 
       def safe_autocorrect?
-        cop_config.fetch('Safe', true) &&
-          cop_config.fetch('SafeAutoCorrect', true)
+        cop_config.fetch('Safe', true) && cop_config.fetch('SafeAutoCorrect', true)
       end
 
       def autocorrect_enabled?
@@ -68,9 +67,7 @@ module RuboCop
         begin_of_first_line = range.begin_pos - range.column
         end_of_first_line = begin_of_first_line + range.source_line.length
 
-        Parser::Source::Range.new(range.source_buffer,
-                                  begin_of_first_line,
-                                  end_of_first_line)
+        Parser::Source::Range.new(range.source_buffer, begin_of_first_line, end_of_first_line)
       end
 
       # Expand the given range to include all of any lines it covers. Does not
@@ -82,9 +79,7 @@ module RuboCop
         last_line_offset = last_line.length - range.last_column
         end_of_last_line = range.end_pos + last_line_offset
 
-        Parser::Source::Range.new(range.source_buffer,
-                                  begin_of_first_line,
-                                  end_of_last_line)
+        Parser::Source::Range.new(range.source_buffer, begin_of_first_line, end_of_last_line)
       end
 
       def max_line_length

data/lib/rubocop/cop/badge.rb

@@ -38,8 +38,7 @@ module RuboCop
       end
 
       def match?(other)
-        cop_name == other.cop_name &&
-          (!qualified? || department == other.department)
+        cop_name == other.cop_name && (!qualified? || department == other.department)
       end
 
       def to_s

data/lib/rubocop/cop/base.rb

@@ -187,8 +187,7 @@ module RuboCop
       def self.match?(given_names)
         return false unless given_names
 
-        given_names.include?(cop_name) ||
-          given_names.include?(department.to_s)
+        given_names.include?(cop_name) || given_names.include?(department.to_s)
       end
 
       def cop_name
@@ -206,13 +205,11 @@ module RuboCop
       end
 
       def config_to_allow_offenses
-        Formatter::DisabledConfigFormatter
-          .config_to_allow_offenses[cop_name] ||= {}
+        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] ||= {}
       end
 
       def config_to_allow_offenses=(hash)
-        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] =
-          hash
+        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] = hash
       end
 
       def target_ruby_version
@@ -233,6 +230,11 @@ module RuboCop
         !relevant_file?(file)
       end
 
+      # There should be very limited reasons for a Cop to do it's own parsing
+      def parse(source, path = nil)
+        ProcessedSource.new(source, target_ruby_version, path)
+      end
+
       ### Persistence
 
       # Override if your cop should be called repeatedly for multiple investigations

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

@@ -83,8 +83,7 @@ module RuboCop
 
         def register_offense(node, gem_name, line_of_first_occurrence)
           line_range = node.loc.column...node.loc.last_column
-          offense_location =
-            source_range(processed_source.buffer, node.first_line, line_range)
+          offense_location = source_range(processed_source.buffer, node.first_line, line_range)
           message = format(
             MSG,
             gem_name: gem_name,

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

@@ -3,15 +3,24 @@
 module RuboCop
   module Cop
     module Bundler
-      # Add a comment describing each gem in your Gemfile.
+      # Each gem in the Gemfile should have a comment explaining
+      # its purpose in the project, or the reason for its version
+      # or source.
       #
-      # Optionally, the "OnlyFor" configuration
+      # The optional "OnlyFor" configuration array
       # can be used to only register offenses when the gems
       # use certain options or have version specifiers.
-      # Add "version_specifiers" and/or the gem option names
-      # you want to check.
       #
-      # A useful use-case is to enforce a comment when using
+      # When "version_specifiers" is included, a comment
+      # will be enforced if the gem has any version specifier.
+      #
+      # When "restrictive_version_specifiers" is included, a comment
+      # will be enforced if the gem has a version specifier that
+      # holds back the version of the gem.
+      #
+      # For any other value in the array, a comment will be enforced for
+      # a gem if an option by the same name is present.
+      # A useful use case is to enforce a comment when using
       # options that change the source of a gem:
       #
       # - `bitbucket`
@@ -21,7 +30,8 @@ module RuboCop
       # - `source`
       #
       # For a full list of options supported by bundler,
-      # you can check the https://bundler.io/man/gemfile.5.html[official documentation].
+      # see https://bundler.io/man/gemfile.5.html
+      # .
       #
       # @example OnlyFor: [] (default)
       #   # bad
@@ -43,6 +53,18 @@ module RuboCop
       #   # Version 2.1 introduces breaking change baz
       #   gem 'foo', '< 2.1'
       #
+      # @example OnlyFor: ['restrictive_version_specifiers']
+      #   # bad
+      #
+      #   gem 'foo', '< 2.1'
+      #
+      #   # good
+      #
+      #   gem 'foo', '>= 1.0'
+      #
+      #   # Version 2.1 introduces breaking change baz
+      #   gem 'foo', '< 2.1'
+      #
       # @example OnlyFor: ['version_specifiers', 'github']
       #   # bad
       #
@@ -60,15 +82,15 @@ module RuboCop
       #
       class GemComment < Base
         include DefNode
+        include GemDeclaration
 
         MSG = 'Missing gem description comment.'
         CHECKED_OPTIONS_CONFIG = 'OnlyFor'
         VERSION_SPECIFIERS_OPTION = 'version_specifiers'
+        RESTRICTIVE_VERSION_SPECIFIERS_OPTION = 'restrictive_version_specifiers'
+        RESTRICTIVE_VERSION_PATTERN = /<|~>/.freeze
         RESTRICT_ON_SEND = %i[gem].freeze
 
-        # @!method gem_declaration?(node)
-        def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
-
         def on_send(node)
           return unless gem_declaration?(node)
           return if ignored_gem?(node)
@@ -102,8 +124,7 @@ module RuboCop
         end
 
         def preceding_comment?(node1, node2)
-          node1 && node2 && precede?(node2, node1) &&
-            comment_line?(node2.loc.expression.source)
+          node1 && node2 && precede?(node2, node1) && comment_line?(node2.loc.expression.source)
         end
 
         def ignored_gem?(node)
@@ -114,6 +135,8 @@ module RuboCop
         def checked_options_present?(node)
           (cop_config[CHECKED_OPTIONS_CONFIG].include?(VERSION_SPECIFIERS_OPTION) &&
             version_specified_gem?(node)) ||
+            (cop_config[CHECKED_OPTIONS_CONFIG].include?(RESTRICTIVE_VERSION_SPECIFIERS_OPTION) &&
+              restrictive_version_specified_gem?(node)) ||
             contains_checked_options?(node)
         end
 
@@ -124,6 +147,15 @@ module RuboCop
           node.arguments[1]&.str_type?
         end
 
+        # Version specifications that restrict all updates going forward. This excludes versions
+        # like ">= 1.0" or "!= 2.0.3".
+        def restrictive_version_specified_gem?(node)
+          return unless version_specified_gem?(node)
+
+          node.arguments
+              .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.to_s) }
+        end
+
         def contains_checked_options?(node)
           (Array(cop_config[CHECKED_OPTIONS_CONFIG]) & gem_options(node).map(&:to_s)).any?
         end