writeexcel 0.1.0

data/README

@@ -0,0 +1,103 @@
+= WriteExcel
+
+ Write to a cross-platform Excel binary file.
+
+== Description
+
+ This library is converted from  Spreadsheet::WriteExcel module of Perl.
+ http://search.cpan.org/~jmcnamara/Spreadsheet-WriteExcel-2.25/
+
+ Some function does not implemented yet.
+ * import externally generated charts into WriteExcel file.
+ * output is file only. not to a memory.
+ * file property of Excel(such as author, time, etc.) is not supported.
+
+ 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 and images can be written to the cells.
+
+    TThe Excel file produced by this module is compatible with 97,
+    2000, 2002 and 2003.
+
+    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. See
+    Spreadsheet::ParseExcel or look at the main documentation for some
+    suggestions. This module cannot be uses to write to an existing
+    Excel file.
+
+
+== Usage
+
+ Document has not converted yet.
+ reference of methods, see original document.
+ http://search.cpan.org/~jmcnamara/Spreadsheet-WriteExcel-2.25/lib/Spreadsheet/WriteExcel.pm
+
+ 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
+
+* Spreadsheet::WriteExcel.new()
+  * accept default format parameter such as new('foo.xls', :font => 'Roman', :size => 12)
+* 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
+
+ This library can handle multibyte character written in utf8. I tested in Japanese,
+ and it looks work well. But, in this version, utf8 or not is recognized
+ by matching non-ascii characters because ruby 1.8 can not recognize character code
+ correctly.
+
+== Dependencies
+
+ * ruby 1.8
+ * ruby-ole (you can install via rubygem)
+
+== Author
+
+ Original was written in Perl by John McNamara (jmcnamara@cpan.org).
+
+ Convert to ruby by Hideo Nakamura (cxn03651@msj.biglobe.ne.jp)
+
+
+== License
+
+ same as Ruby.

data/examples/a_simple.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+#
+# Example of how to use the WriteExcel module to write text and numbers
+# to an Excel binary file.
+#
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook called simple.xls and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new('a_simple.xls');
+worksheet = workbook.add_worksheet
+
+# The general syntax is write(row, column, token). Note that row and
+# column are zero indexed
+#
+
+# Write some text
+worksheet.write(0, 0,  "Hi Excel!")
+
+
+# Write some numbers
+worksheet.write(2, 0,  3)          # Writes 3
+worksheet.write(3, 0,  3.00000)    # Writes 3
+worksheet.write(4, 0,  3.00001)    # Writes 3.00001
+worksheet.write(5, 0,  3.14159)    # TeX revision no.?
+
+
+# Write some formulas
+worksheet.write(7, 0,  '=A3 + A6')
+worksheet.write(8, 0,  '=IF(A5>3,"Yes", "No")')
+
+
+# Write a hyperlink
+worksheet.write(10, 0, 'http://www.perl.com/')
+
+# File save
+workbook.close

data/examples/autofilters.rb

