xmlss 0.4.1 → 1.0.0.rc.1

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    xmlss (0.4.1)
+    xmlss (1.0.0.rc.1)
       enumeration (~> 1.3)
-      undies (~> 2.2)
+      undies (~> 2.2.1)
 
 GEM
   remote: http://rubygems.org/
@@ -17,7 +17,7 @@ GEM
     enumeration (1.3.1)
     rake (0.9.2)
     ruby-prof (0.10.8)
-    undies (2.2.0)
+    undies (2.2.1)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -11,7 +11,7 @@ A ruby DSL for generating spreadsheets in the XML Spreadsheet format.  It provid
 
     require 'xmlss'
 
-    workbook = Xmlss::Worksheet.new do
+    workbook = Xmlss::Workbook.new(Xmlss::Writer.new) do
 
       worksheet("5 columns, 1 row") {
         5.times do
@@ -114,7 +114,7 @@ To generate a spreadsheet, create an Xmlss::Workbook instance and build the work
 
 Xmlss evals the build proc in the scope of the workbook instance.  This means that the build has access to only the data it is given or the DSL itself.  Data is given in the form of a Hash.  The string form of the hash keys are exposed as local workbook methods that return their corresponding values.
 
-    Xmlss::Workbook.new(:data => {:sheet_name => 'A cool sheet'}) do
+    Xmlss::Workbook.new(Xmlss::Writer.new, :sheet_name => 'A cool sheet') do
       worksheet(sheet_name) {
         ...
       }
@@ -124,7 +124,7 @@ Xmlss evals the build proc in the scope of the workbook instance.  This means th
 
 Xmlss uses Undies (https://github.com/kelredd/undies) to render the XML output.  The :output Workbook option is used to create Undies::Ouput objects.  See their docs for usage details (https://github.com/kelredd/undies/blob/master/README.rdoc).
 
-    Xmlss::Workbook.new(:output => {:pp => 2}) do
+    Xmlss::Workbook.new(Xmlss::Writer.new(:pp => 2)) do
       worksheet(sheet_name) {
         ...
       }
@@ -137,7 +137,7 @@ The above examples all pass in a build proc that is eval'd in the scope of the w
 To render using this approach, create a Workbook instance passing it data and output info as above.  However, don't pass any build proc and save off the created workbook:
 
     # choosing not to use any local data or output options
-    workbook = Xmlss::Workbook.new
+    workbook = Xmlss::Workbook.new(Xmlss::Writer.new)
 
 Now just interact with the Workbook API directly.
 

data/bench/profiler_runner.rb

@@ -26,7 +26,7 @@ class XmlssProfilerRunner
     end
 
     @result = RubyProf.profile do
-      Xmlss::Workbook.new(:output => {:pp => 2}, &build).to_file("./bench/profiler_#{n}.xml")
+      Xmlss::Workbook.new(Xmlss::Writer.new(:pp => 2), &build).to_file("./bench/profiler_#{n}.xml")
     end
 
   end

data/examples/example_workbook.rb

@@ -5,7 +5,7 @@ class ExampleWorkbook < Xmlss::Workbook
   def initialize(name, &build)
     puts "Building #{name} workbook xml..."
 
-    super(:output => {:pp => 2}, &build)
+    super(Xmlss::Writer.new(:pp => 2), &build)
     self.to_file("./examples/#{name}.xml")
 
     puts "... ready - open in Excel or whatever..."

data/examples/simple.rb

@@ -16,10 +16,27 @@ ExampleWorkbook.new("simple") do
 
       # put data into the row (infer type)
       [1, "text", 123.45, "<>&'\"/", "$45.23"].each do |data_value|
-        cell { data data_value }
+        cell(data_value)
       end
 
     }
   }
 
+  worksheet('2 rows, 2 columns') {
+    2.times do
+      column
+    end
+
+    2.times do
+      row {
+
+        # put data into the row (infer type)
+        [1, 2].each do |data_value|
+          cell { data data_value }
+        end
+
+      }
+    end
+  }
+
 end

data/examples/simple.xml

@@ -29,4 +29,26 @@
       </Row>
     </Table>
   </Worksheet>
+  <Worksheet ss:Name="2 rows, 2 columns">
+    <Table>
+      <Column />
+      <Column />
+      <Row>
+        <Cell>
+          <Data ss:Type="Number">1</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="Number">2</Data>
+        </Cell>
+      </Row>
+      <Row>
+        <Cell>
+          <Data ss:Type="Number">1</Data>
+        </Cell>
+        <Cell>
+          <Data ss:Type="Number">2</Data>
+        </Cell>
+      </Row>
+    </Table>
+  </Worksheet>
 </Workbook>

