axlsx 1.3.1 → 1.3.2

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

@@ -5,24 +5,50 @@ module Axlsx
   # @note The recommended way to manage data validations is via Worksheet#add_data_validation
   # @see Worksheet#add_data_validation
   class DataValidation
-    
+    include Axlsx::OptionsParser
+
+    # Creates a new {DataValidation} object
+    # @option options [String] formula1
+    # @option options [String] formula2
+    # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
+    # @option options [String] error - Message text of error alert.
+    # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
+    # @option options [String] errorTitle - itle bar text of error alert.
+    # @option options [Symbol] operator - The relational operator used with this data validation.
+    # @option options [String] prompt - Message text of input prompt.
+    # @option options [String] promptTitle - Title bar text of input prompt.
+    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
+    # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
+    # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
+    # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
+    # @option options [Symbol] type - The type of data validation.
+    def initialize(options={})
+      # defaults
+      @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
+      @allowBlank = @showErrorMessage = true
+      @showDropDown = @showInputMessage = false
+      @type = :none
+      @errorStyle = :stop
+      parse_options options
+    end
+
     # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:formula1, :formula2]
-    
+
     # Formula1
     # Available for type whole, decimal, date, time, textLength, list, custom
     # @see type
     # @return [String]
     # default nil
     attr_reader :formula1
-    
+
     # Formula2
     # Available for type whole, decimal, date, time, textLength
     # @see type
     # @return [String]
     # default nil
     attr_reader :formula2
-    
+
     # Allow Blank
     # A boolean value indicating whether the data validation allows the use of empty or blank
     # entries. 1 means empty entries are OK and do not violate the validation constraints.
@@ -31,7 +57,7 @@ module Axlsx
     # @return [Boolean]
     # default true
     attr_reader :allowBlank
-    
+
     # Error Message
     # Message text of error alert.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -39,7 +65,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :error
-    
+
     # Error Style (ST_DataValidationErrorStyle)
     # The style of error alert used for this data validation.
     # Options are:
@@ -51,7 +77,7 @@ module Axlsx
     # @return [Symbol]
     # default :stop
     attr_reader :errorStyle
-    
+
     # Error Title
     # Title bar text of error alert.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -59,7 +85,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :errorTitle
-    
+
     # Operator (ST_DataValidationOperator)
     # The relational operator used with this data validation.
     # Options are:
@@ -76,7 +102,7 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :operator
-    
+
     # Input prompt
     # Message text of input prompt.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -84,7 +110,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :prompt
-    
+
     # Prompt title
     # Title bar text of input prompt.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -92,7 +118,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :promptTitle
-    
+
     # Show drop down
     # A boolean value indicating whether to display a dropdown combo box for a list type data
     # validation. Be careful: false shows the dropdown list!
@@ -101,7 +127,7 @@ module Axlsx
     # @return [Boolean]
     # default false
     attr_reader :showDropDown
-    
+
     # Show error message
     # A boolean value indicating whether to display the error alert message when an invalid
     # value has been entered, according to the criteria specified.
@@ -110,7 +136,7 @@ module Axlsx
     # @return [Boolean]
     # default false
     attr_reader :showErrorMessage
-    
+
     # Show input message
     # A boolean value indicating whether to display the input prompt message.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -118,14 +144,14 @@ module Axlsx
     # @return [Boolean]
     # default false
     attr_reader :showInputMessage
-    
+
     # Range over which data validation is applied, in "A1:B2" format
     # Available for type whole, decimal, date, time, textLength, list, custom
     # @see type
     # @return [String]
     # default nil
     attr_reader :sqref
-    
+
     # The type (ST_DataValidationType) of data validation.
     # Options are:
     #  * custom: Data validation which uses a custom formula to check the cell value.
@@ -139,83 +165,56 @@ module Axlsx
     # @return [Symbol]
     # default none
     attr_reader :type
-    
-    # Creates a new {DataValidation} object
-    # @option options [String] formula1
-    # @option options [String] formula2
-    # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
-    # @option options [String] error - Message text of error alert.
-    # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
-    # @option options [String] errorTitle - itle bar text of error alert.
-    # @option options [Symbol] operator - The relational operator used with this data validation.
-    # @option options [String] prompt - Message text of input prompt.
-    # @option options [String] promptTitle - Title bar text of input prompt.
-    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
-    # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
-    # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
-    # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
-    # @option options [Symbol] type - The type of data validation.
-    def initialize(options={})
-      # defaults
-      @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
-      @allowBlank = @showErrorMessage = true
-      @showDropDown = @showInputMessage = false
-      @type = :none
-      @errorStyle = :stop
-      
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
+
+
     # @see formula1
     def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
-    
+
     # @see formula2
     def formula2=(v); Axlsx::validate_string(v); @formula2 = v end 
-    
+
     # @see allowBlank
     def allowBlank=(v); Axlsx::validate_boolean(v); @allowBlank = v end
-    
+
     # @see error
     def error=(v); Axlsx::validate_string(v); @error = v end
