osheet 0.5.0 → 0.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    osheet (0.5.0)
+    osheet (0.6.0)
       enumeration (~> 1.1.0)
       xmlss (~> 0.2.0)
 

data/lib/osheet/cell.rb

@@ -7,6 +7,7 @@ module Osheet
     include WorkbookElement
     include WorksheetElement
     include StyledElement
+    include MarkupElement
 
     def initialize(workbook=nil, worksheet=nil, *args, &block)
       set_ivar(:workbook, workbook)
@@ -16,6 +17,7 @@ module Osheet
       set_ivar(:rowspan, 1)
       set_ivar(:colspan, 1)
       set_ivar(:href, nil)
+      set_ivar(:index, nil)
       if block_given?
         set_binding_ivars(block.binding)
         instance_exec(*args, &block)
@@ -40,6 +42,7 @@ module Osheet
     def rowspan(value); set_ivar(:rowspan, value); end
     def colspan(value); set_ivar(:colspan, value); end
     def href(value); set_ivar(:href, value); end
+    def index(value); set_ivar(:index, value); end
 
     def attributes
       {
@@ -48,7 +51,8 @@ module Osheet
         :format => get_ivar(:format),
         :colspan => get_ivar(:colspan),
         :rowspan => get_ivar(:rowspan),
-        :href => get_ivar(:href)
+        :href => get_ivar(:href),
+        :index => get_ivar(:index)
       }
     end
 

data/lib/osheet/column.rb

@@ -5,6 +5,7 @@ module Osheet
     include WorksheetElement
     include StyledElement
     include MetaElement
+    include MarkupElement
 
     def initialize(workbook=nil, worksheet=nil, *args, &block)
       set_ivar(:workbook, workbook)

data/lib/osheet/markup_element.rb

@@ -0,0 +1,22 @@
+module Osheet
+  module MarkupElement
+
+    # markup elements can add partial markup to themselves
+    def add(partial_name, *args)
+      if self.kind_of?(Workbook)
+        # on: workbook
+        if (partial = self.partials.get(partial_name))
+          # add partial
+          instance_exec(*args, &partial)
+        end
+      else
+        # on: worksheet, column, row
+        if self.workbook && (partial = self.workbook.partials.get(partial_name))
+          # add partial
+          instance_exec(*args, &partial)
+        end
+      end
+    end
+
+  end
+end

data/lib/osheet/meta_element.rb

@@ -1,7 +1,7 @@
 module Osheet::MetaElement
 
   def meta(value=nil)
-    value.nil? ? instance_variable_get("@meta") : instance_variable_set("@meta", value)
+    value.nil? ? get_ivar(:meta) : set_ivar(:meta, value)
   end
 
 end

data/lib/osheet/partial.rb

@@ -0,0 +1,24 @@
+module Osheet
+  class Partial < ::Proc
+
+    # this class is essentially a way to define a named definition
+    #  block with arguments.  If the partial is added to an element,
+    #  any markup in it's definition block is applied to the element.
+    #  ie. the definition block will be instance_eval'd on the element.
+
+    include Instance
+
+    def initialize(name)
+      unless name.kind_of?(::String) || name.kind_of?(::Symbol)
+        raise ArgumentError, "please use a string or symbol for the partial name."
+      end
+
+      set_ivar(:name, name.to_s)
+      super()
+    end
+
+    def name; get_ivar(:name); end
+    def name=(v); set_ivar(:name, v); end
+
+  end
+end

data/lib/osheet/partial_set.rb

@@ -0,0 +1,57 @@
+require 'osheet/partial'
+
+module Osheet
+  class PartialSet < ::Hash
+
+    # this class is a Hash that behaves kinda like a set.  I want to
+    #  push partials into the set using the '<<' operator, only allow
+    #  Osheet::Partial objs to be pushed, and then be able to reference
+    #  a particular partial using a key
+
+    def initialize
+      super
+    end
+
+    def <<(partial)
+      if (key = verify(partial))
+        push(key, partial)
+      end
+    end
+
+    # return the named partial
+    def get(name)
+      lookup(key(name.to_s))
+    end
+
+    private
+
+    def lookup(key)
+      self[key]
+    end
+
+    # push the partial onto the key
+    def push(key, partial)
+      self[key] = partial
+    end
+
+    # verify the partial, init and return the key
+    #  otherwise ArgumentError it up
+    def verify(partial)
+      unless partial.kind_of?(Partial)
+        raise ArgumentError, 'you can only push Osheet::Partial objs to the partial set'
+      end
+      pkey = partial_key(partial)
+      self[pkey] ||= nil
+      pkey
+    end
+
+    def partial_key(partial)
+      key(partial.name)
+    end
+
+    def key(name)
+      name.to_s
+    end
+
+  end
+end