data/lib/xmlss/element/cell.rb

@@ -1,12 +1,32 @@
+require 'enumeration'
+
 module Xmlss; end
 module Xmlss::Element
   class Cell
 
+    def self.writer; :cell; end
+
     attr_accessor :index, :style_id, :formula, :href, :merge_across, :merge_down
     alias_method :style_i_d, :style_id
     alias_method :h_ref, :href
 
-    def initialize(attrs={}, &build)
+    attr_accessor :data
+
+    include Enumeration
+    enum :type, {
+      :number => "Number",
+      :date_time => "DateTime",
+      :boolean => "Boolean",
+      :string => "String",
+      :error => "Error"
+    }
+
+    def initialize(*args, &build)
+      attrs = args.last.kind_of?(::Hash) ? args.pop : {}
+
+      self.data = args.last.nil? ? (attrs[:data] || "") : args.last
+      self.type = attrs[:type] unless attrs[:type].nil?
+
       self.index = attrs[:index]
       self.style_id = attrs[:style_id]
       self.formula = attrs[:formula]
@@ -15,6 +35,20 @@ module Xmlss::Element
       self.merge_down = attrs[:merge_down] || 0
     end
 
+    def data=(v)
+      self.type = data_type(v)
+      @data = v
+    end
+
+    def data_xml_value
+      case self.data
+      when ::Date, ::Time, ::DateTime
+        self.data.strftime("%Y-%m-%dT%H:%M:%S")
+      else
+        self.data.to_s
+      end
+    end
+
     [:index, :merge_across, :merge_down].each do |meth|
       define_method("#{meth}=") do |value|
         if value && !value.kind_of?(::Fixnum)
@@ -24,5 +58,22 @@ module Xmlss::Element
       end
     end
 
+    private
+
+    def data_type(v)
+      case v
+      when ::Numeric
+        :number
+      when ::Date, ::Time
+        :date_time
+      when ::TrueClass, ::FalseClass
+        :boolean
+      when ::String, ::Symbol
+        :string
+      else
+        :string
+      end
+    end
+
   end
 end

data/lib/xmlss/element/column.rb

@@ -2,6 +2,8 @@ module Xmlss; end
 module Xmlss::Element
   class Column
 
+    def self.writer; :column; end
+
     attr_accessor :style_id, :width, :auto_fit_width, :hidden
     alias_method :style_i_d, :style_id
 

data/lib/xmlss/element/row.rb

@@ -2,6 +2,8 @@ module Xmlss; end
 module Xmlss::Element
   class Row
 
+    def self.writer; :row; end
+
     attr_accessor :style_id, :height, :auto_fit_height, :hidden
     alias_method :style_i_d, :style_id
 

data/lib/xmlss/element/worksheet.rb

@@ -1,23 +1,31 @@
 require 'xmlss/element/column'
 require 'xmlss/element/row'
 require 'xmlss/element/cell'
-require 'xmlss/element/data'
 
 module Xmlss; end
 module Xmlss::Element
   class Worksheet
 
+    def self.writer; :worksheet; end
+
     attr_accessor :name
 
-    def initialize(name, attrs={})
-      self.name = name
+    def initialize(*args)
+      attrs, self.name = [
+        args.last.kind_of?(::Hash) ? args.pop : {},
+        args.last
+      ]
     end
 
     def name=(value)
-      if value.nil? || value.to_s.empty?
-        raise ArgumentError, "'#{name.inspect}' is not a good name for a worksheet"
+      if value.to_s.length > 31
+        raise ArgumentError, "worksheet names must be less than 32 characters long"
+      end
+      @name = if !value.nil? && !value.to_s.empty?
+        sanitized_name(value.to_s)
+      else
+        ""  # TODO: make sure you don't write a worksheet with no sanitized_name
       end
-      @name = sanitized_name(value.to_s)
     end
 
     private

data/lib/xmlss/element_stack.rb

@@ -0,0 +1,69 @@
+module Xmlss
+
+  class 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.
+
+    attr_reader :markup_type
+
+    def initialize(writer, markup_type)
+      @stack = []
+      @writer = writer
+      @markup_type = markup_type
+      @written_level = 0
+    end
+
+    def empty?; @stack.empty?; end
+    def size;   @stack.size;   end
+    def first;  @stack.first;  end
+    def last;   @stack.last;   end
+
+    alias_method :current, :last
+    alias_method :level, :size
+
+    def push(element)
+      if @written_level < level
+        open(current)
+      end
+      @stack.push(element)
+    end
+
+    def pop
+      if !empty?
+        if @written_level < level
+          @stack.pop.tap { |elem| write(elem) }
+        else
+          @stack.pop.tap { |elem| close(elem) }
+        end
+      end
+    end
+
+    def using(element, &block)
+      push(element)
+      (block || Proc.new {}).call
+      pop
+    end
+
+    private
+
+    def open(element)
+      write(element)
+      @writer.push(@markup_type)
+      @written_level += 1
+    end
+
+    def close(element)
+      @writer.pop(@markup_type)
+      @written_level -= 1
+    end
+
+    def write(element)
+      @writer.write(element)
+    end
+
+  end
+
+end

