axlsx 2.0.1 → 2.1.0.pre

data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb

@@ -15,8 +15,8 @@ module Axlsx
     # @see WorksheetHyperlink#initialize
     # @return [WorksheetHyperlink]
     def add(options)
-      @list << WorksheetHyperlink.new(@worksheet, options)
-      @list.last
+      self << WorksheetHyperlink.new(@worksheet, options)
+      last
     end
 
     # The relationships required by this collection's hyperlinks
@@ -31,7 +31,7 @@ module Axlsx
     def to_xml_string(str='')
       return if empty?
       str << '<hyperlinks>'
-      @list.each { |hyperlink| hyperlink.to_xml_string(str) }
+      each { |hyperlink| hyperlink.to_xml_string(str) }
       str << '</hyperlinks>'
     end
   end

data/test/drawing/tc_axis.rb

@@ -61,6 +61,33 @@ class TestAxis < Test::Unit::TestCase
     assert_nothing_raised("accepts valid format code") { @axis.format_code = "00.##"  }
   end
 
+  def create_chart_with_formatting(format_string=nil)
+    p = Axlsx::Package.new
+    p.workbook.add_worksheet(:name => "Formatting Test") do |sheet|
+      sheet.add_row(['test', 20])
+      sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "Test Formatting") do |chart|
+        chart.add_series :data => sheet["B1:B1"], :labels => sheet["A1:A1"]
+        chart.val_axis.format_code = format_string if format_string
+        doc = Nokogiri::XML(chart.to_xml_string)
+        yield doc
+      end
+    end
+  end
+
+  def test_format_code_resets_source_linked
+    create_chart_with_formatting("#,##0.00") do |doc|
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@formatCode='#,##0.00']").size, 1)
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@sourceLinked='0']").size, 1)
+    end
+  end
+
+  def test_no_format_code_keeps_source_linked
+    create_chart_with_formatting do |doc|
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@formatCode='General']").size, 1)
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@sourceLinked='1']").size, 1)
+    end
+  end
+
   def test_crosses
     assert_raise(ArgumentError, "requires valid crosses") { @axis.crosses = 1 }
     assert_nothing_raised("accepts valid crosses") { @axis.crosses = :min }

data/test/drawing/tc_bubble_chart.rb

@@ -0,0 +1,44 @@
+require 'tc_helper.rb'
+
+class TestBubbleChart < Test::Unit::TestCase
+  def setup
+    @p = Axlsx::Package.new
+    @chart = nil
+    @p.workbook.add_worksheet do |sheet|
+      sheet.add_row ["First",  1,  5,  7,  9]
+      sheet.add_row ["",       1, 25, 49, 81]
+      sheet.add_row ["",       1, 42, 60, 75]
+      sheet.add_row ["Second", 5,  2, 14,  9]
+      sheet.add_row ["",       5, 10, 15, 20]
+      sheet.add_row ["",       5, 28, 92, 13]
+      sheet.add_chart(Axlsx::BubbleChart, :title => "example: Bubble Chart") do |chart|
+        chart.start_at 0, 4
+        chart.end_at 10, 19
+        chart.add_series :xData => sheet["B1:E1"], :yData => sheet["B2:E2"], :bubbleSize => sheet["B3:E3"], :title => sheet["A1"]
+        chart.add_series :xData => sheet["B4:E4"], :yData => sheet["B5:E5"], :bubbleSize => sheet["B6:E6"], :title => sheet["A3"]
+        @chart = chart
+      end
+    end
+  end
+
+  def teardown
+  end
+
+  def test_initialization
+    assert_equal(@chart.series_type, Axlsx::BubbleSeries, "series type incorrect")
+    assert(@chart.xValAxis.is_a?(Axlsx::ValAxis), "independant value axis not created")
+    assert(@chart.yValAxis.is_a?(Axlsx::ValAxis), "dependant value axis not created")
+  end
+
+  def test_to_xml_string
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
+    doc = Nokogiri::XML(@chart.to_xml_string)
+    errors = []
+    schema.validate(doc).each do |error|
+      errors.push error
+      puts error.message
+    end
+    assert(errors.empty?, "error free validation")
+  end
+
+end

data/test/drawing/tc_bubble_series.rb

