class RuboCop::Cop::Commissioner
work to the specified cops.
Commissioner class is responsible for processing the AST and delegating
def self.callback_methods
def self.callback_methods Parser::Meta::NODE_TYPES.map { |type| :"on_#{type}" } end
def initialize(cops, forces = [], options = {})
def initialize(cops, forces = [], options = {}) @cops = cops @forces = forces @options = options @callbacks = {} reset_errors end
def investigate(processed_source)
def investigate(processed_source) reset_errors remove_irrelevant_cops(processed_source.buffer.name) reset_callbacks prepare(processed_source) invoke_custom_processing(@cops, processed_source) invoke_custom_processing(@forces, processed_source) walk(processed_source.ast) if processed_source.ast @cops.flat_map(&:offenses) end
def invoke_custom_processing(cops_or_forces, processed_source)
to the commissioner will be passed to the cop too in order to do
If they define the #investigate method, all input parameters passed
There are cops/forces that require their own custom processing.
def invoke_custom_processing(cops_or_forces, processed_source) cops_or_forces.each do |cop| next unless cop.respond_to?(:investigate) with_cop_error_handling(cop) do cop.investigate(processed_source) end end end
def prepare(processed_source)
def prepare(processed_source) @cops.each { |cop| cop.processed_source = processed_source } end
def remove_irrelevant_cops(filename)
def remove_irrelevant_cops(filename) @cops.reject! { |cop| cop.excluded_file?(filename) } end
def reset_callbacks
def reset_callbacks @callbacks.clear end
def reset_errors
def reset_errors @errors = Hash.new { |hash, k| hash[k] = [] } end
def with_cop_error_handling(cop)
def with_cop_error_handling(cop) yield rescue => e raise e if @options[:raise_error] @errors[cop] << e end