rubocop 0.88.0 → 0.91.1

data/lib/rubocop/config.rb

@@ -24,7 +24,7 @@ module RuboCop
     def initialize(hash = {}, loaded_path = nil)
       @loaded_path = loaded_path
       @for_cop = Hash.new do |h, cop|
-        qualified_cop_name = Cop::Cop.qualified_cop_name(cop, loaded_path)
+        qualified_cop_name = Cop::Registry.qualified_cop_name(cop, loaded_path)
         cop_options = self[qualified_cop_name] || {}
         cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
         h[cop] = cop_options
@@ -47,7 +47,7 @@ module RuboCop
     end
 
     def_delegators :@hash, :[], :[]=, :delete, :each, :key?, :keys, :each_key,
-                   :map, :merge, :to_h, :to_hash, :transform_values
+                   :fetch, :map, :merge, :to_h, :to_hash, :transform_values
     def_delegators :@validator, :validate, :target_ruby_version
 
     def to_s
@@ -104,12 +104,29 @@ module RuboCop
       end
     end
 
+    # @return [Config] for the given cop / cop name.
+    # 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]
     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)
+    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_cop[department_name]
+      @for_department ||= Hash.new do |h, dept|
+        h[dept] = self[dept] || {}
+      end
+      @for_department[department_name.to_s]
     end
 
     def for_all_cops

data/lib/rubocop/config_loader.rb

@@ -34,7 +34,7 @@ module RuboCop
         FileFinder.root_level = nil
       end
 
-      def load_file(file) # rubocop:disable Metrics/AbcSize
+      def load_file(file)
         path = File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
 
         hash = load_yaml_configuration(path)
@@ -73,7 +73,7 @@ module RuboCop
         # `can't add a new key into hash during iteration` error
         hash_keys = hash.keys
         hash_keys.each do |key|
-          q = Cop::Cop.qualified_cop_name(key, path)
+          q = Cop::Registry.qualified_cop_name(key, path)
           next if q == key
 
           hash[q] = hash.delete(key)
@@ -129,9 +129,9 @@ module RuboCop
 
       def default_configuration
         @default_configuration ||= begin
-                                     print 'Default ' if debug?
-                                     load_file(DEFAULT_FILE)
-                                   end
+          print 'Default ' if debug?
+          load_file(DEFAULT_FILE)
+        end
       end
 
       # Returns the path rubocop inferred as the root of the project. No file
@@ -140,22 +140,33 @@ module RuboCop
         @project_root ||= find_project_root
       end
 
+      PENDING_BANNER = <<~BANNER
+        The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
+
+        Please also note that can also opt-in to new cops by default by adding this to your config:
+          AllCops:
+            NewCops: enable
+      BANNER
+
       def warn_on_pending_cops(pending_cops)
         return if pending_cops.empty?
 
-        warn Rainbow('The following cops were added to RuboCop, but are not ' \
-                     'configured. Please set Enabled to either `true` or ' \
-                     '`false` in your `.rubocop.yml` file:').yellow
+        warn Rainbow(PENDING_BANNER).yellow
 
         pending_cops.each do |cop|
-          version = cop.metadata['VersionAdded'] || 'N/A'
-
-          warn Rainbow(" - #{cop.name} (#{version})").yellow
+          warn_pending_cop cop
         end
 
         warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
       end
 
+      def warn_pending_cop(cop)
+        version = cop.metadata['VersionAdded'] || 'N/A'
+
+        warn Rainbow("#{cop.name}: # (new in #{version})").yellow
+        warn Rainbow('  Enabled: true').yellow
+      end
+
       # Merges the given configuration with the default one.
       def merge_with_default(config, config_file, unset_nil: true)
         resolver.merge_with_default(config, config_file, unset_nil: unset_nil)

data/lib/rubocop/config_loader_resolver.rb

@@ -5,6 +5,7 @@ require 'pathname'
 
 module RuboCop
   # A help class for ConfigLoader that handles configuration resolution.
