WriteExcel 0.2.0

data/spec/WriteExcel_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Writeexcel" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'WriteExcel'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/test/tc_all.rb

@@ -0,0 +1,31 @@
+require "tc_biff"
+require "tc_ole"
+require "tc_workbook"
+require "tc_worksheet"
+require "tc_format"
+require "tc_formula"
+require 'tc_chart'
+require "test_00_IEEE_double"
+require 'test_01_add_worksheet'
+require 'test_02_merge_formats'
+require 'test_04_dimensions'
+require 'test_05_rows'
+require 'test_06_extsst'
+require 'test_11_date_time'
+require 'test_12_date_only'
+require 'test_13_date_seconds'
+require 'test_21_escher'
+require 'test_22_mso_drawing_group'
+require 'test_23_note'
+require 'test_24_txo'
+require 'test_26_autofilter'
+require 'test_27_autofilter'
+require 'test_28_autofilter'
+require 'test_29_process_jpg'
+require 'test_30_validation_dval'
+require 'test_31_validation_dv_strings'
+require 'test_32_validation_dv_formula'
+require 'test_40_property_types'
+require 'test_41_properties'
+require 'test_42_set_properties'
+require 'tc_example_match'

data/test/tc_biff.rb

@@ -0,0 +1,104 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "test/unit"
+require "WriteExcel"
+
+class TC_BIFFWriter < Test::Unit::TestCase
+
+  TEST_DIR    = File.expand_path(File.dirname(__FILE__))
+  PERL_OUTDIR = File.join(TEST_DIR, 'perl_output')
+
+  def setup
+    t = Time.now.strftime("%Y%m%d")
+    path = "temp#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+    @test_file  = File.join(Dir.tmpdir, path)
+    @biff = BIFFWriter.new
+    @ruby_file = @test_file
+  end
+
+  def test_append_no_error
+    assert_nothing_raised{ @biff.append("World") }
+  end
+
+  def test_prepend_no_error
+    assert_nothing_raised{ @biff.prepend("Hello") }
+  end
+
+  def test_data_added
+    assert_nothing_raised{ @biff.append("Hello", "World") }
+    data = ''
+    while d = @biff.get_data
+      data = data + d
+    end
+    assert_equal("HelloWorld", data, "Bad data contents")
+    assert_equal(10, @biff.datasize, "Bad data size")
+  end
+
+  def test_data_prepended
+
+    assert_nothing_raised{ @biff.append("Hello") }
+    assert_nothing_raised{ @biff.prepend("World") }
+    data = ''
+    while d = @biff.get_data
+      data = data + d
+    end
+    assert_equal("WorldHello", data, "Bad data contents")
+    assert_equal(10, @biff.datasize, "Bad data size")
+  end
+
+  def test_store_bof_length
+    assert_nothing_raised{ @biff.store_bof }
+    assert_equal(20, @biff.datasize, "Bad data size after store_bof call")
+  end
+
+  def test_store_eof_length
+    assert_nothing_raised{ @biff.store_eof }
+    assert_equal(4, @biff.datasize, "Bad data size after store_eof call")
+  end
+
+  def test_datasize_mixed
+    assert_nothing_raised{ @biff.append("Hello") }
+    assert_nothing_raised{ @biff.prepend("World") }
+    assert_nothing_raised{ @biff.store_bof }
+    assert_nothing_raised{ @biff.store_eof }
+    assert_equal(34, @biff.datasize, "Bad data size for mixed data")
+  end
+
+  def test_add_continue
+    perl_file = "#{PERL_OUTDIR}/biff_add_continue_testdata"
+    size = File.size(perl_file)
+    @fh = File.new(@ruby_file,"w+")
+    @fh.print(@biff.add_continue('testdata'))
+    @fh.close
+    rsize = File.size(@ruby_file)
+    assert_equal(size,rsize,"File sizes not the same")
+    compare_file(perl_file, @ruby_file)
+  end
+
+  def teardown
+    @biff = nil
+    File.delete(@ruby_file) if File.exist?(@ruby_file)
+  end
+
+  def compare_file(expected, target)
+    fh_e = File.open(expected, "r")
+    fh_t = File.open(target, "r")
+    while true do
+      e1 = fh_e.read(1)
+      t1 = fh_t.read(1)
+      if e1.nil?
+        assert( t1.nil?, "#{expexted} is EOF but #{target} is NOT EOF.")
+        break
+      elsif t1.nil?
+        assert( e1.nil?, '#{target} is EOF but #{expected} is NOT EOF.')
+        break
+      end
+      assert_equal(e1, t1, sprintf(" #{expected} = '%s' but #{target} = '%s'", e1, t1))
+      break
+    end
+    fh_e.close
+    fh_t.close
+  end
+
+
+end

