tablemaker 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tabletree.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Levin Alexander
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# Tablemaker
+
+HTML table generator that allows arbitrary nested cell subdivisions
+and applies colspan/rowspan as needed.
+
+## Examples
+
+A very basic table:
+
+    # +---+---+
+    # | A | B |
+    # +---+---+
+    # | C | D |
+    # +---+---+
+    #
+    @table2 = Tablemaker.column do |c|
+      c.row do |r|
+        r.cell("A")
+        r.cell("B")
+      end
+      c.row do |r|
+        @c2 = r.cell("C")
+        @d2 = r.cell("D")
+      end
+    end
+
+    # but you can also start with columns and construct the table left-to-right. this produces the exact same result:
+    #
+    Tablemaker.row do |r|
+      r.column do |c|
+        c.cell("A")
+        c.cell("C")
+      end
+      r.column do |c|
+        c.cell("B")
+        c.cell("D")
+      end
+    end
+
+A more advanced example:
+
+    # +---+---+---+
+    # |   | B |   |
+    # |   +---+ C |
+    # |   | D |   |
+    # | A +---+---+
+    # |   |   | F |
+    # |   | E +---+
+    # |   |   | G |
+    # +---+---+---+
+    #
+    @table = Tablemaker.row do |t|
+      t.cell("A")
+      t.column do |r|
+        r.row do |c|
+          c.column do |rr|
+            rr.cell("B")
+            rr.cell("D")
+          end
+          c.cell("C")
+        end
+        r.row do |c|
+          c.cell("E")
+          c.column do |rr|
+            rr.cell("F")
+            rr.cell("G")
+          end
+        end
+      end
+    end
+
+
+this will generate the following output:
+
+    <table>
+      <tr>
+        <td rowspan=4>A</td>
+        <td rowspan=2>B</td>
+        <td>D</td>
+      </tr>
+      <tr>
+        <td>E</td>
+      </tr>
+      <tr>
+        <td rowspan=2>C</td>
+        <td>F</td>
+      </tr>
+      <tr>
+        <td>G</td>
+      </tr>
+    </table>
+
+
+Tablemaker keeps track of all the rowspan/colspan attributes required to generate a valid HTML table
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tablemaker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tablemaker
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+end
+
+task :default => :test
+

data/lib/tablemaker.rb

@@ -0,0 +1,15 @@
+require "tablemaker/version"
+require "tablemaker/frame"
+require 'fiber'
+
+module Tablemaker
+  def self.column(&blk)
+    Column.new(&blk)
+  end
+  def self.row(&blk)
+    Row.new(&blk)
+  end
+
+end
+
+require 'tablemaker/railtie' if defined?(Rails)

data/lib/tablemaker/frame.rb

@@ -0,0 +1,143 @@
+
+module Tablemaker
+  class Frame
+    attr_reader :parent
+    def initialize(parent, idx)
+      @parent = parent
+      @index = idx
+    end
+    def last?
+      return nil unless @parent
+      @index == @parent.items.length-1
+    end
+    def dimensions
+      [columns, rows]
+    end
+    def real_rows
+      return rows unless @parent
+      if @parent.is_a?(Column)
+        return rows unless last?
+        return rows + @parent.real_rows - @parent.rows
+      else
+        @parent.real_rows
+      end
+    end
+    def real_cols
+      return columns unless @parent
+      if @parent.is_a?(Column)
+        @parent.real_cols
+      else
+        return columns unless last?
+        return columns + @parent.real_cols - @parent.columns
+      end
+    end
+    def real_dimensions
+      [real_cols, real_rows]
+    end
+  end
+
+  class Cell < Frame
+    def initialize(parent, idx, data)
+      super(parent, idx)
+      @data = data
+    end
+    def data
+      @data
+    end
+
+    def cell_iterator
+      yield self
+      nil
+    end
+
+    def rows; 1 end
+    def columns; 1 end
+  end
+
+  class Node < Frame
+    attr_reader :items
+    include Enumerable
+
+    def initialize(p=nil, idx = nil)
+      super
+      @items = []
+      yield self
+    end
+
+    def cell(*args)
+      Cell.new(self, @items.length, *args).tap { |c| @items << c }
+    end
+
+    def cells
+      f = Fiber.new do
+        cell_iterator do |i|
+          yield i
+        end
+        nil
+      end
+      f = f.resume while f && f.alive?
+    end
+
+    def each_row
+      items = []
+      f = Fiber.new do
+        cell_iterator do |i|
+          items << i
+        end
+        nil
+      end
+
+      while f && f.alive?
+        f = f.resume
+        yield items unless items.empty?
+        items = []
+      end
+    end
+  end
+
+  class Column < Node
+    def row(&blk)
+      Row.new(self, @items.length, &blk).tap { |r| @items << r }
+    end
+    def columns
+      @items.map(&:columns).max || 0
+    end
+    def rows
+      @items.map(&:rows).inject(0, &:+)
+    end
+
+    def cell_iterator(&blk)
+      @items.each do |i|
+        i.cell_iterator(&blk)
+        Fiber.yield(Fiber.current)
+      end
+      nil
+    end
+  end
+
+  class Row < Node
+    def column(&blk)
+      Column.new(self, @items.length, &blk).tap { |c| @items << c }
+    end
+    def columns
+      @items.map(&:columns).inject(0, &:+)
+    end
+    def rows
+      @items.map(&:rows).max || 0
+    end
+
+    def cell_iterator(&blk)
+      fibers = @items.map do |i|
+        Fiber.new do
+          i.cell_iterator(&blk)
+        end
+      end
+
+      while !fibers.empty?
+        fibers = fibers.map { |f| f.resume }.compact
+        Fiber.yield(Fiber.current)
+      end
+    end
+  end
+
+end