data/lib/osheet/row.rb

@@ -8,6 +8,7 @@ module Osheet
     include WorksheetElement
     include StyledElement
     include MetaElement
+    include MarkupElement
 
     hm :cells
 

data/lib/osheet/template.rb

@@ -1,8 +1,9 @@
+require 'osheet/partial'
+
 module Osheet
-  class Template < ::Proc
+  class Template < Partial
 
-    # this class is essentially a way to define a named initializer
-    #  block and associate that with an osheet element
+    # this class is a partial that is associated with an osheet element
     #  if an element is initialized from a template, the template
     #  block will be instance_eval'd for the element being initialized
 
@@ -11,31 +12,16 @@ module Osheet
     ELEMENTS = ['worksheet', 'column', 'row', 'cell']
 
     def initialize(element, name)
-      verify(element, name)
-      set_ivar(:element, element.to_s)
-      set_ivar(:name, name.to_s)
-      super()
-    end
-
-    [:element, :name].each do |meth|
-      define_method(meth) do
-        get_ivar(meth)
-      end
-      define_method("#{meth}=") do |value|
-        set_ivar(meth, value)
-      end
-    end
-
-    private
-
-    def verify(element, name)
       unless element.respond_to?(:to_s) && ELEMENTS.include?(element.to_s)
         raise ArgumentError, "you can only define a template for #{ELEMENTS.join(', ')} elements."
       end
-      unless name.kind_of?(::String) || name.kind_of?(::Symbol)
-        raise ArgumentError, "please use a string or symbol for the template name."
-      end
+
+      set_ivar(:element, element.to_s)
+      super(name)
     end
 
+    def element; get_ivar(:element); end
+    def element=(v); set_ivar(:element, v); end
+
   end
 end

data/lib/osheet/template_set.rb

@@ -1,23 +1,17 @@
+require 'osheet/partial_set'
 require 'osheet/template'
 
 module Osheet
-  class TemplateSet < ::Hash
+  class TemplateSet < PartialSet
 
-    # this class is a Hash that behaves kinda like a set.  I want to
-    #  push templates into the set using the '<<' operator, only allow
-    #  Osheet::Template objs to be pushed, and then be able to reference
-    #  a particular set of templates using a key
+    # this class is a PartialSet that keys off of the template element
+    #  and name.  Only Osheet::Template objs can be pushed, and you reference
+    #  a particular template using a key of
 
     def initialize
       super
     end
 
-    def <<(template)
-      if (key = verify(template))
-        push(key, template)
-      end
-    end
-
     # return the template set for the named element
     def get(element, name)
       lookup(key(element.to_s, name.to_s))
@@ -51,7 +45,7 @@ module Osheet
     end
 
     def key(element, name)
-      [element, name]
+      [element.to_s, name.to_s]
     end
   end
 end

data/lib/osheet/version.rb

@@ -1,3 +1,3 @@
 module Osheet
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/osheet/view_handler.rb

@@ -0,0 +1,2 @@
+require 'osheet/view_handler/tilt' if defined?(Tilt)
+require 'osheet/view_handler/rails' if defined?(Rails)

data/lib/osheet/workbook.rb

@@ -1,6 +1,9 @@
 require 'osheet/instance'
+require 'osheet/associations'
+require 'osheet/markup_element'
 require 'osheet/style_set'
 require 'osheet/template_set'
+require 'osheet/partial_set'
 require 'osheet/worksheet'
 require 'osheet/xmlss_writer'
 
@@ -8,6 +11,7 @@ module Osheet
   class Workbook
     include Instance
     include Associations