@@ -0,0 +1,21 @@
+require 'tc_helper.rb'
+
+class TestBubbleSeries < Test::Unit::TestCase
+
+  def setup
+    p = Axlsx::Package.new
+    @ws = p.workbook.add_worksheet :name=>"hmmm"
+    @chart = @ws.add_chart Axlsx::BubbleChart, :title => "Bubble Chart"
+    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :bubbleSize=>[1,5,7], :title=>"GDP", :color => 'FF0000'
+  end
+
+  def test_initialize
+    assert_equal(@series.title.text, "GDP", "series title has been applied")
+  end
+
+  def test_to_xml_string
+    doc = Nokogiri::XML(@chart.to_xml_string)
+    assert_equal(doc.xpath("//a:srgbClr[@val='#{@series.color}']").size,2)
+  end
+
+end

data/test/drawing/tc_data_source.rb

@@ -6,6 +6,12 @@
     @data_source = Axlsx::NumDataSource.new :data => ["1", "2", "3"]
   end
 
+  def test_tag_name
+    assert_raise(ArgumentError) { @data_source.tag_name = :zVal }
+    assert_nothing_raised { @data_source.tag_name = :yVal }
+    assert_nothing_raised { @data_source.tag_name = :bubbleSize }
+  end
+
   def test_to_xml_string_strLit
     str = '<?xml version="1.0" encoding="UTF-8"?>'
     str << '<c:chartSpace xmlns:c="' << Axlsx::XML_NS_C << '">'

data/test/drawing/tc_line_chart.rb

@@ -19,11 +19,11 @@ class TestLineChart < Test::Unit::TestCase
     assert(@chart.val_axis.is_a?(Axlsx::ValAxis), "value access not created")
   end
 
- def test_grouping
-   assert_raise(ArgumentError, "require valid grouping") { @chart.grouping = :inverted }
-   assert_nothing_raised("allow valid grouping") { @chart.grouping = :stacked }
-   assert(@chart.grouping == :stacked)
- end
+  def test_grouping
+    assert_raise(ArgumentError, "require valid grouping") { @chart.grouping = :inverted }
+    assert_nothing_raised("allow valid grouping") { @chart.grouping = :stacked }
+    assert(@chart.grouping == :stacked)
+  end
 
   def test_to_xml
     schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))

data/test/drawing/tc_line_series.rb

@@ -6,7 +6,7 @@ class TestLineSeries < Test::Unit::TestCase
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
     chart = @ws.add_chart Axlsx::Line3DChart, :title => "fishery"
-    @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :color => "#FF0000", :show_marker => true
+    @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :color => "#FF0000", :show_marker => true, :smooth => true
   end
 
   def test_initialize
@@ -20,11 +20,19 @@ class TestLineSeries < Test::Unit::TestCase
     assert_equal(true, @series.show_marker)
     @series.show_marker = false
     assert_equal(false, @series.show_marker)
-  end  
+  end
+
+  def test_smooth
+    assert_equal(true, @series.smooth)
+    @series.smooth = false
+    assert_equal(false, @series.smooth)
+  end
+
   def test_to_xml_string
     doc = Nokogiri::XML(@series.to_xml_string)
     assert(doc.xpath("//srgbClr[@val='#{@series.color}']"))
     assert(doc.xpath("//marker"))
+    assert(doc.xpath("//smooth"))
   end
   #TODO serialization testing
 end

data/test/drawing/tc_pic.rb

@@ -79,6 +79,10 @@ class TestPic < Test::Unit::TestCase
 
   def test_image_src_downcase
     assert_nothing_raised { @image.image_src = @test_img_up }
+    ct = @p.send(:content_types).detect do |t|
+      t.respond_to?(:extension) && t.extension.downcase == @image.extname.downcase
+    end
+    assert_equal("image/jpeg", ct.content_type)
   end
 
   def test_descr

data/test/drawing/tc_scatter_series.rb

@@ -6,13 +6,37 @@ class TestScatterSeries < Test::Unit::TestCase
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
     @chart = @ws.add_chart Axlsx::ScatterChart, :title => "Scatter Chart"
-    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :title=>"exponents", :color => 'FF0000'
+    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :title=>"exponents", :color => 'FF0000', :smooth => true
   end
 
   def test_initialize
     assert_equal(@series.title.text, "exponents", "series title has been applied")
   end
 