data/lib/tablemaker/railtie.rb

@@ -0,0 +1,14 @@
+require 'tablemaker/view_helpers'
+
+module Tablemaker
+  class Railtie < Rails::Railtie
+    initializer "tablemaker.configure" do |app|
+      ActiveSupport.on_load :action_view do
+        require 'tablemaker/view_helpers'
+        include Tablemaker::ViewHelpers::ActionView
+      end
+    end
+  end
+end
+
+

data/lib/tablemaker/version.rb

@@ -0,0 +1,3 @@
+module Tablemaker
+  VERSION = "0.0.1"
+end

data/lib/tablemaker/view_helpers.rb

@@ -0,0 +1,100 @@
+require 'action_view'
+
+module Tablemaker
+  module ViewHelpers
+    module ActionView
+      class TableHelper
+        def initialize(context, &block)
+          @context = context
+          @stack = []
+          @root = Tablemaker.column do |r|
+            stack(r) do
+              yield self
+            end
+          end
+        end
+
+        def row
+          current.row do |r|
+            stack(r) do
+              yield
+            end
+          end
+        end
+
+        def column(&blk)
+          if @stack.size == 1
+            row do
+              column(&blk)
+            end
+          else
+            current.column do |c|
+              stack(c, &blk)
+            end
+          end
+        end
+
+        def td(*args, &blk)
+          cell("td", *args, &blk)
+        end
+
+        def th(*args, &blk)
+          cell("th", *args, &blk)
+        end
+
+        def to_html(attrs = {})
+          context.content_tag("table", attrs) do
+            @root.each_row do |r|
+              s = context.content_tag("tr") do
+                r.each do |c|
+                  attrs = {}
+                  attrs[:rowspan] = c.real_rows if c.real_rows > 1
+                  attrs[:colspan] = c.real_cols if c.real_cols > 1
+                  s2 = context.content_tag(c.data[:name], c.data[:opts].merge(attrs)) do
+                    c.data[:text]
+                  end
+
+                  context.concat(s2)
+                end
+              end
+              context.concat(s)
+            end
+          end
+        end
+
+
+        private
+
+        def cell(name, *args, &block)
+          opts = args.extract_options!
+          text = if block_given?
+                   @context.capture(&block)
+                 else
+                   args.shift
+                 end
+          current.cell(text: text, name: name, opts: opts)
+        end
+
+        def stack(frame)
+          @stack.push(frame)
+          yield
+          @stack.pop
+        end
+
+        def context
+          @context
+        end
+
+        def current
+          @stack.last
+        end
+
+      end
+
+
+      def make_table(opts = {}, &block)
+        table = TableHelper.new(self, &block).to_html(opts)
+      end
+    end
+  end
+end

data/tablemaker.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tablemaker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Levin Alexander"]
+  gem.email         = ["mail@levinalex.net"]
+  gem.description   = "HTML table generator that allows arbitrary nested cell subdivisions and applies colspan/rowspan as needed."
+
+  gem.summary       = ""
+  gem.homepage      = "https://github.com/levinalex/tablemaker"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "tablemaker"
+  gem.require_paths = ["lib"]
+  gem.version       = Tablemaker::VERSION
+
+  gem.add_dependency "rake"
+  gem.add_dependency "psych"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "rails", ">= 3.1.0"
+end
+

