axlsx 1.1.8 → 1.2.0

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

@@ -0,0 +1,57 @@
+module Axlsx
+
+  # A wraper class for comments that defines its on worksheet
+  # serailization
+  class WorksheetComments
+
+    # Creates a new WorksheetComments object
+    # param [Worksheet] worksheet The worksheet comments in thes object belong to
+    def initialize(worksheet)
+      raise ArugumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # The comments for this worksheet.
+    # @return [Comments]
+    def comments
+      @comments ||= Comments.new(worksheet)
+    end
+
+    # Adds a comment
+    # @param [Hash] options
+    # @see Comments#add_comment
+    def add_comment(options={})
+      comments.add_comment(options)
+    end 
+
+    # The relationships defined by this objects comments collection
+    # @return [Relationships]
+    def relationships
+      return [] unless has_comments?
+      comments.relationships
+    end
+
+
+    # Helper method to tell us if there are comments in the comments collection
+    # @return [Boolean]
+    def has_comments?
+      !comments.empty?
+    end
+
+    # The index in the worksheet's relationships for the VML drawing that will render the comments
+    # @return [Integer]
+    def index
+      worksheet.relationships.index { |r| r.Type == VML_DRAWING_R } + 1
+    end
+
+    # Seraalize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return unless has_comments?
+      str << "<legacyDrawing r:id='rId#{index}' />"
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+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
+  # worksheet
+  class WorksheetDrawing
+
+    # Creates a new WorksheetDrawing
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet      
+      @drawing = nil
+    end
+
+    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
+    # @see Worksheet#add_chart
+    def add_chart(chart_type, options)
+      @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 
+    # @see Worksheet#add_image
+    def add_image(options)
+      @drawing ||= Drawing.new worksheet
+      drawing.add_image(options)
+    end 
+  
+    # helper method to tell us if the drawing has something in it or not
+    # @return [Boolean] 
+    def has_drawing?
+      @drawing.is_a? Drawing
+    end
+
+    # The relationship required by this object
+    # @return [Relationship]
+    def relationship
+      return unless has_drawing?
+      Relationship.new(DRAWING_R, "../#{drawing.pn}") 
+    end
+
+    # returns the index of the worksheet releationship that defines this drawing.
+    # @return [Integer]
+    def index
+       worksheet.relationships.index{ |r| r.Type == DRAWING_R } +1 
+    end
+
+    # Serialize the drawing for the worksheet
+    # @param [String] str
+    def to_xml_string(str = '')
+      return unless has_drawing? 
+      str << "<drawing r:id='rId#{index}'/>"
+    end
+  end
+end

data/test/drawing/tc_bar_series.rb

@@ -5,7 +5,7 @@ class TestBarSeries < Test::Unit::TestCase
   def setup
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
-    @chart = @ws.drawing.add_chart Axlsx::Bar3DChart, :title => "fishery"
+    @chart = @ws.add_chart Axlsx::Bar3DChart, :title => "fishery"
     @series = @chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :colors => ['FF0000', '00FF00', '0000FF'], :shape => :cone
   end
 

data/test/drawing/tc_chart.rb

@@ -73,7 +73,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_d_lbls.rb

