Class: RuboCop::Runner

# File 'lib/rubocop/runner.rb', line 29

def ruby_extractors
  @ruby_extractors ||= [default_ruby_extractor]
end

# File 'lib/rubocop/runner.rb', line 93

def aborting?
  @aborting
end

# File 'lib/rubocop/runner.rb', line 379

def cached_run?
  @cached_run ||=
    (@options[:cache] == 'true' ||
     (@options[:cache] != 'false' && @config_store.for_pwd.for_all_cops['UseCache'])) &&
    # We can't cache results from code which is piped in to stdin
    !@options[:stdin]
end

# File 'lib/rubocop/runner.rb', line 56

attr_reader :errors, :warnings, :diffs

# File 'lib/rubocop/runner.rb', line 56

attr_reader :errors, :warnings, :diffs

# File 'lib/rubocop/runner.rb', line 364

def except_redundant_cop_disable_directive?
  @options[:except] && (@options[:except] & REDUNDANT_COP_DISABLE_DIRECTIVE_RULES).any?
end

# File 'lib/rubocop/runner.rb', line 490

def in_memory_corrections_possible?
  self.class.ruby_extractors.one?
end

# File 'lib/rubocop/runner.rb', line 237

def parallel_supported_by_options?
  @options[:parallel] && !@options[:auto_gen_config] && !@options[:diff]
end

# File 'lib/rubocop/runner.rb', line 241

def project_index_disables_parallel?
  return false if @project_index.nil? || !Gem.win_platform?

  if @options[:debug]
    puts 'Skipping parallel inspection: the project index is enabled and parallel ' \
         'inspection is not yet supported on Windows.'
  end

  true
end

# File 'lib/rubocop/runner.rb', line 148

def project_index_enabled?
  return false unless @config_store.for_pwd.for_all_cops['UseProjectIndex']

  unless ProjectIndexLoader.available?
    ProjectIndexLoader.warn_unavailable
    return false
  end

  true
end

# File 'lib/rubocop/runner.rb', line 56

attr_reader :errors, :warnings, :diffs

# File 'lib/rubocop/runner.rb', line 702

def assemble_team(config)
  team = Cop::Team.mobilize(mobilized_cop_classes(config), config, @options)

  if @project_index
    team.cops.each do |cop|
      cop.project_index = @project_index
    end
  end

  team
end

# File 'lib/rubocop/runner.rb', line 120

def build_project_index(target_files)
  return unless project_index_enabled?

  @project_index = ProjectIndexLoader.build_index(project_index_files(target_files))
end

# File 'lib/rubocop/runner.rb', line 142

def bundled_gem_files
  return [] unless @config_store.for_pwd.for_all_cops['ProjectIndexIncludesGems']

  ProjectIndexLoader.bundled_gem_source_files
end

# File 'lib/rubocop/runner.rb', line 292

def cached_result(file, team)
  ResultCache.new(file, team, @options, @config_store)
end

# File 'lib/rubocop/runner.rb', line 519

def check_for_infinite_loop(processed_source, offenses_by_iteration)
  checksum = processed_source.checksum

  if (loop_start_index = @processed_sources.index(checksum))
    raise InfiniteCorrectionLoop.new(
      processed_source.path,
      offenses_by_iteration,
      loop_start: loop_start_index
    )
  end

  @processed_sources << checksum
end

# File 'lib/rubocop/runner.rb', line 344

def check_for_redundant_disables?(source)
  return false if except_redundant_cop_disable_directive?
  # Detached `disable-next` directives produce no disabled ranges but must
  # still be reported as redundant.
  if source.disabled_line_ranges.empty? &&
     source.comment_config.detached_next_directives.empty?
    return false
  end

  !@options[:only]
end

# File 'lib/rubocop/runner.rb', line 612

def considered_failure?(offense)
  return false if offense.disabled?

  # 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

# File 'lib/rubocop/runner.rb', line 649

def default_config(cop_name)
  RuboCop::ConfigLoader.default_configuration[cop_name]
end

# File 'lib/rubocop/runner.rb', line 397

def do_inspection_loop(file)
  # We can reuse the prism result since the source did not change yet.
  processed_source = get_processed_source(file, @prism_result)
  original_source = processed_source.raw_source
  # This variable is 2d array used to track corrected offenses after each
  # inspection iteration. This is used to output meaningful infinite loop
  # error message.
  offenses_by_iteration = []
  corrected_source = nil

  # When running with --autocorrect, we need to inspect the file 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. The corrections are kept in memory while iterating and written
  # back to the file when the loop is done.
  iterate_until_no_changes(processed_source, offenses_by_iteration) do
    team, updated_source_file = inspect_and_correct(processed_source, offenses_by_iteration)

    # 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

    # Autocorrect has happened, don't use the prism result since it is stale.
    # With --stdin the corrected source is kept in @options[:stdin] instead.
    corrected_source = team.updated_source
    processed_source = get_processed_source(file, nil, source: corrected_source)
  end

  # Return summary of corrected offenses after all iterations
  [processed_source, offenses_by_iteration.flatten.uniq]
