xhtml_report_generator 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b6c79e8a4be4c2bd9c2b5a824550c47ccc02b3
-  data.tar.gz: a96047a216f7a553d6de6f9f48fca64c4d7790b6
+  metadata.gz: a3544c56a29c66abcc6c6ba3fb11ddc204b3198a
+  data.tar.gz: aeb8c4b728b729c3d88e428297dc5f13f5871ecf
 SHA512:
-  metadata.gz: 94f0ece8702ec1534ccec2c13670f937c0ed41a389164bcf36e36ac9fc40cafc29777ec5b2fe167798161dc998d1d0a756f0c35e2530706d63fd36a545ae14a6
-  data.tar.gz: ea980d45095e57bcda650ff70bf4a1b87628b441ce48bdba7a63ee46bb885dacf6eac1f67b1c7b78feddb143be870acb3555c9cf973d7f4732c4be8f6f2e0c0e
+  metadata.gz: 102f3476494f50f9d96d5a735fe33ae4714d74a70f422b47c0930c613b891d724b23e5ec59624a9361cc21f3e2982bf626bea5c15d772470fc1421760802aa58
+  data.tar.gz: f926db10047c34ddd95eaeb1a9eb7c0f0378cbfec795bc3999e4d8ce28478f813dd4284c7a4e41e97e8e15eb926aa3998eab84c0c3a15cbd96c6b9d2e12080aa

data/README.md

