axlsx 1.3.1 → 1.3.2

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -3,6 +3,26 @@ module Axlsx
   # A NumFmt object defines an identifier and formatting code for data in cells.
   # @note The recommended way to manage styles is Styles#add_style
   class NumFmt
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new NumFmt object
+    # @param [Hash] options Options for the number format object
+    # @option [Integer] numFmtId The predefined format id or new format id for this format
+    # @option [String] fomratCode The format code for this number format
+    def initialize(options={})
+      @numFmtId = 0
+      @formatCode = ""
+      parse_options options
+    end
+
+    serializable_attributes :formatCode, :numFmtId
+
+    # @return [String] The formatting to use for this number format.
+    # @see http://support.microsoft.com/kb/264372
+    attr_reader :formatCode
+
     # @return [Integer] An unsinged integer referencing a standard or custom number format.
     # @note
     #  These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and NUM_FRM_YYYYMMDDHHMMSS.
@@ -40,29 +60,18 @@ module Axlsx
     # @see Axlsx
     attr_reader :numFmtId
 
-    # @return [String] The formatting to use for this number format.
-    # @see http://support.microsoft.com/kb/264372
-    attr_reader :formatCode
-    def initialize(options={})
-      @numFmtId = 0
-      @formatCode = ""
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-    end
-
     # @see numFmtId
     def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
+
     # @see formatCode
     def formatCode=(v) Axlsx::validate_string v; @formatCode = v end
 
-
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<numFmt '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
 

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -5,6 +5,16 @@ module Axlsx
   # @see Style#add_style
   class PatternFill
 
+    include Axlsx::OptionsParser
+    # Creates a new PatternFill Object
+    # @option options [Symbol] patternType
+    # @option options [Color] fgColor
+    # @option options [Color] bgColor
+    def initialize(options={})
+      @patternType = :none
+      parse_options options
+    end
+
     # The color to use for the the background in solid fills.
     # @return [Color]
     attr_reader :fgColor
@@ -38,16 +48,6 @@ module Axlsx
     # @see Office Open XML Part 1 18.18.55
     attr_reader :patternType
 
-    # Creates a new PatternFill Object
-    # @option options [Symbol] patternType
-    # @option options [Color] fgColor
-    # @option options [Color] bgColor
-    def initialize(options={})
-      @patternType = :none
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
     # @see fgColor
     def fgColor=(v) DataTypeValidator.validate "PatternFill.fgColor", Color, v; @fgColor=v end
     # @see bgColor
@@ -61,22 +61,13 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<patternFill patternType="' << patternType.to_s << '">'
       if fgColor.is_a?(Color)
-        str << "<fgColor "
-        fgColor.instance_values.each do |key, value|
-          str << key.to_s << '="' << value.to_s << '" '
-        end
-        str << "/>"
+        fgColor.to_xml_string str, "fgColor"
       end
 
       if bgColor.is_a?(Color)
-        str << "<bgColor "
-        bgColor.instance_values.each do |key, value|
-          str << key.to_s << '="' << value.to_s << '" '
-        end
-        str << "/>"
+        bgColor.to_xml_string str, "bgColor"
       end
       str << '</patternFill>'
     end
-
   end
 end

data/lib/axlsx/stylesheet/styles.rb

@@ -316,7 +316,7 @@ module Axlsx
       return unless options[:border]
       b_opts = options[:border]
       if b_opts.is_a?(Hash)
-        raise ArgumentError, (ERR_INVALID_BORDER_OPTIONS % b_opts) unless b_opts.values_at(:style, :color).size == 2
+        raise ArgumentError, (ERR_INVALID_BORDER_OPTIONS % b_opts) unless b_opts.keys.include?(:style) && b_opts.keys.include?(:color)
         border = Border.new b_opts
         (b_opts[:edges] || [:left, :right, :top, :bottom]).each do |edge|
           b_options = { :name => edge, :style => b_opts[:style], :color => Color.new(:rgb => b_opts[:color]) }

data/lib/axlsx/stylesheet/table_style.rb

@@ -4,6 +4,22 @@ module Axlsx
   # @note Table are not supported in this version and only the defaults required for a valid workbook are created.
   class TableStyle < SimpleTypedList
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # creates a new TableStyle object
+    # @raise [ArgumentError] if name option is not provided.
+    # @param [String] name
+    # @option options [Boolean] pivot
+    # @option options [Boolean] table
+    def initialize(name, options={})
+      self.name = name
+      parse_options options
+      super TableStyleElement
+    end
+
+    serializable_attributes :name, :pivot, :table
+
     # The name of this table style
     # @return [string]
     attr_reader :name
@@ -16,19 +32,6 @@ module Axlsx
     # @return [Boolean]
     attr_reader :table
 
