rubocop 0.76.0 → 0.83.0

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Generate a .rubocop.yml file in the current directory.
+      class InitDotfile < Base
+        DOTFILE = ConfigLoader::DOTFILE
+
+        self.command_name = :init
+
+        def run
+          path = File.expand_path(DOTFILE)
+
+          if File.exist?(DOTFILE)
+            warn Rainbow("#{DOTFILE} already exists at #{path}").red
+
+            STATUS_ERROR
+          else
+            description = <<~DESC
+              # The behavior of RuboCop can be controlled via the .rubocop.yml
+              # configuration file. It makes it possible to enable/disable
+              # certain cops (checks) and to alter their behavior if they accept
+              # any parameters. The file can be placed either in your home
+              # directory or in some project directory.
+              #
+              # RuboCop will start looking for the configuration file in the directory
+              # where the inspected file is and continue its way up to the root directory.
+              #
+              # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+            DESC
+
+            File.open(DOTFILE, 'w') do |f|
+              f.write(description)
+            end
+
+            puts "Writing new #{DOTFILE} to #{path}"
+
+            STATUS_SUCCESS
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Shows the given cops, or all cops by default, and their configurations
+      # for the current directory.
+      class ShowCops < Base
+        self.command_name = :show_cops
+
+        def initialize(env)
+          super
+
+          # Load the configs so the require()s are done for custom cops
+          @config = @config_store.for(Dir.pwd)
+        end
+
+        def run
+          print_available_cops
+        end
+
+        private
+
+        def print_available_cops
+          registry = Cop::Cop.registry
+          show_all = @options[:show_cops].empty?
+
+          if show_all
+            puts "# Available cops (#{registry.length}) " \
+                 "+ config for #{Dir.pwd}: "
+          end
+
+          registry.departments.sort!.each do |department|
+            print_cops_of_department(registry, department, show_all)
+          end
+        end
+
+        def print_cops_of_department(registry, department, show_all)
+          selected_cops = if show_all
+                            cops_of_department(registry, department)
+                          else
+                            selected_cops_of_department(registry, department)
+                          end
+
+          if show_all
+            puts "# Department '#{department}' (#{selected_cops.length}):"
+          end
+
+          print_cop_details(selected_cops)
+        end
+
+        def print_cop_details(cops)
+          cops.each do |cop|
+            if cop.new(@config).support_autocorrect?
+              puts '# Supports --auto-correct'
+            end
+            puts "#{cop.cop_name}:"
+            puts config_lines(cop)
+            puts
+          end
+        end
+
+        def selected_cops_of_department(cops, department)
+          cops_of_department(cops, department).select do |cop|
+            @options[:show_cops].include?(cop.cop_name)
+          end
+        end
+
+        def cops_of_department(cops, department)
+          cops.with_department(department).sort!
+        end
+
+        def config_lines(cop)
+          cnf = @config.for_cop(cop)
+          cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Display version.
+      class Version < Base
+        self.command_name = :version
+
+        def run
+          puts RuboCop::Version.version(false) if @options[:version]
+          puts RuboCop::Version.version(true) if @options[:verbose_version]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    # Home of subcommands in the CLI.
+    module Command
+      class << self
+        # Find the command with a given name and run it in an environment.
+        def run(env, name)
+          class_for(name).new(env).run
+        end
+
+        private
+
+        def class_for(name)
+          Base.by_command_name(name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/environment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    # Execution environment for a CLI command.
+    class Environment
+      attr_reader :options, :config_store, :paths
+
+      def initialize(options, config_store, paths)
+        @options = options
+        @config_store = config_store
+        @paths = paths
+      end
+
+      # Run a command in this environment.
+      def run(name)
+        Command.run(self, name)
+      end
+    end
+  end
+end

data/lib/rubocop/cli.rb

@@ -1,20 +1,9 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
 module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
-    include Formatter::TextUtil
-
-    PHASE_1 = 'Phase 1 of 2: run Metrics/LineLength cop'
-    PHASE_2 = 'Phase 2 of 2: run all cops'
-
-    PHASE_1_OVERRIDDEN = '(skipped because the default Metrics/LineLength:Max' \
-                         ' is overridden)'
-    PHASE_1_DISABLED   = '(skipped because Metrics/LineLength is ' \
-                         'disabled)'
-
     STATUS_SUCCESS     = 0
     STATUS_OFFENSES    = 1
     STATUS_ERROR       = 2
@@ -41,14 +30,15 @@ module RuboCop
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
       @options, paths = Options.new.parse(args)
+      @env = Environment.new(@options, @config_store, paths)
 
       if @options[:init]
-        init_dotfile
+        run_command(:init)
       else
-        validate_options_vs_config
         act_on_options
+        validate_options_vs_config
         apply_default_formatter
-        execute_runners(paths)
+        execute_runners
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
@@ -71,113 +61,18 @@ module RuboCop
 
     private
 
-    def execute_runners(paths)
-      if @options[:auto_gen_config]
-        reset_config_and_auto_gen_file
-        line_length_contents = maybe_run_line_length_cop(paths)
-        run_all_cops_auto_gen_config(line_length_contents, paths)
-      else
-        execute_runner(paths)
-      end
-    end
-
-    def maybe_run_line_length_cop(paths)
-      if !line_length_enabled?(@config_store.for(Dir.pwd))
-        skip_line_length_cop(PHASE_1_DISABLED)
-      elsif !same_max_line_length?(
-        @config_store.for(Dir.pwd), ConfigLoader.default_configuration
-      )
-        skip_line_length_cop(PHASE_1_OVERRIDDEN)
-      else
-        run_line_length_cop_auto_gen_config(paths)
-      end
-    end
-
-    def skip_line_length_cop(reason)
-      puts Rainbow("#{PHASE_1} #{reason}").yellow
-      ''
-    end
-
-    def line_length_enabled?(config)
-      line_length_cop(config)['Enabled']
-    end
-
-    def same_max_line_length?(config1, config2)
-      max_line_length(config1) == max_line_length(config2)
-    end
-
-    def max_line_length(config)
-      line_length_cop(config)['Max']
-    end
-
-    def line_length_cop(config)
-      config.for_cop('Metrics/LineLength')
+    def run_command(name)
+      @env.run(name)
     end
 
-    # Do an initial run with only Metrics/LineLength so that cops that depend
-    # on Metrics/LineLength:Max get the correct value for that parameter.
-    def run_line_length_cop_auto_gen_config(paths)
-      puts Rainbow(PHASE_1).yellow
-      @options[:only] = ['Metrics/LineLength']
-      execute_runner(paths)
-      @options.delete(:only)
-      @config_store = ConfigStore.new
-      # Save the todo configuration of the LineLength cop.
-      IO.read(ConfigLoader::AUTO_GENERATED_FILE)
-        .lines
-        .drop_while { |line| line.start_with?('#') }
-        .join
-    end
-
-    def run_all_cops_auto_gen_config(line_length_contents, paths)
-      puts Rainbow(PHASE_2).yellow
-      result = execute_runner(paths)
-      # This run was made with the current maximum length allowed, so append
-      # the saved setting for LineLength.
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
-        f.write(line_length_contents)
-      end
-      result
-    end
-
-    def init_dotfile
-      path = File.expand_path(ConfigLoader::DOTFILE)
-
-      if File.exist?(ConfigLoader::DOTFILE)
-        warn Rainbow("#{ConfigLoader::DOTFILE} already exists at #{path}").red
-
-        STATUS_ERROR
+    def execute_runners
+      if @options[:auto_gen_config]
+        run_command(:auto_gen_config)
       else
-        description = <<~DESC
-          # The behavior of RuboCop can be controlled via the .rubocop.yml
-          # configuration file. It makes it possible to enable/disable
-          # certain cops (checks) and to alter their behavior if they accept
-          # any parameters. The file can be placed either in your home
-          # directory or in some project directory.
-          #
-          # RuboCop will start looking for the configuration file in the directory
-          # where the inspected file is and continue its way up to the root directory.
-          #
-          # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
-        DESC
-
-        File.open(ConfigLoader::DOTFILE, 'w') do |f|
-          f.write(description)
-        end
-
-        puts "Writing new #{ConfigLoader::DOTFILE} to #{path}"
-
-        STATUS_SUCCESS
+        run_command(:execute_runner)
       end
     end
 
-    def reset_config_and_auto_gen_file
-      @config_store = ConfigStore.new
-      @config_store.options_config = @options[:config] if @options[:config]
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
-      ConfigLoader.add_inheritance_from_auto_generated_file
-    end
-
     def validate_options_vs_config
       if @options[:parallel] &&
          !@config_store.for(Dir.pwd).for_all_cops['UseCache']
@@ -188,10 +83,7 @@ module RuboCop
     end
 
     def act_on_options
-      ConfigLoader.debug = @options[:debug]
-      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
-      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
-      ConfigLoader.options_config = @options[:config]
+      set_options_to_config_loader
 
       @config_store.options_config = @options[:config] if @options[:config]
       @config_store.force_default_config! if @options[:force_default_config]
@@ -207,31 +99,20 @@ module RuboCop
       end
     end
 
-    def execute_runner(paths)
-      runner = Runner.new(@options, @config_store)
-
-      all_passed = runner.run(paths)
-      display_warning_summary(runner.warnings)
-      display_error_summary(runner.errors)
-      maybe_print_corrected_source
-
-      all_pass_or_excluded = all_passed || @options[:auto_gen_config]
-
-      if runner.aborting?
-        STATUS_INTERRUPTED
-      elsif all_pass_or_excluded && runner.errors.empty?
-        STATUS_SUCCESS
-      else
-        STATUS_OFFENSES
-      end
+    def set_options_to_config_loader
+      ConfigLoader.debug = @options[:debug]
+      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
+      ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
+      ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
+      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
+      ConfigLoader.options_config = @options[:config]
     end
 
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
-      puts RuboCop::Version.version(false) if @options[:version]
-      puts RuboCop::Version.version(true) if @options[:verbose_version]
-      print_available_cops if @options[:show_cops]
+      run_command(:version) if @options[:version] || @options[:verbose_version]
+      run_command(:show_cops) if @options[:show_cops]
       raise Finished
     end
 
@@ -247,100 +128,6 @@ module RuboCop
         end
         [[formatter, @options[:output_path]]]
       end
-
-      return unless @options[:auto_gen_config]
-
-      @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                ConfigLoader::AUTO_GENERATED_FILE]
-    end
-
-    def print_available_cops
-      # Load the configs so the require()s are done for custom cops
-      @config_store.for(Dir.pwd)
-      registry = Cop::Cop.registry
-      show_all = @options[:show_cops].empty?
-
-      if show_all
-        puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: "
-      end
-
-      registry.departments.sort!.each do |department|
-        print_cops_of_department(registry, department, show_all)
-      end
-    end
-
-    def print_cops_of_department(registry, department, show_all)
-      selected_cops = if show_all
-                        cops_of_department(registry, department)
-                      else
-                        selected_cops_of_department(registry, department)
-                      end
-
-      puts "# Department '#{department}' (#{selected_cops.length}):" if show_all
-
-      print_cop_details(selected_cops)
-    end
-
-    def print_cop_details(cops)
-      cops.each do |cop|
-        puts '# Supports --auto-correct' if cop.new.support_autocorrect?
-        puts "#{cop.cop_name}:"
-        puts config_lines(cop)
-        puts
-      end
-    end
-
-    def selected_cops_of_department(cops, department)
-      cops_of_department(cops, department).select do |cop|
-        @options[:show_cops].include?(cop.cop_name)
-      end
-    end
-
-    def cops_of_department(cops, department)
-      cops.with_department(department).sort!
-    end
-
-    def config_lines(cop)
-      cnf = @config_store.for(Dir.pwd).for_cop(cop)
-      cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
-    end
-
-    def display_warning_summary(warnings)
-      return if warnings.empty?
-
-      warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow
-
-      warnings.each { |warning| warn warning }
-    end
-
-    def display_error_summary(errors)
-      return if errors.empty?
-
-      warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
-
-      errors.each { |error| warn error }
-
-      warn <<~WARNING
-        Errors are usually caused by RuboCop bugs.
-        Please, report your problems to RuboCop's issue tracker.
-        #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
-
-        Mention the following information in the issue report:
-        #{RuboCop::Version.version(true)}
-      WARNING
-    end
-
-    def maybe_print_corrected_source
-      # If we are asked to autocorrect source code read from stdin, the only
-      # reasonable place to write it is to stdout
-      # Unfortunately, we also write other information to stdout
-      # So a delimiter is needed for tools to easily identify where the
-      # autocorrected source begins
-      return unless @options[:stdin] && @options[:auto_correct]
-
-      puts '=' * 20
-      print @options[:stdin]
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/rubocop/comment_config.rb