@@ -0,0 +1,47 @@
+require 'tc_helper'
+
+class TestDLbls < Test::Unit::TestCase
+
+  def setup
+    @d_lbls = Axlsx::DLbls.new(Axlsx::Pie3DChart)
+  end
+
+  def test_initialization
+    assert_equal(:bestFit, @d_lbls.d_lbl_pos)
+    Axlsx::DLbls::BOOLEAN_ATTRIBUTES.each do |attr|
+      assert_equal(false, @d_lbls.send(attr))
+    end
+  end
+
+  def test_initialization_with_optoins
+    options_hash = Hash[*[Axlsx::DLbls::BOOLEAN_ATTRIBUTES.map { |name| [name, true] }] ]
+    d_lbls = Axlsx::DLbls.new(Axlsx::Pie3DChart, options_hash.merge( { :d_lbl_pos => :t }))
+    Axlsx::DLbls::BOOLEAN_ATTRIBUTES.each do |attr|
+      assert_equal(true, d_lbls.send(attr), "boolean attributes set by options")
+    end
+    assert_equal(:t, d_lbls.d_lbl_pos, "d_lbl_pos set by options")
+  end
+  def test_d_lbl_pos
+    assert_raise(ArgumentError, 'invlaid label positions are rejected') { @d_lbls.d_lbl_pos = :upside_down }
+    assert_nothing_raised('accepts valid label position') { @d_lbls.d_lbl_pos = :ctr }
+  end
+
+  def test_boolean_attributes
+    Axlsx::DLbls::BOOLEAN_ATTRIBUTES.each do |attr|
+      assert_raise(ArgumentError, "rejects non boolean value for #{attr}") { @d_lbls.send("#{attr}=", :foo) }
+      assert_nothing_raised("accepts boolean value for #{attr}") { @d_lbls.send("#{attr}=", true) }
+      assert_nothing_raised("accepts boolean value for #{attr}") { @d_lbls.send("#{attr}=", false) }
+    end
+  end
+
+  def test_to_xml_string
+      str = '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<c:chartSpace xmlns:c="' << Axlsx::XML_NS_C << '" xmlns:a="' << Axlsx::XML_NS_A << '" xmlns:r="' << Axlsx::XML_NS_R << '">'
+      @d_lbls.to_xml_string(str) 
+      str << '</c:chartSpace>'
+      doc = Nokogiri::XML(str)
+      @d_lbls.instance_values.each do |name, value|
+        assert(doc.xpath("//c:#{Axlsx::camel(name, false)}[@val='#{value}']"), "#{name} is properly serialized")
+      end
+  end
+end

data/test/drawing/tc_drawing.rb

@@ -9,8 +9,6 @@ class TestDrawing < Test::Unit::TestCase
 
   def test_initialization
     assert(@ws.workbook.drawings.empty?)
-    assert_equal(@ws.drawing, @ws.workbook.drawings.last, "drawing is added to workbook")
-    assert(@ws.drawing.anchors.is_a?(Axlsx::SimpleTypedList) && @ws.drawing.anchors.empty?, "anchor list is created and empty")
   end
 
   def test_add_chart
@@ -39,7 +37,6 @@ class TestDrawing < Test::Unit::TestCase
     assert(image.is_a?(Axlsx::Pic))
   end
   def test_charts
-    assert(@ws.drawing.charts.empty?)
     chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"bob", :start_at=>[0,0], :end_at=>[1,1])
     assert_equal(@ws.drawing.charts.last, chart, "add chart is returned")
     chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"nancy", :start_at=>[1,5], :end_at=>[5,10])
@@ -47,23 +44,26 @@ class TestDrawing < Test::Unit::TestCase
   end
 
   def test_pn
+    @ws.add_chart(Axlsx::Pie3DChart)
     assert_equal(@ws.drawing.pn, "drawings/drawing1.xml")
   end
 
   def test_rels_pn
+    @ws.add_chart(Axlsx::Pie3DChart)
     assert_equal(@ws.drawing.rels_pn, "drawings/_rels/drawing1.xml.rels")
   end
 
   def test_rId
+    @ws.add_chart(Axlsx::Pie3DChart)
     assert_equal(@ws.drawing.rId, "rId1")
   end
 
   def test_index
+    @ws.add_chart(Axlsx::Pie3DChart)
     assert_equal(@ws.drawing.index, @ws.workbook.drawings.index(@ws.drawing))
   end
 
   def test_relationships
-    assert(@ws.drawing.relationships.empty?)
     chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"bob", :start_at=>[0,0], :end_at=>[1,1])
     assert_equal(@ws.drawing.relationships.size, 1, "adding a chart adds a relationship")
     chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"nancy", :start_at=>[1,5], :end_at=>[5,10])
@@ -72,6 +72,7 @@ class TestDrawing < Test::Unit::TestCase
 
   def test_to_xml
     schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
+    @ws.add_chart(Axlsx::Pie3DChart)
     doc = Nokogiri::XML(@ws.drawing.to_xml_string)
     errors = []
     schema.validate(doc).each do |error|

