writeexcel 0.1.0 → 0.3.0

data/examples/stats.rb

@@ -1,75 +1,75 @@
-#!/usr/bin/ruby -w
-
-###############################################################################
-#
-# This is a simple example of how to use functions with the
-# Spreadsheet::WriteExcel module.
-#
-# 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'
-include Spreadsheet
-xlsfile = 'stats.xls'
-
-workbook = Spreadsheet::WriteExcel.new(xlsfile)
-worksheet = workbook.add_worksheet('Test data')
-
-# Set the column width for columns 1
-worksheet.set_column(0, 0, 20)
-
-
-# Create a format for the headings
-format = workbook.add_format
-format.set_bold
-
-
-# Write the sample data
-worksheet.write(0, 0, 'Sample', format)
-worksheet.write(0, 1, 1)
-worksheet.write(0, 2, 2)
-worksheet.write(0, 3, 3)
-worksheet.write(0, 4, 4)
-worksheet.write(0, 5, 5)
-worksheet.write(0, 6, 6)
-worksheet.write(0, 7, 7)
-worksheet.write(0, 8, 8)
-
-worksheet.write(1, 0, 'Length', format)
-worksheet.write(1, 1, 25.4)
-worksheet.write(1, 2, 25.4)
-worksheet.write(1, 3, 24.8)
-worksheet.write(1, 4, 25.0)
-worksheet.write(1, 5, 25.3)
-worksheet.write(1, 6, 24.9)
-worksheet.write(1, 7, 25.2)
-worksheet.write(1, 8, 24.8)
-
-# Write some statistical functions
-worksheet.write(4,  0, 'Count', format)
-worksheet.write(4,  1, '=COUNT(B1:I1)')
-
-worksheet.write(5,  0, 'Sum', format)
-worksheet.write(5,  1, '=SUM(B2:I2)')
-
-worksheet.write(6,  0, 'Average', format)
-worksheet.write(6,  1, '=AVERAGE(B2:I2)')
-
-worksheet.write(7,  0, 'Min', format)
-worksheet.write(7,  1, '=MIN(B2:I2)')
-
-worksheet.write(8,  0, 'Max', format)
-worksheet.write(8,  1, '=MAX(B2:I2)')
-
-worksheet.write(9,  0, 'Standard Deviation', format)
-worksheet.write(9,  1, '=STDEV(B2:I2)')
-
-worksheet.write(10, 0, 'Kurtosis', format)
-worksheet.write(10, 1, '=KURT(B2:I2)')
-
-workbook.close
-
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# This is a simple example of how to use functions with the
+# WriteExcel module.
+#
+# 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'
+include Spreadsheet
+xlsfile = 'stats.xls'
+
+workbook = WriteExcel.new(xlsfile)
+worksheet = workbook.add_worksheet('Test data')
+
+# Set the column width for columns 1
+worksheet.set_column(0, 0, 20)
+
+
+# Create a format for the headings
+format = workbook.add_format
+format.set_bold
+
+
+# Write the sample data
+worksheet.write(0, 0, 'Sample', format)
+worksheet.write(0, 1, 1)
+worksheet.write(0, 2, 2)
+worksheet.write(0, 3, 3)
+worksheet.write(0, 4, 4)
+worksheet.write(0, 5, 5)
+worksheet.write(0, 6, 6)
+worksheet.write(0, 7, 7)
+worksheet.write(0, 8, 8)
+
+worksheet.write(1, 0, 'Length', format)
+worksheet.write(1, 1, 25.4)
+worksheet.write(1, 2, 25.4)
+worksheet.write(1, 3, 24.8)
+worksheet.write(1, 4, 25.0)
+worksheet.write(1, 5, 25.3)
+worksheet.write(1, 6, 24.9)
+worksheet.write(1, 7, 25.2)
+worksheet.write(1, 8, 24.8)
+
+# Write some statistical functions
+worksheet.write(4,  0, 'Count', format)
+worksheet.write(4,  1, '=COUNT(B1:I1)')
+
+worksheet.write(5,  0, 'Sum', format)
+worksheet.write(5,  1, '=SUM(B2:I2)')
+
+worksheet.write(6,  0, 'Average', format)
+worksheet.write(6,  1, '=AVERAGE(B2:I2)')
+
+worksheet.write(7,  0, 'Min', format)
+worksheet.write(7,  1, '=MIN(B2:I2)')
+
+worksheet.write(8,  0, 'Max', format)
+worksheet.write(8,  1, '=MAX(B2:I2)')
+
+worksheet.write(9,  0, 'Standard Deviation', format)
+worksheet.write(9,  1, '=STDEV(B2:I2)')
+
+worksheet.write(10, 0, 'Kurtosis', format)
+worksheet.write(10, 1, '=KURT(B2:I2)')
+
+workbook.close
+

data/examples/stocks.rb

