Class: RuboCop::Formatter::JSONFormatter

Inherits:
BaseFormatter show all
Includes:
PathUtil
Defined in:
lib/rubocop/formatter/json_formatter.rb

Overview

This formatter formats the report data in JSON format.

Constant Summary

Constants included from PathUtil

PathUtil::HIDDEN_FILE_PATTERN

Instance Attribute Summary collapse

Attributes inherited from BaseFormatter

#options, #output

Instance Method Summary collapse

Methods included from PathUtil

absolute?, glob?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Methods inherited from BaseFormatter

#file_started

Constructor Details

#initialize(output, options = {}) ⇒ JSONFormatter

Returns a new instance of JSONFormatter.



13
14
15
16
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 13

def initialize(output, options = {})
  super
  @output_hash = { metadata: metadata_hash, files: [], summary: { offense_count: 0 } }
end

Instance Attribute Details

#output_hash ⇒ Object (readonly)

Returns the value of attribute output_hash.



11
12
13
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 11

def output_hash
  @output_hash
end

Instance Method Details

#file_finished(file, offenses) ⇒ Object 



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

def file_finished(file, offenses)
  output_hash[:files] << hash_for_file(file, offenses)
  output_hash[:summary][:offense_count] += offenses.count
end

#finished(inspected_files) ⇒ Object 



27
28
29
30
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 27

def finished(inspected_files)
  output_hash[:summary][:inspected_file_count] = inspected_files.count
  output.write output_hash.to_json
end

#hash_for_file(file, offenses) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 42

def hash_for_file(file, offenses)
  {
    path:     smart_path(file),
    offenses: offenses.map { |o| hash_for_offense(o) }
  }
end

#hash_for_location(offense) ⇒ Object

TODO: Consider better solution for Offense#real_column.

The minimum value of `start_column: real_column` is 1.
So, the minimum value of `last_column` should be 1.
And non-zero value of `last_column` should be used as is.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 64

def hash_for_location(offense)
  {
    start_line:   offense.line,
    start_column: offense.real_column,
    last_line:    offense.last_line,
    last_column:  offense.last_column.zero? ? 1 : offense.last_column,
    length:       offense.location.length,
    # `line` and `column` exist for compatibility.
    # Use `start_line` and `start_column` instead.
    line:         offense.line,
    column:       offense.real_column
  }
end

#hash_for_offense(offense) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 49

def hash_for_offense(offense)
  {
    severity:    offense.severity.name,
    message:     offense.message,
    cop_name:    offense.cop_name,
    corrected:   offense.corrected?,
    correctable: offense.correctable?,
    location:    hash_for_location(offense)
  }
end

#metadata_hash ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/rubocop/formatter/json_formatter.rb', line 32

def metadata_hash
  {
    rubocop_version: RuboCop::Version::STRING,
    ruby_engine:     RUBY_ENGINE,
    ruby_version:    RUBY_VERSION,
    ruby_patchlevel: RUBY_PATCHLEVEL.to_s,
    ruby_platform:   RUBY_PLATFORM
  }
end

#started(target_files) ⇒ Object 



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

def started(target_files)
  output_hash[:summary][:target_file_count] = target_files.count
end