+  def test_smoothed_chart_default_smoothing
+    @chart = @ws.add_chart Axlsx::ScatterChart, :title => "Smooth Chart", :scatter_style => :smoothMarker
+    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :title=>"smoothed exponents"
+    assert(@series.smooth, "series is smooth by default on smooth charts")
+  end
+  
+  def test_unsmoothed_chart_default_smoothing
+    @chart = @ws.add_chart Axlsx::ScatterChart, :title => "Unsmooth Chart", :scatter_style => :line
+    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :title=>"unsmoothed exponents"
+    assert(!@series.smooth, "series is not smooth by default on non-smooth charts")
+  end
+  
+  def test_explicit_smoothing
+    @chart = @ws.add_chart Axlsx::ScatterChart, :title => "Unsmooth Chart, Smooth Series", :scatter_style => :line
+    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :title=>"smoothed exponents", :smooth => true
+    assert(@series.smooth, "series is smooth when overriding chart default")
+  end    
+  
+  def test_explicit_unsmoothing
+    @chart = @ws.add_chart Axlsx::ScatterChart, :title => "Smooth Chart, Unsmooth Series", :scatter_style => :smoothMarker
+    @series = @chart.add_series :xData=>[1,2,4], :yData=>[1,3,9], :title=>"unsmoothed exponents", :smooth => false
+    assert(!@series.smooth, "series is not smooth when overriding chart default")
+  end    
+
   def test_to_xml_string
     doc = Nokogiri::XML(@chart.to_xml_string)
     assert_equal(doc.xpath("//a:srgbClr[@val='#{@series.color}']").size,4)

data/test/tc_helper.rb

@@ -7,4 +7,4 @@ end
 
 require 'test/unit'
 require "timecop"
-require "axlsx.rb"
+require "axlsx.rb"

data/test/tc_package.rb

@@ -11,6 +11,7 @@ class TestPackage < Test::Unit::TestCase
     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,6 +53,11 @@ 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__)
     ws.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
@@ -176,7 +182,7 @@ class TestPackage < Test::Unit::TestCase
 
 
     #no mystery parts
-    assert_equal(24, p.size)
+    assert_equal(25, p.size)
 
   end
 

data/test/util/tc_simple_typed_list.rb

@@ -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/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_workbook.rb

@@ -38,7 +38,7 @@ class TestWorkbook < Test::Unit::TestCase
     @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 +53,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 +71,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')
@@ -116,6 +121,15 @@ 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')

data/test/workbook/tc_workbook_view.rb

@@ -0,0 +1,50 @@
+require 'tc_helper'
+
+class TestWorkbookView < Test::Unit::TestCase
+
+  def setup
+    @options = { visibility: :hidden, minimized: true, show_horizontal_scroll: true, show_vertical_scroll: true,
+                show_sheet_tabs: true, tab_ratio: 750, first_sheet: 0, active_tab: 1, x_window: 500, y_window: 400,
+                window_width: 800, window_height: 600, auto_filter_date_grouping: true }
+    @book_view = Axlsx::WorkbookView.new @options
+  end
+
+  def test_options_assignation
+    @options.each do |key, value|
+      assert_equal(value, @book_view.send(key))
+    end
+  end
+
+  def test_boolean_attribute_validation
+    %w(minimized show_horizontal_scroll show_vertical_scroll show_sheet_tabs auto_filter_date_grouping).each do |attr|
+      assert_raise(ArgumentError, 'only booleanish allowed in boolean attributes') { @book_view.send("#{attr}=", "banana") }
+      assert_nothing_raised { @book_view.send("#{attr}=", false )}
+    end
+  end
+
+  def test_integer_attribute_validation
+    %w(tab_ratio first_sheet active_tab x_window y_window window_width window_height).each do |attr|
+      assert_raise(ArgumentError, 'only integer allowed in integer attributes') { @book_view.send("#{attr}=", "b") }
+      assert_nothing_raised { @book_view.send("#{attr}=", 7 )}
+    end
+  end
+
+  def test_visibility_attribute_validation
+    assert_raise(ArgumentError) { @book_view.visibility = :foobar }
+    assert_nothing_raised { @book_view.visibility = :hidden }
+    assert_nothing_raised { @book_view.visibility = :very_hidden }
+    assert_nothing_raised { @book_view.visibility = :visible }
+  end
+
+  def test_to_xml_string
+    xml = @book_view.to_xml_string
+    doc = Nokogiri::XML(xml)
+    @options.each do |key, value|
+      if value == true || value == false
+        value = value ? 1 : 0
+      end
+      path = "workbookView[@#{Axlsx.camel(key, false)}='#{value}']"
+      assert_equal(1, doc.xpath(path).size)
+    end
+  end
+end

