osheet 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    osheet (0.1.0)
+    osheet (0.2.0)
       enumeration (~> 1.1.0)
-      xmlss (~> 0.0.2)
+      xmlss (~> 0.1.0)
 
 GEM
   remote: http://rubygems.org/
@@ -19,7 +19,8 @@ GEM
       kelredd-useful (~> 0.4.0)
       leftright (~> 0.9.0)
       shoulda (~> 2.11)
-    xmlss (0.0.2)
+    xmlss (0.1.0)
+      enumeration (~> 1.1.0)
       nokogiri (~> 1.4.0)
 
 PLATFORMS
@@ -30,4 +31,4 @@ DEPENDENCIES
   enumeration (~> 1.1.0)
   osheet!
   test-belt (= 0.2.1)
-  xmlss (~> 0.0.2)
+  xmlss (~> 0.1.0)

data/README.rdoc

@@ -78,6 +78,10 @@ Pronounced 'oh-sheeeeeet!' - this gem is a DSL wrapper to the spreadsheet gem th
 
     file = wb.to_file('stats')  # => <spreadsheet written to ./stats.xls>
 
+== Examples
+
+I've add a few examples to ./examples.  Please refer to these for examples on basic usage, using templates, formatting data, and styling data.
+
 == API
 
 These classes define how a spreadsheet is constructed.

data/examples/basic_with_templates.rb

@@ -0,0 +1,84 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/basic_with_templates.rb
+# $ open examples/basic_with_templates.xls
+
+require 'rubygems'
+require 'osheet'
+
+fields = ['Sex', 'Age', 'Height', 'Weight']
+data = {
+  'Tom' => ['M', 52, "6'2\"", '220 lbs.'],
+  'Dick' => ['M', 33, "6'5\"", '243 lbs.'],
+  'Sally' => ['F', 29, "5'3\"", '132 lbs.']
+}
+
+# this will dump the above data to a single-sheet workbook w/ no styles
+
+
+Osheet::Workbook.new {
+  title "basic"
+
+  template(:column, :data) { |field, index|
+    width 80
+    meta(
+      :label => field.to_s,
+      :index => index
+    )
+  }
+
+  template(:row, :title) {
+    cell {
+      colspan columns.count
+      data worksheet.name
+    }
+  }
+
+  template(:row, :empty) {
+    cell {
+      colspan columns.count
+      data ''
+    }
+  }
+
+  template(:row, :header) {
+    columns.each do |column|
+      cell {
+        data column.meta[:label]
+      }
+    end
+  }
+
+  template(:row, :data) { |name, stats|
+    cell {
+      data name
+    }
+    stats.each do |stat|
+      cell {
+        data stat
+      }
+    end
+  }
+
+  worksheet {
+    name "Stats: #{fields.join(', ')}"
+
+    column {
+      width 200
+      meta(
+        :label => "Name"
+      )
+    }
+    fields.each_with_index do |f, i|
+      column :data, f, i
+    end
+
+    row :title
+    row :empty
+    row :header
+
+    data.each do |name, stats|
+      row :data, name, stats
+    end
+  }
+}.to_file('examples/basic_with_templates.xls')

data/examples/styles.rb

