osheet 0.10.0 → 1.0.0.rc.1

data/lib/osheet/cell.rb

@@ -1,62 +1,64 @@
 require 'date'
+
 require 'osheet/format'
+require 'osheet/meta_element'
+require 'osheet/styled_element'
 
 module Osheet
   class Cell
-    include Instance
-    include WorkbookElement
-    include WorksheetElement
+
+    include MetaElement
     include StyledElement
-    include MarkupElement
-
-    def initialize(workbook=nil, worksheet=nil, *args, &block)
-      set_ivar(:workbook, workbook)
-      set_ivar(:worksheet, worksheet)
-      set_ivar(:data, nil)
-      set_ivar(:format, Format.new(:general))
-      set_ivar(:rowspan, 1)
-      set_ivar(:colspan, 1)
-      set_ivar(:href, nil)
-      set_ivar(:index, nil)
-      set_ivar(:formula, nil)
-      if block_given?
-        set_binding_ivars(block.binding)
-        instance_exec(*args, &block)
-      end
+
+    def initialize(data_value=nil)
+      @data    = cast_data_value(data_value)
+      @format  = Format.new(:general)
+      @rowspan = 1
+      @colspan = 1
+      @index   = nil
+      @href    = nil
+      @formula = nil
+    end
+
+    def data(value=nil)
+      value.nil? ? @data : @data = cast_data_value(value)
+    end
+
+    def format(value=nil, opts={})
+      value.nil? ? @format : @format = Format.new(value, opts)
+    end
+
+    def rowspan(value=nil)
+      value.nil? ? @rowspan : @rowspan = value
     end
 
-    def data(value)
-      set_ivar(:data, case value
-      when ::String, ::Numeric, ::Date, ::Time, ::DateTime
+    def colspan(value=nil)
+      value.nil? ? @colspan : @colspan = value
+    end
+
+    def index(value=nil)
+      value.nil? ? @index : @index = value
+    end
+
+    def href(value=nil)
+      value.nil? ? @href : @href = value
+    end
+
+    def formula(value=nil)
+      value.nil? ? @formula : @formula = value
+    end
+
+    private
+
+    def cast_data_value(value)
+      case value
+      when ::String, ::Numeric, ::Date, ::Time, ::DateTime, ::NilClass
         value
       when ::Symbol
         value.to_s
       else
         value.inspect.to_s
-      end)
-    end
-
-    def format(type, opts={})
-      set_ivar(:format, Format.new(type, opts))
-    end
-
-    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 formula(value); set_ivar(:formula, value); end
-
-    def attributes
-      {
-        :style_class => get_ivar(:style_class),
-        :data => get_ivar(:data),
-        :format => get_ivar(:format),
-        :colspan => get_ivar(:colspan),
-        :rowspan => get_ivar(:rowspan),
-        :href => get_ivar(:href),
-        :index => get_ivar(:index),
-        :formula => get_ivar(:formula)
-      }
+      end
     end
 
   end

data/lib/osheet/column.rb

@@ -1,40 +1,34 @@
+require 'osheet/meta_element'
+require 'osheet/styled_element'
+
 module Osheet
   class Column
-    include Instance
-    include WorkbookElement
-    include WorksheetElement
-    include StyledElement
+
     include MetaElement
-    include MarkupElement
-
-    def initialize(workbook=nil, worksheet=nil, *args, &block)
-      set_ivar(:workbook, workbook)
-      set_ivar(:worksheet, worksheet)
-      set_ivar(:width, nil)
-      set_ivar(:autofit, false)
-      set_ivar(:hidden, false)
-      if block_given?
-        set_binding_ivars(block.binding)
-        instance_exec(*args, &block)
-      end
+    include StyledElement
+
+    attr_reader :format
+
+    def initialize(width=nil)
+      @width = width
+      @autofit = false
+      @hidden = false
+      @format  = Format.new(:general)
     end
 
     def width(value=nil)
-      !value.nil? ? set_ivar(:width, value) : get_ivar(:width)
+      value.nil? ? @width : @width = value
+    end
+
+    def autofit(value=nil)
+      value.nil? ? @autofit : @autofit = !!value
     end
