write_xlsx 0.0.4 → 0.51.0

data/Gemfile

@@ -6,7 +6,9 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem "bundler"
+end
+group :test do
+  gem "rdoc"
 end

data/README.rdoc

@@ -1,6 +1,6 @@
 = write_xlsx
 
-gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem. write_xlsx is converted from Perl's module https://github.com/jmcnamara/excel-writer-xlsx .
+gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem. write_xlsx is converted from Perl's module Excel::Writer::XLSX-0.51, https://github.com/jmcnamara/excel-writer-xlsx .
 
 == Description
 
@@ -15,6 +15,9 @@ The WriteXLSX supports the following features:
 * Charts
 * Autofilters
 * Data validation
+* Conditional formatting
+* Tables
+* Shapes
 * Hyperlinks
 * Defined names
 * Grouping/Outlines
@@ -24,14 +27,10 @@ The WriteXLSX supports the following features:
 
 write_xlsx uses the same interface as writeexcel gem.
 
-documentation is not completed, but writeexcel's documentation will help you. See http://writeexcel.web.fc2.com/
-
-And you can find many examples in this gem.
-
 == Synopsis
 
-To write a string, a formatted string, a number and a formula to the first worksheet
-in an Excel XMLX spreadsheet called ruby.xlsx:
+To write a string, a formatted string, a number and a formula to
+the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 
   require 'rubygems'
   require 'write_xlsx'
@@ -42,7 +41,7 @@ in an Excel XMLX spreadsheet called ruby.xlsx:
   # Add a worksheet
   worksheet = workbook.add_worksheet
 
-  #  Add and define a format
+  # Add and define a format
   format = workbook.add_format # Add a format
   format.set_bold
   format.set_color('red')
@@ -56,10 +55,14 @@ in an Excel XMLX spreadsheet called ruby.xlsx:
   # Write a number and a formula using A1 notation
   worksheet.write('A3', 1.2345)
   worksheet.write('A4', '=SIN(PI()/4)')
+
   workbook.close
 
 == Recent change
 
+2012-11-30 v0.51.0
+ Impliment Shape, Table as welll as Excel::Write::XLSX-0.51
+
 2012-02-14 v0.0.4
  Fix for x-axis major/minor units in scatter charts.(CPAN_0.46)
 
@@ -72,11 +75,12 @@ in an Excel XMLX spreadsheet called ruby.xlsx:
 == Copyright
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
-Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp) Copyright (c) 2012 HIDEO NAKAMURA. See LICENSE.txt for further details.
+Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp)
+Copyright (c) 2012 HIDEO NAKAMURA. See LICENSE.txt for further details.
 
 == Contributing to write_xlsx
 
-* repsitory: http://github.com/cxn03651/write_xlsx 
+* repsitory: http://github.com/cxn03651/write_xlsx
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -84,5 +88,3 @@ Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp) Copyright (c) 20
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-

data/Rakefile

@@ -57,17 +57,17 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.51.0

