webget-html_output 1.0.2

data/lib/html_output.rb

@@ -0,0 +1,295 @@
+# = HTML Output
+#
+# Author:: Joel Parker Henderson, joelparkerhenderson@gmail.com
+# Copyright:: Copyright (c) 2006-2008 Joel Parker Henderson
+# License:: CreativeCommons License, Non-commercial Share Alike
+# License:: LGPL, GNU Lesser General Public License
+#
+##
+
+module HTMLOutput
+
+  # Options:
+  #   :text : the complete text of the table, e.g. <table>text</table>
+  #   :headers
+  #   :footers
+  #   :rows
+  #   :class is the table's css class, e.g. :class=>'sortable' 
+  #   :id is the table's css id, e.g. :id=>'mytable'
+  #
+  # Return:
+  #   <table id="foo" class="bar">
+  #   <thead>
+  #   <tr>
+  #   <th>header[0]</th>
+  #   <th>header[1]</th>
+  #   <th>header[2]</th>
+  #   </tr>
+  #   </thead>
+  #   <tbody>
+  #   <tr>
+  #   <td>row[0][0]</td>
+  #   <td>row[0][1]</td>
+  #   <td>row[0][2]</td>
+  #   </tr>
+  #   <tr>
+  #   <td>row[1][0]</td>
+  #   <td>row[1][1]</td>
+  #   <td>row[1][2]</td>
+  #   </tr>
+  #   <tr>
+  #   <td>row[2][0]</td>
+  #   <td>row[2][1]</td>
+  #   <td>row[2][2]</td>
+  #   </tr>
+  #   </tbody>
+  #   <tfoot>
+  #   <tr>
+  #   <th>
+  #   <th>footer[0]</th>
+  #   <th>footer[1]</th>
+  #   <th>footer[2]</th>
+  #   </tr>
+  #   </tfoot>
+  #   </table>
+  #
+  # ==Special cases
+  #
+  # If headers or row or footers are nil, then this skips them.
+  # 
+  # If footers==[] then this method will use a footers array
+  # with blanks that is the same length as the headers array.
+  
+  def table(ops={})
+    text=ops[:text]
+    if !text
+     headers=ops[:headers]
+     footers=(defined?(ops[:footers]) ? ((ops[:footers]==true) ? Array.new(headers.size,'') : ops[:footers]) : false)
+     rows=ops[:rows]
+     text=((headers ? thead(headers) : '') + (rows ? tbody(rows) : '') + (footers ? tfoot(footers) : ''))
+    end
+    return "<table#{attrs_to_string(ops,[:id,:class])}>\n" + text + "</table>\n"
+  end
+
+
+  # Options:
+  #   :texts
+  #
+  # Return:
+  #   <table>
+  #   texts[0]
+  #   </table>
+  #   <table>
+  #   texts[0]
+  #   </table>
+  #   ...
+ 
+  def tables(ops={})
+    ops[:texts].map{|text| table(ops.merge(:text=>text))}.join
+  end
+
+
+  # Return:
+  #   <thead>
+  #   <th>header[0]</th>
+  #   <th>header[1]</th>
+  #   <th>header[2]</th>
+  #   </thead>
+
+  def thead(headers)
+    "<thead>\n" + tr(ths(headers)) + "</thead>\n"
+  end
+
+
+  # Return:
+  #   <th>header</th>
+ 
+  def th(header)
+    "<th>" + header.to_s + "</th>\n"
+  end
+
+
+  # Return:
+  #   <th>header[0]</th>
+  #   <th>header[1]</th>
+  #   <th>header[2]</th>
+
+  def ths(headers)
+    headers.map{|x| th(x)}.join
+  end
+
+
+  # Return:
+  #   <tbody>
+  #   <tr>
+  #   <td>row[0][0]</td>
+  #   <td>row[0][1]</td>
+  #   <td>row[0][2]</td>
+  #   </tr>
+  #   <tr>
+  #   <td>row[1][0]</td>
+  #   <td>row[1][1]</td>
+  #   <td>row[1][2]</td>
+  #   </tr>
+  #   <tr>
+  #   <td>row[2][0]</td>
+  #   <td>row[2][1]</td>
+  #   <td>row[2][2]</td>
+  #   </tr>
+  #   </tbody>
+  
+  def tbody(rows)
+    "<tbody>\n" + trs(rows) + "</tbody>\n"
+  end
+
+
+  # Return:
+  #  <tr>
+  #  row
+  #  </tr>
+  #
+  # Return when row is enumerable:
+  #   <tr>
+  #   <td>row[0]</td>
+  #   <td>row[1]</td>
+  #   <td>row[2]</td>
+  #   </tr>
+
+  def tr(row)
+    "<tr>\n" + (row.is_a?(String) ? row : row.is_a?(Enumerable) ? tds(row) : row.to_s) + "</tr>\n"
+  end
+
+
+  # Return:
+  #   <tr>
+  #   <td>row[0][0]</td>
+  #   <td>row[0][1]</td>
+  #   <td>row[0][2]</td>
+  #   </tr>
+  #   <tr>
+  #   <td>row[1][0]</td>
+  #   <td>row[1][1]</td>
+  #   <td>row[1][2]</td>
+  #   </tr>
+  #   <tr>
+  #   <td>row[2][0]</td>
+  #   <td>row[2][1]</td>
+  #   <td>row[2][2]</td>
+  #   </tr>
+
+  def trs(rows)
+    rows.map{|x| tr(x)}.join
+  end
+
+
+  # Return:
+  #   <td>cell</td>
+ 
+  def td(cell)
+    "<td>" + cell.to_s + "</td>\n"
+  end
+
+
+  # Return:
+  #   <td>cells[0]</td>
+  #   <td>cells[1]</td>
+  #   <td>cells[2]</td>
+
+  def tds(cells)
+    cells.map{|x| td(x)}.join
+  end
+
+
+  # Return:
+  #   <tfoot>
+  #   <th>
+  #   <th>footer[0]</th>
+  #   <th>footer[1]</th>
+  #   <th>footer[2]</th>
+  #   </tfoot>
+
+  def tfoot(footers)
+    "<tfoot>\n" + tr(ths(footers)) + "</tfoot>\n"
+  end
+
+
+  # Return:
+  #   <ul>
+  #   list
+  #   </ul>
+  #
+  # Return when list is enumerable:
+  #   <ul>
+  #   <li>list[1]</li>
+  #   <li>list[2]</li>
+  #   <li>list[3]</li>
+  #   </ul>
+ 
+  def ul(list)
+    "<ul>\n" + (list.is_a?(String) ? list : list.is_a?(Enumerable) ? lis(list) : list.to_s) + "</ul>\n"
+  end
+
+  
+  # Return:
+  #   <ul>
+  #   <li>list[0][1]</li>
+  #   <li>list[0][2]</li>
+  #   <li>list[0][3]</li>
+  #   </ul>
+  #   <ul>
+  #   <li>list[1][1]</li>
+  #   <li>list[1][2]</li>
+  #   <li>list[1][3]</li>
+  #   </ul>
+  #   <ul>
+  #   <li>list[2][1]</li>
+  #   <li>list[2][2]</li>
+  #   <li>list[2][3]</li>
+  #   </ul>
+
+  def uls(lists)
+   lists.map{|x| ul(x)}.join
+  end 
+
+
+  # Return:
+  #   <li>item</li>
+ 
+  def li(item)
+    "<li>" + item.to_s + "</li>\n"
+  end
+
+
+  # Return: 
+  #   <li>item[0]</li>
+  #   <li>item[1]</li>
+  #   <li>item[2]</li>
+
+  def lis(items)
+    items.map{|x| li(x)}.join
+  end
+
+
+  protected
+
+  # There's likely a better more-standard way to do this.
+  #
+  # This method is only used by the #table method.
+  #
+  # Return a string of the attributes suitable for HTML
+  #
+  # ==Example
+  #   hash={:foo'=>'bar',:goo'=>'car',;hoo=>'dar'}
+  #   attrs(hash) => ' foo="bar" goo="car" hoo="dar"'
+  #   
+  # ==Example with selected keys
+  #   hash={:foo'=>'bar',:goo'=>'car',;hoo=>'dar'}
+  #   attrs(hash,[:foo,:hoo]) => ' foo="bar" hoo="dar"'
+  
+  def attrs_to_string(ops,keys=nil)
+   return '' if !ops or ops=={}
+   keys||=ops.keys
+   return keys.inject(''){|s,k| s = (ops[k] ? s+=" #{k}=\"#{ops[k]}\"" : s)}
+  end
+
+end

