123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Formatter::TapFormatter

Overview

This formatter formats report data using the Test Anything Protocol. TAP allows for to communicate tests results in a language agnostics way.

Constant Summary

::RuboCop::PathUtil - Included

HIDDEN_FILE_PATTERN, SMART_PATH_CACHE

SimpleTextFormatter - Inherited

COLOR_FOR_SEVERITY

ClangStyleFormatter - Inherited

ELLIPSES

Class Method Summary

BaseFormatter - Inherited

.new

Instance Attribute Summary

BaseFormatter - Inherited

#options, #output

Instance Method Summary

ClangStyleFormatter - Inherited

#report_file, #report_highlighted_area, #report_line, #report_offense, #valid_line?

SimpleTextFormatter - Inherited

#file_finished, #finished, #report_file, #report_summary, #started, #annotate_message, #colored_severity_code, #count_stats, #message

::RuboCop::PathUtil - Included

#absolute?

Returns true for an absolute Unix or Windows path.
#glob?

Returns true for a glob.
#hidden_dir?, #hidden_file?, #hidden_file_in_not_hidden_dir?,
#match_path?

Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity.
#maybe_hidden_file?

Loose check to reduce memory allocations.
#relative_path, #smart_path

Colorizable - Included

#colorize, #rainbow

BaseFormatter - Inherited

#file_finished

Invoked at the end of inspecting each files.
#file_started

Invoked at the beginning of inspecting each files.
#finished

Invoked after all files are inspected or interrupted by user.
#started

Invoked once before any files are inspected.

Constructor Details

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

Instance Method Details

#annotate_message(msg) (private)

[ GitHub ] 

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 62



def annotate_message(msg)
  msg.gsub(/`(.*?)`/, '\1')
end


  








  

    #file_finished(file, offenses)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 14



def file_finished(file, offenses)
  if offenses.empty?
    output.puts "ok #{@progress_count} - #{smart_path(file)}"
  else
    output.puts "not ok #{@progress_count} - #{smart_path(file)}"

    count_stats(offenses)
    report_file(file, offenses)
  end

  @progress_count += 1
end


  








  

    #message(offense)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 66



def message(offense)
  message =
    if offense.corrected_with_todo?
      '[Todo] '
    elsif offense.corrected?
      '[Corrected] '
    elsif offense.correctable?
      '[Correctable] '
    else
      ''
    end

  "#{message}#{annotate_message(offense.message)}"
end


  








  

    #report_highlighted_area(highlighted_area)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 39



def report_highlighted_area(highlighted_area)
  space_area  = highlighted_area.source_buffer.slice(0...highlighted_area.begin_pos)
  source_area = highlighted_area.source
  output.puts("# #{' ' * Unicode::DisplayWidth.of(space_area)}" \
              "#{'^' * Unicode::DisplayWidth.of(source_area)}")
end


  








  

    #report_line(location)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 29



def report_line(location)
  source_line = location.source_line

  if location.single_line?
    output.puts("# #{source_line}")
  else
    output.puts("# #{source_line} #{yellow(ELLIPSES)}")
  end
end


  








  

    #report_offense(file, offense)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 46



def report_offense(file, offense)
  output.printf(
    "# %<path>s:%<line>d:%<column>d: %<severity>s: %<message>s\n",
    path: cyan(smart_path(file)),
    line: offense.line,
    column: offense.real_column,
    severity: colored_severity_code(offense),
    message: message(offense)
  )

  return unless valid_line?(offense)

  report_line(offense.location)
  report_highlighted_area(offense.highlighted_area)
end


  








  

    #started(target_files)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/tap_formatter.rb', line 8



def started(target_files)
  super
  @progress_count = 1
  output.puts "1..#{target_files.size}"
end