osheet 0.9.2 → 0.10.0

data/lib/osheet/xmlss_writer/styles.rb

@@ -3,48 +3,79 @@ module Osheet::XmlssWriter::Styles
 
   protected
 
-  def style_id(style_class, oformat=nil)
-    oformat ||= Osheet::Format.new(:general)
-    (xmlss_style = style(style_class, oformat)).nil? ? '' : xmlss_style.id
+  def style_id(xworkbook, style_class, oformat=nil)
+    xstyle = style(xworkbook, style_class, oformat)
+    xstyle.nil? ? '' : xstyle.id
   end
 
-  def style(style_class, oformat=nil)
+  def style(xworkbook, style_class, oformat=nil)
     oformat ||= Osheet::Format.new(:general)
+
+    # generate the style key for the given class/format
     key = style_key(style_class, oformat.key)
-    xmlss_style = @styles.find{|style| style.id == key}
-    if !key.empty? && xmlss_style.nil?
-      settings = style_settings(key)
-      @styles << (xmlss_style = ::Xmlss::Style::Base.new(key) {
-        if settings.has_key?(:align) && !settings[:align].empty?
-          alignment(settings[:align])
-        end
-        if settings.has_key?(:font) && !settings[:font].empty?
-          font(settings[:font])
-        end
-        if settings.has_key?(:bg) && !settings[:bg].empty?
-          interior(settings[:bg])
-        end
-        ::Osheet::Style::BORDERS.each do |bp|
-          if settings.has_key?(bp) && !settings[bp].empty?
-            border(settings[bp])
-          end
-        end
-        if oformat
-          number_format(:format => oformat.style)
-        end
-      })
+
+    # see if we have already created/used an xmlss style for the given key
+    xstyle = @used_xstyles.find{ |xs| xs.id == key }
+
+    # if not, create an xmlss style for the key and add it to the used cache
+    if !key.empty? && xstyle.nil?
+      xstyle = xmlss_style(xworkbook, key, oformat)
+      @used_xstyles << xstyle
     end
-    xmlss_style
+
+    xstyle
   end
 
+  private
+
   def style_key(style_class, format_key)
     (style_class || '').strip.split(/\s+/).collect do |c|
       ".#{c}"
     end.join('') + (format_key.nil? || format_key.empty? ? '' : "..#{format_key}")
   end
 
+  def xmlss_style(xworkbook, key, oformat)
+    # take all the matching osheet styles for the given key,
+    # and build up xmlss style settings for them
+    settings = style_settings(key)
+
+    xworkbook.style(key) do
+
+      if settings.has_key?(:align) && !settings[:align].empty?
+        xworkbook.alignment(settings[:align])
+      end
+
+      if settings.has_key?(:font) && !settings[:font].empty?
+        xworkbook.font(settings[:font])
+      end
+
+      if settings.has_key?(:bg) && !settings[:bg].empty?
+        xworkbook.interior(settings[:bg])
+      end
+
+      border_set = ::Osheet::Style::BORDERS.inject([]) do |set, bp|
+        if settings.has_key?(bp) && !settings[bp].empty?
+          set << settings[bp]
+        end
+        set
+      end
+      if !border_set.empty?
+        xworkbook.borders {
+          border_set.each { |border_setting| xworkbook.border(border_setting) }
+        }
+      end
+
+      if oformat
+        xworkbook.number_format(oformat.style)
+      end
+
+    end
+  end
+
+  # TODO: would be nice to have a class handle all of the osheet-xmlss style translations...
+
   def style_settings(key)
-    @ostyles.for(key).inject({}) do |style_settings, ostyle|
+    @oworkbook.styles.for(key).inject({}) do |style_settings, ostyle|
       merged_settings(style_settings, ostyle_settings(ostyle))
     end
   end

data/osheet.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.version     = Osheet::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kelly Redding"]
-  s.email       = ["kelly@kelredd.com"]
-  s.homepage    = "http://github.com/kelredd/osheet"
+  s.email       = ["kelly@kellyredding.com"]
+  s.homepage    = "http://github.com/kellyredding/osheet"
   s.summary     = %q{A DSL for specifying and generating spreadsheets using Ruby}
   s.description = %q{A DSL for specifying and generating spreadsheets using Ruby}
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("bundler", ["~> 1.0"])
   s.add_development_dependency("assert", ["~> 0.3"])
-  s.add_dependency("enumeration", ["~> 1.2"])
-  s.add_dependency("xmlss", ["~> 0.2"])
+  s.add_dependency("enumeration", ["~> 1.3"])
+  s.add_dependency("xmlss", ["~> 0.4"])
 
 end

data/test/helper.rb