+  # @api private
   class ConfigLoaderResolver
     def resolve_requires(path, hash)
       config_dir = File.dirname(path)
@@ -201,7 +202,7 @@ module RuboCop
         next unless dept_params['Enabled']
 
         new_default_configuration.each do |cop, params|
-          next unless cop.start_with?(dept + '/')
+          next unless cop.start_with?("#{dept}/")
 
           # Retain original default configuration for cops in the department.
           params['Enabled'] = ConfigLoader.default_configuration[cop]['Enabled']
@@ -213,8 +214,8 @@ module RuboCop
       end
     end
 
-    def transform(config)
-      config.transform_values { |params| yield(params) }
+    def transform(config, &block)
+      config.transform_values(&block)
     end
 
     def gem_config_path(gem_name, relative_config_path)

data/lib/rubocop/config_obsoletion.rb

@@ -2,6 +2,7 @@
 
 module RuboCop
   # This class handles obsolete configuration.
+  # @api private
   class ConfigObsoletion
     RENAMED_COPS = {
       'Layout/AlignArguments' => 'Layout/ArgumentAlignment',
@@ -84,7 +85,12 @@ module RuboCop
       'Lint/InvalidCharacterLiteral' => 'it was never being actually triggered',
       'Lint/SpaceBeforeFirstArg' =>
         'it was a duplicate of `Layout/SpaceBeforeFirstArg`. Please use ' \
-        '`Layout/SpaceBeforeFirstArg` instead'
+        '`Layout/SpaceBeforeFirstArg` instead',
+      'Style/MethodMissingSuper' => 'it has been superseded by `Lint/MissingSuper`. Please use ' \
+        '`Lint/MissingSuper` instead',
+      'Lint/UselessComparison' => 'it has been superseded by '\
+        '`Lint/BinaryOperatorWithIdenticalOperands`. Please use '\
+        '`Lint/BinaryOperatorWithIdenticalOperands` instead'
     }.map do |cop_name, reason|
       [cop_name, "The `#{cop_name}` cop has been removed since #{reason}."]
     end

data/lib/rubocop/config_store.rb

@@ -54,9 +54,9 @@ module RuboCop
       @path_cache[dir] ||= ConfigLoader.configuration_file_for(dir)
       path = @path_cache[dir]
       @object_cache[path] ||= begin
-                                print "For #{dir}: " if ConfigLoader.debug?
-                                ConfigLoader.configuration_from_file(path)
-                              end
+        print "For #{dir}: " if ConfigLoader.debug?
+        ConfigLoader.configuration_from_file(path)
+      end
     end
   end
 end

data/lib/rubocop/config_validator.rb

@@ -8,11 +8,14 @@ module RuboCop
   class ConfigValidator
     extend Forwardable
 
+    # @api private
     COMMON_PARAMS = %w[Exclude Include Severity inherit_mode
                        AutoCorrect StyleGuide Details].freeze
+    # @api private
     INTERNAL_PARAMS = %w[Description StyleGuide
                          VersionAdded VersionChanged VersionRemoved
                          Reference Safe SafeAutoCorrect].freeze
+    # @api private
     NEW_COPS_VALUES = %w[pending disable enable].freeze
 
     def_delegators :@config, :smart_loaded_path, :for_all_cops
@@ -23,7 +26,6 @@ module RuboCop
       @target_ruby = TargetRuby.new(config)
     end
 
-    # rubocop:disable Metrics/AbcSize
     def validate
       check_cop_config_value(@config)
       reject_conflicting_safe_settings
@@ -45,7 +47,6 @@ module RuboCop
       validate_syntax_cop
       reject_mutually_exclusive_defaults
     end
-    # rubocop:enable Metrics/AbcSize
 
     def target_ruby_version
       target_ruby.version
@@ -86,7 +87,7 @@ module RuboCop
       unknown_cops = []
       invalid_cop_names.each do |name|
         # There could be a custom cop with this name. If so, don't warn
