xhtml_report_generator 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3bb7dd2a10d07719f2cac295e6710218fab5f2d
-  data.tar.gz: 0acaa09996b500ec388e63fd06dc9e9a5b1c7c74
+  metadata.gz: 3aa1ee1460f949608080993ab68e93eab9298561
+  data.tar.gz: 3ac67dd1dcde669790405a065295abdcc223d36d
 SHA512:
-  metadata.gz: bdfcc8d627bec2b696efaac8ca4449a39a0c234d9a7ee44d16b02ca46267b05d15dffc653ef7d46ccdd97762d631a67eb0a3919db45bee83d4f5610a4ae038b5
-  data.tar.gz: e7c5cbcd6902fd9640eafc63fb41f7f216bd6f3ae3684039428cb9e96985b1f92f79dae02f659dff4ddb558774b8a465cec3983f759319c9c3277d731fb4cc68
+  metadata.gz: d5499730f068d0597fe8ae3f7fba1e1af58257a7b2ae52c11993e1f3ca0062fc095d8f0e6c48919ccb1141602ed3a6d7b5019d2059747f04c14466c2ee0e1553
+  data.tar.gz: f92130285b5d241af4c17a10068c2c18a155a29cfca58ca6024c20da4b0e1c8dc1f80ba87e3d8dba21dacddb077310080b835ad6922e547a5f73e28544190092

data/README.md

@@ -1,15 +1,20 @@
-xhtml-report-generator
+xhtml_report_generator
 ======================
 
-This project was written to provide an easy way to create valid xhtml documents.
+This project was written to provide an easy way to create valid xhtml or html documents.
 Usecases are the automatic creation of reports (e.g. program logs) with automatically created table of contents.
-xhtml-report-generator is not a Logger replacement, since the complete document is always kept in memory and
-only written to disk on demand. Hence in case of crashes the data might be lost.
+xhtml_report_generator is not a Logger replacement, since the complete document is always kept in memory and
+only written to disk on demand. Hence in case of crashes the data might be lost if you didn't write before.
+
+Ruby version
+-----
+This gem was mainly tested with ruby version 2.2.3. Except of the test_encoding_issues unit tests, all other tests are 
+also passing with 1.9.3. Probably there were issues in ruby itself for earlier versions.
 
 
 Example usage
 -------------
-In the following you can find a quick start on how to use xhtml-report-generator.
+In the following you can find a quick start on how to use xhtml_report_generator.
 Basically the project is built in a way that lets you supply your own methods for everything.
 By default "custom.rb" is loaded through instance eval, so you can check the corresponding documentation for available methods.
 
@@ -21,9 +26,11 @@ Basically starting from version 2 the syntax for each method of custom.rb is uni
 def method({"attribute" => "value", "attribute2" => "value2"}) {contents}
 
 in addition the method naming convention was changed from camelCase to underscore to comply more with ruby conventions.
+
+See <a href=http://www.rubydoc.info/gems/xhtml_report_generator/Custom>http://www.rubydoc.info/gems/xhtml_report_generator/Custom</> for the documentation of available methods.
  
 <pre>
-require 'xhtml-report-generator'
+require 'xhtml_report_generator'
 
 gen1 = XhtmlReportGenerator::Generator.new
 gen1.create_layout("Title")
@@ -33,9 +40,62 @@ gen1.heading("h3") {"section"}
 gen1.content({"class"=>"bold"}) {"content function: Hallo welt &lt;br /> html test &lt;span class=\"r\" >red span test&lt;/span>"}
 gen1.html("&lt;p class=\"italic\">html function: Hallo welt &lt;br /> html test &lt;span class=\"r\" >red span test&lt;/span>&lt;/p>")
 gen1.highlight(/Ha.*lt/)
