axlsx 1.2.0 → 2.0.0

data/lib/axlsx/drawing/scaling.rb

@@ -3,6 +3,19 @@ module Axlsx
   # The Scaling class defines axis scaling
   class Scaling
 
+    include Axlsx::OptionsParser
+
+    # creates a new Scaling object
+    # @option options [Integer, Fixnum] logBase
+    # @option options [Symbol] orientation
+    # @option options [Float] max
+    # @option options [Float] min
+    def initialize(options={})
+      @orientation = :minMax
+      @logBase, @min, @max = nil, nil, nil
+      parse_options options
+    end
+
     # logarithmic base for a logarithmic axis.
     # must be between 2 and 1000
     # @return [Integer]
@@ -21,19 +34,6 @@ module Axlsx
     # @return [Float]
     attr_reader :min
 
-    # creates a new Scaling object
-    # @option options [Integer, Fixnum] logBase
-    # @option options [Symbol] orientation
-    # @option options [Float] max
-    # @option options [Float] min
-    def initialize(options={})
-      @orientation = :minMax
-      @logBase, @min, @max = nil, nil, nil
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # @see logBase
     def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer, Fixnum], v, lambda { |arg| arg >= 2 && arg <= 1000}; @logBase = v; end
     # @see orientation

data/lib/axlsx/drawing/scatter_chart.rb

@@ -7,39 +7,45 @@ module Axlsx
   # @see README for an example
   class ScatterChart < Chart
 
+    include Axlsx::OptionsParser
+
     # The Style for the scatter chart
     # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
     # return [Symbol]
-    attr_reader :scatterStyle
+    attr_reader :scatter_style
+    alias :scatterStyle :scatter_style
 
     # the x value axis
     # @return [ValAxis]
-    attr_reader :xValAxis
+    def x_val_axis
+      axes[:x_val_axis]
+    end
+    alias :xValAxis :x_val_axis
 
     # the y value axis
     # @return [ValAxis]
-    attr_reader :yValAxis
+    def y_val_axis
+      axes[:x_val_axis]
+    end
+    alias :yValAxis :y_val_axis
 
     # Creates a new scatter chart
     def initialize(frame, options={})
-      @scatterStyle = :lineMarker
-      @xValAxId = rand(8 ** 8)
-      @yValAxId = rand(8 ** 8)
-      @xValAxis = ValAxis.new(@xValAxId, @yValAxId)
-      @yValAxis = ValAxis.new(@yValAxId, @xValAxId)
-      super(frame, options)
+      @vary_colors = 0
+      @scatter_style = :lineMarker
+
+           super(frame, options)
       @series_type = ScatterSeries
       @d_lbls = nil
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
     # see #scatterStyle
-    def scatterStyle=(v)
+    def scatter_style=(v)
       Axlsx.validate_scatter_style(v)
-      @scatterStyle = v
+      @scatter_style = v
     end
+    alias :scatterStyle= :scatter_style=
 
     # Serializes the object
     # @param [String] str
@@ -47,17 +53,22 @@ module Axlsx
     def to_xml_string(str = '')
       super(str) do |str_inner|
         str_inner << '<c:scatterChart>'
-        str_inner << '<c:scatterStyle val="' << scatterStyle.to_s << '"/>'
-        str_inner << '<c:varyColors val="1"/>'
+        str_inner << '<c:scatterStyle val="' << scatter_style.to_s << '"/>'
+        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
-        d_lbls.to_xml_string(str) if @d_lbls
-        str_inner << '<c:axId val="' << @xValAxId.to_s << '"/>'
-        str_inner << '<c:axId val="' << @yValAxId.to_s << '"/>'
+        d_lbls.to_xml_string(str_inner) if @d_lbls
+        axes.to_xml_string(str_inner, :ids => true)
         str_inner << '</c:scatterChart>'
-        @xValAxis.to_xml_string str_inner
-        @yValAxis.to_xml_string str_inner
+        axes.to_xml_string(str_inner)
       end
       str
     end