@@ -0,0 +1,266 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to create autofilters with Spreadsheet::WriteExcel.
+#
+# reverse('©'), September 2007, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'writeexcel'
+
+def get_data
+  [
+    ['East',      'Apple',     9000,      'July'],
+    ['East',      'Apple',     5000,      'July'],
+    ['South',     'Orange',    9000,      'September'],
+    ['North',     'Apple',     2000,      'November'],
+    ['West',      'Apple',     9000,      'November'],
+    ['South',     'Pear',      7000,      'October'],
+    ['North',     'Pear',      9000,      'August'],
+    ['West',      'Orange',    1000,      'December'],
+    ['West',      'Grape',     1000,      'November'],
+    ['South',     'Pear',      10000,     'April'],
+    ['West',      'Grape',     6000,      'January'],
+    ['South',     'Orange',    3000,      'May'],
+    ['North',     'Apple',     3000,      'December'],
+    ['South',     'Apple',     7000,      'February'],
+    ['West',      'Grape',     1000,      'December'],
+    ['East',      'Grape',     8000,      'February'],
+    ['South',     'Grape',     10000,     'June'],
+    ['West',      'Pear',      7000,      'December'],
+    ['South',     'Apple',     2000,      'October'],
+    ['East',      'Grape',     7000,      'December'],
+    ['North',     'Grape',     6000,      'April'],
+    ['East',      'Pear',      8000,      'February'],
+    ['North',     'Apple',     7000,      'August'],
+    ['North',     'Orange',    7000,      'July'],
+    ['North',     'Apple',     6000,      'June'],
+    ['South',     'Grape',     8000,      'September'],
+    ['West',      'Apple',     3000,      'October'],
+    ['South',     'Orange',    10000,     'November'],
+    ['West',      'Grape',     4000,      'July'],
+    ['North',     'Orange',    5000,      'August'],
+    ['East',      'Orange',    1000,      'November'],
+    ['East',      'Orange',    4000,      'October'],
+    ['North',     'Grape',     5000,      'August'],
+    ['East',      'Apple',     1000,      'December'],
+    ['South',     'Apple',     10000,     'March'],
+    ['East',      'Grape',     7000,      'October'],
+    ['West',      'Grape',     1000,      'September'],
+    ['East',      'Grape',     10000,     'October'],
+    ['South',     'Orange',    8000,      'March'],
+    ['North',     'Apple',     4000,      'July'],
+    ['South',     'Orange',    5000,      'July'],
+    ['West',      'Apple',     4000,      'June'],
+    ['East',      'Apple',     5000,      'April'],
+    ['North',     'Pear',      3000,      'August'],
+    ['East',      'Grape',     9000,      'November'],
+    ['North',     'Orange',    8000,      'October'],
+    ['East',      'Apple',     10000,     'June'],
+    ['South',     'Pear',      1000,      'December'],
+    ['North',     'Grape',     10000,     'July'],
+    ['East',      'Grape',     6000,      'February'],
+  ]
+end
+
+#######################################################################
+#
+#  Main
+#
+
+xlsfile = 'autofilters.xls'
+
+workbook = Spreadsheet::WriteExcel.new(xlsfile)
+bp=1
+
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+worksheet3 = workbook.add_worksheet
+worksheet4 = workbook.add_worksheet
+worksheet5 = workbook.add_worksheet
+worksheet6 = workbook.add_worksheet
+
+bold       = workbook.add_format(:bold => 1)
+
+# Extract the data embedded at the end of this file.
+headings = %w(Region    Item      Volume    Month)
+data = get_data
+
+# Set up several sheets with the same data.
+workbook.sheets.each do |worksheet|
+    worksheet.set_column('A:D', 12)
+    worksheet.set_row(0, 20, bold)
+    worksheet.write('A1', headings)
+end
+
+###############################################################################
+#
+# Example 1. Autofilter without conditions.
+#
+
+worksheet1.autofilter('A1:D51')
+worksheet1.write('A2', [data])
+
+###############################################################################
+#
+#
+# Example 2. Autofilter with a filter condition in the first column.
+#
+
+# The range in this example is the same as above but in row-column notation.
+worksheet2.autofilter(0, 0, 50, 3)
+
+# The placeholder "Region" in the filter is ignored and can be any string
+# that adds clarity to the expression.
+#
+worksheet2.filter_column(0, 'Region eq East')
+
+#
+# Hide the rows that don't match the filter criteria.
+#
+row = 1
+
+data.each do |row_data|
+    region = row_data[0]
+
+    if region == 'East'
+        # Row is visible.
+    else
+        # Hide row.
+        worksheet2.set_row(row, nil, nil, 1)
+    end
+
+    worksheet2.write(row, 0, row_data)
+    row += 1
+end
+
+
+###############################################################################
+#
+#
+# Example 3. Autofilter with a dual filter condition in one of the columns.
+#
+
+worksheet3.autofilter('A1:D51')
+
+worksheet3.filter_column('A', 'x eq East or x eq South')
+
+#
+# Hide the rows that don't match the filter criteria.
+#
+row = 1
+
+data.each do |row_data|
+    region = row_data[0]
+
+    if region == 'East' || region == 'South'
+        # Row is visible.
+    else
+        # Hide row.
+        worksheet3.set_row(row, nil, nil, 1)
+    end
+
+    worksheet3.write(row, 0, row_data)
+    row += 1
+end
+
+
+###############################################################################
+#
+#
+# Example 4. Autofilter with filter conditions in two columns.
+#
+
+worksheet4.autofilter('A1:D51')
+
+worksheet4.filter_column('A', 'x eq East')
+worksheet4.filter_column('C', 'x > 3000 and x < 8000' )
+
+#
+# Hide the rows that don't match the filter criteria.
+#
+row = 1
+
+data.each do |row_data|
+    region = row_data[0]
+    volume = row_data[2]
+
+    if region == 'East' && volume >  3000   && volume < 8000
+        # Row is visible.
+    else
+        # Hide row.
+        worksheet4.set_row(row, nil, nil, 1)
+    end
+
+    worksheet4.write(row, 0, row_data)
+    row += 1
+end
+
+
+###############################################################################
+#
+#
+# Example 5. Autofilter with filter for blanks.
+#
+
+# Create a blank cell in our test data.
+data[5][0] = ''
+
+worksheet5.autofilter('A1:D51')
+worksheet5.filter_column('A', 'x == Blanks')
+
+#
+# Hide the rows that don't match the filter criteria.
+#
+row = 1
+
+data.each do |row_data|
+    region = row_data[0]
+
+    if region == ''
+        # Row is visible.
+    else
+        # Hide row.
+        worksheet5.set_row(row, nil, nil, 1)
+    end
+
+    worksheet5.write(row, 0, row_data)
+    row += 1
+end
+
+
+###############################################################################
+#
+#
+# Example 6. Autofilter with filter for non-blanks.
+#
+
+worksheet6.autofilter('A1:D51')
+worksheet6.filter_column('A', 'x == NonBlanks')
+
+#
+# Hide the rows that don't match the filter criteria.
+#
+row = 1
+
+data.each do |row_data|
+    region = row_data[0]
+
+    if region != ''
+        # Row is visible.
+    else
+        # Hide row.
+        worksheet6.set_row(row, nil, nil, 1)
+    end
+
+    worksheet6.write(row, 0, row_data)
+    row += 1
+end
+
+workbook.close
+
+