-    def autofit(value); set_ivar(:autofit, !!value); end
-    def autofit?; get_ivar(:autofit); end
-    def hidden(value); set_ivar(:hidden, !!value); end
-    def hidden?; get_ivar(:hidden); end
-
-    def attributes
-      {
-        :style_class => get_ivar(:style_class),
-        :width => get_ivar(:width),
-        :autofit => get_ivar(:autofit),
-        :hidden => get_ivar(:hidden)
-      }
+    def autofit?; @autofit; end
+
+    def hidden(value=nil)
+      value.nil? ? @hidden : @hidden = !!value
     end
+    def hidden?; @hidden; end
 
   end
 end

data/lib/osheet/format.rb

@@ -13,17 +13,17 @@ require 'osheet/format/custom'
 module Osheet::Format
 
   VALUES = [
-    :general,:number, :currency, :accounting,
+    :general, :number, :currency, :accounting,
     :datetime, :percentage, :fraction, :scientific,
     :text, :special, :custom
   ]
 
   class << self
-    def new(type, opts={})
+    def new(type, *args)
       unless VALUES.include?(type)
         raise ArgumentError, "'#{type.inspect}' is not a valid format type"
       end
-      self.const_get(type.to_s.capitalize).new(opts)
+      self.const_get(type.to_s.capitalize).new(*args)
     end
   end
 

data/lib/osheet/meta_element.rb

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

data/lib/osheet/mixin.rb

@@ -1,36 +1,48 @@
-require 'osheet/style'
-require 'osheet/template'
-
 module Osheet::Mixin
 
   def self.included(receiver)
     receiver.send(:extend, ClassMethods)
   end
 
+  class Args
+
+    attr_reader :args, :build
+
+    def initialize(*args, &build)
+      @args = args
+      @build = build || Proc.new {}
+    end
+
+  end
+
   module ClassMethods
-    def style(*selectors, &block)
+
+    def style(*selectors, &build)
       instance_variable_set("@s",
-        (instance_variable_get("@s") || []) << ::Osheet::Style.new(*selectors, &block)
+        (instance_variable_get("@s") || []) << Args.new(*selectors, &build)
       )
     end
+
     def styles
       instance_variable_get("@s") || []
     end
 
-    def template(element, name, &block)
+    def template(element, name, &build)
       instance_variable_set("@t",
-        (instance_variable_get("@t") || []) << ::Osheet::Template.new(element, name, &block)
+        (instance_variable_get("@t") || []) << Args.new(element, name, &build)
       )
     end
+
     def templates
       instance_variable_get("@t") || []
     end
 
-    def partial(name, &block)
+    def partial(name, &build)
       instance_variable_set("@p",
-        (instance_variable_get("@p") || []) << ::Osheet::Partial.new(name, &block)
+        (instance_variable_get("@p") || []) << Args.new(name, &build)
       )
     end
+
     def partials
       instance_variable_get("@p") || []
     end

data/lib/osheet/partial.rb

@@ -2,23 +2,19 @@ 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
+    # 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 workbook.
 
     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)
+      @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/row.rb

@@ -1,44 +1,40 @@
+require 'osheet/meta_element'
+require 'osheet/styled_element'
+
 require 'osheet/cell'
 
 module Osheet
   class Row
-    include Instance
-    include Associations
-    include WorkbookElement
-    include WorksheetElement
-    include StyledElement
+
     include MetaElement
-    include MarkupElement
-
-    hm :cells
-
-    def initialize(workbook=nil, worksheet=nil, *args, &block)
-      set_ivar(:workbook, workbook)
-      set_ivar(:worksheet, worksheet)
-      set_ivar(:height, nil)
-      set_ivar(:autofit, false)
-      set_ivar(:hidden, false)
-      if block_given?
-        set_binding_ivars(block.binding)
-        instance_exec(*args, &block)
-      end
+    include StyledElement
+
+    attr_reader :cells, :format
+
+    def initialize(height=nil)
+      @height  = height
+      @autofit = false
+      @hidden  = false
+      @cells   = []
+      @format  = Format.new(:general)
     end
 
     def height(value=nil)
-      !value.nil? ? set_ivar(:height, value) : get_ivar(:height)
+      value.nil? ? @height : @height = value
     end
-    def autofit(value); set_ivar(:autofit, !!value); end
-    def autofit?; get_ivar(:autofit); end
-    def hidden(value); set_ivar(:hidden, !!value); end
-    def hidden?; get_ivar(:hidden); end
-
-    def attributes
-      {
-        :style_class => get_ivar(:style_class),
-        :height => get_ivar(:height),
-        :autofit => get_ivar(:autofit),
-        :hidden => get_ivar(:hidden)
-      }
+
+    def autofit(value=nil)
+      value.nil? ? @autofit : @autofit = !!value
+    end
+    def autofit?; @autofit; end
+
+    def hidden(value=nil)
+      value.nil? ? @hidden : @hidden = !!value
+    end
+    def hidden?; @hidden; end
+
+    def cell(cell_obj)
+      @cells << cell_obj
     end
 
   end