@@ -0,0 +1,241 @@
+# To run:
+# $ bundle install
+# $ bundle exec ruby examples/styles.rb
+# $ open examples/styles.xls
+
+require 'rubygems'
+require 'osheet'
+
+Osheet::Workbook.new {
+  title "styles"
+  template(:cell, :styled) { |style, attribute|
+    data attribute == :wrap ? (attribute.to_s+' ')*20 : attribute.to_s
+    style_class "#{style} #{attribute}"
+  }
+
+  # align styles
+  style('.align.left') { align :left }
+  style('.align.center') { align :center }
+  style('.align.right') { align :right }
+  style('.align.top') { align :top }
+  style('.align.middle') { align :middle }
+  style('.align.bottom') { align :bottom }
+  style('.align.wrap') { align :wrap }
+  style('.align.rotA') { align 90 }
+  style('.align.rotB') { align -90 }
+  style('.align.rotC') { align 45 }
+
+  worksheet {
+    name "align"
+
+    (0..3).each do
+      column {
+        width 100
+      }
+    end
+
+    { 'Horizontal alignment' => [:left, :center, :right],
+      'Vertical alignment'   => [:top,  :middle, :bottom],
+      'Wrap text'            => [:wrap],
+      'Rotate text'          => [:rotA, :rotB, :rotC]
+    }.each do |k,v|
+      row {
+        height 50
+        v.each {|a| cell(:styled, 'align', a) }
+      }
+    end
+  }
+
+
+
+  # font styles
+  style('.font.underline') { font :underline }
+  style('.font.double_underline') { font :double_underline }
+  style('.font.accounting_underline') { font :accounting_underline }
+  style('.font.double_accounting_underline') { font :double_accounting_underline }
+  style('.font.subscript') { font :subscript }
+  style('.font.superscript') { font :superscript }
+  style('.font.strikethrough') { font :strikethrough }
+  style('.font.shadow') { font :shadow }
+  style('.font.bold') { font :bold }
+  style('.font.italic') { font :italic }
+  style('.font.sizeA') { font 6 }
+  style('.font.sizeB') { font 14 }
+  style('.font.colorA') { font '#FF0000' }
+  style('.font.colorB') { font '#00FF00' }
+
+  worksheet {
+    name "font"
+
+    (0..5).each do
+      column {
+        width 100
+      }
+    end
+
+    row {
+      [:underline, :double_underline, :accounting_underline, :double_accounting_underline].each do |a|
+        cell {
+          data a.to_s
+          style_class "font #{a}"
+        }
+      end
+    }
+    row {
+      [:subscript, :superscript, :strikethrough, :shadow].each do |a|
+        cell {
+          data a.to_s
+          style_class "font #{a}"
+        }
+      end
+    }
+    row {
+      [:bold, :italic].each do |a|
+        cell {
+          data a.to_s
+          style_class "font #{a}"
+        }
+      end
+    }
+    row {
+      [:sizeA, :sizeB].each do |a|
+        cell {
+          data a.to_s
+          style_class "font #{a}"
+        }
+      end
+    }
+    row {
+      [:colorA, :colorB].each do |a|
+        cell {
+          data a.to_s
+          style_class "font #{a}"
+        }
+      end
+    }
+  }
+
+
+
+  # bg styles
+  style('.bg.color') {
+    bg '#FF0000'
+    font '#FFFFFF'
+  }
+  style('.bg.pattern') {
+    bg :horz_stripe
+  }
+  style('.bg.pattern.color') {
+    bg '#FF0000', :horz_stripe => '#000000'
+    font '#FFFFFF'
+  }
+
+  worksheet {
+    name "bg"
+
+    column {
+      width 100
+    }
+
+    row {
+      height 50
+      cell {
+        style_class "bg color"
+        data 'COLOR'
+      }
+    }
+    row {
+      height 50
+      cell {
+        style_class "bg pattern"
+        data 'PATTERN'
+      }
+    }
+    row {
+      height 50
+      cell {
+        style_class "bg pattern color"
+        data 'PATTERN COLOR'
+      }
+    }
+  }
+
+
+
+  # border styles
+  style('.border.top.color')      { border_top '#FF0000' }
+  style('.border.right.color')    { border_right '#00FF00' }
+  style('.border.bottom.color')   { border_bottom '#0000FF' }
+  style('.border.left.color')     { border_left '#FFFF00' }
+  style('.border.top.weight')     { border_top :hairline }
+  style('.border.right.weight')   { border_right :thin }
+  style('.border.bottom.weight')  { border_bottom :medium }
+  style('.border.left.weight')    { border_left :thick }
+  style('.border.top.style')     { border_top :continuous }
+  style('.border.right.style')   { border_right :dash }
+  style('.border.bottom.style')  { border_bottom :dot }
+  style('.border.left.style')    { border_left :dash_dot }
+  style('.border.all') {
+    border :continuous, :thick, '#00FFFF'
+  }
+
+  worksheet {
+    name "border"
+
+    column {
+      width 20
+    }
+    column {
+      width 200
+    }
+
+    row {}
+    row {
+      height 50
+      cell {}
+      cell {
+        style_class "border top color weight style"
+        data 'top red hairline continuous'
+      }
+    }
+    row {}
+    row {
+      height 50
+      cell {}
+      cell {
+        style_class "border right color weight style"
+        data 'right green thin dash'
+      }
+    }
+    row {}
+    row {
+      height 50
+      cell {}
+      cell {
+        style_class "border bottom color weight style"
+        data 'bottom blue medium dat'
+      }
+    }
+    row {}
+    row {
+      height 50
+      cell {}
+      cell {
+        style_class "border left color weight style"
+        data 'left yellow thick dast_dot'
+      }
+    }
+    row {}
+    row {
+      height 50
+      cell {}
+      cell {
+        style_class "border all"
+        data 'all aqua'
+      }
+    }
+  }
+
+
+
+}.to_file('examples/styles.xls')

