Class: RuboCop::Formatter::WorstOffendersFormatter
Overview
This formatter displays the list of offensive files, sorted by number of offenses with the worst offenders first.
Here’s the format:
26 this/file/is/really/bad.rb 3 just/ok.rb – 29 Total
Instance Attribute Summary collapse
#options, #output
Instance Method Summary
collapse
#file_started, #initialize
Instance Attribute Details
#offense_counts ⇒ Object
Returns the value of attribute offense_counts.
17
18
19
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 17
def offense_counts
@offense_counts
end
|
Instance Method Details
#file_finished(file, offenses) ⇒ Object
24
25
26
27
28
29
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 24
def file_finished(file, offenses)
return if offenses.empty?
path = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
@offense_counts[path] = offenses.size
end
|
#finished(_inspected_files) ⇒ Object
31
32
33
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 31
def finished(_inspected_files)
report_summary(@offense_counts)
end
|
#ordered_offense_counts(offense_counts) ⇒ Object
51
52
53
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 51
def ordered_offense_counts(offense_counts)
Hash[offense_counts.sort_by { |k, v| [-v, k] }]
end
|
#report_summary(offense_counts) ⇒ Object
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 35
def report_summary(offense_counts)
per_file_counts = ordered_offense_counts(offense_counts)
total_count = total_offense_count(offense_counts)
output.puts
per_file_counts.each do |file_name, count|
output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}" \
"#{file_name}\n"
end
output.puts '--'
output.puts "#{total_count} Total"
output.puts
end
|
#started(target_files) ⇒ Object
19
20
21
22
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 19
def started(target_files)
super
@offense_counts = {}
end
|
#total_offense_count(offense_counts) ⇒ Object
55
56
57
|
# File 'lib/rubocop/formatter/worst_offenders_formatter.rb', line 55
def total_offense_count(offense_counts)
offense_counts.values.inject(0, :+)
end
|