caxlsx 2.0.2 → 3.0.4

data/test/tc_axlsx.rb

@@ -24,8 +24,14 @@ class TestAxlsx < Test::Unit::TestCase
 
 
   def test_trust_input_can_be_set_to_true
+    # Class variables like this are not reset between test runs, so we have
+    # to save and restore the original value manually.
+    old = Axlsx.trust_input
+
     Axlsx.trust_input = true
     assert_equal true, Axlsx.trust_input
+
+    Axlsx.trust_input = old
   end
   def test_cell_range_relative
     p = Axlsx::Package.new
@@ -45,6 +51,16 @@ class TestAxlsx < Test::Unit::TestCase
     assert_equal(Axlsx.cell_range([c2, c1], true), "'Sheet &lt;''&gt;&quot; 1'!$A$1:$B$1")
   end
 
+  def test_cell_range_row
+    p = Axlsx::Package.new
+    ws = p.workbook.add_worksheet
+    row = ws.add_row
+    row.add_cell
+    row.add_cell
+    row.add_cell
+    assert_equal("A1:C1", Axlsx.cell_range(row, false))
+  end
+
   def test_name_to_indices
     setup_wide
     @wide_test_points.each do |key, value|
@@ -69,4 +85,25 @@ class TestAxlsx < Test::Unit::TestCase
     assert_equal([['Z5', 'AA5', 'AB5'], ['Z6', 'AA6', 'AB6']], Axlsx::range_to_a('Z5:AB6'))
   end
 
+  def test_sanitize_frozen_control_strippped
+    needs_sanitize = "legit\x08".freeze # Backspace control char
+
+    assert_equal(Axlsx.sanitize(needs_sanitize), 'legit', 'should strip control chars')
+  end
+
+  def test_sanitize_unfrozen_control_strippped
+    needs_sanitize = "legit\x08" # Backspace control char
+    sanitized_str = Axlsx.sanitize(needs_sanitize)
+
+    assert_equal(sanitized_str,           'legit',                  'should strip control chars')
+    assert_equal(sanitized_str.object_id, sanitized_str.object_id,  'should preserve object')
+  end
+
+  def test_sanitize_unfrozen_no_sanitize
+    legit_str = 'legit'
+    sanitized_str = Axlsx.sanitize(legit_str)
+
+    assert_equal(sanitized_str,           legit_str,            'should preserve value')
+    assert_equal(sanitized_str.object_id, legit_str.object_id,  'should preserve object')
+  end
 end

data/test/tc_helper.rb

@@ -8,3 +8,5 @@ end
 require 'test/unit'
 require "timecop"
 require "axlsx.rb"
+# MIME detection for Microsoft Office 2007+ formats
+require 'mimemagic/overlay'

data/test/tc_package.rb

@@ -7,10 +7,17 @@ class TestPackage < Test::Unit::TestCase
     ws = @package.workbook.add_worksheet
     ws.add_row ['Can', 'we', 'build it?']
     ws.add_row ['Yes!', 'We', 'can!']
+    @rt = Axlsx::RichText.new
+    @rt.add_run "run 1", :b => true, :i => false
+    ws.add_row [@rt]
+
+    ws.rows.last.add_cell('b', :type => :text)
+
     ws.outline_level_rows 0, 1
     ws.outline_level_columns 0, 1
     ws.add_hyperlink :ref => ws.rows.first.cells.last, :location => 'https://github.com/randym'
     ws.workbook.add_defined_name("#{ws.name}!A1:C2", :name => '_xlnm.Print_Titles', :hidden => true)
+    ws.workbook.add_view active_tab: 1, first_sheet: 0
     ws.protect_range('A1:C1')
     ws.protect_range(ws.rows.last.cells)
     ws.add_comment :author => 'alice', :text => 'Hi Bob', :ref => 'A12'
@@ -52,8 +59,13 @@ class TestPackage < Test::Unit::TestCase
       chart.d_lbls.show_val = true
     end
 
+    ws.add_chart(Axlsx::BubbleChart, :title => 'bubble chart') do |chart|
+      chart.add_series :xData => [1,2,3,4], :yData => [1,3,2,4]
+      chart.d_lbls.show_val = true
+    end
+
     @fname = 'axlsx_test_serialization.xlsx'
-    img = File.expand_path('../../examples/image1.jpeg', __FILE__)
+    img = File.expand_path('../fixtures/image1.jpeg', __FILE__)
     ws.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
       image.width=720
       image.height=666
