axlsx 1.3.1 → 1.3.2

data/lib/axlsx/stylesheet/border_pr.rb

@@ -2,7 +2,7 @@
 module Axlsx
   # A border part.
   class BorderPr
-
+    include Axlsx::OptionsParser
     # @return [Color] The color of this border part.
     attr_reader :color
 
@@ -45,9 +45,10 @@ module Axlsx
     # @option options [Symbol] style
     # @see Axlsx::Border
     def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options(options)
+      #options.each do |o|
+      #  self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      #end
     end
 
     # @see name

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -1,9 +1,33 @@
 # encoding: UTF-8
 module Axlsx
+  
+ 
   # CellAlignment stores information about the cell alignment of a style Xf Object.
   # @note Using Styles#add_style is the recommended way to manage cell alignment.
   # @see Styles#add_style
   class CellAlignment
+    
+
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    
+    serializable_attributes :horizontal, :vertical, :text_rotation, :wrap_text, :indent, :relative_indent, :justify_last_line, :shrink_to_fit, :reading_order
+    # Create a new cell_alignment object
+    # @option options [Symbol] horizontal
+    # @option options [Symbol] vertical
+    # @option options [Integer] text_rotation
+    # @option options [Boolean] wrap_text
+    # @option options [Integer] indent
+    # @option options [Integer] relative_indent
+    # @option options [Boolean] justify_last_line
+    # @option options [Boolean] shrink_to_fit
+    # @option options [Integer] reading_order
+    def initialize(options={})
+      parse_options options
+    end
+
+
+
     # The horizontal alignment of the cell.
     # @note
     #  The horizontal cell alignement style must be one of
@@ -31,11 +55,13 @@ module Axlsx
 
     # The textRotation of the cell.
     # @return [Integer]
-    attr_reader :textRotation
+    attr_reader :text_rotation
+    alias :textRotation :text_rotation
 
     # Indicate if the text of the cell should wrap
     # @return [Boolean]
-    attr_reader :wrapText
+    attr_reader :wrap_text
+    alias :wrapText :wrap_text
 
     # The amount of indent
     # @return [Integer]
@@ -43,64 +69,64 @@ module Axlsx
 
     # The amount of relativeIndent
     # @return [Integer]
-    attr_reader :relativeIndent
+    attr_reader :relative_indent
+    alias :relativeIndent :relative_indent
 
     # Indicate if the last line should be justified.
     # @return [Boolean]
-    attr_reader :justifyLastLine
+    attr_reader :justify_last_line
+    alias :justifyLastLine :justify_last_line
 
     # Indicate if the text should be shrunk to the fit in the cell.
     # @return [Boolean]
-    attr_reader :shrinkToFit
+    attr_reader :shrink_to_fit
+    alias :shrinkToFit :shrink_to_fit
 
     # The reading order of the text
     # 0 Context Dependent
     # 1 Left-to-Right
     # 2 Right-to-Left
     # @return [Integer]
-    attr_reader :readingOrder
-
-    # Create a new cell_alignment object
-    # @option options [Symbol] horizontal
-    # @option options [Symbol] vertical
-    # @option options [Integer] textRotation
-    # @option options [Boolean] wrapText
-    # @option options [Integer] indent
-    # @option options [Integer] relativeIndent
-    # @option options [Boolean] justifyLastLine
-    # @option options [Boolean] shrinkToFit
-    # @option options [Integer] readingOrder
-    def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
+    attr_reader :reading_order
+    alias :readingOrder :reading_order
 
     # @see horizontal
     def horizontal=(v) Axlsx::validate_horizontal_alignment v; @horizontal = v end
     # @see vertical
     def vertical=(v) Axlsx::validate_vertical_alignment v; @vertical = v end
     # @see textRotation
-    def textRotation=(v) Axlsx::validate_unsigned_int v; @textRotation = v end
+    def text_rotation=(v) Axlsx::validate_unsigned_int v; @text_rotation = v end
+    alias :textRotation= :text_rotation=
+
     # @see wrapText
-    def wrapText=(v) Axlsx::validate_boolean v; @wrapText = v end
+    def wrap_text=(v) Axlsx::validate_boolean v; @wrap_text = v end
+    alias :wrapText= :wrap_text=
+
     # @see indent
     def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end
+
     # @see relativeIndent
-    def relativeIndent=(v) Axlsx::validate_int v; @relativeIndent = v end
+    def relative_indent=(v) Axlsx::validate_int v; @relative_indent = v end
+    alias :relativeIndent= :relative_indent=
+
     # @see justifyLastLine
