caxlsx 2.0.2 → 3.0.0

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

@@ -1,5 +1,5 @@
 module Axlsx
-  
+
   # This is a utility class for serialing the drawing node in a
   # worksheet. Drawing objects have their own serialization that exports
   # a drawing document. This is only for the single node in the
@@ -17,7 +17,7 @@ module Axlsx
     attr_reader :worksheet
 
     attr_reader :drawing
-    
+
     # adds a chart to the drawing object
     # @param [Class] chart_type The type of chart to add
     # @param [Hash] options Options to pass on to the drawing and chart
@@ -26,17 +26,17 @@ module Axlsx
       @drawing ||= Drawing.new worksheet
       drawing.add_chart(chart_type, options)
     end
-    
+
     # adds an image to the drawing object
-    # @param [Hash] options Options to pass on to the drawing and image 
+    # @param [Hash] options Options to pass on to the drawing and image
     # @see Worksheet#add_image
     def add_image(options)
-      @drawing ||= Drawing.new worksheet
+      @drawing ||= Drawing.new(worksheet)
       drawing.add_image(options)
-    end 
-  
+    end
+
     # helper method to tell us if the drawing has something in it or not
-    # @return [Boolean] 
+    # @return [Boolean]
     def has_drawing?
       @drawing.is_a? Drawing
     end
@@ -45,13 +45,13 @@ module Axlsx
     # @return [Relationship]
     def relationship
       return unless has_drawing?
-      Relationship.new(self, DRAWING_R, "../#{drawing.pn}") 
+      Relationship.new(self, DRAWING_R, "../#{drawing.pn}")
     end
 
     # Serialize the drawing for the worksheet
     # @param [String] str
     def to_xml_string(str = '')
-      return unless has_drawing? 
+      return unless has_drawing?
       str << "<drawing r:id='#{relationship.Id}'/>"
     end
   end

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_area_chart.rb

@@ -0,0 +1,39 @@
+require 'tc_helper.rb'
+
+class TestAreaChart < Test::Unit::TestCase
+
+  def setup
+    @p = Axlsx::Package.new
+    ws = @p.workbook.add_worksheet
+    @row = ws.add_row ["one", 1, Time.now]
+    @chart = ws.add_chart Axlsx::AreaChart, :title => "fishery"
+  end
+
+  def teardown
+  end
+
+  def test_initialization
+    assert_equal(@chart.grouping, :standard, "grouping defualt incorrect")
+    assert_equal(@chart.series_type, Axlsx::AreaSeries, "series type incorrect")
+    assert(@chart.cat_axis.is_a?(Axlsx::CatAxis), "category axis not created")
+    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_to_xml
+    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_area_series.rb

@@ -0,0 +1,71 @@
+require 'tc_helper.rb'
+
+class TestAreaSeries < Test::Unit::TestCase
+
+  def setup
+    p = Axlsx::Package.new
+    @ws = p.workbook.add_worksheet :name=>"hmmm"
+    chart = @ws.add_chart Axlsx::AreaChart, :title => "fishery"
+    @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
+    assert_equal(@series.title.text, "bob", "series title has been applied")
+    assert_equal(@series.labels.class, Axlsx::AxDataSource)
+    assert_equal(@series.data.class, Axlsx::NumDataSource)
+  end
+
+  def test_show_marker
+    assert_equal(true, @series.show_marker)
+    @series.show_marker = false
+    assert_equal(false, @series.show_marker)
+  end
+
+  def test_smooth
+    assert_equal(true, @series.smooth)
+    @series.smooth = false
+    assert_equal(false, @series.smooth)
+  end
+
+  def test_marker_symbol
+    assert_equal(:default, @series.marker_symbol)
+    @series.marker_symbol = :circle
+    assert_equal(:circle, @series.marker_symbol)
+  end
+
+  def test_to_xml_string
+    doc = Nokogiri::XML(wrap_with_namespaces(@series))
+    assert(doc.xpath("//srgbClr[@val='#{@series.color}']"))
+    assert_equal(xpath_with_namespaces(doc, "//c:marker").size, 0)
+    assert(doc.xpath("//smooth"))
+
+    @series.marker_symbol = :diamond
+    doc = Nokogiri::XML(wrap_with_namespaces(@series))
+    assert_equal(xpath_with_namespaces(doc, "//c:marker/c:symbol[@val='diamond']").size, 1)
+
+    @series.show_marker = false
+    doc = Nokogiri::XML(wrap_with_namespaces(@series))
+    assert_equal(xpath_with_namespaces(doc, "//c:marker/c:symbol[@val='none']").size, 1)
+  end
+
+  def wrap_with_namespaces(series)
+    '<c:chartSpace xmlns:c="' <<
+      Axlsx::XML_NS_C <<
+      '" xmlns:a="' <<
+      Axlsx::XML_NS_A <<
+      '">' <<
+      series.to_xml_string <<
+      '</c:chartSpace>'
+  end
+
+  def xpath_with_namespaces(doc, xpath)
+    doc.xpath(xpath, "a" => Axlsx::XML_NS_A, "c" => Axlsx::XML_NS_C)
+  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_bar_chart.rb

