axlsx 1.3.1 → 1.3.2

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

@@ -1,11 +1,27 @@
-# encoding: UTF-8
 module Axlsx
   # Pane options for a worksheet.
   #
   # @note The recommended way to manage the pane options is via SheetView#pane
   # @see SheetView#pane
   class Pane
-    
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    # Creates a new {Pane} object
+    # @option options [Symbol] active_pane Active Pane
+    # @option options [Symbol] state Split State
+    # @option options [Cell, String] top_left_cell Top Left Visible Cell
+    # @option options [Integer] x_split Horizontal Split Position
+    # @option options [Integer] y_split Vertical Split Position
+    def initialize(options={})
+      #defaults
+      @active_pane = @state = @top_left_cell = nil
+      @x_split = @y_split = 0
+      parse_options options
+    end
+
+    serializable_attributes :active_pane, :state, :top_left_cell, :x_split, :y_split
+
     # Active Pane
     # The pane that is active.
     # Options are 
@@ -32,8 +48,8 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :active_pane
-    
-    
+
+
     # Split State
     # Indicates whether the pane has horizontal / vertical 
     # splits, and whether those splits are frozen.
@@ -51,8 +67,7 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :state
-    
-    
+
     # Top Left Visible Cell
     # Location of the top left visible cell in the bottom 
     # right pane (when in Left-To-Right mode).
@@ -60,8 +75,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :top_left_cell
-    
-    
+
     # Horizontal Split Position
     # Horizontal position of the split, in 1/20th of a point; 0 (zero)
     # if none. If the pane is frozen, this value indicates the number 
@@ -70,8 +84,7 @@ module Axlsx
     # @return [Integer]
     # default 0
     attr_reader :x_split
-    
-    
+
     # Vertical Split Position
     # Vertical position of the split, in 1/20th of a point; 0 (zero) 
     # if none. If the pane is frozen, this value indicates the number
@@ -80,65 +93,49 @@ module Axlsx
     # @return [Integer]
     # default 0
     attr_reader :y_split
-    
-    
-    # Creates a new {Pane} object
-    # @option options [Symbol] active_pane Active Pane
-    # @option options [Symbol] state Split State
-    # @option options [Cell, String] top_left_cell Top Left Visible Cell
-    # @option options [Integer] x_split Horizontal Split Position
-    # @option options [Integer] y_split Vertical Split Position
-    def initialize(options={})
-      #defaults
-      @active_pane = @state = @top_left_cell = nil
-      @x_split = @y_split = 0
-      
-      # write options to instance variables
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
-    
+
     # @see active_pane
-    def active_pane=(v); Axlsx::validate_pane_type(v); @active_pane = v end
-    
-    
+    def active_pane=(v)
+      Axlsx::validate_pane_type(v)
+      @active_pane = Axlsx::camel(v.to_s, false)
+    end
+
     # @see state
-    def state=(v); Axlsx::validate_split_state_type(v); @state = v end
-    
-    
+    def state=(v)
+      Axlsx::validate_split_state_type(v)
+      @state = Axlsx::camel(v.to_s, false)
+    end
+
     # @see top_left_cell
     def top_left_cell=(v)
       cell = (v.class == Axlsx::Cell ? v.r_abs : v)
-      Axlsx::validate_string(cell)  
-      @top_left_cell = cell 
+      Axlsx::validate_string(cell)
+      @top_left_cell = cell
     end
-    
-    
+
     # @see x_split
     def x_split=(v); Axlsx::validate_unsigned_int(v); @x_split = v end
-    
-    
+
     # @see y_split
     def y_split=(v); Axlsx::validate_unsigned_int(v); @y_split = v end
-    
-    
+
     # Serializes the data validation
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      if @state == :frozen && @top_left_cell.nil?
+      finalize
+      str << '<pane '
+      serialized_attributes str
+      str << '/>'
+    end
+    private
+
+    def finalize
+      if @state == 'frozen' && @top_left_cell.nil?
         row = @y_split || 0
         column = @x_split || 0
