axlsx 1.3.1 → 1.3.2

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

@@ -8,35 +8,36 @@ module Axlsx
   #
   class Cfvo
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new Cfvo object
+    # @option options [Symbol] type The type of conditional formatting value object
+    # @option options [Boolean]  gte threshold value usage indicator
+    # @option options [String] val The value of the conditional formatting object
+    def initialize(options={})
+      @gte = true
+      parse_options options
+    end
+
+    serializable_attributes :type, :gte, :val
+
     # Type (ST_CfvoType)
     # The type of this conditional formatting value object. options are num, percent, max, min, formula and percentile
     # @return [Symbol]
     attr_reader :type
 
-
     # Type (xsd:boolean)
     # For icon sets, determines whether this threshold value uses the greater than or equal to operator. 0 indicates 'greater than' is used instead of 'greater than or equal to'.
     # The default value is true
     # @return [Boolean]
     attr_reader :gte
 
-
     # Type (ST_Xstring)
     # The value of the conditional formatting object
     # This library will accept any value so long as it supports to_s
     attr_reader :val
 
-    # Creates a new Cfvo object
-    # @option options [Symbol] type The type of conditional formatting value object
-    # @option options [Boolean]  gte threshold value usage indicator
-    # @option options [String] val The value of the conditional formatting object
-    def initialize(options={})
-      @gte = true
-      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_conditional_formatting_value_object_type(v); @type = v end
 
@@ -54,9 +55,8 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<cfvo '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << ' />'
     end
-
   end
 end

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

@@ -0,0 +1,18 @@
+module Axlsx
+
+  #A collection of Cfvo objects that initializes with the required
+  #first two items
+  class Cfvos < SimpleTypedList
+
+    def initialize
+      super(Cfvo)
+      @list << Cfvo.new(:type => :min, :val => 0)
+      @list << Cfvo.new(:type => :max, :val => 0)
+      lock
+    end
+
+    def to_xml_string(str='')
+      @list.each { |cfvo| cfvo.to_xml_string(str) }
+    end
+  end
+end

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

@@ -4,6 +4,27 @@ module Axlsx
   # The Col class defines column attributes for columns in sheets.
   class Col
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    # Create a new Col objects
+    # @param min First column affected by this 'column info' record.
+    # @param max Last column affected by this 'column info' record.
+    # @option options [Boolean] collapsed see Col#collapsed
+    # @option options [Boolean] hidden see Col#hidden
+    # @option options [Boolean] outlineLevel see Col#outlineLevel
+    # @option options [Boolean] phonetic see Col#phonetic
+    # @option options [Integer] style see Col#style
+    # @option options [Numeric] width see Col#width
+    def initialize(min, max, options={})
+      Axlsx.validate_unsigned_int(max)
+      Axlsx.validate_unsigned_int(min)
+      @min = min
+      @max = max
+      parse_options options
+    end
+
+    serializable_attributes :collapsed, :hidden, :outline_level, :phonetic, :style, :width, :min, :max, :best_fit, :custom_width
+
     # First column affected by this 'column info' record.
     # @return [Integer]
     attr_reader :min
@@ -17,7 +38,8 @@ module Axlsx
     # 'Best fit' means that when numbers are typed into a cell contained in a 'best fit' column, the column width should
     #  automatically resize to display the number. [Note: In best fit cases, column width must not be made smaller, only larger. end note]
     # @return [Boolean]
-    attr_reader :bestFit
+    attr_reader :best_fit
+    alias :bestFit :best_fit
 
     # Flag indicating if the outlining of the affected column(s) is in the collapsed state.
     # @return [Boolean]
@@ -29,7 +51,8 @@ module Axlsx
 
     # Outline level of affected column(s). Range is 0 to 7.
     # @return [Integer]
-    attr_reader :outlineLevel
+    attr_reader :outline_level
+    alias :outlineLevel :outline_level
 
     # Flag indicating if the phonetic information should be displayed by default for the affected column(s) of the worksheet.
     # @return [Boolean]
@@ -44,7 +67,8 @@ module Axlsx
     attr_reader :width
 
     # @return [Boolean]
-    attr_reader :customWidth
+    attr_reader :custom_width
+    alias :customWidth :custom_width
 
     # @see Col#collapsed
     def collapsed=(v)
@@ -59,11 +83,12 @@ module Axlsx
     end
 
     # @see Col#outline
