xmlss 1.0.0.rc.3 → 1.0.0.rc.4

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    xmlss (1.0.0.rc.3)
+    xmlss (1.0.0.rc.4)
       enumeration (~> 1.3)
-      undies (~> 3.0.0.rc.2)
+      undies (~> 3.0.0.rc.3)
 
 GEM
   remote: http://rubygems.org/
@@ -16,7 +16,7 @@ GEM
     enumeration (1.3.1)
     rake (0.9.2)
     ruby-prof (0.10.8)
-    undies (3.0.0.rc.2)
+    undies (3.0.0.rc.3)
     whysoslow (0.0.2)
       ansi (~> 1.4)
 

data/README.rdoc

@@ -106,25 +106,26 @@ protection(value):
 
 == Usage
 
-To generate a spreadsheet, create an Xmlss::Workbook instance and build the workbook using the above DSL.  Workbook takes two optional parameters:
-* opts: hash: :data, :output
-* &build: proc containing DSL directives
+To generate a spreadsheet, create an Xmlss::Workbook instance and build the workbook using the above DSL.  Workbook takes three parameters:
+* Xmlss::Writer instance
+* data hash: (optional) key value data to bind to the workbook scope
+* build block: (optional) block containing DSL directives
 
-=== Data option
+=== Writer (Undies)
 