+    include MarkupElement
 
     hm :worksheets
 
@@ -15,6 +19,7 @@ module Osheet
       set_ivar(:title, nil)
       set_ivar(:styles, StyleSet.new)
       set_ivar(:templates, TemplateSet.new)
+      set_ivar(:partials, PartialSet.new)
       if block_given?
         set_binding_ivars(block.binding)
         instance_eval(&block)
@@ -33,6 +38,10 @@ module Osheet
     def templates
       get_ivar(:templates)
     end
+    def partial(name, &block); push_ivar(:partials, Partial.new(name, &block)); end
+    def partials
+      get_ivar(:partials)
+    end
 
     def attributes
       { :title => get_ivar(:title) }

data/lib/osheet/worksheet.rb

@@ -7,6 +7,7 @@ module Osheet
     include Associations
     include WorkbookElement
     include MetaElement
+    include MarkupElement
 
     hm :columns
     hm :rows
@@ -34,7 +35,10 @@ module Osheet
       if get_ivar(:workbook) && get_ivar(:workbook).worksheets.collect{|ws| ws.name}.include?(name_value)
         raise ArgumentError, "the sheet name '#{name_value}' is already in use.  choose a sheet name that is not used by another sheet"
       end
-      name_value
+      if name_value.to_s.length > 31
+        raise ArgumentError, "worksheet names must be less than 32 characters long"
+      end
+      name_value.to_s
     end
 
   end

data/lib/osheet/xmlss_writer/elements.rb