-    def outlineLevel=(v)
+    def outline_level=(v)
       Axlsx.validate_unsigned_numeric(v)
       raise ArgumentError, 'outlineLevel must be between 0 and 7' unless 0 <= v && v <= 7
-      @outlineLevel = v
+      @outline_level = v
     end
+    alias :outlineLevel= :outline_level=
 
     # @see Col#phonetic
     def phonetic=(v)
@@ -80,29 +105,10 @@ module Axlsx
    # @see Col#width
     def width=(v)
       Axlsx.validate_unsigned_numeric(v) unless v == nil
-      @customWidth = @bestFit = v != nil
+      @custom_width = @best_fit = v != nil
       @width = v
     end
 
-    # Create a new Col objects
-    # @param min First column affected by this 'column info' record.
-    # @param max Last column affected by this 'column info' record.
-    # @option options [Boolean] collapsed see Col#collapsed
-    # @option options [Boolean] hidden see Col#hidden
-    # @option options [Boolean] outlineLevel see Col#outlineLevel
-    # @option options [Boolean] phonetic see Col#phonetic
-    # @option options [Integer] style see Col#style
-    # @option options [Numeric] width see Col#width
-    def initialize(min, max, options={})
-      Axlsx.validate_unsigned_int(max)
-      Axlsx.validate_unsigned_int(min)
-      @min = min
-      @max = max
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
     # updates the width for this col based on the cells autowidth and 
     # an optionally specified fixed width
     # @param [Cell] cell The cell to use in updating this col's width
@@ -122,8 +128,9 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      attrs = self.instance_values.reject{ |key, value| value == nil }
-      str << '<col ' << attrs.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ') << '/>'
+      str << '<col '
+      serialized_attributes str
+      str << '/>'
     end
 
   end

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

@@ -10,7 +10,9 @@ module Axlsx
     # A simple typed list of cfvos
     # @return [SimpleTypedList]
     # @see Cfvo
-    attr_reader :value_objects
+    def value_objects
+      @value_objects ||= Cfvos.new
+    end
 
     # A simple types list of colors
     # @return [SimpleTypedList]
@@ -23,7 +25,6 @@ module Axlsx
     # @see Cfvo
     # @see Color
     def initialize
-      initialize_value_objects
       initialize_colors
       yield self if block_given?
     end
@@ -32,9 +33,9 @@ module Axlsx
     # a reference to the newly created cfvo and color objects so you can alter the default properties.
     # @return [Hash] a hash with :cfvo and :color keys referencing the newly added objects.
     def add(options={})
-      @value_objects << Cfvo.new(:type => options[:type] || :min, :val => options[:val] || 0)
+      value_objects << Cfvo.new(:type => options[:type] || :min, :val => options[:val] || 0)
       @colors << Color.new(:rgb => options[:color] || "FF000000")
-      {:cfvo => @value_objects.last, :color => @colors.last}
+      {:cfvo => value_objects.last, :color => @colors.last}
     end
 
 
@@ -42,7 +43,7 @@ module Axlsx
     # @param [Integer] index The index of the cfvo and color object to delete
     # @note you cannot remove the first two cfvo and color pairs
     def delete_at(index=2)
-      @value_objects.delete_at index
+      value_objects.delete_at index
       @colors.delete_at index
     end
 
@@ -51,20 +52,13 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<colorScale>'
-      @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
+      value_objects.to_xml_string(str)
       @colors.each { |color| color.to_xml_string(str) }
       str << '</colorScale>'
     end
 
     private
 
-    # creates the initial cfvo objects
-    def initialize_value_objects
-      @value_objects = SimpleTypedList.new Cfvo
-      @value_objects.concat [Cfvo.new(:type => :min, :val => 0), Cfvo.new(:type => :max, :val => 0)]
-      @value_objects.lock
-    end
-
     # creates the initial color objects
     def initialize_colors
       @colors = SimpleTypedList.new Color

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

@@ -3,6 +3,20 @@ module Axlsx
   # A comment is the text data for a comment
   class Comment
 
+    include Axlsx::OptionsParser
+
+    # Creates a new comment object
+    # @param [Comments] comments
+    # @param [Hash] options
+    # @option [String] author the author of the comment
+    # @option [String] text The text for the comment
+    def initialize(comments, options={})
+      raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
+      @comments = comments
+      parse_options options
+      yield self if block_given?
+    end
+
     # The text to render
     # @return [String]
     attr_reader :text
