spreadsheet 0.6.0

data/Manifest.txt

@@ -0,0 +1,46 @@
+GUIDE.txt
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/parseexcel.rb
+lib/parseexcel/parseexcel.rb
+lib/parseexcel/parser.rb
+lib/spreadsheet.rb
+lib/spreadsheet/datatypes.rb
+lib/spreadsheet/encodings.rb
+lib/spreadsheet/excel.rb
+lib/spreadsheet/excel/error.rb
+lib/spreadsheet/excel/internals.rb
+lib/spreadsheet/excel/internals/biff5.rb
+lib/spreadsheet/excel/internals/biff8.rb
+lib/spreadsheet/excel/offset.rb
+lib/spreadsheet/excel/reader.rb
+lib/spreadsheet/excel/reader/biff5.rb
+lib/spreadsheet/excel/reader/biff8.rb
+lib/spreadsheet/excel/row.rb
+lib/spreadsheet/excel/sst_entry.rb
+lib/spreadsheet/excel/workbook.rb
+lib/spreadsheet/excel/worksheet.rb
+lib/spreadsheet/excel/writer.rb
+lib/spreadsheet/excel/writer/biff8.rb
+lib/spreadsheet/excel/writer/format.rb
+lib/spreadsheet/excel/writer/workbook.rb
+lib/spreadsheet/excel/writer/worksheet.rb
+lib/spreadsheet/font.rb
+lib/spreadsheet/format.rb
+lib/spreadsheet/formula.rb
+lib/spreadsheet/row.rb
+lib/spreadsheet/workbook.rb
+lib/spreadsheet/worksheet.rb
+lib/spreadsheet/writer.rb
+test/data/test_copy.xls
+test/data/test_version_excel5.xls
+test/data/test_version_excel95.xls
+test/data/test_version_excel97.xls
+test/excel/row.rb
+test/font.rb
+test/integration.rb
+test/workbook.rb
+test/worksheet.rb

data/README.txt

