xmlss 0.4.1 → 1.0.0.rc.1

data/test/workbook_test.rb

@@ -5,20 +5,28 @@ module Xmlss::Worbook
 
   class BasicTests < Assert::Context
     desc "Xmlss::Workbook"
-    before { @wkbk = Xmlss::Workbook.new }
+    before { @wkbk = Xmlss::Workbook.new(Xmlss::Writer.new) }
     subject { @wkbk }
 
+    should have_class_method :writer, :styles_stack, :worksheets_stack
     should have_instance_methods :to_s, :to_file
-    should have_instance_methods :worksheet, :column, :row, :cell, :data
+
     should have_instance_methods :style, :alignment, :borders, :border
     should have_instance_methods :font, :interior, :number_format, :protection
 
+    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 "return element objs when calling its element methods" do
       assert_kind_of Xmlss::Element::Worksheet, subject.worksheet('test')
       assert_kind_of Xmlss::Element::Column, subject.column
       assert_kind_of Xmlss::Element::Row, subject.row
       assert_kind_of Xmlss::Element::Cell, subject.cell
-      assert_kind_of Xmlss::Element::Data, subject.data('test')
     end
 
     should "return style objs when calling its style methods" do
@@ -31,6 +39,13 @@ module Xmlss::Worbook
       assert_kind_of Xmlss::Style::Protection, subject.protection
     end
 
+    should "not complain if setting an attribute when there's no current element" do
+      # it should just do nothing and go on
+      assert_nothing_raised do
+        subject.index(1)
+      end
+    end
+
     should "return workbook markup string" do
       assert_match /<Workbook /, subject.to_s
     end
@@ -46,7 +61,7 @@ module Xmlss::Worbook
     end
 
     should "maintain the workbook's scope throughout content blocks" do