-    # creates a new TableStyle object
-    # @raise [ArgumentError] if name option is not provided.
-    # @param [String] name
-    # @option options [Boolean] pivot
-    # @option options [Boolean] table
-    def initialize(name, options={})
-      self.name = name
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-      super TableStyleElement
-    end
-
     # @see name
     def name=(v) Axlsx::validate_string v; @name=v end
     # @see pivot
@@ -40,10 +43,8 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      attrs = instance_values.reject { |k, v| ![:name, :pivot, :table].include?(k) }
-      attrs[:count] = self.size
       str << '<tableStyle '
-      str << attrs.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str, {:count => self.size}
       str << '>'
       each { |table_style_el| table_style_el.to_xml_string(str) }
       str << '</tableStyle>'

data/lib/axlsx/stylesheet/table_style_element.rb

@@ -3,6 +3,20 @@ module Axlsx
   # an element of style that belongs to a table style.
   # @note tables and table styles are not supported in this version. This class exists in preparation for that support.
   class TableStyleElement
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # creates a new TableStyleElement object
+    # @option options [Symbol] type
+    # @option options [Integer] size
+    # @option options [Integer] dxfId
+    def initialize(options={})
+      parse_options options
+    end
+
+    serializable_attributes :type, :size, :dxfId
+
     # The type of style element. The following type are allowed
     #   :wholeTable
     #   :headerRow
@@ -43,16 +57,6 @@ module Axlsx
     # @return [Integer]
     attr_reader :dxfId
 
-    # creates a new TableStyleElement object
-    # @option options [Symbol] type
-    # @option options [Integer] size
-    # @option options [Integer] dxfId
-    def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-    end
-
     # @see type
     def type=(v) Axlsx::validate_table_element_type v; @type = v end
 
@@ -67,7 +71,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<tableStyleElement '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
 

data/lib/axlsx/stylesheet/table_styles.rb

@@ -4,13 +4,7 @@ module Axlsx
   # @note Support for custom table styles does not exist in this version. Many of the classes required are defined in preparation for future release. Please do not attempt to add custom table styles.
   class TableStyles < SimpleTypedList
 
-    # The default table style. The default value is 'TableStyleMedium9'
-    # @return [String]
-    attr_reader :defaultTableStyle
-
-    # The default pivot table style. The default value is  'PivotStyleLight6'
-    # @return [String]
-    attr_reader :defaultPivotStyle
+    include Axlsx::SerializedAttributes
 
     # Creates a new TableStyles object that is a container for TableStyle objects
     # @option options [String] defaultTableStyle
@@ -20,7 +14,18 @@ module Axlsx
       @defaultPivotStyle = options[:defaultPivotStyle] || "PivotStyleLight16"
       super TableStyle
     end
-    # @see defaultTableStyle
+
+    serializable_attributes :defaultTableStyle, :defaultPivotStyle
+
+    # The default table style. The default value is 'TableStyleMedium9'
+    # @return [String]
+    attr_reader :defaultTableStyle
+
+    # The default pivot table style. The default value is  'PivotStyleLight6'
+    # @return [String]
+    attr_reader :defaultPivotStyle
+
+   # @see defaultTableStyle
     def defaultTableStyle=(v) Axlsx::validate_string(v); @defaultTableStyle = v; end
     # @see defaultPivotStyle
     def defaultPivotStyle=(v) Axlsx::validate_string(v); @defaultPivotStyle = v; end
@@ -29,10 +34,8 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      attr = self.instance_values.reject {|k, v| ![:defaultTableStyle, :defaultPivotStyle].include?(k.to_sym) }
-      attr[:count] = self.size
       str << '<tableStyles '
-      str << attr.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str, {:count => self.size }
       str << '>'
       each { |table_style| table_style.to_xml_string(str) }
       str << '</tableStyles>'

data/lib/axlsx/stylesheet/xf.rb

@@ -5,6 +5,32 @@ module Axlsx
   class Xf
     #does not support extList (ExtensionList)
 
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    # Creates a new Xf object
+    # @option options [Integer] numFmtId
+    # @option options [Integer] fontId
+    # @option options [Integer] fillId
+    # @option options [Integer] borderId
+    # @option options [Integer] xfId
+    # @option options [Boolean] quotePrefix
+    # @option options [Boolean] pivotButton
+    # @option options [Boolean] applyNumberFormat
+    # @option options [Boolean] applyFont
+    # @option options [Boolean] applyFill
+    # @option options [Boolean] applyBorder
+    # @option options [Boolean] applyAlignment
+    # @option options [Boolean] applyProtection
+    # @option options [CellAlignment] alignment
+    # @option options [CellProtection] protection
+    def initialize(options={})
+      parse_options options
+    end
+
+    serializable_attributes :numFmtId, :fontId, :fillId, :borderId, :xfId, :quotePrefix,
+                            :pivotButton, :applyNumberFormat, :applyFont, :applyFill, :applyBorder, :applyAlignment,
+                            :applyProtection
+
     # The cell alignment for this style
     # @return [CellAlignment]
     # @see CellAlignment