ensure
  finalize_corrections(file, original_source, corrected_source)
end

# File 'lib/rubocop/runner.rb', line 481

def emulate_write_read_cycle(source)
  return source unless Platform.windows?

  source.encode(source.encoding, crlf_newline: true)
end

# File 'lib/rubocop/runner.rb', line 541

def extract_ruby_sources(processed_source)
  self.class.ruby_extractors.find do |ruby_extractor|
    result = ruby_extractor.call(processed_source)
    break result if result
  rescue StandardError
    location = if ruby_extractor.is_a?(Proc)
                 ruby_extractor.source_location
               else
                 ruby_extractor.method(:call).source_location
               end
    raise Error, "Ruby extractor #{location[0]} failed to process #{processed_source.path}."
  end
end

# File 'lib/rubocop/runner.rb', line 373

def file_finished(file, offenses)
  @inspected_files << file
  offenses = offenses_to_report(offenses)
  formatter_set.file_finished(file, offenses)
end

# File 'lib/rubocop/runner.rb', line 179

def file_iterator(files, &block)
  all_passed = true

  on_start = ->(file, _index) { file_started(file) }
  on_finish = lambda do |file, index, (offenses, passed)|
    all_passed &&= passed
    finished_report(file, index, offenses)
  end

  if run_in_parallel?(files)
    parallel_file_iterator(files, on_start, on_finish, &block)
  else
    serial_file_iterator(files, on_start, on_finish, &block)
  end

  process_remaining_report_queue

  all_passed
end

# File 'lib/rubocop/runner.rb', line 296

def file_offense_cache(file)
  config = @config_store.for_file(file)
  cache = cached_result(file, standby_team(config)) if cached_run?

  if cache&.valid?
    offenses = cache.load
    # 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[:autocorrect] && offenses.any?
  else
    real_run_needed = true
  end

  if real_run_needed
    offenses = yield
    save_in_cache(cache, offenses) unless Cop::Registry.global.warnings?(file)
  end

  offenses
end

# File 'lib/rubocop/runner.rb', line 283

def file_offenses(file)
  file_offense_cache(file) do
    source, offenses = do_inspection_loop(file)
    offenses = add_redundant_disables(file, offenses.compact.sort, source)
    offenses = offenses.reject(&:disabled?) unless @options[:display_suppressed]
    offenses.sort.freeze
  end
end

# File 'lib/rubocop/runner.rb', line 368

def file_started(file)
  puts "Scanning #{file}" if @options[:debug]
  formatter_set.file_started(file, cli_options: @options, config_store: @config_store)
end

# File 'lib/rubocop/runner.rb', line 445

def finalize_corrections(file, original_source, corrected_source)
  if @options[:diff]
    record_diff(file, original_source, corrected_source)
  elsif corrected_source
    File.write(file, corrected_source)
  end
end

# File 'lib/rubocop/runner.rb', line 109

def find_target_files(paths)
  target_finder = TargetFinder.new(@config_store, @options)
  mode = if @options[:only_recognized_file_types]
           :only_recognized_file_types
         else
           :all_file_types
         end
  target_files = target_finder.find(paths, mode)
  target_files.each(&:freeze).freeze
end

# File 'lib/rubocop/runner.rb', line 199

def finished_report(file, index, offenses)
  @report_queue[index] = [file, offenses]
  @next_index_to_report ||= 0
  while @report_queue.key?(@next_index_to_report)
    process_report_queue_entry(@next_index_to_report)
    @next_index_to_report += 1
  end
end

# File 'lib/rubocop/runner.rb', line 603

def formatter_set
  @formatter_set ||= begin
    set = Formatter::FormatterSet.new(@options)
    pairs = @options[:formatters] || [['progress']]
    pairs.each { |formatter_key, output_path| set.add_formatter(formatter_key, output_path) }
    set
  end
end

# File 'lib/rubocop/runner.rb', line 659

def get_processed_source(file, prism_result, source: nil)
  config = @config_store.for_file(file)
  ruby_version = config.target_ruby_version
  parser_engine = config.parser_engine

  processed_source = if source
                       ProcessedSource.new(
                         emulate_write_read_cycle(source),
                         ruby_version,
                         file,
                         parser_engine: parser_engine
                       )
                     elsif @options[:stdin]
                       ProcessedSource.new(
                         @options[:stdin],
                         ruby_version,
                         file,
                         parser_engine: parser_engine,
                         prism_result: prism_result
                       )
                     else
                       begin
                         ProcessedSource.from_file(
                           file, ruby_version, parser_engine: parser_engine
                         )
                       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

