axlsx 1.0.6 → 1.0.7

data/lib/axlsx/drawing/ser_axis.rb

@@ -1,30 +1,29 @@
 module Axlsx
-  #A SarAxis object defines a series axis
+  #A SerAxis object defines a series axis
   class SerAxis < Axis
 
-    # @return [Boolean]
+    # The number of tick lables to skip between labels
+    # @return [Integer]
     attr_accessor :tickLblSkip
 
+    # The number of tickmarks to be skipped before the next one is rendered.
     # @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] tickLblSkip
-    # @option options [Symbol] tickMarkSkip
+    # @param [Integer] axId the id of this axis. Inherited
+    # @param [Integer] crossAx the id of the perpendicular axis. Inherited
+    # @option options [Symbol] axPos. Inherited
+    # @option options [Symbol] tickLblPos. Inherited
+    # @option options [Symbol] crosses. Inherited
+    # @option options [Integer] tickLblSkip
+    # @option options [Integer] tickMarkSkip
     def initialize(axId, crossAx, options={})
       super(axId, crossAx, options)
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
     end 
 
-    def tickLblSkip=(v) Axlsx::validate_boolean(v); @tickLblSkip = v; end
-    def tickMarkSkip=(v) Axlsx::validate_boolean(v); @tickMarkSkip = v; end
+    def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
+    def tickMarkSkip=(v) Axlsx::validate_unsigned_int(v); @tickMarkSkip = v; end
 
     # Serializes the series axis
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.

data/lib/axlsx/drawing/series.rb

@@ -1,5 +1,5 @@
 module Axlsx
-  # A Series defines the title, data and labels for chart data.
+  # A Series defines the common series attributes and is the super class for all concrete series types.
   # @note The recommended way to manage series is to use Chart#add_series
   # @see Worksheet#add_chart
   # @see Chart#add_series
@@ -13,7 +13,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :index
 
-    # The order of this series in the chart's series.
+    # The order of this series in the chart's series. By default the order is the index of the series.
     # @return [Integer]
     attr_accessor :order
 
@@ -33,7 +33,6 @@ module Axlsx
       end
     end    
     
-    # retrieves the series index in the chart's series collection
     def index
       @chart.series.index(self)
     end

data/lib/axlsx/drawing/series_title.rb

@@ -1,5 +1,5 @@
 module Axlsx
-  # A series title is a Title with a slightly different serialization
+  # A series title is a Title with a slightly different serialization than chart titles.
   class SeriesTitle < Title
 
     # Serializes the series title

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -23,51 +23,24 @@ module Axlsx
     # @return [Integer]
     attr_reader :index
 
-    # Creates a new TwoCellAnchor object
+    # Creates a new TwoCellAnchor object and sets up a reference to the from and to markers in the 
+    # graphic_frame's chart. That means that you can do stuff like
+    # c = worksheet.add_chart Axlsx::Chart
+    # c.start_at 5, 9
     # @param [Drawing] drawing
-    # @param [Chart] chart
-    # @option options [Array] start_at
-    # @option options [Array] end_at
+    # @param [Class] chart_type This is passed to the graphic frame for instantiation. must be Chart or a subclass of Chart
+    # @option options [Array] start_at the col, row to start at
+    # @option options [Array] end_at the col, row to end at
     def initialize(drawing, chart_type, options)
       @drawing = drawing
       drawing.anchors << self      
-
       @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
       @graphic_frame = GraphicFrame.new(self, chart_type, options)
-
-      self.start_at(options[:start_at][0], options[:start_at][1]) if options[:start_at].is_a?(Array)
-      self.end_at(options[:end_at][0], options[:end_at][1]) if options[:end_at].is_a?(Array)
-      # passing a reference to our start and end markers for convenience
-      # this lets us access the markers directly from the chart.
-      @graphic_frame.chart.send(:start_at=, @from)
-      @graphic_frame.chart.send(:end_at=, @to)
     end
 
     def index
       @drawing.anchors.index(self)
     end
-    
-   
-    # This is a short cut method to set the start anchor position
-    # @param [Integer] x The column
-    # @param [Integer] y The row
-    # @return [Marker]
-    def start_at(x, y)
-      @from.col = x
-      @from.row = y
-      @from
-    end
-
-    # This is a short cut method to set the end anchor position
-    # @param [Integer] x The column
-    # @param [Integer] y The row
-    # @return [Marker]
-    def end_at(x, y)
-      @to.col = x
-      @to.row = y
-      @to
-    end
-
     # Serializes the two cell anchor
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
     # @return [String]
@@ -84,5 +57,8 @@ module Axlsx
         xml.send('xdr:clientData')
       }
     end    