-    def justifyLastLine=(v) Axlsx::validate_boolean v; @justifyLastLine = v end
+    def justify_last_line=(v) Axlsx::validate_boolean v; @justify_last_line = v end
+    alias :justifyLastLine= :justify_last_line=
+
     # @see shrinkToFit
-    def shrinkToFit=(v) Axlsx::validate_boolean v; @shrinkToFit = v end
+    def shrink_to_fit=(v) Axlsx::validate_boolean v; @shrink_to_fit = v end
+    alias :shrinkToFit= :shrink_to_fit=
+
     # @see readingOrder
-    def readingOrder=(v) Axlsx::validate_unsigned_int v; @readingOrder = v end
+    def reading_order=(v) Axlsx::validate_unsigned_int v; @reading_order = v end
+    alias :readingOrder= :reading_order=
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<alignment '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
 

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -5,6 +5,11 @@ module Axlsx
   # @see Styles#add_style
   class CellProtection
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    serializable_attributes :hidden, :locked
+
     # specifies locking for cells that have the style containing this protection
     # @return [Boolean]
     attr_reader :hidden
@@ -17,9 +22,7 @@ module Axlsx
     # @option options [Boolean] hidden value for hidden protection
     # @option options [Boolean] locked value for locked protection
     def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
     # @see hidden
@@ -32,7 +35,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<protection '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
 

data/lib/axlsx/stylesheet/cell_style.rb

@@ -4,6 +4,23 @@ module Axlsx
   # @note Using Styles#add_style is the recommended way to manage cell styling.
   # @see Styles#add_style
   class CellStyle
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creats a new CellStyle object
+    # @option options [String] name
+    # @option options [Integer] xfId
+    # @option options [Integer] buildinId
+    # @option options [Integer] iLevel
+    # @option options [Boolean] hidden
+    # @option options [Boolean] customBuiltIn
+    def initialize(options={})
+      parse_options options
+    end
+
+    serializable_attributes :name, :xfId, :buildinId, :iLevel, :hidden, :customBuilin
+
     # The name of this cell style
     # @return [String]
     attr_reader :name
@@ -30,19 +47,7 @@ module Axlsx
     # @return [Boolean]
     attr_reader :customBuiltin
 
-    # Creats a new CellStyle object
-    # @option options [String] name
-    # @option options [Integer] xfId
-    # @option options [Integer] buildinId
-    # @option options [Integer] iLevel
-    # @option options [Boolean] hidden
-    # @option options [Boolean] customBuiltIn
-    def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-    end
-    # @see name
+     # @see name
     def name=(v)  Axlsx::validate_string v; @name = v end
     # @see xfId
     def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
@@ -60,7 +65,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<cellStyle '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
 

data/lib/axlsx/stylesheet/color.rb

@@ -2,6 +2,21 @@
 module Axlsx
   # The color class represents a color used for borders, fills an fonts
   class Color
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new Color object
+    # @option options [Boolean] auto
+    # @option options [String] rgb
+    # @option options [Float] tint
+    def initialize(options={})
+      @rgb = "FF000000"
+      parse_options options
+    end
+
+    serializable_attributes :auto, :rgb, :tint
+
     # Determines if the color is system color dependant
     # @return [Boolean]
     attr_reader :auto
@@ -31,17 +46,7 @@ module Axlsx
     # @return [Float]
     attr_reader :tint
 
-    # Creates a new Color object
-    # @option options [Boolean] auto
-    # @option options [String] rgb
-    # @option options [Float] tint
-    def initialize(options={})
-      @rgb = "FF000000"
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-    end
-    # @see auto
+     # @see auto
     def auto=(v) Axlsx::validate_boolean v; @auto = v end
     # @see color
     def rgb=(v)
@@ -64,11 +69,9 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      str << "<color "
-      self.instance_values.each do |key, value|
-        str << key.to_s << '="' << value.to_s << '" '
-      end
+    def to_xml_string(str = '', tag_name = 'color')
+      str << "<" << tag_name << " "
+      serialized_attributes str
       str << "/>"
     end
   end

data/lib/axlsx/stylesheet/dxf.rb

@@ -3,6 +3,9 @@ module Axlsx
   # The Dxf class defines an incremental formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
   # @see Styles#add_style
   class Dxf
+
+    include Axlsx::OptionsParser
+
     # The order in which the child elements is put in the XML seems to
     # be important for Excel
     CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection]