data/test/drawing/tc_line_series.rb

@@ -5,7 +5,7 @@ class TestLineSeries < Test::Unit::TestCase
   def setup
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
-    chart = @ws.drawing.add_chart Axlsx::Line3DChart, :title => "fishery"
+    chart = @ws.add_chart Axlsx::Line3DChart, :title => "fishery"
     @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :color => "#FF0000"
   end
 

data/test/drawing/tc_pie_3D_chart.rb

@@ -6,7 +6,7 @@ class TestPie3DChart < Test::Unit::TestCase
     p = Axlsx::Package.new
     ws = p.workbook.add_worksheet
     @row = ws.add_row ["one", 1, Time.now]
-    @chart = ws.drawing.add_chart Axlsx::Pie3DChart, :title => "fishery"
+    @chart = ws.add_chart Axlsx::Pie3DChart, :title => "fishery"
   end
 
   def teardown

data/test/drawing/tc_pie_series.rb

@@ -5,7 +5,7 @@ class TestPieSeries < Test::Unit::TestCase
   def setup
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
-    chart = @ws.drawing.add_chart Axlsx::Pie3DChart, :title => "fishery"
+    chart = @ws.add_chart Axlsx::Pie3DChart, :title => "fishery"
     @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :colors => ["FF0000", "00FF00", "0000FF"]
   end
 

data/test/drawing/tc_scatter_series.rb

@@ -5,7 +5,7 @@ class TestScatterSeries < Test::Unit::TestCase
   def setup
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
-    @chart = @ws.drawing.add_chart Axlsx::ScatterChart, :title => "Scatter Chart"
+    @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'
   end
 

data/test/drawing/tc_series.rb

@@ -5,7 +5,7 @@ class TestSeries < Test::Unit::TestCase
   def setup
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
-    chart = @ws.drawing.add_chart Axlsx::Chart, :title => "fishery"
+    chart = @ws.add_chart Axlsx::Chart, :title => "fishery"
     @series = chart.add_series :title=>"bob"
   end
 

data/test/tc_package.rb

@@ -7,6 +7,7 @@ class TestPackage < Test::Unit::TestCase
     ws = @package.workbook.add_worksheet
     ws.add_row ['Can', 'we', 'build it?']
     ws.add_row ['Yes!', 'We', 'can!']
+    ws.workbook.add_defined_name("#{ws.name}!A1:C2", :name => '_xlnm.Print_Titles', :hidden => true)
     ws.protect_range('A1:C1')
     ws.protect_range(ws.rows.last.cells)
     ws.add_comment :author => 'alice', :text => 'Hi Bob', :ref => 'A12'
@@ -28,11 +29,25 @@ class TestPackage < Test::Unit::TestCase
 
     ws.add_chart(Axlsx::Pie3DChart, :title => "これは？", :start_at => [0,3]) do |chart|
       chart.add_series :data=>[1,2,3], :labels=>["a", "b", "c"]
+      chart.d_lbls.show_val = true
+      chart.d_lbls.d_lbl_pos = :outEnd
+      chart.d_lbls.show_percent = true
     end
 
     ws.add_chart(Axlsx::Line3DChart, :title => "axis labels") do |chart|
       chart.valAxis.title = 'bob'
+      chart.d_lbls.show_val = true
     end 
+    
+    ws.add_chart(Axlsx::Bar3DChart, :title => 'bar chart') do |chart|
+      chart.add_series :data => [1,4,5], :labels => %w(A B C)
+      chart.d_lbls.show_percent = true
+    end
+
+    ws.add_chart(Axlsx::ScatterChart, :title => 'scat man') do |chart|
+      chart.add_series :xData => [1,2,3,4], :yData => [4,3,2,1] 
+      chart.d_lbls.show_val = true
+    end
 
     @fname = 'axlsx_test_serialization.xlsx'
     img = File.expand_path('../../examples/image1.jpeg', __FILE__)
@@ -122,7 +137,7 @@ class TestPackage < Test::Unit::TestCase
 
 
     #no mystery parts
-    assert_equal(p.size, 19)
+    assert_equal(p.size, 21)
 
   end
 