-    
+
     # @see errorStyle
     def errorStyle=(v); Axlsx::validate_data_validation_error_style(v); @errorStyle = v end
-    
+
     # @see errorTitle
     def errorTitle=(v); Axlsx::validate_string(v); @errorTitle = v end
-    
+
     # @see operator
     def operator=(v); Axlsx::validate_data_validation_operator(v); @operator = v end
-    
+
     # @see prompt
     def prompt=(v); Axlsx::validate_string(v); @prompt = v end
-    
+
     # @see promptTitle
     def promptTitle=(v); Axlsx::validate_string(v); @promptTitle = v end
-    
+
     # @see showDropDown
     def showDropDown=(v); Axlsx::validate_boolean(v); @showDropDown = v end
-    
+
     # @see showErrorMessage
     def showErrorMessage=(v); Axlsx::validate_boolean(v); @showErrorMessage = v end
-    
+
     # @see showInputMessage
     def showInputMessage=(v); Axlsx::validate_boolean(v); @showInputMessage = v end
-        
+
     # @see sqref
     def sqref=(v); Axlsx::validate_string(v); @sqref = v end
-    
+
     # @see type
     def type=(v); Axlsx::validate_data_validation_type(v); @type = v end
-    
+
     # Serializes the data validation
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       valid_attributes = get_valid_attributes
-      
+
       str << '<dataValidation '
       str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' if (valid_attributes.include?(key.to_sym) and not CHILD_ELEMENTS.include?(key.to_sym)) }.join(' ')
       str << '>'
@@ -223,11 +222,11 @@ module Axlsx
       str << '<formula2>' << self.formula2 << '</formula2>' if @formula2 and valid_attributes.include?(:formula2)
       str << '</dataValidation>'
     end
-    
+
   private
     def get_valid_attributes
       attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
-      
+
       if [:whole, :decimal, :data, :time, :textLength].include?(@type)
         attributes << [:operator, :formula1]
         attributes << [:formula2] if [:between, :notBetween].include?(@operator)
@@ -238,7 +237,7 @@ module Axlsx
       else
         attributes = []
       end
-      
+
       attributes.flatten!
     end
   end

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

@@ -17,7 +17,6 @@ module Axlsx
       @@default_last ||= 'AA200'
     end
 
-
     # Creates a new dimension object
     # @param[Worksheet] worksheet - the worksheet this dimension applies
     # to.

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

@@ -7,8 +7,24 @@ module Axlsx
   # @see ConditionalFormattingRule#initialize
   class IconSet
 
-    # instance values that must be serialized as their own elements - e.g. not attributes.
-    CHILD_ELEMENTS = [:value_objects]
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new icon set object
+    # @option options [String] iconSet
+    # @option options [Boolean] reverse
+    # @option options [Boolean] percent
+    # @option options [Boolean] showValue
+    def initialize(options = {})
+      @percent = @showValue = true
+      @reverse = false
+      @iconSet = "3TrafficLights1"
+      initialize_value_objects
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :iconSet, :percent, :reverse, :showValue
 
     # The icon set to display.
     # Allowed values are: 3Arrows, 3ArrowsGray, 3Flags, 3TrafficLights1, 3TrafficLights2, 3Signs, 3Symbols, 3Symbols2, 4Arrows, 4ArrowsGray, 4RedToBlack, 4Rating, 4TrafficLights, 5Arrows, 5ArrowsGray, 5Rating, 5Quarters
@@ -31,23 +47,7 @@ module Axlsx
     # @return [Boolean]
     attr_reader :showValue
 
-    # Creates a new icon set object
-    # @option options [String] iconSet
-    # @option options [Boolean] reverse
-    # @option options [Boolean] percent
-    # @option options [Boolean] showValue
-    def initialize(options = {})
-      @percent = @showValue = true
-      @reverse = false
-      @iconSet = "3TrafficLights1"
-      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?
-    end
-
-    # @see iconSet
+      # @see iconSet
     def iconSet=(v); Axlsx::validate_icon_set(v); @iconSet = v end
 
     # @see showValue
@@ -64,7 +64,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str="")
       str << '<iconSet '
-      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) }
       str << '</iconSet>'

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

@@ -10,6 +10,26 @@ module Axlsx
   # @see Worksheet#initialize
   class PageMargins
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new PageMargins object
+    # @option options [Numeric] left The left margin in inches
+    # @option options [Numeric] right The right margin in inches
+    # @option options [Numeric] bottom The bottom margin in inches
+    # @option options [Numeric] top The top margin in inches
+    # @option options [Numeric] header The header margin in inches
+    # @option options [Numeric] footer The footer margin in inches
+    def initialize(options={})
+      # Default values taken from MS Excel for Mac 2011
+      @left = @right = DEFAULT_LEFT_RIGHT
+      @top = @bottom = DEFAULT_TOP_BOTTOM
+      @header = @footer = DEFAULT_HEADER_FOOTER
+      parse_options options
+    end
+
+    serializable_attributes :left, :right, :bottom, :top, :header, :footer
+
     # Default left and right margin (in inches)
     DEFAULT_LEFT_RIGHT = 0.75
 