+gen1.link("https://rubygems.org/gems/xhtml_report_generator/") {"download the gem"}
+# browser will parse this as html (based on file extension)
+gen1.write("myreport.html")
+# browser will parse this as xhtml (based on file extension)
+gen1.write("myreport.xhtml")
+</pre>
+
+Adding some graphs to your reports
+----------------------------------
+Due to the xml nature it is also easy to insert SVG graphs / pictures. Check out the svg-graph gem
+
+<pre>
+require 'xhtml_report_generator'
+require 'SVG/Graph/Line'
+require 'REXML/document'
+
+gen1 = XhtmlReportGenerator::Generator.new
+gen1.create_layout("Graph example")
+gen1.heading("h1") {"my graph"}
+
+x_axis = %w(Jan Feb Mar);
+data_sales_02 = [12, 45, 21]
+data_sales_03 = [15, 30, 40]
+
+graph = SVG::Graph::Line.new({
+       :height => 300,
+      :width => 500,
+  :show_graph_title      => true,
+  :graph_title          => 'Graph Title',
+  :show_x_title  => true,
+  :x_title => 'Month',
+  :show_y_title  => true,
+  #:y_title_text_direction => :bt,
+  :y_title => 'cash',
+  :fields => x_axis})
+
+graph.add_data({:data => data_sales_02, :title => 'Sales2002'})
+graph.add_data({:data => data_sales_03, :title => 'Sales2003'})
+
+# we can't add the entire xml document since multiple xml declarations are invalid
+# so we add only 
+doc = REXML::Document.new(graph.burn())
+svg = doc.elements["//svg"]
+out = ''
+f = REXML::Formatters::Pretty.new(0)
+f.compact = true
+f.write(svg, out)
+
+gen1.html(out)
+gen1.write("graph.xhtml")
 
 </pre>
 
+
+
+
 Changes from version 1.x to 2.x
 -------------------------------
 To ease with migration here is a list with the changed function names, please also check the new synopsis

data/lib/xhtml_report_generator.rb

@@ -1,8 +1,6 @@
-#    logfile.title("mein title")
-#    logfile.section
-#    logfil.content("mein resultat")
-#    logfile.markup(regexstart, regex end,  :yellow)
+# encoding: utf-8
 require 'rexml/document'
+require 'rexml/formatters/transitive'
 
 module XhtmlReportGenerator
   
@@ -29,36 +27,73 @@ module XhtmlReportGenerator
       }
       # either use the default files provided with the gem, or those provided by the caller
       symbols = symbols.merge(opts)
+      custom_rb_path = symbols[:custom_rb]
       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]
+      instance_eval(symbols[:custom_rb], custom_rb_path)
 
       @document = Generator.create_xhtml_document("Title")
       head = @document.elements["//head"]
+      
+      head.add_element("meta", {"charset" => "utf-8"})
+      
       # 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"))
+      cdata(symbols[:css], style)
         
       style = head.add_element("style", {"type" => "text/css", "media"=>"print"})
-      style.add_text(REXML::CData.new("\n"+symbols[:css_print].gsub(/\n/, "")+"\n"))
+      cdata(symbols[:css_print], style)
 
       script = head.add_element("script", {"type" => "text/javascript"})
-      script.add_text(REXML::CData.new("\n"+symbols[:jquery]+"\n"))
+      cdata(symbols[:jquery], script)
 
       script = head.add_element("script", {"type" => "text/javascript"})