data/lib/osheet/style.rb

@@ -2,45 +2,31 @@ module Osheet
   class Style
 
     # this class is essentially a set of collectors for style settings
-    #  each setting collects any arguments passed to it and
-    #  it is up to the drivers to determine how to use the settings
-
-    include Instance
+    # each setting collects any arguments passed to it and
+    # it is up to the writer to determine how to use the settings
 
     BORDER_POSITIONS = [:top, :right, :bottom, :left]
     BORDERS = BORDER_POSITIONS.collect{|p| "border_#{p}".to_sym}
     SETTINGS = [:align, :font, :bg] + BORDERS
 
-    def initialize(*selectors, &block)
-      set_ivar(:selectors, verify(selectors))
-      SETTINGS.each {|setting| set_ivar(setting, [])}
-      if block_given?
-        set_binding_ivars(block.binding)
-        instance_eval(&block)
-      end
-    end
+    attr_reader :selectors, :build
 
-    def selectors
-      get_ivar(:selectors)
+    def initialize(*selectors, &build)
+      @selectors = verify(selectors)
+      @build = build || Proc.new {}
+      SETTINGS.each { |s| instance_variable_set("@#{s}", []) }
     end
 
     SETTINGS.each do |setting|
       define_method(setting) do |*args|
-        set_ivar(setting, get_ivar(setting) + args)
+        instance_variable_get("@#{setting}").tap do |value|
+          instance_variable_set("@#{setting}", value + args) if !args.empty?
+        end
       end
     end
 
     def border(*args)
-      BORDERS.each do |border|
-        send(border, *args)
-      end
-    end
-
-    def attributes
-      SETTINGS.inject({}) do |attrs, s|
-        attrs[s] = get_ivar(s)
-        attrs
-      end
+      BORDERS.each { |border| send(border, *args) }
     end
 
     def match?(style_class)

data/lib/osheet/styled_element.rb

@@ -1,5 +1,13 @@
+module Osheet; end
 module Osheet::StyledElement
-  def style_class(value); set_ivar(:style_class, verify_style_class(value)); end
+
+  def style_class(value=nil)
+    if value.nil?
+      instance_variable_get("@style_class")
+    else
+      instance_variable_set("@style_class", verify_style_class(value))
+    end
+  end
 
   private
 

data/lib/osheet/template.rb

@@ -4,10 +4,8 @@ module Osheet
   class Template < Partial
 
     # 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
-
-    include Instance
+    # if an element is initialized from a template, the template
+    # block will be instance_eval'd for the element being initialized
 
     ELEMENTS = ['worksheet', 'column', 'row', 'cell']
 
@@ -16,12 +14,9 @@ module Osheet
         raise ArgumentError, "you can only define a template for #{ELEMENTS.join(', ')} elements."
       end
 
-      set_ivar(:element, element.to_s)
+      @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/version.rb

@@ -1,3 +1,3 @@
 module Osheet
-  VERSION = "0.10.0"
+  VERSION = "1.0.0.rc.1"
 end

data/lib/osheet/workbook.rb

@@ -1,65 +1,157 @@
-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'
+require 'osheet/partial'
+require 'osheet/template'
+require 'osheet/workbook_element'
+require 'osheet/workbook_api'
 
 module Osheet
+
+
   class Workbook
-    include Instance
-    include Associations
-    include MarkupElement
-
-    hm :worksheets
-
-    def initialize(&block)
-      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)
+
+    # This 'Workbook' class is really just a scope for workbook builds to run
+    # in.  All actually workbook metadata is behavior is handled by the
+    # 'WorkbookElement' class
+
+    class ElementStack < ::Array; end
+
+    include WorkbookApi
+
+    def initialize(writer=nil, data={}, &build)
+      # apply :data options to workbook scope
+      data ||= {}
+      if (data.keys.map(&:to_s) & self.public_methods.map(&:to_s)).size > 0
+        raise ArgumentError, "data conflicts with workbook public methods."
       end
-    end
+      metaclass = class << self; self; end
+      data.each {|key, value| metaclass.class_eval { define_method(key){value} }}
 
