rubocop 1.18.0 → 1.56.0

data/lib/rubocop/runner.rb

@@ -8,12 +8,12 @@ module RuboCop
   class Runner # rubocop:disable Metrics/ClassLength
     # An exception indicating that the inspection loop got stuck correcting
     # offenses back and forth.
-    class InfiniteCorrectionLoop < RuntimeError
+    class InfiniteCorrectionLoop < StandardError
       attr_reader :offenses
 
       def initialize(path, offenses_by_iteration, loop_start: -1)
         @offenses = offenses_by_iteration.flatten.uniq
-        root_cause = offenses_by_iteration[loop_start..-1]
+        root_cause = offenses_by_iteration[loop_start..]
                      .map { |x| x.map(&:cop_name).uniq.join(', ') }
                      .join(' -> ')
 
@@ -24,9 +24,35 @@ module RuboCop
       end
     end
 
+    class << self
+      # @return [Array<#call>]
+      def ruby_extractors
+        @ruby_extractors ||= [default_ruby_extractor]
+      end
+
+      private
+
+      # @return [#call]
+      def default_ruby_extractor
+        lambda do |processed_source|
+          [
+            {
+              offset: 0,
+              processed_source: processed_source
+            }
+          ]
+        end
+      end
+    end
+
     # @api private
     MAX_ITERATIONS = 200
 
+    # @api private
+    REDUNDANT_COP_DISABLE_DIRECTIVE_RULES = %w[
+      Lint/RedundantCopDisableDirective RedundantCopDisableDirective Lint
+    ].freeze
+
     attr_reader :errors, :warnings
     attr_writer :aborting
 
@@ -60,11 +86,19 @@ module RuboCop
 
     private
 
-    # Warms up the RuboCop cache by forking a suitable number of rubocop
+    # Warms up the RuboCop cache by forking a suitable number of RuboCop
     # instances that each inspects its allotted group of files.
     def warm_cache(target_files)
+      saved_options = @options.dup
+      if target_files.length <= 1
+        puts 'Skipping parallel inspection: only a single file needs inspection' if @options[:debug]
+        return
+      end
       puts 'Running parallel inspection' if @options[:debug]
+      %i[autocorrect safe_autocorrect].each { |opt| @options[opt] = false }
       Parallel.each(target_files) { |target_file| file_offenses(target_file) }
+    ensure
+      @options = saved_options
     end
 
     def find_target_files(paths)
@@ -143,10 +177,10 @@ module RuboCop
 
       if cache&.valid?
         offenses = cache.load
-        # If we're running --auto-correct and the cache says there are
+        # If we're running --autocorrect and the cache says there are
         # offenses, we need to actually inspect the file. If the cache shows no
         # offenses, we're good.
-        real_run_needed = @options[:auto_correct] && offenses.any?
+        real_run_needed = @options[:autocorrect] && offenses.any?
       else
         real_run_needed = true
       end
@@ -186,7 +220,9 @@ module RuboCop
     end
 
     def check_for_redundant_disables?(source)
-      !source.disabled_line_ranges.empty? && !filtered_run?
+      return false if source.disabled_line_ranges.empty? || except_redundant_cop_disable_directive?
+
+      !@options[:only]
     end
 
     def redundant_cop_disable_directive(file)
@@ -197,8 +233,8 @@ module RuboCop
       yield cop if cop.relevant_file?(file)
     end
 
-    def filtered_run?
-      @options[:except] || @options[:only]
+    def except_redundant_cop_disable_directive?
+      @options[:except] && (@options[:except] & REDUNDANT_COP_DISABLE_DIRECTIVE_RULES).any?
     end
 
     def file_started(file)
@@ -207,17 +243,14 @@ module RuboCop
     end
 
     def file_finished(file, offenses)
-      if @options[:display_only_fail_level_offenses]
-        offenses = offenses.select { |o| considered_failure?(o) }
-      end
+      offenses = offenses_to_report(offenses)
       formatter_set.file_finished(file, offenses)
     end
 
     def cached_run?
       @cached_run ||=
         (@options[:cache] == 'true' ||
-         @options[:cache] != 'false' &&
-         @config_store.for_pwd.for_all_cops['UseCache']) &&
+         (@options[:cache] != 'false' && @config_store.for_pwd.for_all_cops['UseCache'])) &&
         # When running --auto-gen-config, there's some processing done in the
         # cops related to calculating the Max parameters for Metrics cops. We
         # need to do that processing and cannot use caching.
@@ -243,7 +276,7 @@ module RuboCop
       # error message.
       offenses_by_iteration = []
 
