123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Formatter::JUnitFormatter

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, BaseFormatter
Instance Chain:
self, BaseFormatter
Inherits: RuboCop::Formatter::BaseFormatter
Defined in: lib/rubocop/formatter/junit_formatter.rb

Overview

This formatter formats the report data in JUnit format.

Class Method Summary

BaseFormatter - Inherited

.new

Instance Attribute Summary

BaseFormatter - Inherited

#options, #output

Instance Method Summary

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

.new(output, options = {}) ⇒ JUnitFormatter

[ GitHub ] 

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 18



def initialize(output, options = {})
  super

  @document = REXML::Document.new.tap { |document| document << REXML::XMLDecl.new }
  testsuites = REXML::Element.new('testsuites', @document)
  testsuite = REXML::Element.new('testsuite', testsuites)
  @testsuite = testsuite.tap { |element| element.add_attributes('name' => 'rubocop') }

  reset_count
end


  







Instance Method Details



  

    #add_failure_to(testcase, offenses, cop_name)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 83



def add_failure_to(testcase, offenses, cop_name)
  # One failure per offense. Zero failures is a passing test case,
  # for most surefire/nUnit parsers.
  offenses.each do |offense|
    REXML::Element.new('failure', testcase).tap do |failure|
      failure.attributes['type'] = cop_name
      failure.attributes['message'] = offense.message
      failure.add_text(offense.location.to_s)
    end
  end
end


  








  

    #add_testcase_element_to_testsuite_element(file, target_offenses, cop)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 55



def add_testcase_element_to_testsuite_element(file, target_offenses, cop)
  REXML::Element.new('testcase', @testsuite).tap do |testcase|
    testcase.attributes['classname'] = classname_attribute_value(file)
    testcase.attributes['name'] = cop.cop_name

    add_failure_to(testcase, target_offenses, cop.cop_name)
  end
end


  








  

    #classname_attribute_value(file)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 64



def classname_attribute_value(file)
  @classname_attribute_value_cache ||= Hash.new do |hash, key|
    hash[key] = key.delete_suffix('.rb').gsub("#{Dir.pwd}/", '').tr('/', '.')
  end
  @classname_attribute_value_cache[file]
end


  








  

    #file_finished(file, offenses)  
  

  [ GitHub ]


  

  


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



def file_finished(file, offenses)
  @inspected_file_count += 1

  # TODO: Returns all cops with the same behavior as
  # the original rubocop-junit-formatter.
  # https://github.com/mikian/rubocop-junit-formatter/blob/v0.1.4/lib/rubocop/formatter/junit_formatter.rb#L9
  #
  # In the future, it would be preferable to return only enabled cops.
  Cop::Registry.all.each do |cop|
    target_offenses = offenses_for_cop(offenses, cop)
    @offense_count += target_offenses.count

    next unless relevant_for_output?(options, target_offenses)

    add_testcase_element_to_testsuite_element(file, target_offenses, cop)
  end
end


  








  

    #finished(_inspected_files)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 71



def finished(_inspected_files)
  @testsuite.add_attributes('tests' => @inspected_file_count, 'failures' => @offense_count)
  @document.write(output, 2)
end


  








  

    #offenses_for_cop(all_offenses, cop)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 51



def offenses_for_cop(all_offenses, cop)
  all_offenses.select { |offense| offense.cop_name == cop.cop_name }
end


  








  

    #relevant_for_output?(options, target_offenses)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 47



def relevant_for_output?(options, target_offenses)
  !options[:display_only_failed] || target_offenses.any?
end


  








  

    #reset_count   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/formatter/junit_formatter.rb', line 78



def reset_count
  @inspected_file_count = 0
  @offense_count = 0
end