-        next if Cop::Cop.registry.contains_cop_matching?([name])
+        next if Cop::Registry.global.contains_cop_matching?([name])
 
         # Special case for inherit_mode, which is a directive that we keep in
         # the configuration (even though it's not a cop), because it's easier
@@ -150,7 +151,7 @@ module RuboCop
       end
     end
 
-    def validate_enforced_styles(valid_cop_names)
+    def validate_enforced_styles(valid_cop_names) # rubocop:todo Metrics/AbcSize
       valid_cop_names.each do |name|
         styles = @config[name].select { |key, _| key.start_with?('Enforced') }
 

data/lib/rubocop/cop/base.rb

@@ -46,6 +46,9 @@ module RuboCop
       # Consider creation API private
       InvestigationReport = Struct.new(:cop, :processed_source, :offenses, :corrector)
 
+      # List of methods names to restrict calls for `on_send` / `on_csend`
+      RESTRICT_ON_SEND = Set[].freeze
+
       # List of cops that should not try to autocorrect at the same
       # time as this cop
       #
@@ -56,6 +59,14 @@ module RuboCop
         []
       end
 
+      # Cops (other than builtin) are encouraged to implement this
+      # @return [String, nil]
+      #
+      # @api public
+      def self.documentation_url
+        Documentation.url_for(self) if builtin?
+      end
+
       def initialize(config = nil, options = nil)
         @config = config || Config.new
         @options = options || { debug: false }
@@ -137,6 +148,7 @@ module RuboCop
       end
 
       def self.inherited(subclass)
+        super
         Registry.global.enlist(subclass)
       end
 
@@ -189,8 +201,7 @@ module RuboCop
       def cop_config
         # Use department configuration as basis, but let individual cop
         # configuration override.
-        @cop_config ||= @config.for_cop(self.class.department.to_s)
-                               .merge(@config.for_cop(self))
+        @cop_config ||= @config.for_badge(self.class.badge)
       end
 
       def config_to_allow_offenses
@@ -279,6 +290,10 @@ module RuboCop
         @currently_disabled_lines ||= Set.new
       end
 
+      private_class_method def self.restrict_on_send
+        @restrict_on_send ||= self::RESTRICT_ON_SEND.to_set.freeze
+      end
+
       # Called before any investigation
       def begin_investigation(processed_source)
         @current_offenses = []
@@ -297,6 +312,14 @@ module RuboCop
 
       ### Actually private methods
 
+      def self.builtin?
+        return false unless (m = instance_methods(false).first) # any custom method will do
+
+        path, _line = instance_method(m).source_location
+        path.start_with?(__dir__)
+      end
+      private_class_method :builtin?
+
       def reset_investigation
         @currently_disabled_lines = @current_offenses = @processed_source = @current_corrector = nil
       end

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

@@ -53,7 +53,11 @@ module RuboCop
           gem_declarations(processed_source.ast)
             .group_by(&:first_argument)
             .values
-            .select { |nodes| nodes.size > 1 }
+            .select { |nodes| nodes.size > 1 && !condition?(nodes) }
+        end
+
+        def condition?(nodes)
+          nodes[0].parent&.if_type? && nodes[0].parent == nodes[1].parent
         end
 
         def register_offense(node, gem_name, line_of_first_occurrence)

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

@@ -64,13 +64,14 @@ module RuboCop
         MSG = 'Missing gem description comment.'
         CHECKED_OPTIONS_CONFIG = 'OnlyFor'
         VERSION_SPECIFIERS_OPTION = 'version_specifiers'
+        RESTRICT_ON_SEND = %i[gem].freeze
 
         def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
 
         def on_send(node)
           return unless gem_declaration?(node)
           return if ignored_gem?(node)
-          return if commented?(node)
+          return if commented_any_descendant?(node)
           return if cop_config[CHECKED_OPTIONS_CONFIG].any? && !checked_options_present?(node)
 
           add_offense(node)
@@ -78,6 +79,10 @@ module RuboCop
 
         private
 