@@ -43,24 +63,6 @@ module Axlsx
     # @return [Float]
     attr_reader :footer
 
-    # Creates a new PageMargins object
-    # @option options [Numeric] left The left margin in inches
-    # @option options [Numeric] right The right margin in inches
-    # @option options [Numeric] bottom The bottom margin in inches
-    # @option options [Numeric] top The top margin in inches
-    # @option options [Numeric] header The header margin in inches
-    # @option options [Numeric] footer The footer margin in inches
-    def initialize(options={})
-      # Default values taken from MS Excel for Mac 2011
-      @left = @right = DEFAULT_LEFT_RIGHT
-      @top = @bottom = DEFAULT_TOP_BOTTOM
-      @header = @footer = DEFAULT_HEADER_FOOTER
-
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # Set some or all margins at once.
     # @param [Hash] margins the margins to set (possible keys are :left, :right, :top, :bottom, :header and :footer).
     def set(margins)
@@ -90,7 +92,7 @@ module Axlsx
     # @see #custom_margins_specified?
     def to_xml_string(str = '')
       str << '<pageMargins '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
   end

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

@@ -4,16 +4,19 @@ module Axlsx
   # This class name is not a typo, its spec.
   class PageSetUpPr
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
     # creates a new page setup properties object
     # @param [Hash] options
     # @option [Boolean] auto_page_breaks Flag indicating whether the sheet displays Automatic Page Breaks.
     # @option [Boolean] fit_to_page Flag indicating whether the Fit to Page print option is enabled.
     def initialize(options = {})
-      options.each do |key, value|
-        self.send("#{key}=",value) if self.respond_to?("#{key}=")
-      end
+      parse_options options
     end
 
+    serializable_attributes :auto_page_breaks, :fit_to_page
+
     attr_reader :auto_page_breaks
     attr_reader :fit_to_page
 
@@ -37,11 +40,5 @@ module Axlsx
     def to_xml_string(str='')
       str << '<pageSetUpPr ' << serialized_attributes << '/>'
     end
-
-    private
-
-    def serialized_attributes
-      instance_values.map { |key, value| "#{Axlsx.camel(key, false)}='#{value}'" }.join(' ')
-    end
   end
 end

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

@@ -6,8 +6,24 @@ module Axlsx
   # @see Worksheet#initialize
   class PageSetup
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new PageSetup object
+    # @option options [Integer] fit_to_height Number of vertical pages to fit on
+    # @option options [Integer] fit_to_width Number of horizontal pages to fit on
+    # @option options [Symbol] orientation Orientation of the page (:default, :landscape, :portrait)
+    # @option options [String] paper_height Height of paper (number followed by unit identifier: "297mm", "11in")
+    # @option options [String] paper_width Width of paper (number followed by unit identifier: "210mm", "8.5in")
+    # @option options [Integer] scale Print scaling (percent value, integer ranging from 10 to 400)
+    # @option options [Integer] paper_size - the size of paper to use
+    def initialize(options = {})
+       parse_options options
+    end
+
+    serializable_attributes :fit_to_height, :fit_to_width, :orientation, :paper_height, :paper_width, :scale, :paper_size
+
     # TODO: Attributes defined by Open XML spec that are not implemented yet:
-    # 
     # * blackAndWhite
     # * cellComments
     # * copies
@@ -16,7 +32,6 @@ module Axlsx
     # * firstPageNumber
     # * horizontalDpi
     # * pageOrder
-    # * paperSize
     # * useFirstPageNumber
     # * usePrinterDefaults
     # * verticalDpi
@@ -176,24 +191,10 @@ module Axlsx
       @paper_size = size
     end
 
-    # Creates a new PageSetup object
-    # @option options [Integer] fit_to_height Number of vertical pages to fit on
-    # @option options [Integer] fit_to_width Number of horizontal pages to fit on
-    # @option options [Symbol] orientation Orientation of the page (:default, :landscape, :portrait)
-    # @option options [String] paper_height Height of paper (number followed by unit identifier: "297mm", "11in")
-    # @option options [String] paper_width Width of paper (number followed by unit identifier: "210mm", "8.5in")
-    # @option options [Integer] scale Print scaling (percent value, integer ranging from 10 to 400)
-    # @option options [Integer] paper_size - the size of paper to use
-    def initialize(options = {})
-      set(options)
-    end
-
-    # Set some or all page settings at once.
+     # Set some or all page settings at once.
     # @param [Hash] options The page settings to set (possible keys are :fit_to_height, :fit_to_width, :orientation, :paper_height, :paper_width, and :scale).
     def set(options)
-      options.each do |k, v|
-        send("#{k}=", v) if respond_to? "#{k}="
-      end
+      parse_options options
     end
 
     # @see fit_to_height
@@ -234,7 +235,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<pageSetup '
-      str << instance_values.reject{ |k, v| k == 'worksheet' }.map{ |k,v| k.gsub(/_(.)/){ $1.upcase } << %{="#{v}"} }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
   end