data/lib/osheet/version.rb

@@ -1,3 +1,3 @@
 module Osheet
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/osheet/worksheet.rb

@@ -16,12 +16,21 @@ module Osheet
     end
 
     def name(value=nil)
-      !value.nil? ? @name = value : @name
+      !value.nil? ? @name = sanitized_name(value) : @name
     end
 
     def attributes
       { :name => @name }
     end
 
+    private
+
+    def sanitized_name(name_value)
+      if @workbook && @workbook.worksheets.collect{|ws| ws.name}.include?(name_value)
+        raise ArgumentError, "the sheet name '#{name_value}' is already in use.  choose a sheet name that is not used by another sheet"
+      end
+      name_value
+    end
+
   end
 end

data/lib/osheet/xmlss_writer/base.rb

@@ -21,6 +21,16 @@ module Osheet::XmlssWriter
       unless oworkbook.kind_of?(::Osheet::Workbook)
         raise ArgumentError, "'#{oworkbook.inspect}' is not an Osheet::Workbook"
       end
+      # if oworkbook && oworkbook.worksheets.collect{|ws| ws.name}.include?(name_value)
+      #   # puts "ERRORR!!!!!!!!!!!!!!"
+      #   # puts "names: #{names.inspect}"
+      #   # puts "name value: #{name_value}"
+      #   raise ArgumentError, "the sheet name '#{name_value}' is already in use.  enter a sheet name that is not used by another sheet"
+      # end
+      # # puts "names: #{names.inspect}"
+      # # puts "name value: #{name_value}"
+      # # name_value
+      
       @ostyles = oworkbook.styles
       @workbook = ::Xmlss::Workbook.new({
         :worksheets => worksheets(oworkbook.worksheets)

data/lib/osheet/xmlss_writer/styles.rb

@@ -52,7 +52,7 @@ module Osheet::XmlssWriter::Styles
   def merged_settings(current, add)
     # concat values for keys in both sets
     current.keys.each do |k|
-      current[k].merge!(add.delete(k))
+      current[k].merge!(add.delete(k) || {})
     end
     # merge keys for anything not in the current
     current.merge(add)
@@ -92,22 +92,26 @@ module Osheet::XmlssWriter::Styles
   def font_settings(font_cmds)
     font_cmds.inject({}) do |font_settings, font_cmd|
       if (setting = case font_cmd
-        when :underline
-          [:underline, :single]
-        when :double_underline
-          [:underline, :double]
-        when :subscript, :superscript
-          [:alignment, font_cmd]
-        when :bold, :italic
-          [font_cmd, true]
-        when :strikethrough
-          [:strike_through, true]
         when ::Fixnum
           [:size, font_cmd]
         when ::String
           if font_cmd =~ /^#/
             [:color, font_cmd]
           end
+        when :bold, :italic, :shadow
+          [font_cmd, true]
+        when :subscript, :superscript
+          [:alignment, font_cmd]
+        when :strikethrough
+          [:strike_through, true]
+        when :underline
+          [:underline, :single]
+        when :double_underline
+          [:underline, :double]
+        when :accounting_underline
+          [:underline, :single_accounting]
+        when :double_accounting_underline
+          [:underline, :double_accounting]
         end
       )
         font_settings[setting.first] = setting.last
@@ -141,6 +145,9 @@ module Osheet::XmlssWriter::Styles
           bg_settings[setting.first] = setting.last
         end
       end
+      if !bg_settings[:color].nil? && bg_settings[:pattern].nil?
+        bg_settings[:pattern] = :solid
+      end
       bg_settings
     end
   end

data/osheet.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency("test-belt", ["= 0.2.1"]) # locked to a specific version for test stability
 
   s.add_dependency("enumeration", ["~>1.1.0"])
-  s.add_dependency("xmlss", "~>0.0.2")
+  s.add_dependency("xmlss", "~>0.1.0")
 
 end

data/test/workbook_test.rb

@@ -58,6 +58,25 @@ module Osheet
           assert_kind_of Worksheet, worksheets.first
         end
 
+        should "not allow multiple worksheets with the same name" do
+          assert_raises ArgumentError do
+            Workbook.new {
+              title "should fail"
+
+              worksheet { name "awesome" }
+              worksheet { name "awesome" }
+            }
+          end
+          assert_nothing_raised do
+            Workbook.new {
+              title "should not fail"
+
+              worksheet { name "awesome" }
+              worksheet { name "awesome1" }
+            }
+          end
+        end
+
         should "know it's attribute(s)" do
           [:title].each do |a|
             assert subject.attributes.has_key?(a)

data/test/xmlss_writer/base_test.rb

@@ -23,7 +23,7 @@ module Osheet
         }
       end
 
-      should "allow writing an Osheet::Workbook" do
+      should "only allow writing an Osheet::Workbook" do
         assert_nothing_raised do
           subject.workbook = @workbook
         end
@@ -32,6 +32,16 @@ module Osheet
         end
       end
 
+      should "not allow writing a workbook that has multiple worksheets with the same name" do
+        assert_raises ArgumentError do
+          subject.workbook = Workbook.new {
+            title "invalid"
+            worksheet { name "testsheet1" }
+            worksheet { name "testsheet1" }
+          }
+        end
+      end
+
       should "create an Xmlss workbook" do
         assert_nothing_raised do
           subject.workbook = @workbook

data/test/xmlss_writer/styles_test.rb

@@ -12,6 +12,7 @@ module Osheet
           style('.font.size') { font 14 }
           style('.font.weight') { font :bold }
           style('.font.style') { font :italic }
+          style('.align.center') { align :center }
         }
       end
 
