WriteExcel 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Eliot Dahood
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= WriteExcel
+
+Description goes here.
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Eliot Dahood. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "WriteExcel"
+    gem.summary = %Q{Write to a cross-platform Excel binary file With Ruby 1.9.1}
+    gem.description = %Q{An Easy, Fast way to Make Excel 2003 Compatible Files from Ruby.  Write to a cross-platform Excel binary file With Ruby 1.9.1}
+    gem.email = "eliot.dahood@zoho.com"
+    gem.homepage = "http://github.com/edahood/WriteExcel"
+    gem.authors = ["Eliot Dahood"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.has_rdoc  = false
+    gem.add_dependency('ruby-ole', '>=1.2.8.2')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "WriteExcel #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

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/bigfile.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of creating a Spreadsheet::WriteExcel that is larger than the
+# default 7MB limit.
+#
+# It is exactly that same as any other Spreadsheet::WriteExcel program except
+# that is requires that the OLE::Storage module is installed.
+#
+# reverse('©'), Jan 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'
+
+workbook  = Spreadsheet::WriteExcel.new('bigfile.xls')
+worksheet = workbook.add_worksheet
+
+worksheet.set_column(0, 50, 18)
+
+0.upto(50) do |col|
+  0.upto(6000) do |row|
+    worksheet.write(row, col, "Row: #{row} Col: #{col}")
+  end
+end
+
+workbook.close