# File 'lib/rubocop/runner.rb', line 432

def inspect_and_correct(processed_source, offenses_by_iteration)
  # 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_by_iteration.empty? && offenses_by_iteration.last.select!(&:corrected?)
  team, new_offenses, updated_source_file = inspect_iteration(processed_source)
  offenses_by_iteration.push(new_offenses)

  [team, updated_source_file]
end

# File 'lib/rubocop/runner.rb', line 533

def inspect_file(processed_source, team = mobilize_team(processed_source))
  extracted_ruby_sources = extract_ruby_sources(processed_source)
  offenses = team.investigate_fragments(extracted_ruby_sources, original: processed_source)
  @errors.concat(team.errors)
  @warnings.concat(team.warnings)
  [offenses, team.updated_source_file?]
end

# File 'lib/rubocop/runner.rb', line 159

def inspect_files(files) # rubocop:disable Metrics/AbcSize
  formatter_set.started(files)
  formatters_started = true
  file_iterator(files) do |file|
    offenses = process_file(file)
    succeeded = offenses.none? { |o| considered_failure?(o) && offense_displayed?(o) }

    [offenses, succeeded]
  end
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], @options[:cache_root])
  end
  formatter_set.finished(@inspected_files.freeze) if formatters_started
  formatter_set.close_output_files
end

# File 'lib/rubocop/runner.rb', line 469

def inspect_iteration(processed_source)
  team = mobilize_team(processed_source)
  team.defer_corrections = @options[:diff] || in_memory_corrections_possible?
  offenses, updated_source_file = inspect_file(processed_source, team)
  [team, offenses, updated_source_file]
end

# File 'lib/rubocop/runner.rb', line 494

def iterate_until_no_changes(source, offenses_by_iteration)
  # 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_by_iteration)

    if (iterations += 1) > MAX_ITERATIONS
      raise InfiniteCorrectionLoop.new(source.path, offenses_by_iteration)
    end

    source = yield
    break unless source
  end
end

# File 'lib/rubocop/runner.rb', line 269

def list_files(paths)
  paths.each { |path| puts PathUtil.relative_path(path) }
end

# File 'lib/rubocop/runner.rb', line 645

def mark_as_safe_by_config?(config)
  config.nil? || (config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true))
end

# File 'lib/rubocop/runner.rb', line 653

def minimum_severity_to_fail
  @minimum_severity_to_fail ||=
    RuboCop::Cop::Severity.minimum_to_fail(@options, @config_store.for_pwd)
end

# File 'lib/rubocop/runner.rb', line 577

def mobilize_cop_badge?(badge, config)
  return false if badge.department == :Test
  return false if badge.match_name?(@options[:except])

  if @options[:only]
    badge.match_name?(@options[:only])
  else
    # use only cops that link to a style guide if requested.
    !style_guide_cops_only?(config) || config.for_cop(badge.to_s)['StyleGuide']
  end
end

# File 'lib/rubocop/runner.rb', line 555

def mobilize_team(processed_source)
  config = @config_store.for_file(processed_source.path)
  @inspection_team_by_config ||= {}.compare_by_identity
  @inspection_team_by_config[config] ||= assemble_team(config)
end

# File 'lib/rubocop/runner.rb', line 561

def mobilized_cop_classes(config)
  @mobilized_cop_classes ||= {}.compare_by_identity
  @mobilized_cop_classes[config] ||= begin
    # `@options[:only]` and `@options[:except]` are not qualified until
    # needed so that the registry contains any cops added by `require`s,
    # which register eagerly when their files are loaded.
    qualify_option_cop_names

    OptionsValidator.new(@options).validate_cop_options

    # Filtering by badge keeps lazy-loaded cops unloaded; only the cops
    # that survive the filter and are enabled will be loaded.
    Cop::Registry.global.filter_by_badge(@options) { |badge| mobilize_cop_badge?(badge, config) }
  end
end

# File 'lib/rubocop/runner.rb', line 621

def offense_displayed?(offense)
  if @options[:display_only_fail_level_offenses]
    considered_failure?(offense)
  elsif @options[:display_only_safe_correctable]
    supports_safe_autocorrect?(offense)
  elsif @options[:display_only_correctable]
    offense.correctable?
  else
    true
  end
end

# File 'lib/rubocop/runner.rb', line 633

def offenses_to_report(offenses)
  offenses.select { |o| offense_displayed?(o) }
end

# File 'lib/rubocop/runner.rb', line 101

def only_changed(target_files)
  return target_files unless @options[:changed]

  changed = ChangedFiles.new(@options[:changed]).paths

  target_files.select { |file| changed.include?(file) }.freeze
