rubocop 0.78.0

data/lib/rubocop/rspec/host_environment_simulation_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# RuboCop can be run in contexts where unexpected other libraries are included,
+# which may interfere with its normal behavior. In order to test those
+# situations, it may be necessary to require another library for the duration
+# of one spec
+module HostEnvironmentSimulatorHelper
+  def in_its_own_process_with(*files)
+    if ::Process.respond_to?(:fork)
+      pid = ::Process.fork do
+        # Need to write coverage result under different name
+        if defined?(SimpleCov)
+          SimpleCov.command_name "rspec-fork-#{Process.pid}"
+          SimpleCov.pid = Process.pid
+        end
+
+        files.each { |file| require file }
+        yield
+      end
+      ::Process.wait(pid)
+
+      # assert that the block did not fail
+      expect($CHILD_STATUS).to be_success
+    else
+      warn 'Process.fork is not available.'
+    end
+  end
+end

data/lib/rubocop/rspec/shared_contexts.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'fileutils'
+
+RSpec.shared_context 'isolated environment', :isolated_environment do
+  around do |example|
+    Dir.mktmpdir do |tmpdir|
+      original_home = ENV['HOME']
+      original_xdg_config_home = ENV['XDG_CONFIG_HOME']
+
+      # Make sure to expand all symlinks in the path first. Otherwise we may
+      # get mismatched pathnames when loading config files later on.
+      tmpdir = File.realpath(tmpdir)
+
+      # Make upwards search for .rubocop.yml files stop at this directory.
+      RuboCop::FileFinder.root_level = tmpdir
+
+      begin
+        virtual_home = File.expand_path(File.join(tmpdir, 'home'))
+        Dir.mkdir(virtual_home)
+        ENV['HOME'] = virtual_home
+        ENV.delete('XDG_CONFIG_HOME')
+
+        working_dir = File.join(tmpdir, 'work')
+        Dir.mkdir(working_dir)
+
+        RuboCop::PathUtil.chdir(working_dir) do
+          example.run
+        end
+      ensure
+        ENV['HOME'] = original_home
+        ENV['XDG_CONFIG_HOME'] = original_xdg_config_home
+
+        RuboCop::FileFinder.root_level = nil
+      end
+    end
+  end
+end
+
+# `cop_config` must be declared with #let.
+RSpec.shared_context 'config', :config do
+  let(:config) do
+    # Module#<
+    unless described_class < RuboCop::Cop::Cop
+      raise '`config` must be used in `describe SomeCopClass do .. end`'
+    end
+
+    hash = { 'AllCops' => { 'TargetRubyVersion' => ruby_version } }
+    hash['AllCops']['TargetRailsVersion'] = rails_version if rails_version
+    if respond_to?(:cop_config)
+      cop_name = described_class.cop_name
+      hash[cop_name] = RuboCop::ConfigLoader
+                       .default_configuration[cop_name]
+                       .merge(cop_config)
+    end
+
+    hash = other_cops.merge hash if respond_to?(:other_cops)
+
+    RuboCop::Config.new(hash, "#{Dir.pwd}/.rubocop.yml")
+  end
+end
+
+RSpec.shared_context 'mock console output' do
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+RSpec.shared_context 'ruby 2.3', :ruby23 do
+  let(:ruby_version) { 2.3 }
+end
+
+RSpec.shared_context 'ruby 2.4', :ruby24 do
+  let(:ruby_version) { 2.4 }
+end
+
+RSpec.shared_context 'ruby 2.5', :ruby25 do
+  let(:ruby_version) { 2.5 }
+end
+
+RSpec.shared_context 'ruby 2.6', :ruby26 do
+  let(:ruby_version) { 2.6 }
+end

data/lib/rubocop/rspec/support.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Require this file to load code that supports testing using RSpec.
+
+require_relative 'cop_helper'
+require_relative 'host_environment_simulation_helper'
+require_relative 'shared_contexts'
+require_relative 'expect_offense'
+
+RSpec.configure do |config|
+  config.include CopHelper
+  config.include HostEnvironmentSimulatorHelper
+end

data/lib/rubocop/runner.rb

