spreadsheet 0.6.0

data/lib/spreadsheet/worksheet.rb

@@ -0,0 +1,215 @@
+require 'date'
+require 'spreadsheet/encodings'
+require 'spreadsheet/row'
+
+module Spreadsheet
+  ##
+  # The Worksheet class. Contains most of the Spreadsheet data in Rows.
+  #
+  # Interesting Attributes
+  # #name          :: The Name of this Worksheet.
+  # #default_format:: The default format used for all cells in this Workhseet
+  #                   that have no format set explicitly or in
+  #                   Row#default_format.
+  # #rows          :: The Rows in this Worksheet. It is not recommended to
+  #                   Manipulate this Array directly. If you do, call
+  #                   #updated_from with the smallest modified index.
+  class Worksheet
+    include Encodings
+    attr_accessor :name, :workbook
+    attr_reader :rows
+    include Enumerable
+    def initialize opts={}
+      @dimensions = [0,0,0,0]
+      @name = opts[:name] || 'Worksheet'
+      @workbook = opts[:workbook]
+      @rows = []
+    end
+    ##
+    # Add a Format to the Workbook. If you use Row#set_format, you should not
+    # need to use this Method.
+    def add_format fmt
+      @workbook.add_format fmt
+    end
+    ##
+    # Get the enriched value of the Cell at _row_, _column_.
+    # See also Worksheet#[], Row#[].
+    def cell row, column
+      row(row)[column]
+    end
+    ##
+    # The number of columns in this Worksheet which contain data.
+    def column_count
+      dimensions[3] - dimensions[2]
+    end
+    ##
+    # Delete the Row at _idx_ (0-based) from this Worksheet.
+    def delete_row idx
+      res = @rows.delete_at idx
+      updated_from idx
+      res
+    end
+    ##
+    # The default Format of this Worksheet, if you have set one.
+    # Returns the Workbook's default Format otherwise.
+    def default_format
+      @default_format || @workbook.default_format
+    end
+    ##
+    # Set the default Format of this Worksheet.
+    def default_format= format
+      @default_format = format
+      add_format format if format
+      format
+    end
+    ##
+    # Dimensions:: [ first used row, first unused row,
+    #              first used column, first unused column ]
+    #              ( First used means that all rows or columns before that are
+    #              empty. First unused means that this and all following rows
+    #              or columns are empty. )
+    def dimensions
+      @dimensions || recalculate_dimensions
+    end
+    ##
+    # If no argument is given, #each iterates over all used Rows (from the first
+    # used Row until but omitting the first unused Row, see also #dimensions).
+    #
+    # If the argument skip is given, #each iterates from that row until but
+    # omitting the first unused Row, effectively skipping the first _skip_ Rows
+    # from the top of the Worksheet.
+    def each skip=dimensions[0], &block
+      skip.upto(dimensions[1] - 1) do |idx|
+        block.call row(idx)
+      end
+    end
+    def encoding # :nodoc:
+      @workbook.encoding
+    end
+    ##
+    # Insert a Row at _idx_ (0-based) containing _cells_
+    def insert_row idx, cells=[]
+      res = @rows.insert idx, Row.new(self, idx, cells)
+      updated_from idx
+      res
+    end
+    def inspect
+      "#<#{self.class}:#{object_id} "
+      names = instance_variables
+      names.delete '@rows'
+      variables = names.collect do |name|
+        "%s=%s" % [name, instance_variable_get(name)]
+      end.join(' ')
+      sprintf "#<%s:0x%014x %s @rows[%i]>", self.class, object_id,
+                                            variables, row_count
+    end
+    ##
+    # Replace the Row at _idx_ with the following arguments. Like #update_row,
+    # but truncates the Row if there are fewer arguments than Cells in the Row.
+    def replace_row idx, *cells
+      if(row = @rows[idx]) && cells.size < row.size
+        cells.concat Array.new(row.size - cells.size)
+      end
+      update_row idx, *cells
+    end
+    ##
+    # The Row at _idx_ or a new Row.
+    def row idx
+      @rows[idx] || Row.new(self, idx)
+    end
+    ##
+    # The number of Rows in this Worksheet which contain data.
+    def row_count
+      dimensions[1] - dimensions[0]
+    end
+    ##
+    # Tell Worksheet that the Row at _idx_ has been updated and the #dimensions
+    # need to be recalculated. You should not need to call this directly.
+    def row_updated idx, row
+      @dimensions = nil
+      row = @rows[idx] = shorten(row)
+      format_dates row
+      row
+    end
+    ##
+    # Updates the Row at _idx_ with the following arguments.
+    def update_row idx, *cells
+      res = if row = @rows[idx]
+              row[0, cells.size] = cells
+              row
+            elsif cells = shorten(cells)
+              Row.new self, idx, cells
+            end
+      row_updated idx, res
+      res
+    end
+    ##
+    # Renumbers all Rows starting at _idx_ and calls #row_updated for each of
+    # them.
+    def updated_from idx
+      idx.upto(@rows.size - 1) do |idx|
+        row = row(idx)
+        row.idx = idx
+        row_updated idx, row
+      end
+    end
+    ##
+    # Get the enriched value of the Cell at _row_, _column_.
+    # See also Worksheet#cell, Row#[].
+    def [] row, column
+      row(row)[column]
+    end
+    ##
+    # Set the value of the Cell at _row_, _column_ to _value_.
+    # See also Row#[]=.
+    def []= row, column, value
+      row(row)[column] = value
+    end
+    private
+    def format_dates row # :nodoc:
+      ## If no format is set in a cell which contains a Date or Time, we will
+      #  add a format. At the moment, the number formats correspond to builtin
+      #  Excel number-formats. We may need to add a level of abstraction if
+      #  additional writers are added to the library.
+      return unless row
+      row.each_with_index do |value, idx|
+        unless row.formats[idx]
+          format = nil
+          case value
+          when Date
+            format = @workbook.formats.find do |fmt| fmt.date? end
+            format ||= Format.new :number_format => client('M/D/YY', 'UTF8')
+          when DateTime, Time
+            format = @workbook.formats.find do |fmt| fmt.datetime? end
+            format ||= Format.new :number_format => client('M/D/YY h:mm', 'UTF8')
+          end
+          if format
+            row.formats[idx] = format
+            @workbook.add_format format
+          end
+        end
+      end
+    end
+    def index_of_first ary # :nodoc:
+      return unless ary
+      ary.index(ary.find do |elm| elm end)
+    end
+    def recalculate_dimensions # :nodoc:
+      shorten @rows
+      @dimensions = []
+      @dimensions[0] = index_of_first @rows
+      @dimensions[1] = @rows.size
+      compact = @rows.compact
+      @dimensions[2] = compact.collect do |row| index_of_first row end.compact.min
+      @dimensions[3] = compact.collect do |row| row.size end.max
+      @dimensions
+    end
+    def shorten ary # :nodoc:
+      return unless ary
+      while !ary.empty? && !ary.last
+        ary.pop
+      end
+      ary unless ary.empty?
+    end
+  end
+end

