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

Methods

open writer

Classes and Modules

Module Spreadsheet::Compatibility
Module Spreadsheet::Datatypes
Module Spreadsheet::Encodings
Module Spreadsheet::Excel
Class Spreadsheet::Column
Class Spreadsheet::Font
Class Spreadsheet::Format
Class Spreadsheet::Formula
Class Spreadsheet::Link
Class Spreadsheet::Row
Class Spreadsheet::Workbook
Class Spreadsheet::Worksheet
Class Spreadsheet::Writer

Constants

VERSION = '0.6.4.1' The version of Spreadsheet you are using.

Attributes

client_encoding [RW]

Public Class methods

open(io_or_path, mode="rb+", &block)

Parses a Spreadsheet Document and returns a Workbook object. At present, only Excel-Documents can be read.

[Source]

    # File lib/spreadsheet.rb, line 60
60:     def open io_or_path, mode="rb+", &block
61:       if io_or_path.respond_to? :seek
62:         Excel::Workbook.open(io_or_path)
63:       elsif block
64:         File.open(io_or_path, mode) do |fh|
65:           block.call open(fh)
66:         end
67:       else
68:         open File.open(io_or_path, mode)
69:       end
70:     end

writer(io_or_path, type=Excel)

Returns a Writer object for the specified path. At present, only the Excel-Writer is available.

[Source]

    # File lib/spreadsheet.rb, line 75
75:     def writer io_or_path, type=Excel
76:       Excel::Writer::Workbook.new io_or_path
77:     end