@@ -0,0 +1,379 @@
+# frozen_string_literal: true
+
+require 'parallel'
+
+module RuboCop
+  # This class handles the processing of files, which includes dealing with
+  # formatters and letting cops inspect the files.
+  class Runner # rubocop:disable Metrics/ClassLength
+    # An exception indicating that the inspection loop got stuck correcting
+    # offenses back and forth.
+    class InfiniteCorrectionLoop < RuntimeError
+      attr_reader :offenses
+
+      def initialize(path, offenses)
+        super "Infinite loop detected in #{path}."
+        @offenses = offenses
+      end
+    end
+
+    MAX_ITERATIONS = 200
+
+    attr_reader :errors, :warnings
+    attr_writer :aborting
+
+    def initialize(options, config_store)
+      @options = options
+      @config_store = config_store
+      @errors = []
+      @warnings = []
+      @aborting = false
+    end
+
+    def run(paths)
+      target_files = find_target_files(paths)
+      if @options[:list_target_files]
+        list_files(target_files)
+      else
+        warm_cache(target_files) if @options[:parallel]
+        inspect_files(target_files)
+      end
+    rescue Interrupt
+      self.aborting = true
+      warn ''
+      warn 'Exiting...'
+
+      false
+    end
+
+    def aborting?
+      @aborting
+    end
+
+    private
+
+    # 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)
+      puts 'Running parallel inspection' if @options[:debug]
+      Parallel.each(target_files, &method(:file_offenses))
+    end
+
+    def find_target_files(paths)
+      target_finder = TargetFinder.new(@config_store, @options)
+      target_files = target_finder.find(paths)
+      target_files.each(&:freeze).freeze
+    end
+
+    def inspect_files(files)
+      inspected_files = []
+
+      formatter_set.started(files)
+
+      each_inspected_file(files) { |file| inspected_files << file }
+    ensure
+      # OPTIMIZE: Calling `ResultCache.cleanup` takes time. This optimization
+      # mainly targets editors that integrates RuboCop. When RuboCop is run
+      # by an editor, it should be inspecting only one file.
+      if files.size > 1 && cached_run?
+        ResultCache.cleanup(@config_store, @options[:debug])
+      end
+      formatter_set.finished(inspected_files.freeze)
+      formatter_set.close_output_files
+    end
+
+    def each_inspected_file(files)
+      files.reduce(true) do |all_passed, file|
+        offenses = process_file(file)
+        yield file
+
+        if offenses.any? { |o| considered_failure?(o) }
+          break false if @options[:fail_fast]
+
+          next false
+        end
+
+        all_passed
+      end
+    end
+
+    def list_files(paths)
+      paths.each do |path|
+        puts PathUtil.relative_path(path)
+      end
+    end
+
+    def process_file(file)
+      file_started(file)
+      offenses = file_offenses(file)
+    rescue InfiniteCorrectionLoop => e
+      offenses = e.offenses.compact.sort.freeze
+      raise
+    ensure
+      file_finished(file, offenses || [])
+    end
+
+    def file_offenses(file)
+      file_offense_cache(file) do
+        source = get_processed_source(file)
+        source, offenses = do_inspection_loop(file, source)
+        add_redundant_disables(file, offenses.compact.sort, source)
+      end
+    end
+
+    def cached_result(file, team)
+      ResultCache.new(file, team, @options, @config_store)
+    end
+
+    def file_offense_cache(file)
+      config = @config_store.for(file)
+      cache = cached_result(file, standby_team(config)) if cached_run?
+
+      if cache&.valid?
+        offenses = cache.load
+        # If we're running --auto-correct 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?
+      else
+        real_run_needed = true
+      end
+
+      if real_run_needed
+        offenses = yield
+        save_in_cache(cache, offenses)
+      end
+
+      offenses
+    end
+
+    def add_redundant_disables(file, offenses, source)
+      if check_for_redundant_disables?(source)
+        redundant_cop_disable_directive(file) do |cop|
+          cop.check(offenses, source.disabled_line_ranges, source.comments)
+          offenses += cop.offenses
+          offenses += autocorrect_redundant_disables(file, source, cop,
+                                                     offenses)
+        end
+      end
+
+      offenses.sort.reject(&:disabled?).freeze
+    end
+
+    def check_for_redundant_disables?(source)
+      !source.disabled_line_ranges.empty? && !filtered_run?
+    end
+
+    def redundant_cop_disable_directive(file)
+      config = @config_store.for(file)
+      if config.for_cop(Cop::Lint::RedundantCopDisableDirective)
+               .fetch('Enabled')
+        cop = Cop::Lint::RedundantCopDisableDirective.new(config, @options)
+        yield cop if cop.relevant_file?(file)
+      end
+    end
+
+    def filtered_run?
+      @options[:except] || @options[:only]
+    end
+
+    def autocorrect_redundant_disables(file, source, cop, offenses)
+      cop.processed_source = source
+
+      team = Cop::Team.new(RuboCop::Cop::Registry.new, nil, @options)
+      team.autocorrect(source.buffer, [cop])
+
+      return [] unless team.updated_source_file?
+
+      # Do one extra inspection loop if any redundant disables were
+      # removed. This is done in order to find rubocop:enable directives that
+      # have now become useless.
+      _source, new_offenses = do_inspection_loop(file,
+                                                 get_processed_source(file))
+      new_offenses - offenses
+    end
+
+    def file_started(file)
+      puts "Scanning #{file}" if @options[:debug]
+      formatter_set.file_started(file,
+                                 cli_options: @options,
+                                 config_store: @config_store)
+    end
+
+    def file_finished(file, offenses)
+      if @options[:display_only_fail_level_offenses]
+        offenses = offenses.select { |o| considered_failure?(o) }
+      end
+      formatter_set.file_finished(file, offenses)
+    end
+
+    def cached_run?
+      @cached_run ||=
+        (@options[:cache] == 'true' ||
+         @options[:cache] != 'false' &&
+         @config_store.for(Dir.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.
+        !@options[:auto_gen_config] &&
+        # We can't cache results from code which is piped in to stdin
+        !@options[:stdin]
+    end
+
+    def save_in_cache(cache, offenses)
+      return unless cache
+      # Caching results when a cop has crashed would prevent the crash in the
+      # next run, since the cop would not be called then. We want crashes to
+      # show up the same in each run.
+      return if errors.any? || warnings.any?
+
+      cache.save(offenses)
+    end
+
+    def do_inspection_loop(file, processed_source)
+      offenses = []
+
+      # When running with --auto-correct, 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.
+      iterate_until_no_changes(processed_source, offenses) do
+        # The offenses that couldn't be corrected will be found again so we
+        # only keep the corrected ones in order to avoid duplicate reporting.
+        offenses.select!(&:corrected?)
+        new_offenses, updated_source_file = inspect_file(processed_source)
+        offenses.concat(new_offenses).uniq!
+
+        # We have to reprocess the source to pickup the changes. Since the
+        # change could (theoretically) introduce parsing errors, we break the
+        # loop if we find any.
+        break unless updated_source_file
+
+        processed_source = get_processed_source(file)
+      end
+
+      [processed_source, offenses]
+    end
+
+    def iterate_until_no_changes(source, offenses)
+      # Keep track of the state of the source. If a cop modifies the source
+      # and another cop undoes it producing identical source we have an
+      # infinite loop.
+      @processed_sources = []
+
+      # It is also possible for a cop to keep adding indefinitely to a file,
+      # making it bigger and bigger. If the inspection loop runs for an
+      # excessively high number of iterations, this is likely happening.
+      iterations = 0
+
+      loop do
+        check_for_infinite_loop(source, offenses)
+
+        if (iterations += 1) > MAX_ITERATIONS
+          raise InfiniteCorrectionLoop.new(source.path, offenses)
+        end
+
+        source = yield
+        break unless source
+      end
+    end
+
+    # Check whether a run created source identical to a previous run, which
+    # means that we definitely have an infinite loop.
+    def check_for_infinite_loop(processed_source, offenses)
+      checksum = processed_source.checksum
+
+      if @processed_sources.include?(checksum)
+        raise InfiniteCorrectionLoop.new(processed_source.path, offenses)
+      end
+
+      @processed_sources << checksum
+    end
+
+    def inspect_file(processed_source)
+      config = @config_store.for(processed_source.path)
+      team = Cop::Team.new(mobilized_cop_classes(config), config, @options)
+      offenses = team.inspect_file(processed_source)
+      @errors.concat(team.errors)
+      @warnings.concat(team.warnings)
+      [offenses, team.updated_source_file?]
+    end
+
+    def mobilized_cop_classes(config)
+      @mobilized_cop_classes ||= {}
+      @mobilized_cop_classes[config.object_id] ||= begin
+        cop_classes = Cop::Cop.all
+
+        OptionsValidator.new(@options).validate_cop_options
+
+        if @options[:only]
+          cop_classes.select! { |c| c.match?(@options[:only]) }
+        else
+          filter_cop_classes(cop_classes, config)
+        end
+
+        cop_classes.reject! { |c| c.match?(@options[:except]) }
+
+        Cop::Registry.new(cop_classes)
+      end
+    end
+
+    def filter_cop_classes(cop_classes, config)
+      # use only cops that link to a style guide if requested
+      return unless style_guide_cops_only?(config)
+
+      cop_classes.select! { |cop| config.for_cop(cop)['StyleGuide'] }
+    end
+
+    def style_guide_cops_only?(config)
+      @options[:only_guide_cops] || config.for_all_cops['StyleGuideCopsOnly']
+    end
+
+    def formatter_set
+      @formatter_set ||= begin
+        set = Formatter::FormatterSet.new(@options)
+        pairs = @options[:formatters] || [['progress']]
+        pairs.each do |formatter_key, output_path|
+          set.add_formatter(formatter_key, output_path)
+        end
+        set
+      end
+    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
+
+      !offense.corrected? && offense.severity >= minimum_severity_to_fail
+    end
+
+    def minimum_severity_to_fail
+      @minimum_severity_to_fail ||= begin
+        name = @options[:fail_level] || :refactor
+        RuboCop::Cop::Severity.new(name)
+      end
+    end
+
+    def get_processed_source(file)
+      ruby_version = @config_store.for(file).target_ruby_version
+
+      if @options[:stdin]
+        ProcessedSource.new(@options[:stdin], ruby_version, file)
+      else
+        ProcessedSource.from_file(file, ruby_version)
+      end
+    end
+
+    # A Cop::Team instance is stateful and may change when inspecting.
+    # The "standby" team for a given config is an initialized but
+    # otherwise dormant team that can be used for config- and option-
+    # level caching in ResultCache.
+    def standby_team(config)
+      @team_by_config ||= {}
+      @team_by_config[config.object_id] ||=
+        Cop::Team.new(mobilized_cop_classes(config), config, @options)
+    end
+  end
+end