+
+    # The axes for the scatter chart. ScatterChart has an x_val_axis and
+    # a y_val_axis
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:x_val_axis => ValAxis, :y_val_axis => ValAxis)
+    end
   end
 end

data/lib/axlsx/drawing/ser_axis.rb

@@ -5,30 +5,29 @@ module Axlsx
 
     # The number of tick lables to skip between labels
     # @return [Integer]
-    attr_reader :tickLblSkip
+    attr_reader :tick_lbl_skip
+    alias :tickLblSkip :tick_lbl_skip
 
     # The number of tickmarks to be skipped before the next one is rendered.
     # @return [Boolean]
-    attr_reader :tickMarkSkip
+    attr_reader :tick_mark_skip
+    alias :tickMarkSkip :tick_mark_skip
 
     # Creates a new SerAxis object
-    # @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={})
-      @tickLblSkip, @tickMarkSkip = 1, 1
-      super(axId, crossAx, options)
+    # @option options [Integer] tick_lbl_skip
+    # @option options [Integer] tick_mark_skip
+    def initialize(options={})
+      @tick_lbl_skip, @tick_mark_skip = 1, 1
+      super(options)
     end
 
     # @see tickLblSkip
-    def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
+    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    alias :tickLblSkip= :tick_lbl_skip=
 
     # @see tickMarkSkip
-    def tickMarkSkip=(v) Axlsx::validate_unsigned_int(v); @tickMarkSkip = v; end
+    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
+    alias :tickMarkSkip= :tick_mark_skip=
 
     # Serializes the object
     # @param [String] str
@@ -36,8 +35,8 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<c:serAx>'
       super(str)
-      str << '<c:tickLblSkip val="' << @tickLblSkip.to_s << '"/>' unless @tickLblSkip.nil?
-      str << '<c:tickMarkSkip val="' << @tickMarkSkip.to_s << '"/>' unless @tickMarkSkip.nil?
+      str << '<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>' unless @tick_lbl_skip.nil?
+      str << '<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>' unless @tick_mark_skip.nil?
       str << '</c:serAx>'
     end
   end

data/lib/axlsx/drawing/series.rb

@@ -6,6 +6,8 @@ module Axlsx
   # @see Chart#add_series
   class Series
 
+    include Axlsx::OptionsParser
+
     # The chart that owns this series
     # @return [Chart]
     attr_reader :chart
@@ -22,19 +24,15 @@ module Axlsx
       @order = nil
       self.chart = chart
       @chart.series << self
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
-
     # The index of this series in the chart's series.
     # @return [Integer]
     def index
       @chart.series.index(self)
     end
 
-
     # The order of this series in the chart's series. By default the order is the index of the series.
     # @return [Integer]
     def order
@@ -68,5 +66,4 @@ module Axlsx
       str << '</c:ser>'
     end
   end
-
 end

data/lib/axlsx/drawing/str_data.rb

@@ -5,6 +5,8 @@ module Axlsx
   # This class is extended for NumData to include the formatCode attribute required for numLit and numCache
   class StrData
 
+    include Axlsx::OptionsParser
+
     # creates a new StrVal object
     # @option options [Array] :data
     # @option options [String] :tag_name
@@ -12,9 +14,7 @@ module Axlsx
       @tag_prefix = :str
       @type = StrVal
       @pt = SimpleTypedList.new(@type)
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
     # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.

data/lib/axlsx/drawing/str_val.rb

@@ -4,19 +4,20 @@ module Axlsx
   #This class specifies data for a particular data point.
   class StrVal
 
-    # a string value.
-    # @return [String]
-    attr_reader :v
+    include Axlsx::OptionsParser
 
     # creates a new StrVal object
     # @option options [String] v
     def initialize(options={})
       @v = ""
       @idx = 0
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
+
+    # a string value.
+    # @return [String]
+    attr_reader :v
+
     # @see v
     def v=(v)
       @v = v.to_s