@@ -1,80 +1,80 @@
-  #!/usr/bin/ruby -w
-
-###############################################################################
-#
-# Example of formatting using the Spreadsheet::WriteExcel module
-#
-# This example shows how to use a conditional numerical format
-# with colours to indicate if a share price has gone up or down.
-#
-# 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 and add a worksheet
-workbook  = Spreadsheet::WriteExcel.new("stocks.xls")
-worksheet = workbook.add_worksheet
-
-# Set the column width for columns 1, 2, 3 and 4
-worksheet.set_column(0, 3, 15)
-
-
-# Create a format for the column headings
-header = workbook.add_format
-header.set_bold
-header.set_size(12)
-header.set_color('blue')
-
-
-# Create a format for the stock price
-f_price = workbook.add_format
-f_price.set_align('left')
-f_price.set_num_format('$0.00')
-
-
-# Create a format for the stock volume
-f_volume = workbook.add_format
-f_volume.set_align('left')
-f_volume.set_num_format('#,##0')
-
-
-# Create a format for the price change. This is an example of a conditional
-# format. The number is formatted as a percentage. If it is positive it is
-# formatted in green, if it is negative it is formatted in red and if it is
-# zero it is formatted as the default font colour (in this case black).
-# Note: the [Green] format produces an unappealing lime green. Try
-# [Color 10] instead for a dark green.
-#
-f_change = workbook.add_format
-f_change.set_align('left')
-f_change.set_num_format('[Green]0.0%;[Red]-0.0%;0.0%')
-
-
-# Write out the data
-worksheet.write(0, 0, 'Company', header)
-worksheet.write(0, 1, 'Price',   header)
-worksheet.write(0, 2, 'Volume',  header)
-worksheet.write(0, 3, 'Change',  header)
-
-worksheet.write(1, 0, 'Damage Inc.'     )
-worksheet.write(1, 1, 30.25,     f_price)  # $30.25
-worksheet.write(1, 2, 1234567,   f_volume) # 1,234,567
-worksheet.write(1, 3, 0.085,     f_change) # 8.5% in green
-
-worksheet.write(2, 0, 'Dump Corp.'      )
-worksheet.write(2, 1, 1.56,      f_price)  # $1.56
-worksheet.write(2, 2, 7564,      f_volume) # 7,564
-worksheet.write(2, 3, -0.015,    f_change) # -1.5% in red
-
-worksheet.write(3, 0, 'Rev Ltd.'        )
-worksheet.write(3, 1, 0.13,      f_price)  # $0.13
-worksheet.write(3, 2, 321,       f_volume) # 321
-worksheet.write(3, 3, 0,         f_change) # 0 in the font color (black)
-
-
-workbook.close
+  #!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of formatting using the WriteExcel module
+#
+# This example shows how to use a conditional numerical format
+# with colours to indicate if a share price has gone up or down.
+#
+# 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 and add a worksheet
+workbook  = WriteExcel.new("stocks.xls")
+worksheet = workbook.add_worksheet
+
+# Set the column width for columns 1, 2, 3 and 4
+worksheet.set_column(0, 3, 15)
+
+
+# Create a format for the column headings
+header = workbook.add_format
+header.set_bold
+header.set_size(12)
+header.set_color('blue')
+
+
+# Create a format for the stock price
+f_price = workbook.add_format
+f_price.set_align('left')
+f_price.set_num_format('$0.00')
+
+
+# Create a format for the stock volume
+f_volume = workbook.add_format
+f_volume.set_align('left')
+f_volume.set_num_format('#,##0')
+
+
+# Create a format for the price change. This is an example of a conditional
+# format. The number is formatted as a percentage. If it is positive it is
+# formatted in green, if it is negative it is formatted in red and if it is
+# zero it is formatted as the default font colour (in this case black).
+# Note: the [Green] format produces an unappealing lime green. Try
+# [Color 10] instead for a dark green.
+#
+f_change = workbook.add_format
+f_change.set_align('left')
+f_change.set_num_format('[Green]0.0%;[Red]-0.0%;0.0%')
+
+
+# Write out the data
+worksheet.write(0, 0, 'Company', header)
+worksheet.write(0, 1, 'Price',   header)
+worksheet.write(0, 2, 'Volume',  header)
+worksheet.write(0, 3, 'Change',  header)
+
+worksheet.write(1, 0, 'Damage Inc.'     )
+worksheet.write(1, 1, 30.25,     f_price)  # $30.25
+worksheet.write(1, 2, 1234567,   f_volume) # 1,234,567
+worksheet.write(1, 3, 0.085,     f_change) # 8.5% in green
+
+worksheet.write(2, 0, 'Dump Corp.'      )
+worksheet.write(2, 1, 1.56,      f_price)  # $1.56
+worksheet.write(2, 2, 7564,      f_volume) # 7,564
+worksheet.write(2, 3, -0.015,    f_change) # -1.5% in red
+
+worksheet.write(3, 0, 'Rev Ltd.'        )
+worksheet.write(3, 1, 0.13,      f_price)  # $0.13
+worksheet.write(3, 2, 321,       f_volume) # 321
+worksheet.write(3, 3, 0,         f_change) # 0 in the font color (black)
+
+
+workbook.close

