axlsx 1.3.1 → 1.3.2

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,6 +7,8 @@ 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]
@@ -30,9 +32,7 @@ module Axlsx
       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

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/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,7 +28,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :rot_x
     alias :rotX :rot_x
-    
+
     # height of chart as % of chart width
     # must be between 5% and 500%
     # @return [String]
@@ -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,6 +3,28 @@ module Axlsx
   # A VmlShape is used to position and render a comment.
   class VmlShape
 
+    include Axlsx::OptionsParser
+
+    # 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
+    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
+      @id = (0...8).map{65.+(rand(25)).chr}.join
+      parse_options options
+      yield self if block_given?
+    end
+
     # The row anchor position for this shape determined by the comment's ref value
     # @return [Integer]
     attr_reader :row
@@ -43,29 +65,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :bottom_offset
 
-    # 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
-    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
-      @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
-      yield self if block_given?
-    end
-
-    # @see column
+     # @see column
     def column=(v); Axlsx::validate_integerish(v); @column = v.to_i end
  
     # @see row

data/lib/axlsx/package.rb

@@ -3,7 +3,7 @@ module Axlsx
   # Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
   # xlsx document including valdation and serialization.
   class Package
-
+    include Axlsx::OptionsParser
 
     # provides access to the app doc properties for this package
     # see App
@@ -23,9 +23,7 @@ module Axlsx
       @workbook = nil
       @core, @app  =  Core.new, App.new
       @core.creator = options[:author] || @core.creator
-      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
 
@@ -175,7 +173,7 @@ module Axlsx
     # @return [Array] An array of hashes that define the entry, document and schema for each part of the package.
     # @private
     def parts
-      @parts = [
+      parts = [
        {:entry => RELS_PN, :doc => relationships.to_xml_string, :schema => RELS_XSD},
        {:entry => "xl/#{STYLES_PN}", :doc => workbook.styles.to_xml_string, :schema => SML_XSD},
        {:entry => CORE_PN, :doc => @core.to_xml_string, :schema => CORE_XSD},
@@ -186,39 +184,39 @@ module Axlsx
       ]
 
       workbook.drawings.each do |drawing|
-        @parts << {:entry => "xl/#{drawing.rels_pn}", :doc => drawing.relationships.to_xml_string, :schema => RELS_XSD}
-        @parts << {:entry => "xl/#{drawing.pn}", :doc => drawing.to_xml_string, :schema => DRAWING_XSD}
+        parts << {:entry => "xl/#{drawing.rels_pn}", :doc => drawing.relationships.to_xml_string, :schema => RELS_XSD}
+        parts << {:entry => "xl/#{drawing.pn}", :doc => drawing.to_xml_string, :schema => DRAWING_XSD}
       end
 
 
       workbook.tables.each do |table|
-        @parts << {:entry => "xl/#{table.pn}", :doc => table.to_xml_string, :schema => SML_XSD}
+        parts << {:entry => "xl/#{table.pn}", :doc => table.to_xml_string, :schema => SML_XSD}
       end
 
       workbook.comments.each do|comment|
         if comment.size > 0
-          @parts << { :entry => "xl/#{comment.pn}", :doc => comment.to_xml_string, :schema => SML_XSD }
-          @parts << { :entry => "xl/#{comment.vml_drawing.pn}", :doc => comment.vml_drawing.to_xml_string, :schema => nil }
+          parts << { :entry => "xl/#{comment.pn}", :doc => comment.to_xml_string, :schema => SML_XSD }
+          parts << { :entry => "xl/#{comment.vml_drawing.pn}", :doc => comment.vml_drawing.to_xml_string, :schema => nil }
         end
       end
 
       workbook.charts.each do |chart|
-        @parts << {:entry => "xl/#{chart.pn}", :doc => chart.to_xml_string, :schema => DRAWING_XSD}
+        parts << {:entry => "xl/#{chart.pn}", :doc => chart.to_xml_string, :schema => DRAWING_XSD}
       end
 
       workbook.images.each do |image|
-        @parts << {:entry => "xl/#{image.pn}", :path => image.image_src}
+        parts << {:entry => "xl/#{image.pn}", :path => image.image_src}
       end
 
       if use_shared_strings
-        @parts << {:entry => "xl/#{SHARED_STRINGS_PN}", :doc => workbook.shared_strings.to_xml_string, :schema => SML_XSD}
+        parts << {:entry => "xl/#{SHARED_STRINGS_PN}", :doc => workbook.shared_strings.to_xml_string, :schema => SML_XSD}
       end
 
       workbook.worksheets.each do |sheet|
-        @parts << {:entry => "xl/#{sheet.rels_pn}", :doc => sheet.relationships.to_xml_string, :schema => RELS_XSD}
-        @parts << {:entry => "xl/#{sheet.pn}", :doc => sheet.to_xml_string, :schema => SML_XSD}
+        parts << {:entry => "xl/#{sheet.rels_pn}", :doc => sheet.relationships.to_xml_string, :schema => RELS_XSD}
+        parts << {:entry => "xl/#{sheet.pn}", :doc => sheet.to_xml_string, :schema => SML_XSD}
       end
-      @parts
+      parts
     end
 
     # Performs xsd validation for a signle document

data/lib/axlsx/stylesheet/border.rb

@@ -3,21 +3,12 @@ module Axlsx
   # This class details a border used in Office Open XML spreadsheet styles.
   class Border
 
-    # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell.
-    attr_reader :diagonalUp
-
-    # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
-    attr_reader :diagonalDown
-
-    # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
-    attr_reader :outline
-
-    # @return [SimpleTypedList] A list of BorderPr objects for this border.
-    attr_reader :prs
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
 
     # Creates a new Border object
-    # @option options [Boolean] diagonalUp
-    # @option options [Boolean] diagonalDown
+    # @option options [Boolean] diagonal_up
+    # @option options [Boolean] diagonal_down
     # @option options [Boolean] outline
     # @example - Making a border
     #   p = Axlsx::Package.new
@@ -30,15 +21,33 @@ module Axlsx
     # @see Style#add_style
     def initialize(options={})
       @prs = SimpleTypedList.new BorderPr
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
+    serializable_attributes :diagonal_up, :diagonal_down, :outline
+
+    # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell.
+    attr_reader :diagonal_up
+    alias :diagonalUp :diagonal_up
+
+    # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
+    attr_reader :diagonal_down
+    alias :diagonalDown :diagonal_down
+
+    # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
+    attr_reader :outline
+
+    # @return [SimpleTypedList] A list of BorderPr objects for this border.
+    attr_reader :prs
+
     # @see diagonalUp
-    def diagonalUp=(v) Axlsx::validate_boolean v; @diagonalUp = v end
+    def diagonal_up=(v) Axlsx::validate_boolean v; @diagonal_up = v end
+    alias :diagonalUp= :diagonal_up=
+
     # @see diagonalDown
-    def diagonalDown=(v) Axlsx::validate_boolean v; @diagonalDown = v end
+    def diagonal_down=(v) Axlsx::validate_boolean v; @diagonal_down = v end
+    alias :diagonalDown= :diagonal_down=
+
     # @see outline
     def outline=(v) Axlsx::validate_boolean v; @outline = v end
 
@@ -47,9 +56,9 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<border '
-      h = self.instance_values.select{ |k,v| [:diagonalUp, :diagonalDown, :outline].include? k }
-      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '>'
+      # enforces order
       [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
         @prs.select { |pr| pr.name == k }.each do |part|
           part.to_xml_string(str)