@@ -27,7 +28,5 @@ module Axlsx
       Axlsx::validate_unsigned_int(idx)
       str << '<c:pt idx="' << idx.to_s << '"><c:v>' << v.to_s << '</c:v></c:pt>'
     end
-
   end
-
 end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -5,6 +5,8 @@ module Axlsx
   # @see Worksheet#add_chart
   class TwoCellAnchor
 
+    include Axlsx::OptionsParser
+
     # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
     # @return [Marker]
     attr_reader :from
@@ -34,22 +36,23 @@ module Axlsx
       @drawing = drawing
       drawing.anchors << self
       @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
+      parse_options options
     end
 
     # sets the col, row attributes for the from marker.
     # @note The recommended way to set the start position for graphical
     # objects is directly thru the object. 
     # @see Chart#start_at
-    def start_at(x, y)
-      set_marker_coords(x, y, from)
+    def start_at(x, y=nil)
+      from.coord x, y
     end
 
     # sets the col, row attributes for the to marker
     # @note the recommended way to set the to position for graphical
     # objects is directly thru the object
     # @see Char#end_at
-    def end_at(x, y)
-      set_marker_coords(x, y, to) 
+    def end_at(x, y=nil)
+      to.coord x, y
     end
 
     # Creates a graphic frame and chart object associated with this anchor
@@ -85,28 +88,5 @@ module Axlsx
       str << '<xdr:clientData/>'
       str << '</xdr:twoCellAnchor>'
     end
-    private 
-
-    # parses coordinates and sets up a marker's row/col propery
-    def set_marker_coords(x, y, marker)
-      marker.col, marker.row = *parse_coord_args(x, y)
-    end
-
-    # handles multiple inputs for setting the position of a marker
-    # @see Chart#start_at
-    def parse_coord_args(x, y=0)
-      if x.is_a?(String)
-        x, y = *Axlsx::name_to_indices(x)
-      end
-      if x.is_a?(Cell)
-        x, y = *x.pos
-      end
-      if x.is_a?(Array)
-        x, y = *x
-      end
-      [x, y]
-    end
-
-
   end
 end

data/lib/axlsx/drawing/val_axis.rb

@@ -6,21 +6,22 @@ module Axlsx
     # This element specifies how the value axis crosses the category axis.
     # must be one of [:between, :midCat]
     # @return [Symbol]
-    attr_reader :crossBetween
+    attr_reader :cross_between
+    alias :crossBetween :cross_between
 
     # Creates a new ValAxis 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 [Symbol] crossesBetween
-    def initialize(axId, crossAx, options={})
-      self.crossBetween = :between
-      super(axId, crossAx, options)
+    # @option options [Symbol] crosses_between
+    def initialize(options={})
+      self.cross_between = :between
+      super(options)
     end
-    # @see crossBetween
-    def crossBetween=(v) RestrictionValidator.validate "ValAxis.crossBetween", [:between, :midCat], v; @crossBetween = v; end
+
+    # @see cross_between
+    def cross_between=(v)
+      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
+      @cross_between = v
+    end
+    alias :crossBetween= :cross_between=
 
     # Serializes the object
     # @param [String] str
@@ -28,7 +29,7 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<c:valAx>'
       super(str)
-      str << '<c:crossBetween val="' << @crossBetween.to_s << '"/>'
+      str << '<c:crossBetween val="' << @cross_between.to_s << '"/>'
       str << '</c:valAx>'
     end
 

data/lib/axlsx/drawing/view_3D.rb

@@ -3,6 +3,20 @@ module Axlsx
   # 3D attributes for a chart.
   class View3D
 
+    include Axlsx::OptionsParser
+
+    # Creates a new View3D for charts
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
+    # @option options [Integer] perspective
+    def initialize(options={})
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
+      parse_options options
+    end
+
     # Validation for hPercent
     H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)/
 
@@ -14,8 +28,8 @@ module Axlsx
     # @return [Integer]
     attr_reader :rot_x
     alias :rotX :rot_x