@@ -61,12 +73,12 @@ class TestPackage < Test::Unit::TestCase
       image.start_at 5, 5
       image.end_at 10, 10
     end
-    ws.add_image :image_src => File.expand_path('../../examples/image1.gif', __FILE__) do |image|
+    ws.add_image :image_src => File.expand_path('../fixtures/image1.gif', __FILE__) do |image|
       image.start_at 0, 20
       image.width=360
       image.height=333
     end
-    ws.add_image :image_src => File.expand_path('../../examples/image1.png', __FILE__) do |image|
+    ws.add_image :image_src => File.expand_path('../fixtures/image1.png', __FILE__) do |image|
       image.start_at 9, 20
       image.width = 180
       image.height = 167
@@ -115,18 +127,35 @@ class TestPackage < Test::Unit::TestCase
   end
 
   def test_serialization
-    assert_nothing_raised do
-      begin
-        @package.serialize(@fname)
-        zf = Zip::File.open(@fname)
-        @package.send(:parts).each{ |part| zf.get_entry(part[:entry]) }
-        File.delete(@fname)
-      rescue Errno::EACCES
-        puts "WARNING:: test_serialization requires write access."
-      end
+    @package.serialize(@fname)
+    assert_zip_file_matches_package(@fname, @package)
+    File.delete(@fname)
+  end
+
+  def test_serialization_with_zip_command
+    @package.serialize(@fname, false, zip_command: "zip")
+    assert_zip_file_matches_package(@fname, @package)
+    File.delete(@fname)
+  end
+
+  def test_serialization_with_zip_command_and_absolute_path
+    fname = "#{Dir.tmpdir}/#{@fname}"
+    @package.serialize(fname, false, zip_command: "zip")
+    assert_zip_file_matches_package(fname, @package)
+    File.delete(fname)
+  end
+
+  def test_serialization_with_invalid_zip_command
+    assert_raises Axlsx::ZipCommand::ZipError do
+      @package.serialize(@fname, false, zip_command: "invalid_zip")
     end
   end
 
+  def assert_zip_file_matches_package(fname, package)
+    zf = Zip::File.open(fname)
+    package.send(:parts).each{ |part| zf.get_entry(part[:entry]) }
+  end
+
   # See comment for Package#zip_entry_for_part
   def test_serialization_creates_identical_files_at_any_time_if_created_at_is_set
     @package.core.created = Time.now
@@ -148,6 +177,11 @@ class TestPackage < Test::Unit::TestCase
     assert package_1.to_stream.string == package_2.to_stream.string, "zip files are not identical"
   end
 
+  def test_serialization_creates_files_with_excel_mime_type
+    assert_equal(MimeMagic.by_magic(@package.to_stream).type,
+                 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+  end
+
   def test_validation
     assert_equal(@package.validate.size, 0, @package.validate)
     Axlsx::Workbook.send(:class_variable_set, :@@date1904, 9900)
@@ -176,12 +210,13 @@ class TestPackage < Test::Unit::TestCase
 
 
     #no mystery parts
-    assert_equal(24, p.size)
+    assert_equal(25, p.size)
 
   end
 
   def test_shared_strings_requires_part
     @package.use_shared_strings = true
+    @package.to_stream #ensure all cell_serializer paths are hit
     p = @package.send(:parts)
     assert_equal(p.select{ |part| part[:entry] =~/xl\/sharedStrings.xml/}.size, 1, "shared strings table missing")
   end
@@ -218,6 +253,8 @@ class TestPackage < Test::Unit::TestCase
     # this is just a roundabout guess for a package as it is build now
     # in testing.
     assert(stream.size > 80000)
+    # Cached ids should be cleared
+    assert(Axlsx::Relationship.ids_cache.empty?)
   end
 
   def test_encrypt

data/test/util/tc_mime_type_utils.rb

@@ -0,0 +1,13 @@
+require 'tc_helper.rb'
+class TestMimeTypeUtils < Test::Unit::TestCase
+  def setup
+    @test_img = File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
+  end
+
+  def teardown
+  end
+
+  def test_mime_type_utils
+    assert_equal(Axlsx::MimeTypeUtils::get_mime_type(@test_img), 'image/jpeg')
+  end
+end

data/test/util/tc_simple_typed_list.rb

@@ -1,7 +1,7 @@
 require 'tc_helper.rb'
 class TestSimpleTypedList < Test::Unit::TestCase
   def setup
-    @list = Axlsx::SimpleTypedList.new Fixnum
+    @list = Axlsx::SimpleTypedList.new Integer
   end
 
   def teardown
@@ -72,7 +72,6 @@ class TestSimpleTypedList < Test::Unit::TestCase
   def test_equality
     @list.push 1
     @list.push 2
-    assert_equal(@list, [1,2])
-    
+    assert_equal(@list.to_ary, [1,2])
   end
 end

data/test/util/tc_validators.rb

@@ -91,7 +91,7 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_scale_10_400 10.0 }
     assert_raise(ArgumentError) { Axlsx.validate_scale_10_400 400.1 }
     assert_raise(ArgumentError) { Axlsx.validate_scale_10_400 "99" }
