rubocop 0.82.0 → 0.86.0

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

@@ -206,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/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/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

@@ -23,7 +23,7 @@ module RuboCop
     #       # Do custom processing
     #     end
     #   end
-    class Cop
+    class Cop # rubocop:disable Metrics/ClassLength
       extend RuboCop::AST::Sexp
       extend NodePattern::Macros
       include RuboCop::AST::Sexp
@@ -44,22 +44,12 @@ module RuboCop
       attr_reader :config, :offenses, :corrections
       attr_accessor :processed_source # TODO: Bad design.
 
-      @registry = Registry.new
-
-      class << self
-        attr_reader :registry
-      end
-
-      def self.all
-        registry.without_department(:Test).cops
-      end
-
-      def self.qualified_cop_name(name, origin)
-        registry.qualified_cop_name(name, origin)
+      def self.inherited(subclass)
+        Registry.global.enlist(subclass)
       end
 
-      def self.inherited(subclass)
-        registry.enlist(subclass)
+      def self.exclude_from_registry
+        Registry.global.dismiss(self)
       end
 
       def self.badge
@@ -146,17 +136,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 +208,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)
@@ -238,6 +236,23 @@ module RuboCop
         nil
       end
 
+      ### Deprecated registry access
+
+      # @deprecated Use Registry.global
+      def self.registry
+        Registry.global
+      end
+
+      # @deprecated Use Registry.all
+      def self.all
+        Registry.all
+      end
+
+      # @deprecated Use Registry.qualified_cop_name
+      def self.qualified_cop_name(name, origin)
+        Registry.qualified_cop_name(name, origin)
+      end
+
       private
 
       def find_message(node, message)

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

@@ -48,9 +48,7 @@ module RuboCop
           return if taboo_ranges.any? { |t| within?(range, t) }
 
           if column_delta.positive?
-            unless range.resize(1).source == "\n"
-              corrector.insert_before(range, ' ' * column_delta)
-            end
+            corrector.insert_before(range, ' ' * column_delta) unless range.resize(1).source == "\n"
           elsif /\A[ \t]+\z/.match?(range.source)
             remove(range, corrector)
           end
@@ -92,9 +90,7 @@ module RuboCop
         end
 
         def calculate_range(expr, line_begin_pos, column_delta)
-          if column_delta.positive?
-            return range_between(line_begin_pos, line_begin_pos)
-          end
+          return range_between(line_begin_pos, line_begin_pos) if column_delta.positive?
 
           starts_with_space =
             expr.source_buffer.source[line_begin_pos].start_with?(' ')

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

@@ -129,7 +129,7 @@ module RuboCop
       end
 
       def separating_space?
-        block_begin.source_buffer.source[block_begin.begin_pos + 2].match(/\s/)
+        block_begin.source_buffer.source[block_begin.begin_pos + 2].match?(/\s/)
       end
     end
   end

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

@@ -35,9 +35,7 @@ module RuboCop
 
         def add_space(processed_source, corrector, left_token, right_token)
           @processed_source = processed_source
-          unless left_token.space_after?
-            corrector.insert_after(left_token.pos, ' ')
-          end
+          corrector.insert_after(left_token.pos, ' ') unless left_token.space_after?
           return if right_token.space_before?
 
           corrector.insert_before(right_token.pos, ' ')

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

@@ -68,9 +68,7 @@ module RuboCop
               gem_name(current),
               gem_name(previous)
             )
-            unless get_dependency_name(previous) == get_dependency_name(current)
-              next
-            end
+            next unless get_dependency_name(previous) == get_dependency_name(current)
 
             register_offense(previous, current)
           end

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

@@ -64,7 +64,7 @@ module RuboCop
         def extract_ruby_version(required_ruby_version)
           if required_ruby_version.array_type?
             required_ruby_version = required_ruby_version.children.detect do |v|
-              v.str_content =~ /[>=]/
+              /[>=]/.match?(v.str_content)
             end
           end
 