-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.
+The Xmlss::Writer uses Undies (https://github.com/kellyredding/undies) to write the XML output.  The writer takes Undies::IO options.  See the Undies README for usage details.
 
-    Xmlss::Workbook.new(Xmlss::Writer.new, :sheet_name => 'A cool sheet') do
-      worksheet(sheet_name) {
+    Xmlss::Workbook.new(Xmlss::Writer.new(:pp => 2)) do
+      worksheet('A cool sheet') {
         ...
       }
     end
 
-=== Output option (Undies)
+=== Data hash
 
-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 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(Xmlss::Writer.new(:pp => 2)) do
+    Xmlss::Workbook.new(Xmlss::Writer.new, :sheet_name => 'A cool sheet') do
       worksheet(sheet_name) {
         ...
       }
@@ -155,7 +156,9 @@ Now just interact with the Workbook API directly.
 
 == Disclaimer
 
-Be aware this library only provides the basic, raw API for constructing spreadsheets using this spec and utilities to convert those objects to string xml data representing them.  It does not provide any macro logic to aid in constructing the sheets.  If you want a more convenient API for your use case, I suggest subclassing the objects and tailoring them to your needs.
+Be aware this library only provides the basic, raw API for constructing spreadsheets using this spec and utilities to convert those objects to string xml data representing them.  It does not provide any macro logic to aid in constructing the sheets.  If you want a more convenient API for your use case, I suggest extending the objects and tailoring them to your needs.
+
+You may also be interested in osheet-xmlss (https://github.com/kellyredding/osheet-xmlss).  I wrote this to use the more convenient Osheet workbook syntax to generate Xmlss workbooks.
 
 The XML Spreadsheet spec and format are legacy and may have limited support depending on your version of MS Excel.  For a more modern spreadsheet generation method, I suggest looking into Office Open XML Workbook format (http://en.wikipedia.org/wiki/Office_Open_XML).
 

data/lib/xmlss/element/column.rb

@@ -20,5 +20,11 @@ module Xmlss::Element
       @width = value && value < 0 ? nil : value
     end
 
+    def autofit;         self.auto_fit_width;         end
+    def autofit=(value); self.auto_fit_width = value; end
+
+    def autofit?; !!self.autofit; end
+    def hidden?;  !!self.hidden;  end
+
   end
 end

data/lib/xmlss/element/row.rb

@@ -20,5 +20,11 @@ module Xmlss::Element
       @height = value && value < 0 ? nil : value
     end
 
+    def autofit;         self.auto_fit_height;         end
+    def autofit=(value); self.auto_fit_height = value; end
+
+    def autofit?; !!self.autofit; end
+    def hidden?;  !!self.hidden;  end
+
   end
 end

data/lib/xmlss/version.rb

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

data/lib/xmlss/workbook.rb

@@ -101,63 +101,65 @@ module Xmlss
 
     # Workbook element attributes API
 
-    def style_id(value)  # cell, row, column
-      # check to make sure there is a current on this one
-      if (c = self.class.worksheets_stack(self).current)
-        c.style_id = value
-      end
+    def merge_across(value)  # cell
+      self.class.worksheets_stack(self).current.merge_across = value
     end
 
-    def data(value)  # cell
-      self.class.worksheets_stack(self).current.data = value
+    def merge_down(value)  # cell
+      self.class.worksheets_stack(self).current.merge_down = value
     end
 
-    def type(value)  # cell
-      self.class.worksheets_stack(self).current.type = value
+    def name(value)  # worksheet
+      self.class.worksheets_stack(self).current.name = value
     end
 
-    def index(value)  # cell
-      self.class.worksheets_stack(self).current.index = value
+    def style_id(value)  # cell, row, column
+      # check to make sure there is a current on this one
+      if (c = self.class.worksheets_stack(self).current)
+        c.style_id = value
+      end
     end
 
-    def formula(value)  # cell
-      self.class.worksheets_stack(self).current.formula = value
+    def width(value)  # column
+      self.class.worksheets_stack(self).current.width = value
     end
 
-    def href(value)  # cell
-      self.class.worksheets_stack(self).current.href = value
+    def height(value)  # row
+      self.class.worksheets_stack(self).current.height = value
     end
 
-    def merge_across(value)  # cell
-      self.class.worksheets_stack(self).current.merge_across = value
+    def autofit(value)  # column, row
+      self.class.worksheets_stack(self).current.autofit = value
     end
+    alias_method :auto_fit_width,  :autofit
+    alias_method :auto_fit_height, :autofit
 
-    def merge_down(value)  # cell
-      self.class.worksheets_stack(self).current.merge_down = value
+    def autofit?
+      self.class.worksheets_stack(self).current.autofit?
     end
 
-    def height(value)  # row
-      self.class.worksheets_stack(self).current.height = value
+    def hidden(value)  # row, column
+      self.class.worksheets_stack(self).current.hidden = value
     end
 
-    def auto_fit_height(value)  # row
-      self.class.worksheets_stack(self).current.auto_fit_height = value
+    def hidden?
+      self.class.worksheets_stack(self).current.hidden?
     end
 
-    def hidden(value)  # row, column
-      self.class.worksheets_stack(self).current.hidden = value
+    def data(value)  # cell
+      self.class.worksheets_stack(self).current.data = value
     end
 
-    def width(value)  # column
-      self.class.worksheets_stack(self).current.width = value
+    def href(value)  # cell
+      self.class.worksheets_stack(self).current.href = value
     end
 
-    def auto_fit_width(value)  # column
-      self.class.worksheets_stack(self).current.auto_fit_width = value
+    def formula(value)  # cell
+      self.class.worksheets_stack(self).current.formula = value
     end
 
-    def name(value)  # worksheet
-      self.class.worksheets_stack(self).current.name = value
+    def index(value)  # cell
+      self.class.worksheets_stack(self).current.index = value
     end
 
     # overriding to make less noisy

data/test/element/column_test.rb

@@ -10,7 +10,8 @@ module Xmlss::Element
 
     should be_styled
     should have_class_method :writer
-    should have_accessor :width, :auto_fit_width, :hidden
+    should have_accessors :width, :auto_fit_width, :autofit, :hidden
+    should have_readers   :autofit?, :hidden?
 
     should "know its writer hook" do
       assert_equal :column, subject.class.writer

data/test/element/row_test.rb

@@ -10,7 +10,9 @@ module Xmlss::Element
 
     should be_styled
     should have_class_method :writer
-    should have_accessors :height, :auto_fit_height, :hidden
+    should have_accessors :height, :auto_fit_height, :autofit, :hidden
+    should have_readers   :autofit?, :hidden?
+
 
     should "know its writer hook" do
       assert_equal :row, subject.class.writer

data/test/workbook_test.rb

@@ -16,11 +16,11 @@ module Xmlss::Worbook
 
     should have_instance_methods :worksheet, :column, :row, :cell
 
-    should have_instance_methods :data, :type
-    should have_instance_methods :index, :style_id, :formula, :href
-    should have_instance_methods :merge_across, :merge_down, :height
-    should have_instance_methods :auto_fit_height, :hidden, :width
-    should have_instance_methods :auto_fit_width, :name
+    should have_instance_methods :data, :index, :style_id, :formula, :href, :name
+    should have_instance_methods :merge_across, :merge_down, :height, :width
+    should have_instance_methods :hidden, :hidden?
+    should have_instance_methods :autofit, :autofit?
+    should have_instance_methods :auto_fit_height, :auto_fit_width
 
     should "return element objs when calling its element methods" do
       assert_kind_of Xmlss::Element::Worksheet, subject.worksheet('test')

data/xmlss.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("assert", ["~> 0.7.3"])
   s.add_development_dependency("assert-view", ["~> 0.6"])
-  s.add_dependency("undies", ["~> 3.0.0.rc.2"])
+  s.add_dependency("undies", ["~> 3.0.0.rc.3"])
   s.add_dependency("enumeration", ["~> 1.3"])
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: xmlss
 version: !ruby/object:Gem::Version 
-  hash: 15424051
+  hash: 15424061
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - rc
-  - 3
-  version: 1.0.0.rc.3
+  - 4
+  version: 1.0.0.rc.4
 platform: ruby
 authors: 
 - Kelly Redding
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-18 00:00:00 Z
+date: 2012-05-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -57,14 +57,14 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15424113
+        hash: 15424115
         segments: 
         - 3
         - 0
         - 0
         - rc
-        - 2
-        version: 3.0.0.rc.2
+        - 3
+        version: 3.0.0.rc.3
   name: undies
   version_requirements: *id003
   prerelease: false