xhtml_report_generator 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc379b301d2c38242fdb6708b0189896382ac92f
-  data.tar.gz: 9ebe5ee16571a086d9f6b39b94a56ee2cbe21d09
+  metadata.gz: a56e14ff278000689e7206f3460278519a0f71d5
+  data.tar.gz: 4b8f3ab22cc07c789e38649fbab38e59554fa303
 SHA512:
-  metadata.gz: d3bb81610d3c81f03f5c09e99e4b53a716266ce91c75425f5912c59512bf8e5df168ca594297b18f9664b2ea6d9ecad8c7e3dc6326bbaea74ea4b00708f5f411
-  data.tar.gz: 5c2f2f097770f3005b681c64fdb6f92e8cb0eb229efb5c9be154f09325d5f523252b3b509039356b1d31a29dc49481c0441aa5483b313fd3fc8662164ff185f2
+  metadata.gz: 309ea3a329355afce991bda4007b957df24fd48793c3451067b9210510c7bdd4de7a35f8302cac2b3d153b35626c3624c574f7b36d04298c046808b6909933b2
+  data.tar.gz: 9845ac4ffd8ebb70e244d039cb8dc54ee6712e7801b25cec58964971e2c7609548483df22d4b2b022bf0b1040172694b6e756b7355a4c844af82c66bde231295

data/lib/xhtml_report_generator.rb

@@ -5,6 +5,9 @@
 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
@@ -62,13 +65,21 @@ module XhtmlReportGenerator
       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 <pre> tags
-      @document.write(:output=>output,:indent=>indent, :transitive=>true)
+      # 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

data/lib/xhtml_report_generator/custom.rb

@@ -1,7 +1,7 @@
-# The module needs to be called 'Custom'
+# The module name doesn't matter, just make sure at the end to 'extend' it
+# because it will be 'eval'ed  by the initialize method of the XhtmlReportGenerator::Generator class.
 module Custom
-
-  #puts Module.nesting
+  
   # 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']
@@ -18,22 +18,33 @@ module Custom
     @current = @document.elements["//body/div[@class='middle']"]
   end
 
+  # sets the title of the document in the header section as well as in the layout.
+  # createLayout must be called before!
   def setTitle(title)
+    if !@layout 
+      raise "call createLayout first"
+    end
     pagetitle = @document.elements["//head/title"]
     pagetitle.text = title
     div = @document.elements["//body/div[@class='head']"]
     div.text = title
   end
 
+  # returns the title text of the report
   def getTitle()
     pagetitle = @document.elements["//head/title"]
     return pagetitle.text
   end
 
-  # set the current element to the first element matched by the xpath expression.
-  # The current element is the one which was last added
+  # set the current element to the element or first element matched by the xpath expression.
+  # The current element is the one which can be modified through highlighting.
+  # @param xpath [REXML::Element|String] the element or a string
   def setCurrent!(xpath)
-    @current = @document.elements[xpath]
+    if xpath.is_a?(REXML::Element)
+      @current = xpath
+    else
+      @current = @document.elements[xpath]
+    end
   end
 
   # returns the current xml element
@@ -173,7 +184,7 @@ module Custom
   # @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(text, type, toc=:ltoc)
+  def heading(text, type="h1", toc=:ltoc)
     case toc
     when :rtoc
       opts = {"class" => "onlyrtoc"}
@@ -191,6 +202,30 @@ module Custom
     @current.text = text
     return @current
   end
+  
+# Inserts a new heading element at the very beginning of the middle div section, and points @current to this 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 headingTop(text, type="h1", toc=:ltoc)
+  case toc
+  when :rtoc
+    opts = {"class" => "onlyrtoc"}
+  when :btoc
+    opts = {"class" => "bothtoc"}
+  else
+    opts = {}
+  end
+
+  temp = REXML::Element.new(type)
+  temp.add_attributes(opts)
+  # insert before the first child of div middle
+  @div_middle.insert_before("//div[@class='middle']/*[1]", 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

data/lib/xhtml_report_generator/version.rb

@@ -1,5 +1,5 @@
 module XhtmlReportGenerator
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end
 
-puts XhtmlReportGenerator::VERSION
+# puts XhtmlReportGenerator::VERSION

metadata

@@ -1,29 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: xhtml_report_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Manuel Widmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies: []
-description: |
-  Here is an example usage:
-  @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.
+description: "The generator can be used to create xhtml files. It comes with some
+  default utility functions.\n== Here is an example usage\n  gen1 = XhtmlReportGenerator::Generator.new\n
+  \ gen1.createLayout\n  gen1.setTitle(\"Example Report\")\n  gen1.heading(\"titel\",
+  \"h1\", :btoc)\n  gen1.heading(\"subtitel\", \"h2\", :ltoc)\n  gen1.heading(\"section\",
+  \"h3\")\n  gen1.content(\"content function: Hallo welt <br /> html test <span class=\"r\"
+  >red span test</span>\", {\"class\"=>\"bold\"})\n  gen1.html(\"<p class=\"italic\">html
+  function: Hallo welt <br /> html test <span class=\"r\" >red span test</span></p>\")\n\nThe
+  javascript to render the table of contents, the custom generator functions and style
+  sheet all can be\nsupplied by your own, if necessary. \n"
 email: m-widmer@gmx.ch
 executables: []
 extensions: []
@@ -37,7 +32,7 @@ files:
 - lib/xhtml_report_generator/style_template.css
 - lib/xhtml_report_generator/toc.js
 - lib/xhtml_report_generator/version.rb
-homepage: http://rubygems.org/gems/hrg
+homepage: https://rubygems.org/gems/xhtml_report_generator
 licenses:
 - MIT
 metadata: {}
@@ -49,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='