data/test/unit/html_output_test.rb

@@ -0,0 +1,84 @@
+require 'test/unit'
+require 'html_output'
+
+class HTMLOutputTest < Test::Unit::TestCase
+
+  # Mock Inputs
+  CELLS=['a','b','c']
+  ITEMS=['a','b','c']
+  ROWS=[['a','b','c'],['d','e','f'],['g','h','i']]
+
+
+  def test_li
+    assert_equal("<li>a</li>\n",h.li('a'))
+  end
+
+  def test_lis
+    assert_equal("<li>a</li>\n<li>b</li>\n<li>c</li>\n",h.lis(ITEMS))
+  end
+
+  def test_ul
+    assert_equal("<ul>\n<li>a</li>\n<li>b</li>\n<li>c</li>\n</ul>\n",h.ul(ITEMS))
+  end
+
+  def test_uls
+    assert_equal("<ul>\n<li>a</li>\n<li>b</li>\n<li>c</li>\n</ul>\n<ul>\n<li>a</li>\n<li>b</li>\n<li>c</li>\n</ul>\n",h.uls([ITEMS,ITEMS]))
+  end
+
+  def test_td
+    assert_equal("<td>a</td>\n",h.td('a'))
+  end
+
+  def test_tds
+    assert_equal("<td>a</td>\n<td>b</td>\n<td>c</td>\n",h.tds(CELLS))
+  end
+
+  def test_tr
+    assert_equal("<tr>\n<td>a</td>\n<td>b</td>\n<td>c</td>\n</tr>\n",h.tr(CELLS))
+  end
+
+  def test_trs
+    assert_equal("<tr>\n<td>a</td>\n<td>b</td>\n<td>c</td>\n</tr>\n<tr>\n<td>d</td>\n<td>e</td>\n<td>f</td>\n</tr>\n<tr>\n<td>g</td>\n<td>h</td>\n<td>i</td>\n</tr>\n",h.trs(ROWS))
+  end
+
+  def test_tbody
+    assert_equal("<tbody>\n<tr>\n<td>a</td>\n<td>b</td>\n<td>c</td>\n</tr>\n<tr>\n<td>d</td>\n<td>e</td>\n<td>f</td>\n</tr>\n<tr>\n<td>g</td>\n<td>h</td>\n<td>i</td>\n</tr>\n</tbody>\n",h.tbody(ROWS))
+  end
+
+  def test_ths
+    assert_equal("<th>a</th>\n<th>b</th>\n<th>c</th>\n",h.ths(CELLS))
+  end
+
+  def test_thead(headers)
+    assert_equal("<thead>\n<tr>\n<th>a</th>\n<th>b</th>\n<th>c</th>\n</tr>\n</thead>",h.thead(CELLS))
+  end
+
+  def test_tfoot
+    assert_equal("<tfoot>\n<tr>\n<th>a</th>\n<th>b</th>\n<th>c</th>\n<\tr>\n</tfoot>\n",h.tfoot(CELLS))
+  end
+
+  def test_table_text
+    assert_equal("<table>\nfoo</table>\n",h.table(:text=>'foo'))
+  end
+
+  def test_table_text_and_attrs
+    assert_equal("<table id=\"foo\" class=\"bar\">\nfoo</table>\n",h.table(:id=>'foo',:class=>'bar',:text=>'foo'))
+  end
+
+  def test_tables
+    assert_equal("<table>\nfoo</table>\n<table>\nbar</table>\n",h.tables(:texts=>['foo','bar']))
+  end
+
+  def test_table_headers_body_footers
+    assert_equal(
+      "<table>\n"+
+      "<thead>\n<tr>\n<th>a</th>\n<th>b</th>\n<th>c</th>\n</tr>\n</thead>\n"+
+      "<tbody>\n<tr>\n<td>a</td>\n<td>b</td>\n<td>c</td>\n</tr>\n<tr>\n<td>d</td>\n<td>e</td>\n<td>f</td>\n</tr>\n<tr>\n<td>g</td>\n<td>h</td>\n<td>i</td>\n</tr>\n</tbody>\n"+
+      "<tfoot>\n<tr>\n<th>a</th>\n<th>b</th>\n<th>c</th>\n</tr>\n</tfoot>\n"+
+      "</table>\n",
+      h.table(:headers=>CELLS,:rows=>ROWS,:footers=>CELLS)
+    )
+  end
+
+end
+

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+name: webget-html_output
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- WebGet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-13 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: webget@webget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/html_output.rb
+has_rdoc: true
+homepage: http://webget.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: HTML output formating of items into tables, headers, rows, cells, lists, etc.
+test_files: 
+- test/unit/html_output_test.rb