data/test/workbook/worksheet/auto_filter/tc_filters.rb

@@ -44,7 +44,7 @@ class TestFilters < Test::Unit::TestCase
 
   def test_to_xml_string
     doc = Nokogiri::XML(@filters.to_xml_string)
-    assert_equal(1, doc.xpath('//filters[@blank="true"]').size)
+    assert_equal(1, doc.xpath('//filters[@blank=1]').size)
   end
 end
 

data/test/workbook/worksheet/tc_break.rb

@@ -44,6 +44,6 @@ class TestBreak < Test::Unit::TestCase
 
   def test_to_xml_string
     doc = Nokogiri::XML(@break.to_xml_string)
-    assert_equal(doc.xpath('//brk[@id="1"][@min="1"][@max="10"][@pt="false"][@man="true"]').size, 1)
+    assert_equal(doc.xpath('//brk[@id="1"][@min="1"][@max="10"][@pt=0][@man=1]').size, 1)
   end
 end

data/test/workbook/worksheet/tc_cell.rb

@@ -34,7 +34,7 @@ class TestCell < Test::Unit::TestCase
   end
 
   def test_pos
-    assert_equal(@c.pos, [@c.index, @c.row.index])
+    assert_equal(@c.pos, [@c.index, @c.row.index(@c)])
   end
 
   def test_r
@@ -50,6 +50,12 @@ class TestCell < Test::Unit::TestCase
     assert_equal(@cAA.r_abs,"$AA$2", "needs to accept multi-digit columns")
   end
 
+  def test_name
+    @c.name = 'foo'
+    assert_equal(1, @ws.workbook.defined_names.size)
+    assert_equal('foo', @ws.workbook.defined_names.last.name)
+  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}
@@ -89,6 +95,7 @@ class TestCell < Test::Unit::TestCase
     assert_equal(@c.send(:cell_type_from_value, true), :boolean)
     assert_equal(@c.send(:cell_type_from_value, false), :boolean)
     assert_equal(@c.send(:cell_type_from_value, 1.0/10**6), :float)
+    assert_equal(@c.send(:cell_type_from_value, Axlsx::RichText.new), :richtext)
     assert_equal(:iso_8601, @c.send(:cell_type_from_value, '2008-08-30T01:45:36.123+09:00'))
   end
 
@@ -101,6 +108,8 @@ class TestCell < Test::Unit::TestCase
     assert_equal(@c.send(:cast_value, "1.0"), 1.0)
     @c.type = :string
     assert_equal(@c.send(:cast_value, nil), nil)
+    @c.type = :richtext
+    assert_equal(@c.send(:cast_value, nil), nil)
     @c.type = :float
     assert_equal(@c.send(:cast_value, nil), nil)
     @c.type = :boolean
@@ -216,6 +225,13 @@ 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
+    @row.cells.last.merge @c
+    assert_equal(@c.row.worksheet.send(:merged_cells).last, "A1:C1")
+  end
 
   def test_ssti
     assert_raise(ArgumentError, "ssti must be an unsigned integer!") { @c.send(:ssti=, -1) }
@@ -278,6 +294,18 @@ class TestCell < Test::Unit::TestCase
 
   end
 
+  def test_to_xml_string_array_formula
+    p = Axlsx::Package.new
+    ws = p.workbook.add_worksheet do |sheet|
+      sheet.add_row ["{=SUM(C2:C11*D2:D11)}"]
+    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']"))
+  end
+
   def test_font_size_with_custom_style_and_no_sz
     @c.style = @c.row.worksheet.workbook.styles.add_style :bg_color => 'FF00FF'
     sz = @c.send(:font_size)
@@ -295,11 +323,11 @@ class TestCell < Test::Unit::TestCase
     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"]
@@ -313,7 +341,5 @@ class TestCell < Test::Unit::TestCase
       puts error.message
     end
     assert(errors.empty?, "error free validation")
-
   end
-
 end