rubocop 0.80.1 → 0.85.0

data/lib/rubocop/config_loader_resolver.rb

@@ -17,10 +17,12 @@ module RuboCop
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def resolve_inheritance(path, hash, file, debug)
       inherited_files = Array(hash['inherit_from'])
       base_configs(path, inherited_files, file)
         .reverse.each_with_index do |base_config, index|
+        override_department_setting_for_cops(base_config, hash)
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
 
@@ -34,6 +36,7 @@ module RuboCop
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def resolve_inheritance_from_gems(hash)
       gems = hash.delete('inherit_gem')
@@ -68,9 +71,7 @@ module RuboCop
         end
       end
 
-      if disabled_by_default
-        config = handle_disabled_by_default(config, default_configuration)
-      end
+      config = handle_disabled_by_default(config, default_configuration) if disabled_by_default
 
       opts = { inherit_mode: config['inherit_mode'] || {},
                unset_nil: unset_nil }
@@ -100,8 +101,30 @@ module RuboCop
     end
     # rubocop:enable Metrics/AbcSize
 
+    # An `Enabled: true` setting in user configuration for a cop overrides an
+    # `Enabled: false` setting for its department.
+    def override_department_setting_for_cops(base_hash, derived_hash)
+      derived_hash.each_key do |key|
+        next unless key =~ %r{(.*)/.*}
+
+        department = Regexp.last_match(1)
+        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
+        # cop to be enabled later, when logic surrounding enabled/disabled it
+        # run, even though its department is disabled.
+        derived_hash[key]['Enabled'] = 'override_department' if derived_hash[key]['Enabled']
+      end
+    end
+
     private
 
+    def disabled?(hash, department)
+      hash[department] && hash[department]['Enabled'] == false
+    end
+
     def duplicate_setting?(base_hash, derived_hash, key, inherited_file)
       return false if inherited_file.nil? # Not inheritance resolving merge
       return false if inherited_file.start_with?('..') # Legitimate override
@@ -148,10 +171,20 @@ module RuboCop
 
     def inherited_file(path, inherit_from, file)
       if remote_file?(inherit_from)
+        # A remote configuration, e.g. `inherit_from: http://example.com/rubocop.yml`.
         RemoteConfig.new(inherit_from, File.dirname(path))
+      elsif Pathname.new(inherit_from).absolute?
+        # An absolute path to a config, e.g. `inherit_from: /Users/me/rubocop.yml`.
+        # The path may come from `inherit_gem` option, where a gem name is expanded
+        # to an absolute path to that gem.
+        print 'Inheriting ' if ConfigLoader.debug?
+        inherit_from
       elsif file.is_a?(RemoteConfig)
+        # A path relative to a URL, e.g. `inherit_from: configs/default.yml`
+        # in a config included with `inherit_from: http://example.com/rubocop.yml`
         file.inherit_from_remote(inherit_from, path)
       else
+        # A local relative path, e.g. `inherit_from: default.yml`
         print 'Inheriting ' if ConfigLoader.debug?
         File.expand_path(inherit_from, File.dirname(path))
       end
@@ -181,12 +214,18 @@ module RuboCop
     end
 
     def transform(config)
-      Hash[config.map { |cop, params| [cop, yield(params)] }]
+      config.transform_values { |params| yield(params) }
     end
 
     def gem_config_path(gem_name, relative_config_path)
-      spec = Gem::Specification.find_by_name(gem_name)
-      File.join(spec.gem_dir, relative_config_path)
+      if defined?(Bundler)
+        gem = Bundler.load.specs[gem_name].first
+        gem_path = gem.full_gem_path if gem
+      end
+
+      gem_path ||= Gem::Specification.find_by_name(gem_name).gem_dir
+
+      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}"

data/lib/rubocop/config_obsoletion.rb

@@ -17,8 +17,10 @@ module RuboCop
       'Layout/IndentHash' => 'Layout/FirstHashElementIndentation',
       'Layout/IndentHeredoc' => 'Layout/HeredocIndentation',
       'Layout/LeadingBlankLines' => 'Layout/LeadingEmptyLines',
+      'Layout/Tab' => 'Layout/IndentationStyle',
       'Layout/TrailingBlankLines' => 'Layout/TrailingEmptyLines',
       'Lint/DuplicatedKey' => 'Lint/DuplicateHashKey',
+      'Lint/EndInMethod' => 'Style/EndBlock',
       'Lint/HandleExceptions' => 'Lint/SuppressedException',
       'Lint/MultipleCompare' => 'Lint/MultipleComparison',
       'Lint/StringConversionInInterpolation' => 'Lint/RedundantStringCoercion',

data/lib/rubocop/config_store.rb

