write_xlsx 0.0.4 → 0.51.0

data/test/drawing/test_write_col.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteCol < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_col
+    expected = '<xdr:col>4</xdr:col>'
+
+    @drawing.__send__(:write_col, 4)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_col_off.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteColOff < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_col_off
+    expected = '<xdr:colOff>457200</xdr:colOff>'
+
+    @drawing.__send__(:write_col_off, 457200)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_ext.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteExt < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_ext
+    expected = '<xdr:ext cx="9308969" cy="6078325" />'
+
+    @drawing.__send__(:write_ext, 9308969, 6078325)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_pos.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWritePos < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_pos
+    expected = '<xdr:pos x="0" y="0" />'
+
+    @drawing.__send__(:write_pos, 0, 0)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_row.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteRow < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_row
+    expected = '<xdr:row>8</xdr:row>'
+
+    @drawing.__send__(:write_row, 8)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_row_off.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteRowOff < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_row_off
+    expected = '<xdr:rowOff>104775</xdr:rowOff>'
+
+    @drawing.__send__(:write_row_off, 104775)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_xfrm_extension.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteXfrmExtension < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_xfrm_extension
+    expected = '<a:ext cx="0" cy="0" />'
+
+    @drawing.__send__(:write_xfrm_extension)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/drawing/test_write_xfrm_offset.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx/drawing'
+
+class TestWriteXfrmOffset < Test::Unit::TestCase
+  def setup
+    @drawing = Writexlsx::Drawing.new
+  end
+
+  def test_write_xfrm_offset
+    expected = '<a:off x="0" y="0" />'
+
+    @drawing.__send__(:write_xfrm_offset)
+    result = @drawing.instance_variable_get(:@writer).string
+
+    assert_equal(expected, result)
+  end
+end

data/test/helper.rb

@@ -26,9 +26,8 @@ def set_default_xf_indices #:nodoc:
 class Test::Unit::TestCase
   def setup_dir_var
     @test_dir = File.dirname(__FILE__)
-    @expected_dir = File.join(@test_dir, 'expected_dir')
-    @result_dir   = File.join(@test_dir, 'result_dir')
     @perl_output  = File.join(@test_dir, 'perl_output')
+    @regression_output  = File.join(@test_dir, 'regression', 'xlsx_files')
   end
 
   def expected_to_array(lines)
@@ -41,66 +40,110 @@ def expected_to_array(lines)
   end
 
   def got_to_array(xml_str)
-    str = xml_str.gsub(/[\r\n]/, '')
-    str.gsub(/>[ \t\r\n]*</, ">\t<").split(/\t/)
+    xml_str.gsub(/[\r\n]/, '').
+      gsub(/ +\/>/, ' />').
+      gsub(/>[ \t]*</, ">\t<").
+      split("\t")
   end
 