-        
         @top_left_cell = "#{('A'..'ZZ').to_a[column]}#{row+1}"
       end
-      
-      str << '<pane '
-      str << instance_values.map { |key, value| '' << key.gsub(/_(.)/){ $1.upcase } << 
-        %{="#{[:active_pane, :state].include?(key.to_sym) ? value.to_s.gsub(/_(.)/){ $1.upcase } : value}"} unless value.nil? }.join(' ')
-      str << '/>'
     end
   end
 end

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

@@ -6,22 +6,9 @@ module Axlsx
   # @see Worksheet#initialize
   class PrintOptions
 
-    # Whether grid lines should be printed.
-    # @return [Boolean]
-    attr_reader :grid_lines
-
-    # Whether row and column headings should be printed.
-    # @return [Boolean]
-    attr_reader :headings
-
-    # Whether the content should be centered horizontally on the page.
-    # @return [Boolean]
-    attr_reader :horizontal_centered
-
-    # Whether the content should be centered vertically on the page.
-    # @return [Boolean]
-    attr_reader :vertical_centered
-
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
     # Creates a new PrintOptions object
     # @option options [Boolean] grid_lines Whether grid lines should be printed
     # @option options [Boolean] headings Whether row and column headings should be printed
@@ -32,31 +19,22 @@ module Axlsx
       set(options)
     end
 
+    serializable_attributes :grid_lines, :headings, :horizontal_centered, :vertical_centered
+    boolean_attr_accessor :grid_lines, :headings, :horizontal_centered, :vertical_centered
+
     # Set some or all options at once.
     # @param [Hash] options The options to set (possible keys are :grid_lines, :headings, :horizontal_centered, and :vertical_centered).
     def set(options)
-      options.each do |k, v|
-        send("#{k}=", v) if respond_to? "#{k}="
-      end
+      parse_options options
     end
 
-    # @see grid_lines
-    def grid_lines=(v); Axlsx::validate_boolean(v); @grid_lines = v; end
-    # @see headings
-    def headings=(v); Axlsx::validate_boolean(v); @headings = v; end
-    # @see horizontal_centered
-    def horizontal_centered=(v); Axlsx::validate_boolean(v); @horizontal_centered = v; end
-    # @see vertical_centered
-    def vertical_centered=(v); Axlsx::validate_boolean(v); @vertical_centered = v; end
-
     # Serializes the page options element.
     # @note As all attributes default to "false" according to the xml schema definition, the generated xml includes only those attributes that are set to true.
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<printOptions '
-      # 
-      str << instance_values.select{ |k,v| v == true }.map{ |k,v| k.gsub(/_(.)/){ $1.upcase } << %{="#{v}"} }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
   end

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

@@ -4,6 +4,18 @@ module Axlsx
   # @see Worksheet#protect_range
   class ProtectedRange
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+   # Initializes a new protected range object
+    # @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
+    # @option [String] name An optional name for the protected name.
+    def initialize(options={})
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :sqref, :name
     # The reference for the protected range
     # @return [String]
     attr_reader :sqref
@@ -12,16 +24,6 @@ module Axlsx
     # @return [String]
     attr_reader :name
 
-    # Initializes a new protected range object
-    # @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
-    # @option [String] name An optional name for the protected name.
-    def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      yield self if block_given?
-    end
-    
     # @see sqref
     def sqref=(v)
       Axlsx.validate_string(v)
@@ -33,14 +35,15 @@ module Axlsx
       Axlsx.validate_string(v)
       @name = v
     end
-   
+
     # serializes the proteted range
     # @param [String] str if this string object is provided we append
     # our output to that object. Use this - it helps limit the number of
     # objects created during serialization
     def to_xml_string(str="")
-      attrs = self.instance_values.reject{ |key, value| value == nil }
-      str << '<protectedRange ' << attrs.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ') << '/>'
+      str << '<protectedRange '
+      serialized_attributes str
+      str << '/>'
     end 
   end
 end

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