data/test/helper.rb

@@ -0,0 +1,8 @@
+gem 'minitest'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'tablemaker'
+require 'tablemaker/view_helpers'
+

data/test/test_action_view_helper.rb

@@ -0,0 +1,62 @@
+require 'helper'
+
+class TestTableMaker < ActionView::TestCase
+  include Tablemaker::ViewHelpers::ActionView
+
+  setup do
+    ActionView::Base.send(:include, Tablemaker::ViewHelpers::ActionView)
+  end
+
+  test "should integrate with ActiveRecord::Base" do
+    assert_respond_to ActionView::Base.new, :make_table
+  end
+
+  test "should output simple table correctly" do
+    table = make_table(class: "table") do |t|
+            t.row do
+              t.th("A", style: "color: red")
+              t.td("B")
+            end
+          end
+
+    expected = "<table class='table'><tr><th style='color: red'>A</th><td>B</td></tr></table>"
+    assert_dom_equal expected, table
+  end
+
+  test "should output simple table starting with columns correctly" do
+    table = make_table do |t|
+            t.column do
+              t.td("A")
+              t.td("B")
+            end
+          end
+
+    expected = "<table><tr><td>A</td></tr><tr><td>B</td></tr></table>"
+    assert_dom_equal expected, table
+  end
+
+  test "should output complex table correctly" do
+    table = make_table do |t|
+      t.row do
+        t.td("A")
+        t.td("B")
+        t.td("C")
+      end
+      t.row do
+        t.column do
+          t.td("E")
+          t.td("F")
+        end
+        t.td("G")
+      end
+    end
+
+    expected = "<table>" +
+                 "<tr><td>A</td><td>B</td><td>C</td></tr>" +
+                 "<tr><td>E</td><td rowspan=2 colspan=2>G</td></tr>" +
+                 "<tr><td>F</td></tr>" +
+               "</table>"
+
+    assert_dom_equal expected, table
+  end
+end

data/test/test_tablemaker.rb