-    
-    # height of chart as % of chart
+
+    # height of chart as % of chart width
     # must be between 5% and 500%
     # @return [String]
     attr_reader :h_percent
@@ -26,7 +40,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :rot_y
     alias :rotY :rot_y
-    
+
     # depth or chart as % of chart width
     # must be between 20% and 2000%
     # @return [String]
@@ -42,60 +56,60 @@ module Axlsx
     # @return [Integer]
     attr_reader :perspective
 
-    # Creates a new View3D for charts
-    # @option options [Integer] rot_x
-    # @option options [String] h_percent
-    # @option options [Integer] rot_y
-    # @option options [String] depth_percent
-    # @option options [Boolean] r_ang_ax
-    # @option options [Integer] perspective
-    def initialize(options={})
-      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # @see rot_x
-    def rot_x=(v) DataTypeValidator.validate "#{self.class}.rot_x", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rot_x = v; end
+    def rot_x=(v)
+      RangeValidator.validate "View3D.rot_x", -90, 90, v
+      @rot_x = v
+    end
     alias :rotX= :rot_x=
 
-    # @see h_percent
-    def h_percent=(v)
-      RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
-      @h_percent = v
-    end
+      # @see h_percent
+      def h_percent=(v)
+        RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+        @h_percent = v
+      end
     alias :hPercent= :h_percent=
 
-    # @see rot_y
-    def rot_y=(v) DataTypeValidator.validate "#{self.class}.rot_y", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rot_y = v; end
+      # @see rot_y
+      def rot_y=(v) 
+        RangeValidator.validate "View3D.rot_y", 0, 360, v
+        @rot_y = v
+      end
     alias :rotY= :rot_y=
 
-    # @see depth_percent
-    def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+      # @see depth_percent
+      def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
     alias :depthPercent= :depth_percent=
 
-    # @see r_ang_ax
-    def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+      # @see r_ang_ax
+      def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
     alias :rAngAx= :r_ang_ax=
-     
-    # @see perspective
-    def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
+      # @see perspective
+      def perspective=(v) 
+        RangeValidator.validate "View3D.perspective", 0, 240, v
+        @perspective = v
+      end
+
+    # DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<c:view3D>'
-      str << '<c:rotX val="' << @rot_x.to_s << '"/>' unless @rot_x.nil?
-      str << '<c:hPercent val="' << @h_percent.to_s << '"/>' unless @h_percent.nil?
-      str << '<c:rotY val="' << @rot_y.to_s << '"/>' unless @rot_y.nil?
-      str << '<c:depthPercent val="' << @depth_percent.to_s << '"/>' unless @depth_percent.nil?
-      str << '<c:rAngAx val="' << @r_ang_ax.to_s << '"/>' unless @r_ang_ax.nil?
-      str << '<c:perspective val="' << @perspective.to_s << '"/>' unless @perspective.nil?
+      %w(rot_x h_percent rot_y depth_percent r_ang_ax perspective).each do |key|
+        str << element_for_attribute(key, 'c')
+      end
       str << '</c:view3D>'
     end
 
+    private
+    # Note: move this to Axlsx module if we find the smae pattern elsewhere.
+    def element_for_attribute(name, namespace='')
+      val = instance_values[name]
+      return "" if val == nil
+      "<%s:%s val='%s'/>" % [namespace, Axlsx::camel(name, false), val]
+    end
   end
 end

data/lib/axlsx/drawing/vml_shape.rb

@@ -3,96 +3,36 @@ module Axlsx
   # A VmlShape is used to position and render a comment.
   class VmlShape
 
