axlsx 2.1.0.pre → 3.0.0.pre

data/test/drawing/tc_title.rb

@@ -19,6 +19,11 @@ class TestTitle < Test::Unit::TestCase
     assert(@title.cell == nil)
   end
 
+  def test_initialize_title_size
+    title = Axlsx::Title.new 'bob', 90
+    assert_equal "90", title.text_size
+  end
+
   def test_text
     assert_raise(ArgumentError, "text must be a string") { @title.text = 123 }
     @title.cell = @row.cells.first

data/test/stylesheet/tc_styles.rb

@@ -133,7 +133,7 @@ class TestStyles < Test::Unit::TestCase
       :font_name => "woot font"
     }
     assert_equal(@styles.parse_font_options {}, nil, "noop if no font keys are set")
-    assert_equal(@styles.parse_font_options(:b=>1).class, Fixnum, "return index of font if not :dxf type")
+    assert(@styles.parse_font_options(:b=>1).is_a?(Integer), "return index of font if not :dxf type")
     assert_equal(@styles.parse_font_options(:b=>1, :type => :dxf).class, Axlsx::Font, "return font object if :dxf type")
 
     f = @styles.parse_font_options(options.merge(:type => :dxf))
@@ -147,7 +147,7 @@ class TestStyles < Test::Unit::TestCase
 
   def test_parse_fill_options
     assert_equal(@styles.parse_fill_options {}, nil, "noop if no fill keys are set")
-    assert_equal(@styles.parse_fill_options(:bg_color => "DE").class, Fixnum, "return index of fill if not :dxf type")
+    assert(@styles.parse_fill_options(:bg_color => "DE").is_a?(Integer), "return index of fill if not :dxf type")
     assert_equal(@styles.parse_fill_options(:bg_color => "DE", :type => :dxf).class, Axlsx::Fill, "return fill object if :dxf type")
     f = @styles.parse_fill_options(:bg_color => "DE", :type => :dxf)
     assert(f.fill_type.bgColor.rgb == "FFDEDEDE")

data/test/tc_axlsx.rb

@@ -45,6 +45,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 +79,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

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

data/test/tc_package.rb

@@ -7,6 +7,12 @@ 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'
@@ -154,6 +160,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)
@@ -188,6 +199,7 @@ class TestPackage < Test::Unit::TestCase
 
   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

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__) + "/../../examples/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

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,7 +125,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 '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|
       assert_nothing_raised { Axlsx.validate_data_validation_type sym }
@@ -133,7 +133,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 '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_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,6 +33,12 @@ 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')
@@ -98,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]
@@ -136,4 +151,10 @@ class TestWorkbook < Test::Unit::TestCase
     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

data/test/workbook/worksheet/tc_cell.rb

@@ -4,6 +4,7 @@ class TestCell < Test::Unit::TestCase
 
   def setup
     p = Axlsx::Package.new
+    p.use_shared_strings = true
     @ws = p.workbook.add_worksheet :name=>"hmmm"
     p.workbook.styles.add_style :sz=>20
     @row = @ws.add_row
@@ -56,6 +57,19 @@ class TestCell < Test::Unit::TestCase
     assert_equal('foo', @ws.workbook.defined_names.last.name)
   end
 
+  def test_autowidth
+    style = @c.row.worksheet.workbook.styles.add_style({:alignment => {:horizontal => :center, :vertical => :center, :wrap_text => true}}  )
+    @c.style = style
+    assert_equal(@c.autowidth, 5.5)
+  end
+
+  def test_time
+    @c.type = :time
+    now = DateTime.now
+    @c.value = now
+    assert_equal(@c.value, now.to_time)
+  end
+
   def test_style
     assert_raise(ArgumentError, "must reject invalid style indexes") { @c.style=@c.row.worksheet.workbook.styles.cellXfs.size }
     assert_nothing_raised("must allow valid style index changes") {@c.style=1}
@@ -119,6 +133,19 @@ class TestCell < Test::Unit::TestCase
     assert_equal("2012-10-10T12:24", @c.send(:cast_value, "2012-10-10T12:24"))
   end
 
