keeguon-spreadsheet 0.9.3

data/Manifest.txt

@@ -0,0 +1,85 @@
+.gitignore
+.travis.yml
+GUIDE.md
+Gemfile
+Gemfile.lock
+History.md
+LICENSE.txt
+Manifest.txt
+README.md
+Rakefile
+bin/xlsopcodes
+doc/Excel97-2007BinaryFileFormatSpecification.pdf
+doc/excelfileformat.pdf
+lib/parseexcel.rb
+lib/parseexcel/parseexcel.rb
+lib/parseexcel/parser.rb
+lib/spreadsheet.rb
+lib/spreadsheet/column.rb
+lib/spreadsheet/compatibility.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/password_hash.rb
+lib/spreadsheet/excel/reader.rb
+lib/spreadsheet/excel/reader/biff5.rb
+lib/spreadsheet/excel/reader/biff8.rb
+lib/spreadsheet/excel/rgb.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/n_worksheet.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/helpers.rb
+lib/spreadsheet/link.rb
+lib/spreadsheet/note.rb
+lib/spreadsheet/noteObject.rb
+lib/spreadsheet/row.rb
+lib/spreadsheet/workbook.rb
+lib/spreadsheet/worksheet.rb
+lib/spreadsheet/writer.rb
+spreadsheet.gemspec
+test/data/test_adding_data_to_existing_file.xls
+test/data/test_borders.xls
+test/data/test_changes.xls
+test/data/test_comment.xls
+test/data/test_copy.xls
+test/data/test_datetime.xls
+test/data/test_empty.xls
+test/data/test_formula.xls
+test/data/test_long_sst_record.xls
+test/data/test_margin.xls
+test/data/test_merged_and_protected.xls
+test/data/test_merged_cells.xls
+test/data/test_missing_row.xls
+test/data/test_pagesetup.xls
+test/data/test_version_excel5.xls
+test/data/test_version_excel95.xls
+test/data/test_version_excel97.xls
+test/data/test_version_excel97_2010.xls
+test/data/test_worksheet_visibility.xls
+test/excel/reader.rb
+test/excel/row.rb
+test/excel/writer/workbook.rb
+test/excel/writer/worksheet.rb
+test/font.rb
+test/format.rb
+test/integration.rb
+test/row.rb
+test/suite.rb
+test/workbook.rb
+test/workbook_protection.rb
+test/worksheet.rb

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,80 @@
+### 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'
+require 'spreadsheet/excel/rgb'
+
+# = 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.9.4'
+
+  ##
+  # 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+"
+      if io_or_path.respond_to? :seek
+        Excel::Workbook.open(io_or_path)
+      elsif block_given?
+        File.open(io_or_path, mode) do |fh|
+          yield 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

data/lib/spreadsheet/datatypes.rb

@@ -0,0 +1,161 @@
+require 'spreadsheet/compatibility'
+
+module Spreadsheet
+  ##
+  # This module defines convenience-methods for the definition of Spreadsheet
+  # attributes (boolean, colors and enumerations)
+  module Datatypes
+    include Compatibility
+    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,
+             :xls_color_0,
+             :xls_color_1,
+             :xls_color_2,
+             :xls_color_3,
+             :xls_color_4,
+             :xls_color_5,
+             :xls_color_6,
+             :xls_color_7,
+             :xls_color_8,
+             :xls_color_9,
+             :xls_color_10,
+             :xls_color_11,
+             :xls_color_12,
+             :xls_color_13,
+             :xls_color_14,
+             :xls_color_15,
+             :xls_color_16,
+             :xls_color_17,
+             :xls_color_18,
+             :xls_color_19,
+             :xls_color_20,
+             :xls_color_21,
+             :xls_color_22,
+             :xls_color_23,
+             :xls_color_24,
+             :xls_color_25,
+             :xls_color_26,
+             :xls_color_27,
+             :xls_color_28,
+             :xls_color_29,
+             :xls_color_30,
+             :xls_color_31,
+             :xls_color_32,
+             :xls_color_33,
+             :xls_color_34,
+             :xls_color_35,
+             :xls_color_36,
+             :xls_color_37,
+             :xls_color_38,
+             :xls_color_39,
+             :xls_color_40,
+             :xls_color_41,
+             :xls_color_42,
+             :xls_color_43,
+             :xls_color_44,
+             :xls_color_45,
+             :xls_color_46,
+             :xls_color_47,
+             :xls_color_48,
+             :xls_color_49,
+             :xls_color_50,
+             :xls_color_51,
+             :xls_color_52,
+             :xls_color_53,
+             :xls_color_54,
+             :xls_color_55 ]
+  ##
+  # Define instance methods to read and write boolean attributes.
+  def boolean *args
+    args.each do |key|
+      define_method key do
+        name = ivar_name key
+        !!(instance_variable_get(name) if instance_variables.include?(name))
+      end
+      define_method "#{key}?" do
+        send key
+      end
+      define_method "#{key}=" do |arg|
+        arg = false if arg == 0
+        instance_variable_set(ivar_name(key), !!arg)
+      end
+      define_method "#{key}!" do
+        send "#{key}=", true
+      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 ivar_name(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
+      name = ivar_name key
+      value = instance_variable_get(name) if instance_variables.include? name
+      value || 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(ivar_name(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 ivar_name(key), values.first
+      end
+    end
+  end
+end
+      end
+    end
+  end
+end