rubocop 0.91.0 → 1.0.0

data/lib/rubocop.rb

@@ -8,12 +8,14 @@ require 'set'
 require 'forwardable'
 require 'regexp_parser'
 require 'unicode/display_width/no_string_ext'
+
+# we have to require RuboCop's version, before rubocop-ast's
+require_relative 'rubocop/version'
 require 'rubocop-ast'
+
 require_relative 'rubocop/ast_aliases'
 require_relative 'rubocop/ext/regexp_node'
 
-require_relative 'rubocop/version'
-
 require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/ext/processed_source'
 
@@ -25,7 +27,6 @@ require_relative 'rubocop/string_interpreter'
 require_relative 'rubocop/error'
 require_relative 'rubocop/warning'
 
-require_relative 'rubocop/cop/tokens_util'
 require_relative 'rubocop/cop/util'
 require_relative 'rubocop/cop/offense'
 require_relative 'rubocop/cop/message_annotator'
@@ -104,7 +105,6 @@ require_relative 'rubocop/cop/mixin/percent_literal'
 require_relative 'rubocop/cop/mixin/preceding_following_alignment'
 require_relative 'rubocop/cop/mixin/preferred_delimiters'
 require_relative 'rubocop/cop/mixin/rational_literal'
-require_relative 'rubocop/cop/mixin/regexp_literal_help'
 require_relative 'rubocop/cop/mixin/rescue_node'
 require_relative 'rubocop/cop/mixin/safe_assignment'
 require_relative 'rubocop/cop/mixin/space_after_punctuation'
@@ -278,6 +278,7 @@ require_relative 'rubocop/cop/lint/flip_flop'
 require_relative 'rubocop/cop/lint/float_comparison'
 require_relative 'rubocop/cop/lint/float_out_of_range'
 require_relative 'rubocop/cop/lint/format_parameter_mismatch'
+require_relative 'rubocop/cop/lint/hash_compare_by_identity'
 require_relative 'rubocop/cop/lint/heredoc_method_call_position'
 require_relative 'rubocop/cop/lint/identity_comparison'
 require_relative 'rubocop/cop/lint/implicit_string_concatenation'
@@ -307,6 +308,7 @@ require_relative 'rubocop/cop/lint/rand_one'
 require_relative 'rubocop/cop/lint/redundant_cop_disable_directive'
 require_relative 'rubocop/cop/lint/redundant_cop_enable_directive'
 require_relative 'rubocop/cop/lint/redundant_require_statement'
+require_relative 'rubocop/cop/lint/redundant_safe_navigation'
 require_relative 'rubocop/cop/lint/redundant_splat_expansion'
 require_relative 'rubocop/cop/lint/redundant_string_coercion'
 require_relative 'rubocop/cop/lint/redundant_with_index'
@@ -397,6 +399,7 @@ require_relative 'rubocop/cop/style/case_like_if'
 require_relative 'rubocop/cop/style/character_literal'
 require_relative 'rubocop/cop/style/class_and_module_children'
 require_relative 'rubocop/cop/style/class_check'
+require_relative 'rubocop/cop/style/class_equality_comparison'
 require_relative 'rubocop/cop/style/class_methods'
 require_relative 'rubocop/cop/style/class_methods_definitions'
 require_relative 'rubocop/cop/style/class_vars'
@@ -468,8 +471,6 @@ require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/sole_nested_conditional'
-require_relative 'rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses'
-require_relative 'rubocop/cop/style/method_call_with_args_parentheses/require_parentheses'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'
 require_relative 'rubocop/cop/style/method_def_parentheses'
 require_relative 'rubocop/cop/style/min_max'
@@ -615,6 +616,7 @@ require_relative 'rubocop/config_obsoletion'
 require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
 require_relative 'rubocop/target_finder'
+require_relative 'rubocop/directive_comment'
 require_relative 'rubocop/comment_config'
 require_relative 'rubocop/magic_comment'
 require_relative 'rubocop/result_cache'
@@ -628,6 +630,7 @@ require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/show_cops'
 require_relative 'rubocop/cli/command/version'
+require_relative 'rubocop/config_regeneration'
 require_relative 'rubocop/options'
 require_relative 'rubocop/remote_config'
 require_relative 'rubocop/target_ruby'