@@ -26,22 +40,12 @@ module Axlsx
     # rPh (Phonetic Text Run)
     # phoneticPr (Phonetic Properties)
 
-    def initialize(comments, options={})
-      raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
-      @comments = comments
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      yield self if block_given?
-    end
-
     # The vml shape that will render this comment
     # @return [VmlShape]
     def vml_shape
       @vml_shape ||= initialize_vml_shape
     end
 
-    #
     # The index of this author in a unique sorted list of all authors in
     # the comment.
     # @return [Integer]
@@ -96,6 +100,5 @@ module Axlsx
          vml.bottom_row = vml.row + 4
       end
     end
-
   end
 end

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

@@ -6,6 +6,16 @@ module Axlsx
   # @see ConditionalFormattingRule
   class ConditionalFormatting
 
+   include Axlsx::OptionsParser
+   
+    # Creates a new {ConditionalFormatting} object
+    # @option options [Array] rules The rules to apply
+    # @option options [String] sqref The range to apply the rules to
+    def initialize(options={})
+      @rules = []
+      parse_options options
+    end
+
     # Range over which the formatting is applied, in "A1:B2" format
     # @return [String]
     attr_reader :sqref
@@ -18,17 +28,7 @@ module Axlsx
     # @return [Array]
     attr_reader :rules
 
-    # Creates a new {ConditionalFormatting} object
-    # @option options [Array] rules The rules to apply
-    # @option options [String] sqref The range to apply the rules to
-    def initialize(options={})
-      @rules = []
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
-    # Add Conditional Formatting Rules to this object. Rules can either
+     # Add Conditional Formatting Rules to this object. Rules can either
     # be already created {ConditionalFormattingRule} elements or
     # hashes of options for automatic creation.  If rules is a hash
     # instead of an array, assume only one rule being added.

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

@@ -8,8 +8,32 @@ module Axlsx
   # @see ConditionalFormattingRule#initialize
   class ConditionalFormattingRule
 
-    # instance values that must be serialized as their own elements - e.g. not attributes.
-    CHILD_ELEMENTS = [:formula, :color_scale, :data_bar, :icon_set]
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new Conditional Formatting Rule object
+    # @option options [Symbol] type The type of this formatting rule
+    # @option options [Boolean] aboveAverage This is an aboveAverage rule
+    # @option options [Boolean] bottom This is a bottom N rule.
+    # @option options [Integer] dxfId The formatting id to apply to matches
+    # @option options [Boolean] equalAverage Is the aboveAverage or belowAverage rule inclusive
+    # @option options [Integer] priority The priority of the rule, 1 is highest
+    # @option options [Symbol] operator Which operator to apply
+    # @option options [String] text The value to apply a text operator against
+    # @option options [Boolean] percent If a top/bottom N rule, evaluate as N% rather than N
+    # @option options [Integer] rank If a top/bottom N rule, the value of N
+    # @option options [Integer] stdDev The number of standard deviations above or below the average to match
+    # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
+    # @option options [Symbol]  timePeriod The time period in a date occuring... rule
+    # @option options [String] formula The formula to match against in i.e. an equal rule
+    def initialize(options={})
+      @color_scale = @data_bar = @icon_set = @formula = nil
+      parse_options options
+    end
+
+    serializable_attributes :type, :aboveAverage, :bottom, :dxfId, :equalAverage,
+                            :priority, :operator, :text, :percent, :rank, :stdDev,
+                            :stopIfTrue, :timePeriod
 
     # Formula
     # @return [String]
@@ -129,28 +153,6 @@ module Axlsx
       @icon_set ||= IconSet.new
     end
 
-    # Creates a new Conditional Formatting Rule object
-    # @option options [Symbol] type The type of this formatting rule
-    # @option options [Boolean] aboveAverage This is an aboveAverage rule
-    # @option options [Boolean] bottom This is a bottom N rule.
-    # @option options [Integer] dxfId The formatting id to apply to matches
-    # @option options [Boolean] equalAverage Is the aboveAverage or belowAverage rule inclusive
-    # @option options [Integer] priority The priority of the rule, 1 is highest
-    # @option options [Symbol] operator Which operator to apply
-    # @option options [String] text The value to apply a text operator against
-    # @option options [Boolean] percent If a top/bottom N rule, evaluate as N% rather than N
-    # @option options [Integer] rank If a top/bottom N rule, the value of N
-    # @option options [Integer] stdDev The number of standard deviations above or below the average to match
-    # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
-    # @option options [Symbol]  timePeriod The time period in a date occuring... rule
-    # @option options [String] formula The formula to match against in i.e. an equal rule
-    def initialize(options={})
-      @color_scale = @data_bar = @icon_set = @formula = nil
-      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_conditional_formatting_type(v); @type = v end
     # @see aboveAverage
