Class: RuboCop::Formatter::OffenseCountFormatter

Inherits:
BaseFormatter show all
Defined in:
lib/rubocop/formatter/offense_count_formatter.rb

Overview

This formatter displays the list of offended cops with a count of how many offenses of their kind were found. Ordered by desc offense count

Here's the format:

26 LineLength

3 OneLineConditional

29 Total

Instance Attribute Summary collapse

Attributes inherited from BaseFormatter

#output

Instance Method Summary collapse

Methods inherited from BaseFormatter

#file_started, #initialize

Constructor Details

This class inherits a constructor from RuboCop::Formatter::BaseFormatter

Instance Attribute Details

#offense_countsObject (readonly)

Returns the value of attribute offense_counts


15
16
17
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 15

def offense_counts
  @offense_counts
end

Instance Method Details

#file_finished(_file, offenses) ⇒ Object


22
23
24
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 22

def file_finished(_file, offenses)
  offenses.each { |o| @offense_counts[o.cop_name] += 1 }
end

#finished(_inspected_files) ⇒ Object


26
27
28
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 26

def finished(_inspected_files)
  report_summary(@offense_counts)
end

#ordered_offense_counts(offense_counts) ⇒ Object


46
47
48
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 46

def ordered_offense_counts(offense_counts)
  Hash[offense_counts.sort_by { |k, v| [-v, k] }]
end

#report_summary(offense_counts) ⇒ Object


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 30

def report_summary(offense_counts)
  per_cop_counts = ordered_offense_counts(offense_counts)
  total_count = total_offense_count(offense_counts)

  output.puts

  per_cop_counts.each do |cop_name, count|
    output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}" \
                "#{cop_name}\n"
  end
  output.puts '--'
  output.puts "#{total_count}  Total"

  output.puts
end

#started(target_files) ⇒ Object


17
18
19
20
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 17

def started(target_files)
  super
  @offense_counts = Hash.new(0)
end

#total_offense_count(offense_counts) ⇒ Object


50
51
52
# File 'lib/rubocop/formatter/offense_count_formatter.rb', line 50

def total_offense_count(offense_counts)
  offense_counts.values.inject(0, :+)
end