@@ -29,14 +29,24 @@ module RuboCop
       @options_config = ConfigLoader.default_configuration
     end
 
-    def for(file_or_dir)
-      return @options_config if @options_config
+    def for_file(file)
+      for_dir(File.dirname(file))
+    end
 
+    # If type (file/dir) is known beforehand,
+    # prefer using #for_file or #for_dir for improved performance
+    def for(file_or_dir)
       dir = if File.directory?(file_or_dir)
               file_or_dir
             else
               File.dirname(file_or_dir)
             end
+      for_dir(dir)
+    end
+
+    def for_dir(dir)
+      return @options_config if @options_config
+
       @path_cache[dir] ||= ConfigLoader.configuration_file_for(dir)
       path = @path_cache[dir]
       @object_cache[path] ||= begin

data/lib/rubocop/config_validator.rb

@@ -13,6 +13,7 @@ module RuboCop
     INTERNAL_PARAMS = %w[Description StyleGuide
                          VersionAdded VersionChanged VersionRemoved
                          Reference Safe SafeAutoCorrect].freeze
+    NEW_COPS_VALUES = %w[pending disable enable].freeze
 
     def_delegators :@config, :smart_loaded_path, :for_all_cops
 
@@ -22,6 +23,7 @@ module RuboCop
       @target_ruby = TargetRuby.new(config)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def validate
       check_cop_config_value(@config)
       reject_conflicting_safe_settings
@@ -37,11 +39,13 @@ module RuboCop
 
       alert_about_unrecognized_cops(invalid_cop_names)
       check_target_ruby
+      validate_new_cops_parameter
       validate_parameter_names(valid_cop_names)
       validate_enforced_styles(valid_cop_names)
       validate_syntax_cop
       reject_mutually_exclusive_defaults
     end
+    # rubocop:enable Metrics/AbcSize
 
     def target_ruby_version
       target_ruby.version
@@ -107,6 +111,18 @@ module RuboCop
             'It\'s not possible to disable this cop.'
     end
 
+    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)
+
+      message = "invalid #{new_cop_parameter} for `NewCops` found in" \
+                "#{smart_loaded_path}\n" \
+                "Valid choices are: #{NEW_COPS_VALUES.join(', ')}"
+
+      raise ValidationError, message
+    end
+
     def validate_parameter_names(valid_cop_names)
       valid_cop_names.each do |name|
         validate_section_presence(name)
@@ -190,7 +206,8 @@ module RuboCop
                        SafeAutoCorrect
                        AutoCorrect].include?(key) && value.is_a?(String)
 
-        next if key == 'Enabled' && value == 'pending'
+        next if key == 'Enabled' &&
+                %w[pending override_department].include?(value)
 
         raise ValidationError, msg_not_boolean(parent, key, value)
       end

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -43,8 +43,7 @@ module RuboCop
       def disable_offense(node)
         range = node.location.expression
         eol_comment = " # rubocop:todo #{cop_name}"
-        needed_line_length = range.column +
-                             (range.source_line + eol_comment).length
+        needed_line_length = (range.source_line + eol_comment).length
         if needed_line_length <= max_line_length
           disable_offense_at_end_of_line(range_of_first_line(range),
                                          eol_comment)

data/lib/rubocop/cop/badge.rb

@@ -4,11 +4,11 @@ module RuboCop
   module Cop
     # Identifier of all cops containing a department and cop name.
     #
-    # All cops are identified by their badge. For example, the badge
-    # for `RuboCop::Cop::Layout::Tab` is `Layout/Tab`. Badges can be
-    # parsed as either `Department/CopName` or just `CopName` to allow
-    # for badge references in source files that omit the department
-    # for RuboCop to infer.
+    # All cops are identified by their badge. For example, the badge for
+    # `RuboCop::Cop::Layout::IndentationStyle` is `Layout/IndentationStyle`.
+    # Badges can be parsed as either `Department/CopName` or just `CopName` to
+    # allow for badge references in source files that omit the department for
+    # RuboCop to infer.
     class Badge
       # Error raised when a badge parse fails.
       class InvalidBadge < Error

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

@@ -5,7 +5,25 @@ module RuboCop
     module Bundler
       # Add a comment describing each gem in your Gemfile.
       #
-      # @example
+      # Optionally, the "OnlyFor" configuration
+      # 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
+      # options that change the source of a gem:
+      #
+      # - `bitbucket`
+      # - `gist`
+      # - `git`
+      # - `github`
+      # - `source`
+      #
+      # For a full list of options supported by bundler,
+      # you can check the https://bundler.io/man/gemfile.5.html[official documentation].
+      #
+      # @example OnlyFor: [] (default)
       #   # bad
       #
       #   gem 'foo'