@@ -204,7 +206,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<cfRule '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' unless CHILD_ELEMENTS.include?(key.to_sym) }.join(' ')
+      serialized_attributes str
       str << '>'
       str << '<formula>' << self.formula << '</formula>' if @formula
       @color_scale.to_xml_string(str) if @color_scale && @type == :colorScale

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

@@ -7,6 +7,24 @@ module Axlsx
   # @see ConditionalFormattingRule#initialize
   class DataBar
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new data bar conditional formatting object
+    # @option options [Integer] minLength
+    # @option options [Integer] maxLength
+    # @option options [Boolean] showValue
+    # @option options [String] color - the rbg value used to color the bars
+    def initialize(options = {})
+      @min_length = 10
+      @max_length = 90
+      @show_value = true
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :min_length, :max_length, :show_value
+
     # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:value_objects, :color]
 
@@ -14,24 +32,29 @@ module Axlsx
     # The minimum length of the data bar, as a percentage of the cell width.
     # The default value is 10
     # @return [Integer]
-    attr_reader :minLength
+    attr_reader :min_length
+    alias :minLength :min_length
 
     # maxLength attribute
     # The maximum length of the data bar, as a percentage of the cell width.
     # The default value is 90
     # @return [Integer]
-    attr_reader :maxLength
+    attr_reader :max_length
+    alias :maxLength :max_length
 
     # maxLength attribute
     # Indicates whether to show the values of the cells on which this data bar is applied.
     # The default value is true
     # @return [Boolean]
-    attr_reader :showValue
+    attr_reader :show_value
+    alias :showValue :show_value
 
     # A simple typed list of cfvos
     # @return [SimpleTypedList]
     # @see Cfvo
-    attr_reader :value_objects
+    def value_objects
+      @value_objects ||= Cfvos.new
+    end
 
     # color
     # the color object used in the data bar formatting
@@ -40,29 +63,26 @@ module Axlsx
       @color ||= Color.new :rgb => "FF0000FF"
     end
 
-    # Creates a new data bar conditional formatting object
-    # @option options [Integer] minLength
-    # @option options [Integer] maxLength
-    # @option options [Boolean] showValue
-    # @option options [String] color - the rbg value used to color the bars
-    def initialize(options = {})
-      @minLength = 10
-      @maxLength = 90
-      @showValue = true
-      initialize_value_objects
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      yield self if block_given?
+    # @see minLength
+    def min_length=(v)
+      Axlsx.validate_unsigned_int(v)
+      @min_length = v
     end
+    alias :minLength= :min_length=
 
-    # @see minLength
-    def minLength=(v); Axlsx.validate_unsigned_int(v); @minLength = v end
     # @see maxLength
-    def maxLength=(v); Axlsx.validate_unsigned_int(v); @maxLength = v end
+    def max_length=(v)
+      Axlsx.validate_unsigned_int(v)
+      @max_length = v
+    end
+    alias :maxLength= :max_length=
 
     # @see showValue
-    def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
+    def show_value=(v)
+      Axlsx.validate_boolean(v)
+      @show_value = v
+    end
+    alias :showValue= :show_value=
 
     # Sets the color for the data bars.
     # @param [Color|String] v The color object, or rgb string value to apply
@@ -77,21 +97,11 @@ module Axlsx
     # @return [String]
     def to_xml_string(str="")
       str << '<dataBar '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' unless CHILD_ELEMENTS.include?(key.to_sym) }.join(' ')
+      serialized_attributes str
       str << '>'
-      @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
+      value_objects.to_xml_string(str)
       self.color.to_xml_string(str)
       str << '</dataBar>'
     end
-
-    private
-
-    # Initalize the simple typed list of value objects
-    # I am keeping this private for now as I am not sure what impact changes to the required two cfvo objects will do.
-    def initialize_value_objects
-      @value_objects = SimpleTypedList.new Cfvo
-      @value_objects.concat [Cfvo.new(:type => :min, :val => 0), Cfvo.new(:type => :max, :val => 0)]
-      @value_objects.lock
-    end
   end
 end