@@ -0,0 +1,71 @@
+require 'tc_helper.rb'
+
+class TestBarChart < Test::Unit::TestCase
+
+  def setup
+    @p = Axlsx::Package.new
+    ws = @p.workbook.add_worksheet
+    @row = ws.add_row ["one", 1, Time.now]
+    @chart = ws.add_chart Axlsx::BarChart, :title => "fishery"
+  end
+
+  def teardown
+  end
+
+  def test_initialization
+    assert_equal(@chart.grouping, :clustered, "grouping defualt incorrect")
+    assert_equal(@chart.series_type, Axlsx::BarSeries, "series type incorrect")
+    assert_equal(@chart.bar_dir, :bar, " bar direction incorrect")
+    assert(@chart.cat_axis.is_a?(Axlsx::CatAxis), "category axis not created")
+    assert(@chart.val_axis.is_a?(Axlsx::ValAxis), "value access not created")
+  end
+
+  def test_bar_direction
+    assert_raise(ArgumentError, "require valid bar direction") { @chart.bar_dir = :left }
+    assert_nothing_raised("allow valid bar direction") { @chart.bar_dir = :col }
+    assert(@chart.bar_dir == :col)
+  end
+
+ def test_grouping
+   assert_raise(ArgumentError, "require valid grouping") { @chart.grouping = :inverted }
+   assert_nothing_raised("allow valid grouping") { @chart.grouping = :standard }
+   assert(@chart.grouping == :standard)
+ end
+
+
+ def test_gapWidth
+   assert_raise(ArgumentError, "require valid gap width") { @chart.gap_width = 200 }
+   assert_nothing_raised("allow valid gapWidth") { @chart.gap_width = "200%" }
+   assert(@chart.gap_width == "200%")
+ end
+
+ def test_gapDepth
+   assert_raise(ArgumentError, "require valid gap_depth") { @chart.gap_depth = 200 }
+   assert_nothing_raised("allow valid gap_depth") { @chart.gap_depth = "200%" }
+   assert(@chart.gap_depth == "200%")
+ end
+
+  def test_shape
+    assert_raise(ArgumentError, "require valid shape") { @chart.shape = :star }
+    assert_nothing_raised("allow valid shape") { @chart.shape = :cone }
+    assert(@chart.shape == :cone)
+  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
+
+  def test_to_xml_string_has_axes_in_correct_order
+    str = @chart.to_xml_string
+    cat_axis_position = str.index(@chart.axes[:cat_axis].id.to_s)
+    val_axis_position = str.index(@chart.axes[:val_axis].id.to_s)
+    assert(cat_axis_position < val_axis_position, "cat_axis must occur earlier than val_axis in the XML")
+  end
+end

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_chart.rb

@@ -6,7 +6,7 @@ class TestChart < Test::Unit::TestCase
     @p = Axlsx::Package.new
     ws = @p.workbook.add_worksheet
     @row = ws.add_row ["one", 1, Time.now]
-    @chart = ws.add_chart Axlsx::Bar3DChart, :title => "fishery"
+    @chart = ws.add_chart Axlsx::Bar3DChart, :title => "fishery", :bg_color => "000000"
   end
 
   def teardown
@@ -27,17 +27,30 @@ class TestChart < Test::Unit::TestCase
     assert_equal(@chart.title.cell, @row.cells.first)
   end
 
+  def test_style
+    assert_raise(ArgumentError) { @chart.style = 49 }
+    assert_nothing_raised { @chart.style = 2 }
+    assert_equal(@chart.style, 2)
+  end
+
   def test_to_from_marker_access
     assert(@chart.to.is_a?(Axlsx::Marker))
     assert(@chart.from.is_a?(Axlsx::Marker))
   end
 
-  def test_style
-    assert_raise(ArgumentError) { @chart.style = 49 }
-    assert_nothing_raised { @chart.style = 2 }
-    assert_equal(@chart.style, 2)
+  def test_bg_color
+    assert_raise(ArgumentError) { @chart.bg_color = 2 }
+    assert_nothing_raised { @chart.bg_color = "FFFFFF" }
+    assert_equal(@chart.bg_color, "FFFFFF")
+
   end
-  
+
+  def test_title_size
+    assert_raise(ArgumentError) { @chart.title_size = 2 }
+    assert_nothing_raised { @chart.title_size = "100" }
+    assert_equal(@chart.title.text_size, "100")
+  end
+
   def test_vary_colors
     assert_equal(true, @chart.vary_colors)
     assert_raise(ArgumentError) { @chart.vary_colors = 7 }
@@ -63,7 +76,7 @@ class TestChart < Test::Unit::TestCase
     @chart.start_at [5,6]
     assert_equal(@chart.graphic_frame.anchor.from.col, 5)
     assert_equal(@chart.graphic_frame.anchor.from.row, 6)
-    
+
   end
 
   def test_end_at
@@ -76,7 +89,7 @@ class TestChart < Test::Unit::TestCase
     @chart.end_at [10,11]
     assert_equal(@chart.graphic_frame.anchor.to.col, 10)
     assert_equal(@chart.graphic_frame.anchor.to.row, 11)
-  
+
   end
 
   def test_add_series
@@ -88,13 +101,13 @@ class TestChart < Test::Unit::TestCase
   def test_pn
     assert_equal(@chart.pn, "charts/chart1.xml")
   end
-  
+
   def test_d_lbls
     assert_equal(nil, @chart.instance_values[:d_lbls])
     @chart.d_lbls.d_lbl_pos = :t
     assert(@chart.d_lbls.is_a?(Axlsx::DLbls), 'DLbls instantiated on access')
   end
-  
+
   def test_to_xml_string
     schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
     doc = Nokogiri::XML(@chart.to_xml_string)

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 << '">'