-    def title(value=nil)
-      !value.nil? ? set_ivar(:title, value) : get_ivar(:title)
-    end
+      # setup the writer, element stack, and workbook_element
+      writer.bind(self) if writer
+      set_ivar(:writer, writer)
+      set_ivar(:element_stack, Workbook::ElementStack.new)
+      set_ivar(:workbook_element, WorkbookElement.new)
+
+      # push the workbook element onto the element stack
+      element_stack.push(workbook)
 
-    def style(*selectors, &block); push_ivar(:styles, Style.new(*selectors, &block)); end
-    def styles
-      get_ivar(:styles)
+      # run any instance workbook build given
+      instance_eval(&build) if build
     end
-    def template(element, name, &block); push_ivar(:templates, Template.new(element, name, &block)); end
-    def templates
-      get_ivar(:templates)
+
+    def writer
+      get_ivar(:writer)
     end
-    def partial(name, &block); push_ivar(:partials, Partial.new(name, &block)); end
-    def partials
-      get_ivar(:partials)
+
+    def element_stack
+      get_ivar(:element_stack)
     end
 
-    def attributes
-      { :title => get_ivar(:title) }
+    def workbook_element
+      get_ivar(:workbook_element)
     end
+    alias_method :workbook, :workbook_element
 
+    # use a mixin to define its markup handlers (templates, partials, and styles)
+    # in your workbook scope
+    # all blocks in mixins will be instance eval'd in the workbook scope
+    # and should be written as such
     def use(mixin)
-      (mixin.styles || []).each{ |s| push_ivar(:styles, s) }
-      (mixin.templates || []).each{ |t| push_ivar(:templates, t) }
-      (mixin.partials || []).each{ |p| push_ivar(:partials, p) }
+      # templates and partials are just blocks themselves so they just need to
+      # be added to the workbook element
+      # they will be instance eval'd when they get used
+      (mixin.templates || []).each { |mt| template(*mt.args, &mt.build) }
+      (mixin.partials  || []).each { |mp| partial(*mp.args, &mp.build)  }
+
+      # styles not only need to be added to the workbook element, but
+      # any build passed to the style needs to be instance eval'd
+      (mixin.styles || []).each do |ms|
+        StyleBuild.new(self, *ms.args, &ms.build).add do |build|
+          instance_eval(&build)
+        end
+      end
     end
 
-    def writer
-      XmlssWriter::Base.new(:workbook => self)
+    # add partials to dynamically add markup to your workbook
+    # note: you can also define element templates to add element specific
+    # markup to your workbook
+    def add(partial_name, *args)
+      workbook.partials.get(partial_name).tap do |p|
+        instance_exec(*args, &p) if p
+      end
+    end
+
+    # overriding to make less noisy
+    def to_str(*args)
+      "#<Osheet::Workbook:#{self.object_id} @title=#{workbook.title.inspect}, " +
+      "worksheet_count=#{workbook.worksheets.size.inspect}, " +
+      "style_count=#{workbook.styles.size.inspect}>"
     end
+    alias_method :inspect, :to_str
 
-    [:to_data, :to_file].each do |meth|
+    # writers are responsible for defining what each of these methods do
+    # and what they return
+    [:to_s, :to_data, :to_file].each do |meth|
       define_method(meth) {|*args| writer.send(meth, *args) }
     end
 
+    private
+
+    OSHEET_IVAR_NS = "_osheet_"
+
+    def get_ivar(name)
+      instance_variable_get(ivar_name(name))
+    end
+
+    def set_ivar(name, value)
+      instance_variable_set(ivar_name(name), value)
+    end
+
+    def push_ivar(name, value)
+      get_ivar(name) << value
+    end
+
+    def ivar_name(name)
+      "@#{OSHEET_IVAR_NS}#{name}"
+    end
+
+  end
+
+
+
+  class Workbook::ElementStack
+
+    # this class is just a wrapper to Array.  I want to treat this as a
+    # stack of objects for the workbook DSL to reference.  I need to push
+    # an object onto the stack, reference it using the 'current' method,
+    # and pop it off the stack when I'm done.
+
+    def initialize
+      super
+    end
+
+    def push(*args)
+      super
+    end
+
+    def pop(*args)
+      super
+    end
+
+    def current
+      self.last
+    end
+
+    def size(*args)
+      super
+    end
+
+    def using(obj, &block)
+      push(obj)
+      block.call if !block.nil?
+      pop
+    end
+
   end
+
+
 end