WriteExcel 0.2.0

data/test/test_30_validation_dval.rb

@@ -0,0 +1,82 @@
+##########################################################################
+# test_30_validation_dval.rb
+#
+# Tests for the Excel DVAL structure used in data validation.
+#
+# reverse('©'), September 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+#########################################################################
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "test/unit"
+require 'WriteExcel'
+
+class TC_validation_dval < Test::Unit::TestCase
+
+  def setup
+    t = Time.now.strftime("%Y%m%d")
+    path = "temp#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+    @test_file           = File.join(Dir.tmpdir, path)
+    @workbook   = Spreadsheet::WriteExcel.new(@test_file)
+    @worksheet  = @workbook.add_worksheet
+  end
+
+  def teardown
+    @workbook.close
+    File.unlink(@test_file) if FileTest.exist?(@test_file)
+  end
+
+  def test_1
+    obj_id     = 1
+    dv_count   = 1
+
+    caption    = " \tData validation: _store_dval(#{obj_id}, #{dv_count})"
+    target     = %w(
+                   B2 01 12 00 04 00 00 00 00 00 00 00 00 00 01 00
+                   00 00 01 00 00 00
+                 ).join(' ')
+
+    result     = unpack_record(@worksheet.store_dval(obj_id, dv_count))
+    assert_equal(target, result, caption)
+  end
+
+  def test_2
+    obj_id     = -1
+    dv_count   = 1
+
+    caption    = " \tData validation: _store_dval(#{obj_id}, #{dv_count})"
+    target     = %w(
+                   B2 01 12 00 04 00 00 00 00 00 00 00 00 00 FF FF
+                   FF FF 01 00 00 00
+                 ).join(' ')
+
+    result     = unpack_record(@worksheet.store_dval(obj_id, dv_count))
+    assert_equal(target, result, caption)
+  end
+
+  def test_3
+    obj_id     = 1
+    dv_count   = 2
+
+    caption    = " \tData validation: _store_dval(#{obj_id}, #{dv_count})"
+    target     = %w(
+                   B2 01 12 00 04 00 00 00 00 00 00 00 00 00 01 00
+                   00 00 02 00 00 00
+                 ).join(' ')
+
+    result     = unpack_record(@worksheet.store_dval(obj_id, dv_count))
+    assert_equal(target, result, caption)
+  end
+
+  ###############################################################################
+  #
+  # Unpack the binary data into a format suitable for printing in tests.
+  #
+  def unpack_record(data)
+    data.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ')
+  end
+
+end

data/test/test_31_validation_dv_strings.rb

@@ -0,0 +1,131 @@
+##########################################################################
+# test_31_validation_dv_strings.rb
+#
+# Tests for the packed caption/message strings used in the Excel DV structure
+# as part of data validation.
+#
+# reverse('©'), September 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+#########################################################################
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "test/unit"
+require 'WriteExcel'
+
+class TC_validation_dv_strings < Test::Unit::TestCase
+
+  def setup
+    t = Time.now.strftime("%Y%m%d")
+    path = "temp#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+    @test_file           = File.join(Dir.tmpdir, path)
+    @workbook   = Spreadsheet::WriteExcel.new(@test_file)
+    @worksheet  = @workbook.add_worksheet
+  end
+
+  def teardown
+    @workbook.close
+    File.unlink(@test_file) if FileTest.exist?(@test_file)
+  end
+
+  def test_empty_string
+    string      = ''
+    max_length  = 32
+
+    caption    = " \tData validation: _pack_dv_string('', #{max_length})"
+    target     = %w(
+                   01 00 00 00
+                 ).join(' ')
+    result     = unpack_record(@worksheet.pack_dv_string(string, max_length))
+    assert_equal(target, result, caption)
+  end
+
+  def test_nil
+    string      = nil
+    max_length  = 32
+
+    caption    = " \tData validation: _pack_dv_string('', #{max_length})"
+    target     = %w(
+                   01 00 00 00
+                 ).join(' ')
+    result     = unpack_record(@worksheet.pack_dv_string(string, max_length))
+    assert_equal(target, result, caption)
+  end
+
+  def test_single_space
+    string      = ' '
+    max_length  = 32
+
+    caption    = " \tData validation: _pack_dv_string('', #{max_length})"
+    target     = %w(
+                   01 00 00 20
+                 ).join(' ')
+    result     = unpack_record(@worksheet.pack_dv_string(string, max_length))
+    assert_equal(target, result, caption)
+  end
+
+  def test_single_character
+    string      = 'A'
+    max_length  = 32
+
+    caption    = " \tData validation: _pack_dv_string('', #{max_length})"
+    target     = %w(
+                   01 00 00 41
+                 ).join(' ')
+    result     = unpack_record(@worksheet.pack_dv_string(string, max_length))
+    assert_equal(target, result, caption)
+  end
+
+  def test_string_longer_than_32_characters_for_dialog_captions
+    string      = 'This string is longer than 32 characters'
+    max_length  = 32
+
+    caption    = " \tData validation: _pack_dv_string('', #{max_length})"
+    target     = %w(
+                   20 00 00 54 68 69 73 20
+                   73 74 72 69 6E 67 20 69 73 20 6C 6F 6E 67 65 72
+                   20 74 68 61 6E 20 33 32 20 63 68
+                 ).join(' ')
+    result     = unpack_record(@worksheet.pack_dv_string(string, max_length))
+    assert_equal(target, result, caption)
+  end
+
+  def test_string_longer_than_32_characters_for_dialog_messages
+    string      = 'ABCD' * 64
+    max_length  = 255
+
+    caption    = " \tData validation: _pack_dv_string('', #{max_length})"
+    target     = %w(
+                            FF 00 00 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43 44 41 42 43 44 41 42 43 44 41 42 43 44 41
+                            42 43
+                 ).join(' ')
+    result     = unpack_record(@worksheet.pack_dv_string(string, max_length))
+    assert_equal(target, result, caption)
+  end
+
+  ###############################################################################
+  #
+  # Unpack the binary data into a format suitable for printing in tests.
+  #
+  def unpack_record(data)
+    data.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ')
+  end
+
+end

