writeexcel¶ ↑

Write to a cross-platform Excel binary file.

Description¶ ↑

This library is converted from Spreadsheet::WriteExcel module of Perl. search.cpan.org/~jmcnamara/Spreadsheet-WriteExcel-2.37/

Some examples written in perl was successfully converted to Ruby. But this library written in Ruby has many bugs, I think.

Original description is below:

The Spreadsheet::WriteExcel module can be used to create a cross-
platform Excel binary file. Multiple worksheets can be added to a
workbook and formatting can be applied to cells. Text, numbers,
formulas, hyperlinks, images and charts can be written to the cells.

TThe Excel file produced by this module is compatible with 97,
2000, 2002, 2003 and 2007.

The module will work on the majority of Windows, UNIX and
Macintosh platforms. Generated files are also compatible with the
spreadsheet applications Gnumeric and OpenOffice.org.

This module cannot be used to read an Excel file.

Usage¶ ↑

See rdoc’s WriteExcel class document or Reference writeexcel.web.fc2.com/ . You must save source file in UTF8 and run ruby with -Ku option or set $KCODE=‘u’.

Example Code:

require 'writeexcel'

# Create a new Excel Workbook
workbook = WriteExcel.new('ruby.xls')

# Add worksheet(s)
worksheet  = workbook.add_worksheet
worksheet2 = workbook.add_worksheet

# Add and define a format
format = workbook.add_format
format.set_bold
format.set_color('red')
format.set_align('right')

# write a formatted and unformatted string.
worksheet.write(1, 1, 'Hi Excel.', format)  # cell B2
worksheet.write(2, 1, 'Hi Excel.')          # cell B3

# write a number and formula using A1 notation
worksheet.write('B4', 3.14159)
worksheet.write('B5', '=SIN(B4/4)')

# write to file
workbook.close

Difference with Perl module¶ ↑

• WriteExcel.new()

  • accept default format parameter such as new(‘foo.xls’, :font => ‘Roman’, :size => 12)

• Unary minus is supported, but it will be stored as ‘-1*’. ex) ‘=-1’ -> ‘=-1*1’, ‘=-SIN(PI()/2)’ => ‘=-1*SIN(PI()/2)’

• Worksheet.write(row, col, token, format)

  • if token.kind_of?(Numeric) then call write_number, if token.kind_of?(String) then not call write_number().

• Worksheet.keep_leading_zeros()

  • ignore. if write 0001, use string such as write(1,2, ‘0001’)

• and .…..

Caution¶ ↑

You must save source file in UTF8 and run ruby with -Ku option or set $KCODE=‘u’ when use urf8 string data.

Recent Changes¶ ↑

v0.6.8

• Bug fix. Worksheet#protect doesn’t work well.

v0.6.7

• Bug fix. Worksheet#set_first_sheet doesn’t work well.

• Bug fix. Worksheet#hide_zero doesn’t work well.

• Bug fix. Worksheet#set_column - col width doesn’t set to zero when pass hidden 1.

‘ v0.6.6

• add private method to avoid warning: private attribute?

v0.6.5

• Bug fix. if workbook already has worksheet of utf8 name, Workbook#add_worksheet, Workbook#add_chart, Workbook#add_chart_ext raise exception when add new worksheet of utf8 name.

v0.6.4

• Bug fix. endless loop when inserted image size > 8224bytes.

v0.6.3

• Bug fix. endless loop when inserted image size > 8224.

v0.6.1

• Bug fix. to avoid output stack trace for debug when defined $debug such as Rails 2.3.8 development console.

v0.6.0

• Bug fix. to avoid destroy to_json method when using with Rails 3

Author¶ ↑

Original was written in Perl by John McNamara (jmcnamara@cpan.org).

Convert to ruby by Hideo Nakamura (cxn03651@msj.biglobe.ne.jp) Copyright © 2009-2010 Hideo NAKAMURA. See LICENSE for details.

License¶ ↑

same as Ruby.

Note on Patches/Pull Requests¶ ↑

• Fork the project.

• Make your feature addition or bug fix.

• Add tests for it. This is important so I don’t break it in a future version unintentionally.

• Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

• Send me a pull request. Bonus points for topic branches.