@@ -636,3 +639,4 @@ require_relative 'rubocop/yaml_duplication_checker'
 unless File.exist?("#{__dir__}/../rubocop.gemspec") # Check if we are a gem
   RuboCop::ResultCache.rubocop_required_features = $LOADED_FEATURES - before_us
 end
+RuboCop::AST.rubocop_loaded if RuboCop::AST.respond_to?(:rubocop_loaded)

data/lib/rubocop/cached_data.rb

@@ -21,6 +21,7 @@ module RuboCop
     private
 
     def serialize_offense(offense)
+      status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
       {
         # Calling #to_s here ensures that the serialization works when using
         # other json serializers such as Oj. Some of these gems do not call
@@ -32,7 +33,7 @@ module RuboCop
         },
         message:  message(offense),
         cop_name: offense.cop_name,
-        status:   :uncorrected
+        status:   status || offense.status
       }
     end
 

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

@@ -10,7 +10,7 @@ module RuboCop
 
         def run
           puts RuboCop::Version.version(debug: false) if @options[:version]
-          puts RuboCop::Version.version(debug: true) if @options[:verbose_version]
+          puts RuboCop::Version.version(debug: true, env: env) if @options[:verbose_version]
         end
       end
     end

data/lib/rubocop/comment_config.rb

@@ -41,12 +41,15 @@ module RuboCop
     end
 
     def extra_enabled_comments
-      extra_enabled_comments_with_names([], {})
+      extra_enabled_comments_with_names(
+        extras: Hash.new { |h, k| h[k] = [] },
+        names: Hash.new(0)
+      )
     end
 
     private
 
-    def extra_enabled_comments_with_names(extras, names)
+    def extra_enabled_comments_with_names(extras:, names:)
       each_directive do |comment, cop_names, disabled|
         next unless comment_only_line?(comment.loc.expression.line)
 
@@ -190,18 +193,19 @@ module RuboCop
         enabled_cops += 1
       end
 
-      extras << [comment, 'all'] if enabled_cops.zero?
+      extras[comment] << 'all' if enabled_cops.zero?
     end
 
+    # Collect cops that have been disabled or enabled by name in a directive comment
+    # so that `Lint/RedundantCopEnableDirective` can register offenses correctly.
     def handle_switch(cop_names, names, disabled, extras, comment)
       cop_names.each do |name|
-        names[name] ||= 0
         if disabled
           names[name] += 1
         elsif (names[name]).positive?
           names[name] -= 1
         else
-          extras << [comment, name]
+          extras[comment] << name
         end
       end
     end

data/lib/rubocop/config.rb

@@ -37,6 +37,10 @@ module RuboCop
       new(hash, path).check
     end
 
+    def loaded_features
+      @loaded_features ||= ConfigLoader.loaded_features
+    end
+
     def check
       deprecation_check do |deprecation_message|
         warn("#{loaded_path} - #{deprecation_message}")

data/lib/rubocop/config_loader.rb

@@ -35,12 +35,13 @@ module RuboCop
       end
 
       def load_file(file)
-        path = File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
+        path = file_path(file)
 
         hash = load_yaml_configuration(path)
 
         # Resolve requires first in case they define additional cops
-        resolver.resolve_requires(path, hash)
+        loaded_features = resolver.resolve_requires(path, hash)
+        add_loaded_features(loaded_features)
 
         add_missing_namespaces(path, hash)
 
@@ -172,8 +173,24 @@ module RuboCop
         resolver.merge_with_default(config, config_file, unset_nil: unset_nil)
       end
 
+      def loaded_features
+        @loaded_features.flatten.compact
+      end
+
       private
 
+      def file_path(file)
+        File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
+      end
+
+      def add_loaded_features(loaded_features)
+        if instance_variable_defined?(:@loaded_features)
+          instance_variable_get(:@loaded_features) << loaded_features
+        else
+          instance_variable_set(:@loaded_features, [loaded_features])
+        end
+      end
+
       def find_project_dotfile(target_dir)
         find_file_upwards(DOTFILE, target_dir, project_root)
       end

data/lib/rubocop/config_loader_resolver.rb

@@ -9,11 +9,13 @@ module RuboCop
   class ConfigLoaderResolver
     def resolve_requires(path, hash)
       config_dir = File.dirname(path)