@@ -53,6 +53,7 @@ module Osheet::XmlssWriter::Elements
     ::Xmlss::Cell.new({
       :style_id => style_id(ocell.attributes[:style_class], ocell.attributes[:format]),
       :href => ocell.attributes[:href],
+      :index => ocell.attributes[:index],
       :merge_across => cell_merge(ocell.attributes[:colspan]),
       :merge_down => cell_merge(ocell.attributes[:rowspan]),
       :data => data(ocell.attributes[:data])

data/lib/osheet.rb

@@ -3,23 +3,26 @@ module Osheet
   MIME_TYPE = "application/vnd.ms-excel"
 
   class << self
-    # used to register an appropriate template handler
+    # used to register an appropriate view handler
     # and register a mime type if necessary
     def register
       ::Mime::Type.register MIME_TYPE, :xls if defined? ::Mime::Type
-      require 'osheet/template_handler'
+      require 'osheet/view_handler'
     end
   end
 
 end
 
+require 'osheet/instance'
+require 'osheet/partial'
 require 'osheet/associations'
-require 'osheet/workbook_element'
-require 'osheet/worksheet_element'
+require 'osheet/mixin'
+
+require 'osheet/markup_element'
 require 'osheet/styled_element'
 require 'osheet/meta_element'
-require 'osheet/instance'
-require 'osheet/mixin'
+require 'osheet/workbook_element'
+require 'osheet/worksheet_element'
 
 if defined? Rails::Railtie
   require 'osheet/railtie'

data/test/cell_test.rb

@@ -2,8 +2,8 @@ require "test/helper"
 require 'osheet/cell'
 
 module Osheet
-  class CellTest < Test::Unit::TestCase
 
+  class CellTest < Test::Unit::TestCase
     context "Osheet::Cell" do
       subject { Cell.new }
 
@@ -11,7 +11,7 @@ module Osheet
       should_be_a_worksheet_element(Cell)
       should_be_a_workbook_element(Cell)
 
-      should_have_instance_methods :data, :format, :colspan, :rowspan, :href
+      should_have_instance_methods :data, :format, :colspan, :rowspan, :href, :index
 
       should "set it's defaults" do
         assert_equal nil, subject.send(:get_ivar, "data")
@@ -19,57 +19,75 @@ module Osheet
         assert_equal 1,   subject.send(:get_ivar, "colspan")
         assert_equal 1,   subject.send(:get_ivar, "rowspan")
         assert_equal nil,   subject.send(:get_ivar, "href")
+        assert_equal nil,   subject.send(:get_ivar, "index")
       end
 
-      context "that has attributes" do
-        subject do
-          Cell.new do
-            style_class 'more poo'
-            data    "Poo"
-            format  :number
-            colspan 4
-            rowspan 2
-            href "http://www.google.com"
-          end
-        end
+    end
+  end
 
-        should "should set them correctly" do
-          assert_equal "Poo", subject.send(:get_ivar, "data")
-          assert_kind_of Format::Number, subject.send(:get_ivar, "format")
-          assert_equal 4,     subject.send(:get_ivar, "colspan")
-          assert_equal 2,     subject.send(:get_ivar, "rowspan")
-          assert_equal "http://www.google.com", subject.send(:get_ivar, "href")
+  class CellAttributeTest < Test::Unit::TestCase
+    context "a celll that has attributes" do
+      subject do
+        Cell.new do
+          style_class 'more poo'
+          data    "Poo"
+          format  :number
+          colspan 4
+          rowspan 2
+          index 3
+          href "http://www.google.com"
         end
+      end
 
-        should "know it's attribute(s)" do
-          [:style_class, :data, :format, :rowspan, :colspan, :href].each do |a|
-            assert subject.attributes.has_key?(a)
-          end
-          assert_equal "more poo", subject.attributes[:style_class]
-          assert_equal "Poo", subject.attributes[:data]
-          assert_kind_of Format::Number, subject.attributes[:format]
-          assert_equal 4, subject.attributes[:colspan]
-          assert_equal 2, subject.attributes[:rowspan]
-          assert_equal "http://www.google.com", subject.attributes[:href]
+      should "should set them correctly" do
+        assert_equal "Poo", subject.send(:get_ivar, "data")
+        assert_kind_of Format::Number, subject.send(:get_ivar, "format")
+        assert_equal 4,     subject.send(:get_ivar, "colspan")
+        assert_equal 2,     subject.send(:get_ivar, "rowspan")
+        assert_equal 3,     subject.send(:get_ivar, "index")
+        assert_equal "http://www.google.com", subject.send(:get_ivar, "href")
+      end
+
+      should "know it's attribute(s)" do
+        [:style_class, :data, :format, :rowspan, :colspan, :index, :href].each do |a|
+          assert subject.attributes.has_key?(a)
         end
+
+        assert_equal "more poo", subject.attributes[:style_class]
+        assert_equal "Poo", subject.attributes[:data]
+        assert_kind_of Format::Number, subject.attributes[:format]
+        assert_equal 4, subject.attributes[:colspan]
+        assert_equal 2, subject.attributes[:rowspan]
+        assert_equal 3, subject.attributes[:index]
+        assert_equal "http://www.google.com", subject.attributes[:href]
       end
 
+    end
+  end
+
+  class CellDataTest < Test::Unit::TestCase
+    context "A cell" do
+      subject { Cell.new }
+
       should "type cast data strings/symbols" do
         ['a string', :symbol].each do |thing|
           cell = Cell.new{data thing}
           assert_kind_of ::String, cell.send(:get_ivar, "data")
         end
       end
+
       should "type cast data dates" do
         cell = Cell.new{data Date.today}
         assert_kind_of ::Date, cell.send(:get_ivar, "data")
       end
+
       should "type cast data numerics" do
         [1, 1.0].each do |thing|
           cell = Cell.new{data thing}
           assert_kind_of ::Numeric, cell.send(:get_ivar, "data")
         end
       end
+
       should "type cast all other data to string" do
         [Osheet, [:a, 'Aye'], {:a => 'Aye'}].each do |thing|
           cell = Cell.new{data thing}
@@ -78,7 +96,29 @@ module Osheet
       end
 
     end
+  end
 
+  class CellPartialTest < Test::Unit::TestCase
+    context "A workbook that defines column partials" do
+      subject do
+        Workbook.new {
+          partial(:cell_stuff) {
+            style_class 'more poo'
+            data "Poo"
+          }
+
+          worksheet { row { cell {
+            add :cell_stuff
+          } } }
+        }
+      end
+
+      should "add it's partials to it's markup" do
+        assert_equal 'more poo', subject.worksheets.first.rows.first.cells.first.attributes[:style_class]
+        assert_equal 'Poo', subject.worksheets.first.rows.first.cells.first.attributes[:data]
+      end
+
+    end
   end
 
   class CellBindingTest < Test::Unit::TestCase

data/test/column_test.rb

@@ -2,8 +2,8 @@ require "test/helper"
 require "osheet/column"
 
 module Osheet
-  class ColumnTest < Test::Unit::TestCase
 
+  class ColumnTest < Test::Unit::TestCase
     context "Osheet::Column" do
       subject { Column.new }
 
@@ -26,47 +26,56 @@ module Osheet
         assert_equal nil, subject.meta
       end
 
-      context "that has attributes" do
-        subject do
-          Column.new do
-            style_class "more poo"
-            width  100
-            autofit true
-            hidden true
-            meta(
-              {}
-            )
-          end
-        end
+    end
+  end
 
-        should "should set them correctly" do
-          assert_equal 100, subject.send(:get_ivar, "width")
-          assert_equal true, subject.send(:get_ivar, "autofit")
-          assert subject.autofit?
-          assert_equal true, subject.send(:get_ivar, "hidden")
-          assert subject.hidden?
-          assert_equal({}, subject.meta)
+  class ColumnAttributesTest < Test::Unit::TestCase
+    context "that has attributes" do
+      subject do
+        Column.new do
+          style_class "more poo"
+          width  100
+          autofit true
+          hidden true
+          meta(
+            {}
+          )
         end
+      end
 
-        should "know it's width" do
-          subject.width(false)
-          assert_equal false, subject.width
-          subject.width(180)
-          assert_equal 180, subject.width
-          subject.width(nil)
-          assert_equal 180, subject.width
-        end
+      should "should set them correctly" do
+        assert_equal 100, subject.send(:get_ivar, "width")
+        assert_equal true, subject.send(:get_ivar, "autofit")
+        assert subject.autofit?
+        assert_equal true, subject.send(:get_ivar, "hidden")
+        assert subject.hidden?
+        assert_equal({}, subject.meta)
+      end
 
-        should "know it's attribute(s)" do
-          [:style_class, :width, :autofit, :hidden].each do |a|
-            assert subject.attributes.has_key?(a)
-          end
-          assert_equal 'more poo', subject.attributes[:style_class]
-          assert_equal 100, subject.attributes[:width]
-          assert_equal true, subject.attributes[:autofit]
-          assert_equal true, subject.attributes[:hidden]
+      should "know it's attribute(s)" do
+        [:style_class, :width, :autofit, :hidden].each do |a|
+          assert subject.attributes.has_key?(a)
         end
+        assert_equal 'more poo', subject.attributes[:style_class]
+        assert_equal 100, subject.attributes[:width]
+        assert_equal true, subject.attributes[:autofit]
+        assert_equal true, subject.attributes[:hidden]
+      end
+
+    end
+  end
 
+  class ColumnDataTest < Test::Unit::TestCase
+    context "A column" do
+      subject { Column.new }
+
+      should "set it's width" do
+        subject.width(false)
+        assert_equal false, subject.width
+        subject.width(180)
+        assert_equal 180, subject.width
+        subject.width(nil)
+        assert_equal 180, subject.width
       end
 
       should "cast autofit and hidden to bool" do
@@ -76,7 +85,29 @@ module Osheet
       end
 
     end
+  end
 
+  class ColumnPartialTest < Test::Unit::TestCase
+    context "A workbook that defines column partials" do
+      subject do
+        Workbook.new {
+          partial(:column_stuff) {
+            width 200
+            meta(:label => 'awesome')
+          }
+
+          worksheet { column {
+            add :column_stuff
+          } }
+        }
+      end
+
+      should "add it's partials to it's markup" do
+        assert_equal 200, subject.worksheets.first.columns.first.width
+        assert_equal({:label => 'awesome'}, subject.worksheets.first.columns.first.meta)
+      end
+
+    end
   end
 
   class ColumnBindingTest < Test::Unit::TestCase

data/test/env.rb

@@ -6,4 +6,5 @@
   $LOAD_PATH.unshift(full_path) unless $LOAD_PATH.include?(full_path)
 end
 
+puts "osheet require"
 require 'osheet'