@@ -67,30 +93,7 @@ module Axlsx
     # @return [Boolean]
     attr_reader :applyProtection
 
-    # Creates a new Xf object
-    # @option options [Integer] numFmtId
-    # @option options [Integer] fontId
-    # @option options [Integer] fillId
-    # @option options [Integer] borderId
-    # @option options [Integer] xfId
-    # @option options [Boolean] quotePrefix
-    # @option options [Boolean] pivotButton
-    # @option options [Boolean] applyNumberFormat
-    # @option options [Boolean] applyFont
-    # @option options [Boolean] applyFill
-    # @option options [Boolean] applyBorder
-    # @option options [Boolean] applyAlignment
-    # @option options [Boolean] applyProtection
-    # @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
-    end
-
-    # @see Xf#alignment
+      # @see Xf#alignment
     def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
 
     # @see protection
@@ -132,8 +135,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<xf '
-      h = instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}
-      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '>'
       alignment.to_xml_string(str) if self.alignment
       protection.to_xml_string(str) if self.protection

data/lib/axlsx/util/accessors.rb

@@ -0,0 +1,49 @@
+module Axlsx
+  # This module defines some of the more common validating attribute
+  # accessors that we use in Axlsx
+  #
+  # When this module is included in your class you can simply call
+  #
+  # string_attr_access :foo
+  #
+  # To generate a new, validating set of accessors for foo.
+  module Accessors
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # Defines the class level xxx_attr_accessor methods
+    module ClassMethods
+
+      # Creates one or more string validated attr_accessors
+      # @param [Array] symbols An array of symbols representing the
+      # names of the attributes you will add to your class.
+      def string_attr_accessor(*symbols)
+        validated_attr_accessor(symbols, 'validate_string')
+      end
+
+      # Creates on or more boolean validated attr_accessors
+      # @param [Array] symbols An array of symbols representing the
+      # names of the attributes you will add to your class.
+      def boolean_attr_accessor(*symbols)
+        validated_attr_accessor(symbols, 'validate_boolean')
+      end
+
+      # Template for defining validated write accessors
+      SETTER = "def %s=(value) Axlsx::%s(value); @%s = value; end"
+
+      # Creates the reader and writer access methods
+      # @param [Array] symbols The names of the attributes to create
+      # @param [String] validator The axlsx validation method to use when
+      # validating assignation.
+      # @see lib/axlsx/util/validators.rb 
+      def validated_attr_accessor(symbols, validator)
+        symbols.each do |symbol|
+          attr_reader symbol
+          module_eval(SETTER % [symbol.to_s, validator, symbol.to_s], __FILE__, __LINE__)
+        end
+      end
+    end
+  end
+end
+

data/lib/axlsx/util/options_parser.rb

@@ -0,0 +1,15 @@
+module Axlsx
+  # This module defines a single method for parsing options in class
+  # initializers.
+  module OptionsParser
+
+    # Parses an options hash by calling any defined method by the same
+    # name of the key postfixed with an '='
+    # @param [Hash] options Options to parse.
+    def parse_options(options={})
+      options.each do |key, value|
+        self.send("#{key}=", value) if self.respond_to?("#{key}=") && value != nil
+      end
+    end
+  end
+end

data/lib/axlsx/util/serialized_attributes.rb

@@ -0,0 +1,46 @@
+module Axlsx
+  # This module allows us to define a list of symbols defining which
+  # attributes will be serialized for a class.
+  module SerializedAttributes
+
+    # Extend with class methods
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # class methods applied to all includers
+    module ClassMethods
+
+      # This is the method to be used in inheriting classes to specify 
+      # which of the instance values are serializable
+      def serializable_attributes(*symbols)
+        @xml_attributes = symbols
+      end
+
+      # a reader for those attributes
+      def xml_attributes
+        @xml_attributes
+      end
+    end
+
+    # serializes the instance values of the defining object based on the 
+    # list of serializable attributes.
+    # @param [String] str The string instance to append this
+    # serialization to.
+    # @param [Hash] additional_attributes An option key value hash for
+    # defining values that are not serializable attributes list.
+    def serialized_attributes(str = '', additional_attributes = {})
+      key_value_pairs = instance_values
+      key_value_pairs.each do |key, value|
+        key_value_pairs.delete(key) if value == nil
+        key_value_pairs.delete(key) unless self.class.xml_attributes.include?(key.to_sym)
+      end
+      key_value_pairs.merge! additional_attributes
+
+      key_value_pairs.each do |key, value|
+        str << "#{Axlsx.camel(key, false)}=\"#{value}\" "
+      end
+      str
+    end
+  end
+end