@@ -5,15 +5,28 @@ module Axlsx
   # @note The recommended way to manage the selection pane options is via SheetView#add_selection
   # @see SheetView#add_selection
   class Selection
-    
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new {Selection} object
+    # @option options [Cell, String] active_cell Active Cell Location
+    # @option options [Integer] active_cell_id Active Cell Index
+    # @option options [Symbol] pane Pane
+    # @option options [String] sqref Sequence of References
+    def initialize(options={})
+      @active_cell = @active_cell_id = @pane = @sqref = nil
+      parse_options options
+    end
+
+    serializable_attributes :active_cell, :active_cell_id, :pane, :sqref
     # Active Cell Location
     # Location of the active cell.
     # @see type
     # @return [String]
     # default nil
     attr_reader :active_cell
-    
-    
+
     # Active Cell Index
     # 0-based index of the range reference (in the array of references listed in sqref)
     # containing the active cell. Only used when the selection in sqref is not contiguous.
@@ -24,8 +37,7 @@ module Axlsx
     # @return [Integer]
     # default nil
     attr_reader :active_cell_id
-    
-    
+
     # Pane
     # The pane to which this selection belongs.
     # Options are 
@@ -52,59 +64,39 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :pane
-    
-    
+
     # Sequence of References
     # Range of the selection. Can be non-contiguous set of ranges.
     # @see type
     # @return [String]
     # default nil
     attr_reader :sqref
-    
-    
-    # Creates a new {Selection} object
-    # @option options [Cell, String] active_cell Active Cell Location
-    # @option options [Integer] active_cell_id Active Cell Index
-    # @option options [Symbol] pane Pane
-    # @option options [String] sqref Sequence of References
-    def initialize(options={})
-      #defaults
-      @active_cell = @active_cell_id = @pane = @sqref = nil
-      
-      # write options to instance variables
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
-    
+
     # @see active_cell
     def active_cell=(v)
       cell = (v.class == Axlsx::Cell ? v.r_abs : v)
-      Axlsx::validate_string(cell)  
-      @active_cell = cell 
+      Axlsx::validate_string(cell)
+      @active_cell = cell
     end
-    
-    
+
     # @see active_cell_id
     def active_cell_id=(v); Axlsx::validate_unsigned_int(v); @active_cell_id = v end
-    
-    
+
     # @see pane
-    def pane=(v); Axlsx::validate_pane_type(v); @pane = v end
-    
-    
+    def pane=(v)
+      Axlsx::validate_pane_type(v)
+      @pane = Axlsx::camel(v, false)
+    end
+
     # @see sqref
     def sqref=(v); Axlsx::validate_string(v); @sqref = v end
-    
-    
+
     # Serializes the data validation
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<selection '
-      str << instance_values.map { |key, value| '' << key.gsub(/_(.)/){ $1.upcase } << 
-        %{="#{[:pane].include?(key.to_sym) ? value.to_s.gsub(/_(.)/){ $1.upcase } : value}"} unless value.nil? }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
   end

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

@@ -3,33 +3,20 @@ module Axlsx
   # the SheetCalcPr object for the worksheet
   # This object contains calculation properties for the worksheet.
   class SheetCalcPr
-
+   include Axlsx::OptionsParser
+   include Axlsx::SerializedAttributes
+   include Axlsx::Accessors
     # creates a new SheetCalcPr
     # @param [Hash] options Options for this object
     # @option [Boolean] full_calc_on_load @see full_calc_on_load
     def initialize(options={})
       @full_calc_on_load = true
-      options.each do |key, value|
-        self.send("#{key}=", value) if self.respond_to?("#{key}=")
-      end
+      parse_options options
     end
 