@@ -0,0 +1,231 @@
+require 'helper'
+
+
+def assert_table_structure(structure, table)
+  structure = structure
+
+  t = []
+  table.each_row do |row|
+    r = []
+    row.each do |cell|
+      r << cell
+    end
+    t << r
+  end
+  assert_equal structure, t
+end
+
+describe "an example table" do
+  before do
+
+    # +---+---+---+
+    # |   | B |   |
+    # |   +---+ C |
+    # |   | D |   |
+    # | A +---+---+
+    # |   |   | F |
+    # |   | E +---+
+    # |   |   | G |
+    # +---+---+---+
+    #
+    @table = Tablemaker.row do |t|
+      @a = t.cell("A")
+      t.column do |r|
+        @row = r.row do |c|
+          @col = c.column do |rr|
+            @b = rr.cell("B")
+            @d = rr.cell("D")
+          end
+          @c = c.cell("C")
+        end
+        r.row do |c|
+          @e = c.cell("E")
+          c.column do |rr|
+            @f = rr.cell("F")
+            @g = rr.cell("G")
+          end
+        end
+      end
+    end
+  end
+
+  it "should compile without errors" do
+    assert @table
+    assert_kind_of Tablemaker::Node, @table
+  end
+
+  it "should return a Row for #row" do
+    assert_kind_of Tablemaker::Row, @row
+    assert_equal 2, @row.rows
+  end
+
+  it "should return a Column for #column" do
+    assert_kind_of Tablemaker::Column, @col
+    assert_equal 1, @col.columns
+    assert_equal 2, @col.rows
+  end
+
+  it "items should have correct dimensions" do
+    assert_equal 4, @table.rows
+    assert_equal 3, @table.columns
+  end
+
+  it "should have real dimensions for cells" do
+    assert_equal [1,4], @a.real_dimensions
+  end
+
+  it "should yield cells in the correct order" do
+    assert_equal [@a, @b, @c, @d, @e, @f, @g], @table.to_enum(:cells).to_a
+  end
+
+  it "should allow iteration over rows/cols" do
+    assert_table_structure [[@a, @b, @c], [@d], [@e, @f], [@g]], @table
+  end
+end
+
+describe "a simple column" do
+  before do
+    @col = Tablemaker.column do |c|
+      c.cell("A")
+      c.cell("B")
+    end
+  end
+
+  it "should have 2 rows, 1 column" do
+    assert_equal 2, @col.rows
+    assert_equal 1, @col.columns
+  end
+end
+
+describe "nested columns" do
+  before do
+    @col = Tablemaker.column do |c|
+      c.cell("A")
+      @row = c.row do |r|
+        r.column do |c2|
+          c2.cell("B")
+          c2.cell("C")
+        end
+      end
+    end
+  end
+
+  it "should have 3 rows, 1 column" do
+    assert_equal 3, @col.rows
+    assert_equal 1, @col.columns
+  end
+end
+
+describe "simple 3/2" do
+  before do
+
+    # +---+---+---+
+    # | A | B | C |
+    # +---+---+---+
+    # | D |   E   |
+    # +---+-------+
+    #
+    @table = Tablemaker.column do |t|
+      @r1 = t.row do |r1|
+        @a = r1.cell("A")
+        @b = r1.cell("B")
+        @c = r1.cell("C")
+      end
+      @r2 = t.row do |r2|
+        @d = r2.cell("D")
+        @e = r2.cell("E")
+      end
+    end
+  end
+end
+
+describe "spanning cols/rows at the same time" do
+  before do
+
+    # +---+---+---+
+    # | A | B | C |
+    # +---+---+---+
+    # | D |       |
+    # +---+   F   |
+    # | E |       |
+    # +---+-------+
+    #
+    @table = Tablemaker.column do |t|
+      @r1 = t.row do |r1|
+        @a = r1.cell("A")
+        @b = r1.cell("B")
+        @c = r1.cell("C")
+      end
+      @r2 = t.row do |r2|
+        @c1 = @c1 = r2.column do |c1|
+          @d = c1.cell("D")
+          @e = c1.cell("E")
+        end
+        @c2 = r2.column do |c2|
+          @f = c2.cell("F")
+        end
+      end
+    end
+  end
+
+  it "should correctly identify last cols" do
+    assert !@r1.last?, "r1 is not last col"
+    assert @r2.last?, "r2 is last col"
+  end
+
+  it "should have correct dimensions on items" do
+    assert_equal [3,3], @table.dimensions
+    assert_equal [3,1], @r1.dimensions
+    assert_equal [1,1], @a.dimensions
+    assert_equal [3,2], @r2.real_dimensions
+    assert_equal [1,2], @c1.real_dimensions
+    assert_equal [2,2], @c2.real_dimensions
+    assert_equal [2,2], @f.real_dimensions
+  end
+
+  it "should iterate correctly over subitems" do
+    assert_equal [@a, @b, @c], @r1.to_enum(:cells).to_a
+    assert_equal [@d, @f, @e], @r2.to_enum(:cells).to_a
+    assert_equal [@a, @b, @c, @d, @f, @e], @table.to_enum(:cells).to_a
+  end
+
+
+  it "should allow iteration over rows/cols" do
+    assert_table_structure [[@a, @b, @c], [@d, @f], [@e]], @table
+  end
+end
+
+describe "starting with rows or columns does not matter" do
+
+  before do
+    @table1 = Tablemaker.row do |r|
+      r.column do |c|
+        @a1 = c.cell("A")
+        @c1 = c.cell("C")
+      end
+      r.column do |c|
+        @b1 = c.cell("B")
+        @d1 = c.cell("D")
+      end
+    end
+
+    @table2 = Tablemaker.column do |c|
+      c.row do |r|
+        @a2 = r.cell("A")
+        @b2 = r.cell("B")
+      end
+      c.row do |r|
+        @c2 = r.cell("C")
+        @d2 = r.cell("D")
+      end
+    end
+  end
+
+  it "should have correct structure" do
+    assert_table_structure [[@a1, @b1], [@c1, @d1]], @table1
+    assert_table_structure [[@a2, @b2], [@c2, @d2]], @table2
+  end
+
+
+end
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: tablemaker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Levin Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: HTML table generator that allows arbitrary nested cell subdivisions and
+  applies colspan/rowspan as needed.
+email:
+- mail@levinalex.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tablemaker.rb
+- lib/tablemaker/frame.rb
+- lib/tablemaker/railtie.rb
+- lib/tablemaker/version.rb
+- lib/tablemaker/view_helpers.rb
+- tablemaker.gemspec
+- test/helper.rb
+- test/test_action_view_helper.rb
+- test/test_tablemaker.rb
+homepage: https://github.com/levinalex/tablemaker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3601937828848287223
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3601937828848287223
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/helper.rb
+- test/test_action_view_helper.rb
+- test/test_tablemaker.rb