@@ -6,6 +6,15 @@ $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 require 'osheet'
 
 class Assert::Context
+
+  def xstyle_markup(xworkbook)
+    xworkbook.instance_variable_get("@__xmlss_undies_writer").flush.style_markup
+  end
+
+  def xelement_markup(xworkbook)
+    xworkbook.instance_variable_get("@__xmlss_undies_writer").flush.element_markup
+  end
+
   class << self
 
 

data/test/xmlss_writer/base_test.rb

@@ -8,13 +8,13 @@ module Osheet
     before { @writer = XmlssWriter::Base.new }
     subject { @writer }
 
-    should have_readers :workbook, :styles
-    should have_writer :workbook
+    should have_readers :used_xstyles
+    should have_writer :oworkbook
+    should have_instance_methods :xworkbook
 
   end
 
-  class XmlssWriter::WorkbookTest < XmlssWriter::BaseTest
-    desc "workbook"
+  class XmlssWriter::WorkbookTests < XmlssWriter::BaseTest
     before do
       @workbook = Workbook.new {
         title "xmlss"
@@ -24,10 +24,10 @@ module Osheet
 
     should "only allow writing an Osheet::Workbook" do
       assert_nothing_raised do
-        subject.workbook = @workbook
+        subject.oworkbook = @workbook
       end
       assert_raises ArgumentError do
-        subject.workbook = "poo"
+        subject.oworkbook = "poo"
       end
     end
 
@@ -42,16 +42,18 @@ module Osheet
     end
 
     should "create an Xmlss workbook" do
-      assert_nothing_raised do
-        subject.workbook = @workbook
-      end
-      assert_kind_of ::Xmlss::Workbook, subject.workbook
-      assert_equal @workbook.worksheets.size, subject.workbook.worksheets.size
+      subject.oworkbook = @workbook
+      assert_kind_of ::Xmlss::Workbook, subject.xworkbook
+
+      assert_equal(
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Workbook xmlns=\"urn:schemas-microsoft-com:office:spreadsheet\" xmlns:ss=\"urn:schemas-microsoft-com:office:spreadsheet\"><Styles></Styles><Worksheet ss:Name=\"testsheet1\"><Table></Table></Worksheet></Workbook>",
+        subject.xworkbook.to_s
+      )
     end
 
   end
 
-  class XmlssWriter::ToDataTest < Assert::Context
+  class XmlssWriter::ToFileTests < Assert::Context
     desc "XmlssWriter::Base"
     before do
       @writer = XmlssWriter::Base.new({

data/test/xmlss_writer/elements_test.rb

@@ -1,4 +1,5 @@
 require "assert"
+
 require 'osheet/xmlss_writer'
 
 module Osheet
@@ -6,47 +7,92 @@ module Osheet
   class XmlssWriter::ElementsTest < Assert::Context
     before do
       @writer = XmlssWriter::Base.new
+      @xworkbook = ::Xmlss::Workbook.new
     end
     subject { @writer }
 
   end
 
-  class XmlssWriter::WorksheetTest < XmlssWriter::ElementsTest
-    desc "when writing a worksheet"
+  class XmlssWriter::CellTests < XmlssWriter::ElementsTest
+    desc "when writing a cell"
     before do
-      @worksheet = Worksheet.new {
-        name "testsheet2"
-        column { width 100 }
-        row { height 50 }
-      }
+      @cell = Osheet::Cell.new do
+        style_class "awesome thing"
+        data    100
+        format  :number
+        href    'http://example.com'
+        rowspan 2
+        colspan 5
+        index 3
+        formula "=R1C1"
+      end
+      @xmlss_cell = subject.send(:cell, @xworkbook, @cell)
     end
 
-    should "create an Xmlss worksheet" do
-      xmlss_worksheet = subject.send(:worksheet, @worksheet)
-      assert_kind_of ::Xmlss::Worksheet, xmlss_worksheet
-      assert_equal @worksheet.attributes[:name], xmlss_worksheet.name
-      assert_kind_of ::Xmlss::Table, xmlss_worksheet.table
-      assert_equal @worksheet.columns.size, xmlss_worksheet.table.columns.size
-      assert_equal @worksheet.rows.size, xmlss_worksheet.table.rows.size
+    should "create an Xmlss cell with appropriate attributes" do
+      assert_kind_of ::Xmlss::Element::Cell, @xmlss_cell
+      assert_equal 'http://example.com', @xmlss_cell.href
+      assert_equal 3, @xmlss_cell.index
+      assert_equal "=R1C1", @xmlss_cell.formula
+      assert_equal 1, @xmlss_cell.merge_down
+      assert_equal 4, @xmlss_cell.merge_across
     end
 
-    should "filter invalid worksheet names" do
-      { 'valid name' => 'valid name',
-        'valid 2' => 'valid 2',
-        'invalid :' => 'invalid ',
-        'invalid ;' => 'invalid ',
-        'invalid *' => 'invalid ',
-        'invalid /' => 'invalid ',
-        'invalid \\' => 'invalid ',
-        '[invalid]' => "invalid]"
-      }.each do |k,v|
-        assert_equal v, subject.send(:worksheet, Worksheet.new { name k}).name
+    should "style an Xmlss cell" do
+      assert_equal ".awesome.thing..number_none_0_nocomma_black", @xmlss_cell.style_id
+      assert_equal 1, subject.used_xstyles.size
+      assert_kind_of ::Xmlss::Style::Base, subject.used_xstyles.first
+      assert_equal @xmlss_cell.style_id, subject.used_xstyles.first.id
+    end
+
+    should "write row element markup" do
+      assert_equal(
+        "<Cell ss:Formula=\"=R1C1\" ss:HRef=\"http://example.com\" ss:Index=\"3\" ss:MergeAcross=\"4\" ss:MergeDown=\"1\" ss:StyleID=\".awesome.thing..number_none_0_nocomma_black\"><Data ss:Type=\"Number\">100</Data></Cell>",
+        xelement_markup(@xworkbook)
+      )
+    end
+
+  end
+
+  class XmlssWriter::RowTests < XmlssWriter::ElementsTest
+    desc "when writing a row"
+    before do
+      @row = Osheet::Row.new do
+        style_class "awesome thing"
+        height  100
+        autofit true
+        hidden true
+        cell {
+          data  'one hundred'
+        }
       end
+      @xmlss_row = subject.send(:row, @xworkbook, @row)
+    end
+
+    should "create an Xmlss row" do
+      assert_kind_of ::Xmlss::Element::Row, @xmlss_row
+      assert_equal @row.attributes[:height], @xmlss_row.height
+      assert_equal @row.attributes[:autofit], @xmlss_row.auto_fit_height
+      assert_equal @row.attributes[:hidden], @xmlss_row.hidden
+    end
+
+    should "style an Xmlss row" do
+      assert_equal ".awesome.thing", @xmlss_row.style_id
+      assert_equal 1, subject.used_xstyles.size
+      assert_kind_of ::Xmlss::Style::Base, subject.used_xstyles.first
+      assert_equal @xmlss_row.style_id, subject.used_xstyles.first.id
+    end
+
+    should "write row element markup" do
+      assert_equal(
+        "<Row ss:AutoFitHeight=\"1\" ss:Height=\"100\" ss:Hidden=\"1\" ss:StyleID=\".awesome.thing\"><Cell><Data ss:Type=\"String\">one hundred</Data></Cell></Row>",
+        xelement_markup(@xworkbook)
+      )
     end
 
   end
 
-  class XmlssWriter::ColumnTest < XmlssWriter::ElementsTest
+  class XmlssWriter::ColumnTests < XmlssWriter::ElementsTest
     desc "when writing a column"
     before do
       @column = Osheet::Column.new {
@@ -58,11 +104,11 @@ module Osheet
          :color => 'blue'
         })
       }
-      @xmlss_column = subject.send(:column, @column)
+      @xmlss_column = subject.send(:column, @xworkbook, @column)
     end
 
     should "create an Xmlss column" do
-      assert_kind_of ::Xmlss::Column, @xmlss_column
+      assert_kind_of ::Xmlss::Element::Column, @xmlss_column
       assert_equal @column.attributes[:width], @xmlss_column.width
       assert_equal @column.attributes[:autofit], @xmlss_column.auto_fit_width
       assert_equal @column.attributes[:hidden], @xmlss_column.hidden
@@ -70,104 +116,57 @@ module Osheet
 
     should "style an Xmlss column" do
       assert_equal ".awesome", @xmlss_column.style_id
-      assert_equal 1, subject.styles.size
-      assert_kind_of ::Xmlss::Style::Base, subject.styles.first
-      assert_equal @xmlss_column.style_id, subject.styles.first.id
-    end
-  end
-
-  class XmlssWriter::RowTest < XmlssWriter::ElementsTest
-    desc "when writing a row"
-    before do
-      @row = Osheet::Row.new do
-        style_class "awesome thing"
-        height  100
-        autofit true
-        hidden true
-        cell {
-          data  'one hundred'
-        }
-      end
-      subject.workbook = Workbook.new {
-        style('.awesome') {
-          font 14
-        }
-        style('.thing') {
-          font :italic
-        }
-        style('.awesome.thing') {
-          font :bold
-        }
-      }
-      @xmlss_row = subject.send(:row, @row)
+      assert_equal 1, subject.used_xstyles.size
+      assert_kind_of ::Xmlss::Style::Base, subject.used_xstyles.first
+      assert_equal @xmlss_column.style_id, subject.used_xstyles.first.id
     end
 
-    should "create an Xmlss row" do
-      assert_kind_of ::Xmlss::Row, @xmlss_row
-      assert_equal @row.attributes[:height], @xmlss_row.height
-      assert_equal @row.attributes[:autofit], @xmlss_row.auto_fit_height
-      assert_equal @row.attributes[:hidden], @xmlss_row.hidden
-      assert_equal 1, @xmlss_row.cells.size
+    should "write column element markup" do
+      assert_equal(
+        "<Column ss:AutoFitWidth=\"1\" ss:Hidden=\"1\" ss:StyleID=\".awesome\" ss:Width=\"100\" />",
+        xelement_markup(@xworkbook)
+      )
     end
 
-    should "style an Xmlss row" do
-      assert_equal ".awesome.thing", @xmlss_row.style_id
-      assert_equal 1, subject.styles.size
-      assert_kind_of ::Xmlss::Style::Base, subject.styles.first
-      assert_equal @xmlss_row.style_id, subject.styles.first.id
-      assert_equal 14, subject.styles.first.font.size
-      assert_equal true, subject.styles.first.font.bold?
-      assert_equal true, subject.styles.first.font.italic?
-    end
   end
 
-  class XmlssWriter::CellTest < XmlssWriter::ElementsTest
-    desc "when writing a cell"
+  class XmlssWriter::WorksheetTests < XmlssWriter::ElementsTest
+    desc "when writing a worksheet"
     before do
-      @cell = Osheet::Cell.new do
-        style_class "awesome thing"
-        data    100
-        format  :number
-        href    'http://example.com'
-        rowspan 2
-        colspan 5
-        index 3
-        formula "=R1C1"
+      @worksheet = Worksheet.new do
+        name "testsheet2"
+        column { width 100 }
+        row { height 50 }
       end
-      subject.workbook = Workbook.new {
-        style('.awesome') {
-          font 14
-        }
-        style('.thing') {
-          font :italic
-        }
-        style('.awesome.thing') {
-          font :bold
-        }
-      }
-      @xmlss_cell = subject.send(:cell, @cell)
     end
 
-    should "create an Xmlss cell with appropriate data" do
-      assert_kind_of ::Xmlss::Cell, @xmlss_cell
-      assert_kind_of ::Xmlss::Data, @xmlss_cell.data
-      assert_equal @cell.attributes[:data], @xmlss_cell.data.value
-      assert_equal ::Xmlss::Data.type(:number), @xmlss_cell.data.type
-      assert_equal 'http://example.com', @xmlss_cell.href
-      assert_equal 3, @xmlss_cell.index
-      assert_equal "=R1C1", @xmlss_cell.formula
+    should "create an Xmlss worksheet" do
+      xmlss_worksheet = subject.send(:worksheet, @xworkbook, @worksheet)
+      assert_kind_of ::Xmlss::Element::Worksheet, xmlss_worksheet
     end
 
-    should "handle rowspan and colspan" do
-      assert_equal 1, @xmlss_cell.merge_down
-      assert_equal 4, @xmlss_cell.merge_across
+    should "filter invalid worksheet names" do
+      { 'valid name' => 'valid name',
+        'valid 2' => 'valid 2',
+        'invalid :' => 'invalid ',
+        'invalid ;' => 'invalid ',
+        'invalid *' => 'invalid ',
+        'invalid /' => 'invalid ',
+        'invalid \\' => 'invalid ',
+        '[invalid]' => "invalid]"
+      }.each do |k,v|
+        assert_equal v, subject.send(:worksheet,  @xworkbook, Worksheet.new { name k }).name
+      end
     end
 
-    should "style an Xmlss cell" do
-      assert_equal ".awesome.thing..number_none_0_nocomma_black", @xmlss_cell.style_id
-      assert_equal ".awesome.thing..number_none_0_nocomma_black", subject.styles.first.id
-      assert_equal '0', subject.styles.first.number_format.format
+    should "write worksheet element markup" do
+      subject.send(:worksheet, @xworkbook, @worksheet)
+      assert_equal(
+        "<Worksheet ss:Name=\"testsheet2\"><Table><Column ss:Width=\"100\" /><Row ss:Height=\"50\"></Row></Table></Worksheet>",
+        xelement_markup(@xworkbook)
+      )
     end
+
   end
 
 end