-    
+
     #scale_0_10_400
     assert_nothing_raised { Axlsx.validate_scale_0_10_400 0 }
     assert_nothing_raised { Axlsx.validate_scale_0_10_400 10 }
@@ -101,7 +101,7 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_scale_0_10_400 10.0 }
     assert_raise(ArgumentError) { Axlsx.validate_scale_0_10_400 400.1 }
     assert_raise(ArgumentError) { Axlsx.validate_scale_0_10_400 "99" }
-    
+
     #page_orientation
     assert_nothing_raised { Axlsx.validate_page_orientation :default }
     assert_nothing_raised { Axlsx.validate_page_orientation :landscape }
@@ -109,7 +109,7 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_page_orientation nil }
     assert_raise(ArgumentError) { Axlsx.validate_page_orientation 1 }
     assert_raise(ArgumentError) { Axlsx.validate_page_orientation "landscape" }
-    
+
     #data_validation_error_style
     [:information, :stop, :warning].each do |sym|
       assert_nothing_raised { Axlsx.validate_data_validation_error_style sym }
@@ -117,7 +117,7 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style :other_symbol }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 'warning' }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 0 }
-    
+
     #data_validation_operator
     [:lessThan, :lessThanOrEqual, :equal, :notEqual, :greaterThanOrEqual, :greaterThan, :between, :notBetween].each do |sym|
       assert_nothing_raised { Axlsx.validate_data_validation_operator sym }
@@ -125,15 +125,15 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style :other_symbol }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 'lessThan' }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 0 }
-    
+
     #data_validation_type
-    [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole].each do |sym|
+    [:custom, :data, :decimal, :list, :none, :textLength, :date, :time, :whole].each do |sym|
       assert_nothing_raised { Axlsx.validate_data_validation_type sym }
     end
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style :other_symbol }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 'decimal' }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 0 }
-    
+
     #sheet_view_type
     [:normal, :page_break_preview, :page_layout].each do |sym|
       assert_nothing_raised { Axlsx.validate_sheet_view_type sym }
@@ -141,7 +141,7 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style :other_symbol }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 'page_layout' }
     assert_raise(ArgumentError) { Axlsx.validate_data_validation_error_style 0 }
-    
+
     #active_pane_type
     [:bottom_left, :bottom_right, :top_left, :top_right].each do |sym|
       assert_nothing_raised { Axlsx.validate_pane_type sym }
@@ -149,7 +149,7 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_pane_type :other_symbol }
     assert_raise(ArgumentError) { Axlsx.validate_pane_type 'bottom_left' }
     assert_raise(ArgumentError) { Axlsx.validate_pane_type 0 }
-    
+
     #split_state_type
     [:frozen, :frozen_split, :split].each do |sym|
       assert_nothing_raised { Axlsx.validate_split_state_type sym }
@@ -157,8 +157,32 @@ class TestValidators < Test::Unit::TestCase
     assert_raise(ArgumentError) { Axlsx.validate_split_state_type :other_symbol }
     assert_raise(ArgumentError) { Axlsx.validate_split_state_type 'frozen_split' }
     assert_raise(ArgumentError) { Axlsx.validate_split_state_type 0 }