data/test/tc_chart.rb

@@ -0,0 +1,22 @@
+#####################################################
+# tc_chart.rb
+#
+# Test suite for the Chart class (chart.rb)
+#####################################################
+base = File.basename(Dir.pwd)
+if base == "test" || base =~ /spreadsheet/i
+  Dir.chdir("..") if base == "test"
+  $LOAD_PATH.unshift(Dir.pwd + "/lib/spreadsheet")
+  Dir.chdir("test") rescue nil
+end
+
+require "test/unit"
+require "WriteExcel"
+
+class TC_Chart < Test::Unit::TestCase
+
+  def test_
+    assert(true)
+  end
+
+end

data/test/tc_example_match.rb

@@ -0,0 +1,1280 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "test/unit"
+require 'WriteExcel'
+
+class TC_example_match < Test::Unit::TestCase
+
+  TEST_DIR    = File.expand_path(File.dirname(__FILE__))
+  PERL_OUTDIR = File.join(TEST_DIR, 'perl_output')
+
+  def setup
+    t = Time.now.strftime("%Y%m%d")
+    path = "temp#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+    @test_file  = File.join(Dir.tmpdir, path)
+    @filename  = @test_file
+    @filename2 = @test_file + "2"
+  end
+
+  def teardown
+    File.delete(@filename)  if File.exist?(@filename)
+    File.delete(@filename2) if File.exist?(@filename2)
+  end
+
+  def test_a_simple
+    workbook  = Spreadsheet::WriteExcel.new(@filename);
+    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
+    
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/a_simple.xls", @filename)
+  end
+
+  def test_regions
+    workbook = Spreadsheet::WriteExcel.new(@filename)
+
+    # 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
+    bp=1
+    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
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/regions.xls", @filename)
+  end
+
+  def test_stats
+    workbook = Spreadsheet::WriteExcel.new(@filename)
+    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
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/regions.xls", @filename)
+  end
+
+  def test_hidden
+    workbook   = Spreadsheet::WriteExcel.new(@filename)
+    worksheet1 = workbook.add_worksheet
+    worksheet2 = workbook.add_worksheet
+    worksheet3 = workbook.add_worksheet
+
+    # Sheet2 won't be visible until it is unhidden in Excel.
+    worksheet2.hide
+
+    worksheet1.write(0, 0, 'Sheet2 is hidden')
+    worksheet2.write(0, 0, 'How did you find me?')
+    worksheet3.write(0, 0, 'Sheet2 is hidden')
+
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/hidden.xls", @filename)
+  end
+
+  def test_hyperlink1
+    # Create a new workbook and add a worksheet
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet('Hyperlinks')
+    
+    # Format the first column
+    worksheet.set_column('A:A', 30)
+    worksheet.set_selection('B1')
+    
+    
+    # Add a sample format
+    format = workbook.add_format
+    format.set_size(12)
+    format.set_bold
+    format.set_color('red')
+    format.set_underline
+    
+    
+    # Write some hyperlinks
+    worksheet.write('A1', 'http://www.perl.com/'                )
+    worksheet.write('A3', 'http://www.perl.com/', 'Perl home'   )
+    worksheet.write('A5', 'http://www.perl.com/', nil, format)
+    worksheet.write('A7', 'mailto:jmcnamara@cpan.org', 'Mail me')
+    
+    # Write a URL that isn't a hyperlink
+    worksheet.write_string('A9', 'http://www.perl.com/')
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/hyperlink.xls", @filename)
+  end
+
+  def test_copyformat
+    # Create workbook1
+    workbook1       = Spreadsheet::WriteExcel.new(@filename)
+    worksheet1      = workbook1.add_worksheet
+    format1a        = workbook1.add_format
+    format1b        = workbook1.add_format
+    
+    # Create workbook2
+    workbook2       = Spreadsheet::WriteExcel.new(@filename2)
+    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
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/workbook1.xls", @filename)
+    compare_file("#{PERL_OUTDIR}/workbook2.xls", @filename2)
+  end
+
+  def test_data_validate
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+    
+    # Add a format for the header cells.
+    header_format = workbook.add_format(
+                                                :border      => 1,
+                                                :bg_color    => 43,
+                                                :bold        => 1,
+                                                :text_wrap   => 1,
+                                                :valign      => 'vcenter',
+                                                :indent      => 1
+                                             )
+    
+    # Set up layout of the worksheet.
+    worksheet.set_column('A:A', 64)
+    worksheet.set_column('B:B', 15)
+    worksheet.set_column('D:D', 15)
+    worksheet.set_row(0, 36)
+    worksheet.set_selection('B3')
+    
+    
+    # Write the header cells and some data that will be used in the examples.
+    row = 0
+    heading1 = 'Some examples of data validation in Spreadsheet::WriteExcel'
+    heading2 = 'Enter values in this column'
+    heading3 = 'Sample Data'
+    
+    worksheet.write('A1', heading1, header_format)
+    worksheet.write('B1', heading2, header_format)
+    worksheet.write('D1', heading3, header_format)
+    
+    worksheet.write('D3', ['Integers',   1, 10])
+    worksheet.write('D4', ['List data', 'open', 'high', 'close'])
+    worksheet.write('D5', ['Formula',   '=AND(F5=50,G5=60)', 50, 60])
+    
+    
+    #
+    # Example 1. Limiting input to an integer in a fixed range.
+    #
+    txt = 'Enter an integer between 1 and 10'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'integer',
+            :criteria        => 'between',
+            :minimum         => 1,
+            :maximum         => 10
+        })
+    
+    
+    #
+    # Example 2. Limiting input to an integer outside a fixed range.
+    #
+    txt = 'Enter an integer that is not between 1 and 10 (using cell references)'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'integer',
+            :criteria        => 'not between',
+            :minimum         => '=E3',
+            :maximum         => '=F3'
+        })
+    
+    
+    #
+    # Example 3. Limiting input to an integer greater than a fixed value.
+    #
+    txt = 'Enter an integer greater than 0'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'integer',
+            :criteria        => '>',
+            :value           => 0
+        })
+    
+    
+    #
+    # Example 4. Limiting input to an integer less than a fixed value.
+    #
+    txt = 'Enter an integer less than 10'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'integer',
+            :criteria        => '<',
+            :value           => 10
+        })
+    
+    
+    #
+    # Example 5. Limiting input to a decimal in a fixed range.
+    #
+    txt = 'Enter a decimal between 0.1 and 0.5'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'decimal',
+            :criteria        => 'between',
+            :minimum         => 0.1,
+            :maximum         => 0.5
+        })
+    
+    
+    #
+    # Example 6. Limiting input to a value in a dropdown list.
+    #
+    txt = 'Select a value from a drop down list'
+    row += 2
+    bp=1
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'list',
+            :source          => ['open', 'high', 'close']
+        })
+    
+    
+    #
+    # Example 6. Limiting input to a value in a dropdown list.
+    #
+    txt = 'Select a value from a drop down list (using a cell range)'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'list',
+            :source          => '=E4:G4'
+        })
+    
+    
+    #
+    # Example 7. Limiting input to a date in a fixed range.
+    #
+    txt = 'Enter a date between 1/1/2008 and 12/12/2008'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'date',
+            :criteria        => 'between',
+            :minimum         => '2008-01-01T',
+            :maximum         => '2008-12-12T'
+        })
+    
+    
+    #
+    # Example 8. Limiting input to a time in a fixed range.
+    #
+    txt = 'Enter a time between 6:00 and 12:00'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'time',
+            :criteria        => 'between',
+            :minimum         => 'T06:00',
+            :maximum         => 'T12:00'
+        })
+    
+    
+    #
+    # Example 9. Limiting input to a string greater than a fixed length.
+    #
+    txt = 'Enter a string longer than 3 characters'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'length',
+            :criteria        => '>',
+            :value           => 3
+        })
+    
+    
+    #
+    # Example 10. Limiting input based on a formula.
+    #
+    txt = 'Enter a value if the following is true "=AND(F5=50,G5=60)"'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate        => 'custom',
+            :value           => '=AND(F5=50,G5=60)'
+        })
+    
+    
+    #
+    # Example 11. Displaying and modify data validation messages.
+    #
+    txt = 'Displays a message when you select the cell'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate      => 'integer',
+            :criteria      => 'between',
+            :minimum       => 1,
+            :maximum       => 100,
+            :input_title   => 'Enter an integer:',
+            :input_message => 'between 1 and 100'
+        })
+    
+    
+    #
+    # Example 12. Displaying and modify data validation messages.
+    #
+    txt = 'Display a custom error message when integer isn\'t between 1 and 100'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate      => 'integer',
+            :criteria      => 'between',
+            :minimum       => 1,
+            :maximum       => 100,
+            :input_title   => 'Enter an integer:',
+            :input_message => 'between 1 and 100',
+            :error_title   => 'Input value is not valid!',
+            :error_message => 'It should be an integer between 1 and 100'
+        })
+    
+    
+    #
+    # Example 13. Displaying and modify data validation messages.
+    #
+    txt = 'Display a custom information message when integer isn\'t between 1 and 100'
+    row += 2
+    
+    worksheet.write(row, 0, txt)
+    worksheet.data_validation(row, 1,
+        {
+            :validate      => 'integer',
+            :criteria      => 'between',
+            :minimum       => 1,
+            :maximum       => 100,
+            :input_title   => 'Enter an integer:',
+            :input_message => 'between 1 and 100',
+            :error_title   => 'Input value is not valid!',
+            :error_message => 'It should be an integer between 1 and 100',
+            :error_type    => 'information'
+        })
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/data_validate.xls", @filename)
+  end
+
+  def test_merge1
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+
+    # Increase the cell size of the merged cells to highlight the formatting.
+    worksheet.set_column('B:D', 20)
+    worksheet.set_row(2, 30)
+
+    # Create a merge format
+    format = workbook.add_format(:center_across => 1)
+
+    # Only one cell should contain text, the others should be blank.
+    worksheet.write(2, 1, "Center across selection", format)
+    worksheet.write_blank(2, 2,                 format)
+    worksheet.write_blank(2, 3,                 format)
+
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/merge1.xls", @filename)
+  end
+
+  def test_merge2
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+
+    # Increase the cell size of the merged cells to highlight the formatting.
+    worksheet.set_column(1, 2, 30)
+    worksheet.set_row(2, 40)
+
+    # Create a merged format
+    format = workbook.add_format(
+                                        :center_across   => 1,
+                                        :bold            => 1,
+                                        :size            => 15,
+                                        :pattern         => 1,
+                                        :border          => 6,
+                                        :color           => 'white',
+                                        :fg_color        => 'green',
+                                        :border_color    => 'yellow',
+                                        :align           => 'vcenter'
+                                  )
+
+    # Only one cell should contain text, the others should be blank.
+    worksheet.write(2, 1, "Center across selection", format)
+    worksheet.write_blank(2, 2,                      format)
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/merge2.xls", @filename)
+  end
+  
+  def test_merge3
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet()
+    
+    # Increase the cell size of the merged cells to highlight the formatting.
+    [1, 3,6,7].each { |row| worksheet.set_row(row, 30) }
+    worksheet.set_column('B:D', 20)
+    
+    ###############################################################################
+    #
+    # Example 1: Merge cells containing a hyperlink using write_url_range()
+    # and the standard Excel 5+ merge property.
+    #
+    format1 = workbook.add_format(
+                                        :center_across   => 1,
+                                        :border          => 1,
+                                        :underline       => 1,
+                                        :color           => 'blue'
+                                 )
+    
+    # Write the cells to be merged
+    worksheet.write_url_range('B2:D2', 'http://www.perl.com', format1)
+    worksheet.write_blank('C2', format1)
+    worksheet.write_blank('D2', format1)
+    
+    
+    
+    ###############################################################################
+    #
+    # Example 2: Merge cells containing a hyperlink using merge_range().
+    #
+    format2 = workbook.add_format(
+                                        :border      => 1,
+                                        :underline   => 1,
+                                        :color       => 'blue',
+                                        :align       => 'center',
+                                        :valign      => 'vcenter'
+                                 )
+    
+    # Merge 3 cells
+    worksheet.merge_range('B4:D4', 'http://www.perl.com', format2)
+    
+    
+    # Merge 3 cells over two rows
+    worksheet.merge_range('B7:D8', 'http://www.perl.com', format2)
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/merge3.xls", @filename)
+  end
+
+  def test_merge4
+    # Create a new workbook and add a worksheet
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+    
+    # Increase the cell size of the merged cells to highlight the formatting.
+    (1..11).each { |row| worksheet.set_row(row, 30) }
+    worksheet.set_column('B:D', 20)
+    
+    ###############################################################################
+    #
+    # Example 1: Text centered vertically and horizontally
+    #
+    format1 = workbook.add_format(
+                                        :border  => 6,
+                                        :bold    => 1,
+                                        :color   => 'red',
+                                        :valign  => 'vcenter',
+                                        :align   => 'center'
+                                       )
+    
+    worksheet.merge_range('B2:D3', 'Vertical and horizontal', format1)
+    
+    
+    ###############################################################################
+    #
+    # Example 2: Text aligned to the top and left
+    #
+    format2 = workbook.add_format(
+                                        :border  => 6,
+                                        :bold    => 1,
+                                        :color   => 'red',
+                                        :valign  => 'top',
+                                        :align   => 'left'
+                                      )
+    
+    worksheet.merge_range('B5:D6', 'Aligned to the top and left', format2)
+    
+    ###############################################################################
+    #
+    # Example 3:  Text aligned to the bottom and right
+    #
+    format3 = workbook.add_format(
+                                        :border  => 6,
+                                        :bold    => 1,
+                                        :color   => 'red',
+                                        :valign  => 'bottom',
+                                        :align   => 'right'
+                                      )
+    
+    worksheet.merge_range('B8:D9', 'Aligned to the bottom and right', format3)
+    
+    ###############################################################################
+    #
+    # Example 4:  Text justified (i.e. wrapped) in the cell
+    #
+    format4 = workbook.add_format(
+                                        :border  => 6,
+                                        :bold    => 1,
+                                        :color   => 'red',
+                                        :valign  => 'top',
+                                        :align   => 'justify'
+                                      )
+    
+    worksheet.merge_range('B11:D12', 'Justified: '+'so on and '*18, format4)
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/merge4.xls", @filename)
+  end
+
+  def test_merge5
+    # Create a new workbook and add a worksheet
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+    
+    
+    # Increase the cell size of the merged cells to highlight the formatting.
+    (3..8).each { |col| worksheet.set_row(col, 36) }
+    [1, 3, 5].each { |n| worksheet.set_column(n, n, 15) }
+    
+    
+    ###############################################################################
+    #
+    # Rotation 1, letters run from top to bottom
+    #
+    format1 = workbook.add_format(
+                                        :border      => 6,
+                                        :bold        => 1,
+                                        :color       => 'red',
+                                        :valign      => 'vcentre',
+                                        :align       => 'centre',
+                                        :rotation    => 270
+                                      )
+    
+    
+    worksheet.merge_range('B4:B9', 'Rotation 270', format1)
+    
+    
+    ###############################################################################
+    #
+    # Rotation 2, 90° anticlockwise
+    #
+    format2 = workbook.add_format(
+                                        :border      => 6,
+                                        :bold        => 1,
+                                        :color       => 'red',
+                                        :valign      => 'vcentre',
+                                        :align       => 'centre',
+                                        :rotation    => 90
+                                      )
+    
+    
+    worksheet.merge_range('D4:D9', 'Rotation 90°', format2)
+    
+    
+    
+    ###############################################################################
+    #
+    # Rotation 3, 90° clockwise
+    #
+    format3 = workbook.add_format(
+                                        :border      => 6,
+                                        :bold        => 1,
+                                        :color       => 'red',
+                                        :valign      => 'vcentre',
+                                        :align       => 'centre',
+                                        :rotation    => -90
+                                      )
+    
+    
+    worksheet.merge_range('F4:F9', 'Rotation -90°', format3)
+    
+    workbook.close
+    
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/merge5.xls", @filename)
+  end
+
+  def test_images
+    # Create a new workbook called simple.xls and add a worksheet
+    workbook   = Spreadsheet::WriteExcel.new(@filename)
+    worksheet1 = workbook.add_worksheet('Image 1')
+    worksheet2 = workbook.add_worksheet('Image 2')
+    worksheet3 = workbook.add_worksheet('Image 3')
+    worksheet4 = workbook.add_worksheet('Image 4')
+    bp=1
+    
+    # Insert a basic image
+    worksheet1.write('A10', "Image inserted into worksheet.")
+    worksheet1.insert_image('A1', File.join(TEST_DIR,'republic.png'))
+    
+    
+    # Insert an image with an offset
+    worksheet2.write('A10', "Image inserted with an offset.")
+    worksheet2.insert_image('A1', File.join(TEST_DIR,'republic.png'), 32, 10)
+    
+    # Insert a scaled image
+    worksheet3.write('A10', "Image scaled: width x 2, height x 0.8.")
+    worksheet3.insert_image('A1', File.join(TEST_DIR,'republic.png'), 0, 0, 2, 0.8)
+    
+    # Insert an image over varied column and row sizes
+    # This does not require any additional work
+    
+    # Set the cols and row sizes
+    # NOTE: you must do this before you call insert_image()
+    worksheet4.set_column('A:A', 5)
+    worksheet4.set_column('B:B', nil, nil, 1) # Hidden
+    worksheet4.set_column('C:D', 10)
+    worksheet4.set_row(0, 30)
+    worksheet4.set_row(3, 5)
+    
+    worksheet4.write('A10', "Image inserted over scaled rows and columns.")
+    worksheet4.insert_image('A1', File.join(TEST_DIR,'republic.png'))
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/images.xls", @filename)
+  end
+
+  def test_tab_colors
+    workbook   = Spreadsheet::WriteExcel.new(@filename)
+    
+    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
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/tab_colors.xls", @filename)
+  end
+
+  def test_stocks
+    # Create a new workbook and add a worksheet
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    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
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/stocks.xls", @filename)
+  end
+
+  def test_protection
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+    
+    # Create some format objects
+    locked    = workbook.add_format(:locked => 1)
+    unlocked  = workbook.add_format(:locked => 0)
+    hidden    = workbook.add_format(:hidden => 1)
+    
+    # Format the columns
+    worksheet.set_column('A:A', 42)
+    worksheet.set_selection('B3:B3')
+    
+    # Protect the worksheet
+    worksheet.protect
+    
+    # Examples of cell locking and hiding
+    worksheet.write('A1', 'Cell B1 is locked. It cannot be edited.')
+    worksheet.write('B1', '=1+2', locked)
+    
+    worksheet.write('A2', 'Cell B2 is unlocked. It can be edited.')
+    worksheet.write('B2', '=1+2', unlocked)
+    
+    worksheet.write('A3', "Cell B3 is hidden. The formula isn't visible.")
+    worksheet.write('B3', '=1+2', hidden)
+    
+    worksheet.write('A5', 'Use Menu->Tools->Protection->Unprotect Sheet')
+    worksheet.write('A6', 'to remove the worksheet protection.   ')
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/protection.xls", @filename)
+  end
+
+  def test_date_time
+    # Create a new workbook and add a worksheet
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    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 output 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 written 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
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/date_time.xls", @filename)
+  end
+  def test_diag_border
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet
+
+    format1   = workbook.add_format(:diag_type     => 1)
+    format2   = workbook.add_format(:diag_type     => 2)
+    format3   = workbook.add_format(:diag_type     => 3)
+    format4   = workbook.add_format(
+                                  :diag_type       => 3,
+                                  :diag_border     => 7,
+                                  :diag_color      => 'red'
+                )
+    
+    worksheet.write('B3',  'Text', format1)
+    worksheet.write('B6',  'Text', format2)
+    worksheet.write('B9',  'Text', format3)
+    worksheet.write('B12', 'Text', format4)
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/diag_border.xls", @filename)
+  end
+
+  def test_header
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    preview   = "Select Print Preview to see the header and footer"
+    
+    
+    ######################################################################
+    #
+    # A simple example to start
+    #
+    worksheet1  = workbook.add_worksheet('Simple')
+    
+    header1     = '&CHere is some centred text.'
+    
+    footer1     = '&LHere is some left aligned text.'
+    
+    
+    worksheet1.set_header(header1)
+    worksheet1.set_footer(footer1)
+    
+    worksheet1.set_column('A:A', 50)
+    worksheet1.write('A1', preview)
+    
+    
+    ######################################################################
+    #
+    # This is an example of some of the header/footer variables.
+    #
+    worksheet2  = workbook.add_worksheet('Variables')
+    
+    header2     = '&LPage &P of &N'+
+                      '&CFilename: &F' +
+                      '&RSheetname: &A'
+    
+    footer2     = '&LCurrent date: &D'+
+                      '&RCurrent time: &T'
+    
+    worksheet2.set_header(header2)
+    worksheet2.set_footer(footer2)
+    
+    
+    worksheet2.set_column('A:A', 50)
+    worksheet2.write('A1', preview)
+    worksheet2.write('A21', "Next sheet")
+    worksheet2.set_h_pagebreaks(20)
+    
+    
+    ######################################################################
+    #
+    # This example shows how to use more than one font
+    #
+    worksheet3 = workbook.add_worksheet('Mixed fonts')
+    
+    header3    = '&C' +
+                     '&"Courier New,Bold"Hello ' +
+                     '&"Arial,Italic"World'
+    
+    footer3    = '&C' +
+                     '&"Symbol"e' +
+                     '&"Arial" = mc&X2'
+    
+    worksheet3.set_header(header3)
+    worksheet3.set_footer(footer3)
+    
+    worksheet3.set_column('A:A', 50)
+    worksheet3.write('A1', preview)
+    
+    
+    ######################################################################
+    #
+    # Example of line wrapping
+    #
+    worksheet4 = workbook.add_worksheet('Word wrap')
+    
+    header4    = "&CHeading 1\nHeading 2\nHeading 3"
+    
+    worksheet4.set_header(header4)
+    
+    worksheet4.set_column('A:A', 50)
+    worksheet4.write('A1', preview)
+    
+    
+    ######################################################################
+    #
+    # Example of inserting a literal ampersand &
+    #
+    worksheet5 = workbook.add_worksheet('Ampersand')
+    
+    header5    = "&CCuriouser && Curiouser - Attorneys at Law"
+    
+    worksheet5.set_header(header5)
+    
+    worksheet5.set_column('A:A', 50)
+    worksheet5.write('A1', preview)
+    
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/headers.xls", @filename)
+  end
+
+  def test_demo
+    workbook   = Spreadsheet::WriteExcel.new(@filename)
+    worksheet  = workbook.add_worksheet('Demo')
+    worksheet2 = workbook.add_worksheet('Another sheet')
+    worksheet3 = workbook.add_worksheet('And another')
+    
+    bold       = workbook.add_format(:bold => 1)
+    
+    #######################################################################
+    #
+    # Write a general heading
+    #
+    worksheet.set_column('A:A', 36, bold)
+    worksheet.set_column('B:B', 20       )
+    worksheet.set_row(0,     40       )
+    
+    heading  = workbook.add_format(
+                                    :bold    => 1,
+                                    :color   => 'blue',
+                                    :size    => 16,
+                                    :merge   => 1,
+                                    :align  => 'vcenter'
+                                  )
+    
+    headings = ['Features of Spreadsheet::WriteExcel', '']
+    worksheet.write_row('A1', headings, heading)
+    
+    
+    #######################################################################
+    #
+    # Some text examples
+    #
+    text_format  = workbook.add_format(
+                                        :bold    => 1,
+                                        :italic  => 1,
+                                        :color   => 'red',
+                                        :size    => 18,
+                                        :font    =>'Lucida Calligraphy'
+                                      )
+    
+    # A phrase in Cyrillic
+    unicode = [
+                "042d0442043e002004440440043004370430002004"+
+                "3d043000200440044304410441043a043e043c0021"
+              ].pack('H*')
+    
+    worksheet.write('A2', "Text")
+    worksheet.write('B2', "Hello Excel")
+    worksheet.write('A3', "Formatted text")
+    worksheet.write('B3', "Hello Excel", text_format)
+    worksheet.write('A4', "Unicode text")
+    worksheet.write_utf16be_string('B4', unicode)
+    
+    
+    #######################################################################
+    #
+    # Some numeric examples
+    #
+    num1_format  = workbook.add_format(:num_format => '$#,##0.00')
+    num2_format  = workbook.add_format(:num_format => ' d mmmm yyy')
+    
+    worksheet.write('A5', "Numbers")
+    worksheet.write('B5', 1234.56)
+    worksheet.write('A6', "Formatted numbers")
+    worksheet.write('B6', 1234.56, num1_format)
+    worksheet.write('A7', "Formatted numbers")
+    worksheet.write('B7', 37257, num2_format)
+    
+    
+    #######################################################################
+    #
+    # Formulae
+    #
+    worksheet.set_selection('B8')
+    worksheet.write('A8', 'Formulas and functions, "=SIN(PI()/4)"')
+    worksheet.write('B8', '=SIN(PI()/4)')
+    
+    
+    #######################################################################
+    #
+    # Hyperlinks
+    #
+    worksheet.write('A9', "Hyperlinks")
+    worksheet.write('B9',  'http://www.perl.com/' )
+    
+    
+    #######################################################################
+    #
+    # Images
+    #
+    worksheet.write('A10', "Images")
+    worksheet.insert_image('B10', File.join(TEST_DIR,'republic.png'), 16, 8)
+    
+    
+    #######################################################################
+    #
+    # Misc
+    #
+    worksheet.write('A18', "Page/printer setup")
+    worksheet.write('A19', "Multiple worksheets")
+    
+    workbook.close
+    
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/demo.xls", @filename)
+  end
+
+  def test_unicode_cyrillic
+    # Create a Russian worksheet name in utf8.
+    sheet   = [0x0421, 0x0442, 0x0440, 0x0430, 0x043D, 0x0438,
+                         0x0446, 0x0430].pack("U*")
+
+    # Create a Russian string.
+    str     = [0x0417, 0x0434, 0x0440, 0x0430, 0x0432, 0x0441,
+                       0x0442, 0x0432, 0x0443, 0x0439, 0x0020, 0x041C,
+                       0x0438, 0x0440, 0x0021].pack("U*")
+
+    workbook  = Spreadsheet::WriteExcel.new(@filename)
+    worksheet = workbook.add_worksheet(sheet + '1')
+
+    worksheet.set_column('A:A', 18)
+    worksheet.write('A1', str)
+
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/unicode_cyrillic.xls", @filename)
+  end
+
+  def compare_file(expected, target)
+    fh_e = File.open(expected, "r")
+    fh_t = File.open(target, "r")
+    while true do
+      e1 = fh_e.read(1)
+      t1 = fh_t.read(1)
+      if e1.nil?
+        assert( t1.nil?, "#{expexted} is EOF but #{target} is NOT EOF.")
+        break
+      elsif t1.nil?
+        assert( e1.nil?, '#{target} is EOF but #{expected} is NOT EOF.')
+        break
+      end
+      assert_equal(e1, t1, sprintf(" #{expected} = '%s' but #{target} = '%s'", e1, t1))
+      break
+    end
+    fh_e.close
+    fh_t.close
+  end
+
+
+end