@@ -15,10 +33,37 @@ module RuboCop
       #   # Helpers for the foo things.
       #   gem 'foo'
       #
+      # @example OnlyFor: ['version_specifiers']
+      #   # bad
+      #
+      #   gem 'foo', '< 2.1'
+      #
+      #   # good
+      #
+      #   # Version 2.1 introduces breaking change baz
+      #   gem 'foo', '< 2.1'
+      #
+      # @example OnlyFor: ['version_specifiers', 'github']
+      #   # bad
+      #
+      #   gem 'foo', github: 'some_account/some_fork_of_foo'
+      #
+      #   gem 'bar', '< 2.1'
+      #
+      #   # good
+      #
+      #   # Using this fork because baz
+      #   gem 'foo', github: 'some_account/some_fork_of_foo'
+      #
+      #   # Version 2.1 introduces breaking change baz
+      #   gem 'bar', '< 2.1'
+      #
       class GemComment < Cop
         include DefNode
 
         MSG = 'Missing gem description comment.'
+        CHECKED_OPTIONS_CONFIG = 'OnlyFor'
+        VERSION_SPECIFIERS_OPTION = 'version_specifiers'
 
         def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
 
@@ -26,6 +71,7 @@ module RuboCop
           return unless gem_declaration?(node)
           return if ignored_gem?(node)
           return if commented?(node)
+          return if cop_config[CHECKED_OPTIONS_CONFIG].any? && !checked_options_present?(node)
 
           add_offense(node)
         end
@@ -58,6 +104,29 @@ module RuboCop
           ignored_gems = Array(cop_config['IgnoredGems'])
           ignored_gems.include?(node.first_argument.value)
         end
+
+        def checked_options_present?(node)
+          (cop_config[CHECKED_OPTIONS_CONFIG].include?(VERSION_SPECIFIERS_OPTION) &&
+            version_specified_gem?(node)) ||
+            contains_checked_options?(node)
+        end
+
+        # Besides the gem name, all other *positional* arguments to `gem` are version specifiers,
+        # as long as it has one we know there's at least one version specifier.
+        def version_specified_gem?(node)
+          # arguments[0] is the gem name
+          node.arguments[1]&.str_type?
+        end
+
+        def contains_checked_options?(node)
+          (Array(cop_config[CHECKED_OPTIONS_CONFIG]) & gem_options(node).map(&:to_s)).any?
+        end
+
+        def gem_options(node)
+          return [] unless node.arguments.last&.type == :hash
+
+          node.arguments.last.keys.map(&:value)
+        end
       end
     end
   end

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

@@ -53,7 +53,7 @@ module RuboCop
         def autocorrect(node)
           lambda do |corrector|
             corrector.replace(
-              node.first_argument.loc.expression, "'https://rubygems.org'"
+              node.first_argument, "'https://rubygems.org'"
             )
           end
         end

data/lib/rubocop/cop/commissioner.rb

@@ -36,7 +36,6 @@ module RuboCop
 
       def investigate(processed_source)
         reset_errors
-        remove_irrelevant_cops(processed_source.file_path)
         reset_callbacks
         prepare(processed_source)
         invoke_custom_processing(@cops, processed_source)
@@ -63,26 +62,6 @@ module RuboCop
         @errors = []
       end
 
-      def remove_irrelevant_cops(filename)
-        @cops.reject! do |cop|
-          cop.excluded_file?(filename) ||
-            !support_target_ruby_version?(cop) ||
-            !support_target_rails_version?(cop)
-        end
-      end
-
-      def support_target_ruby_version?(cop)
-        return true unless cop.class.respond_to?(:support_target_ruby_version?)
-
-        cop.class.support_target_ruby_version?(cop.target_ruby_version)
-      end
-
-      def support_target_rails_version?(cop)
-        return true unless cop.class.respond_to?(:support_target_rails_version?)
-
-        cop.class.support_target_rails_version?(cop.target_rails_version)
-      end
-
       def reset_callbacks
         @callbacks.clear
       end

data/lib/rubocop/cop/cop.rb

@@ -146,17 +146,24 @@ module RuboCop
         @offenses.any? { |o| o.location == location }
       end
 
-      def correct(node)
+      def correct(node) # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength
         reason = reason_to_not_correct(node)
         return reason if reason
 
         @corrected_nodes[node] = true
+
         if support_autocorrect?
           correction = autocorrect(node)
-          return :uncorrected unless correction
 
-          @corrections << Correction.new(correction, node, self)
-          :corrected
+          if correction
+            @corrections << Correction.new(correction, node, self)
+            :corrected
+          elsif disable_uncorrectable?
+            disable_uncorrectable(node)
+            :corrected_with_todo
+          else
+            :uncorrected
+          end
         elsif disable_uncorrectable?
           disable_uncorrectable(node)
           :corrected_with_todo