data/test/workbook/tc_defined_name.rb

@@ -0,0 +1,41 @@
+require 'tc_helper'
+
+class TestDefinedNames < Test::Unit::TestCase
+  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
+    Axlsx::DefinedName::STRING_ATTRIBUTES.each do |attr|
+      assert_raise(ArgumentError, 'only strings allowed in string attributes') { @dn.send("#{attr}=", 1) }
+      assert_nothing_raised { @dn.send("#{attr}=", '_xlnm.Sheet_Title') }
+    end
+  end
+
+  def test_boolean_attributes
+   Axlsx::DefinedName::BOOLEAN_ATTRIBUTES.each do |attr|
+      assert_raise(ArgumentError, 'only booleanish allowed in string attributes') { @dn.send("#{attr}=", 'foo') }
+      assert_nothing_raised { @dn.send("#{attr}=", 1) }
+    end
+
+  end
+
+  def test_local_sheet_id
+    assert_raise(ArgumentError, 'local_sheet_id must be an unsigned int') { @dn.local_sheet_id = -1 }
+    assert_nothing_raised { @dn.local_sheet_id = 1 }
+  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('Sheet1!A1:A1', doc.xpath('//definedName').text)
+  end
+end

data/test/workbook/tc_workbook.rb

@@ -24,7 +24,10 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(Axlsx::Workbook.date1904, @wb.date1904)
   end
 
-
+  def test_add_defined_name
+    @wb.add_defined_name 'Sheet1!1:1', :name => '_xlnm.Print_Titles', :hidden => true
+    assert_equal(1, @wb.defined_names.size)
+  end
 
   def test_shared_strings
     assert_equal(@wb.use_shared_strings, nil)
@@ -72,14 +75,13 @@ class TestWorkbook < Test::Unit::TestCase
     assert(@wb.worksheets.size == 1)
   end
 
-
   def test_to_xml_string_defined_names
     @wb.add_worksheet do |sheet|
       sheet.add_row [1, "two"]
       sheet.auto_filter = "A1:B1"
     end
     doc = Nokogiri::XML(@wb.to_xml_string)
-    assert_equal(doc.xpath('//xmlns:workbook/xmlns:definedNames/xmlns:definedName').inner_text, @wb.worksheets[0].abs_auto_filter)
+    assert_equal(doc.xpath('//xmlns:workbook/xmlns:definedNames/xmlns:definedName').inner_text, @wb.worksheets[0].auto_filter.defined_name)
   end
 
 

data/test/workbook/worksheet/table/tc_table.rb

@@ -25,14 +25,6 @@ class TestTable < Test::Unit::TestCase
 
   end
 
-  def test_charts
-    assert(@ws.drawing.charts.empty?)
-    chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"bob", :start_at=>[0,0], :end_at=>[1,1])
-    assert_equal(@ws.drawing.charts.last, chart, "add chart is returned")
-    chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"nancy", :start_at=>[1,5], :end_at=>[5,10])
-    assert_equal(@ws.drawing.charts.last, chart, "add chart is returned")
-  end
-
   def test_pn
     @ws.add_table("A1:D5")
     assert_equal(@ws.tables.first.pn, "tables/table1.xml")

data/test/workbook/worksheet/tc_cell.rb

@@ -197,19 +197,17 @@ class TestCell < Test::Unit::TestCase
   end
 
   def test_merge_with_string
-    assert_equal(@c.row.worksheet.merged_cells.size, 0)
     @c.row.add_cell 2
     @c.row.add_cell 3
     @c.merge "A2"
-    assert_equal(@c.row.worksheet.merged_cells.last, "A1:A2")
+    assert_equal(@c.row.worksheet.send(:merged_cells).last, "A1:A2")
   end
 
   def test_merge_with_cell
-    assert_equal(@c.row.worksheet.merged_cells.size, 0)
     @c.row.add_cell 2
     @c.row.add_cell 3
     @c.merge @row.cells.last
-    assert_equal(@c.row.worksheet.merged_cells.last, "A1:C1")
+    assert_equal(@c.row.worksheet.send(:merged_cells).last, "A1:C1")
   end
 
   def test_ssti