ruby-spreadsheet 0.6.5

data/README.txt

@@ -0,0 +1,91 @@
+Last Update: 08.12.2010 - Zeno Davatz
+
+
+= Spreadsheet
+
+http://spreadsheet.rubyforge.org
+
+For a viewable directory of all recent changes, please see:
+
+http://scm.ywesee.com/?p=spreadsheet/.git;a=summary
+
+For Non-GPLv3 commercial licencing, please see:
+
+http://www.spreadsheet.ch
+
+
+== 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?
+
+* Supported outline (grouping) functions
+* 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
+* ruby-ole[http://code.google.com/p/ruby-ole/]
+
+
+== Examples
+
+Have a look at the GUIDE[link://files/GUIDE_txt.html].
+
+
+== Installation
+
+Using RubyGems[http://www.rubygems.org]:
+
+* sudo gem install spreadsheet
+
+If you don't like RubyGems[http://www.rubygems.org], let me know which
+installation solution you prefer and I'll include it in the future.
+
+If you can use 'rake' and 'hoe' library is also installed, you can 
+build a gem package as follows:
+
+* rake gem 
+
+The gem package is built in pkg directory.
+
+
+== 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) 2010 ywesee GmbH (mhatakeyama@ywesee.com, zdavatz@ywesee.com)
+
+
+== License
+
+This library is distributed under the GPLv3.
+Please see the LICENSE[link://files/LICENSE_txt.html] file.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ruby-spreadsheet"
+  gem.homepage = "http://github.com/lda/ruby-spreadsheet"
+  gem.license = "GPLv3"
+  gem.summary = %Q{The Spreadsheet Library is designed to read and write Spreadsheet Documents}
+  gem.description = %Q{As of version 0.6.0, only Microsoft Excel compatible spreadsheets are supported}
+  gem.email = "lda@openteam.ru, mhatakeyama@ywesee.com, zdavatz@ywesee.com"
+  gem.authors = ["Dmitry Lihachev", "Masaomi Hatakeyama", "Zeno R.R. Davatz"]
+  gem.add_runtime_dependency 'ruby-ole', '> 1.2'
+  gem.executables << 'xlsopcodes'
+
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-spreadsheet #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.5

data/bin/xlsopcodes

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'spreadsheet'
+
+source, target = ARGV
+
+if source.nil?
+  puts "Usage: #{$0} <source> [<target>]"
+  exit -1
+end
+
+target = target ? File.open(target, 'w') : STDOUT
+
+reader = Spreadsheet::Excel::Reader.new :print_opcodes => target
+reader.setup File.open(source)
+
+while tuple = reader.get_next_chunk
+end

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-2010 ywesee GmbH
+#
+#   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: mhatakeyama@ywesee.com, zdavatz@ywesee.com
+#     P-Mail: ywesee GmbH
+#             Zeno R.R. Davatz
+#             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.5.0'
+
+  ##
+  # Default client Encoding. Change this value if your application uses a
+  # different Encoding:
+  # Spreadsheet.client_encoding = 'ISO-LATIN-1//TRANSLIT//IGNORE'
+  @client_encoding = 'UTF-8'
+
+  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.respond_to? :seek
+        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/column.rb

@@ -0,0 +1,71 @@
+require 'spreadsheet/datatypes'
+
+module Spreadsheet
+  ##
+  # The Column class. Encapsulates column-formatting and width, and provides a
+  # means to iterate over all cells in a column.
+  #
+  # Useful Attributes:
+  # #width::          The width in characters (in respect to the '0' character
+  #                   of the Worksheet's default Font). Float values are
+  #                   permitted, for Excel the available Precision is at 1/256
+  #                   characters.
+  # #default_format:: The default Format for cells in this column (applied if
+  #                   there is no explicit Cell Format and no default Row format
+  #                   for the Cell).
+  # #hidden::         The Column is hidden.
+  # #collapsed::      The Column is collapsed.
+  # #outline_level::  Outline level of the column.
+  class Column
+    class << self
+      def updater *keys
+        keys.each do |key|
+          unless instance_methods.include? "unupdated_#{key}="
+            alias_method :"unupdated_#{key}=", :"#{key}="
+            define_method "#{key}=" do |value|
+              send "unupdated_#{key}=", value
+              @worksheet.column_updated @idx, self if @worksheet
+              value
+            end
+          end
+        end
+      end
+    end
+    include Datatypes
+    include Enumerable
+    attr_accessor :width, :worksheet
+    attr_reader :default_format, :idx
+    boolean :hidden, :collapsed
+    enum :outline_level, 0, Integer
+    updater :collapsed, :hidden, :outline_level, :width
+    def initialize idx, format, opts={}
+      @worksheet = nil
+      @idx = idx
+      opts[:width] ||= 10
+      opts.each do |key, value|
+        self.send "#{key}=", value
+      end
+      self.default_format = format
+    end
+    ##
+    # Set the default Format for Cells in this Column.
+    def default_format= format
+      @worksheet.add_format format if @worksheet
+      @default_format = format
+      @worksheet.column_updated @idx, self if @worksheet
+      format
+    end
+    ##
+    # Iterate over all cells in this column.
+    def each
+      @worksheet.each do |row|
+        yield row[idx]
+      end
+    end
+    def == other # :nodoc:
+      other.is_a?(Column) && default_format == other.default_format \
+        && width == other.width && hidden == other.hidden \
+        && collapsed == other.collapsed && outline_level == other.outline_level
+    end
+  end
+end

data/lib/spreadsheet/compatibility.rb

@@ -0,0 +1,23 @@
+module Spreadsheet
+  module Compatibility
+    ##
+    # One of the most incisive changes in terms of meta-programming in Ruby 1.9
+    # is the switch from representing instance-variable names as Strings to
+    # presenting them as Symbols. ivar_name provides compatibility.
+    if RUBY_VERSION >= '1.9'
+      def ivar_name symbol
+        :"@#{symbol}"
+      end
+      def method_name symbol
+        symbol.to_sym
+      end
+    else
+      def ivar_name symbol
+        "@#{symbol}"
+      end
+      def method_name symbol
+        symbol.to_s
+      end
+    end
+  end
+end