ruby-spreadsheet 0.6.5

data/lib/spreadsheet/workbook.rb

@@ -0,0 +1,120 @@
+require 'spreadsheet/format'
+require 'spreadsheet/encodings'
+
+module Spreadsheet
+  ##
+  # The Workbook class represents a Spreadsheet-Document and is the entry point
+  # for all Spreadsheet manipulation.
+  #
+  # Interesting Attributes:
+  # #default_format:: The default format used for all cells in this Workbook.
+  #                   that have no format set explicitly or in
+  #                   Row#default_format or Worksheet#default_format.
+  class Workbook
+    include Spreadsheet::Encodings
+    attr_reader :io, :worksheets, :formats, :fonts
+    attr_accessor :active_worksheet, :encoding, :default_format, :version
+    def initialize io = nil, opts={:default_format => Format.new}
+      @worksheets = []
+      @io = io
+      @fonts = []
+      @formats = []
+      if @default_format = opts[:default_format]
+        @formats.push @default_format
+      end
+    end
+    ##
+    # Add a Font to the Workbook. Used by the parser. You should not need to
+    # use this Method.
+    def add_font font
+      @fonts.push(font).uniq! if font
+      font
+    end
+    ##
+    # Add a Format to the Workbook. If you use Row#set_format, you should not
+    # need to use this Method.
+    def add_format format
+      @formats.push(format) if format && !@formats.include?(format)
+      format
+    end
+    ##
+    # Add a Worksheet to the Workbook.
+    def add_worksheet worksheet
+      worksheet.workbook = self
+      @worksheets.push worksheet
+      worksheet
+    end
+    ##
+    # Create a new Worksheet in this Workbook.
+    # Used without options this creates a Worksheet with the name 'WorksheetN'
+    # where the new Worksheet is the Nth Worksheet in this Workbook.
+    #
+    # Use the option <em>:name => 'My pretty Name'</em> to override this
+    # behavior.
+    def create_worksheet opts = {}
+      opts[:name] ||= client("Worksheet#{@worksheets.size.next}", 'UTF-8')
+      add_worksheet Worksheet.new(opts)
+    end
+    ##
+    # The Font at _idx_
+    def font idx
+      @fonts[idx]
+    end
+    ##
+    # The Format at _idx_, or - if _idx_ is a String -
+    # the Format with name == _idx_
+    def format idx
+      case idx
+      when Integer
+        @formats[idx] || @default_format
+      when String
+        @formats.find do |fmt| fmt.name == idx end
+      end
+    end
+    def inspect
+      variables = (instance_variables - uninspect_variables).collect do |name|
+        "%s=%s" % [name, instance_variable_get(name)]
+      end.join(' ')
+      uninspect = uninspect_variables.collect do |name|
+        var = instance_variable_get name
+        "%s=%s[%i]" % [name, var.class, var.size]
+      end.join(' ')
+      sprintf "#<%s:0x%014x %s %s>", self.class, object_id,
+                                     variables, uninspect
+    end
+    def uninspect_variables # :nodoc:
+      %w{@formats @fonts @worksheets}
+    end
+    ##
+    # The Worksheet at _idx_, or - if _idx_ is a String -
+    # the Worksheet with name == _idx_
+    def worksheet idx
+      case idx
+      when Integer
+        @worksheets[idx]
+      when String
+        @worksheets.find do |sheet| sheet.name == idx end
+      end
+    end
+    ##
+    # Write this Workbook to a File, IO Stream or Writer Object. The latter will
+    # make more sense once there are more than just an Excel-Writer available.
+    def write io_path_or_writer
+      if io_path_or_writer.is_a? Writer
+        io_path_or_writer.write self
+      else
+        writer(io_path_or_writer).write(self)
+      end
+    end
+    ##
+    # Returns a new instance of the default Writer class for this Workbook (can
+    # only be an Excel::Writer::Workbook at this time)
+    def writer io_or_path, type=Excel, version=self.version
+      if type == Excel
+        Excel::Writer::Workbook.new io_or_path
+      else
+        raise NotImplementedError, "No Writer defined for #{type}"
+      end
+    end
+  end
+end

data/lib/spreadsheet/worksheet.rb