data/lib/spreadsheet/writer.rb

@@ -0,0 +1,29 @@
+module Spreadsheet
+  ##
+  # Parent Class for all Writers. Implements the copying of unmodified
+  # Spreadsheet documents.
+  class Writer
+    def initialize io_or_path
+      @io_or_path = io_or_path
+    end
+    def write workbook
+      if @io_or_path.is_a? IO
+        write_workbook workbook, @io_or_path
+      else
+        File.open(@io_or_path, "wb+") do |fh|
+          write_workbook workbook, fh
+        end
+      end
+    end
+    private
+    def write_workbook workbook, io
+      reader = workbook.io
+      unless io == reader
+        reader.rewind
+        data = reader.read
+        io.rewind
+        io.write data
+      end
+    end
+  end
+end

data/test/excel/row.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# Excel::TestRow -- Spreadsheet -- 12.10.2008 -- hwyss@ywesee.com
+
+$: << File.expand_path('../../lib', File.dirname(__FILE__))
+
+require 'test/unit'
+require 'spreadsheet'
+
+module Spreadsheet
+  module Excel
+class TestRow < Test::Unit::TestCase
+  def setup
+    @workbook = Excel::Workbook.new
+    @worksheet = Excel::Worksheet.new
+    @workbook.add_worksheet @worksheet
+  end
+  def test_date
+    row = Row.new @worksheet, 0, [nil, 27627.6789]
+    assert_equal Date.new(1975,8,21), row.date(1)
+  end
+  def test_datetime
+    row = Row.new @worksheet, 0, [nil, 27627.6789]
+    d1 = DateTime.new(1975,8,21) + 0.6789
+    d2 = row.datetime 1
+    assert_equal d1, d2
+  end
+end
+  end
+end

data/test/font.rb