end

# File 'lib/rubocop/runner.rb', line 252

def parallel_file_iterator(files, on_start, on_finish, &block)
  Parallel.each(files, start: on_start, finish: on_finish, &block)
end

# File 'lib/rubocop/runner.rb', line 273

def process_file(file)
  file_offenses(file)
rescue InfiniteCorrectionLoop => e
  raise e if @options[:raise_cop_error]

  errors << e
  warn Rainbow(e.message).red
  e.offenses.compact.sort.freeze
end

# File 'lib/rubocop/runner.rb', line 213

def process_remaining_report_queue
  @report_queue.keys.sort.each do |index|
    process_report_queue_entry(index)
  end
end

# File 'lib/rubocop/runner.rb', line 208

def process_report_queue_entry(index)
  file, offenses = @report_queue.delete(index)
  file_finished(file, offenses)
end

# File 'lib/rubocop/runner.rb', line 131

def project_index_files(target_files)
  root = @config_store.for_pwd.base_dir_for_path_parameters
  project_files = begin
    find_target_files([root]) | target_files
  rescue Errno::ENOENT
    target_files
  end

  (project_files | bundled_gem_files).sort
end

# File 'lib/rubocop/runner.rb', line 589

def qualify_option_cop_names
  %i[only except].each do |option|
    next unless @options[option]

    @options[option].map! do |cop_name|
      Cop::Registry.qualified_cop_name(cop_name, "--#{option} option")
    end
  end
end

# File 'lib/rubocop/runner.rb', line 456

def record_diff(file, original_source, corrected_source)
  new_source = @options[:stdin] || corrected_source
  return unless original_source && new_source

  # The original source is the file as it is on disk, so the corrected one
  # has to go through the same line ending conversion `File.write` would
  # apply, or on Windows every single line reads as changed.
  new_source = emulate_write_read_cycle(new_source)

  diff = UnifiedDiff.new(PathUtil.smart_path(file), original_source, new_source).to_s
  @diffs << diff unless diff.empty?
end

# File 'lib/rubocop/runner.rb', line 356

def redundant_cop_disable_directive(file)
  config = @config_store.for_file(file)
  return unless config.for_cop(Cop::Lint::RedundantCopDisableDirective).fetch('Enabled')

  cop = Cop::Lint::RedundantCopDisableDirective.new(config, @options)
  yield cop if cop.relevant_file?(file)
end

# File 'lib/rubocop/runner.rb', line 70

def run(paths)
  @inspection_team_by_config = {}.compare_by_identity

  # Compute the cache source checksum once to avoid potential
  # inconsistencies between workers.
  ResultCache.source_checksum

  target_files = only_changed(find_target_files(paths))
  build_project_index(target_files)

  if @options[:list_target_files]
    list_files(target_files)
  else
    inspect_files(target_files)
  end
rescue Interrupt
  self.aborting = true
  warn ''
  warn 'Exiting...'

  false
end

# File 'lib/rubocop/runner.rb', line 219

def run_in_parallel?(files)
  return false unless parallel_supported_by_options?

  if files.size <= 1
    puts 'Skipping parallel inspection: only a single file needs inspection' if @options[:debug]
    return false
  end

  return false if project_index_disables_parallel?

  puts 'Running parallel inspection' if @options[:debug]

  true
end

# File 'lib/rubocop/runner.rb', line 387

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

# File 'lib/rubocop/runner.rb', line 256

def serial_file_iterator(files, on_start, on_finish, &block)
  files.each_with_index do |file, index|
    on_start.call(file, index)
    result = yield file
    on_finish.call(file, index, result)

    # Report and count the offending file before stopping so `--fail-fast`
    # still shows its offenses and exits with a failing status.
    _offenses, succeeded = result
    break if @options[:fail_fast] && !succeeded
  end
end

# File 'lib/rubocop/runner.rb', line 697

def standby_team(config)
  @standby_team_by_config ||= {}.compare_by_identity
  @standby_team_by_config[config] ||= assemble_team(config)
end

# File 'lib/rubocop/runner.rb', line 599

def style_guide_cops_only?(config)
  @options[:only_guide_cops] || config.for_all_cops['StyleGuideCopsOnly']
end

# File 'lib/rubocop/runner.rb', line 637

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

# File 'lib/rubocop/runner.rb', line 333

def team_for_redundant_disables(file, offenses, source)
  return unless check_for_redundant_disables?(source)

  config = @config_store.for_file(file)
  team = Cop::Team.mobilize([Cop::Lint::RedundantCopDisableDirective], config, @options)
  return if team.cops.empty?

  team.cops.first.offenses_to_check = offenses
  yield team
end