data/lib/rubocop/cop/generator.rb

@@ -58,7 +58,7 @@ module RuboCop
                 # TODO: Implement the cop in here.
                 #
                 # In many cases, you can use a node matcher for matching node pattern.
-                # See https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/node_pattern.rb
+                # See https://github.com/rubocop-hq/rubocop-ast/blob/master/lib/rubocop/node_pattern.rb
                 #
                 # For example
                 MSG = 'Use `#good_method` instead of `#bad_method`.'
@@ -132,11 +132,12 @@ module RuboCop
         ).inject
       end
 
-      def inject_config(config_file_path: 'config/default.yml')
+      def inject_config(config_file_path: 'config/default.yml',
+                        version_added: bump_minor_version)
         injector =
           ConfigurationInjector.new(configuration_file_path: config_file_path,
                                     badge: badge,
-                                    version_added: bump_minor_version)
+                                    version_added: version_added)
 
         injector.inject do
           output.puts(format(CONFIGURATION_ADDED_MESSAGE,

data/lib/rubocop/cop/generator/configuration_injector.rb

@@ -58,7 +58,7 @@ module RuboCop
         end
 
         def cop_name_line?(yaml)
-          yaml !~ /^[\s#]/
+          !/^[\s#]/.match?(yaml)
         end
       end
     end

data/lib/rubocop/cop/ignored_node.rb

@@ -10,9 +10,7 @@ module RuboCop
 
       def part_of_ignored_node?(node)
         ignored_nodes.map(&:loc).any? do |ignored_loc|
-          if ignored_loc.expression.begin_pos > node.source_range.begin_pos
-            next false
-          end
+          next false if ignored_loc.expression.begin_pos > node.source_range.begin_pos
 
           ignored_end_pos = if ignored_loc.respond_to?(:heredoc_body)
                               ignored_loc.heredoc_end.end_pos

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

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks how the *when*s of a *case* expression
-      # are indented in relation to its *case* or *end* keyword.
+      # This cop checks how the ``when``s of a `case` expression
+      # are indented in relation to its `case` or `end` keyword.
       #
-      # It will register a separate offense for each misaligned *when*.
+      # It will register a separate offense for each misaligned `when`.
       #
       # @example
       #   # If Layout/EndAlignment is set to keyword style (default)

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

@@ -8,22 +8,24 @@ module RuboCop
       # `Categories` allows us to map macro names into a category.
       #
       # Consider an example of code style that covers the following order:
-      # - Module inclusion (include, prepend, extend)
-      # - Constants
-      # - Associations (has_one, has_many)
-      # - Public attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Other macros (validates, validate)
-      # - Public class methods
-      # - Initializer
-      # - Public instance methods
-      # - Protected attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Protected instance methods
-      # - Private attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Private instance methods
+      #
+      # * Module inclusion (include, prepend, extend)
+      # * Constants
+      # * Associations (has_one, has_many)
+      # * Public attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Other macros (validates, validate)
+      # * Public class methods
+      # * Initializer
+      # * Public instance methods
+      # * Protected attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Protected instance methods
+      # * Private attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Private instance methods
       #
       # You can configure the following order:
       #
-      # ```yaml
+      # [source,yaml]
+      # ----
       #  Layout/ClassStructure:
       #    ExpectedOrder:
       #      - module_inclusion
@@ -40,13 +42,14 @@ module RuboCop
       #      - private_attribute_macros
       #      - private_delegate
       #      - private_methods
-      # ```
+      # ----
       #
       # Instead of putting all literals in the expected order, is also
       # possible to group categories of macros. Visibility levels are handled
       # automatically.
       #
-      # ```yaml
+      # [source,yaml]
+      # ----
       #  Layout/ClassStructure:
       #    Categories:
       #      association:
@@ -63,7 +66,7 @@ module RuboCop
       #        - include
       #        - prepend
       #        - extend
-      # ```
+      # ----
       #
       # @example
       #   # bad