+
+    private
+
   end
 end

data/lib/axlsx/drawing/val_axis.rb

@@ -2,7 +2,7 @@ module Axlsx
   # the ValAxis class defines a chart value axis.
   class ValAxis < Axis
 
-    # This element specifies whether the value axis crosses the category axis between categories.
+    # This element specifies how the value axis crosses the category axis.
     # must be one of [:between, :midCat]
     # @return [Symbol]
     attr_accessor :crossBetween
@@ -11,17 +11,17 @@ module Axlsx
     # @param [Integer] axId the id of this axis
     # @param [Integer] crossAx the id of the perpendicular axis
     # @option options [Symbol] axPos
-    # @option options [Symbol] crosses
     # @option options [Symbol] tickLblPos
+    # @option options [Symbol] crosses
     # @option options [Symbol] crossesBetween
     def initialize(axId, crossAx, options={})
-      @crossBetween = :between
+      self.crossBetween = :between
       super(axId, crossAx, options)
     end
     
     def crossBetween=(v) RestrictionValidator.validate "ValAxis.crossBetween", [:between, :midCat], v; @crossBetween = v; end
 
-    # Serializes the value  axis
+    # Serializes the value axis
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
     # @return [String]
     def to_xml(xml)

data/lib/axlsx/drawing/val_axis_data.rb

@@ -0,0 +1,28 @@
+module Axlsx
+  # The ValAxisData class manages the values for a chart value series.
+  class ValAxisData < CatAxisData
+
+    # Serializes the value axis data
+    # @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:val') {
+        xml.send('c:numRef') {
+          xml.send('c:f', Axlsx::cell_range(@list))
+          xml.send('c:numCache') {
+            xml.send('c:formatCode', 'General')
+            xml.send('c:ptCount', :val=>size)
+            each_with_index do |item, index|
+              v = item.is_a?(Cell) ? item.value : item
+              xml.send('c:pt', :idx=>index) {
+                xml.send('c:v', v) 
+              }
+            end
+          }                        
+        }
+      }
+    end
+
+  end
+  
+end

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

@@ -0,0 +1,29 @@
+module Axlsx
+
+  class ValAxisData < SimpleTypedList
+    def initialize(data=[])
+      super Object
+      @list.concat data if data.is_a?(Array)
+    end
+
+    def to_xml(xml)
+      xml.send('c:val') {
+        xml.send('c:numRef') {
+          xml.send('c:f', Axlsx::cell_range(@list))
+          xml.send('c:numCache') {
+            xml.send('c:formatCode', 'General')
+            xml.send('c:ptCount', :val=>data.size)
+            each_with_index do |item, index|
+              v = item.is_a?(Cell) ? item.value : item
+              xml.send('c:pt', :idx=>index) {
+                xml.send('c:v', v) 
+              }
+            end
+          }                        
+        }
+      }
+    end
+
+  end
+  
+end

data/lib/axlsx/drawing/view_3D.rb

@@ -1,6 +1,13 @@
 module Axlsx
   # 3D attributes for a chart.
   class View3D
+
+    # Validation for hPercent
+    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
+    
+    # validation for depthPercent
+    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)%/
+
     # x rotation for the chart 
     # must be between -90 and 90
     # @return [Integer]
@@ -41,18 +48,17 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end    
     end
-    
-    # Validation for hPercent
-    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
-    
-    # validation for depthPercent
-    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)%/
 
     def rotX=(v) DataTypeValidator.validate "#{self.class}.rotX", [Integer, Fixnum], v, lambda {|v| v >= -90 && v <= 90 }; @rotX = v; end
+
     def hPercent=(v) RegexValidator.validate "#{self.class}.rotX", H_PERCENT_REGEX, v; @hPercent = v; end
+
     def rotY=(v) DataTypeValidator.validate "#{self.class}.rotY", [Integer, Fixnum], v, lambda {|v| v >= 0 && v <= 360 }; @rotY = v; end
+
     def depthPercent=(v) RegexValidator.validate "#{self.class}.depthPercent", DEPTH_PERCENT_REGEX, v; @depthPercent = v; end
+
     def rAngAx=(v) Axlsx::validate_boolean(v); @rAngAx = v; end
+
     def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|v| v >= 0 && v <= 240 }; @perspective = v; end
 
     # Serializes the view3D properties

data/lib/axlsx/util/constants.rb

@@ -1,8 +1,5 @@
 module Axlsx
 
-  # version
-  VERSION="1.0.6"
-
   # XML Encoding
   ENCODING = "UTF-8"
 

data/lib/axlsx/util/simple_typed_list.rb

