Class: MetricFu::Report

Inherits:
Object
  • Object
show all
Defined in:
lib/base/report.rb

Overview

Report

The Report class is responsible two things:

It adds information to the yaml report, produced by the system as a whole, for each of the generators used in this test run.

It also handles passing the information from each generator used in this test run out to the template class set in MetricFu::Configuration.

Instance Method Summary collapse

Instance Method Details

#add(report_type) ⇒ Object

Adds a hash from a passed report, produced by one of the Generator classes to the aggregate report_hash managed by this hash.

Parameters:

  • report_type

    Hash The hash to add to the aggregate report_hash


52
53
54
55
# File 'lib/base/report.rb', line 52

def add(report_type)
  clazz = MetricFu.const_get(report_type.to_s.capitalize)
  report_hash.merge!(clazz.generate_report)
end

#open_in_browser?Boolean

Checks to discover whether we should try and open the results of the report in the browser on this system. We only try and open in the browser if we're on OS X and we're not running in a CruiseControl.rb environment. See MetricFu.configuration for more details about how we make those guesses.

Returns:

  • (Boolean)

    Boolean Should we open in the browser or not?


85
86
87
88
# File 'lib/base/report.rb', line 85

def open_in_browser?
  MetricFu.configuration.platform.include?('darwin') &&
  ! MetricFu.configuration.is_cruise_control_rb?
end

#report_hashObject

:nodoc:


32
33
34
# File 'lib/base/report.rb', line 32

def report_hash #:nodoc:
  @report_hash ||= {}
end

#save_output(content, dir, file = 'index.html') ⇒ Object

Saves the passed in content to the passed in directory. If a filename is passed in it will be used as the name of the file, otherwise it will default to 'index.html'

Parameters:

  • content

    String A string containing the content (usually html) to be written to the file.

  • dir

    String A dir containing the path to the directory to write the file in.

  • file (defaults to: 'index.html')

    String A filename to save the path as. Defaults to 'index.html'.


71
72
73
74
75
# File 'lib/base/report.rb', line 71

def save_output(content, dir, file='index.html')
  open("#{dir}/#{file}", "w") do |f|
    f.puts content
  end
end

#save_templatized_reportObject

Instantiates a new template class based on the configuration set in MetricFu::Configuration, or through the MetricFu.config block in your rake file (defaults to the included AwesomeTemplate), assigns the report_hash to the report_hash in the template, and tells the template to to write itself out.


41
42
43
44
45
# File 'lib/base/report.rb', line 41

def save_templatized_report
  @template = MetricFu.template_class.new
  @template.report = report_hash
  @template.write
end

#show_in_browser(dir) ⇒ Object

Shows 'index.html' from the passed directory in the browser if we're able to open the browser on this platform.

Parameters:

  • dir

    String The directory path where the 'index.html' we want to open is

    stored


96
97
98
# File 'lib/base/report.rb', line 96

def show_in_browser(dir)
  system("open #{dir}/index.html") if open_in_browser?
end

#to_yamlObject

Renders the result of the report_hash into a yaml serialization ready for writing out to a file.

Returns:

  • YAML A YAML object containing the results of the report generation process


27
28
29
# File 'lib/base/report.rb', line 27

def to_yaml
  report_hash.to_yaml
end