-      Array(hash.delete('require')).each do |r|
-        if r.start_with?('.')
-          require(File.join(config_dir, r))
-        else
-          require(r)
+      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
         end
       end
     end

data/lib/rubocop/config_regeneration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class handles collecting the options for regenerating a TODO file.
+  # @api private
+  class ConfigRegeneration
+    AUTO_GENERATED_FILE = RuboCop::CLI::Command::AutoGenerateConfig::AUTO_GENERATED_FILE
+    COMMAND_REGEX = /(?<=`rubocop )(.*?)(?=`)/.freeze
+    DEFAULT_OPTIONS = { auto_gen_config: true }.freeze
+
+    # Get options from the comment in the TODO file, and parse them as options
+    def options
+      # If there's no existing TODO file, generate one
+      return DEFAULT_OPTIONS unless todo_exists?
+
+      match = generation_command.match(COMMAND_REGEX)
+      return DEFAULT_OPTIONS unless match
+
+      options = match[1].split(' ')
+      Options.new.parse(options).first
+    end
+
+    private
+
+    def todo_exists?
+      File.exist?(AUTO_GENERATED_FILE) && !File.empty?(AUTO_GENERATED_FILE)
+    end
+
+    def generation_command
+      File.foreach(AUTO_GENERATED_FILE).take(2).last
+    end
+  end
+end

data/lib/rubocop/config_validator.rb

@@ -18,6 +18,11 @@ module RuboCop
     # @api private
     NEW_COPS_VALUES = %w[pending disable enable].freeze
 
+    # @api private
+    CONFIG_CHECK_KEYS = %w[Enabled Safe SafeAutoCorrect AutoCorrect].to_set.freeze
+    CONFIG_CHECK_DEPARTMENTS = %w[pending override_department].freeze
+    private_constant :CONFIG_CHECK_KEYS, :CONFIG_CHECK_DEPARTMENTS
+
     def_delegators :@config, :smart_loaded_path, :for_all_cops
 
     def initialize(config)
@@ -202,13 +207,9 @@ module RuboCop
       hash.each do |key, value|
         check_cop_config_value(value, key) if value.is_a?(Hash)
 
-        next unless %w[Enabled
-                       Safe
-                       SafeAutoCorrect
-                       AutoCorrect].include?(key) && value.is_a?(String)
+        next unless CONFIG_CHECK_KEYS.include?(key) && value.is_a?(String)
 
-        next if key == 'Enabled' &&
-                %w[pending override_department].include?(value)
+        next if key == 'Enabled' && CONFIG_CHECK_DEPARTMENTS.include?(value)
 
         raise ValidationError, msg_not_boolean(parent, key, value)
       end

data/lib/rubocop/cop/badge.rb

@@ -10,37 +10,22 @@ module RuboCop
     # 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
-        MSG = 'Invalid badge %<badge>p. ' \
-              'Expected `Department/CopName` or `CopName`.'
-
-        def initialize(token)
-          super(format(MSG, badge: token))
-        end
-      end
-
       attr_reader :department, :cop_name
 
       def self.for(class_name)
-        new(*class_name.split('::').last(2))
+        parts = class_name.split('::')
+        name_deep_enough = parts.length >= 4
+        new(name_deep_enough ? parts[2..-1] : parts.last(2))
       end
 
       def self.parse(identifier)
-        parts = identifier.split('/', 2)
-
-        raise InvalidBadge, identifier if parts.size > 2
-
-        if parts.one?
-          new(nil, *parts)
-        else
-          new(*parts)
-        end
+        new(identifier.split('/'))
       end
 
-      def initialize(department, cop_name)
-        @department = department.to_sym if department
-        @cop_name   = cop_name
+      def initialize(class_name_parts)
+        department_parts = class_name_parts[0...-1]
+        @department = (department_parts.join('/').to_sym unless department_parts.empty?)
+        @cop_name = class_name_parts.last
       end
 
       def ==(other)
@@ -66,7 +51,7 @@ module RuboCop
       end
 
       def with_department(department)
-        self.class.new(department, cop_name)
+        self.class.new([department.to_s.split('/'), cop_name].flatten)
       end
     end
   end

data/lib/rubocop/cop/base.rb