data/test/test_32_validation_dv_formula.rb

@@ -0,0 +1,211 @@
+##########################################################################
+# test_32_validation_dv_formula.rb
+#
+# Tests for the Excel DVAL structure used in data validation.
+#
+# reverse('©'), September 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+#########################################################################
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "test/unit"
+require 'WriteExcel'
+
+class TC_validation_dv_formula < Test::Unit::TestCase
+
+  def setup
+    t = Time.now.strftime("%Y%m%d")
+    path = "temp#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+    @test_file           = File.join(Dir.tmpdir, path)
+    @workbook   = Spreadsheet::WriteExcel.new(@test_file)
+    @worksheet  = @workbook.add_worksheet
+    @worksheet2 = @workbook.add_worksheet
+  end
+
+  def teardown
+    @workbook.close
+    File.unlink(@test_file) if FileTest.exist?(@test_file)
+  end
+
+  def test_integer_values
+    formula      = '10'
+
+    caption    = " \tData validation: _pack_dv_formula('#{formula}')"
+    bytes      = %w(
+                    03 00 00 E0 1E 0A 00
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_decimal_values
+    formula      = '1.2345'
+
+    caption    = " \tData validation: _pack_dv_formula('#{formula}')"
+    bytes      = %w(
+                    09 00 E0 3F 1F 8D 97 6E 12 83 C0 F3 3F
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_date_values
+    formula      = @worksheet.convert_date_time('2008-07-24T')
+
+    caption    = " \tData validation: _pack_dv_formula('2008-07-24T')"
+    bytes      = %w(
+                    03 00 E0 3F 1E E5 9A
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_time_values
+    formula      = @worksheet.convert_date_time('T12:00')
+
+    caption    = " \tData validation: _pack_dv_formula('T12:00')"
+    bytes      = %w(
+                    09 00 E0 3F 1F 00 00 00 00 00 00 E0 3F
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_cell_reference_value_C9
+    formula      = '=C9'
+
+    caption    = " \tData validation: _pack_dv_formula('#{formula}')"
+    bytes      = %w(
+                    05 00 E0 3F 44 08 00 02 C0
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_cell_reference_value_E3_E6
+    formula      = '=E3:E6'
+
+    caption    = " \tData validation: _pack_dv_formula('#{formula}')"
+    bytes      = %w(
+                    09 00 0C 00 25 02 00 05 00 04 C0 04 C0
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_cell_reference_value_E3_E6_absolute
+    formula      = '=$E$3:$E$6'
+
+    caption    = " \tData validation: _pack_dv_formula('#{formula}')"
+    bytes      = %w(
+                    09 00 0C 00 25 02 00 05 00 04 00 04 00
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_list_values
+    formula      = ['a', 'bb', 'ccc']
+
+    caption    = " \tData validation: _pack_dv_formula(['a', 'bb', 'ccc'])"
+    bytes      = %w(
+                    0B 00 0C 00 17 08 00 61 00 62 62 00 63 63 63
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_empty_string
+    formula      = ''
+
+    caption    = " \tData validation: _pack_dv_formula('')"
+    bytes      = %w(
+                    00 00 00
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  def test_undefined_value
+    formula      = nil
+
+    caption    = " \tData validation: _pack_dv_formula(nil)"
+    bytes      = %w(
+                    00 00 00
+                 )
+
+    # Zero out Excel's random unused word to allow comparison.
+    bytes[2]   = '00'
+    bytes[3]   = '00'
+    target     = bytes.join(" ")
+
+    result     = unpack_record(@worksheet.pack_dv_formula(formula))
+    assert_equal(target, result, caption)
+  end
+
+  ###############################################################################
+  #
+  # Unpack the binary data into a format suitable for printing in tests.
+  #
+  def unpack_record(data)
+    data.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ')
+  end
+
+end

data/test/test_40_property_types.rb

@@ -0,0 +1,191 @@
+##########################################################################
+# test_40_property_types.rb
+#
+# Tests for the basic property types used in OLE property sets.
+#
+# reverse('©'), September 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+#########################################################################
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require 'test/unit'
+require 'rubygems'
+require 'WriteExcel'
+
+class TC_property_types < Test::Unit::TestCase
+
+  def setup
+    @smiley = '☺'   # chr 0x263A;    in perl
+  end
+
+  def test_pack_a_VT_I2
+    caption    = " \tDoc properties: pack_VT_I2(1252)"
+    target     = %w(
+                    02 00 00 00 E4 04 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_I2(1252) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_string_and_check_for_padding
+    string     = ''
+    codepage   = 0x04E4
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                     1E 00 00 00 01 00 00 00 00 00 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_string_and_check_for_padding_2
+    string     = 'a'
+    codepage   = 0x04E4
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 02 00 00 00 61 00 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_string_and_check_for_padding_3
+    string     = 'bb'
+    codepage   = 0x04E4
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 03 00 00 00 62 62 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_string_and_check_for_padding_4
+    string     = 'ccc'
+    codepage   = 0x04E4
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 04 00 00 00 63 63 63 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_string_and_check_for_padding_5
+    string     = 'dddd'
+    codepage   = 0x04E4
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 05 00 00 00 64 64 64 64 00 00 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_string_and_check_for_padding_6
+    string     = 'Username'
+    codepage   = 0x04E4
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 09 00 00 00 55 73 65 72 6E 61 6D 65
+                    00 00 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_UTF8_string
+    string     = @smiley
+    codepage   = 0xFDE9
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{@smiley}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 04 00 00 00 E2 98 BA 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_UTF8_string_2
+    string     = "a" + @smiley
+    codepage   = 0xFDE9
+    caption    = " \tDoc properties: _pack_VT_LPSTR('a#{@smiley}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 05 00 00 00 61 E2 98 BA 00 00 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_UTF8_string_3
+    string     = "aa" + @smiley
+    codepage   = 0xFDE9
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 06 00 00 00 61 61 E2 98 BA 00 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_UTF8_string_4
+    string     = "aaa" + @smiley
+    codepage   = 0xFDE9
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 07 00 00 00 61 61 61 E2 98 BA 00 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_LPSTR_UTF8_string_5
+    string     = "aaaa" + @smiley
+    codepage   = 0xFDE9
+    caption    = " \tDoc properties: _pack_VT_LPSTR('#{string}',\t#{codepage}')"
+    target     = %w(
+                    1E 00 00 00 08 00 00 00 61 61 61 61 E2 98 BA 00
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_LPSTR(string, codepage) )
+    assert_equal(target, result, caption)
+  end
+
+  def test_pack_a_VT_FILETIME
+    # Wed Aug 13 00:40:00 2008
+    # $sec,$min,$hour,$mday,$mon,$year
+    # We normalise the time using timegm() so that the tests don't fail due to
+    # different timezones.
+    filetime   = Time.gm(2008,8,13,0,40,0)
+
+    caption    = " \tDoc properties: _pack_VT_FILETIME()"
+    target     = %w(
+                    40 00 00 00 00 70 EB 1D DD FC C8 01
+                   ).join(' ')
+
+    result     = unpack_record( pack_VT_FILETIME(filetime) )
+    assert_equal(target, result, caption)
+  end
+
+  ###############################################################################
+  #
+  # Unpack the binary data into a format suitable for printing in tests.
+  #
+  def unpack_record(data)
+    data.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ')
+  end
+
+end