@@ -42,10 +45,7 @@ module Axlsx
     # @option options [CellAlignment] alignment
     # @option options [CellProtection] protection
     def initialize(options={})
-      options.each do |o|
-        next if o[1].nil?
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
     # @see Dxf#alignment

data/lib/axlsx/stylesheet/font.rb

@@ -4,6 +4,27 @@ module Axlsx
   # @note The recommended way to manage fonts, and other styles is Styles#add_style
   # @see Styles#add_style
   class Font
+    include Axlsx::OptionsParser
+
+    # Creates a new Font
+    # @option options [String] name
+    # @option options [Integer] charset
+    # @option options [Integer] family
+    # @option options [Integer] family
+    # @option options [Boolean] b
+    # @option options [Boolean] i
+    # @option options [Boolean] u
+    # @option options [Boolean] strike
+    # @option options [Boolean] outline
+    # @option options [Boolean] shadow
+    # @option options [Boolean] condense
+    # @option options [Boolean] extend
+    # @option options [Color] color
+    # @option options [Integer] sz
+    def initialize(options={})
+      parse_options options
+    end
+
     # The name of the font
     # @return [String]
     attr_reader :name
@@ -86,28 +107,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :sz
 
-    # Creates a new Font
-    # @option options [String] name
-    # @option options [Integer] charset
-    # @option options [Integer] family
-    # @option options [Integer] family
-    # @option options [Boolean] b
-    # @option options [Boolean] i
-    # @option options [Boolean] u
-    # @option options [Boolean] strike
-    # @option options [Boolean] outline
-    # @option options [Boolean] shadow
-    # @option options [Boolean] condense
-    # @option options [Boolean] extend
-    # @option options [Color] color
-    # @option options [Integer] sz
-    def initialize(options={})
-      options.each do |o|
-        next if o[1].nil?
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    # @see name
+     # @see name
     def name=(v) Axlsx::validate_string v; @name = v end
     # @see charset
     def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -4,6 +4,24 @@ module Axlsx
   # @see Open Office XML Part 1 §18.8.24
   class GradientFill
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new GradientFill object
+    # @option options [Symbol] type
+    # @option options [Float] degree
+    # @option options [Float] left
+    # @option options [Float] right
+    # @option options [Float] top
+    # @option options [Float] bottom
+    def initialize(options={})
+      options[:type] ||= :linear
+      parse_options options
+      @stop = SimpleTypedList.new GradientStop
+    end
+
+    serializable_attributes :type, :degree, :left, :right, :top, :bottom
+
     # The type of gradient.
     # @note
     #  valid options are
@@ -36,41 +54,47 @@ module Axlsx
     # @return [SimpleTypedList]
     attr_reader :stop
 
-    # Creates a new GradientFill object
-    # @option options [Symbol] type
-    # @option options [Float] degree
-    # @option options [Float] left
-    # @option options [Float] right
-    # @option options [Float] top
-    # @option options [Float] bottom
-    def initialize(options={})
-      options[:type] ||= :linear
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-      @stop = SimpleTypedList.new GradientStop
-    end
-
     # @see type
     def type=(v) Axlsx::validate_gradient_type v; @type = v end
+
     # @see degree
     def degree=(v) Axlsx::validate_float v; @degree = v end
+
     # @see left
-    def left=(v) DataTypeValidator.validate "GradientFill.left", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @left = v end
+    def left=(v)
+      validate_format_percentage "GradientFill.left", v
+      @left = v
+    end
+
     # @see right
-    def right=(v) DataTypeValidator.validate "GradientFill.right", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @right = v end
+    def right=(v)
+     validate_format_percentage "GradientFill.right", v
+     @right = v
+    end
+
     # @see top
-    def top=(v) DataTypeValidator.validate "GradientFill.top", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @top = v end
+    def top=(v)
+      validate_format_percentage "GradientFill.top", v
+      @top = v
+    end
+
     # @see bottom
-    def bottom=(v) DataTypeValidator.validate "GradientFill.bottom", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @bottom= v end
+    def bottom=(v)
+      validate_format_percentage "GradientFill.bottom", v
+      @bottom = v
+    end
+
+    # validates that the value provided is between 0.0 and 1.0
+    def validate_format_percentage(name, value)
+      DataTypeValidator.validate name, Float, value, lambda { |arg| arg >= 0.0 && arg <= 1.0}
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<gradientFill '
-      h = self.instance_values.reject { |k,v| k.to_sym == :stop }
-      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '>'
       @stop.each { |s| s.to_xml_string(str) }
       str << '</gradientFill>'