+
+    #display_blanks_as
+    [:gap, :span, :zero].each do |sym|
+      assert_nothing_raised { Axlsx.validate_display_blanks_as sym }
+    end
+    assert_raise(ArgumentError) { Axlsx.validate_display_blanks_as :other_symbol }
+    assert_raise(ArgumentError) { Axlsx.validate_display_blanks_as 'other_blank' }
+    assert_raise(ArgumentError) { Axlsx.validate_display_blanks_as 0 }
+
+    #view_visibility
+    [:visible, :hidden, :very_hidden].each do |sym|
+      assert_nothing_raised { Axlsx.validate_view_visibility sym }
+    end
+    assert_raise(ArgumentError) { Axlsx.validate_view_visibility :other_symbol }
+    assert_raise(ArgumentError) { Axlsx.validate_view_visibility 'other_visibility' }
+    assert_raise(ArgumentError) { Axlsx.validate_view_visibility 0 }
+
+    #marker_symbol
+    [:default, :circle, :dash, :diamond, :dot, :picture, :plus, :square, :star, :triangle, :x].each do |sym|
+      assert_nothing_raised { Axlsx.validate_marker_symbol sym }
+    end
+    assert_raise(ArgumentError) { Axlsx.validate_marker_symbol :other_symbol }
+    assert_raise(ArgumentError) { Axlsx.validate_marker_symbol 'other_marker' }
+    assert_raise(ArgumentError) { Axlsx.validate_marker_symbol 0 }
   end
- 
+
   def test_validate_integerish
     assert_raise(ArgumentError) { Axlsx.validate_integerish Axlsx }
     [1, 1.4, "a"].each { |test_value| assert_nothing_raised { Axlsx.validate_integerish test_value } }
@@ -179,7 +203,7 @@ class TestValidators < Test::Unit::TestCase
 
   def test_range_validation
      # exclusive
-     assert_raise(ArgumentError) { Axlsx::RangeValidator.validate('foo', 1, 10, 10, false) } 
+     assert_raise(ArgumentError) { Axlsx::RangeValidator.validate('foo', 1, 10, 10, false) }
      # inclusive by default
      assert_nothing_raised { Axlsx::RangeValidator.validate('foo', 1, 10, 10) }
   end

data/test/workbook/tc_defined_name.rb

@@ -1,14 +1,14 @@
 require 'tc_helper'
 
 class TestDefinedNames < Test::Unit::TestCase
-  def setup 
+  def setup
     @dn = Axlsx::DefinedName.new('Sheet1!A1:A1')
   end
 
   def test_initialize
     assert_equal('Sheet1!A1:A1', @dn.formula)
   end
-  
+
   def test_string_attributes
     %w(short_cut_key status_bar help description custom_menu comment).each do |attr|
       assert_raise(ArgumentError, 'only strings allowed in string attributes') { @dn.send("#{attr}=", 1) }
@@ -29,13 +29,21 @@ class TestDefinedNames < Test::Unit::TestCase
     assert_nothing_raised { @dn.local_sheet_id = 1 }
   end
 
+  def test_do_not_camelcase_value_for_name
+    @dn.name = '_xlnm._FilterDatabase'
+    doc = Nokogiri::XML(@dn.to_xml_string)
+    assert_equal(doc.xpath("//definedName[@name='_xlnm._FilterDatabase']").size, 1)
+    assert_equal('Sheet1!A1:A1', doc.xpath('//definedName').text)
+  end
+
   def test_to_xml_string
     assert_raise(ArgumentError, 'name is required for serialization') { @dn.to_xml_string }
     @dn.name = '_xlnm.Print_Titles'
     @dn.hidden = true
     doc = Nokogiri::XML(@dn.to_xml_string)
-    assert(doc.xpath("//definedName[@name='_xlnm.Print_Titles']"))
-    assert(doc.xpath("//definedName[@hidden='true']"))
+    assert_equal(doc.xpath("//definedName[@name='_xlnm.Print_Titles']").size, 1)
+    assert_equal(doc.xpath("//definedName[@hidden='1']").size, 1)
     assert_equal('Sheet1!A1:A1', doc.xpath('//definedName').text)
   end
+
 end

data/test/workbook/tc_shared_strings_table.rb

@@ -4,10 +4,12 @@ class TestSharedStringsTable < Test::Unit::TestCase
 
   def setup
     @p = Axlsx::Package.new :use_shared_strings=>true
+
     ws = @p.workbook.add_worksheet
     ws.add_row ['a', 1, 'b']
     ws.add_row ['b', 1, 'c']
     ws.add_row ['c', 1, 'd']
+    ws.rows.last.add_cell('b', :type => :text)
   end
 
   def test_workbook_has_shared_strings
@@ -16,7 +18,7 @@ class TestSharedStringsTable < Test::Unit::TestCase
 
   def test_count
     sst = @p.workbook.shared_strings
-    assert_equal(sst.count, 6)
+    assert_equal(sst.count, 7)
   end
 
   def test_unique_count
@@ -41,4 +43,17 @@ class TestSharedStringsTable < Test::Unit::TestCase
     assert_equal(errors.size, 0, "sharedStirngs.xml Invalid" + errors.map{ |e| e.message }.to_s)
   end
 
