Class: XhtmlReportGenerator::Generator

Inherits:

Object

• Object
• XhtmlReportGenerator::Generator

Defined in:

lib/xhtml_report_generator.rb

Overview

This is the main generator class. It can be instanced with custom javascript, css, and ruby files to allow generation of arbitrary reports.

Instance Attribute Summary

• #document ⇒ REXML::Document

  This is the html document / actual report.

• #file ⇒ String

  path to the file where this report is saved to.

• #sync ⇒ Boolean

  if true, the report will be written to disk after every modificaiton.

Class Method Summary

• .create_xhtml_document(title) ⇒ Object

  Creates a minimal valid xhtml document including header title and body elements.

Instance Method Summary

• #cdata(str, parent_element) ⇒ REXML::Element

  Surrounds CData tag with c-style comments to remain compatible with normal html.

• #code(attrs = {}, &block) ⇒ REXML::Element

  Appends a

   node after the @current node.
  

• #content(attrs = {}, &block) ⇒ REXML::Element

  Appends a

  node after the @current node.

• #create_layout(title, layout = 3) ⇒ Object

  creates the basic page layout and sets the current Element to the main content area (middle div).

• #custom_table(table_data, opts = {}) ⇒ REXML::Element

  creates a html table from two dimensional array of the form Array [row] [col].

• #document_changed ⇒ Object

  This method should be called after every change to the document.

• #element_to_string(elem) ⇒ String
• #encoding_fixer(str) ⇒ String

  Check if the give string is a valid UTF-8 byte sequence.

• #get_code_html(attrs = {}, &block) ⇒ String

  Instead of adding content to the report, this method returns the produced html code as a string.

• #get_content_html(attrs = {}, &block) ⇒ String

  Instead of adding content to the report, this method returns the produced html code as a string.

• #get_current ⇒ REXML::Element

  returns the current xml element.

• #get_element_text(el = @current, recursive = true) ⇒ String

  returns the plain text without any xml tags of the specified element and all its children.

• #get_image_html(path, attributes = {}) ⇒ String

  Instead of adding content to the report, this method returns the produced html code as a string.

• #get_link_html(href, attrs = {}, &block) ⇒ String

  Instead of adding content to the report, this method returns the produced html code as a string.

• #get_title ⇒ String

  returns the title text of the report.

• #heading(tag_type = "h1", attrs = {}, &block) ⇒ REXML::Element

  Appends a new heading element to body, and sets current to this new heading.

• #heading_top(tag_type = "h1", attrs = {}, &block) ⇒ REXML::Element

  Inserts a new heading element at the very beginning of the middle div section, and points @current to this heading.

• #highlight(regex, color = "y", el = @current) ⇒ Fixnum

  Scans all REXML::Text children of an REXML::Element for any occurrences of regex.

• #highlight_captures(regex, color = "y", el = @current) ⇒ Fixnum

  Scans all REXML::Text children of an REXML::Element for any occurrences of regex.

• #html(text) ⇒ REXML::Element

  insert arbitrary xml code after the @current element in the content pane (div middle).

• #image(path, attributes = {}) ⇒ Object
• #initialize(opts = {}) ⇒ Generator constructor

  A new instance of Generator.

• #javascript(attrs = {}, &block) ⇒ REXML::Element

  Appends a

  Returns a new instance of Generator.

  Examples:

  Valid keys for the opts Hash

  :title        Title in the header section, defaults to "Title"
  :js           if specified, array of javascript files which are inlined into the html header section, after
                the default included js files (check in sourcecode below).
  :css          if specified, array of css files which are inlined into the html header section after
                the default included css files (check in sourcecode below).
  :css_print    if specified, array of css files which are inlined into the html header section with media=print
                after the default included print css files (check in sourcecode below).
  

  Parameters:

  • opts (Hash) (defaults to: {}) —

    See the example for an explanation of the valid symbols

  # File 'lib/xhtml_report_generator.rb', line 28
  
  def initialize(opts = {})
    # define the default values
    resources = File.expand_path("../../resource/", __FILE__)
    defaults = {
      :title     => "Title",
      :js        => [
          File.expand_path("js/jquery-3.5.1.min.js", resources),
          File.expand_path("d3v5.16.0/d3.min.js", resources),
          File.expand_path("c3v0.7.18/c3.min.js", resources),
          File.expand_path("js/split.min.js", resources),
          File.expand_path("js/layout_split.js", resources),
          File.expand_path("js/table_of_contents.js", resources),
          File.expand_path("js/toggle_linewrap.js", resources),
        ],
      :css       => [
          File.expand_path("css/style.css", resources),
          File.expand_path("c3v0.7.18/c3.min.css", resources),
        ],
      :css_print => [
          File.expand_path("css/print.css", resources)
        ],
      #:custom_rb => File.expand_path("../custom.rb", __FILE__),
    }
    @sync = false
  
    opts[:title]      = defaults[:title]     if !opts.key?(:title)
  
    if opts.key?(:js)
      opts[:js]         = defaults[:js] + opts[:js]
    else
      opts[:js]         = defaults[:js]
    end
    if opts.key?(:css)
      opts[:css]        = defaults[:css] + opts[:css]
    else
      opts[:css]        = defaults[:css]
    end
    if opts.key?(:css_print)
      opts[:css_print]  = defaults[:css_print] + opts[:css_print]
    else
      opts[:css_print]  = defaults[:css_print]
    end
  
    @document = Generator.create_xhtml_document(opts[:title])
    head = @document.elements["//head"]
  
    head.add_element("meta", {"charset" => "utf-8"})
  
    # insert css
    opts[:css].each do |css_path|
      style = head.add_element("style", {"type" => "text/css"})
      cdata(File.read(css_path), style)
    end
  
    # insert css for printing
    opts[:css_print].each do |css_path|
      style = head.add_element("style", {"type" => "text/css", "media"=>"print"})
      cdata(File.read(css_path), style)
    end
  
    # inster js files
    opts[:js].each do |js_path|
      script = head.add_element("script", {"type" => "text/javascript"})
      cdata(File.read(js_path), script)
    end
    document_changed()
  end