@@ -0,0 +1,279 @@
+require 'date'
+require 'spreadsheet/column'
+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.
+  # #columns       :: The Column formatting in this Worksheet. Column
+  #                   instances may appear at more than one position in #columns.
+  #                   If you modify a Column directly, your changes will be
+  #                   reflected in all those positions.
+  # #selected      :: When a user chooses to print a Workbook, Excel will include
+  #                   all selected Worksheets. If no Worksheet is selected at
+  #                   Workbook#write, then the first Worksheet is selected by
+  #                   default.
+  class Worksheet
+    include Spreadsheet::Encodings
+    include Enumerable
+    attr_accessor :name, :selected, :workbook, :orientation
+    attr_accessor :fit_width_to_pages, :fit_height_to_pages
+    attr_reader :rows, :columns
+    def initialize opts={}
+      @default_format = nil
+      @selected = opts[:selected]
+      @dimensions = [0,0,0,0]
+      @orientation = :portrait
+      @name = opts[:name] || 'Worksheet'
+      @workbook = opts[:workbook]
+      @rows = []
+      @columns = []
+      @links = {}
+    end
+    def active # :nodoc:
+      warn "Worksheet#active is deprecated. Please use Worksheet#selected instead."
+      selected
+    end
+    def active= selected # :nodoc:
+      warn "Worksheet#active= is deprecated. Please use Worksheet#selected= instead."
+      self.selected = selected
+    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 if fmt
+    end
+    ##
+    # Get the enriched value of the Cell at _row_, _column_.
+    # See also Worksheet#[], Row#[].
+    def cell row, column
+      row(row)[column]
+    end
+    ##
+    # Returns the Column at _idx_.
+    def column idx
+      @columns[idx] || Column.new(idx, default_format, :worksheet => self)
+    end
+    ##
+    # The number of columns in this Worksheet which contain data.
+    def column_count
+      dimensions[3] - dimensions[2]
+    end
+    def column_updated idx, column
+      @columns[idx] = column
+    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
+      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
+    ##
+    # Sets the default Format of the column at _idx_.
+    #
+    # _idx_ may be an Integer, or an Enumerable that iterates over a number of
+    # Integers.
+    #
+    # _format_ is a Format, or nil if you want to remove the Formatting at _idx_
+    #
+    # Returns an instance of Column if _idx_ is an Integer, an Array of Columns
+    # otherwise.
+    def format_column idx, format=nil, opts={}
+      opts[:worksheet] = self
+      res = case idx
+            when Integer
+              column = nil
+              if format
+                column = Column.new(idx, format, opts)
+              end
+              @columns[idx] = column
+            else
+              idx.collect do |col| format_column col, format, opts end
+            end
+      shorten @columns
+      res
+    end
+    ##
+    # Formats all Date, DateTime and Time cells with _format_ or the default
+    # formats:
+    # - 'DD.MM.YYYY' for Date
+    # - 'DD.MM.YYYY hh:mm:ss' for DateTime and Time
+    def format_dates! format=nil
+      each do |row|
+        row.each_with_index do |value, idx|
+          unless row.formats[idx] || row.format(idx).date_or_time?
+            numfmt = case value
+                     when DateTime, Time
+                       format || client('DD.MM.YYYY hh:mm:ss', 'UTF-8')
+                     when Date
+                       format || client('DD.MM.YYYY', 'UTF-8')
+                     end
+            case numfmt
+            when Format
+              row.set_format idx, numfmt
+            when String
+              fmt = row.format(idx).dup
+              fmt.number_format = numfmt
+              row.set_format idx, fmt
+            end
+          end
+        end
+      end
+    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
+      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
+    ## The last Row containing any data
+    def last_row
+      row(last_row_index)
+    end
+    ## The index of the last Row containing any data
+    def last_row_index
+      [dimensions[1] - 1, 0].max
+    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
+      @rows[idx] = 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
+            else
+              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 index
+      index.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 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) || 0
+      @dimensions[1] = @rows.size
+      compact = @rows.compact
+      @dimensions[2] = compact.collect do |row| row.first_used end.compact.min || 0
+      @dimensions[3] = compact.collect do |row| row.first_unused end.max || 0
+      @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,30 @@
+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.respond_to? :seek
+        @io_or_path.binmode
+        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/ruby-spreadsheet.gemspec

@@ -0,0 +1,126 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-spreadsheet}
+  s.version = "0.6.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dmitry Lihachev", "Masaomi Hatakeyama", "Zeno R.R. Davatz"]
+  s.date = %q{2010-12-20}
+  s.description = %q{As of version 0.6.0, only Microsoft Excel compatible spreadsheets are supported}
+  s.email = %q{lda@openteam.ru, mhatakeyama@ywesee.com, zdavatz@ywesee.com}
+  s.executables = ["xlsopcodes", "xlsopcodes"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.txt"
+  ]
+  s.files = [
+    ".document",
+    "GUIDE.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "History.txt",
+    "LICENSE.txt",
+    "README.txt",
+    "Rakefile",
+    "VERSION",
+    "bin/xlsopcodes",
+    "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/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/helpers.rb",
+    "lib/spreadsheet/link.rb",
+    "lib/spreadsheet/row.rb",
+    "lib/spreadsheet/workbook.rb",
+    "lib/spreadsheet/worksheet.rb",
+    "lib/spreadsheet/writer.rb",
+    "ruby-spreadsheet.gemspec",
+    "test/data/test_changes.xls",
+    "test/data/test_copy.xls",
+    "test/data/test_datetime.xls",
+    "test/data/test_empty.xls",
+    "test/data/test_formula.xls",
+    "test/data/test_missing_row.xls",
+    "test/data/test_version_excel5.xls",
+    "test/data/test_version_excel95.xls",
+    "test/data/test_version_excel97.xls",
+    "test/excel/row.rb",
+    "test/excel/writer/worksheet.rb",
+    "test/font.rb",
+    "test/integration.rb",
+    "test/row.rb",
+    "test/suite.rb",
+    "test/workbook.rb",
+    "test/worksheet.rb"
+  ]
+  s.homepage = %q{http://github.com/lda/ruby-spreadsheet}
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{The Spreadsheet Library is designed to read and write Spreadsheet Documents}
+  s.test_files = [
+    "test/excel/row.rb",
+    "test/excel/writer/worksheet.rb",
+    "test/font.rb",
+    "test/integration.rb",
+    "test/row.rb",
+    "test/suite.rb",
+    "test/workbook.rb",
+    "test/worksheet.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-ole>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<ruby-ole>, ["> 1.2"])
+    else
+      s.add_dependency(%q<ruby-ole>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-ole>, ["> 1.2"])
+    end
+  else
+    s.add_dependency(%q<ruby-ole>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-ole>, ["> 1.2"])
+  end
+end
+