RubyGems - xhtml_report_generator - Versions diffs - 0.0.2 → 1.0.0 - Mend

xhtml_report_generator 0.0.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml +4 -4
data/lib/xhtml_report_generator.rb +4 -3
data/lib/xhtml_report_generator/custom.rb +63 -32
data/lib/xhtml_report_generator/version.rb +1 -1
metadata +12 -10

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38ba586873ac2380d55080740068cfbd34564413
-  data.tar.gz: 794724eeb48ba9c1815fb4087510d1b1d2197e1d
+  metadata.gz: ee7cef2f258529bb6cda36c4dc3f57099eed7cb6
+  data.tar.gz: 236b3246f37cf842901a2841d444094e557ecec7
 SHA512:
-  metadata.gz: 67ab6ba2bf9fc04633b9ae0304ca80ae2731208b5d61892ffebc8ade79548bd9148ae5d5381589b7f29bf7fd6b9e4098863b6927ab9be33b9c41c5399d75e2c5
-  data.tar.gz: a30a760b5de3eaf866b231ca06c3821a95188b8fb0c4fa0fffdd731f43ba91b922a6cf8ebf09eb5e1de122399e8b17fc91c8a3baae6ed1b85962a1340c109ccc
+  metadata.gz: 140ca1648b99672e2e184d3a17e1e6364c90f8c8e446aa71441f424746fea1408a3ac1652d8c1da2fa4ce136f28c2c4078bee0773de581f0b29987ff1e60517f
+  data.tar.gz: e11a1be493f829854522b8d8f9c577fcb3afbdf3883e4717ae4e0d4bfdcf48666b795d3c5f90170d06f68fab60e90ec003889441ad788007192c827972ac3c81

data/lib/xhtml_report_generator.rb CHANGED Viewed

@@ -7,7 +7,8 @@ require 'rexml/document'
 module XhtmlReportGenerator
   class Generator
     attr_accessor :document
-    # @param opts [Hash]
+    # @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
@@ -31,7 +32,7 @@ module XhtmlReportGenerator
       # all existing Generator classes
       instance_eval symbols[:custom_rb]
-      @document = Generator.createXhtml("Title")
+      @document = Generator.createXhtmlDoc("Title")
       head = @document.elements["//head"]
       # insert the custom css, and javascript files
       style = head.add_element("style", {"type" => "text/css"})
@@ -47,7 +48,7 @@ module XhtmlReportGenerator
     # Creates a minimal valid xhtml document including header title and body elements
     # @param title [String] Title in the header section
-    def self.createXhtml(title)
+    def self.createXhtmlDoc(title)
       header = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>'
       header += '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'

data/lib/xhtml_report_generator/custom.rb CHANGED Viewed

@@ -1,12 +1,14 @@
 # The module needs to be called 'Custom'
 module Custom
   #puts Module.nesting
-  # css classes mapped to toc
-  # creates the basic page layout and sets the current Element to
-  # //body/div[@class='middle']
+  # creates the basic page layout and sets the current Element to the main content area (middle div)
+  # @example The middle div is matched by the following xPath
+  #   //body/div[@class='middle']
   def createLayout
     @body = @document.elements["//body"]
+    # only add the layout if it is not already there
     if !@layout
       @body.add_element("div", {"class" => "head"})
       @body.add_element("div", {"class" => "lefttoc", "id" => "ltoc"})
@@ -23,44 +25,55 @@ module Custom
     div = @document.elements["//body/div[@class='head']"]
     div.text = title
   end
+  def getTitle()
+    pagetitle = @document.elements["//head/title"]
+    return pagetitle.text
+  end
-  # set the current element the first element matched by the xpath expression
-  def setPosition!(xpath)
+  # set the current element to the first element matched by the xpath expression.
+  # The current element is the one which was last added
+  def setCurrent!(xpath)
     @current = @document.elements[xpath]
   end
+  # returns the current xml element
+  def getCurrent()
+    return @current
+  end
-  def code(text)
-    pre = REXML::Element.new("pre")
-    parent = @div_middle.insert_after(@current, pre)
-    @current = pre
+  # Appends a <pre> node after the @current node
+  def code(text, attrs={})
+    temp = REXML::Element.new("pre")
+    temp.add_attributes(attrs)
+    @div_middle.insert_after(@current, temp)
+    @current = temp
     @current.add_text(text)
+    return @current
   end
+  # Appends a <p> node after the @current node
   def content(text, attrs={})