@@ -113,7 +113,8 @@ module RuboCop
     def each_mentioned_cop
       each_directive do |comment, cop_names, disabled|
         comment_line_number = comment.loc.expression.line
-        single_line = !comment_only_line?(comment_line_number)
+        single_line = !comment_only_line?(comment_line_number) ||
+                      directive_on_comment_line?(comment)
 
         cop_names.each do |cop_name|
           yield qualified_cop_name(cop_name), disabled, comment_line_number,
@@ -122,6 +123,10 @@ module RuboCop
       end
     end
 
+    def directive_on_comment_line?(comment)
+      comment.text[1..-1].match(COMMENT_DIRECTIVE_REGEXP)
+    end
+
     def each_directive
       return if processed_source.comments.nil?
 

data/lib/rubocop/config.rb

@@ -2,6 +2,9 @@
 
 require 'pathname'
 
+# FIXME: Moving Rails department code to RuboCop Rails will remove
+# the following rubocop:disable comment.
+# rubocop:disable Metrics/ClassLength
 module RuboCop
   # This class represents the configuration of the RuboCop application
   # and all its cops. A Config is associated with a YAML configuration
@@ -13,6 +16,8 @@ module RuboCop
     include FileFinder
     extend Forwardable
 
+    CopConfig = Struct.new(:name, :metadata)
+
     DEFAULT_RAILS_VERSION = 5.0
     attr_reader :loaded_path
 