+  def test_remove_control_characters_in_xml_serialization
+    nasties =  "hello\x10\x00\x1C\x1Eworld"
+    @p.workbook.worksheets[0].add_row [nasties]
+
+    # test that the nasty string was added to the shared strings
+    assert @p.workbook.shared_strings.unique_cells.has_key?(nasties)
+
+    # test that none of the control characters are in the XML output for shared strings
+    assert_no_match(/#{Axlsx::CONTROL_CHARS}/, @p.workbook.shared_strings.to_xml_string)
+
+    # assert that the shared string was normalized to remove the control characters
+    assert_not_nil @p.workbook.shared_strings.to_xml_string.index("helloworld")
+  end
 end

data/test/workbook/tc_workbook.rb

@@ -33,12 +33,18 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(@wb.use_autowidth, false)
   end
 
+  def test_is_reversed
+    assert_equal(@wb.is_reversed, nil)
+    assert_raise(ArgumentError) {@wb.is_reversed = 0.1}
+    assert_nothing_raised {@wb.is_reversed = true }
+    assert_equal(@wb.use_autowidth, true)
+  end
 
   def test_sheet_by_name_retrieval
     @wb.add_worksheet(:name=>'foo')
     @wb.add_worksheet(:name=>'bar')
     assert_equal('foo', @wb.sheet_by_name('foo').name)
-    
+
   end
   def test_date1904
     assert_equal(Axlsx::Workbook.date1904, @wb.date1904)
@@ -53,6 +59,11 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(1, @wb.defined_names.size)
   end
 
+  def test_add_view
+    @wb.add_view visibility: :hidden, window_width: 800
+    assert_equal(1, @wb.views.size)
+  end
+
   def test_shared_strings
     assert_equal(@wb.use_shared_strings, nil)
     assert_raise(ArgumentError) {@wb.use_shared_strings = 'bpb'}
@@ -66,7 +77,7 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(@wb.worksheets.first, ws, "the worksheet returned is the worksheet added")
     assert_equal(ws.name, "bob", "name option gets passed to worksheet")
   end
-  
+
   def test_insert_worksheet
     @wb.add_worksheet(:name => 'A')
     @wb.add_worksheet(:name => 'B')
@@ -93,7 +104,16 @@ class TestWorkbook < Test::Unit::TestCase
     end
     assert(errors.empty?, "error free validation")
   end
-  def test_range_requires__valid_sheet
+
+  def test_to_xml_reversed
+    @wb.is_reversed = true
+    @wb.add_worksheet(:name => 'first')
+    second = @wb.add_worksheet(:name => 'second')
+    doc = Nokogiri::XML(@wb.to_xml_string)
+    assert_equal second.name, doc.xpath('//xmlns:workbook/xmlns:sheets/*[1]/@name').to_s
+  end
+
+  def test_range_requires_valid_sheet
     ws = @wb.add_worksheet :name=>'fish'
     ws.add_row [1,2,3]
     ws.add_row [4,5,6]
@@ -116,10 +136,25 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(doc.xpath('//xmlns:workbook/xmlns:definedNames/xmlns:definedName').inner_text, @wb.worksheets[0].auto_filter.defined_name)
   end
 
+  def test_to_xml_string_book_views
+    @wb.add_worksheet do |sheet|
+      sheet.add_row [1, "two"]
+    end
+    @wb.add_view active_tab: 0, first_sheet: 0
+    doc = Nokogiri::XML(@wb.to_xml_string)
+    assert_equal(1, doc.xpath('//xmlns:workbook/xmlns:bookViews/xmlns:workbookView[@activeTab=0]').size)
+  end
+
   def test_to_xml_uses_correct_rIds_for_pivotCache
     ws = @wb.add_worksheet
     pivot_table = ws.add_pivot_table('G5:G6', 'A1:D5')
     doc = Nokogiri::XML(@wb.to_xml_string)
     assert_equal pivot_table.cache_definition.rId, doc.xpath("//xmlns:pivotCache").first["r:id"]
   end
+
+  def test_worksheet_name_is_intact_after_serialized_into_xml
+    sheet = @wb.add_worksheet(:name => '_Example')
+    wb_xml = Nokogiri::XML(@wb.to_xml_string)
+    assert_equal sheet.name, wb_xml.xpath('//xmlns:workbook/xmlns:sheets/*[1]/@name').to_s
+  end
 end