data/examples/tab_colors.rb

@@ -1,30 +1,30 @@
-#!/usr/bin/ruby -w
-
-#######################################################################
-#
-# Example of how to set Excel worksheet tab colours.
-#
-# reverse('©'), May 2006, 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'
-
-workbook   = Spreadsheet::WriteExcel.new('tab_colors.xls')
-
-worksheet1 =  workbook.add_worksheet
-worksheet2 =  workbook.add_worksheet
-worksheet3 =  workbook.add_worksheet
-worksheet4 =  workbook.add_worksheet
-
-# Worsheet1 will have the default tab colour.
-worksheet2.set_tab_color('red')
-worksheet3.set_tab_color('green')
-worksheet4.set_tab_color(0x35) # Orange
-
-workbook.close
-
-workbook.close
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to set Excel worksheet tab colours.
+#
+# reverse('©'), May 2006, 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'
+
+workbook   = WriteExcel.new('tab_colors.xls')
+
+worksheet1 =  workbook.add_worksheet
+worksheet2 =  workbook.add_worksheet
+worksheet3 =  workbook.add_worksheet
+worksheet4 =  workbook.add_worksheet
+
+# Worsheet1 will have the default tab colour.
+worksheet2.set_tab_color('red')
+worksheet3.set_tab_color('green')
+worksheet4.set_tab_color(0x35) # Orange
+
+workbook.close
+
+workbook.close

data/examples/write_arrays.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to use the WriteExcel module to
+# write 1D and 2D arrays of data.
+#
+require 'rubygems'
+require 'writeexcel'
+
+workbook   = WriteExcel.new("write_arrays.xls")
+worksheet1 = workbook.add_worksheet('Example 1')
+worksheet2 = workbook.add_worksheet('Example 2')
+worksheet3 = workbook.add_worksheet('Example 3')
+worksheet4 = workbook.add_worksheet('Example 4')
+worksheet5 = workbook.add_worksheet('Example 5')
+worksheet6 = workbook.add_worksheet('Example 6')
+worksheet7 = workbook.add_worksheet('Example 7')
+worksheet8 = workbook.add_worksheet('Example 8')
+
+format     = workbook.add_format(:color => 'red', :bold => 1)
+format_cmd = workbook.add_format(:color => 'blue', :bold => 1)
+# Data arrays used in the following examples.
+# undef values are written as blank cells (with format if specified).
+#
+array   =   [ 'one', 'two', nil, 'four' ]
+
+array2d =   [
+                    ['maggie', 'milly', 'molly', 'may'  ],
+                    [13,       14,      15,      16     ],
+                    ['shell',  'star',  'crab',  'stone'],
+            ]
+
+# 1. Write a row of data using an array.
+#
+#    array[0]   array[1]   array[2]
+worksheet1.write('A1', "worksheet1.write('A3', array)", format_cmd)
+worksheet1.write('A3', array)
+
+# 2. Write a data using an array of array.
+#
+#    array[0]
+#    array[1]
+#    array[2]
+worksheet2.write('A1', "worksheet2.write('A3', [ array ])", format_cmd)
+worksheet2.write('A3', [ array ])
+
+# 3. Write a row of data using an explicit write_row() method call.
+#    This is the same as calling write() in Ex. 1 above.
+#
+worksheet3.write('A1', "worksheet3.write_row('A3', array)", format_cmd)
+worksheet3.write_row('A3', array)
+
+# 4. Write a column of data using the write_col() method call.
+#    This is same as Ex. 2 above.
+worksheet4.write('A1', "worksheet4.write_col('A3', array)", format_cmd)
+worksheet4.write_col('A3', array)
+
+# 5. Write a 2D array in col-row order.
+#    array[0][0]   array[1][0]  ...
+#    array[0][1]   array[1][1]  ...
+#    array[0][2]   array[1][2]  ...
+worksheet5.write('A1', "worksheet5.write('A3', array2d)", format_cmd)
+worksheet5.write('A3', array2d)
+
+# 6. Write a 2D array in row-col order using array of 2D array.
+#    array[0][0]   array[0][1]  ...
+#    array[1][0]   array[1][1]  ...
+#    array[2][0]   array[2][1]  ...
+worksheet6.write('A1', "worksheet6.write('A3', [ array2d ] )", format_cmd)
+worksheet6.write('A3', [ array2d ] )
+
+# 7. Write a 2D array in row-col order using write_col().
+#    This is same as Ex. 6 above.
+worksheet7.write('A1', "worksheet7.write_col('A3', array2d)", format_cmd)
+worksheet7.write_col('A3', array2d)
+
+# 8. Write a row of data with formatting. The blank cell is also formatted.
+worksheet8.write('A1', "worksheet8.write('A3', array, format)", format_cmd)
+worksheet8.write('A3', array, format)
+
+workbook.close