-    # The row anchor position for this shape determined by the comment's ref value
-    # @return [Integer]
-    attr_reader :row
-
-    # The column anchor position for this shape determined by the comment's ref value
-    # @return [Integer]
-    attr_reader :column
-
-    # The left column for this shape
-    # @return [Integer]
-    attr_reader :left_column
-
-    # The left offset for this shape
-    # @return [Integer]
-    attr_reader :left_offset
-
-    # The top row for this shape
-    # @return [Integer]
-    attr_reader :top_row
-
-    # The top offset for this shape
-    # @return [Integer]
-    attr_reader :top_offset
-
-    # The right column for this shape
-    # @return [Integer]
-    attr_reader :right_column
-
-    # The right offset for this shape
-    # @return [Integer]
-    attr_reader :right_offset
-
-    # The botttom row for this shape
-    # @return [Integer]
-    attr_reader :bottom_row
-
-    # The bottom offset for this shape
-    # @return [Integer]
-    attr_reader :bottom_offset
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
 
     # Creates a new VmlShape
-    # @option options [Integer|String] left_column
-    # @option options [Integer|String] left_offset
-    # @option options [Integer|String] top_row
-    # @option options [Integer|String] top_offset
-    # @option options [Integer|String] right_column
-    # @option options [Integer|String] right_offset
-    # @option options [Integer|String] bottom_row
-    # @option options [Integer|String] bottom_offset
+    # @option options [Integer] row
+    # @option options [Integer] column
+    # @option options [Integer] left_column
+    # @option options [Integer] left_offset
+    # @option options [Integer] top_row
+    # @option options [Integer] top_offset
+    # @option options [Integer] right_column
+    # @option options [Integer] right_offset
+    # @option options [Integer] bottom_row
+    # @option options [Integer] bottom_offset
     def initialize(options={})
       @row = @column = @left_column = @top_row = @right_column = @bottom_row = 0
       @left_offset = 15
       @top_offset = 2
       @right_offset = 50
       @bottom_offset = 5
+      @visible = true
       @id = (0...8).map{65.+(rand(25)).chr}.join
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
       yield self if block_given?
     end
 
-    # @see column
-    def column=(v); Axlsx::validate_integerish(v); @column = v.to_i end
- 
-    # @see row
-    def row=(v); Axlsx::validate_integerish(v); @row = v.to_i end
-    # @see left_column
-    def left_column=(v); Axlsx::validate_integerish(v); @left_column = v.to_i end
-
-    # @see left_offset
-    def left_offset=(v); Axlsx::validate_integerish(v); @left_offset = v.to_i end
-
-    # @see top_row
-    def top_row=(v); Axlsx::validate_integerish(v); @top_row = v.to_i end
-
-    # @see top_offset
-    def top_offset=(v); Axlsx::validate_integerish(v); @top_offset = v.to_i end
-
-    # @see right_column
-    def right_column=(v); Axlsx::validate_integerish(v); @right_column = v.to_i end
-
-    # @see right_offset
-    def right_offset=(v); Axlsx::validate_integerish(v); @right_offset = v.to_i end
-
-    # @see bottom_row
-    def bottom_row=(v); Axlsx::validate_integerish(v); @bottom_row = v.to_i end
+    unsigned_int_attr_accessor :row, :column, :left_column, :left_offset, :top_row, :top_offset,
+                               :right_column, :right_offset, :bottom_row, :bottom_offset
 
-    # @see bottom_offset
-    def bottom_offset=(v); Axlsx::validate_integerish(v); @bottom_offset = v.to_i end
+    boolean_attr_accessor :visible
 
     # serialize the shape to a string
     # @param [String] str
@@ -100,7 +40,8 @@ module Axlsx
     def to_xml_string(str ='')
 str << <<SHAME_ON_YOU
 
-<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto">
+<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto"
+  style="visibility:#{@visible ? 'visible' : 'hidden'}">
   <v:fill color2="#ffffa1 [80]"/>
   <v:shadow on="t" obscured="t"/>
   <v:path o:connecttype="none"/>
@@ -115,7 +56,7 @@ str << <<SHAME_ON_YOU
    <x:AutoFill>False</x:AutoFill>
    <x:Row>#{row}</x:Row>
    <x:Column>#{column}</x:Column>
-   <x:Visible/>
+   #{@visible ? '<x:Visible/>' : ''}
   </x:ClientData>
  </v:shape>
 SHAME_ON_YOU