+  def test_cast_time_subclass
+    subtime = Class.new(Time) do
+      def to_time
+        raise "#to_time of Time subclass should not be called"
+      end
+    end
+
+    time = subtime.now
+
+    @c.type = :time
+    assert_equal(time, @c.send(:cast_value, time))
+  end
+
   def test_color
     assert_raise(ArgumentError) { @c.color = -1.1 }
     assert_nothing_raised { @c.color = "FF00FF00" }
@@ -225,7 +252,7 @@ class TestCell < Test::Unit::TestCase
     @c.merge @row.cells.last
     assert_equal(@c.row.worksheet.send(:merged_cells).last, "A1:C1")
   end
-  
+
   def test_reverse_merge_with_cell
     @c.row.add_cell 2
     @c.row.add_cell 3
@@ -271,7 +298,7 @@ class TestCell < Test::Unit::TestCase
     c_xml = Nokogiri::XML(@c.to_xml_string(1,1))
     assert_equal(c_xml.xpath("/c[@s=1]").size, 1)
   end
-  
+
   def test_to_xml_string_with_run
     # Actually quite a number of similar run styles
     # but the processing should be the same
@@ -281,7 +308,7 @@ class TestCell < Test::Unit::TestCase
     @c.font_name = 'arial'
     @c.color = 'FF0000'
     c_xml = Nokogiri::XML(@c.to_xml_string(1,1))
-    assert(c_xml.xpath("//b"))
+    assert(c_xml.xpath("//b").any?)
   end
 
   def test_to_xml_string_formula
@@ -290,8 +317,8 @@ class TestCell < Test::Unit::TestCase
       sheet.add_row ["=IF(2+2=4,4,5)"]
     end
     doc = Nokogiri::XML(ws.to_xml_string)
-    assert(doc.xpath("//f[@text()='IF(2+2=4,4,5)']"))
-
+    doc.remove_namespaces!
+    assert(doc.xpath("//f[text()='IF(2+2=4,4,5)']").any?)
   end
 
   def test_to_xml_string_array_formula
@@ -301,9 +328,24 @@ class TestCell < Test::Unit::TestCase
     end
     doc = Nokogiri::XML(ws.to_xml_string)
     doc.remove_namespaces!
-    assert(doc.xpath("//f[text()='SUM(C2:C11*D2:D11)']"))
-    assert(doc.xpath("//f[@t='array']"))
-    assert(doc.xpath("//f[@ref='A1']"))
+    assert(doc.xpath("//f[text()='SUM(C2:C11*D2:D11)']").any?)
+    assert(doc.xpath("//f[@t='array']").any?)
+    assert(doc.xpath("//f[@ref='A1']").any?)
+  end
+
+  def test_to_xml_string_text_formula
+    p = Axlsx::Package.new
+    ws = p.workbook.add_worksheet do |sheet|
+      sheet.add_row ["=1+1", "-1+1"], type: :text
+    end
+    doc = Nokogiri::XML(ws.to_xml_string)
+    doc.remove_namespaces!
+
+    assert(doc.xpath("//f[text()='1+1']").empty?)
+    assert(doc.xpath("//t[text()='=1+1']").any?)
+
+    assert(doc.xpath("//f[text()='1+1']").empty?)
+    assert(doc.xpath("//t[text()='-1+1']").any?)
   end
 
   def test_font_size_with_custom_style_and_no_sz
@@ -322,17 +364,17 @@ class TestCell < Test::Unit::TestCase
     sz = @c.send(:font_size)
     assert_equal(sz, 52)
   end
-  
+
   def test_cell_with_sz
     @c.sz = 25
     assert_equal(25, @c.send(:font_size))
   end
-  
+
   def test_to_xml
     # TODO This could use some much more stringent testing related to the xml content generated!
     @ws.add_row [Time.now, Date.today, true, 1, 1.0, "text", "=sum(A1:A2)", "2013-01-13T13:31:25.123"]
     @ws.rows.last.cells[5].u = true
-    
+
     schema = Nokogiri::XML::Schema(File.open(Axlsx::SML_XSD))
     doc = Nokogiri::XML(@ws.to_xml_string)
     errors = []