+        def commented_any_descendant?(node)
+          commented?(node) || node.each_descendant.any? { |n| commented?(n) }
+        end
+
         def commented?(node)
           preceding_lines = preceding_lines(node)
           preceding_comment?(node, preceding_lines.last)
@@ -86,12 +91,12 @@ module RuboCop
         # The args node1 & node2 may represent a RuboCop::AST::Node
         # or a Parser::Source::Comment. Both respond to #loc.
         def precede?(node1, node2)
-          node2.loc.line - node1.loc.line == 1
+          node2.loc.line - node1.loc.line <= 1
         end
 
         def preceding_lines(node)
           processed_source.ast_with_comments[node].select do |line|
-            line.loc.line < node.loc.line
+            line.loc.line <= node.loc.line
           end
         end
 

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

@@ -34,6 +34,8 @@ module RuboCop
               "Please change your source to 'https://rubygems.org' " \
               "if possible, or 'http://rubygems.org' if not."
 
+        RESTRICT_ON_SEND = %i[source].freeze
+
         def_node_matcher :insecure_protocol_source?, <<~PATTERN
           (send nil? :source
             $(sym ${:gemcutter :rubygems :rubyforge}))

data/lib/rubocop/cop/commissioner.rb

@@ -7,6 +7,9 @@ module RuboCop
     class Commissioner
       include RuboCop::AST::Traversal
 
+      RESTRICTED_CALLBACKS = %i[on_send on_csend].freeze
+      private_constant :RESTRICTED_CALLBACKS
+
       # How a Commissioner returns the results of the investigation
       # as a list of Cop::InvestigationReport and any errors caught
       # during the investigation.
@@ -42,7 +45,8 @@ module RuboCop
         @cops = cops
         @forces = forces
         @options = options
-        @callbacks = {}
+        @callbacks = Hash.new { |h, k| h[k] = cops_callbacks_for(k) }
+        @restricted_map = {}
 
         reset
       end
@@ -57,10 +61,17 @@ module RuboCop
         method_name = :"on_#{node_type}"
         next unless method_defined?(method_name)
 
-        define_method(method_name) do |node|
-          trigger_responding_cops(method_name, node)
-          super(node) unless NO_CHILD_NODES.include?(node_type)
+        if RESTRICTED_CALLBACKS.include?(method_name)
+          trigger_restricted = "trigger_restricted_cops(:on_#{node_type}, node)"
         end
+
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def on_#{node_type}(node)
+            trigger_responding_cops(:on_#{node_type}, node)
+            #{trigger_restricted}
+            #{'super(node)' unless NO_CHILD_NODES.include?(node_type)}
+          end
+        RUBY
       end
 
       # @return [InvestigationReport]
@@ -83,9 +94,6 @@ module RuboCop
       private
 
       def trigger_responding_cops(callback, node)
-        @callbacks[callback] ||= @cops.select do |cop|
-          cop.respond_to?(callback)
-        end
         @callbacks[callback].each do |cop|
           with_cop_error_handling(cop, node) do
             cop.send(callback, node)
@@ -95,7 +103,38 @@ module RuboCop
 
       def reset
         @errors = []
-        @callbacks = {}
+      end
+
+      def cops_callbacks_for(callback)
+        callbacks = @cops.select do |cop|
+          cop.respond_to?(callback)
+        end
+        if RESTRICTED_CALLBACKS.include?(callback)
+          @restricted_map[callback] = restricted_map(callbacks)
+        end
+        callbacks
+      end
+
+      def trigger_restricted_cops(event, node)
+        name = node.method_name
+        @restricted_map.fetch(event)[name]&.each do |cop|
+          with_cop_error_handling(cop, node) do
+            cop.send(event, node)
+          end
+        end
+      end
+
+      # Note: mutates `callbacks` in place
+      def restricted_map(callbacks)
+        map = {}
+        callbacks.select! do |cop|
+          restrictions = cop.class.send :restrict_on_send
+          restrictions.each do |name|
+            (map[name] ||= []) << cop
+          end
+          restrictions.empty?
+        end
+        map
       end
 
       def invoke(callback, cops, *args)