@@ -36,7 +37,7 @@ module Osheet
       end
 
       should "build a style obj from many matching osheet styles" do
-        xmlss_style = subject.send(:style, 'font size weight style')
+        xmlss_style = subject.send(:style, 'font size weight style align center')
         assert_equal 14, xmlss_style.font.size
         assert_equal true, xmlss_style.font.bold?
         assert_equal true, xmlss_style.font.italic?
@@ -102,11 +103,9 @@ module Osheet
       subject { XmlssWriter::Base.new }
       before do
         subject.workbook = Workbook.new {
-          [
-            :underline, :double_underline,
-            :subscript, :superscript,
-            :bold, :italic, :strikethrough,
-            :wrap
+          [ :underline, :double_underline, :accounting_underline, :double_accounting_underline,
+            :subscript, :superscript, :shadow, :strikethrough, :wrap,
+            :bold, :italic
           ].each do |s|
             style(".font.#{s}") { font s }
           end
@@ -122,6 +121,8 @@ module Osheet
       should "build style objs for font underline settings" do
         assert_equal ::Xmlss::Style::Font.underline(:single), subject.send(:style, 'font underline').font.underline
         assert_equal ::Xmlss::Style::Font.underline(:double), subject.send(:style, 'font double_underline').font.underline
+        assert_equal ::Xmlss::Style::Font.underline(:single_accounting), subject.send(:style, 'font accounting_underline').font.underline
+        assert_equal ::Xmlss::Style::Font.underline(:double_accounting), subject.send(:style, 'font double_accounting_underline').font.underline
       end
 
       should "build style objs for font alignment settings" do
@@ -133,6 +134,7 @@ module Osheet
         assert_equal true, subject.send(:style, 'font bold').font.bold?
         assert_equal true, subject.send(:style, 'font italic').font.italic?
         assert_equal true, subject.send(:style, 'font strikethrough').font.strike_through?
+        assert_equal true, subject.send(:style, 'font shadow').font.shadow?
       end
 
       should "build style objs for font size" do
@@ -147,7 +149,7 @@ module Osheet
   end
 
   class XmlssWriter::Bg < Test::Unit::TestCase
-    context("Font bg writer") do
+    context("Bg writer") do
 
       subject { XmlssWriter::Base.new }
       before do
@@ -155,6 +157,8 @@ module Osheet
           style('.bg.color') { bg '#FF0000' }
           style('.bg.pattern-only') { bg :solid }
           style('.bg.pattern-color') { bg :horz_stripe => '#0000FF' }
+          style('.bg.color-first') { bg '#00FF00', {:horz_stripe => '#0000FF'} }
+          style('.bg.pattern-first') { bg({:horz_stripe => '#0000FF'}, '#00FF00') }
         }
       end
 
@@ -162,7 +166,7 @@ module Osheet
         assert_equal nil, subject.send(:style, 'bg').interior
       end
 
-      should "build style objs for bg color" do
+      should "build style objs for bg color and auto set the pattern to solid" do
         assert_equal '#FF0000', subject.send(:style, 'bg color').interior.color
       end
 
@@ -173,6 +177,18 @@ module Osheet
         assert_equal '#0000FF', subject.send(:style, 'bg pattern-color').interior.pattern_color
       end
 
+      should "set pattern to solid when setting bg color" do
+        assert_equal ::Xmlss::Style::Interior.pattern(:solid), subject.send(:style, 'bg color').interior.pattern
+      end
+
+      should "set pattern to pattern setting when first setting bg color then pattern" do
+        assert_equal ::Xmlss::Style::Interior.pattern(:horz_stripe), subject.send(:style, 'bg color-first').interior.pattern
+      end
+
+      should "set pattern to pattern setting when first setting bg pattern then color" do
+        assert_equal ::Xmlss::Style::Interior.pattern(:horz_stripe), subject.send(:style, 'bg pattern-first').interior.pattern
+      end
+
     end
   end
 
@@ -241,9 +257,8 @@ module Osheet
       subject { XmlssWriter::Base.new }
 
       should "build a style obj with formatting" do
-        # TODO: uncomment when further styles defined
-        #assert_equal '@', subject.send(:style, '', Osheet::Format.new(:text)).number_format.format
-        #assert_equal 'mm/dd/yy', subject.send(:style, '', 'mm/dd/yy').number_format.format
+        assert_equal '@', subject.send(:style, '', Osheet::Format.new(:text)).number_format.format
+        assert_equal 'mm/dd/yy', subject.send(:style, '', Osheet::Format.new(:datetime, 'mm/dd/yy')).number_format.format
       end
 
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: osheet
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 -05:00
+date: 2011-04-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,9 +76,9 @@ dependencies:
         hash: 27
         segments: 
         - 0
+        - 1
         - 0
-        - 2
-        version: 0.0.2
+        version: 0.1.0
   type: :runtime
   version_requirements: *id004
 description: A DSL for specifying and generating rich spreasheetML.  Specify your spreadsheet using the richness of Ruby and easily produce the corresponding spreadsheetML to render in MS Excel.
@@ -98,7 +98,9 @@ files:
 - README.rdoc
 - Rakefile
 - examples/basic.rb
+- examples/basic_with_templates.rb
 - examples/formats.rb
+- examples/styles.rb
 - examples/trivial.rb
 - lib/osheet.rb
 - lib/osheet/associations.rb