Class: XhtmlReportGenerator::Generator
- Inherits:
-
Object
- Object
- XhtmlReportGenerator::Generator
- Defined in:
- lib/xhtml_report_generator.rb
Overview
This is the main generator class. It can be instanced with custom javascript, css, and ruby files to allow generation of arbitrary reports.
Instance Attribute Summary collapse
-
#document ⇒ REXML::Document
This is the html document / actual report.
-
#file ⇒ String
path to the file where this report is saved to.
-
#sync ⇒ Boolean
if true, the report will be written to disk after every modificaiton.
Class Method Summary collapse
-
.create_xhtml_document(title) ⇒ Object
Creates a minimal valid xhtml document including header title and body elements.
Instance Method Summary collapse
-
#cdata(str, parent_element) ⇒ REXML::Element
Surrounds CData tag with c-style comments to remain compatible with normal html.
-
#code(attrs = {}, &block) ⇒ REXML::Element
Appends a <pre> node after the @current node.
-
#content(attrs = {}, &block) ⇒ REXML::Element
Appends a <p> node after the @current node.
-
#create_layout(title, layout = 3) ⇒ Object
creates the basic page layout and sets the current Element to the main content area (middle div).
-
#custom_table(table_data, opts = {}) ⇒ REXML::Element
creates a html table from two dimensional array of the form Array [row] [col].
-
#document_changed ⇒ Object
This method should be called after every change to the document.
- #element_to_string(elem) ⇒ String
-
#encoding_fixer(str) ⇒ String
Check if the give string is a valid UTF-8 byte sequence.
-
#get_code_html(attrs = {}, &block) ⇒ String
Instead of adding content to the report, this method returns the produced html code as a string.
-
#get_content_html(attrs = {}, &block) ⇒ String
Instead of adding content to the report, this method returns the produced html code as a string.
-
#get_current ⇒ REXML::Element
returns the current xml element.
-
#get_element_text(el = @current, recursive = true) ⇒ String
returns the plain text without any xml tags of the specified element and all its children.
-
#get_image_html(path, attributes = {}) ⇒ String
Instead of adding content to the report, this method returns the produced html code as a string.
-
#get_link_html(href, attrs = {}, &block) ⇒ String
Instead of adding content to the report, this method returns the produced html code as a string.
-
#get_title ⇒ String
returns the title text of the report.
-
#heading(tag_type = "h1", attrs = {}, &block) ⇒ REXML::Element
Appends a new heading element to body, and sets current to this new heading.
-
#heading_top(tag_type = "h1", attrs = {}, &block) ⇒ REXML::Element
Inserts a new heading element at the very beginning of the middle div section, and points @current to this heading.
-
#highlight(regex, color = "y", el = @current) ⇒ Fixnum
Scans all REXML::Text children of an REXML::Element for any occurrences of regex.
-
#highlight_captures(regex, color = "y", el = @current) ⇒ Fixnum
Scans all REXML::Text children of an REXML::Element for any occurrences of regex.
-
#html(text) ⇒ REXML::Element
insert arbitrary xml code after the @current element in the content pane (div middle).
- #image(path, attributes = {}) ⇒ Object
-
#initialize(opts = {}) ⇒ Generator
constructor
A new instance of Generator.
-
#javascript(attrs = {}, &block) ⇒ REXML::Element
Appends a <script> node after the @current node.
-
#link(href, attrs = {}, &block) ⇒ REXML::Element
Appends a <a href = > node after the @current nodes.
-
#replace_text_with_elements(parent, element, tagname, attribs, index_length_array) ⇒ Object
Helper Method for the highlight methods.
-
#set_current!(xpath) ⇒ Object
set the current element to the element or first element matched by the xpath expression.
-
#set_title(title) ⇒ Object
sets the title of the document in the <head> section as well as in the layout header div create_layout must be called before!.
-
#table(table_data, headers = 0, table_attrs = {}, tr_attrs = {}, th_attrs = {}, td_attrs = {}) ⇒ REXML::Element
creates a html table from two dimensional array of the form Array [row] [col].
-
#to_s(indent = 0) ⇒ String
returns the string representation of the xml document.
-
#write(file = @file, mode = 'w') ⇒ Object
Saves the xml document to a file.
Constructor Details
#initialize(opts = {}) ⇒ Generator
Returns a new instance of Generator.
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/xhtml_report_generator.rb', line 28 def initialize(opts = {}) # define the default values resources = File.("../../resource/", __FILE__) defaults = { :title => "Title", :js => [ File.("js/jquery-3.5.1.min.js", resources), File.("d3v5.16.0/d3.min.js", resources), File.("c3v0.7.18/c3.min.js", resources), File.("js/split.min.js", resources), File.("js/layout_split.js", resources), File.("js/table_of_contents.js", resources), File.("js/toggle_linewrap.js", resources), ], :css => [ File.("css/style.css", resources), File.("c3v0.7.18/c3.min.css", resources), ], :css_print => [ File.("css/print.css", resources) ], #:custom_rb => File.expand_path("../custom.rb", __FILE__), } @sync = false opts[:title] = defaults[:title] if !opts.key?(:title) if opts.key?(:js) opts[:js] = defaults[:js] + opts[:js] else opts[:js] = defaults[:js] end if opts.key?(:css) opts[:css] = defaults[:css] + opts[:css] else opts[:css] = defaults[:css] end if opts.key?(:css_print) opts[:css_print] = defaults[:css_print] + opts[:css_print] else opts[:css_print] = defaults[:css_print] end @document = Generator.create_xhtml_document(opts[:title]) head = @document.elements["//head"] head.add_element("meta", {"charset" => "utf-8"}) # insert css opts[:css].each do |css_path| style = head.add_element("style", {"type" => "text/css"}) cdata(File.read(css_path), style) end # insert css for printing opts[:css_print].each do |css_path| style = head.add_element("style", {"type" => "text/css", "media"=>"print"}) cdata(File.read(css_path), style) end # inster js files opts[:js].each do |js_path| script = head.add_element("script", {"type" => "text/javascript"}) cdata(File.read(js_path), script) end document_changed() end |
Instance Attribute Details
#document ⇒ REXML::Document
This is the html document / actual report
17 18 19 |
# File 'lib/xhtml_report_generator.rb', line 17 def document @document end |
#file ⇒ String
path to the file where this report is saved to. Default: nil
17 18 19 |
# File 'lib/xhtml_report_generator.rb', line 17 def file @file end |
#sync ⇒ Boolean
if true, the report will be written to disk after every modificaiton. Default: false Note that sync = true can have severe performance impact, since the complete html file is written to disk after each change.
17 18 19 |
# File 'lib/xhtml_report_generator.rb', line 17 def sync @sync end |
Class Method Details
.create_xhtml_document(title) ⇒ Object
Creates a minimal valid xhtml document including header title and body elements
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/xhtml_report_generator.rb', line 133 def self.create_xhtml_document(title) # don't use version 1.1 - firefox has not yet a parser for xml 1.1 # https://bugzilla.mozilla.org/show_bug.cgi?id=233154 header = '<?xml version="1.0" encoding="UTF-8"?>' # change of doctype to <!DOCTYPE html> for html5 compatibility header << '<!DOCTYPE html>' 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 |
Instance Method Details
#cdata(str, parent_element) ⇒ REXML::Element
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/]]>/
102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/xhtml_report_generator.rb', line 102 def cdata(str, parent_element) # sometimes depending on LC_CTYPE environemnt variable it can happen that js / css files are interpreted # with wrong encoding str = encoding_fixer(str) # 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 |
#code(attrs = {}, &block) ⇒ REXML::Element
Appends a <pre> node after the @current node
316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/xhtml_report_generator.rb', line 316 def code(attrs={}, &block) temp = REXML::Element.new("pre") 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) document_changed() return @current end |
#content(attrs = {}, &block) ⇒ REXML::Element
Appends a <p> node after the @current node
364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/xhtml_report_generator.rb', line 364 def content(attrs={}, &block) temp = REXML::Element.new("p") 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) document_changed() return @current end |
#create_layout(title, layout = 3) ⇒ Object
creates the basic page layout and sets the current Element to the main content area (middle div)
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/xhtml_report_generator.rb', line 197 def create_layout(title, layout=3) raise "invalid layout selector, choose from 0..3" if (layout < 0) || (layout > 3) @body = @document.elements["//body"] # only add the layout if it is not already there if !@layout head = @body.add_element("div", {"class" => "head", "id" => "head"}) head.add_element("button", {"id" => "pre_toggle_linewrap"}).add_text("Toggle Linewrap") if (layout & 0x1) != 0 div = @body.add_element("div", {"class" => "lefttoc split split-horizontal", "id" => "ltoc"}) div.add_text("Table of Contents") div.add_element("br") end @div_middle = @body.add_element("div", {"class" => "middle split split-horizontal", "id" => "middle"}) if (layout & 0x2) != 0 div = @body.add_element("div", {"class" => "righttoc split split-horizontal", "id" => "rtoc"}) div.add_text("Quick Links") div.add_element("br");div.add_element("br") end @body.add_element("p", {"class" => "#{layout}", "id" => "layout"}).add_text("this text should be hidden") @layout = true end @current = @document.elements["//body/div[@id='middle']"] set_title(title) document_changed() end |
#custom_table(table_data, opts = {}) ⇒ REXML::Element
creates a html table from two dimensional array of the form Array [row] [col]
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'lib/xhtml_report_generator.rb', line 604 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(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 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 # we need to deepcopy the attributes _td_attrs = Marshal.load(Marshal.dump(o[:td_attrs])) # check all special criteria 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 # puts h[:attributes].inspect # puts "cell value row #{i} col #{j}: #{table_data[i][j]}" # puts h[:condition].call(table_data[i][j]).inspect if h[:condition].call(table_data[i][j]) h[:attributes].each { |attr, val| # debug, verify deepcopy # puts "objects are equal: #{_td_attrs[attr].equal?(o[:td_attrs][attr])}" 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 if elem.is_a?(REXML::Text) # due to reasons unclear to me, text needs special treatment col.add_text(elem) else col.add_element(elem) # add the td element end end else col.add_text(table_data[i][j].to_s) end end # for j in 0..table_data[i].length-1 do # column end # for i in 0..table_data.length-1 do # row @div_middle.insert_after(@current, temp) @current = temp document_changed() return @current end |
#document_changed ⇒ Object
This method should be called after every change to the document. Here we ensure the report is written to disk after each change if #sync is true. If #sync is false this method does nothing
182 183 184 185 186 187 188 189 |
# File 'lib/xhtml_report_generator.rb', line 182 def document_changed() if @sync if @file.nil? raise "You must call #write at least once before you can enable synced mode" end write() end end |
#element_to_string(elem) ⇒ String
289 290 291 292 293 294 |
# File 'lib/xhtml_report_generator.rb', line 289 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 |
#encoding_fixer(str) ⇒ String
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” (xe2xb8xae) (‘REVERSED QUESTION MARK’) because the default replacement character “uFFFD” (‘QUESTION MARK IN DIAMOND BOX’) is two slots wide and might destroy mono spaced formatting
120 121 122 123 124 125 126 127 128 129 |
# File 'lib/xhtml_report_generator.rb', line 120 def encoding_fixer(str) str = str.to_s # catch str = nil #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 |
#get_code_html(attrs = {}, &block) ⇒ String
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)
300 301 302 303 304 305 306 307 |
# File 'lib/xhtml_report_generator.rb', line 300 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 |
#get_content_html(attrs = {}, &block) ⇒ String
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)
351 352 353 354 355 356 357 358 |
# File 'lib/xhtml_report_generator.rb', line 351 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 |
#get_current ⇒ REXML::Element
returns the current xml element
265 266 267 |
# File 'lib/xhtml_report_generator.rb', line 265 def get_current() return @current end |
#get_element_text(el = @current, recursive = true) ⇒ String
returns the plain text without any xml tags of the specified element and all its children
273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/xhtml_report_generator.rb', line 273 def get_element_text(el = @current, recursive = true) out = "" el.to_a.each { |child| if child.is_a?(REXML::Text) out << child.value() else if recursive out << get_element_text(child, true) end end } return out end |
#get_image_html(path, attributes = {}) ⇒ String
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)
428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/xhtml_report_generator.rb', line 428 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 |
#get_link_html(href, attrs = {}, &block) ⇒ String
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)
396 397 398 399 400 401 402 403 404 |
# File 'lib/xhtml_report_generator.rb', line 396 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 |
#get_title ⇒ String
returns the title text of the report
245 246 247 248 |
# File 'lib/xhtml_report_generator.rb', line 245 def get_title() pagetitle = @document.elements["//head/title"] return pagetitle.text end |
#heading(tag_type = "h1", attrs = {}, &block) ⇒ REXML::Element
Appends a new heading element to body, and sets current to this new heading
711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'lib/xhtml_report_generator.rb', line 711 def heading(tag_type="h1", attrs={}, &block) temp = REXML::Element.new(tag_type) 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.text = text document_changed() return @current end |
#heading_top(tag_type = "h1", attrs = {}, &block) ⇒ REXML::Element
Inserts a new heading element at the very beginning of the middle div section, and points @current to this heading
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 |
# File 'lib/xhtml_report_generator.rb', line 731 def heading_top(tag_type="h1", attrs={}, &block) temp = REXML::Element.new(tag_type) temp.add_attributes(attrs) # check if there are any child elements if @div_middle.has_elements?() # insert before the first child of div middle @div_middle.insert_before("//div[@id='middle']/*[1]", temp) else # middle is empty, just insert the heading @div_middle.insert_after(@current, temp) end @current = temp raise "Block argument is mandatory" unless block_given? text = encoding_fixer(block.call()) @current.text = text document_changed() return @current end |
#highlight(regex, color = "y", el = @current) ⇒ Fixnum
Scans all REXML::Text children of an REXML::Element for any occurrences of regex. The text will be matched as one, not line by line as you might think. If you want to write a regexp matching multiple lines keep in mind that the dot “.” by default doesn’t match newline characters. Consider using the “m” option (e.g. /regex/m ) which makes dot match newlines or match newlines explicitly. highlight then puts a <span> </span> tag around all matches of regex
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 |
# File 'lib/xhtml_report_generator.rb', line 523 def highlight(regex, color="y", el = @current) # get all children of the current node arr = el.to_a() num_matches = 0 #puts arr.inspect # first we have to detach all children from parent, otherwise we can cause ordering issues arr.each {|i| i.remove() } # depth first recursion into grand-children for i in arr do #puts i.class.to_s() if i.is_a?(REXML::Text) # in general a text looks as follows: # .*(matchstring|.*)* # We get an array of [[start,length], [start,length], ...] for all our regex matches positions = i.value().enum_for(:scan, regex).map { [Regexp.last_match.begin(0), Regexp.last_match.end(0)-Regexp.last_match.begin(0)] } num_matches += positions.length 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" num_matches += highlight(regex, color, i) el.add(i) end # if i.is_a?(REXML::Text) end # for i in arr do document_changed() return num_matches end |
#highlight_captures(regex, color = "y", el = @current) ⇒ Fixnum
Scans all REXML::Text children of an REXML::Element for any occurrences of regex. The text will be matched as one, not line by line as you might think. If you want to write a regexp matching multiple lines keep in mind that the dot “.” by default doesn’t match newline characters. Consider using the “m” option (e.g. /regex/m ) which makes dot match newlines or match newlines explicitly. 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!!
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 |
# File 'lib/xhtml_report_generator.rb', line 471 def highlight_captures(regex, color="y", el = @current) # get all children of the current node arr = el.to_a() num_matches = 0 # first we have to detach all children from parent, otherwise we can cause ordering issues arr.each {|i| i.remove() } # depth first recursion into grand-children for i in arr do if i.is_a?(REXML::Text) # in general a text looks as follows: # .*(matchstring|.*)* # We get an array of [[start,length], [start,length], ...] for all our regex SUB-matches positions = i.value().enum_for(:scan, regex).flat_map { # Regexp.last_match is a MatchData object, the index 0 is the entire match, 1 to n are captures array = Array.new for k in 1..Regexp.last_match.length - 1 do array.push([Regexp.last_match.begin(k), Regexp.last_match.end(k)-Regexp.last_match.begin(k)]) end # return the array for the flat_map array } num_matches += positions.length 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) el.add(i) end # if i.is_a?(REXML::Text) end # for i in arr do document_changed() return num_matches end |
#html(text) ⇒ REXML::Element
insert arbitrary xml code after the @current element in the content pane (div middle)
379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/xhtml_report_generator.rb', line 379 def html(text) # 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.to_s+"</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 @div_middle.insert_after(@current, i) @current = i end document_changed() return @current end |
#image(path, attributes = {}) ⇒ Object
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 |
# File 'lib/xhtml_report_generator.rb', line 444 def image(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) @div_middle.insert_after(@current, temp) @current = temp document_changed() return @current end |
#javascript(attrs = {}, &block) ⇒ REXML::Element
Appends a <script> node after the @current node
333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/xhtml_report_generator.rb', line 333 def javascript(attrs={}, &block) default_attrs = {"type" => "text/javascript"} attrs = default_attrs.merge(attrs) temp = REXML::Element.new("script") temp.add_attributes(attrs) @div_middle.insert_after(@current, temp) @current = temp raise "Block argument is mandatory" unless block_given? script_content = encoding_fixer(block.call()) cdata(script_content, @current) document_changed() return @current end |
#link(href, attrs = {}, &block) ⇒ REXML::Element
Appends a <a href = > node after the @current nodes
411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/xhtml_report_generator.rb', line 411 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) document_changed() return @current end |
#replace_text_with_elements(parent, element, tagname, attribs, index_length_array) ⇒ Object
Helper Method for the highlight methods. it will introduce specific xhtml tags around parts of a text child of an xml element.
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 |
# File 'lib/xhtml_report_generator.rb', line 771 def replace_text_with_elements(parent, element, tagname, attribs, index_length_array) last_end = 0 index = 0 #puts index_length_array.inspect #puts element.inspect for j in index_length_array do # reattach normal (unmatched) text if j[0] > last_end # text = REXML::Text.new(element.value()[ last_end, j[0] - last_end ]) # parent.add_text(text) # add text without creating a textnode, textnode screws up formatting (e.g. all whitespace are condensed into one) parent.add_text( element.value()[ last_end, j[0] - last_end ] ) end #create the tag node with attributes and add the text to it tag = parent.add_element(REXML::Element.new(tagname), attribs) tag.add_text(element.value()[ j[0], j[1] ]) last_end = j[0]+j[1] # in the last round check for any remaining text if index == index_length_array.length - 1 if last_end < element.value().length # text = REXML::Text.new(element.value()[ last_end, element.value().length - last_end ]) # parent.add(text) # add text without creating a textnode, textnode screws up formatting (e.g. all whitespace are condensed into one) parent.add_text( element.value()[ last_end, element.value().length - last_end ] ) end end index += 1 end # for j in positions do # don't forget to reattach the textnode if there are no regex matches at all if index == 0 parent.add(element) end end |
#set_current!(xpath) ⇒ Object
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.
253 254 255 256 257 258 259 260 261 |
# File 'lib/xhtml_report_generator.rb', line 253 def set_current!(xpath) if xpath.is_a?(REXML::Element) @current = xpath elsif xpath.is_a?(String) @current = @document.elements[xpath] else raise "xpath is neither a String nor a REXML::Element" end end |
#set_title(title) ⇒ Object
sets the title of the document in the <head> section as well as in the layout header div create_layout must be called before!
232 233 234 235 236 237 238 239 240 241 |
# File 'lib/xhtml_report_generator.rb', line 232 def set_title(title) if !@layout raise "call create_layout first" end pagetitle = @document.elements["//head/title"] pagetitle.text = title div = @document.elements["//body/div[@id='head']"] div.text = title document_changed() end |
#table(table_data, headers = 0, table_attrs = {}, tr_attrs = {}, th_attrs = {}, td_attrs = {}) ⇒ REXML::Element
creates a html table from two dimensional array of the form Array [row] [col]
568 569 570 571 572 573 574 575 576 577 578 |
# File 'lib/xhtml_report_generator.rb', line 568 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 |
#to_s(indent = 0) ⇒ String
returns the string representation of the xml document
154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/xhtml_report_generator.rb', line 154 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}) # change to Formatters since document.write is deprecated f = REXML::Formatters::Transitive.new(indent) f.write(@document, output) return output end |
#write(file = @file, mode = 'w') ⇒ Object
Saves the xml document to a file. If no file is given, the file which was used most recently for this Generator object will be overwritten.
170 171 172 173 174 175 176 177 |
# File 'lib/xhtml_report_generator.rb', line 170 def write(file=@file, mode='w') # instance variables are nil if they were never initialized if file.nil? raise "no valid file given: '#{file}'" end @file = file File.open(file, "#{mode}:UTF-8") {|f| f.write(self.to_s.force_encoding(Encoding::UTF_8))} end |