class RuboCop::Runner

This class handles the processing of files, which includes dealing with formatters and letting cops inspect the files.

Constants

MAX_ITERATIONS

Attributes

aborting[R]
aborting?[R]
errors[R]
warnings[R]

Public Class Methods

new(options, config_store) click to toggle source
# File lib/rubocop/runner.rb, line 25
def initialize(options, config_store)
  @options = options
  @config_store = config_store
  @errors = []
  @warnings = []
  @aborting = false
end

Public Instance Methods

abort() click to toggle source
# File lib/rubocop/runner.rb, line 43
def abort
  @aborting = true
end
run(paths) click to toggle source
# File lib/rubocop/runner.rb, line 33
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
end

Private Instance Methods

add_unneeded_disables(file, offenses, source) click to toggle source
# File lib/rubocop/runner.rb, line 128
def add_unneeded_disables(file, offenses, source)
  if check_for_unneeded_disables?(source)
    config = @config_store.for(file)
    if config.for_cop(Cop::Lint::UnneededDisable).fetch('Enabled')
      cop = Cop::Lint::UnneededDisable.new(config, @options)
      if cop.relevant_file?(file)
        cop.check(offenses, source.disabled_line_ranges, source.comments)
        offenses += cop.offenses
        autocorrect_unneeded_disables(source, cop)
      end
    end
    offenses
  end

  offenses.sort.reject(&:disabled?).freeze
end
autocorrect_unneeded_disables(source, cop) click to toggle source
# File lib/rubocop/runner.rb, line 153
def autocorrect_unneeded_disables(source, cop)
  cop.processed_source = source

  Cop::Team.new(
    RuboCop::Cop::Registry.new,
    nil,
    @options
  ).autocorrect(source.buffer, [cop])
end
cached_run?() click to toggle source
# File lib/rubocop/runner.rb, line 169
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 can not use caching.
    !@options[:auto_gen_config] &&
    # Auto-correction needs a full run. It can not use cached results.
    !@options[:auto_correct] &&
    # We can't cache results from code which is piped in to stdin
    !@options[:stdin]
end
check_for_infinite_loop(processed_source, offenses) click to toggle source

Check whether a run created source identical to a previous run, which means that we definitely have an infinite loop.

# File lib/rubocop/runner.rb, line 244
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
check_for_unneeded_disables?(source) click to toggle source
# File lib/rubocop/runner.rb, line 145
def check_for_unneeded_disables?(source)
  !source.disabled_line_ranges.empty? && !filtered_run?
end
considered_failure?(offense) click to toggle source
# File lib/rubocop/runner.rb, line 312
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
do_inspection_loop(file, processed_source) click to toggle source
# File lib/rubocop/runner.rb, line 194
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
each_inspected_file(files) { |file| ... } click to toggle source
# File lib/rubocop/runner.rb, line 74
def each_inspected_file(files)
  files.reduce(true) do |all_passed, file|
    break false if aborting?

    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
enable_rails_cops(config) click to toggle source
# File lib/rubocop/runner.rb, line 264
def enable_rails_cops(config)
  config['Rails'] ||= {}
  config['Rails']['Enabled'] = true
end
file_offense_cache(file) { || ... } click to toggle source
# File lib/rubocop/runner.rb, line 116
def file_offense_cache(file)
  cache = ResultCache.new(file, @options, @config_store) if cached_run?
  if cache && cache.valid?
    offenses = cache.load
  else
    offenses = yield
    save_in_cache(cache, offenses)
  end

  offenses
end
file_offenses(file) click to toggle source
# File lib/rubocop/runner.rb, line 108
def file_offenses(file)
  file_offense_cache(file) do
    source = get_processed_source(file)
    source, offenses = do_inspection_loop(file, source)
    add_unneeded_disables(file, offenses.compact.sort, source)
  end
end
file_started(file) click to toggle source
# File lib/rubocop/runner.rb, line 163
def file_started(file)
  formatter_set.file_started(file,
                             cli_options: @options,
                             config_store: @config_store)
end
filter_cop_classes(cop_classes, config) click to toggle source
# File lib/rubocop/runner.rb, line 290
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
filtered_run?() click to toggle source
# File lib/rubocop/runner.rb, line 149
def filtered_run?
  @options[:except] || @options[:only]
end
find_target_files(paths) click to toggle source
# File lib/rubocop/runner.rb, line 56
def find_target_files(paths)
  target_finder = TargetFinder.new(@config_store, @options)
  target_files = target_finder.find(paths)
  target_files.each(&:freeze).freeze
end
formatter_set() click to toggle source
# File lib/rubocop/runner.rb, line 301
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
get_processed_source(file) click to toggle source
# File lib/rubocop/runner.rb, line 328
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
inspect_file(processed_source) click to toggle source
# File lib/rubocop/runner.rb, line 254
def inspect_file(processed_source)
  config = @config_store.for(processed_source.path)
  enable_rails_cops(config) if @options[:rails]
  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
inspect_files(files) click to toggle source
# File lib/rubocop/runner.rb, line 62
def inspect_files(files)
  inspected_files = []

  formatter_set.started(files)

  each_inspected_file(files) { |file| inspected_files << file }
ensure
  ResultCache.cleanup(@config_store, @options[:debug]) if cached_run?
  formatter_set.finished(inspected_files.freeze)
  formatter_set.close_output_files
end
iterate_until_no_changes(source, offenses) { || ... } click to toggle source
# File lib/rubocop/runner.rb, line 219
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
list_files(paths) click to toggle source
# File lib/rubocop/runner.rb, line 90
def list_files(paths)
  paths.each do |path|
    puts PathUtil.relative_path(path)
  end
end
minimum_severity_to_fail() click to toggle source
# File lib/rubocop/runner.rb, line 321
def minimum_severity_to_fail
  @minimum_severity_to_fail ||= begin
    name = @options[:fail_level] || :refactor
    RuboCop::Cop::Severity.new(name)
  end
end
mobilized_cop_classes(config) click to toggle source
# File lib/rubocop/runner.rb, line 269
def mobilized_cop_classes(config)
  @mobilized_cop_classes ||= {}
  @mobilized_cop_classes[config.object_id] ||= begin
    cop_classes = Cop::Cop.all

    %i[only except].each do |opt|
      OptionsValidator.validate_cop_list(@options[opt])
    end

    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
process_file(file) click to toggle source
# File lib/rubocop/runner.rb, line 96
def process_file(file)
  puts "Scanning #{file}" if @options[:debug]
  file_started(file)

  offenses = file_offenses(file)
  formatter_set.file_finished(file, offenses)
  offenses
rescue InfiniteCorrectionLoop => e
  formatter_set.file_finished(file, e.offenses.compact.sort.freeze)
  raise
end
save_in_cache(cache, offenses) click to toggle source
# File lib/rubocop/runner.rb, line 184
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
style_guide_cops_only?(config) click to toggle source
# File lib/rubocop/runner.rb, line 297
def style_guide_cops_only?(config)
  @options[:only_guide_cops] || config.for_all_cops['StyleGuideCopsOnly']
end
warm_cache(target_files) click to toggle source

Warms up the RuboCop cache by forking a suitable number of rubocop instances that each inspects its alotted group of files.

# File lib/rubocop/runner.rb, line 51
def warm_cache(target_files)
  puts 'Running parallel inspection' if @options[:debug]
  Parallel.each(target_files, &method(:file_offenses))
end