# logfile.title("mein title") # logfile.section # logfil.content("mein resultat") # logfile.markup(regexstart, regex end, :yellow) require 'rexml/document' module XhtmlReportGenerator # This is the main generator class. It can be instanced with custom javascript, css, and ruby files to allow # generation of arbitrary reports. class Generator attr_accessor :document # @param opts [Hash] See the example for an explanation of the valid symbols # @example Valid symbols for the opts Hash # :jquery if specified, path to a version of jquery, that will be inlined into the html header section # :toc if specified, path to a javascript.js.rb file that contains the magic to generate all # :css if specified, path to a css file that contains the markup rules for your generated reports # :custom_rb if specified, path to a custom Module containing def initialize(opts = {}) # define the default values path = File.expand_path("../xhtml_report_generator", __FILE__) symbols = { :jquery => File.expand_path("jquery.js",path), :toc => File.expand_path("toc.js",path), :css => File.expand_path("style_template.css",path), :custom_rb => File.expand_path("custom.rb",path) } # either use the default files provided with the gem, or those provided by the caller symbols = symbols.merge(opts) for key in symbols.keys do # read the contents into the symbols hash symbols[key] = File.read(symbols[key]) end # load the custom module and extend it, use instance_eval otherwise the module will affect # all existing Generator classes instance_eval symbols[:custom_rb] @document = Generator.createXhtmlDoc("Title") head = @document.elements["//head"] # insert the custom css, and javascript files style = head.add_element("style", {"type" => "text/css"}) # remove all newlines style.add_text(REXML::CData.new("\n"+symbols[:css].gsub(/\n/, "")+"\n")) script = head.add_element("script", {"type" => "text/javascript"}) script.add_text(REXML::CData.new("\n"+symbols[:jquery]+"\n")) script = head.add_element("script", {"type" => "text/javascript"}) script.add_text(REXML::CData.new("\n"+symbols[:toc]+"\n")) end # Creates a minimal valid xhtml document including header title and body elements # @param title [String] Title in the header section def self.createXhtmlDoc(title) header = '' header += '' doc = REXML::Document.new(header) html = doc.add_element("html", {"xmlns" => "http://www.w3.org/1999/xhtml"}) # create header head = html.add_element("head") t = head.add_element("title") t.text = title html.add_element("body") return doc end # returns the string representation of the xml document # @param indent [Number] indent for child elements. defaults to 0. def to_s(indent = 0) output = "" # note transitive is needed to preserve newlines in 
 tags
      # note2:  the hash options syntax is supported only from ruby version >= 2.0.0 we need the old style
      #         for compatibility with 1.9.3
      #@document.write({:output=>output, :indent=>indent, :transitive=>true})
      @document.write(output, indent, true)
      return output
    end
    
    # saves the xml document as a file
    # @param file [String] absolute or relative path to the file to which will be written.
    # @param mode [String] defaults to 'w', one of the file open modes that allows writing ['r+','w','w+','a','a+']
    def writeToFile(file, mode='w')
      File.open(file, "#{mode}:UTF-8") {|f| f.write(self.to_s)}
    end
  end
end