@@ -100,6 +100,11 @@ module Axlsx
       index < @locked_at
     end
     
+    # override the equality method so that this object can be compared to a simple array.
+    # if this object's list is equal to the specifiec array, we return true.
+    def ==(v)
+      v == @list
+    end
     # method_mission override to pass allowed methods to the list.
     # @note 
     #  the following methods are not allowed
@@ -123,12 +128,12 @@ module Axlsx
     #   :drop_while
     #   :delete_if
     #   :clear
-    #   :concat
     def method_missing(meth, *args, &block)
-      raise ArgumentError, "#{meth} not supported" if [:replace, :insert, :collect!, :map!, :pop, :delete_if, :reverse!, :shift, :shuffle!, :slice!, :sort!, :uniq!, :unshift, :zip, :flatten!, :fill, :drop, :drop_while, :delete_if, :clear, :concat].include? meth.to_sym        
+      raise ArgumentError, "#{meth} not supported" if [:replace, :insert, :collect!, :map!, :pop, :delete_if, :reverse!, :shift, :shuffle!, :slice!, :sort!, :uniq!, :unshift, :zip, :flatten!, :fill, :drop, :drop_while, :delete_if, :clear].include? meth.to_sym        
       if @list.respond_to? meth
         @list.send(meth, *args, &block)      
       else
+        puts "method:#{meth.inspect}"
         super
       end
     end

data/lib/axlsx/version.rb

@@ -0,0 +1,4 @@
+module Axlsx
+  # version
+  VERSION="1.0.7"
+end

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

@@ -100,11 +100,19 @@ module Axlsx
       @rows.last
     end
 
-    # Adds a chart to this worksheets drawing.
+    # Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details. 
     # @param [Class] chart_type
     # @option options [Array] start_at
     # @option options [Array] end_at
     # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Integer] style 
+    # @note each chart type also specifies additional options 
+    # @see Chart
+    # @see Pie3DChart
+    # @see Bar3DChart
+    # @see Line3DChart
+    # @see README for examples
     def add_chart(chart_type, options={})
       chart = drawing.add_chart(chart_type, options)
       yield chart if block_given?

data/test/drawing/tc_axis.rb

@@ -14,6 +14,7 @@ class TestAxis < Test::Unit::TestCase
     assert_equal(@axis.tickLblPos, :nextTo, "tick label position default incorrect")
     assert_equal(@axis.crosses, :autoZero, "tick label position default incorrect")
     assert(@axis.scaling.is_a?(Axlsx::Scaling) && @axis.scaling.orientation == :minMax, "scaling default incorrect")
+    assert_raise(ArgumentError) { Axlsx::Axis.new -1234, 'abcd' }
   end
 
   def test_axis_position

data/test/drawing/tc_cat_axis_data.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestCatAxisData < Test::Unit::TestCase
+
+  def setup
+    p = Axlsx::Package.new
+    @ws = p.workbook.add_worksheet
+    chart = @ws.drawing.add_chart Axlsx::Bar3DChart
+    @series = chart.add_series :labels=>["zero", "one", "two"]
+  end
+  
+  def test_initialize
+    assert(@series.labels.is_a?Axlsx::SimpleTypedList)
+    assert_equal(@series.labels, ["zero", "one", "two"])
+  end
+
+end

data/test/drawing/tc_cat_axis_data.rb~

@@ -0,0 +1,32 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestCatAxisData < 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(@series.data.is_a?Axlsx::SimpleTypedList)
+    assert_equal(@series.data, [0,1,2], "data option 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_chart.rb

@@ -34,6 +34,18 @@ class TestChart < Test::Unit::TestCase
     assert_equal(@chart.style, 2)
   end
 
+  def test_start_at
+    @chart.start_at 15,25
+    assert_equal(@chart.graphic_frame.anchor.from.col, 15)
+    assert_equal(@chart.graphic_frame.anchor.from.row, 25)
+
+  end
+
+  def end_at
+    @chart.end_at 25, 90
+    assert_equal(@chart.graphic_frame.anchor.from.col, 25)
+    assert_equal(@chart.graphic_frame.anchor.to.row, 90)
+  end
 
   def test_add_series    
     s = @chart.add_series :data=>[0,1,2,3], :labels => ["one", 1, "anything"], :title=>"bob"

data/test/drawing/tc_line_series.rb

@@ -0,0 +1,27 @@
+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")    
+  end
+
+  def test_data
+    assert_equal(@series.data, [0,1,2])
+  end
+
+  def test_labels
+    assert_equal(@series.labels, ["zero", "one", "two"])
+  end
+
+end