-      # When running with --auto-correct, we need to inspect the file (which
+      # When running with --autocorrect, we need to inspect the file (which
       # includes writing a corrected version of it) until no more corrections
       # are made. This is because automatic corrections can introduce new
       # offenses. In the normal case the loop is only executed once.
@@ -307,10 +340,25 @@ module RuboCop
     end
 
     def inspect_file(processed_source, team = mobilize_team(processed_source))
-      report = team.investigate(processed_source)
-      @errors.concat(team.errors)
-      @warnings.concat(team.warnings)
-      [report.offenses, team.updated_source_file?]
+      extracted_ruby_sources = extract_ruby_sources(processed_source)
+      offenses = extracted_ruby_sources.flat_map do |extracted_ruby_source|
+        report = team.investigate(
+          extracted_ruby_source[:processed_source],
+          offset: extracted_ruby_source[:offset],
+          original: processed_source
+        )
+        @errors.concat(team.errors)
+        @warnings.concat(team.warnings)
+        report.offenses
+      end
+      [offenses, team.updated_source_file?]
+    end
+
+    def extract_ruby_sources(processed_source)
+      self.class.ruby_extractors.find do |ruby_extractor|
+        result = ruby_extractor.call(processed_source)
+        break result if result
+      end
     end
 
     def mobilize_team(processed_source)
@@ -373,34 +421,68 @@ module RuboCop
     end
 
     def considered_failure?(offense)
-      # For :autocorrect level, any offense - corrected or not - is a failure.
       return false if offense.disabled?
 
-      return true if @options[:fail_level] == :autocorrect
+      # For :autocorrect level, any correctable offense is a failure, regardless of severity
+      return true if @options[:fail_level] == :autocorrect && offense.correctable?
 
       !offense.corrected? && offense.severity >= minimum_severity_to_fail
     end
 
+    def offenses_to_report(offenses)
+      if @options[:display_only_fail_level_offenses]
+        offenses.select { |o| considered_failure?(o) }
+      elsif @options[:display_only_safe_correctable]
+        offenses.select { |o| supports_safe_autocorrect?(o) }
+      elsif @options[:display_only_correctable]
+        offenses.select(&:correctable?)
+      else
+        offenses
+      end
+    end
+
+    def supports_safe_autocorrect?(offense)
+      cop_class = Cop::Registry.global.find_by_cop_name(offense.cop_name)
+      default_cfg = default_config(offense.cop_name)
+
+      offense.correctable? &&
+        cop_class&.support_autocorrect? && mark_as_safe_by_config?(default_cfg)
+    end
+
+    def mark_as_safe_by_config?(config)
+      config.nil? || (config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true))
+    end
+
+    def default_config(cop_name)
+      RuboCop::ConfigLoader.default_configuration[cop_name]
+    end
+
     def minimum_severity_to_fail
       @minimum_severity_to_fail ||= begin
         # Unless given explicitly as `fail_level`, `:info` severity offenses do not fail
         name = @options[:fail_level] || :refactor
-        RuboCop::Cop::Severity.new(name)
+
+        # autocorrect is a fake level - use the default
+        RuboCop::Cop::Severity.new(name == :autocorrect ? :refactor : name)
       end
     end
 
     def get_processed_source(file)
-      ruby_version = @config_store.for_file(file).target_ruby_version
-
-      if @options[:stdin]
-        ProcessedSource.new(@options[:stdin], ruby_version, file)
-      else
-        begin
-          ProcessedSource.from_file(file, ruby_version)
-        rescue Errno::ENOENT
-          raise RuboCop::Error, "No such file or directory: #{file}"
-        end
-      end
+      config = @config_store.for_file(file)
+      ruby_version = config.target_ruby_version
+
+      processed_source = if @options[:stdin]
+                           ProcessedSource.new(@options[:stdin], ruby_version, file)
+                         else
+                           begin
+                             ProcessedSource.from_file(file, ruby_version)
+                           rescue Errno::ENOENT
+                             raise RuboCop::Error, "No such file or directory: #{file}"
+                           end
+                         end
+      processed_source.config = config
+      processed_source.registry = mobilized_cop_classes(config)
+      processed_source
     end
 
     # A Cop::Team instance is stateful and may change when inspecting.

