Class: Ruport::Formatter::HTML

Inherits:
Ruport::Formatter show all
Defined in:
lib/ruport/formatter/html.rb

Overview

This class produces HTML output for Ruport’s Row, Table, Group, and Grouping controllers. It can be subclassed, as it has some helper methods that might be useful for custom output.

Rendering Options

:show_table_headers True by default

:show_group_headers True by default

:style Used for grouping (:inline, :justified)

Instance Attribute Summary

Attributes inherited from Ruport::Formatter

#data, #format, #options

Instance Method Summary collapse

Methods inherited from Ruport::Formatter

build, #clear_output, #erb, formats, #method_missing, #output, renders, save_as_binary_file, #save_output, #template

Methods included from RenderingTools

#render_group, #render_grouping, #render_inline_grouping, #render_row, #render_table

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Ruport::Formatter

Instance Method Details

#apply_template ⇒ Object

Hook for setting available options using a template. See the template documentation for the available options and their format.



33
34
35
36
 
# File 'lib/ruport/formatter/html.rb', line 33

def apply_template
  apply_table_format_template(template.table)
  apply_grouping_format_template(template.grouping)
end

#build_group_body ⇒ Object

Creates the group body. Since group data is a table, just uses the Table controller.



81
82
83
 
# File 'lib/ruport/formatter/html.rb', line 81

def build_group_body
  render_table data, options.to_hash
end

#build_group_header ⇒ Object

Renders the header for a group using the group name.



74
75
76
 
# File 'lib/ruport/formatter/html.rb', line 74

def build_group_header
  output << "\t<p>#{data.name}</p>\n"
end

#build_grouping_body ⇒ Object

Generates the body for a grouping. Iterates through the groups and renders them using the group controller.



88
89
90
91
92
93
94
95
 
# File 'lib/ruport/formatter/html.rb', line 88

def build_grouping_body
  case options.style
  when :inline
    render_inline_grouping(options)
  when :justified
    render_justified_grouping
  end
end

#build_row(data = self.data) ⇒ Object

Renders individual rows for the table.



65
66
67
68
69
70
 
# File 'lib/ruport/formatter/html.rb', line 65

def build_row(data = self.data)
  output <<
    "\t\t<tr>\n\t\t\t<td>" +
    data.to_a.join("</td>\n\t\t\t<td>") +
    "</td>\n\t\t</tr>\n"
end

#build_table_body ⇒ Object

Uses the Row controller to build up the table body. Replaces nil and empty strings with “&nbsp;”



53
54
55
56
57
 
# File 'lib/ruport/formatter/html.rb', line 53

def build_table_body
  data.each do |row|
    build_row(row.map { |e| e.to_s.empty? ? "&nbsp;" : e })
  end
end

#build_table_footer ⇒ Object

Simply closes the table tag.



60
61
62
 
# File 'lib/ruport/formatter/html.rb', line 60

def build_table_footer
  output << "\t</table>\n"
end

#build_table_header ⇒ Object

Generates table headers based on the column names of your Data::Table.

This method does not do anything if options.show_table_headers is false or the Data::Table has no column names.



42
43
44
45
46
47
48
49
 
# File 'lib/ruport/formatter/html.rb', line 42

def build_table_header
  output << "\t<table>\n"
  unless data.column_names.empty? || !options.show_table_headers
    output << "\t\t<tr>\n\t\t\t<th>" + 
      data.column_names.join("</th>\n\t\t\t<th>") + 
      "</th>\n\t\t</tr>\n"
  end
end

#html_table ⇒ Object

Generates <table> tags enclosing the yielded content.

Example:

output << html_table { "<tr><td>1</td><td>2</td></tr>\n" }
#=> "<table>\n<tr><td>1</td><td>2</td></tr>\n</table>\n"



104
105
106
 
# File 'lib/ruport/formatter/html.rb', line 104

def html_table
  "<table>\n" << yield << "</table>\n"
end

#textile(s) ⇒ Object

Uses RedCloth to turn a string containing textile markup into HTML.

Example:

textile "*bar*" #=> "<p><strong>foo</strong></p>"



114
115
116
117
118
119
 
# File 'lib/ruport/formatter/html.rb', line 114

def textile(s)   
  require "redcloth"
  RedCloth.new(s).to_html   
rescue LoadError
  raise RuntimeError, "You need RedCloth!\n gem install RedCloth -v 3.0.3"
end