-      wkbk = Xmlss::Workbook.new do
+      wkbk = Xmlss::Workbook.new(Xmlss::Writer.new) do
         style('test') {
           alignment
           borders {
@@ -57,7 +72,8 @@ module Xmlss::Worbook
           number_format
           protection
         }
-        worksheet('test') {
+        worksheet {
+          name 'test'
           column
 
           row {
@@ -67,7 +83,7 @@ module Xmlss::Worbook
       end
 
       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><Style ss:ID=\"test\"><Alignment /><Borders><Border ss:LineStyle=\"Continuous\" ss:Weight=\"1\" /></Borders><Font /><Interior /><NumberFormat /><Protection /></Style></Styles><Worksheet ss:Name=\"test\"><Table><Column /><Row><Cell><Data ss:Type=\"Number\">#{wkbk.object_id}</Data></Cell></Row></Table></Worksheet></Workbook>",
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Workbook xmlns=\"urn:schemas-microsoft-com:office:spreadsheet\" xmlns:ss=\"urn:schemas-microsoft-com:office:spreadsheet\"><Styles><Style ss:ID=\"test\"><Alignment /><Borders><Border ss:LineStyle=\"Continuous\" ss:Weight=\"1\" /></Borders><Font /><Interior /><NumberFormat /><Protection /></Style></Styles><Worksheet ss:Name=\"test\"><Table><Column /><Row><Cell><Data ss:Type=\"Number\">#{wkbk.object_id}</Data></Cell></Row></Table></Worksheet></Workbook>",
         wkbk.to_s
       )
     end
@@ -78,31 +94,31 @@ module Xmlss::Worbook
 
     should "bork if non hash-like data is provided" do
       assert_raises NoMethodError do
-        Xmlss::Workbook.new(:data => "some data")
+        Xmlss::Workbook.new(Xmlss::Writer.new, "some data")
       end
       assert_respond_to(
         :some,
-        Xmlss::Workbook.new(:data => {:some => 'data'})
+        Xmlss::Workbook.new(Xmlss::Writer.new, :some => 'data')
       )
     end
 
     should "complain if trying to set data that conflict with public methods" do
       assert_raises ArgumentError do
-        Xmlss::Workbook.new(:data => {:worksheet => "yay!"})
+        Xmlss::Workbook.new(Xmlss::Writer.new, :worksheet => "yay!")
       end
     end
 
     should "respond to each data key with its value" do
-      wkbk = Xmlss::Workbook.new(:data => {:some => 'data'})
+      wkbk = Xmlss::Workbook.new(Xmlss::Writer.new, :some => 'data')
       assert_equal "data", wkbk.some
     end
 
     should "be able to access its data in the workbook definition" do
-      wkbk = Xmlss::Workbook.new(:data => {:name => "awesome"}) do
-        worksheet name
+      wkbk = Xmlss::Workbook.new(Xmlss::Writer.new, :worksheet_name => "awesome") do
+        worksheet worksheet_name
       end
       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=\"awesome\"><Table /></Worksheet></Workbook>",
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Workbook xmlns=\"urn:schemas-microsoft-com:office:spreadsheet\" xmlns:ss=\"urn:schemas-microsoft-com:office:spreadsheet\"><Styles></Styles><Worksheet ss:Name=\"awesome\"><Table /></Worksheet></Workbook>",
         wkbk.to_s
       )
     end

data/test/writer_test.rb

@@ -0,0 +1,413 @@
+require 'assert'
+
+require 'xmlss/writer'
+require 'xmlss/workbook'
+
+module Xmlss
+
+
+
+  class BasicTests < Assert::Context
+    desc "UndiesWriter"
+    setup do
+      @w = Writer.new
+    end
+    subject { @w }
+
+    should have_class_methods :attributes, :classify, :coerce
+    should have_readers :styles_markup, :worksheets_markup
+    should have_instance_methods :write, :push, :pop, :flush, :workbook
+
+    should have_instance_methods :style, :alignment, :borders, :border
+    should have_instance_methods :font, :interior, :number_format, :protection
+
+    should have_instance_methods :worksheet, :column, :row, :cell
+
+    should "have empty markup by default" do
+      assert_empty subject.worksheets_markup
+      assert_empty subject.styles_markup
+    end
+
+    should "return itself when flushed" do
+      assert_equal subject, subject.flush
+    end
+
+  end
+
+
+
+  class HelpersTests < BasicTests
+
+    should "coerce certain values for xml output" do
+      assert_equal 1, Writer.coerce(true)
+      assert_nil   Writer.coerce(false)
+      assert_nil   Writer.coerce("")
+      assert_equal "hi", Writer.coerce("hi")
+      assert_equal 1, Writer.coerce(1)
+    end
+
+    should "classify underscored string" do
+      assert_equal "Hi", Writer.classify("Hi")
+      assert_equal "Hi", Writer.classify("hi")
+      assert_equal "Hithere", Writer.classify("HiThere")
+      assert_equal "Hithere", Writer.classify("hithere")
+      assert_equal "HiThere", Writer.classify("Hi_There")
+      assert_equal "HiThere", Writer.classify("Hi_there")
+      assert_equal "HiThere", Writer.classify("hi_there")
+    end
+
+    should "convert a list of attributes for xml output" do
+      class Thing
+        def keys; [:thing, :other, 'some', 'hi', :hi_there]; end
+
+        def thing;    true;   end
+        def other;    false;  end
+        def some;     "";     end
+        def hi;       :there; end
+        def hi_there; "you";  end
+      end
+      thing = Thing.new
+      exp = {
+        "ss:Hi" => "there",
+        "ss:HiThere" => "you",
+        "ss:Thing" => "1"
+      }
+
+      assert_equal exp, Writer.attributes(thing, thing.keys)
+    end
+
+  end
+
+
+
+  class StyleWritingTests < BasicTests
+
+    should "write alignment markup" do
+      subject.write(Xmlss::Style::Alignment.new({
+        :wrap_text => true,
+        :horizontal => :center,
+        :vertical => :bottom,
+        :rotate => 90
+      }))
+      subject.flush
+
+      assert_equal(
+        "<Alignment ss:Horizontal=\"Center\" ss:Rotate=\"90\" ss:Vertical=\"Bottom\" ss:WrapText=\"1\" />",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write border markup" do
+      subject.write(Xmlss::Style::Border.new({
+        :color => '#FF0000',
+        :position => :top,
+        :weight => :thick,
+        :line_style => :dot
+      }))
+      subject.flush
+
+      assert_equal(
+        "<Border ss:Color=\"#FF0000\" ss:LineStyle=\"Dot\" ss:Position=\"Top\" ss:Weight=\"3\" />",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write border collection markup" do
+      subject.write(Xmlss::Style::Borders.new)
+      subject.push(:styles)
+
+      subject.write(Xmlss::Style::Border.new({
+        :color => '#FF0000',
+        :position => :top
+      }))
+
+      subject.write(Xmlss::Style::Border.new({
+        :position => :left
+      }))
+
+      subject.flush
+
+      assert_equal(
+        "<Borders><Border ss:Color=\"#FF0000\" ss:LineStyle=\"Continuous\" ss:Position=\"Top\" ss:Weight=\"1\" /><Border ss:LineStyle=\"Continuous\" ss:Position=\"Left\" ss:Weight=\"1\" /></Borders>",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write font markup" do
+      subject.write(Xmlss::Style::Font.new({
+        :bold => true,
+        :color => '#FF0000',
+        :italic => true,
+        :size => 10,
+        :strike_through => true,
+        :underline => :single,
+        :alignment => :superscript,
+        :name => 'Verdana'
+      }))
+      subject.flush
+
+      assert_equal(
+        "<Font ss:Bold=\"1\" ss:Color=\"#FF0000\" ss:FontName=\"Verdana\" ss:Italic=\"1\" ss:Size=\"10\" ss:StrikeThrough=\"1\" ss:Underline=\"Single\" ss:VerticalAlign=\"Superscript\" />",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write interior markup" do
+      subject.write(Xmlss::Style::Interior.new({
+        :color => "#000000",
+        :pattern => :solid,
+        :pattern_color => "#FF0000"
+      }))
+      subject.flush
+
+      assert_equal(
+        "<Interior ss:Color=\"#000000\" ss:Pattern=\"Solid\" ss:PatternColor=\"#FF0000\" />",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write number format markup" do
+      subject.write(Xmlss::Style::NumberFormat.new("General"))
+      subject.flush
+
+      assert_equal(
+        "<NumberFormat ss:Format=\"General\" />",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write protection markup" do
+      subject.write(Xmlss::Style::Protection.new(true))
+      subject.flush
+
+      assert_equal(
+        "<Protection ss:Protect=\"1\" />",
+        subject.styles_markup.to_s
+      )
+    end
+
+    should "write full style markup" do
+      subject.write(Xmlss::Style::Base.new(:write_markup_test))
+      subject.push(:styles)
+
+      subject.write(Xmlss::Style::Alignment.new({
+        :horizontal => :left,
+        :vertical => :center,
+        :wrap_text => true
+      }))
+
+      subject.write(Xmlss::Style::Borders.new)
+      subject.push(:styles)
+
+      subject.write(Xmlss::Style::Border.new({:position => :left}))
+      subject.write(Xmlss::Style::Border.new({:position => :right}))
+
+      subject.pop(:styles)
+      subject.write(Xmlss::Style::Font.new({:bold => true}))
+      subject.write(Xmlss::Style::Interior.new({:color => "#000000"}))
+      subject.write(Xmlss::Style::NumberFormat.new("General"))
+      subject.write(Xmlss::Style::Protection.new(true))
+
+      subject.flush
+
+      assert_equal(
+        "<Style ss:ID=\"write_markup_test\"><Alignment ss:Horizontal=\"Left\" ss:Vertical=\"Center\" ss:WrapText=\"1\" /><Borders><Border ss:LineStyle=\"Continuous\" ss:Position=\"Left\" ss:Weight=\"1\" /><Border ss:LineStyle=\"Continuous\" ss:Position=\"Right\" ss:Weight=\"1\" /></Borders><Font ss:Bold=\"1\" /><Interior ss:Color=\"#000000\" /><NumberFormat ss:Format=\"General\" /><Protection ss:Protect=\"1\" /></Style>",
+        subject.styles_markup.to_s
+      )
+    end
+
+  end
+
+
+
+  class WorksheetWritingTests < BasicTests
+    desc "writing worksheet markup"
+
+    should "write cell data markup" do
+      subject.write(Xmlss::Element::Cell.new("some data"))
+      subject.flush
+
+      assert_equal(
+        "<Cell><Data ss:Type=\"String\">some data</Data></Cell>",
+        subject.worksheets_markup.to_s
+      )
+    end
+
+    should "write cell data markup w/ \\n line breaks" do
+      subject.write(Xmlss::Element::Cell.new("line\nbreak", :type => :string))
+      subject.flush
+
+      assert_equal "<Cell><Data ss:Type=\"String\">line#{Writer::LB}break</Data></Cell>", subject.worksheets_markup.to_s
+    end
+
+    should "write cell data markup w/ \\r line breaks" do
+      subject.write(Xmlss::Element::Cell.new("line\rbreak", :type => :string))
+      subject.flush
+
+      assert_equal "<Cell><Data ss:Type=\"String\">line#{Writer::LB}break</Data></Cell>", subject.worksheets_markup.to_s
+    end
+
+    should "write cell data markup w/ \\r\\n line breaks" do
+      subject.write(Xmlss::Element::Cell.new("line\r\nbreak", :type => :string))
+      subject.flush
+
+      assert_equal "<Cell><Data ss:Type=\"String\">line#{Writer::LB}break</Data></Cell>", subject.worksheets_markup.to_s
+    end
+
+    should "write cell data markup w/ \\n\\r line breaks" do
+      subject.write(Xmlss::Element::Cell.new("line\n\rbreak", :type => :string))
+      subject.flush
+
+      assert_equal "<Cell><Data ss:Type=\"String\">line#{Writer::LB}break</Data></Cell>", subject.worksheets_markup.to_s
+    end
+
+    should "write cell data markup w/ line breaks and leading space" do
+      subject.write(Xmlss::Element::Cell.new(%s{
+Should
+  honor
+    this}, :type => :string))
+      subject.flush
+
+      assert_equal(
+        "<Cell><Data ss:Type=\"String\">#{Writer::LB}Should#{Writer::LB}  honor#{Writer::LB}    this</Data></Cell>",
+        subject.worksheets_markup.to_s
+      )
+    end
+
+    should "write cell data markup w/ escaped values" do
+      subject.write(Xmlss::Element::Cell.new("some\n&<>'\"/\ndata"))
+      subject.flush
+
+      assert_equal(
+        "<Cell><Data ss:Type=\"String\">some&#13;&#10;&amp;&lt;&gt;&#x27;&quot;&#x2F;&#13;&#10;data</Data></Cell>",
+        subject.worksheets_markup.to_s
+      )
+    end
+
+    should "write worksheet element markup" do
+      subject.write(Xmlss::Element::Worksheet.new('awesome'))
+      subject.push(:worksheets)
+
+      subject.write(Xmlss::Element::Column.new({
+          :width => 120,
+          :style_id => 'narrowcolumn'
+      }))
+
+      subject.write(Xmlss::Element::Row.new({
+        :hidden => true,
+        :height => 120,
+        :style_id => 'awesome'
+      }))
+      subject.push(:worksheets)
+
+      subject.write(Xmlss::Element::Cell.new({
+        :index => 2,
+        :data  => "100",
+        :type  => :number,
+        :href  => "http://www.google.com"
+      }))
+
+      subject.flush
+
+      assert_equal(
+        "<Worksheet ss:Name=\"awesome\"><Table><Column ss:StyleID=\"narrowcolumn\" ss:Width=\"120\" /><Row ss:Height=\"120\" ss:Hidden=\"1\" ss:StyleID=\"awesome\"><Cell ss:HRef=\"http://www.google.com\" ss:Index=\"2\"><Data ss:Type=\"Number\">100</Data></Cell></Row></Table></Worksheet>",
+        subject.worksheets_markup.to_s
+      )
+    end
+
+    should "write multiple cells with data in a row" do
+      subject.write(Xmlss::Element::Row.new)
+      subject.push(:worksheets)
+
+      2.times { subject.write(Xmlss::Element::Cell.new("100")) }
+      subject.pop(:worksheets)
+
+      subject.flush
+
+      assert_equal(
+        "<Row><Cell><Data ss:Type=\"String\">100</Data></Cell><Cell><Data ss:Type=\"String\">100</Data></Cell></Row>",
+        subject.worksheets_markup.to_s
+      )
+    end
+
+    should "write multiple rows with cells in a worksheet" do
+      subject.write(Xmlss::Element::Worksheet.new('two rows'))
+      subject.push(:worksheets)
+
+      subject.write(Xmlss::Element::Row.new)
+      subject.push(:worksheets)
+      subject.write(Xmlss::Element::Cell.new("row1"))
+      subject.pop(:worksheets)
+
+      subject.write(Xmlss::Element::Row.new)
+      subject.push(:worksheets)
+      subject.write(Xmlss::Element::Cell.new("row2"))
+      subject.pop(:worksheets)
+
+      subject.pop(:worksheets)
+      subject.flush
+
+      assert_equal(
+        "<Worksheet ss:Name=\"two rows\"><Table><Row><Cell><Data ss:Type=\"String\">row1</Data></Cell></Row><Row><Cell><Data ss:Type=\"String\">row2</Data></Cell></Row></Table></Worksheet>",
+        subject.worksheets_markup.to_s
+      )
+    end
+
+  end
+
+
+
+  class WorkbookWritingTests < BasicTests
+
+    def build_workbook(writer)
+      writer.write(Xmlss::Style::Base.new(:some_font))
+      writer.push(:styles)
+      writer.write(Xmlss::Style::Font.new({:bold => true}))
+      writer.pop(:styles)
+
+      writer.write(Xmlss::Style::Base.new(:some_numformat))
+      writer.push(:styles)
+      writer.write(Xmlss::Style::NumberFormat.new("General"))
+      writer.pop(:styles)
+
+      writer.write(Xmlss::Element::Worksheet.new('test1'))
+      writer.push(:worksheets)
+      writer.write(Xmlss::Element::Row.new({:hidden => true}))
+      writer.push(:worksheets)
+      writer.write(Xmlss::Element::Cell.new("some data", {:index => 2}))
+      writer.pop(:worksheets)
+      writer.pop(:worksheets)
+
+      writer.write(Xmlss::Element::Worksheet.new('test2'))
+      writer.push(:worksheets)
+      writer.write(Xmlss::Element::Row.new({:hidden => true}))
+      writer.push(:worksheets)
+      writer.write(Xmlss::Element::Cell.new("some data", {:index => 2}))
+      writer.pop(:worksheets)
+      writer.pop(:worksheets)
+
+      writer.flush
+    end
+
+    should "return workbook markup" do
+      build_workbook(subject)
+      assert_equal(
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Workbook xmlns=\"urn:schemas-microsoft-com:office:spreadsheet\" xmlns:ss=\"urn:schemas-microsoft-com:office:spreadsheet\"><Styles><Style ss:ID=\"some_font\"><Font ss:Bold=\"1\" /></Style><Style ss:ID=\"some_numformat\"><NumberFormat ss:Format=\"General\" /></Style></Styles><Worksheet ss:Name=\"test1\"><Table><Row ss:Hidden=\"1\"><Cell ss:Index=\"2\"><Data ss:Type=\"String\">some data</Data></Cell></Row></Table></Worksheet><Worksheet ss:Name=\"test2\"><Table><Row ss:Hidden=\"1\"><Cell ss:Index=\"2\"><Data ss:Type=\"String\">some data</Data></Cell></Row></Table></Worksheet></Workbook>",
+        subject.workbook
+      )
+    end
+
+    should "return pretty workbook markup" do
+      writer = Writer.new(:pp => 2)
+      build_workbook(writer)
+      assert_equal(
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Workbook xmlns=\"urn:schemas-microsoft-com:office:spreadsheet\" xmlns:ss=\"urn:schemas-microsoft-com:office:spreadsheet\">\n  <Styles>\n    <Style ss:ID=\"some_font\">\n      <Font ss:Bold=\"1\" />\n    </Style>\n    <Style ss:ID=\"some_numformat\">\n      <NumberFormat ss:Format=\"General\" />\n    </Style>\n  </Styles>\n  <Worksheet ss:Name=\"test1\">\n    <Table>\n      <Row ss:Hidden=\"1\">\n        <Cell ss:Index=\"2\">\n          <Data ss:Type=\"String\">some data</Data>\n        </Cell>\n      </Row>\n    </Table>\n  </Worksheet>\n  <Worksheet ss:Name=\"test2\">\n    <Table>\n      <Row ss:Hidden=\"1\">\n        <Cell ss:Index=\"2\">\n          <Data ss:Type=\"String\">some data</Data>\n        </Cell>\n      </Row>\n    </Table>\n  </Worksheet>\n</Workbook>",
+        writer.workbook
+      )
+    end
+
+
+
+  end
+
+end

data/xmlss.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("bundler", ["~> 1.0"])
   s.add_development_dependency("assert", ["~> 0.6"])
-  s.add_dependency("undies", ["~> 2.2"])
+  s.add_dependency("undies", ["~> 2.2.1"])
   s.add_dependency("enumeration", ["~> 1.3"])
 end