axlsx 1.0.4 → 1.0.5

data/lib/axlsx/drawing/ser_axis.rb~

@@ -0,0 +1,48 @@
+module Axlsx
+  #A CatAxis object defines a chart category axis
+  class SerAxis < Axis
+
+    # @return [Boolean]
+    attr_accessor :tickLblSkip
+
+    # @return [Boolean]
+    attr_accessor :tickMarkSkip
+
+    # Creates a new SerAxis object
+    # @param [Integer] axId the id of this axis
+    # @param [Integer] crossAx the id of the perpendicular axis
+    # @option options [Symbol] axPos
+    # @option options [Symbol] tickLblPos
+    # @option options [Symbol] crosses
+    # @option options [Boolean] auto
+    # @option options [Symbol] lblAlgn
+    # @option options [Integer] lblOffset    
+    def initialize(axId, crossAx, options={})
+      super(axId, crossAx, options)
+      self.auto = true
+      self.lblAlgn = :ctr
+      self.lblOffset = "100%"
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end 
+
+    def auto=(v) Axlsx::validate_boolean(v); @auto = v; end
+    def lblAlgn=(v) RestrictionValidator.validate "#{self.class}.lblAlgn", [:ctr, :l, :r], v; @lblAlgn = v; end
+    def lblOffset=(v) RegexValidator.validate "#{self.class}.lblOffset", LBL_OFFSET_REGEX, v; @lblOffset = v; end
+
+    # Serializes the category axis
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.send('c:catAx') {
+        super(xml)
+        xml.send('c:auto', :val=>@auto)
+        xml.send('c:lblAlgn', :val=>@lblAlgn)
+        xml.send('c:lblOffset', :val=>@lblOffset)                 
+      }
+    end
+  end
+  
+
+end

data/lib/axlsx/drawing/series.rb

@@ -18,7 +18,7 @@ module Axlsx
     attr_accessor :order
 
     # The title of the series
-    # @return [String]
+    # @return [SeriesTitle]
     attr_accessor :title
 
     # Creates a new series
@@ -44,8 +44,12 @@ module Axlsx
       @order || index
     end
 
-    def title=(v)  Axlsx::validate_string(v); @title = v; end
-    
+    def title=(v) 
+      v = SeriesTitle.new(v) if v.is_a?(String) || v.is_a?(Cell)
+      DataTypeValidator.validate "#{self.class}.title", SeriesTitle, v
+      @title = v
+    end
+   
     private 
     
     # assigns the chart for this series
@@ -57,10 +61,8 @@ module Axlsx
     def to_xml(xml)
       xml.send('c:ser') {
         xml.send('c:idx', :val=>index)
-        xml.send('c:order', :val=>order || index)
-        xml.send('c:tx') {
-          xml.send('c:v', self.title)
-        }
+        xml.send('c:order', :val=>order || index)        
+        title.to_xml(xml) unless title.nil?
         yield xml if block_given?
       }
     end

data/lib/axlsx/drawing/series_title.rb