data/examples/copyformat.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the format copying method with Spreadsheet::WriteExcel #
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'writeexcel'
+
+# Create workbook1
+workbook1       = Spreadsheet::WriteExcel.new("workbook1.xls")
+worksheet1      = workbook1.add_worksheet
+format1a        = workbook1.add_format
+format1b        = workbook1.add_format
+
+# Create workbook2
+workbook2       = Spreadsheet::WriteExcel.new("workbook2.xls")
+worksheet2      = workbook2.add_worksheet
+format2a        = workbook2.add_format
+format2b        = workbook2.add_format
+
+# Create a global format object that isn't tied to a workbook
+global_format   = Format.new
+
+# Set the formatting
+global_format.set_color('blue')
+global_format.set_bold
+global_format.set_italic
+
+# Create another example format
+format1b.set_color('red')
+
+# Copy the global format properties to the worksheet formats
+format1a.copy(global_format)
+format2a.copy(global_format)
+
+# Copy a format from worksheet1 to worksheet2
+format2b.copy(format1b)
+
+# Write some output
+worksheet1.write(0, 0, "Ciao", format1a)
+worksheet1.write(1, 0, "Ciao", format1b)
+
+worksheet2.write(0, 0, "Hello", format2a)
+worksheet2.write(1, 0, "Hello", format2b)
+workbook1.close
+workbook2.close