-      script.add_text(REXML::CData.new("\n"+symbols[:toc]+"\n"))
+      cdata(symbols[:toc], script)
+    end
+	
+    # Surrounds CData tag with c-style comments to remain compatible with normal html. 
+    # For plain xhtml documents this is not needed.
+    # Example /*<![CDATA[*/\n ...content ... \n/*]]>*/
+    # @param str [String] the string to be enclosed in cdata
+    # @param parent_element [REXML::Element] the element to which cdata should be added
+    # @return [String] CDATA enclosed in c-style comments /**/
+    def cdata(str, parent_element)
+      f = REXML::Formatters::Transitive.new(0) # use Transitive to preserve source formatting
+      # somehow there is a problem with CDATA, any text added after will automatically go into the CDATA
+      # so we have do add a dummy node after the CDATA and then add the text.
+      parent_element.add_text("/*")
+      parent_element.add(REXML::CData.new("*/\n"+str+"\n/*"))
+      parent_element.add(REXML::Comment.new("dummy comment to make c-style comments for cdata work"))
+      parent_element.add_text("*/")
+    end
+    
+    # Check if the give string is a valid UTF-8 byte sequence. If it is not valid UTF-8, then 
+    # all invalid bytes are replaced by "\u2e2e" (\xe2\xb8\xae) ('REVERSED QUESTION MARK') because the default
+    # replacement character "\uFFFD" ('QUESTION MARK IN DIAMOND BOX') is two slots wide and might 
+    # destroy mono spaced formatting
+    # @param str [String] of any encoding
+    # @return [String] UTF-8 encoded valid string
+    def encoding_fixer(str)
+      #if !str.force_encoding('UTF-8').valid_encoding?
+      #  str.encode!('UTF-8', 'ISO-8859-1', {:invalid => :replace, :undef => :replace, :xml => :text})
+      #end
+      tmp = str.force_encoding('UTF-8').encode('UTF-8',{:invalid => :replace, :undef => :replace, :replace => "\u2e2e"})
+      # replace all special control chars as well but keep newline and whitespace "\u2e2e"
+      tmp.force_encoding('binary').gsub!(/[\x00-\x07\x0C-\x1F]|\xef\xbf\xbe|\xef\xbf\xbf/n, "\xe2\xb8\xae".force_encoding('binary'))
+      return tmp.force_encoding('UTF-8')
     end
 
     # Creates a minimal valid xhtml document including header title and body elements
     # @param title [String] Title in the header section
     def self.create_xhtml_document(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">'
+      # don't use version 1.1 - firefox has not yet a parser vor xml 1.1
+      # https://bugzilla.mozilla.org/show_bug.cgi?id=233154
+      header = '<?xml version="1.0" encoding="UTF-8"?>'
+      header << '<!DOCTYPE html>'
 
       doc = REXML::Document.new(header)
       html = doc.add_element("html", {"xmlns" => "http://www.w3.org/1999/xhtml"})
@@ -71,14 +106,18 @@ module XhtmlReportGenerator
     end
 
     # returns the string representation of the xml document
-    # @param indent [Number] indent for child elements. defaults to 0.
+    # @param indent [Number] indent for child elements. defaults to 0. 
+    #                        Note: if you change the indet this might destroy formatting of <pre> sections
+    # @return [String] formatted xml document
     def to_s(indent = 0)
       output = ""
       # note :  transitive is needed to preserve newlines in <pre> 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)
+      # @document.write({:output=>output, :indent=>indent, :transitive=>true})
+      # change to Formatters since document.write is deprecated
+      f = REXML::Formatters::Transitive.new(indent) 
+      f.write(@document, output)
       return output
     end
     

data/lib/xhtml_report_generator/custom.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'base64'
 # 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.
@@ -28,7 +29,7 @@ module Custom
       div.add_text("Quick Links")
       div.add_element("br");div.add_element("br")
       end
-      
+
       @div_middle = @body.add_element("div", {"class" => "middle"})
       @layout = true
     end
@@ -85,7 +86,7 @@ module Custom
     @div_middle.insert_after(@current, temp)
     @current = temp
     raise "Block argument is mandatory" unless block_given?
-    text = block.call()
+    text = encoding_fixer(block.call())
     @current.add_text(text)
     return @current
   end
@@ -100,7 +101,7 @@ module Custom
     @div_middle.insert_after(@current, temp)
     @current = temp
     raise "Block argument is mandatory" unless block_given?
-    text = block.call()
+    text = encoding_fixer(block.call())
     @current.add_text(text)
     return @current
   end
@@ -109,7 +110,8 @@ module Custom
   # @param text [String] valid xhtml code which is included into the document
   # @return [REXML::Element] the Element which was just added 
   def html(text)
-    # we need to create a new document with a pseudo root
+    # we need to create a new document with a pseudo root becaus having multiple nodes at top 
+    # level is not valid xml
     doc = REXML::Document.new("<root>"+text+"</root>")
     # 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
@@ -119,6 +121,23 @@ module Custom
     return @current
   end
   
+  # Appends  a <a href = > node after the @current nodes
+  # @param href [String] this is the
+  # @param attrs [Hash] attributes for the <a> element
+  # @yieldreturn [String] the text to be added to the <a> element
+  # @return [REXML::Element] the Element which was just added
+  def link(href, attrs={}, &block) 
+    temp = REXML::Element.new("a")
+    attrs.merge!({"href" => href})
+    temp.add_attributes(attrs)
+    @div_middle.insert_after(@current, temp)
+    @current = temp
+    raise "Block argument is mandatory" unless block_given?
+    text = encoding_fixer(block.call())
+    @current.add_text(text)
+    return @current
+  end
+  
   # @param path [String] absolute or relative path to the image that should be inserted into the report
   # @param attrs [Hash] attributes for the <img> element, any valid html attributes can be specified
   #   you may specify attributes such "alt", "height", "width"
@@ -270,7 +289,7 @@ module Custom
     @div_middle.insert_after(@current, temp)
     @current = temp
     raise "Block argument is mandatory" unless block_given?
-    text = block.call()
+    text = encoding_fixer(block.call())
     @current.text = text
     return @current
   end
@@ -297,7 +316,7 @@ module Custom
     
     @current = temp
     raise "Block argument is mandatory" unless block_given?
-    text = block.call()
+    text = encoding_fixer(block.call())
     @current.text = text
     return @current
   end

data/lib/xhtml_report_generator/toc.js

@@ -1,5 +1,5 @@
-$(document).ready(function(){$("td").each(function(b){b=$(this);null!==b.html().match(/^passed$/)?b.attr("style","background-color:#19D119;"):null!==b.html().match(/^failed$/)?b.attr("style","background-color:#FF4719;"):null!==b.html().match(/^check$/)&&b.attr("style","background-color:#FFFF00;")});$("[class=rtoconly],[class=bothtoc]").each(function(b){var a=$(this),c=a.attr("class");a.attr("id",c+b);$("#rtoc").append("<a href='#"+c+b+"'>"+a.html()+"</a> <br />\n")});h3index=h2index=h1index=0;$("h1, h2, h3, a.h2, a.h1").each(function(b){var a=
-$(this);void 0==a.attr("id")&&a.attr("id","title"+b);if("h1"==a.prop("tagName"))h1index+=1,h3index=h2index=0,a.prepend(h1index+" "),$("#ltoc").append("<br />\n"),lasth1="#"+a.attr("id"),lasth1cont=a.html();else if("h2"==a.prop("tagName"))h2index+=1,h3index=0,a.prepend(h1index+"."+h2index+" "),lasth2="#"+a.attr("id"),lasth2cont=a.html();else if("h3"==a.prop("tagName"))h3index+=1,a.prepend(h1index+"."+h2index+"."+h3index+" ");else{if("h1"==a.attr("class"))return a.attr("href",lasth1),a.html(lasth1cont),
-0;if("h2"==a.attr("class"))return a.attr("href",lasth2),a.html(lasth2cont),0}if("rtoconly"==a.attr("class"))return 0;$("#ltoc").append("<div id='div_fold_"+h1index+"_"+h2index+"_"+h3index+"'><a id='a_fold_"+h1index+"_"+h2index+"_"+h3index+"' style='cursor:pointer'>&#160;-&#160;</a> <a id='link"+b+"' href='#"+a.attr("id")+"' >"+a.html()+"</a> <br /> </div>\n");return 0});$('a[id^="a_fold"]').click(function(){var b=$(this),a=b.attr("id").match(/(\d+)_(\d+)_(\d+)/);if(b.html().match(/-/))var c="&#160;+&#160;",
-e=!1;else c="&#160;-&#160;",e=!0;b.html(c);if("0"==a[2]){var d=new RegExp("div_fold_"+a[1]+"_[1-9]\\d*_0");$("div").filter(function(){return this.id.match(d)}).each(function(){$(this).children('a[id^="a_fold"]').html(c);$(this).toggle(e)});d=new RegExp("div_fold_"+a[1]+"_\\d+_[1-9]\\d*");$("div").filter(function(){return this.id.match(d)}).each(function(){$(this).children('a[id^="a_fold"]').html(c);$(this).toggle(e)})}else"0"==a[3]&&(d=new RegExp("div_fold_"+a[1]+"_"+a[2]+"_[1-9]\\d*"),$("div").filter(function(){return this.id.match(d)}).each(function(){$(this).children('a[id^="a_fold"]').html(c);
-$(this).toggle(e)}))})});
+$(document).ready(function(){$("td").each(function(b){b=$(this);null!==b.html().match(/^passed$/i)?b.attr("style","background-color:#19D119;"):null!==b.html().match(/^failed$/i)?b.attr("style","background-color:#FF4719;"):null!==b.html().match(/^check$/i)&&b.attr("style","background-color:#FFFF00;")});$("[class=rtoconly],[class=bothtoc]").each(function(b){var a=$(this),c=a.attr("class");a.attr("id",c+b);$("#rtoc").append("<a href='#"+c+b+"'>"+a.html()+"</a> <br />\n")});h3index=h2index=h1index=0;
+$("h1, h2, h3, a.h2, a.h1").each(function(b){var a=$(this);void 0==a.attr("id")&&a.attr("id","title"+b);if("H1"==a.prop("tagName").toUpperCase())h1index+=1,h3index=h2index=0,a.prepend(h1index+" "),$("#ltoc").append("<br />\n"),lasth1="#"+a.attr("id"),lasth1cont=a.html();else if("H2"==a.prop("tagName").toUpperCase())h2index+=1,h3index=0,a.prepend(h1index+"."+h2index+" "),lasth2="#"+a.attr("id"),lasth2cont=a.html();else if("H3"==a.prop("tagName").toUpperCase())h3index+=1,a.prepend(h1index+"."+h2index+
+"."+h3index+" ");else{if("H1"==a.attr("class").toUpperCase())return a.attr("href",lasth1),a.html(lasth1cont),0;if("H2"==a.attr("class").toUpperCase())return a.attr("href",lasth2),a.html(lasth2cont),0}if("undefined"!=typeof a.attr("class")&&"RTOCONLY"==a.attr("class").toUpperCase())return 0;$("#ltoc").append("<div id='div_fold_"+h1index+"_"+h2index+"_"+h3index+"'><a id='a_fold_"+h1index+"_"+h2index+"_"+h3index+"' style='cursor:pointer'>&#160;-&#160;</a> <a id='link"+b+"' href='#"+a.attr("id")+"' >"+
+a.html()+"</a> <br /> </div>\n");return 0});$('a[id^="a_fold"]').click(function(){var b=$(this),a=b.attr("id").match(/(\d+)_(\d+)_(\d+)/);if(b.html().match(/-/))var c="&#160;+&#160;",e=!1;else c="&#160;-&#160;",e=!0;b.html(c);if("0"==a[2]){var d=new RegExp("div_fold_"+a[1]+"_[1-9]\\d*_0");$("div").filter(function(){return this.id.match(d)}).each(function(){$(this).children('a[id^="a_fold"]').html(c);$(this).toggle(e)});d=new RegExp("div_fold_"+a[1]+"_\\d+_[1-9]\\d*");$("div").filter(function(){return this.id.match(d)}).each(function(){$(this).children('a[id^="a_fold"]').html(c);
+$(this).toggle(e)})}else"0"==a[3]&&(d=new RegExp("div_fold_"+a[1]+"_"+a[2]+"_[1-9]\\d*"),$("div").filter(function(){return this.id.match(d)}).each(function(){$(this).children('a[id^="a_fold"]').html(c);$(this).toggle(e)}))})});

data/lib/xhtml_report_generator/version.rb

@@ -1,5 +1,5 @@
 module XhtmlReportGenerator
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end
 
 # puts XhtmlReportGenerator::VERSION

metadata

@@ -1,25 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: xhtml_report_generator
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Manuel Widmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies: []
-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
+description: "The generator can be used to create html or xhtml files. It comes with
+  many utility functions.\n== Example usage\n  gen1 = XhtmlReportGenerator::Generator.new\n
   \ gen1.create_layout(\"Title\")\n  gen1.heading(\"h1\", {\"class\" => \"bothtoc\"})
   {\"titel\"}\n  gen1.heading(\"h2\") {\"subtitel\"}\n  gen1.heading(\"h3\") {\"section\"}\n
-  \ gen1.content({\"class\"=>\"bold\"}) {\"content function: Hallo welt <br />
-  html test <span class=\"r\" >red span test</span>\"}\n  gen1.html(\"<p
-  class=\"italic\">html function: Hallo welt <br /> html test <span class=\"r\"
-  >red span test</span></p>\")\n  gen1.highlight(/Ha.*lt/)\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"
+  \ gen1.content({\"class\"=>\"bold\"}) {\"content function: Hallo welt <br /> html
+  test <span class=\"r\" >red span test</span>\"}\n  gen1.html(\"<p class=\"italic\">html
+  function: Hallo welt <br /> html test <span class=\"r\" >red span test<span></p>\")\n
+  \ gen1.highlight(/Ha.*lt/)\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. By default there are methods to insert tables, links, paragraphs,
+  preformatted text\nand arbitrary xhtml code. Due to the xml nature it is also easy
+  to insert SVG graphs / pictures.\n\n"
 email: m-widmer@gmx.ch
 executables: []
 extensions: []
@@ -57,5 +59,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: A simple and quick xhtml report generator
+summary: A simple html or xhtml generator to create human readable support
 test_files: []