html_skeleton 0.2.3 → 0.3.4

data/README.md

@@ -1,38 +1,52 @@
-HTML Calendar
-=============
+HtmlSkeleton
+============
+
+HtmlSkeleton provides the frame for a calendar or a table,
+i.e. no loops are required to build up the HTML structure.
+Filling the skeleton is done via parameters and, in particular,
+with procs (Proc.new, lambda).
+See below Default Options.
+
+Install
+-------
+
+    gem 'html_skeleton'
+
+    rake   # for testing
+
+
+Calendar
+========
 
 A simple helper for creating an HTML calendar.
 The "calendar" method will be available to your view templates.
 
-Blocks (Proc.new) may be supplied by the user to generate
-particular HTML-code for a day, a month or a year.
-As an example (see below) clicking a day triggers an action.
-
+Procs may be supplied to generate
+particular HTML-code for a day or the year.
+In the example below clicking a day triggers an action.
 
 Examples
 --------
+    HtmlSkeleton.new.calendar                    # calendar for current year
+    HtmlSkeleton.new.calendar :year = 2012       # calendar for year 2012
+    HtmlSkeleton.new.calendar :year = 2012, :month => 8  # calendar for August 2012
 
-    calendar                            # calendar for current year
-    calendar :year = 2012               # calendar for year 2012
-    calendar :year = 2012, :month => 8  # calendar for August 2012
-
-    calendar {|date|
-      link ="/#{controller_name}/toggle/#{@row.id}?date=#{date}"
-      style = @row.holidays.include?(date.to_s) ?
+    HtmlSkeleton.new.calendar {|date|
+      link ="/#{controller_name}/toggle/#{@resource.id}?date=#{date}"
+      style = @resource.holidays.include?(date.to_s) ?
 	       'font-weight:bold; color:red' : ''
       %Q{ <a style="#{style}" href="#{link}"> #{date.day.to_s} </a>}
     }
 
-
 Default Options
 ---------------
-    :year   => DateTime.now.year,
-    :calendar_class => 'calendar',
+    :year        => DateTime.now.year,
+    :title       => DateTime.now.year,
+    :calendar_class => 'skeleton',
     :day_names   => Date::DAYNAMES.dup,
+    :month_names => Date::MONTHNAMES,
     :abbrev      => (0..1),
-    :day_block   => block || Proc.new {|d| d.day.to_s},
-    :month_block =>          Proc.new {|d| d.strftime('%B')},
-    :year_block  =>          Proc.new {|d| d.to_s},
+    :cell_proc   => block || lambda {|d| d.day.to_s},
     :first_day_of_week => 1
 
 
@@ -40,3 +54,58 @@ Inspired by calendar_helper:
 
 * Jeremy Voorhis -- http://jvoorhis.com
 * Geoffrey Grosenbach -- http://nubyonrails.com
+
+
+Table
+=====
+
+A simple helper for creating an HTML table.
+
+Table only takes care of the HTML tags and expects lambdas/strings to
+be supplied by the user.
+
+Examples
+--------
+    rows = %w{a bb ccc}
+    cols = %w{1 22}
+    HtmlSkeleton.new.table(rows, cols) {|row, col|
+       col == '1' ? '<td>bingo</td>' : '<td></td>'
+    }
+
+    HtmlSkeleton.new.table(@users, %w{email address},
+		:th_attribute => lambda { |col| col.name },
+		:legend => 'Users') { |row, col|
+      "<td>#{ row.send(col) }</td>"
+    }
+
+    stripes = %w{odd even}
+    proc = lambda{ |row| k = stripes.shift; stripes << k; %Q{class="#{k}"} }
+    HtmlSkeleton.new.table(@users, %w{email address},
+		:tr_attribute => proc,
+		:legend => 'Users') { |row, col|
+      "<td>#{ row.send(col) }</td>"
+    }
+
+Default Options
+---------------
+    :legend => nil,
+    :col_legend   => lambda(&:to_s),
+    :row_legend   => lambda(&:id),
+    :th_attribute => lambda { |col| nil },
+    :tr_attribute => lambda { |row| nil },
+    :table_class  => 'skeleton',
+    :cell_proc    => block || lambda {|row, col| "<td>#{row} #{col}</td>"}
+
+
+Curious?
+--------
+
+    github.com/cthulhu666/easy_table
+    github.com/giniedp/fancygrid
+    github.com/hunterae/table-for
+    github.com/jgdavey/tabletastic
+    github.com/lunich/table_for
+    github.com/watu/table_builder
+    ruby-toolbox.com/projects/tableasy
+
+Copyright (c) 2012 [Dittmar Krall], released under the MIT license.

data/lib/html_skeleton.rb

@@ -1,18 +1,10 @@
 require 'date'
+require 'html_skeleton_calendar'
+require 'html_skeleton_table'
 
 class HtmlSkeleton
   attr_reader :options
 
-  def table(rows, cols, options = {}, &block)
-    set_table_options(options, &block)
-    <<-EOS
-<table class="#{@options[:table_class]}">
-  #{table_header(cols)}
-  #{table_body(rows, cols)}
-</table>
-    EOS
-  end
-
   def calendar(options = {}, &block)
     set_calendar_options(options, &block)
     frame = @options[:month] ? 'div' : 'table'
@@ -21,51 +13,17 @@ class HtmlSkeleton
 		a_year(@options[:year])
     %Q{<#{frame} class="#{@options[:calendar_class]}"> #{body} </#{frame}>}
   end
-end
-
 
-# table methods ######################################################
-class HtmlSkeleton
- protected
-  def defaultProc
-    Proc.new(&:to_s)
-  end
-
-  def set_table_options(options, &block)
-    @options = {
-      :title => '',
-      :table_class => 'skeleton',
-      :legend_proc => defaultProc,
-      :header_proc => defaultProc,
-      :cell_proc   => block || Proc.new {|row, col| "<td>#{row} #{col}</td>"},
-    }.merge options
-  end
-
-  def table_header(cols)
-    proc = @options[:header_proc]
-    col_header = cols.collect { |col| "<th>#{proc.call(col)}</th>" }.join
-    %Q{<thead><th class="legend">#{@options[:title]}</th>#{col_header}</thead>}
-  end
-
-  def table_body(rows, cols)
-    legend_proc = @options[:legend_proc]
-    rows.collect { |row|
-      cells = table_row(row, cols)
-      %Q{<tr><td class="legend">#{legend_proc.call(row)}</td>#{cells}</tr>}
-    }.join("\n")
-  end
-
-  def table_row(row, cols)
-    cell_proc = @options[:cell_proc]
-    cols.collect { |col|  cell_proc.call(row, col) }.join('')
+  def table(rows, cols, options = {}, &block)
+    set_table_options(options, &block)
+    <<-EOS
+<table class="#{@options[:table_class]}">
+  #{table_header(cols)}
+  #{table_body(rows, cols)}
+</table>
+    EOS
   end
 
-end
-
-
-# calendar methods ###################################################
-class HtmlSkeleton
-  attr_reader :day_header
 
  protected
   def set_calendar_options(options, &block)
@@ -76,7 +34,7 @@ class HtmlSkeleton
       :calendar_class => 'skeleton',
       :month_names => Date::MONTHNAMES,
       :abbrev      => (0..1),
-      :cell_proc   => block || Proc.new {|d| d.day.to_s},
+      :cell_proc   => block || lambda {|d| d.day.to_s},
       :first_day_of_week => 1
     }.merge options
 
@@ -90,63 +48,17 @@ class HtmlSkeleton
     }.join('')
   end
 
-  def a_year(year)
-    rows, cols = 3, 4
-    body = (0..rows - 1).collect {|y|
-      str = (1..cols).collect {|x| "<td>#{a_month(year, y * cols + x)}</td>"}
-      "<tr>#{str.join('')}</tr>"
-    }
-    <<-EOS
-<thead><th colspan="2">#{@options[:title]}</th></thead>
-#{body.join('')}
-    EOS
-  end
-
-  def a_month(year, month)
-    title = @options[:month_names][month]
-    <<-EOS
-<table class="month">
-  <tr class="monthName"><th colspan="7">#{title}</th></tr>
-  <tr class="dayName">#{@day_header}</tr>
-  #{days_of_month(year, month)}
-</table>
-    EOS
-  end
-
-  def days_of_month(year, month)
-    first_weekday = @options[:first_day_of_week]
-    last_weekday  = first_weekday > 0 ? first_weekday - 1 : 6
-    cell_proc = @options[:cell_proc]
-    today = (Time.respond_to?(:zone) &&
-	    !(zone = Time.zone).nil? ? zone.now.to_date : Date.today)
-
-    first = Date.civil(year, month, 1)
-    last  = Date.civil(year, month, -1)
-
-    cal = '<tr>'
-    cal << '<td></td>' * days_between(first_weekday, first.wday)
-    first.upto(last) {|cur|
-      cal << a_day(cur, today, cell_proc)
-      cal << '</tr> <tr>' if cur.wday == last_weekday
-    }
-    cal << '<td></td>' * days_between((last + 1).wday, first_weekday + 7)
-    cal << '</tr>'
-  end
-
-  def a_day(date, today, block)
-    attrs = 'day'
-    attrs += ' weekendDay'  if weekend?(date)
-    attrs += ' today'       if date == today
-    "<td class=\"#{attrs}\">#{block.call(date)}</td>"
-#    "<td class=\"#{attrs}\">##</td>"
-  end
-  
-  def weekend?(date)
-    [0, 6].include?(date.wday)
-  end
+  def set_table_options(options, &block)
+    @options = {
+      :legend => nil,
+      :col_legend => lambda(&:to_s),
+      :row_legend => lambda(&:id),
+      :th_attribute => lambda { |col| nil },
+      :tr_attribute => lambda { |row| nil },
 
-  def days_between(first, second)
-    first > second ? second + (7 - first) : second - first
+      :table_class => 'skeleton',
+      :cell_proc   => block || lambda {|row, col| "<td>#{row} #{col}</td>"},
+    }.merge options
   end
 
 end

data/lib/html_skeleton_calendar.rb

@@ -0,0 +1,67 @@
+require 'date'
+
+# calendar methods ###################################################
+class HtmlSkeleton
+  attr_reader :day_header
+
+ protected
+  def a_year(year)
+    rows, cols = 3, 4
+    body = (0..rows - 1).collect {|y|
+      str = (1..cols).collect {|x| "<td>#{a_month(year, y * cols + x)}</td>"}
+      "<tr>#{str.join('')}</tr>"
+    }
+    <<-EOS
+<thead><th colspan="2">#{@options[:title]}</th></thead>
+#{body.join('')}
+    EOS
+  end
+
+  def a_month(year, month)
+    title = @options[:month_names][month]
+    <<-EOS
+<table class="month">
+  <tr class="monthName"><th colspan="7">#{title}</th></tr>
+  <tr class="dayName">#{@day_header}</tr>
+  #{days_of_month(year, month)}
+</table>
+    EOS
+  end
+
+  def days_of_month(year, month)
+    first_weekday = @options[:first_day_of_week]
+    last_weekday  = first_weekday > 0 ? first_weekday - 1 : 6
+    cell_proc = @options[:cell_proc]
+    today = (Time.respond_to?(:zone) &&
+	    !(zone = Time.zone).nil? ? zone.now.to_date : Date.today)
+
+    first = Date.civil(year, month, 1)
+    last  = Date.civil(year, month, -1)
+
+    cal = '<tr>'
+    cal << '<td></td>' * days_between(first_weekday, first.wday)
+    first.upto(last) {|cur|
+      cal << a_day(cur, today, cell_proc)
+      cal << '</tr> <tr>' if cur.wday == last_weekday
+    }
+    cal << '<td></td>' * days_between((last + 1).wday, first_weekday + 7)
+    cal << '</tr>'
+  end
+
+  def a_day(date, today, block)
+    attrs = 'day'
+    attrs += ' weekendDay'  if weekend?(date)
+    attrs += ' today'       if date == today
+    "<td class=\"#{attrs}\">#{block.call(date)}</td>"
+#    "<td class=\"#{attrs}\">##</td>"
+  end
+  
+  def weekend?(date)
+    [0, 6].include?(date.wday)
+  end
+
+  def days_between(first, second)
+    first > second ? second + (7 - first) : second - first
+  end
+
+end

data/lib/html_skeleton_table.rb

@@ -0,0 +1,35 @@
+require 'date'
+
+# table methods ######################################################
+class HtmlSkeleton
+ protected
+  def table_header(cols)
+    legend       = @options[:legend]
+    th_attribute = @options[:th_attribute]
+    return ''  unless legend
+
+    proc = @options[:col_legend]
+    col_header = cols.collect { |col|
+      "<th #{th_attribute.call(col)}>#{proc.call(col)}</th>"
+    }.join
+    %Q{<thead><th class="legend">#{legend}</th>#{col_header}</thead>}
+  end
+
+  def table_body(rows, cols)
+    legend       = @options[:legend]
+    row_legend   = @options[:row_legend]
+    tr_attribute = @options[:tr_attribute]
+    rows.collect { |row|
+      rlegend = legend ? %Q{<td class="legend">#{row_legend.call(row)}</td>}
+		       : ''
+      cells = table_row(row, cols)
+      %Q{<tr #{tr_attribute.call(row)}>#{rlegend}#{cells}</tr>}
+    }.join("\n")
+  end
+
+  def table_row(row, cols)
+    cell_proc = @options[:cell_proc]
+    cols.collect { |col|  cell_proc.call(row, col) }.join('')
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2012-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,9 +36,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/html_skeleton.rb
+- lib/html_skeleton_calendar.rb
+- lib/html_skeleton_table.rb
 - README.md
 - MIT-LICENSE
-homepage: 
+homepage: http://matique.de
 licenses: []
 post_install_message: 
 rdoc_options: []