data/lib/rubocop/server/cache.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative '../cache_config'
+require_relative '../config_finder'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # Caches the states of server process.
+    # @api private
+    class Cache
+      GEMFILE_NAMES = %w[Gemfile gems.rb].freeze
+
+      class << self
+        attr_accessor :cache_root_path
+
+        # Searches for Gemfile or gems.rb in the current dir or any parent dirs
+        def project_dir
+          current_dir = Dir.pwd
+          while current_dir != '/'
+            return current_dir if GEMFILE_NAMES.any? do |gemfile|
+              File.exist?(File.join(current_dir, gemfile))
+            end
+
+            current_dir = File.expand_path('..', current_dir)
+          end
+          # If we can't find a Gemfile, just use the current directory
+          Dir.pwd
+        end
+
+        def project_dir_cache_key
+          @project_dir_cache_key ||= project_dir[1..].tr('/', '+')
+        end
+
+        def dir
+          Pathname.new(File.join(cache_path, project_dir_cache_key)).tap do |d|
+            d.mkpath unless d.exist?
+          end
+        end
+
+        def cache_path
+          cache_root_dir = if cache_root_path
+                             File.join(cache_root_path, 'rubocop_cache')
+                           else
+                             cache_root_dir_from_config
+                           end
+
+          File.expand_path(File.join(cache_root_dir, 'server'))
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def cache_root_dir_from_config
+          CacheConfig.root_dir do
+            # `RuboCop::ConfigStore` has heavy dependencies, this is a lightweight implementation
+            # so that only the necessary `CacheRootDirectory` can be obtained.
+            config_path = ConfigFinder.find_config_path(Dir.pwd)
+            file_contents = File.read(config_path)
+
+            # Returns early if `CacheRootDirectory` is not used before requiring `erb` or `yaml`.
+            next unless file_contents.include?('CacheRootDirectory')
+
+            require 'erb'
+            yaml_code = ERB.new(file_contents).result
+
+            require 'yaml'
+            config_yaml = YAML.safe_load(
+              yaml_code, permitted_classes: [Regexp, Symbol], aliases: true
+            )
+
+            # For compatibility with Ruby 3.0 or lower.
+            if Gem::Version.new(Psych::VERSION) < Gem::Version.new('4.0.0')
+              config_yaml == false ? nil : config_yaml
+            end
+
+            config_yaml&.dig('AllCops', 'CacheRootDirectory')
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def port_path
+          dir.join('port')
+        end
+
+        def token_path
+          dir.join('token')
+        end
+
+        def pid_path
+          dir.join('pid')
+        end
+
+        def lock_path
+          dir.join('lock')
+        end
+
+        def status_path
+          dir.join('status')
+        end
+
+        def version_path
+          dir.join('version')
+        end
+
+        def stderr_path
+          dir.join('stderr')
+        end
+
+        def pid_running?
+          Process.kill(0, pid_path.read.to_i) == 1
+        rescue Errno::ESRCH, Errno::ENOENT, Errno::EACCES
+          false
+        end
+
+        def acquire_lock
+          lock_file = File.open(lock_path, File::CREAT)
+          # flock returns 0 if successful, and false if not.
+          flock_result = lock_file.flock(File::LOCK_EX | File::LOCK_NB)
+          yield flock_result != false
+        ensure
+          lock_file.flock(File::LOCK_UN)
+          lock_file.close
+        end
+
+        def write_port_and_token_files(port:, token:)
+          port_path.write(port)
+          token_path.write(token)
+        end
+
+        def write_pid_file
+          pid_path.write(Process.pid)
+          yield
+        ensure
+          dir.rmtree
+        end
+
+        def write_status_file(status)
+          status_path.write(status)
+        end
+
+        def write_version_file(version)
+          version_path.write(version)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/server/cli.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative '../arguments_env'
+require_relative '../arguments_file'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # The CLI is a class responsible of handling server command line interface logic.
+    # @api private
+    class CLI
+      # Same exit status value as `RuboCop::CLI`.
+      STATUS_SUCCESS = 0
+      STATUS_ERROR = 2
+
+      SERVER_OPTIONS = %w[
+        --server
+        --no-server
+        --server-status
+        --restart-server
+        --start-server
+        --stop-server
+        --no-detach
+      ].freeze
+      EXCLUSIVE_OPTIONS = (SERVER_OPTIONS - %w[--server --no-server]).freeze
+      NO_DETACH_OPTIONS = %w[--server --start-server --restart-server].freeze
+
+      def initialize
+        @exit = false
+      end
+
+      def run(argv = ARGV)
+        unless Server.support_server?
+          return error('RuboCop server is not supported by this Ruby.') if use_server_option?(argv)
+
+          return STATUS_SUCCESS
+        end
+
+        Cache.cache_root_path = fetch_cache_root_path_from(argv)
+
+        process_arguments(argv)
+      end
+
+      def exit?
+        @exit
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def process_arguments(argv)
+        server_arguments = delete_server_argument_from(argv)
+
+        detach = !server_arguments.delete('--no-detach')
+
+        if server_arguments.size >= 2
+          return error("#{server_arguments.join(', ')} cannot be specified together.")
+        end
+
+        server_command = server_arguments.first
+
+        unless detach || NO_DETACH_OPTIONS.include?(server_command)
+          return error("#{server_command} cannot be combined with --no-detach.")
+        end
+
+        if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count > allowed_option_count
+          return error("#{server_command} cannot be combined with #{argv[0]}.")
+        end
+
+        if server_command.nil?
+          server_command = ArgumentsEnv.read_as_arguments.delete('--server') ||
+                           ArgumentsFile.read_as_arguments.delete('--server')
+        end
+
+        run_command(server_command, detach: detach)
+
+        STATUS_SUCCESS
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
+      def run_command(server_command, detach:)
+        case server_command
+        when '--server'
+          Server::ClientCommand::Start.new(detach: detach).run unless Server.running?
+        when '--no-server'
+          Server::ClientCommand::Stop.new.run if Server.running?
+        when '--restart-server'
+          @exit = true
+          Server::ClientCommand::Restart.new.run
+        when '--start-server'
+          @exit = true
+          Server::ClientCommand::Start.new(detach: detach).run
+        when '--stop-server'
+          @exit = true
+          Server::ClientCommand::Stop.new.run
+        when '--server-status'
+          @exit = true
+          Server::ClientCommand::Status.new.run
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength:
+
+      def fetch_cache_root_path_from(arguments)
+        cache_root = arguments.detect { |argument| argument.start_with?('--cache-root') }
+        return unless cache_root
+
+        if cache_root.start_with?('--cache-root=')
+          cache_root.split('=')[1]
+        else
+          arguments[arguments.index(cache_root) + 1]
+        end
+      end
+
+      def delete_server_argument_from(all_arguments)
+        SERVER_OPTIONS.each_with_object([]) do |server_option, server_arguments|
+          server_arguments << all_arguments.delete(server_option)
+        end.compact
+      end
+
+      def use_server_option?(argv)
+        (argv & SERVER_OPTIONS).any?
+      end
+
+      def allowed_option_count
+        Cache.cache_root_path ? 2 : 1
+      end
+
+      def error(message)
+        require 'rainbow'
+
+        @exit = true
+        warn Rainbow(message).red
+
+        STATUS_ERROR
+      end
+    end
+  end
+end