@@ -42,7 +47,7 @@ module RuboCop
     end
 
     def_delegators :@hash, :[], :[]=, :delete, :each, :key?, :keys, :each_key,
-                   :map, :merge, :to_h, :to_hash
+                   :map, :merge, :to_h, :to_hash, :transform_values
     def_delegators :@validator, :validate, :target_ruby_version
 
     def to_s
@@ -111,11 +116,19 @@ module RuboCop
       @for_all_cops ||= self['AllCops'] || {}
     end
 
+    def disabled_new_cops?
+      for_all_cops['NewCops'] == 'disable'
+    end
+
+    def enabled_new_cops?
+      for_all_cops['NewCops'] == 'enable'
+    end
+
     def file_to_include?(file)
       relative_file_path = path_relative_to_config(file)
 
       # Optimization to quickly decide if the given file is hidden (on the top
-      # level) and can not be matched by any pattern.
+      # level) and cannot be matched by any pattern.
       is_hidden = relative_file_path.start_with?('.') &&
                   !relative_file_path.start_with?('..')
       return false if is_hidden && !possibly_include_hidden?
@@ -215,6 +228,18 @@ module RuboCop
       nil
     end
 
+    def pending_cops
+      keys.each_with_object([]) do |qualified_cop_name, pending_cops|
+        department = department_of(qualified_cop_name)
+        next if department && department['Enabled'] == false
+
+        cop_metadata = self[qualified_cop_name]
+        next unless cop_metadata['Enabled'] == 'pending'
+
+        pending_cops << CopConfig.new(qualified_cop_name, cop_metadata)
+      end
+    end
+
     private
 
     def target_rails_version_from_bundler_lock_file
@@ -235,17 +260,22 @@ module RuboCop
     end
 
     def enable_cop?(qualified_cop_name, cop_options)
-      cop_department, cop_name = qualified_cop_name.split('/')
-      department = cop_name.nil?
-
-      unless department
-        department_options = self[cop_department]
-        if department_options && department_options['Enabled'] == false
-          return false
-        end
+      department = department_of(qualified_cop_name)
+      cop_enabled = cop_options.fetch('Enabled') do
+        !for_all_cops['DisabledByDefault']
       end
+      return true if cop_enabled == 'override_department'
+      return false if department && department['Enabled'] == false
+
+      cop_enabled
+    end
+
+    def department_of(qualified_cop_name)
+      cop_department, cop_name = qualified_cop_name.split('/')
+      return nil if cop_name.nil?
 
-      cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
+      self[cop_department]
     end
   end
 end
+# rubocop:enable Metrics/ClassLength