-  def compare_xlsx(expected, result, xlsx)
-    begin
-      prepare_compare(expected, result, xlsx)
-      expected_files = files(expected)
-      result_files   = files(result)
-
-      not_exists = expected_files - result_files
-      assert(not_exists.empty?, "These files does not exist: #{not_exists.to_s}")
-
-      additional_exist = result_files - expected_files
-      assert(additional_exist.empty?, "These files must not exist: #{additional_exist.to_s}")
-
-      compare_files(expected, result)
-    ensure
-      cleanup(xlsx)
+  def vml_str_to_array(vml_str)
+    ret = ''
+    vml_str.split(/[\r\n]+/).each do |vml|
+      str = vml.sub(/^\s+/, '').     # Remove leading whitespace.
+        sub(/\s+$/, '').             # Remove trailing whitespace.
+        gsub(/\'/, '"').             # Convert VMLs attribute quotes.
+        gsub(/([^ ])\/>$/, '\1 />'). # Add space before element end like XML::Writer.
+        sub(/"$/, '" ').        # Add space between attributes.
+        sub(/>$/, ">\n").       # Add newline after element end.
+        gsub(/></, ">\n<")      # Split multiple elements.
+      str.chomp! if str == "<x:Anchor>\n" # Put all of Anchor on one line.
+      ret += str
     end
+    ret.split(/\n/)
   end
 
-  def compare_files(expected, result)
-    files(expected).each do |file|
-      compare_file(expected, result, file)
-    end
+  def entrys(xlsx)
+    result = []
+    Zip::ZipFile.foreach(xlsx) { |entry| result << entry }
+    result
   end
 
-  def compare_file(expected, result, file)
-    ruby_19 do
-      assert_equal(got_to_array(IO.read(File.join(expected, file), :encoding => 'UTF-8')),
-                   got_to_array(IO.read(File.join(result, file),   :encoding => 'UTF-8')),
-                   "#{file} differs.")
-    end
-    ruby_18 do 
-      assert_equal(got_to_array(IO.read(File.join(expected, file))),
-                   got_to_array(IO.read(File.join(result, file))),
-                   "#{file} differs.")
-    end
+  def compare_xlsx_for_regression(exp_filename, got_filename, ignore_members = nil, ignore_elements = nil)
+    compare_xlsx(exp_filename, got_filename, ignore_members, ignore_elements, true)
   end
 
-  def prepare_compare(expected, result, xlsx)
-    prepare_xlsx(expected, File.join(@perl_output, xlsx))
-    prepare_xlsx(result, xlsx)
-  end
+  def compare_xlsx(exp_filename, got_filename, ignore_members = nil, ignore_elements = nil, regression = false)
+    # The zip "members" are the files in the XLSX container.
+    got_members = entrys(got_filename).sort_by {|member| member.name}
+    exp_members = entrys(exp_filename).sort_by {|member| member.name}
 
-  def prepare_xlsx(dir, xlsx)
-    Dir.mkdir(dir)
-    system("unzip -q #{xlsx} -d #{dir}")
-  end
+    # Ignore some test specific filenames.
+    if ignore_members
+      got_members.reject! {|member| ignore_members.include?(member.name) }
+      exp_members.reject! {|member| ignore_members.include?(member.name) }
+    end
 
-  def files(dir)
-    Dir.glob(File.join(dir, "**/*")).select { |f| File.file?(f) }.
-                                     reject { |f| File.basename(f) =~ /(core|theme1)\.xml/ }.
-                                     collect { |f| f.sub(Regexp.new("^#{dir}"), '') }
+    # Check that each XLSX container has the same file members.
+    assert_equal(
+                 exp_members.collect {|member| member.name},
+                 got_members.collect {|member| member.name},
+                 "file members differs.")
+
+    # Compare each file in the XLSX containers.
+    exp_members.each_index do |i|
+      got_xml_str = got_members[i].get_input_stream.read.gsub(%r!(\S)/>!, '\1 />')
+      exp_xml_str = exp_members[i].get_input_stream.read.gsub(%r!(\S)/>!, '\1 />')
+
+      # Remove dates and user specific data from the core.xml data.
+      if exp_members[i].name == 'docProps/core.xml'
+        if regression
+          exp_xml_str = exp_xml_str.gsub(/ ?John/, '').gsub(/\d\d\d\d-\d\d-\d\dT\d\d\:\d\d:\d\dZ/,'')
+        else
+          exp_xml_str = exp_xml_str.gsub(/\d\d\d\d-\d\d-\d\dT\d\d\:\d\d:\d\dZ/,'')
+        end
+        got_xml_str = got_xml_str.gsub(/\d\d\d\d-\d\d-\d\dT\d\d\:\d\d:\d\dZ/,'')
+      end
+
+      if exp_members[i].name =~ %r!xl/worksheets/sheet\d.xml!
+        exp_xml_str = exp_xml_str.
+          sub(/horizontalDpi="200" /, '').
+          sub(/verticalDpi="200" /, '').
+          sub(/(<pageSetup.* )r:id="rId1"/, '\1').
+          sub(/ +\/>/, ' />')
+      end
+
+      if exp_members[i].name =~ /.vml$/
+        got_xml = got_to_array(got_xml_str)
+        exp_xml = vml_str_to_array(exp_xml_str)
+      else
+        got_xml = got_to_array(got_xml_str)
+        exp_xml = got_to_array(exp_xml_str)
+      end
+
+      # Ignore test specific XML elements for defined filenames.
+      if ignore_elements && ignore_elements[exp_members[i].name]
+        str = ignore_elements[exp_members[i].name].join('|')
+        regex = Regexp.new(str)
+
+        got_xml = got_xml.reject { |s| s =~ regex }
+        exp_xml = exp_xml.reject { |s| s =~ regex }
+      end
+
+      # Reorder the XML elements in the XLSX relationship files.
+      case exp_members[i].name
+      when '[Content_Types].xml', /.rels$/
+        got_xml = sort_rel_file_data(got_xml)
+        exp_xml = sort_rel_file_data(exp_xml)
+      end
+
+      # Comparison of the XML elements in each file.
+      assert_equal(exp_xml, got_xml, "#{exp_members[i].name} differs.")
+    end
   end
 
-  def cleanup(xlsx)
-    Writexlsx::Utility.delete_files(xlsx)          if File.exist?(xlsx)
-    Writexlsx::Utility.delete_files(@expected_dir) if File.exist?(@expected_dir)
-    Writexlsx::Utility.delete_files(@result_dir)   if File.exist?(@result_dir)
+  def sort_rel_file_data(xml_array)
+    header = xml_array.shift
+    tail   = xml_array.pop
+    xml_array.sort.unshift(header).push(tail)
   end
 end

data/test/package/shared_strings/test_write_si.rb

@@ -3,11 +3,20 @@
 require 'write_xlsx/package/shared_strings'
 
 class TestWriteSi < Test::Unit::TestCase
-  def test_write_si
+  def setup
     @obj = Writexlsx::Package::SharedStrings.new
+  end
+
+  def test_write_si
     @obj.__send__('write_si', 'neptune')
     result = @obj.instance_variable_get(:@writer).string
     expected = '<si><t>neptune</t></si>'
     assert_equal(expected, result)
   end
+
+  def test_write_si_with_empty_string
+    assert_nothing_raised do
+      @obj.__send__('write_si', '')
+    end
+  end
 end

data/test/package/table/test_table01.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx'
+require 'stringio'
+
+class TestTable01 < Test::Unit::TestCase
+  def setup
+    workbook = WriteXLSX.new(StringIO.new)
+    @worksheet = workbook.add_worksheet
+  end
+
+  def test_table01
+    # Set the table properties.
+    @worksheet.add_table('C3:F13')
+
+    table = Writexlsx::Package::Table.new
+    table.properties = @worksheet.tables[0]
+    table.__send__(:assemble_xml_file)
+
+    result = got_to_array(table.instance_variable_get(:@writer).string)
+
+    assert_equal(expected, result)
+  end
+
+  def expected
+    expected_to_array(
+                      <<EOS
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" id="1" name="Table1" displayName="Table1" ref="C3:F13" totalsRowShown="0">
+  <autoFilter ref="C3:F13"/>
+  <tableColumns count="4">
+    <tableColumn id="1" name="Column1"/>
+    <tableColumn id="2" name="Column2"/>
+    <tableColumn id="3" name="Column3"/>
+    <tableColumn id="4" name="Column4"/>
+  </tableColumns>
+  <tableStyleInfo name="TableStyleMedium9" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/>
+</table>
+EOS
+                      )
+  end
+end

data/test/package/table/test_table02.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx'
+require 'stringio'
+
+class TestTable02 < Test::Unit::TestCase
+  def setup
+    workbook = WriteXLSX.new(StringIO.new)
+    @worksheet = workbook.add_worksheet
+  end
+
+  def test_table02
+    # Set the table properties.
+    @worksheet.add_table('D4:I15', :style => 'Table Style Light 17')
+
+    table = Writexlsx::Package::Table.new
+    table.properties = @worksheet.tables[0]
+    table.__send__(:assemble_xml_file)
+
+    result = got_to_array(table.instance_variable_get(:@writer).string)
+
+    assert_equal(expected, result)
+  end
+
+  def expected
+    expected_to_array(
+                      <<EOS
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" id="1" name="Table1" displayName="Table1" ref="D4:I15" totalsRowShown="0">
+  <autoFilter ref="D4:I15"/>
+  <tableColumns count="6">
+    <tableColumn id="1" name="Column1"/>
+    <tableColumn id="2" name="Column2"/>
+    <tableColumn id="3" name="Column3"/>
+    <tableColumn id="4" name="Column4"/>
+    <tableColumn id="5" name="Column5"/>
+    <tableColumn id="6" name="Column6"/>
+  </tableColumns>
+  <tableStyleInfo name="TableStyleLight17" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/>
+</table>
+EOS
+                      )
+  end
+end

data/test/package/table/test_table03.rb

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx'
+require 'stringio'
+
+class TestTable03 < Test::Unit::TestCase
+  def setup
+    workbook = WriteXLSX.new(StringIO.new)
+    @worksheet = workbook.add_worksheet
+  end
+
+  def test_table03
+    # Set the table properties.
+    @worksheet.add_table(
+                         'C5:D16',
+                         {
+                           :banded_rows    => 0,
+                           :first_column   => 1,
+                           :last_column    => 1,
+                           :banded_columns => 1
+                         }
+                         )
+
+    table = Writexlsx::Package::Table.new
+    table.properties = @worksheet.tables[0]
+    table.__send__(:assemble_xml_file)
+
+    result = got_to_array(table.instance_variable_get(:@writer).string)
+
+    assert_equal(expected, result)
+  end
+
+  def expected
+    expected_to_array(
+                      <<EOS
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" id="1" name="Table1" displayName="Table1" ref="C5:D16" totalsRowShown="0">
+  <autoFilter ref="C5:D16"/>
+  <tableColumns count="2">
+    <tableColumn id="1" name="Column1"/>
+    <tableColumn id="2" name="Column2"/>
+  </tableColumns>
+  <tableStyleInfo name="TableStyleMedium9" showFirstColumn="1" showLastColumn="1" showRowStripes="0" showColumnStripes="1"/>
+</table>
+EOS
+                      )
+  end
+end