@@ -0,0 +1,163 @@
+#!/usr/bin/env ruby
+# TestFont -- Spreadsheet -- 09.10.2008 -- hwyss@ywesee.com
+
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'test/unit'
+require 'spreadsheet/font'
+
+module Spreadsheet
+  class TestFont < Test::Unit::TestCase
+    def setup
+      @font = Font.new 'Arial'
+    end
+    def test_italic
+      assert_equal false, @font.italic
+      @font.italic!
+      assert_equal true, @font.italic
+      @font.italic = nil
+      assert_equal false, @font.italic
+      @font.italic = 1
+      assert_equal true, @font.italic
+    end
+    def test_encoding
+      assert_equal :default, @font.encoding
+      @font.encoding = :apple_roman
+      assert_equal :apple_roman, @font.encoding
+      @font.encoding = 'Chinese Simplified'
+      assert_equal :chinese_simplified, @font.encoding
+      assert_raises ArgumentError do @font.size = 'ascii' end
+      assert_equal :chinese_simplified, @font.encoding
+      @font.encoding = nil
+      assert_equal :default, @font.encoding
+    end
+    def test_family
+      assert_equal :none, @font.family
+      @font.family = :roman
+      assert_equal :roman, @font.family
+      @font.family = 'Swiss'
+      assert_equal :swiss, @font.family
+      assert_raises ArgumentError do @font.size = :greek end
+      assert_equal :swiss, @font.family
+      @font.family = nil
+      assert_equal :none, @font.family
+    end
+    def test_name
+      assert_equal 'Arial', @font.name
+      @font.name = 'Helvetica'
+      assert_equal 'Helvetica', @font.name
+    end
+    def test_outline
+      assert_equal false, @font.outline
+      @font.outline!
+      assert_equal true, @font.outline
+      @font.outline = nil
+      assert_equal false, @font.outline
+      @font.outline = 1
+      assert_equal true, @font.outline
+    end
+    def test_escapement
+      assert_equal :normal, @font.escapement
+      @font.escapement = :superscript
+      assert_equal :superscript, @font.escapement
+      @font.escapement = 'sub'
+      assert_equal :subscript, @font.escapement
+      assert_raises ArgumentError do @font.size = "upwards" end
+      assert_equal :subscript, @font.escapement
+      @font.escapement = nil
+      assert_equal :normal, @font.escapement
+    end
+    def test_shadow
+      assert_equal false, @font.shadow
+      @font.shadow!
+      assert_equal true, @font.shadow
+      @font.shadow = nil
+      assert_equal false, @font.shadow
+      @font.shadow = 1
+      assert_equal true, @font.shadow
+    end
+    def test_size
+      assert_equal 10, @font.size  
+      @font.size = 12
+      assert_equal 12, @font.size  
+      @font.size = 11.2
+      assert_equal 11.2, @font.size  
+      assert_raises ArgumentError do @font.size = "123" end
+    end
+    def test_strikeout
+      assert_equal false, @font.strikeout
+      @font.strikeout!
+      assert_equal true, @font.strikeout
+      @font.strikeout = nil
+      assert_equal false, @font.strikeout
+      @font.strikeout = 1
+      assert_equal true, @font.strikeout
+    end
+    def test_underline
+      assert_equal :none, @font.underline
+      @font.underline = :single
+      assert_equal :single, @font.underline
+      @font.underline = 'double accounting'
+      assert_equal :double_accounting, @font.underline
+      assert_raises ArgumentError do @font.size = :triple end
+      assert_equal :double_accounting, @font.underline
+      @font.underline = nil
+      assert_equal :none, @font.underline
+      @font.underline = true
+      assert_equal :single, @font.underline
+    end
+    def test_weight
+      assert_equal :normal, @font.weight
+      @font.weight = :bold
+      assert_equal :bold, @font.weight
+      @font.weight = 100
+      assert_equal 100, @font.weight
+      assert_raises ArgumentError do @font.weight = Object.new end
+      assert_equal 100, @font.weight
+      @font.weight = 'bold'
+      assert_equal :bold, @font.weight
+      @font.weight = nil
+      assert_equal :normal, @font.weight
+    end
+    def test_key
+      expected = 'Arial_10_normal_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.name = 'Helvetica'
+      expected = 'Helvetica_10_normal_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.size = 12
+      expected = 'Helvetica_12_normal_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.weight = :bold
+      expected = 'Helvetica_12_bold_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.italic!
+      expected = 'Helvetica_12_bold_italic_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.strikeout!
+      expected = 'Helvetica_12_bold_italic_strikeout_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.outline!
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.shadow!
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_shadow_normal_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.escapement = :super
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_shadow_superscript_none_text_none_default'
+      assert_equal expected, @font.key
+      @font.underline = :double
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_shadow_superscript_double_text_none_default'
+      assert_equal expected, @font.key
+      @font.color = :blue
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_shadow_superscript_double_blue_none_default'
+      assert_equal expected, @font.key
+      @font.family = :swiss
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_shadow_superscript_double_blue_swiss_default'
+      assert_equal expected, @font.key
+      @font.encoding = :iso_latin1
+      expected = 'Helvetica_12_bold_italic_strikeout_outline_shadow_superscript_double_blue_swiss_iso_latin1'
+      assert_equal expected, @font.key
+    end
+  end
+end