@@ -48,9 +48,73 @@ By default "custom.rb" is loaded through instance eval, see
 [XhtmlReportGenerator/Generator](http://www.rubydoc.info/gems/xhtml_report_generator/XhtmlReportGenerator/Generator)
 for the documentation of available methods.
 
+Advanced example1: custom tables including pictures or links
+----------------------------------
+[Code] (../master/test/test.rb#L166-L233)
+
+```ruby
+require 'xhtml_report_generator'
+gen1 = XhtmlReportGenerator::Generator.new
+gen1.create_layout("Custom Table")
+gen1.heading("h1") {"custom styling"}
+table_data = [
+  (0..9).collect{|i| i},
+  (10..19).collect{|i| i},
+  (20..29).collect{|i| i},
+  (30..39).collect{|i| i},
+]
+table_opts = {
+  :headers => 3,
+  :data_is_xhtml => false,
+  :special => [
+    { # highlight all numbers from 0-13 green, only 11-13 should be green since the others are part of heading
+      condition: Proc.new { |e| (0 <= e.to_i) && (e.to_i <= 13) },   # a proc
+      attributes: {"style" => "background: #00FF00;"},
+    },
+    { # font-color the area if number contains a 3
+      row_index: 2..3,
+      col_index: 3..7,
+      condition: Proc.new { |e| e.to_s.match(/3/) },   # a proc
+      attributes: {"style" => "color: red;"},
+    },
+    { # red border around row 2-3 col with title 8
+      row_title: /[23]/,
+      col_title: "8",
+      condition: Proc.new { |e| true },   # a proc
+      attributes: {"style" => "border: 2px solid red;"},
+    },
+    { # black border around cell bottom right
+      row_index: 2,
+      col_index: 9,
+      condition: Proc.new { |e| true },   # a proc
+      attributes: {"style" => "border: 2px solid black;"},
+    },
+  ]
+}
+gen1.custom_table(table_data, table_opts)
+gen1.heading("h1") {"Table Layout"}
+table_opts = {
+  :headers => 0,
+  :data_is_xhtml => true,
+}
 
+a = gen1.get_code_html() {"  blub\nblab\n\t\tblib"}
+b = gen1.get_image_html("path/to/test.png", {"width" => "55", "height"=> "20", "alt" => "some_interesting_text"})
+c = gen1.get_content_html() {"   leading-whitespace removed"}
+d = gen1.get_link_html("https://rubygems.org/gems/xhtml_report_generator/") {"download the gem"}
 
-Advanced example: including some graphs to your reports
+table_data = [
+  [a, d],
+  [c, b]
+]
+gen1.custom_table(table_data, table_opts)
+
+gen1.write("path/to/CustomTable.xhtml")
+```
+[Preview](https://cdn.rawgit.com/lumean/xhtml-report-generator/master/test/CustomTableReference.xhtml)
+
+
+Advanced example2: including 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
 
@@ -82,16 +146,8 @@ graph = SVG::Graph::Line.new({
 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 the svg part
-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)
+# add the svg to the report
+gen1.html(graph.burn_svg_only())
 gen1.write("graph.xhtml")
 
 ```
@@ -131,8 +187,6 @@ As a start you can copy the [custom.rb](../master/lib/xhtml_report_generator/cus
 default naming.
 
 
-
-
 Changes from version 2.x to 3.x
 -------------------------------
 The options for the initialize method "XhtmlReportGenerator::Generator.new" changed.

data/lib/xhtml_report_generator/custom.rb

@@ -98,8 +98,33 @@ module Custom
     return out
   end
 
+  # @param elem [REXML::Element]
+  # @return [String]
+  def element_to_string(elem)
+    f = REXML::Formatters::Transitive.new(0) # use Transitive to preserve source formatting (e.g. <pre> tags)
+    out = ""
+    f.write(elem, out)
+    return out
+  end
+  
+  # @see #code
+  # Instead of adding content to the report, this method returns the produced html code as a string.
+  # This can be used to insert code into #custom_table (with the option data_is_xhtml: true)
+  # @return [String] the code including <pre> tags as a string
+  def get_code_html(attrs={}, &block)
+    temp = REXML::Element.new("pre")
+    temp.add_attributes(attrs)
+    raise "Block argument is mandatory" unless block_given?
+    text = encoding_fixer(block.call())
+    temp.add_text(text)
+    element_to_string(temp)
+  end
+  
   # Appends a <pre> node after the @current node
-  # @param attrs [Hash] attributes for the <pre> element
+  # @param attrs [Hash] attributes for the <pre> element. The following classes can be passed as attributes and are predefined with a different
+  #                     background for your convenience !{"class" => "code0"} (light-blue), !{"class" => "code1"} (red-brown), 
+  #                     !{"class" => "code2"} (light-green), !{"class" => "code3"} (light-yellow). You may also specify your own background
+  #                     as follows: !{"style" => "background: #FF00FF;"}.
   # @yieldreturn [String] the text to be added to the <pre> element
   # @return [REXML::Element] the Element which was just added
   def code(attrs={}, &block)
@@ -113,6 +138,19 @@ module Custom
     return @current
   end
 
+  # @see #content
+  # Instead of adding content to the report, this method returns the produced html code as a string.
+  # This can be used to insert code into #custom_table (with the option data_is_xhtml: true)
+  # @return [String] the code including <pre> tags as a string
+  def get_content_html(attrs={}, &block)
+    temp = REXML::Element.new("p")
+    temp.add_attributes(attrs)
+    raise "Block argument is mandatory" unless block_given?
+    text = encoding_fixer(block.call())
+    temp.add_text(text)
+    element_to_string(temp)
+  end
+  
   # Appends a <p> node after the @current node
   # @param attrs [Hash] attributes for the <p> element
   # @yieldreturn [String] the text to be added to the <p> element
@@ -143,6 +181,20 @@ module Custom
     return @current
   end
   
+  # @see #link
+  # Instead of adding content to the report, this method returns the produced html code as a string.
+  # This can be used to insert code into #custom_table (with the option data_is_xhtml: true)
+  # @return [String] the code including <pre> tags as a string
+  def get_link_html(href, attrs={}, &block)
+    temp = REXML::Element.new("a")
+    attrs.merge!({"href" => href})
+    temp.add_attributes(attrs)
+    raise "Block argument is mandatory" unless block_given?
+    text = encoding_fixer(block.call())
+    temp.add_text(text)
+    element_to_string(temp)
+  end
+  
   # Appends  a <a href = > node after the @current nodes
   # @param href [String] this is the
   # @param attrs [Hash] attributes for the <a> element
@@ -160,6 +212,22 @@ module Custom
     return @current
   end
   
+  # @see #image
+  # Instead of adding content to the report, this method returns the produced html code as a string.
+  # This can be used to insert code into #custom_table (with the option data_is_xhtml: true)
+  # @return [String] the code including <pre> tags as a string
+  def get_image_html(path, attributes = {})
+    # read image as binary and do a base64 encoding
+    binary_data = Base64.strict_encode64(IO.binread(path))
+    type = File.extname(path).gsub('.', '')
+    # create the element
+    temp = REXML::Element.new("img")
+    # add the picture
+    temp.add_attribute("src","data:image/#{type};base64,#{binary_data}")
+    temp.add_attributes(attributes)
+    element_to_string(temp)
+  end
+  
   # @param path [String] absolute or relative path to the image that should be inserted into the report
   # @param attributes [Hash] attributes for the <img> element, any valid html attributes can be specified
   #   you may specify attributes such "alt", "height", "width"
@@ -187,7 +255,7 @@ module Custom
   # highlight_captures then 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!!
   # @param regex [Regexp] a regular expression that will be matched
-  # @param color [String] at this point one of "y", "r", "g", "b" (yellow, red, green, blue) is supported
+  # @param color [String] either one of "y", "r", "g", "b" (yellow, red, green, blue) or a valid html color code (e.g. "#80BFFF")
   # @param el [REXML::Element] the Element (scope) which will be searched for pattern matches, by default the last inserted element will be scanned
   # @return [Fixnum] the number of highlighted captures
   def highlight_captures(regex, color="y", el = @current)
@@ -214,7 +282,14 @@ module Custom
           array
         }
         num_matches += positions.length
-        replace_text_with_elements(el, i, "span", {"class" => color}, positions)
+        if ["y","r","g","b"].include?(color)
+          attr = {"class" => color}
+        elsif color.match(/^#[A-Fa-f0-9]{6}$/)
+          attr = {"style" => "background: #{color};"}
+        else
+          raise "invalid color: #{color}"
+        end
+        replace_text_with_elements(el, i, "span", attr, positions)
       else
         # for non-text nodes we recurse into it and finally reattach to our parent to preserve ordering
         num_matches += highlight_captures(regex, color, i)
@@ -231,7 +306,7 @@ module Custom
   # or match newlines explicitly.
   # highlight then puts a <span> </span> tag around all matches of regex
   # @param regex [Regexp] a regular expression that will be matched
-  # @param color [String] at this point one of "y", "r", "g", "b" (yellow, red, green, blue) is supported
+  # @param color [String] either one of "y", "r", "g", "b" (yellow, red, green, blue) or a valid html color code (e.g. "#80BFFF")
   # @param el [REXML::Element] the Element (scope) which will be searched for pattern matches
   # @return [Fixnum] the number of highlighted captures
   def highlight(regex, color="y", el = @current)
@@ -254,7 +329,14 @@ module Custom
             Regexp.last_match.end(0)-Regexp.last_match.begin(0)]
         }
         num_matches += positions.length
-        replace_text_with_elements(el, i, "span", {"class" => color}, positions)
+        if ["y","r","g","b"].include?(color)
+          attr = {"class" => color}
+        elsif color.match(/^#[A-Fa-f0-9]{6}$/)
+          attr = {"style" => "background: #{color};"}
+        else
+          raise "invalid color: #{color}"
+        end
+        replace_text_with_elements(el, i, "span", attr, positions)
       else
         # for non-text nodes we recurse into it and finally reattach to our parent to preserve ordering
         # puts "recurse"
@@ -272,23 +354,119 @@ module Custom
   #   is equivalent to the bitwise AND of the two least significant bits with 1, 2 or 3
   # @return [REXML::Element] the Element which was just added 
   def table(table_data, headers=0, table_attrs={}, tr_attrs={}, th_attrs={}, td_attrs={})
-
+    opts = {
+      headers: headers,
+      data_is_xhtml: false,
+      table_attrs: table_attrs,
+      th_attrs: th_attrs,
+      tr_attrs: tr_attrs,
+      td_attrs: td_attrs,
+    }
+    custom_table(table_data, opts)
+  end
+  
+  # creates a html table from two dimensional array of the form Array [row] [col]
+  # @param table_data [Array<Array>] of the form Array [row] [col] containing all data, the '.to_s' method will be called on each element, 
+  # @option opts [Number] :headers either of 0, 1, 2, 3. Where 0 is no headers (<th>) at all, 1 is only the first row,
+  #                       2 is only the first column and 3 is both, first row and first column as <th> elements. Every other number
+  #                       is equivalent to the bitwise AND of the two least significant bits with 1, 2 or 3
+  # @option opts [Boolean] :data_is_xhtml defaults to false, if true table_data is inserted as xhtml without any sanitation or escaping.
+  #                                       This way a table can be used for custom layouts.
+  # @option opts [Hash] :table_attrs  html attributes for the <table> tag
+  # @option opts [Hash] :th_attrs     html attributes for the <th> tag
+  # @option opts [Hash] :tr_attrs     html attributes for the <tr> tag
+  # @option opts [Hash] :td_attrs     html attributes for the <td> tag
+  # @option opts [Array<Hash>] :special Array of hashes for custom attributes on specific cells (<td> only) of the table  
+  # @example Example of the :special attributes
+  #   opts[:special] = [
+  #     {
+  #       col_title: 'rx_DroppedFrameCount', # string or regexp or nil  # if neither title nor index are present, the condition is evaluated for all <td> cells
+  #       col_index: 5..7,  # Fixnum, Range or nil     # index has precedence over title
+  #       row_title: 'D_0_BE_iMix',  # string or regexp or nil
+  #       row_index: 6,  # Fixnum, Range or nil  
+  #       condition: Proc.new { |e| Integer(e) != 0 },   # a proc
+  #       attributes: {"style" => "background-color: #DB7093;"},
+  #     },
+  #   ]
+  # @return [REXML::Element] the Element which was just added 
+  def custom_table(table_data, opts = {})
+    defaults = {
+      headers: 0,
+      data_is_xhtml: false,
+      table_attrs: {},
+      th_attrs: {},
+      tr_attrs: {},
+      td_attrs: {},
+      special: [],
+    }
+    o = defaults.merge(opts)
+    
     temp = REXML::Element.new("table")
-    temp.add_attributes(table_attrs)
+    temp.add_attributes(o[:table_attrs])
+    row_titles = table_data.collect{|row| row[0].to_s}
+    col_titles = table_data[0].collect{|title| title.to_s}
 
-    for i in 0..table_data.length-1 do
-      row = temp.add_element("tr", tr_attrs)
-      for j in 0..table_data[i].length-1 do
-        if (i == 0 && (0x1 & headers)==0x1)
-          col = row.add_element("th", th_attrs)
-        elsif (j == 0 && (0x2 & headers)==0x2)
-          col = row.add_element("th", th_attrs)
-        elsif ((i == 0 || j ==0) && (0x3 & headers)==0x3)
-          col = row.add_element("th", th_attrs)
+    for i in 0..table_data.length-1 do # row
+      row = temp.add_element("tr", o[:tr_attrs])
+      for j in 0..table_data[i].length-1 do # column
+        if (i == 0 && (0x1 & o[:headers])==0x1)
+          col = row.add_element("th", o[:th_attrs])
+        elsif (j == 0 && (0x2 & o[:headers])==0x2)
+          col = row.add_element("th", o[:th_attrs])
+        elsif ((i == 0 || j ==0) && (0x3 & o[:headers])==0x3)
+          col = row.add_element("th", o[:th_attrs])
         else
-          col = row.add_element("td", td_attrs)
+          _td_attrs = o[:td_attrs].clone
+
+          o[:special].each do |h|
+            # check if the current cell is a candidate for special
+            if !h[:col_index].nil?
+              if h[:col_index].is_a?(Range)
+                next if (!h[:col_index].include?(j)) # skip if not in range
+              elsif h[:col_index].is_a?(Integer)
+                next if (h[:col_index] != j)         # skip if not at index
+              end
+            elsif !h[:col_title].nil?
+              next if !col_titles[j].match(h[:col_title])
+            end
+            # check if the current cell is a candidate for special
+            if !h[:row_index].nil?
+              if h[:row_index].is_a?(Range)
+                next if (!h[:row_index].include?(i)) # skip if not in range
+              elsif h[:row_index].is_a?(Integer)
+                next if (h[:row_index] != i)         # skip if not at index
+              end
+             elsif !h[:row_title].nil?
+              next if !row_titles[i].match(h[:row_title])
+            end
+            
+            # here we are a candidate for special, so we check if we meet the condition
+            if h[:condition].call(table_data[i][j])
+              h[:attributes].each { |attr, val|
+                if !_td_attrs[attr].nil?
+                  # assume the existing attribute is a string (other types don't make much sense for html)
+                  _td_attrs[attr] << val
+                else
+                  # create the attribute if it is not already there
+                  _td_attrs[attr] = val
+                end
+              }
+            end
+          end
+          
+          col = row.add_element("td", _td_attrs)
+        end
+        if o[:data_is_xhtml]
+          # we need to create a new document with a pseudo root because having multiple nodes at top 
+          # level is not valid xml
+          doc = REXML::Document.new("<root>" + table_data[i][j].to_s + "</root>")
+          # then we move all children of root to the actual div middle element and insert after current
+          for elem in doc.root.to_a do
+            col.add_element(elem) # add the td element
+          end
+        else
+          col.add_text(table_data[i][j].to_s)
         end
-        col.add_text(table_data[i][j].to_s)
       end
     end
 
@@ -296,6 +474,7 @@ module Custom
     @current = temp
     return @current
   end
+  
 
   # Appends a new heading element to body, and sets current to this new heading
   # @param tag_type [String] specifiy "h1", "h2", "h3" for the heading, defaults to "h1"

data/lib/xhtml_report_generator/version.rb

@@ -1,5 +1,5 @@
 module XhtmlReportGenerator
-  VERSION = '3.0.3'
+  VERSION = '3.1.0'
 end
 
 # puts XhtmlReportGenerator::VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xhtml_report_generator
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Manuel Widmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2016-09-30 00:00:00.000000000 Z
 dependencies: []
 description: "The generator can be used to create html or xhtml files. It comes with
   many utility functions.\n  \nThe javascript to render the table of contents, the
@@ -51,10 +51,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A simple html or xhtml generator or logger to create human readable reports
   and logs
 test_files: []
-has_rdoc: