Module: RR::ScanReportPrinters

Defined in:
lib/rubyrep/scan_report_printers/scan_report_printers.rb,
lib/rubyrep/scan_report_printers/scan_detail_reporter.rb,
lib/rubyrep/scan_report_printers/scan_summary_reporter.rb

Overview

Manages scan report printers. Scan report printers implement functionality to report the row differences identified during a scan. All table scans are processed by the same printer instance.

Scan report printers need to register themselves and their command line options with #register.

A scan report printer needs to implement at the minimum the following functionality:

# Creation of a new ScanReportPrinter.
# * +session+: the current Session object
# * +arg+: command line argument as yielded by OptionParser#on.
def initialize(arg)

# A scan of the given 'left' table and corresponding 'right' table is executed.
# Needs to yield so that the actual scan can be executed.
def scan(left_table, right_table)

# Each difference is handed to the printer as described in the format
# as described e. g. in DirectTableScan#run
def report_difference(type, row)

# Optional method. If a scan report printer has it, it is called after the
# last table scan is executed.
# (A good place to print a final summary.)
def scanning_finished

Defined Under Namespace

Classes: ScanDetailReporter, ScanSummaryReporter

Class Method Summary collapse

Class Method Details

.on_printer_selection(opts) ⇒ Object

Registers all report printer command line options into the given OptionParser. Once the command line is parsed with OptionParser#parse! it will yield the printer class and the optional command line parameter.

Note: If multiple printers are specified in the command line, all are created and yielded.



59
60
61
62
63
64
65
 
# File 'lib/rubyrep/scan_report_printers/scan_report_printers.rb', line 59

def self.on_printer_selection(opts)
  printers.each do |printer|
    opts.on(*printer[:opts]) do |arg|
      yield printer[:printer_class], arg
    end
  end
end

.printers ⇒ Object

Array of registered ScanReportPrinters. Each entry is a hash with the following keys and related values:

  • :printer_class: The ScanReportPrinter class.

  • :opts: An array defining the command line options (handed to OptionParter#on).



36
37
38
 
# File 'lib/rubyrep/scan_report_printers/scan_report_printers.rb', line 36

def self.printers
  @@report_printers ||= []
end

.register(printer_class, *opts) ⇒ Object

Needs to be called by ScanReportPrinters to register themselves (printer) and their command line options.

  • :printer_class is the ScanReportPrinter class,

  • :opts is an array defining the command line options (handed to OptionParter#on).



44
45
46
47
48
49
 
# File 'lib/rubyrep/scan_report_printers/scan_report_printers.rb', line 44

def self.register(printer_class, *opts)
  printers << {
    :printer_class => printer_class,
    :opts => opts
  }
end