-    @current = @div_middle.add_element("p", attrs)
+    temp = REXML::Element.new("p")
+    temp.add_attributes(attrs)
+    @div_middle.insert_after(@current, temp)
+    @current = temp
     @current.add_text(text)
     return @current
   end
-  def html(text, attrs={})
-    @current = @div_middle.add_element("p", attrs)
+  # insert arbitrary xml code after the @current element in the content pane (div middle)
+  def html(text)
     # we need to create a new document with a pseudo root
     doc = REXML::Document.new("<root>"+text+"</root>")
-    # then we move all children of root to the actual <p> </p> element
+    # then we move all children of root to the actual div middle element and insert after current
     for i in doc.root.to_a do
-      @current.add(i)
+      @div_middle.insert_after(@current, i)
+      @current = i
     end
     return @current
   end
-  #TODO
-  def contentAfter(locaiton, text)
-  end
-  #TODO
-  def contentBefore(locaiton, text)
-  end
   # puts a <span> </span> tag around all captures of the regex
   # NOTE: nested captures are not supported and don't make sense in this context!!
@@ -131,16 +144,31 @@ module Custom
     end # for i in arr do
   end
-  # creates a table from csv data
-  def table (table_data)
+  # creates a html table from two dimensional array of the form Array[row][col]
+  def table (table_data, table_attrs={}, tr_attrs={}, th_attrs={}, td_attrs={})
+    @current = @div_middle.add_element("table", table_attrs)
+    for i in 0..table_data.length-1 do
+      row = @current.add_element("tr", tr_attrs)
+      for j in 0..table_data[i].length-1 do
+        if j == 0
+          col = row.add_element("th", th_attrs)
+          col.add_text(table_data[i][j])
+        else
+          col = row.add_element("td", td_attrs)
+          col.add_text(table_data[i][j])
+        end
+      end
+    end
   end
-  # Appends a new heading element to body
-  # @param type [String] specifiy "h1", "h2", "h3" for the heading
+  # Appends a new heading element to body, and sets current to this new heading
   # @param text [String] the heading text
+  # @param type [String] specifiy "h1", "h2", "h3" for the heading
   # @param toc [symbol] one of :ltoc, :rtoc, :btoc  depending on in which toc you want to display the heading
   # @return the added element
-  def heading(type, text, toc=:ltoc)
+  def heading(text, type, toc=:ltoc)
     case toc
     when :rtoc
       opts = {"class" => "onlyrtoc"}
@@ -150,13 +178,16 @@ module Custom
       opts = {}
     end
-    @current = @div_middle.add_element(type, opts)
+    temp = REXML::Element.new(type)
+    temp.add_attributes(opts)
+    @div_middle.insert_after(@current, temp)
+    @current = temp
     @current.text = text
     return @current
   end
-  #
   # @param element [REXML::Element] the element in whose text tags will be added at the specified indices of @index_length_array
   # @param parent [REXML::Element] the parent to which @element should be attached after parsing
   # @param tagname [String] the tag that will be introduced as <tagname> at the indices specified

data/lib/xhtml_report_generator/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module XhtmlReportGenerator
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end
 puts XhtmlReportGenerator::VERSION

metadata CHANGED Viewed

@@ -1,25 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: xhtml_report_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Manuel Widmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   Here is an example usage:
-  gen1 = XhtmlReportGenerator::Generator.new
-  gen1.createLayout
-  gen1.setTitle("Example Report")
-  gen1.heading("h1", "titel", :btoc)
-  gen1.heading("h2", "subtitel", :ltoc)
-  gen1.heading("h3", "section")
-  gen1.content("content function: Hallo welt <br /> html test <span class="r" >red span test</span>",{"class"=>"bold"})
-  gen1.html("html function: Hallo welt <br /> html test <span class="r" >red span test</span>",{"class"=>"italic"})
+  @example Basic Testreport
+    gen1 = XhtmlReportGenerator::Generator.new
+    gen1.createLayout
+    gen1.setTitle("Example Report")
+    gen1.heading("titel", "h1", :btoc)
+    gen1.heading("subtitel", "h2", :ltoc)
+    gen1.heading("section", "h3")
+    gen1.content("content function: Hallo welt <br /> html test <span class="r" >red span test</span>", {"class"=>"bold"})
+    gen1.html("<p class="italic">html function: Hallo welt <br /> html test <span class="r" >red span test</span></p>")
   The javascript to render the table of contents, the custom generator functions and style sheet all can be
   supplied by your own, if needed.
@@ -61,3 +62,4 @@ signing_key:
 specification_version: 4
 summary: A simple and quick xhtml report generator
 test_files: []
+has_rdoc: