xmlss 0.3.1 → 0.4.0

data/test/undies_writer_test.rb

@@ -0,0 +1,333 @@
+require 'assert'
+
+require 'xmlss/undies_writer'
+require 'xmlss/workbook'
+
+class Xmlss::UndiesWriter
+
+  class BasicTests < Assert::Context
+    desc "UndiesWriter"
+    setup do
+      @w = Xmlss::UndiesWriter.new
+    end
+    subject { @w }
+
+    should have_class_methods :attributes, :classify, :coerce
+    should have_readers :style_markup, :element_markup
+    should have_instance_method :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, :data
+
+    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, Xmlss::UndiesWriter.coerce(true)
+      assert_nil Xmlss::UndiesWriter.coerce(false)
+      assert_nil Xmlss::UndiesWriter.coerce("")
+      assert_equal "hi", Xmlss::UndiesWriter.coerce("hi")
+      assert_equal 1, Xmlss::UndiesWriter.coerce(1)
+    end
+
+    should "classify underscored string" do
+      assert_equal "Hi", Xmlss::UndiesWriter.classify("Hi")
+      assert_equal "Hi", Xmlss::UndiesWriter.classify("hi")
+      assert_equal "Hithere", Xmlss::UndiesWriter.classify("HiThere")
+      assert_equal "Hithere", Xmlss::UndiesWriter.classify("hithere")
+      assert_equal "HiThere", Xmlss::UndiesWriter.classify("Hi_There")
+      assert_equal "HiThere", Xmlss::UndiesWriter.classify("Hi_there")
+      assert_equal "HiThere", Xmlss::UndiesWriter.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, Xmlss::UndiesWriter.attributes(thing, thing.keys)
+    end
+
+  end
+
+  class StyleWritingTests < BasicTests
+    desc "writing style markup"
+
+    should "write alignment markup" do
+      subject.alignment(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.style_markup
+      )
+    end
+
+    should "write border markup" do
+      subject.border(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.style_markup
+      )
+    end
+
+    should "write border collection markup" do
+      subject.borders {
+        subject.border(Xmlss::Style::Border.new({
+          :color => '#FF0000',
+          :position => :top
+        }))
+        subject.border(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.style_markup
+      )
+    end
+
+    should "write font markup" do
+      subject.font(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.style_markup
+      )
+    end
+
+    should "write interior markup" do
+      subject.interior(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.style_markup
+      )
+    end
+
+    should "write number format markup" do
+      subject.number_format(Xmlss::Style::NumberFormat.new("General"))
+      subject.flush
+
+      assert_equal(
+        "<NumberFormat ss:Format=\"General\" />",
+        subject.style_markup
+      )
+    end
+
+    should "write protection markup" do
+      subject.protection(Xmlss::Style::Protection.new(true))
+      subject.flush
+
+      assert_equal(
+        "<Protection ss:Protect=\"1\" />",
+        subject.style_markup
+      )
+    end
+
+    should "write full style markup" do
+      subject.style(Xmlss::Style::Base.new(:write_markup_test)) {
+        subject.alignment(Xmlss::Style::Alignment.new({
+          :horizontal => :left,
+          :vertical => :center,
+          :wrap_text => true
+        }))
+        subject.borders {
+          subject.border(Xmlss::Style::Border.new({:position => :left}))
+          subject.border(Xmlss::Style::Border.new({:position => :right}))
+        }
+        subject.font(Xmlss::Style::Font.new({:bold => true}))
+        subject.interior(Xmlss::Style::Interior.new({:color => "#000000"}))
+        subject.number_format(Xmlss::Style::NumberFormat.new("General"))
+        subject.protection(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.style_markup
+      )
+    end
+
+  end
+
+
+  class WorksheetWritingTests < BasicTests
+    desc "writing worksheet markup"
+
+    should "write data markup" do
+      subject.data(Xmlss::Element::Data.new("some data"))
+      subject.flush
+
+      assert_equal(
+        "<Data ss:Type=\"String\">some data</Data>",
+        subject.element_markup
+      )
+    end
+
+    should "write data markup w/ line breaks" do
+      subject.data(Xmlss::Element::Data.new(%s{
+        Hello World
+      }, :type => :string))
+      subject.flush
+
+      assert_equal(
+        "<Data ss:Type=\"String\">&#13;&#10;        Hello World&#13;&#10;      </Data>",
+        subject.element_markup
+      )
+    end
+
+    should "write cell markup" do
+      subject.cell(Xmlss::Element::Cell.new({:index => 2})) {
+        subject.data(Xmlss::Element::Data.new("some data"))
+      }
+      subject.flush
+
+      assert_equal(
+        "<Cell ss:Index=\"2\"><Data ss:Type=\"String\">some data</Data></Cell>",
+        subject.element_markup
+      )
+    end
+
+    should "write row markup" do
+      subject.row(Xmlss::Element::Row.new({:hidden => true})) {
+        subject.cell(Xmlss::Element::Cell.new({:index => 2})) {
+          subject.data(Xmlss::Element::Data.new("some data"))
+        }
+      }
+      subject.flush
+
+      assert_equal(
+        "<Row ss:Hidden=\"1\"><Cell ss:Index=\"2\"><Data ss:Type=\"String\">some data</Data></Cell></Row>",
+        subject.element_markup
+      )
+    end
+
+    should "write column markup" do
+      subject.column(Xmlss::Element::Column.new({:hidden => true}))
+      subject.flush
+
+      assert_equal(
+        "<Column ss:Hidden=\"1\" />",
+        subject.element_markup
+      )
+    end
+
+    should "write worksheet markup" do
+      subject.worksheet(Xmlss::Element::Worksheet.new('test')) {
+        subject.row(Xmlss::Element::Row.new({:hidden => true})) {
+          subject.cell(Xmlss::Element::Cell.new({:index => 2})) {
+            subject.data(Xmlss::Element::Data.new("some data"))
+          }
+        }
+      }
+      subject.flush
+
+      assert_equal(
+        "<Worksheet ss:Name=\"test\"><Table><Row ss:Hidden=\"1\"><Cell ss:Index=\"2\"><Data ss:Type=\"String\">some data</Data></Cell></Row></Table></Worksheet>",
+        subject.element_markup
+      )
+    end
+
+    should "return workbook markup" do
+      subject.style(Xmlss::Style::Base.new(:some_font)) {
+        subject.font(Xmlss::Style::Font.new({:bold => true}))
+      }
+
+      subject.style(Xmlss::Style::Base.new(:some_numformat)) {
+        subject.number_format(Xmlss::Style::NumberFormat.new("General"))
+      }
+
+      subject.worksheet(Xmlss::Element::Worksheet.new('test')) {
+        subject.row(Xmlss::Element::Row.new({:hidden => true})) {
+          subject.cell(Xmlss::Element::Cell.new({:index => 2})) {
+            subject.data(Xmlss::Element::Data.new("some data"))
+          }
+        }
+      }
+
+      subject.flush
+
+      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=\"some_font\"><Font ss:Bold=\"1\" /></Style><Style ss:ID=\"some_numformat\"><NumberFormat ss:Format=\"General\" /></Style></Styles><Worksheet ss:Name=\"test\"><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 = Xmlss::UndiesWriter.new(:pp => 2)
+      writer.style(Xmlss::Style::Base.new(:some_font)) {
+        writer.font(Xmlss::Style::Font.new({:bold => true}))
+      }
+
+      writer.style(Xmlss::Style::Base.new(:some_numformat)) {
+        writer.number_format(Xmlss::Style::NumberFormat.new("General"))
+      }
+
+      writer.worksheet(Xmlss::Element::Worksheet.new('test')) {
+        writer.row(Xmlss::Element::Row.new({:hidden => true})) {
+          writer.cell(Xmlss::Element::Cell.new({:index => 2})) {
+            writer.data(Xmlss::Element::Data.new("some data"))
+          }
+        }
+      }
+
+      writer.flush
+
+      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=\"test\">\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/test/workbook_test.rb

@@ -1,66 +1,111 @@
 require "assert"
 require 'xmlss/workbook'
 
-module Xmlss
-  class WorkbookTest < Assert::Context
+module Xmlss::Worbook
+
+  class BasicTests < Assert::Context
     desc "Xmlss::Workbook"
-    before { @wkbk = Workbook.new }
+    before { @wkbk = Xmlss::Workbook.new }
     subject { @wkbk }
 
-    should have_accessor :styles, :worksheets
-    should have_instance_method :to_xml
+    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 "set it's defaults" do
-      assert_equal [], subject.styles
-      assert_equal [], subject.worksheets
+    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
 
-  end
+    should "return style objs when calling its style methods" do
+      assert_kind_of Xmlss::Style::Base, subject.style('test')
+      assert_kind_of Xmlss::Style::Alignment, subject.alignment
+      assert_kind_of Xmlss::Style::Border, subject.border
+      assert_kind_of Xmlss::Style::Font, subject.font
+      assert_kind_of Xmlss::Style::Interior, subject.interior
+      assert_kind_of Xmlss::Style::NumberFormat, subject.number_format
+      assert_kind_of Xmlss::Style::Protection, subject.protection
+    end
 
-  class WorkbookAttrsTest < Assert::Context
-    desc "when initializing with attrs"
-    subject { @wkbk }
-    before do
-      # specifying attrs at init time
-      @wkbk = Workbook.new({
-        :worksheets => [Worksheet.new('sheet1')]
-      })
-
-      # writing attrs at run time
-      @wkbk.styles = [
-        Xmlss::Style::Base.new('title') do
-          alignment({:horizontal => :left})
-          font({:size => 14, :bold => true})
-        end,
-
-        Xmlss::Style::Base.new('header') do
-          alignment({:horizontal => :left})
-          font({:bold => true})
-          [:top, :right, :bottom, :left].each do |p|
-            border({:position => :p})
-          end
-        end
-      ]
+    should "return workbook markup string" do
+      assert_match /<Workbook /, subject.to_s
     end
 
-    should "build the attrs appropriately" do
-      [:worksheets, :styles].each do |thing|
-        assert_kind_of ItemSet, subject.send(thing)
+    should "write workbook markup to a file path" do
+      path = nil
+      assert_nothing_raised do
+        path = subject.to_file("./tmp/workbook_test.xls")
       end
-      assert_kind_of Worksheet, subject.worksheets.first
-      assert_equal 1, subject.worksheets.size
+      assert_kind_of ::String, path
+      assert_equal './tmp/workbook_test.xls', path
+      assert File.exists?(path)
+    end
 
-      assert_kind_of Style::Base, subject.styles.first
-      assert_equal 2, subject.styles.size
+    should "maintain the workbook's scope throughout content blocks" do
+      wkbk = Xmlss::Workbook.new do
+        style('test') {
+          alignment
+          borders {
+            border
+          }
+          font
+          interior
+          number_format
+          protection
+        }
+        worksheet('test') {
+          column
+
+          row {
+            cell { data self.object_id }
+          }
+        }
+      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>",
+        wkbk.to_s
+      )
     end
 
   end
 
-  class WorkbookXmlTest < WorkbookTest
-    desc "for generating XML"
+  class DataTests < BasicTests
+
+    should "bork if non hash-like data is provided" do
+      assert_raises NoMethodError do
+        Xmlss::Workbook.new(:data => "some data")
+      end
+      assert_respond_to(
+        :some,
+        Xmlss::Workbook.new(:data => {: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!"})
+      end
+    end
 
-    should have_reader :xml
-    should_build_node
+    should "respond to each data key with its value" do
+      wkbk = Xmlss::Workbook.new(:data => {: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
+      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>",
+        wkbk.to_s
+      )
+    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("nokogiri", ["~> 1.4"])
-  s.add_dependency("enumeration", ["~> 1.2"])
+  s.add_dependency("undies", ["~> 2.1"])
+  s.add_dependency("enumeration", ["~> 1.3"])
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xmlss
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-24 00:00:00 Z
+date: 2012-01-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -55,13 +55,13 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 1
         segments: 
+        - 2
         - 1
-        - 4
-        version: "1.4"
+        version: "2.1"
   version_requirements: *id003
-  name: nokogiri
+  name: undies
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
@@ -70,11 +70,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 9
         segments: 
         - 1
-        - 2
-        version: "1.2"
+        - 3
+        version: "1.3"
   version_requirements: *id004
   name: enumeration
 description: This gem provides an api for constructing spreadsheet data and then uses that data to generate xml that can be interpreted by MS Excel.  The xml conforms to the XML Spreadsheet spec (http://msdn.microsoft.com/en-us/library/aa140066(office.10).aspx).
@@ -92,17 +92,23 @@ files:
 - Gemfile.lock
 - README.rdoc
 - Rakefile
+- bench/profiler.rb
+- bench/profiler_runner.rb
 - examples/example_workbook.rb
 - examples/layout.rb
+- examples/layout.xml
 - examples/simple.rb
+- examples/simple.xml
 - examples/styles.rb
+- examples/styles.xml
 - examples/text.rb
+- examples/text.xml
 - lib/xmlss.rb
-- lib/xmlss/cell.rb
-- lib/xmlss/column.rb
-- lib/xmlss/data.rb
-- lib/xmlss/item_set.rb
-- lib/xmlss/row.rb
+- lib/xmlss/element/cell.rb
+- lib/xmlss/element/column.rb
+- lib/xmlss/element/data.rb
+- lib/xmlss/element/row.rb
+- lib/xmlss/element/worksheet.rb
 - lib/xmlss/style/alignment.rb
 - lib/xmlss/style/base.rb
 - lib/xmlss/style/border.rb
@@ -110,18 +116,16 @@ files:
 - lib/xmlss/style/interior.rb
 - lib/xmlss/style/number_format.rb
 - lib/xmlss/style/protection.rb
-- lib/xmlss/table.rb
+- lib/xmlss/undies_writer.rb
 - lib/xmlss/version.rb
 - lib/xmlss/workbook.rb
-- lib/xmlss/worksheet.rb
-- lib/xmlss/xml.rb
-- test/cell_test.rb
-- test/column_test.rb
-- test/data_test.rb
+- test/element/cell_test.rb
+- test/element/column_test.rb
+- test/element/data_test.rb
+- test/element/row_test.rb
+- test/element/worksheet_test.rb
 - test/helper.rb
 - test/irb.rb
-- test/item_set_test.rb
-- test/row_test.rb
 - test/style/alignment_test.rb
 - test/style/base_test.rb
 - test/style/border_test.rb
@@ -129,12 +133,9 @@ files:
 - test/style/interior_test.rb
 - test/style/number_format_test.rb
 - test/style/protection_test.rb
-- test/table_test.rb
 - test/thing.rb
+- test/undies_writer_test.rb
 - test/workbook_test.rb
-- test/worksheet_test.rb
-- test/xml_test.rb
-- test/xmlss_test.rb
 - xmlss.gemspec
 homepage: http://github.com/kelredd/xmlss
 licenses: []
@@ -165,18 +166,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Generate spreadsheet docs for MS Excel using XML Spreedsheet
 test_files: 
-- test/cell_test.rb
-- test/column_test.rb
-- test/data_test.rb
+- test/element/cell_test.rb
+- test/element/column_test.rb
+- test/element/data_test.rb
+- test/element/row_test.rb
+- test/element/worksheet_test.rb
 - test/helper.rb
 - test/irb.rb
-- test/item_set_test.rb
-- test/row_test.rb
 - test/style/alignment_test.rb
 - test/style/base_test.rb
 - test/style/border_test.rb
@@ -184,9 +185,6 @@ test_files:
 - test/style/interior_test.rb
 - test/style/number_format_test.rb
 - test/style/protection_test.rb
-- test/table_test.rb
 - test/thing.rb
+- test/undies_writer_test.rb
 - test/workbook_test.rb
-- test/worksheet_test.rb
-- test/xml_test.rb
-- test/xmlss_test.rb

data/lib/xmlss/item_set.rb

@@ -1,17 +0,0 @@
-module Xmlss
-  class ItemSet < ::Array
-    include Xmlss::Xml
-    def xml
-      { :node => name,
-        :children => self }
-    end
-
-    attr_accessor :name
-
-    def initialize(name=nil, *args)
-      self.name = name
-      super *args
-    end
-
-  end
-end