@@ -0,0 +1,54 @@
+= Spreadsheet
+
+  http://spreadsheet.rubyforge.org
+
+== Description
+
+The Spreadsheet Library is designed to read and write Spreadsheet Documents.
+As of version 0.6.0, only Microsoft Excel compatible spreadsheets are
+supported. Spreadsheet is a combination/complete rewrite of the
+Spreadsheet::Excel Library by Daniel J. Berger and the ParseExcel Library by
+Hannes Wyss. Spreadsheet can read, write and modify Spreadsheet Documents.
+
+== What's new?
+* Significantly improved memory-efficiency when reading large Excel Files
+* Limited Spreadsheet modification support
+* Improved handling of String Encodings
+
+== Roadmap
+0.7.0:: Improved Format support/Styles
+0.7.1:: Document Modification: Formats/Styles
+0.8.0:: Formula Support
+0.8.1:: Document Modification: Formulas
+0.9.0:: Write-Support: BIFF5
+1.0.0:: Ruby 1.9 Support;
+        Remove backward compatibility code
+
+== Dependencies
+
+* ruby 1.8
+* Iconv
+* ruby-ole[http://code.google.com/p/ruby-ole/]
+
+== Examples
+
+Have a look at the GUIDE[link://files/GUIDE_txt.html].
+
+== Authors
+
+Original Code:
+
+Spreadsheet::Excel:
+Copyright (c) 2005 by Daniel J. Berger (djberg96@gmail.com)
+
+ParseExcel:
+Copyright (c) 2003 by Hannes Wyss (hannes.wyss@gmail.com)
+
+New Code:
+Copyright (c) 2008 by Hannes Wyss (hannes.wyss@gmail.com)
+
+== License
+
+This library is distributed under the GPL. 
+Please see the LICENSE[link://files/LICENSE_txt.html] file.
+

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/spreadsheet.rb'
+
+ENV['RDOCOPT'] = '-c utf8'
+
+Hoe.new('spreadsheet', Spreadsheet::VERSION) do |p|
+  # p.rubyforge_name = 'spreadsheetx' # if different than lowercase project name
+   p.developer('Hannes Wyss', 'hannes.wyss@gmail.com')
+   p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/parseexcel.rb

@@ -0,0 +1,27 @@
+### Spreadsheet - A Library for reading and writing Spreadsheet Documents.
+#
+#   Copyright (C) 2008  Hannes Wyss
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#   Contact Information:
+#
+#     E-Mail: hannes.wyss@gmail.com
+#     P-Mail: ywesee GmbH
+#             Hannes Wyss
+#             Winterthurerstrasse 52
+#             8006 Zürich
+###           Switzerland
+
+require 'parseexcel/parseexcel'

data/lib/parseexcel/parseexcel.rb

@@ -0,0 +1,75 @@
+require 'spreadsheet'
+
+warn <<-EOS
+[DEPRECATED] By requiring 'parseexcel', 'parseexcel/parseexcel' and/or
+             'parseexcel/parser' you are loading a Compatibility layer which
+             provides a drop-in replacement for the ParseExcel library. This
+             code makes the reading of Spreadsheet documents less efficient and
+             will be removed in Spreadsheet version 1.0.0
+EOS
+
+module Spreadsheet
+  ##
+  # The ParseExcel module is provided as a drop-in replacement for the
+  # ParseExcel library. This code is deprecated and will be removed in
+  # Spreadsheet version 1.0.0
+  module ParseExcel
+def ParseExcel.parse path
+  Spreadsheet.open path
+end
+class Worksheet
+  class Cell
+    attr_accessor :value, :kind, :numeric, :code, :book,
+      :format, :rich, :encoding, :annotation
+    def initialize value, format, row, idx
+      @format = format
+      @idx = idx
+      @row = row
+      @value = value
+      @encoding = Spreadsheet.client_encoding
+    end
+    def date
+      @row.date @idx
+    end
+    def datetime
+      @row.datetime @idx
+    end
+    def to_i
+      @value.to_i
+    end
+    def to_f
+      @value.to_f
+    end
+    def to_s(target_encoding=nil)
+      if(target_encoding)
+        begin
+          Iconv.new(target_encoding, @encoding).iconv(@value)
+        rescue
+          Iconv.new(target_encoding, 'ascii').iconv(@value.to_s)
+        end
+      else
+        @value.to_s
+      end
+    end
+    def type
+      if @format && (@format.date? || @format.time?)
+        :date
+      elsif @value.is_a?(Numeric)
+        :numeric
+      else
+        :text
+      end
+    end
+  end
+end
+  end
+  module Excel
+class Reader # :nodoc: all
+  def set_cell worksheet, row, column, xf, value=nil
+    cells = @current_row_block[row] ||= Row.new(nil, row)
+    cells.formats[column] = xf = @workbook.format(xf)
+    cells[column] = ParseExcel::Worksheet::Cell.new(value, xf, cells, column)
+  end
+end
+  end
+end

data/lib/parseexcel/parser.rb

@@ -0,0 +1,11 @@
+require 'parseexcel'
+
+module Spreadsheet
+  module ParseExcel # :nodoc: all
+    class Parser
+      def parse path
+        Spreadsheet.open path
+      end
+    end
+  end
+end

data/lib/spreadsheet.rb

@@ -0,0 +1,79 @@
+### Spreadsheet - A Library for reading and writing Spreadsheet Documents.
+#
+#   Copyright (C) 2008  Hannes Wyss
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#   Contact Information:
+#
+#     E-Mail: hannes.wyss@gmail.com
+#     P-Mail: ywesee GmbH
+#             Hannes Wyss
+#             Winterthurerstrasse 52
+#             8006 Zürich
+###           Switzerland
+
+require 'spreadsheet/excel/workbook'
+require 'spreadsheet/excel/reader'
+
+# = Synopsis
+# The Spreadsheet Library is designed to read and write Spreadsheet Documents.
+# As of version 0.6.0, only Microsoft Excel compatible spreadsheets are
+# supported.
+#
+# == Example
+#  require 'spreadsheet'
+#
+#  book = Spreadsheet.open '/path/to/an/excel-file.xls'
+#  sheet = book.worksheet 0
+#  sheet.each do |row| puts row[0] end
+module Spreadsheet
+
+  ##
+  # The version of Spreadsheet you are using.
+  VERSION = '0.6.0'
+
+  ##
+  # Default client Encoding. Change this value if your application uses a
+  # different Encoding:
+  # Spreadsheet.client_encoding = 'ISO-LATIN-1//TRANSLIT//IGNORE'
+  @client_encoding = 'UTF8'
+
+  class << self
+
+    attr_accessor :client_encoding
+
+    ##
+    # Parses a Spreadsheet Document and returns a Workbook object. At present,
+    # only Excel-Documents can be read.
+    def open io_or_path, mode="rb+", &block
+      if io_or_path.is_a? IO
+        Excel::Workbook.open(io_or_path)
+      elsif block
+        File.open(io_or_path, mode) do |fh|
+          block.call open(fh)
+        end
+      else
+        open File.open(io_or_path, mode)
+      end
+    end
+
+    ##
+    # Returns a Writer object for the specified path. At present, only the
+    # Excel-Writer is available.
+    def writer io_or_path, type=Excel
+      Excel::Writer::Workbook.new io_or_path
+    end
+  end
+end

data/lib/spreadsheet/datatypes.rb

@@ -0,0 +1,99 @@
+module Spreadsheet
+  ##
+  # This module defines convenience-methods for the definition of Spreadsheet
+  # attributes (boolean, colors and enumerations)
+  module Datatypes
+    def Datatypes.append_features mod
+      super
+      mod.module_eval do
+class << self
+  ##
+  # Valid colors for color attributes.
+  COLORS = [ :builtin_black, :builtin_white, :builtin_red, :builtin_green,
+             :builtin_blue, :builtin_yellow, :builtin_magenta, :builtin_cyan,
+             :text, :border, :pattern_bg, :dialog_bg, :chart_text, :chart_bg,
+             :chart_border, :tooltip_bg, :tooltip_text, :aqua,
+             :black, :blue, :cyan, :brown, :fuchsia, :gray, :grey, :green,
+             :lime, :magenta, :navy, :orange, :purple, :red, :silver, :white,
+             :yellow ]
+  ##
+  # Define instance methods to read and write boolean attributes.
+  def boolean *args
+    args.each do |key|
+      define_method key do
+        !!instance_variable_get("@#{key}")
+      end
+      define_method "#{key}?" do
+        !!instance_variable_get("@#{key}")
+      end
+      define_method "#{key}!" do
+        instance_variable_set("@#{key}", true)
+      end
+      define_method "#{key}=" do |arg|
+        arg = false if arg == 0
+        instance_variable_set("@#{key}", !!arg)
+      end
+    end
+  end
+  ##
+  # Define instance methods to read and write color attributes.
+  # For valid colors see COLORS
+  def colors *args
+    args.each do |key|
+      attr_reader key
+      define_method "#{key}=" do |name|
+        name = name.to_s.downcase.to_sym
+        if COLORS.include?(name)
+          instance_variable_set "@#{key}", name
+        else
+          raise ArgumentError, "unknown color '#{name}'"
+        end
+      end
+    end
+  end
+  ##
+  # Define instance methods to read and write enumeration attributes.
+  # * The first argument designates the attribute name.
+  # * The second argument designates the default value.
+  # * All subsequent attributes are possible values.
+  # * If the last attribute is a Hash, each value in the Hash designates
+  #   aliases for the corresponding key.
+  def enum key, *values
+    aliases = {}
+    if values.last.is_a? Hash
+      values.pop.each do |value, synonyms|
+        if synonyms.is_a? Array
+          synonyms.each do |synonym| aliases.store synonym, value end
+        else
+          aliases.store synonyms, value
+        end
+      end
+    end
+    values.each do |value|
+      aliases.store value, value
+    end
+    define_method key do
+      instance_variable_get("@#{key}") || values.first
+    end
+    define_method "#{key}=" do |arg|
+      if arg
+        arg = aliases.fetch arg do
+          aliases.fetch arg.to_s.downcase.gsub(/[ \-]/, '_').to_sym, arg
+        end
+        if values.any? do |val| val === arg end
+          instance_variable_set("@#{key}", arg)
+        else
+          valid = values.collect do |val| val.inspect end.join ', '
+          raise ArgumentError,
+            "Invalid value '#{arg.inspect}' for #{key}. Valid values are: #{valid}"
+        end
+      else
+        instance_variable_set "@#{key}", values.first
+      end
+    end
+  end
+end
+      end
+    end
+  end
+end

data/lib/spreadsheet/encodings.rb

@@ -0,0 +1,49 @@
+module Spreadsheet
+  ##
+  # Methods for Encoding-conversions. You should not need to use any of these.
+  module Encodings
+    if RUBY_VERSION >= '1.9'
+      def ascii string
+        string.encode 'ASCII//TRANSLIT//IGNORE'
+      end
+      def client string, internal='UTF-16LE'
+        string.encode Spreadsheet.client_encoding
+      end
+      def internal string, internal='UTF-16LE'
+        string.encode internal
+      end
+    else
+      require 'iconv'
+      @@utf8_utf16 = Iconv.new('UTF-16LE', 'UTF8')
+      @@utf16_ascii = Iconv.new('ASCII//TRANSLIT//IGNORE', 'UTF-16LE')
+      @@utf16_utf8 = Iconv.new('UTF8//TRANSLIT//IGNORE', 'UTF-16LE')
+      @@iconvs = {}
+      def ascii string
+        @@utf16_ascii.iconv string
+      rescue
+        string.gsub /[^\x20-\x7e]+/, ''
+      end
+      def client string, internal='UTF-16LE'
+        key = [Spreadsheet.client_encoding, internal]
+        iconv = @@iconvs[key] ||= Iconv.new(Spreadsheet.client_encoding, internal)
+        iconv.iconv string
+      end
+      def internal string, internal='UTF-16LE'
+        key = [internal, Spreadsheet.client_encoding]
+        iconv = @@iconvs[key] ||= Iconv.new(internal, Spreadsheet.client_encoding)
+        iconv.iconv string
+      end
+    end
+  rescue LoadError
+    warn "You don't have Iconv support compiled in your Ruby. Spreadsheet may not work as expected"
+    def ascii string
+      string.gsub /[^\x20-\x7e]+/, ''
+    end
+    def client string, internal='UTF-16LE'
+      string.delete "\0"
+    end
+    def internal string, internal='UTF-16LE'
+      string.split('').zip(Array.new(string.size, 0.chr)).join
+    end
+  end
+end