@@ -211,8 +218,9 @@ module RuboCop
       alias name cop_name
 
       def relevant_file?(file)
-        file_name_matches_any?(file, 'Include', true) &&
-          !file_name_matches_any?(file, 'Exclude', false)
+        file == RuboCop::AST::ProcessedSource::STRING_SOURCE_NAME ||
+          file_name_matches_any?(file, 'Include', true) &&
+            !file_name_matches_any?(file, 'Exclude', false)
       end
 
       def excluded_file?(file)

data/lib/rubocop/cop/corrector.rb

@@ -72,18 +72,18 @@ module RuboCop
 
       # Removes the source range.
       #
-      # @param [Parser::Source::Range] range
-      def remove(range)
-        validate_range range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      def remove(node_or_range)
+        range = to_range(node_or_range)
         @source_rewriter.remove(range)
       end
 
       # Inserts new code before the given source range.
       #
-      # @param [Parser::Source::Range] range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
       # @param [String] content
-      def insert_before(range, content)
-        validate_range range
+      def insert_before(node_or_range, content)
+        range = to_range(node_or_range)
         # TODO: Fix Cops using bad ranges instead
         if range.end_pos > @source_buffer.source.size
           range = range.with(end_pos: @source_buffer.source.size)
@@ -94,28 +94,38 @@ module RuboCop
 
       # Inserts new code after the given source range.
       #
-      # @param [Parser::Source::Range] range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
       # @param [String] content
-      def insert_after(range, content)
-        validate_range range
+      def insert_after(node_or_range, content)
+        range = to_range(node_or_range)
         @source_rewriter.insert_after(range, content)
       end
 
+      # Wraps the given source range with the given before and after texts
+      #
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [String] before
+      # @param [String] after
+      def wrap(node_or_range, before, after)
+        range = to_range(node_or_range)
+        @source_rewriter.wrap(range, before, after)
+      end
+
       # Replaces the code of the source range `range` with `content`.
       #
-      # @param [Parser::Source::Range] range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
       # @param [String] content
-      def replace(range, content)
-        validate_range range
+      def replace(node_or_range, content)
+        range = to_range(node_or_range)
         @source_rewriter.replace(range, content)
       end
 
       # Removes `size` characters prior to the source range.
       #
-      # @param [Parser::Source::Range] range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
       # @param [Integer] size
-      def remove_preceding(range, size)
-        validate_range range
+      def remove_preceding(node_or_range, size)
+        range = to_range(node_or_range)
         to_remove = Parser::Source::Range.new(range.source_buffer,
                                               range.begin_pos - size,
                                               range.begin_pos)
@@ -126,10 +136,10 @@ module RuboCop
       # If `size` is greater than the size of `range`, the removed region can
       # overrun the end of `range`.
       #
-      # @param [Parser::Source::Range] range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
       # @param [Integer] size
-      def remove_leading(range, size)
-        validate_range range
+      def remove_leading(node_or_range, size)
+        range = to_range(node_or_range)
         to_remove = Parser::Source::Range.new(range.source_buffer,
                                               range.begin_pos,
                                               range.begin_pos + size)
@@ -140,10 +150,10 @@ module RuboCop
       # If `size` is greater than the size of `range`, the removed region can
       # overrun the beginning of `range`.
       #
-      # @param [Parser::Source::Range] range
+      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
       # @param [Integer] size
-      def remove_trailing(range, size)
-        validate_range range
+      def remove_trailing(node_or_range, size)
+        range = to_range(node_or_range)
         to_remove = Parser::Source::Range.new(range.source_buffer,
                                               range.end_pos - size,
                                               range.end_pos)
@@ -153,11 +163,25 @@ module RuboCop
       private
 
       # :nodoc:
-      def validate_range(range)
-        buffer = range.source_buffer
+      def to_range(node_or_range)
+        range = case node_or_range
+                when ::RuboCop::AST::Node, ::Parser::Source::Comment
+                  node_or_range.loc.expression
+                when ::Parser::Source::Range
+                  node_or_range
+                else
+                  raise TypeError,
+                        'Expected a Parser::Source::Range, Comment or ' \
+                        "Rubocop::AST::Node, got #{node_or_range.class}"
+                end
+        validate_buffer(range.source_buffer)
+        range
+      end
+
+      def validate_buffer(buffer)
         return if buffer == @source_buffer
 
-        unless buffer.is_a?(Parser::Source::Buffer)
+        unless buffer.is_a?(::Parser::Source::Buffer)
           # actually this should be enforced by parser gem
           raise 'Corrector expected range source buffer to be a ' \
                 "Parser::Source::Buffer, but got #{buffer.class}"