xmlss 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    xmlss (0.0.1)
+    xmlss (0.0.2)
+      enumeration (~> 1.1.0)
       nokogiri (~> 1.4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    enumeration (1.1.0)
     json (1.5.1)
     kelredd-useful (0.4.1)
       json
@@ -23,6 +25,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
+  enumeration (~> 1.1.0)
   nokogiri (~> 1.4.0)
   test-belt (= 0.2.1)
   xmlss!

data/README.rdoc

@@ -70,14 +70,12 @@ These classes define how a spreadsheet is constructed.
 === Xmlss::Cell
 * *style_id*: string
 * *data*: Xmlss::Data object
-* *formula*: string
 * *href*: string
 * *merge_across*: int, default: 0
 * *merge_down*: int, default: 0
-* *tool_tip*: string
 
 === Xmlss::Data
-* *type*: :number, :datetime, :boolean, :string, :error, required
+* *type*: :number, :date_time, :boolean, :string, :error, required
 * *value*: needs to respond to 'to_s'
 
 
@@ -119,7 +117,7 @@ These classes define how a spreadsheet cells are styled.
 * *pattern_color*: hex string
 
 === Xmlss::Style::NumberFormat
-* *format*: :symbol (see code for options)
+* *format*: :symbol (there are MANY different options for this, I suggest saving a spreadsheet in the XML format and seeing what Excel uses)
 
 === Xmlss::Style::Protection
 * *protected*: bool, default: false

data/examples/example_workbook.rb

@@ -4,7 +4,7 @@ require 'test/env'
 class ExampleWorkbook < Xmlss::Workbook
   def initialize
     super
-    puts "Builing #{self.name}.xml..."
+    puts "Building #{self.name}.xml..."
     build
   end
 

data/lib/xmlss/data.rb

@@ -12,7 +12,7 @@ module Xmlss
         :value => :xml_value }
     end
 
-    include Xmlss::Enum
+    include Enumeration
     enum :type, {
       :number => "Number",
       :date_time => "DateTime",

data/lib/xmlss/style/alignment.rb

@@ -6,7 +6,7 @@ module Xmlss::Style
         :attributes => [:horizontal, :vertical, :wrap_text, :rotate] }
     end
 
-    include Xmlss::Enum
+    include Enumeration
     enum :horizontal, {
       :automatic => "Automatic",
       :left => "Left",

data/lib/xmlss/style/border.rb

@@ -6,7 +6,7 @@ module Xmlss::Style
         :attributes => [:color, :position, :weight, :line_style] }
     end
 
-    include Xmlss::Enum
+    include Enumeration
     enum :position, {
       :left => "Left",
       :top => "Top",

data/lib/xmlss/style/font.rb

@@ -9,7 +9,7 @@ module Xmlss::Style
         ] }
     end
 
-    include Xmlss::Enum
+    include Enumeration
     enum :underline, {
       :none => 0,
       :single => 1,

data/lib/xmlss/style/interior.rb

@@ -6,7 +6,7 @@ module Xmlss::Style
         :attributes => [:color, :pattern, :pattern_color] }
     end
 