@@ -0,0 +1,22 @@
+module Axlsx
+  # A series title is a Title with a slightly different serialization
+  class SeriesTitle < Title
+
+    # Serializes the series title
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.send('c:tx') {
+        xml.send('c:strRef') {
+          xml.send('c:f', range)
+          xml.send('c:strCache') {
+            xml.send('c:ptCount', :val=>1)
+            xml.send('c:pt', :idx=>0) {
+              xml.send('c:v', @text)
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/axlsx/drawing/series_title.rb~

@@ -0,0 +1,18 @@
+module Axlsx
+  class SeriesTitle < Title
+    
+    def to_xml(xml)
+      xml.send('c:tx') {
+        xml.send('c:strRef') {
+          xml.send('c:f', range)
+          xml.send('c:strCache') {
+            xml.send('c:ptCount', :val=>1)
+            xml.send('c:pt', :idx=>0) {
+              xml.send('c:v', @text)
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/axlsx/drawing/title.rb

@@ -32,7 +32,6 @@ module Axlsx
     end
 
     # Not implemented at this time.
-    #def tx=(v) DataTypeValidator.validate 'Title.tx', Tx, v; @tx=v; end
     #def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
     #def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
     #def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end
@@ -55,7 +54,7 @@ module Axlsx
         }
       }      
     end
-
+    
     private 
 
     # returns the excel style abslute reference for the title when title is a Cell object

data/lib/axlsx/util/constants.rb

@@ -1,7 +1,7 @@
 module Axlsx
 
   # version
-  VERSION="1.0.4"
+  VERSION="1.0.5"
 
   # XML Encoding
   ENCODING = "UTF-8"

data/test/drawing/tc_bar_series.rb

@@ -11,7 +11,7 @@ class TestBarSeries < Test::Unit::TestCase
   end
   
   def test_initialize
-    assert_equal(@series.title, "bob", "series title has been applied")
+    assert_equal(@series.title.text, "bob", "series title has been applied")
     assert_equal(@series.data, [0,1,2], "data option applied")
     assert_equal(@series.labels, ["zero", "one","two"], "labels option applied")    
     assert_equal(@series.shape, :box, "series shape has been applied")   

data/test/drawing/tc_chart.rb

@@ -28,19 +28,21 @@ 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_add_series    
     s = @chart.add_series :data=>[0,1,2,3], :labels => ["one", 1, "anything"], :title=>"bob"
     assert_equal(@chart.series.last, s, "series has been added to chart series collection")
-    assert_equal(s.title, "bob", "series title has been applied")
+    assert_equal(s.title.text, "bob", "series title has been applied")
     assert_equal(s.data, [0,1,2,3], "data option applied")
     assert_equal(s.labels, ["one",1,"anything"], "labels option applied")    
   end  
   
-  def test_create_range
-    
-  end
-
   def test_pn
     assert_equal(@chart.pn, "charts/chart1.xml")
   end

data/test/drawing/tc_line_3d_chart.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestLine3DChart < 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::Line3DChart, :title => "fishery"
+  end
+
+  def teardown
+  end
+
+  def test_initialization    
+    assert_equal(@chart.grouping, :standard, "grouping defualt incorrect")
+    assert_equal(@chart.series_type, Axlsx::LineSeries, "series type incorrect")
+    assert(@chart.catAxis.is_a?(Axlsx::CatAxis), "category axis not created")
+    assert(@chart.valAxis.is_a?(Axlsx::ValAxis), "value access not created")
+    assert(@chart.serAxis.is_a?(Axlsx::SerAxis), "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_gapDepth
+   assert_raise(ArgumentError, "require valid gapDepth") { @chart.gapDepth = 200 }
+   assert_nothing_raised("allow valid gapDepth") { @chart.gapDepth = "200%" }
+   assert(@chart.gapDepth == "200%")
+ end
+
+
+  def test_to_xml
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
+    doc = Nokogiri::XML(@chart.to_xml)
+    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_line_3d_chart.rb~

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestBar3DChart < 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::Bar3DChart, :title => "fishery"
+  end
+
+  def teardown
+  end
+
+  def test_initialization    
+    assert_equal(@chart.grouping, :clustered, "grouping defualt incorrect")
+    assert_equal(@chart.series_type, Axlsx::LineSeries, "series type incorrect")
+    assert(@chart.catAxis.is_a?(Axlsx::CatAxis), "category axis not created")
+    assert(@chart.valAxis.is_a?(Axlsx::ValAxis), "value access not created")
+    assert(@chart.serAxis.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 = :standard }
+   assert(@chart.grouping == :standard)
+ end
+
+ def test_gapDepth
+   assert_raise(ArgumentError, "require valid gapDepth") { @chart.gapDepth = 200 }
+   assert_nothing_raised("allow valid gapDepth") { @chart.gapDepth = "200%" }
+   assert(@chart.gapDepth == "200%")
+ end
+
+
+  def test_to_xml
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
+    doc = Nokogiri::XML(@chart.to_xml)
+    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_line_series.tc

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+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"
+    @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob"
+  end
+  
+  def test_initialize
+    assert_equal(@series.title.text, "bob", "series title has been applied")
+    assert_equal(@series.data, [0,1,2], "data option applied")
+    assert_equal(@series.labels, ["zero", "one","two"], "labels option applied")    
+    assert_equal(@series.shape, :box, "series shape has been applied")   
+  end
+
+  def test_data
+    assert_equal(@series.data, [0,1,2])
+  end
+
+  def test_labels
+    assert_equal(@series.labels, ["zero", "one", "two"])
+  end
+
+  def test_shape
+    assert_raise(ArgumentError, "require valid shape") { @series.shape = :teardropt }
+    assert_nothing_raised("allow valid shape") { @series.shape = :cone }
+    assert(@series.shape == :cone)
+  end
+
+end

data/test/drawing/tc_line_series.tc~

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestLineSeries < 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"
+    @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob"
+  end
+  
+  def test_initialize
+    assert_equal(@series.title, "bob", "series title has been applied")
+    assert_equal(@series.data, [0,1,2], "data option applied")
+    assert_equal(@series.labels, ["zero", "one","two"], "labels option applied")    
+    assert_equal(@series.shape, :box, "series shape has been applied")   
+  end
+
+  def test_data
+    assert_equal(@series.data, [0,1,2])
+  end
+
+  def test_labels
+    assert_equal(@series.labels, ["zero", "one", "two"])
+  end
+
+  def test_shape
+    assert_raise(ArgumentError, "require valid shape") { @series.shape = :teardropt }
+    assert_nothing_raised("allow valid shape") { @series.shape = :cone }
+    assert(@series.shape == :cone)
+  end
+
+end

data/test/drawing/tc_pie_series.rb

@@ -11,7 +11,7 @@ class TestPieSeries < Test::Unit::TestCase
   end
   
   def test_initialize
-    assert_equal(@series.title, "bob", "series title has been applied")
+    assert_equal(@series.title.text, "bob", "series title has been applied")
     assert_equal(@series.data, [0,1,2], "data option applied")
     assert_equal(@series.labels, ["zero", "one","two"], "labels option applied")    
     assert_equal(@series.explosion, nil, "series shape has been applied")   

data/test/drawing/tc_ser_axis.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestSerAxis < Test::Unit::TestCase
+  def setup    
+    @axis = Axlsx::SerAxis.new 12345, 54321
+  end
+  def teardown
+  end
+
+  def test_tickLblSkip
+    assert_raise(ArgumentError, "requires valid tickLblSkip") { @axis.tickLblSkip = :my_eyes }
+    assert_nothing_raised("accepts valid tickLblSkip") { @axis.tickLblSkip = false }
+    assert_equal(@axis.tickLblSkip, false)
+  end
+
+  def test_tickMarkSkip
+    assert_raise(ArgumentError, "requires valid tickMarkSkip") { @axis.tickMarkSkip = :my_eyes }
+    assert_nothing_raised("accepts valid tickMarkSkip") { @axis.tickMarkSkip = false }
+    assert_equal(@axis.tickMarkSkip, false)
+  end
+
+end

data/test/drawing/tc_ser_axis.rb~

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestSerAxis < Test::Unit::TestCase
+  def setup    
+    @axis = Axlsx::ValAxis.new 12345, 54321
+  end
+  def teardown
+  end
+
+  def test_initialization
+    assert_equal(@axis.crossBetween, :between, "axis crossBetween default incorrect")
+  end
+
+  def test_crossBetween
+    assert_raise(ArgumentError, "requires valid crossBetween") { @axis.crossBetween = :my_eyes }
+    assert_nothing_raised("accepts valid crossBetween") { @axis.crossBetween = :midCat }
+  end
+
+end

data/test/drawing/tc_series.rb

@@ -11,7 +11,7 @@ class TestSeries < Test::Unit::TestCase
   end
   
   def test_initialize
-    assert_equal(@series.title, "bob", "series title has been applied")
+    assert_equal(@series.title.text, "bob", "series title has been applied")
     assert_equal(@series.order, @series.index, "order is index by default")
     assert_equal(@series.index, @series.chart.series.index(@series), "index is applied")    
   end

data/test/drawing/tc_series_title.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestSeriesTitle < Test::Unit::TestCase
+  def setup    
+    @p = Axlsx::Package.new
+    ws = @p.workbook.add_worksheet
+    @row = ws.add_row ["one", 1, Time.now]
+    @title = Axlsx::SeriesTitle.new
+    @chart = ws.add_chart Axlsx::Bar3DChart
+  end
+
+  def teardown
+  end
+
+  def test_initialization
+    assert(@title.text == "")
+    assert(@title.cell == nil)
+  end
+
+  def test_text
+    assert_raise(ArgumentError, "text must be a string") { @title.text = 123 }
+    @title.cell = @row.cells.first
+    @title.text = "bob"    
+    assert(@title.cell == nil, "setting title with text clears the cell")
+  end
+
+  def test_cell
+    assert_raise(ArgumentError, "cell must be a Cell") { @title.cell = "123" }
+    @title.cell = @row.cells.first
+    assert(@title.text == "one")
+  end
+  
+end