data/lib/rubocop/server/client_command/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'socket'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # Abstract base class for server client command.
+      # @api private
+      class Base
+        def run
+          raise NotImplementedError
+        end
+
+        private
+
+        def send_request(command:, args: [], body: '')
+          TCPSocket.open('127.0.0.1', Cache.port_path.read) do |socket|
+            socket.puts [Cache.token_path.read, Dir.pwd, command, *args].shelljoin
+            socket.write body
+            socket.close_write
+            $stdout.write socket.readpartial(4096) until socket.eof?
+          end
+        end
+
+        def check_running_server
+          Server.running?.tap do |running|
+            warn 'RuboCop server is not running.' unless running
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/server/client_command/exec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # This class is a client command to execute server process.
+      # @api private
+      class Exec < Base
+        def run
+          ensure_server!
+          Cache.status_path.delete if Cache.status_path.file?
+          read_stdin = ARGV.include?('-s') || ARGV.include?('--stdin')
+          send_request(
+            command: 'exec',
+            args: ARGV.dup,
+            body: read_stdin ? $stdin.read : ''
+          )
+          warn stderr unless stderr.empty?
+          status
+        end
+
+        private
+
+        def ensure_server!
+          if incompatible_version?
+            warn 'RuboCop version incompatibility found, RuboCop server restarting...'
+            ClientCommand::Stop.new.run
+          elsif check_running_server
+            return
+          end
+
+          ClientCommand::Start.new.run
+        end
+
+        def incompatible_version?
+          Cache.version_path.read != RuboCop::Version::STRING
+        end
+
+        def stderr
+          Cache.stderr_path.read
+        end
+
+        def status
+          unless Cache.status_path.file?
+            raise "RuboCop server: Could not find status file at: #{Cache.status_path}"
+          end
+
+          status = Cache.status_path.read
+          raise "RuboCop server: '#{status}' is not a valid status!" if (status =~ /^\d+$/).nil?
+
+          status.to_i
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/server/client_command/restart.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # This class is a client command to restart server process.
+      # @api private
+      class Restart < Base
+        def run
+          ClientCommand::Stop.new.run
+          ClientCommand::Start.new.run
+        end
+      end
+    end
+  end
+end