data/lib/xmlss/style/alignment.rb

@@ -3,6 +3,8 @@ require 'xmlss/style/base'
 module Xmlss::Style
   class Alignment
 
+    def self.writer; :alignment; end
+
     include Enumeration
     enum :horizontal, {
       :automatic => "Automatic",

data/lib/xmlss/style/base.rb

@@ -12,6 +12,8 @@ require 'xmlss/style/protection'
 module Xmlss::Style
   class Base
 
+    def self.writer; :style; end
+
     attr_reader :id
     alias_method :i_d, :id
 

data/lib/xmlss/style/border.rb

@@ -1,8 +1,11 @@
 require 'xmlss/style/base'
 
 module Xmlss::Style
+
   class Border
 
+    def self.writer; :border; end
+
     include Enumeration
 
     enum :position, {
@@ -40,4 +43,11 @@ module Xmlss::Style
     end
 
   end
+
+  class Borders
+
+    def self.writer; :borders; end
+
+  end
+
 end

data/lib/xmlss/style/font.rb

@@ -3,6 +3,8 @@ require 'xmlss/style/base'
 module Xmlss::Style
   class Font
 
+    def self.writer; :font; end
+
     include Enumeration
     enum :underline, {
       :single => 'Single',

data/lib/xmlss/style/interior.rb

@@ -3,6 +3,8 @@ require 'xmlss/style/base'
 module Xmlss::Style
   class Interior
 
+    def self.writer; :interior; end
+
     include Enumeration
     enum :pattern, {
       :none => "None",

data/lib/xmlss/style/number_format.rb

@@ -3,6 +3,8 @@ require 'xmlss/style/base'
 module Xmlss::Style
   class NumberFormat
 
+    def self.writer; :number_format; end
+
     attr_accessor :format
 
     def initialize(format=nil)

data/lib/xmlss/style/protection.rb

@@ -3,6 +3,8 @@ require 'xmlss/style/base'
 module Xmlss::Style
   class Protection
 
+    def self.writer; :protection; end
+
     attr_accessor :protect
 
     def initialize(value=nil)

data/lib/xmlss/version.rb

@@ -1,3 +1,3 @@
 module Xmlss
-  VERSION = "0.4.1"
+  VERSION = "1.0.0.rc.1"
 end

data/lib/xmlss/workbook.rb

@@ -1,16 +1,27 @@
-require 'xmlss/undies_writer'
+require 'xmlss/writer'
+require 'xmlss/element_stack'
 require 'xmlss/style/base'
 require 'xmlss/element/worksheet'
 
 module Xmlss
   class Workbook
 
-    # TODO: (writer, data={}, &build)
-    def initialize(opts={}, &build)
+    def self.writer(workbook)
+      workbook.instance_variable_get("@__xmlss_writer")
+    end
+
+    def self.styles_stack(workbook)
+      workbook.instance_variable_get("@__xmlss_styles_stack")
+    end
+
+    def self.worksheets_stack(workbook)
+      workbook.instance_variable_get("@__xmlss_worksheets_stack")
+    end
+
+    def initialize(writer, data={}, &build)
       # (don't pollute workbook scope that the build may run in)
 
       # apply :data options to workbook scope
-      data = (opts || {})[:data] || {}
       if (data.keys.map(&:to_s) & self.public_methods.map(&:to_s)).size > 0
         raise ArgumentError, "data conflicts with workbook public methods."
       end
@@ -18,14 +29,16 @@ module Xmlss
       data.each {|key, value| metaclass.class_eval { define_method(key){value} }}
 
       # setup the Undies xml writer with any :output options
-      @__xmlss_undies_writer = UndiesWriter.new((opts || {})[:output] || {})
+      @__xmlss_writer           = writer
+      @__xmlss_styles_stack     = ElementStack.new(writer, :styles)
+      @__xmlss_worksheets_stack = ElementStack.new(writer, :worksheets)
 
       # run any instance workbook build given
       instance_eval(&build) if build
     end
 
     def to_s
-      @__xmlss_undies_writer.workbook
+      self.class.writer(self).workbook
     end
 
     def to_file(path)
@@ -34,85 +47,89 @@ module Xmlss
       File.exists?(path) ? path : false
     end
 
-    # Workbook elements API
+    # Workbook styles API
 
-    def worksheet(*args, &block)
-      Element::Worksheet.new(*args).tap do |elem|
-        @__xmlss_undies_writer.worksheet(elem, &block)
-      end
+    def style(*args, &block)
+      self.class.styles_stack(self).using(Style::Base.new(*args), &block)
     end
 
-    def column(*args, &block)
-      Element::Column.new(*args).tap do |elem|
-        @__xmlss_undies_writer.column(elem, &block)
-      end
+    def alignment(*args, &block)
+      self.class.styles_stack(self).using(Style::Alignment.new(*args), &block)
     end
 
-    def row(*args, &block)
-      Element::Row.new(*args).tap do |elem|
-        @__xmlss_undies_writer.row(elem, &block)
-      end
+    def borders(*args, &block)
+      self.class.styles_stack(self).using(Style::Borders.new(*args), &block)
     end
 
-    def cell(*args, &block)
-      Element::Cell.new(*args).tap do |elem|
-        @__xmlss_undies_writer.cell(elem, &block)
-      end
+    def border(*args, &block)
+      self.class.styles_stack(self).using(Style::Border.new(*args), &block)
     end
 
-    def data(*args, &block)
-      Element::Data.new(*args).tap do |elem|
-        @__xmlss_undies_writer.data(elem, &block)
-      end
+    def font(*args, &block)
+      self.class.styles_stack(self).using(Style::Font.new(*args), &block)
     end
 
-    # Workbook styles API
-
-    def style(*args, &block)
-      Style::Base.new(*args).tap do |style|
-        @__xmlss_undies_writer.style(style, &block)
-      end
+    def interior(*args, &block)
+      self.class.styles_stack(self).using(Style::Interior.new(*args), &block)
     end
 
-    def alignment(*args, &block)
-      Style::Alignment.new(*args).tap do |style|
-        @__xmlss_undies_writer.alignment(style, &block)
-      end
+    def number_format(*args, &block)
+      self.class.styles_stack(self).using(Style::NumberFormat.new(*args), &block)
     end
 
-    def borders(*args, &block)
-      @__xmlss_undies_writer.borders(&block)
+    def protection(*args, &block)
+      self.class.styles_stack(self).using(Style::Protection.new(*args), &block)
     end
 
-    def border(*args, &block)
-      Style::Border.new(*args).tap do |style|
-        @__xmlss_undies_writer.border(style, &block)
-      end
+    # Workbook elements API
+
+    def worksheet(*args, &block)
+      self.class.worksheets_stack(self).using(Element::Worksheet.new(*args), &block)
     end
 
-    def font(*args, &block)
-      Style::Font.new(*args).tap do |style|
-        @__xmlss_undies_writer.font(style, &block)
-      end
+    def column(*args, &block)
+      self.class.worksheets_stack(self).using(Element::Column.new(*args), &block)
     end
 
-    def interior(*args, &block)
-      Style::Interior.new(*args).tap do |style|
-        @__xmlss_undies_writer.interior(style, &block)
-      end
+    def row(*args, &block)
+      self.class.worksheets_stack(self).using(Element::Row.new(*args), &block)
     end
 
-    def number_format(*args, &block)
-      Style::NumberFormat.new(*args).tap do |style|
-        @__xmlss_undies_writer.number_format(style, &block)
+    def cell(*args, &block)
+      self.class.worksheets_stack(self).using(Element::Cell.new(*args), &block)
+    end
+
+    # Workbook element attributes API
+
+    [ :data,            # cell
+      :type,            # cell
+      :index,           # cell
+      :style_id,        # cell, row, :column
+      :formula,         # cell
+      :href,            # cell
+      :merge_across,    # cell
+      :merge_down,      # cell
+      :height,          # row
+      :auto_fit_height, # row
+      :hidden,          # row, column
+      :width,           # column
+      :auto_fit_width,  # column
+      :name             # worksheet
+    ].each do |a|
+      define_method(a) do |value|
+        if (current_element = self.class.worksheets_stack(self).current)
+          current_element.send("#{a}=", value)
+        end
       end
     end
 
-    def protection(*args, &block)
-      Style::Protection.new(*args).tap do |style|
-        @__xmlss_undies_writer.protection(style, &block)
-      end
+    # overriding to make less noisy
+    def to_str(*args)
+      "#<Xmlss::Workbook:#{self.object_id} " +
+      "current_element=#{self.class.worksheets_stack(self).current.inspect}, " +
+      "current_style=#{self.class.styles_stack(self).current.inspect}>"
     end
+    alias_method :inspect, :to_str
 
   end
 end