-    include Xmlss::Enum
+    include Enumeration
     enum :pattern, {
       :none => "None",
       :solid => "Solid",

data/lib/xmlss/version.rb

@@ -1,3 +1,3 @@
 module Xmlss
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/xmlss/workbook.rb

@@ -16,8 +16,24 @@ module Xmlss
     attr_accessor :styles, :worksheets
 
     def initialize(attrs={})
-      self.styles = Xmlss::ItemSet.new(:styles, attrs[:styles] || [])
-      self.worksheets = Xmlss::ItemSet.new(nil, attrs[:worksheets] || [])
+      self.styles = attrs[:styles]
+      self.worksheets = attrs[:worksheets]
+    end
+
+    def styles=(collection)
+      @styles = if (set = collection || []).kind_of?(ItemSet)
+        set
+      else
+        ItemSet.new(:styles, set)
+      end
+    end
+
+    def worksheets=(collection)
+      @worksheets = if (set = collection || []).kind_of?(ItemSet)
+        set
+      else
+        ItemSet.new(nil, set)
+      end
     end
 
     def to_xml

data/lib/xmlss/worksheet.rb

@@ -13,11 +13,15 @@ module Xmlss
     attr_accessor :name, :table
 
     def initialize(name, attrs={})
-      if name.nil? || name.empty?
+      self.name = name
+      self.table = attrs[:table] || Table.new
+    end
+
+    def name=(value)
+      if value.nil? || value.to_s.empty?
         raise ArgumentError, "'#{name.inspect}' is not a good name for a worksheet"
       end
-      self.name = sanitized_name(name)
-      self.table = attrs[:table] || Table.new
+      @name = sanitized_name(value.to_s)
     end
 
     def table=(value)
@@ -29,9 +33,9 @@ module Xmlss
 
     private
 
-    def sanitized_name(value)
-      # worksheet name cannot contain: /, \, ?, *, [, ]
-      value.to_s.gsub(/[\/|\\|\?|\*|\[|\]]/, '')
+    def sanitized_name(name)
+      # worksheet name cannot contain: /, \, :, ;, * or start with '['
+      name.to_s.gsub(/[\/|\\|:|;|\*]/, '').gsub(/^\[/, '')
     end
   end
 end

data/lib/xmlss.rb

@@ -24,8 +24,8 @@ module Xmlss
   end
 end
 
+require 'enumeration'
 require 'xmlss/xml'
-require 'xmlss/enum'
 require 'xmlss/style/base'
 require 'xmlss/workbook'
 

data/test/workbook_test.rb

@@ -17,7 +17,14 @@ module Xmlss
 
       context "when initializing with attrs" do
         subject do
-          styles = [
+          # specifying attrs at init time
+          Workbook.new({
+            :worksheets => [Worksheet.new('sheet1')]
+          })
+        end
+        before do
+          # writing attrs at run time
+          subject.styles = [
             Xmlss::Style::Base.new('title') do
               alignment({:horizontal => :left})
               font({:size => 14, :bold => true})
@@ -31,10 +38,6 @@ module Xmlss
               end
             end
           ]
-          Workbook.new({
-            :worksheets => [Worksheet.new('sheet1')],
-            :styles => styles
-          })
         end
 
         should "build the attrs appropriately" do

data/test/worksheet_test.rb

@@ -17,12 +17,18 @@ module Xmlss
       end
 
       should "filter name chars" do
-        # worksheet name cannot contain: /, \, ?, *, [, ]
+        # worksheet name cannot contain: /, \, :, ;, * or start with '['
         assert_equal "test test", Worksheet.new("test/ test").name
         assert_equal "test test", Worksheet.new("tes\\t test").name
-        assert_equal "test test", Worksheet.new("te?st test?").name
-        assert_equal "test test", Worksheet.new("t*est test").name
-        assert_equal "test test", Worksheet.new("[te]st test").name
+        assert_equal "test test", Worksheet.new("te:st test:").name
+        ws = Worksheet.new("te;st ;test")
+        assert_equal "test test", ws.name
+        ws.name = "t*est test"
+        assert_equal "test test", ws.name
+        ws.name = "[te]st test"
+        assert_equal "te]st test", ws.name
+        ws.name = "t[e]st test"
+        assert_equal "t[e]st test", ws.name
       end
 
       should "allow defining a table at init" do

data/xmlss.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency("bundler", ["~> 1.0"])
-  s.add_development_dependency("test-belt", ["= 0.2.1"]) # locked to a specific version for test stability
+  s.add_development_dependency("test-belt", ["= 0.2.1"])
   s.add_dependency("nokogiri", ["~> 1.4.0"])
+  s.add_dependency("enumeration", ["~>1.1.0"])
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xmlss
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 -05:00
+date: 2011-04-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,22 @@ dependencies:
         version: 1.4.0
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: enumeration
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id004
 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).
 email: 
 - kelly@kelredd.com
@@ -89,7 +105,6 @@ files:
 - lib/xmlss/cell.rb
 - lib/xmlss/column.rb
 - lib/xmlss/data.rb
-- lib/xmlss/enum.rb
 - lib/xmlss/item_set.rb
 - lib/xmlss/row.rb
 - lib/xmlss/style/alignment.rb
@@ -107,7 +122,6 @@ files:
 - test/cell_test.rb
 - test/column_test.rb
 - test/data_test.rb
-- test/enum_test.rb
 - test/env.rb
 - test/helper.rb
 - test/item_set_test.rb
@@ -164,7 +178,6 @@ test_files:
 - test/cell_test.rb
 - test/column_test.rb
 - test/data_test.rb
-- test/enum_test.rb
 - test/env.rb
 - test/helper.rb
 - test/item_set_test.rb

data/lib/xmlss/enum.rb

@@ -1,56 +0,0 @@
-# common methods used for handling enum data
-module Xmlss
-  module Enum
-
-    module ClassMethods
-      def enum(name, map)
-        # TODO: validate name
-        unless map.kind_of?(::Hash)
-          raise ArguementError, "please specify the enum map as a Hash"
-        end
-
-        # define an anonymous Module to extend on
-        # defining a class level map reader
-        class_methods = Module.new do
-          define_method(name) do |key|
-            class_variable_get("@@#{name}")[key]
-          end
-        end
-
-        # set a class variable to store the enum map (used by above reader)
-        # extend the anonymous module to get tne above class
-        #   level reader for the map
-        class_eval do
-          class_variable_set("@@#{name}", map)
-          extend class_methods
-        end
-
-        # instance writer for the enum value
-        define_method("#{name}=") do |value|
-          map = self.class.send(:class_variable_get, "@@#{name}")
-          instance_variable_set("@#{name}", if value && map.has_key?(value)
-            # write by key
-            map[value]
-          elsif map.has_value?(value)
-            # write by value
-            value
-          else
-            nil
-          end)
-        end
-
-        # instance reader for the enum value
-        define_method(name) do
-          instance_variable_get("@#{name}")
-        end
-      end
-    end
-
-    class << self
-      def included(receiver)
-        receiver.send :extend, ClassMethods
-      end
-    end
-
-  end
-end

data/test/enum_test.rb

@@ -1,63 +0,0 @@
-require "test/helper"
-require 'xmlss/enum'
-require 'test/thing'
-
-module Xmlss
-  class EnumTest < Test::Unit::TestCase
-
-    context "Xmlss::Enum mixin" do
-      subject { Thing.new }
-      before do
-        Thing.send :include, Xmlss::Enum
-      end
-
-      should_have_class_method :enum
-
-      context "instance" do
-        before do
-          Thing.send(:enum, :stuff, {
-            :a => "eh",
-            :b => "bee",
-            :c => "see"
-          })
-        end
-
-        should_have_class_method :stuff
-        should "provide class level access to the enum" do
-          assert Thing.send(:class_variable_get, "@@stuff")
-          assert_equal 3, Thing.send(:class_variable_get, "@@stuff").size
-          assert_equal "eh", Thing.stuff(:a)
-        end
-
-        should_have_accessor :stuff
-
-        should "write by key and read by value" do
-          subject.stuff = :a
-          assert_equal "eh", subject.stuff
-        end
-
-        should "write by value and read by value" do
-          subject.stuff = "bee"
-          assert_equal "bee", subject.stuff
-        end
-
-        should "not read by key" do
-          subject.stuff = :c
-          assert_not_equal :c, subject.stuff
-        end
-
-        should "write nil for keys that aren't in the enum" do
-          subject.stuff = :bad
-          assert_equal nil, subject.stuff
-        end
-
-        should "write nil for values that aren't in the enum" do
-          subject.stuff = "bady-bad"
-          assert_equal nil, subject.stuff
-        end
-
-      end
-    end
-
-  end
-end