data/examples/chart_secondary_axis.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of a Line chart with a secondary axis in WriteXLSX.
+#
+# reverse(c), March 2011, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_secondary_axis.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = [ 'Aliens', 'Humans']
+data = [
+    [ 2,  3,  4,  5,  6,  7 ],
+    [ 10, 40, 50, 20, 10, 50 ]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+# Create a new chart object. In this case an embedded chart.
+chart = workbook.add_chart(:type => 'line', :embedded => 1)
+
+# Configure the first series.
+chart.add_series(
+    :name    => '=Sheet1!$A$1',
+    :values  => '=Sheet1!$A$2:$A$7',
+    :y2_axis => 1
+)
+
+chart.add_series(
+    :name       => '=Sheet1!$B$1',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+chart.set_legend(:position => 'right')
+
+# Add a chart title and some axis labels.
+chart.set_title(:name => 'Survey results')
+chart.set_x_axis(:name => 'Days')
+chart.set_y_axis(:name => 'Population', :major_gridlines => {:show => 0})
+chart.set_y2_axis(:name => 'Laser wounds')
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D2', chart, 25, 10)
+
+workbook.close

data/examples/date_time.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# WriteXLSX example of writing detes and times using the
+# Worksheet#write_date_time.
+#
+# reverse(c), March 2001, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('date_time.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Expand the first column so that the date is visible.
+worksheet.set_column('A:B', 30)
+
+# Write the column headers.
+worksheet.write('A1', 'Formatted date', bold)
+worksheet.write('B1', 'Format',         bold)
+
+# Examples date and time formats. In the outpu file compare how changing
+# the format codes change the appearance of the date.
+#
+date_formats = [
+    'dd/mm/yy',
+    'mm/dd/yy',
+    '',
+    'd mm yy',
+    'dd mm yy',
+    '',
+    'dd m yy',
+    'dd mm yy',
+    'dd mmm yy',
+    'dd mmmm yy',
+    '',
+    'dd mm y',
+    'dd mm yyy',
+    'dd mm yyyy',
+    '',
+    'd mmmm yyyy',
+    '',
+    'dd/mm/yy',
+    'dd/mm/yy hh:mm',
+    'dd/mm/yy hh:mm:ss',
+    'dd/mm/yy hh:mm:ss.000',
+    '',
+    'hh:mm',
+    'hh:mm:ss',
+    'hh:mm:ss.000'
+               ]
+
+# Write the same date and time using each of the above formats. The empty
+# string formats create a blank line to make the example clearer.
+#
+row = 0
+date_formats.each do |date_format|
+  row += 1
+  next if date_format == ''
+
+  # Create a format for the date or time.
+  format = workbook.add_format(
+                               :num_format => date_format,
+                               :align      => 'left'
+                               )
+
+  # Write the same date using different formats.
+  worksheet.write_date_time(row, 0, '2004-08-01T12:30:45.123', format)
+  worksheet.write(row, 1, date_format)
+end
+
+# The following is an example of an invalid date. It is writen as a string
+# instead of a number. This is also Excel's default behaviour.
+#
+row += 2
+worksheet.write_date_time(row, 0, '2004-13-01T12:30:45.123')
+worksheet.write(row, 1, 'Invalid date. Written as string.', bold)
+
+workbook.close

data/examples/panes.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of using the Excel::Writer::XLSX module to create worksheet panes.
+#
+# reverse(c), May 2001, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Create a new workbook called simple.xls and add a worksheet
+workbook  = WriteXLSX.new('panes.xlsx')
+
+worksheet1 = workbook.add_worksheet('Panes 1')
+worksheet2 = workbook.add_worksheet('Panes 2')
+worksheet3 = workbook.add_worksheet('Panes 3')
+worksheet4 = workbook.add_worksheet('Panes 4')
+
+# Freeze panes
+worksheet1.freeze_panes(1, 0)    # 1 row
+
+worksheet2.freeze_panes(0, 1)    # 1 column
+worksheet3.freeze_panes(1, 1)    # 1 row and column
+
+# Split panes.
+# The divisions must be specified in terms of row and column dimensions.
+# The default row height is 15 and the default column width is 8.43
+#
+worksheet4.split_panes(15, 8.43)    # 1 row and column
+
+#######################################################################
+#
+# Set up some formatting and text to highlight the panes
+#
+
+header = workbook.add_format(
+                             :align    => 'center',
+                             :valign   => 'vcenter',
+                             :fg_color => 0x2A
+                             )
+
+center = workbook.add_format(:align => 'center')
+
+#######################################################################
+#
+# Sheet 1
+#
+
+worksheet1.set_column('A:I', 16)
+worksheet1.set_row(0, 20)
+worksheet1.set_selection('C3')
+
+(0..8).each { |i| worksheet1.write(0, i, 'Scroll down', header) }
+(1..100).each do |i|
+  (0..8).each {|j| worksheet1.write(i, j, i + 1, center)}
+end
+
+#######################################################################
+#
+# Sheet 2
+#
+
+worksheet2.set_column('A:A', 16)
+worksheet2.set_selection('C3')
+
+(0..49).each do |i|
+  worksheet2.set_row(i, 15)
+  worksheet2.write(i, 0, 'Scroll right', header)
+end
+
+(0..49).each do |i|
+  (1..25).each {|j| worksheet2.write(i, j, j, center)}
+end
+
+#######################################################################
+#
+# Sheet 3
+#
+
+worksheet3.set_column('A:Z', 16)
+worksheet3.set_selection('C3')
+
+worksheet3.write(0, 0, '', header)
+
+(1..25).each {|i| worksheet3.write(0, i, 'Scroll down', header)}
+(1..49).each {|i| worksheet3.write(i, 0, 'Scroll right', header)}
+(1..49).each do |i|
+  (1..25).each {|j| worksheet3.write(i, j, j, center)}
+end
+
+#######################################################################
+#
+# Sheet 4
+#
+
+worksheet4.set_selection('C3')
+
+(1..25).each {|i| worksheet4.write(0, i, 'Scroll', center)}
+(1..49).each {|i| worksheet4.write(i, 0, 'Scroll', center)}
+(1..49).each do |i|
+  (1..25).each {|j| worksheet4.write(i, j, j, center)}
+end
+
+workbook.close

data/examples/regions.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# An example of how to use the WriteXLSX gem to write a basic
+# Excel workbook with multiple worksheets.
+#
+# reverse(c), March 2001, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('regions.xlsx')
+
+# Add some worksheets
+north = workbook.add_worksheet('North')
+south = workbook.add_worksheet('South')
+east  = workbook.add_worksheet('East')
+west  = workbook.add_worksheet('West')
+
+# Add a Format
+format = workbook.add_format
+format.set_bold
+format.set_color('blue')
+
+# Add a caption to each worksheet
+workbook.sheets.each do |worksheet|
+  worksheet.write(0, 0, 'Sales', format)
+end
+
+# Write some data
+north.write(0, 1, 200000)
+south.write(0, 1, 100000)
+east.write(0, 1, 150000)
+west.write(0, 1, 100000)
+
+# Set the active worksheet
+south.activate
+
+# Set the width of the first column
+south.set_column(0, 0, 20)
+
+# Set the active cell
+south.set_selection(0, 1)
+
+workbook.close

data/examples/shape1.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A simple example of how to use the WriteXLSX gem to
+# add shapes to an Excel xlsx file.
+#
+# reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
+# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('shape1.xlsx')
+worksheet = workbook.add_worksheet
+
+# Add a circle, with centered text.
+ellipse = workbook.add_shape(
+            :type   => 'ellipse',
+            :text   => "Hello\nWorld",
+            :width  => 60,
+            :height => 60
+                             )
+worksheet.insert_shape('A1', ellipse, 50, 50)
+
+# Add a plus sign.
+plus = workbook.add_shape(
+         :type => 'plus',
+         :width => 20,
+         :height => 20
+                          )
+worksheet.insert_shape('D8', plus)
+
+workbook.close