-    # Indicates whether the application should do a full calculate on
-    # load due to contents on this sheet. After load and successful cal,c
-    # the application shall set this value to false. Set this to true
-    # when the application should calculate the workbook on load.
-    # @return [Boolean]
-    def full_calc_on_load
-      @full_calc_on_load
-    end
+    boolean_attr_accessor :full_calc_on_load
 
-    # specify the full_calc_on_load value
-    # @param [Boolean] value
-    # @see full_calc_on_load
-    def full_calc_on_load=(value)
-      Axlsx.validate_boolean(value)
-      @full_calc_on_load = value
-    end
+    serializable_attributes :full_calc_on_load
 
     # Serialize the object
     # @param [String] str the string to append this objects serialized
@@ -38,12 +25,5 @@ module Axlsx
     def to_xml_string(str='')
       str << "<sheetCalcPr #{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/sheet_pr.rb

@@ -2,73 +2,44 @@ module Axlsx
 
   # The SheetPr class manages serialization fo a worksheet's sheetPr element.
   class SheetPr
-
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
+
+    serializable_attributes :sync_horizontal,
+                            :sync_vertical,
+                            :transtion_evaluation,
+                            :transition_entry,
+                            :published,
+                            :filter_mode,
+                            :enable_format_conditions_calculation,
+                            :code_name,
+                            :sync_ref
 
     # These attributes are all boolean so I'm doing a bit of a hand
     # waving magic show to set up the attriubte accessors
-    BOOLEAN_ATTRIBUTES = [:sync_horizontal, 
-                          :sync_vertical, 
-                          :transtion_evaluation, 
+    boolean_attr_accessor :sync_horizontal,
+                          :sync_vertical,
+                          :transtion_evaluation,
                           :transition_entry,
                           :published,
                           :filter_mode,
-                          :enable_format_conditions_calculation]
+                          :enable_format_conditions_calculation
 
+    string_attr_accessor :code_name, :sync_ref
 
     # Creates a new SheetPr object
     # @param [Worksheet] worksheet The worksheet that owns this SheetPr object
     def initialize(worksheet, options={})
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
       @worksheet = worksheet
-      options.each do |key, value|
-        attr = "#{key}="  
-        self.send(attr, value) if self.respond_to?(attr)
-      end
+      parse_options options
     end
 
-    # Dynamically create accessors for boolean attriubtes
-    BOOLEAN_ATTRIBUTES.each do |attr|    
-      class_eval %{
-      # The #{attr} attribute reader
-      # @return [Boolean]
-      attr_reader :#{attr} 
-
-      # The #{attr} writer
-      # @param [Boolean] value The value to assign to #{attr}
-      # @return [Boolean]
-      def #{attr}=(value)
-        Axlsx::validate_boolean(value)
-        @#{attr} = value
-      end
-      }
-    end
-
-    # Anchor point for worksheet's window.
-    # @return [String]
-    attr_reader :code_name
-
-    # Specifies a stable name of the sheet, which should not change over time,
-    #  and does not change from user input. This name should be used by code 
-    #  to reference a particular sheet.
-    # @return [String]
-    attr_reader :sync_ref
-
     # The worksheet these properties apply to!
     # @return [Worksheet]
     attr_reader :worksheet
 
-    # @see code_name
-    # @param [String] name
-    def code_name=(name)
-      @code_name = name
-    end
-
-    # @see sync_ref
-    # @param [String] ref A cell reference (e.g. "A1")
-    def sync_ref=(ref)
-      @sync_ref = ref
-    end
-
     # Serialize the object
     # @param [String] str serialized output will be appended to this object if provided.
     # @return [String]
@@ -87,15 +58,6 @@ module Axlsx
 
     private
 
-    def serialized_attributes(str = '')
-      instance_values.each do |key, value| 
-        unless %(worksheet page_setup_pr).include? key
-          str << "#{Axlsx.camel(key, false)}='#{value}' " 
-        end
-      end
-      str
-    end
-
     def update_properties
       page_setup_pr.fit_to_page = worksheet.fit_to_page?
       if worksheet.auto_filter.columns.size > 0