class RuboCop::Formatter::FormatterSet
which invoke same method of each formatters.
formatter instances and provides transparent formatter API methods
This is a collection of formatters. A FormatterSet can hold multiple
def add_formatter(formatter_type, output_path = nil)
def add_formatter(formatter_type, output_path = nil) formatter_class = case formatter_type when Class formatter_type when /\A[A-Z]/ custom_formatter_class(formatter_type) else builtin_formatter_class(formatter_type) end if output_path dir_path = File.dirname(output_path) FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path) output = File.open(output_path, 'w') else output = $stdout end self << formatter_class.new(output) end
def builtin_formatter_class(specified_key)
def builtin_formatter_class(specified_key) matching_keys = BUILTIN_FORMATTERS_FOR_KEYS.keys.select do |key| key.start_with?(specified_key) end if matching_keys.empty? fail %(No formatter for "#{specified_key}") elsif matching_keys.size > 1 fail %(Cannot determine formatter for "#{specified_key}") end BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first] end
def close_output_files
def close_output_files each do |formatter| formatter.output.close if formatter.output.is_a?(File) end end
def custom_formatter_class(specified_class_name)
def custom_formatter_class(specified_class_name) constant_names = specified_class_name.split('::') constant_names.shift if constant_names.first.empty? constant_names.reduce(Object) do |namespace, constant_name| namespace.const_get(constant_name, false) end end
def file_finished(file, offenses)
def file_finished(file, offenses) if @cop_disabled_line_ranges.any? && # Don't check unneeded disable if --only or --except option is # given, because these options override configuration. (@options[:except] || []).empty? && (@options[:only] || []).empty? config = @config_store.for(file) if config['Lint/UnneededDisable']['Enabled'] cop = Cop::Lint::UnneededDisable.new(config, @options) cop.check(offenses, @cop_disabled_line_ranges, @comments) offenses += cop.offenses end end offenses = offenses.sort.reject(&:disabled?) each { |f| f.file_finished(file, offenses) } offenses end
def file_started(file, options)
def file_started(file, options) @cop_disabled_line_ranges = options[:cop_disabled_line_ranges] @comments = options[:comments] @options = options[:cli_options] @config_store = options[:config_store] each { |f| f.file_started(file, options) } end