@@ -261,6 +261,21 @@ module RuboCop
           'they are returned as the result of the investigation'
       end
 
+      ### Reserved for Commissioner
+
+      # @api private
+      def callbacks_needed
+        self.class.callbacks_needed
+      end
+
+      # @api private
+      def self.callbacks_needed
+        @callbacks_needed ||= public_instance_methods.select do |m|
+          m.match?(/^on_|^after_/) &&
+            !Base.method_defined?(m) # exclude standard "callbacks" like 'on_begin_investigation'
+        end
+      end
+
       private
 
       ### Reserved for Cop::Cop
@@ -291,7 +306,7 @@ module RuboCop
       end
 
       private_class_method def self.restrict_on_send
-        @restrict_on_send ||= self::RESTRICT_ON_SEND.to_set.freeze
+        @restrict_on_send ||= self::RESTRICT_ON_SEND.to_a.freeze
       end
 
       # Called before any investigation

data/lib/rubocop/cop/commissioner.rb

@@ -7,7 +7,7 @@ module RuboCop
     class Commissioner
       include RuboCop::AST::Traversal
 
-      RESTRICTED_CALLBACKS = %i[on_send on_csend].freeze
+      RESTRICTED_CALLBACKS = %i[on_send on_csend after_send after_csend].freeze
       private_constant :RESTRICTED_CALLBACKS
 
       # How a Commissioner returns the results of the investigation
@@ -45,8 +45,7 @@ module RuboCop
         @cops = cops
         @forces = forces
         @options = options
-        @callbacks = Hash.new { |h, k| h[k] = cops_callbacks_for(k) }
-        @restricted_map = {}
+        initialize_callbacks
 
         reset
       end
@@ -61,16 +60,18 @@ module RuboCop
         method_name = :"on_#{node_type}"
         next unless method_defined?(method_name)
 
-        if RESTRICTED_CALLBACKS.include?(method_name)
-          trigger_restricted = "trigger_restricted_cops(:on_#{node_type}, node)"
-        end
+        # Hacky: Comment-out code as needed
+        r = '#' unless RESTRICTED_CALLBACKS.include?(method_name) # has Restricted?
+        c = '#' if NO_CHILD_NODES.include?(node_type) # has Children?
 
         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
+                  def on_#{node_type}(node)
+                    trigger_responding_cops(:on_#{node_type}, node)
+              #{r}  trigger_restricted_cops(:on_#{node_type}, node)
+          #{c}      super(node)
+          #{c}      trigger_responding_cops(:after_#{node_type}, node)
+          #{c}#{r}  trigger_restricted_cops(:after_#{node_type}, node)
+                  end
         RUBY
       end
 
@@ -94,7 +95,7 @@ module RuboCop
       private
 
       def trigger_responding_cops(callback, node)
-        @callbacks[callback].each do |cop|
+        @callbacks[callback]&.each do |cop|
           with_cop_error_handling(cop, node) do
             cop.send(callback, node)
           end
@@ -105,19 +106,32 @@ module RuboCop
         @errors = []
       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)
+      def initialize_callbacks
+        @callbacks = build_callbacks(@cops)
+        @restricted_map = restrict_callbacks(@callbacks)
+      end
+
+      def build_callbacks(cops)
+        callbacks = {}
+        cops.each do |cop|
+          cop.callbacks_needed.each do |callback|
+            (callbacks[callback] ||= []) << cop
+          end
         end
         callbacks
       end
 
+      def restrict_callbacks(callbacks)
+        restricted = {}
+        RESTRICTED_CALLBACKS.each do |callback|
+          restricted[callback] = restricted_map(callbacks[callback])
+        end
+        restricted
+      end
+
       def trigger_restricted_cops(event, node)
         name = node.method_name
-        @restricted_map.fetch(event)[name]&.each do |cop|
+        @restricted_map[event][name]&.each do |cop|
           with_cop_error_handling(cop, node) do
             cop.send(event, node)
           end
@@ -127,7 +141,7 @@ module RuboCop
       # Note: mutates `callbacks` in place
       def restricted_map(callbacks)
         map = {}
-        callbacks.select! do |cop|
+        callbacks&.select! do |cop|
           restrictions = cop.class.send :restrict_on_send
           restrictions.each do |name|
             (map[name] ||= []) << cop