axlsx 1.2.0 → 1.3.3

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

@@ -5,59 +5,14 @@ module Axlsx
   # @see Worksheet#add_row
   class Row
 
+    include SerializedAttributes
+    include Accessors
     # No support is provided for the following attributes
     # spans
     # thickTop
     # thickBottom
 
-
-    # A list of serilizable attributes.
-    # @note height(ht) and customHeight are manages separately for now. Have a look at Row#height
-    SERIALIZABLE_ATTRIBUTES = [:hidden, :outlineLevel, :collapsed, :s, :customFormat, :ph]
-    
-    # The worksheet this row belongs to
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # The cells this row holds
-    # @return [SimpleTypedList]
-    attr_reader :cells
-
-    # Row height measured in point size. There is no margin padding on row height.
-    # @return [Float]
-    attr_reader :height
-
-    # Flag indicating if the outlining of row.
-    # @return [Boolean]
-    attr_reader :collapsed
-
-    # Flag indicating if the the row is hidden.
-    # @return [Boolean]
-    attr_reader :hidden
-
-    # Outlining level of the row, when outlining is on
-    # @return [Integer]
-    attr_reader :outlineLevel
-
-    # The style applied ot the row. This affects the entire row.
-    # @return [Integer]
-    attr_reader :s
-
-    # indicates that a style has been applied directly to the row via Row#s
-    # @return [Boolean]
-    attr_reader :customFormat
-
-    # indicates if the row should show phonetic
-    # @return [Boolean]
-    attr_reader :ph
-
-    # NOTE removing this from the api as it is actually incorrect. 
-    # having a method to style a row's cells is fine, but it is not an attribute on the row. 
-    # The proper attribute is ':s'
-    # attr_reader style
-    #
-    
-    # Creates a new row. New Cell objects are created based on the values, types and style options.
+   # Creates a new row. New Cell objects are created based on the values, types and style options.
     # A new cell is created for each item in the values array. style and types options are applied as follows:
     #   If the types option is defined and is a symbol it is applied to all the cells created.
     #   If the types option is an array, cell types are applied by index for each cell
@@ -73,7 +28,7 @@ module Axlsx
     # @see Row#array_to_cells
     # @see Cell
     def initialize(worksheet, values=[], options={})
-      @height = nil
+      @ht = nil
       self.worksheet = worksheet
       @cells = SimpleTypedList.new Cell
       @worksheet.rows << self
@@ -81,29 +36,48 @@ module Axlsx
       array_to_cells(values, options)
     end
 
-    # @see Row#collapsed
-    def collapsed=(v)
-      Axlsx.validate_boolean(v)
-      @collapsed = v
-    end
+    # A list of serializable attributes.
+    serializable_attributes :hidden, :outline_level, :collapsed, :custom_format, :s, :ph, :custom_height, :ht
+
+    # Boolean row attribute accessors
+    boolean_attr_accessor :hidden, :collapsed, :custom_format, :ph, :custom_height
 
-    # @see Row#hidden
-    def hidden=(v)
-      Axlsx.validate_boolean(v)
-      @hidden = v
+    # The worksheet this row belongs to
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # The cells this row holds
+    # @return [SimpleTypedList]
+    attr_reader :cells
+
+    # Row height measured in point size. There is no margin padding on row height.
+    # @return [Float]
+    def height
+      @ht
     end
-   
-    # @see Row#ph
-    def ph=(v) Axlsx.validate_boolean(v); @ph = v end
+
+    # Outlining level of the row, when outlining is on
+    # @return [Integer]
+    attr_reader :outline_level
+    alias :outlineLevel :outline_level
+
+    # The style applied ot the row. This affects the entire row.
+    # @return [Integer]
+    attr_reader :s
 
     # @see Row#s
-    def s=(v) Axlsx.validate_unsigned_numeric(v); @s = v; @customFormat = true end
+    def s=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @custom_format = true 
+      @s = v
+    end
 
     # @see Row#outline
-    def outlineLevel=(v)
+    def outline_level=(v)
       Axlsx.validate_unsigned_numeric(v)
-      @outlineLevel = v
+      @outline_level = v
     end
+    alias :outlineLevel= :outline_level=
 
     # The index of this row in the worksheet
     # @return [Integer]
@@ -116,18 +90,11 @@ module Axlsx
     # @param [String] str The string this rows xml will be appended to.
     # @return [String]
     def to_xml_string(r_index, str = '')
-      str << '<row r="' << (r_index + 1 ).to_s << '" '
-      instance_values.select { |key, value| SERIALIZABLE_ATTRIBUTES.include? key.to_sym }.each do |key, value|
-        str << key << '="' << value.to_s << '" '
-      end
-      if custom_height?
-        str << 'customHeight="1" ht="' << height.to_s << '">'
-      else
-        str << '>'
-      end
+      str << '<row '
+      serialized_attributes(str, { :r => r_index + 1 })
+      str << '>'
       @cells.each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, str) }
       str << '</row>'
-      str
     end
 
     # Adds a singel sell to the row based on the data provided and updates the worksheet's autofit data.
@@ -154,13 +121,13 @@ module Axlsx
     end
 
     # @see height
-    def height=(v); Axlsx::validate_unsigned_numeric(v) unless v.nil?; @height = v end
-
-    # true if the row height has been manually set
-    # @return [Boolean]
-    # @see #height
-    def custom_height?
-      @height != nil
+    def height=(v)
+      Axlsx::validate_unsigned_numeric(v)
+      unless v.nil?
+        @ht = v
+        @custom_height = true
+      end
+      @ht
     end
 
     private

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

@@ -0,0 +1,29 @@
+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
+      parse_options options
+    end
+
+    boolean_attr_accessor :full_calc_on_load
+
+    serializable_attributes :full_calc_on_load
+
+    # Serialize the object
+    # @param [String] str the string to append this objects serialized
+    # content to.
+    # @return [String]
+    def to_xml_string(str='')
+      str << "<sheetCalcPr #{serialized_attributes}/>"
+    end
+  end
+end

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

@@ -1,24 +1,69 @@
 module Axlsx
 
   # The SheetPr class manages serialization fo a worksheet's sheetPr element.
-  # Only fit_to_page is implemented
   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_attr_accessor :sync_horizontal,
+                          :sync_vertical,
+                          :transtion_evaluation,
+                          :transition_entry,
+                          :published,
+                          :filter_mode,
+                          :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)
+    def initialize(worksheet, options={})
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
       @worksheet = worksheet
+      parse_options options
     end
 
+    # The worksheet these properties apply to!
+    # @return [Worksheet]
     attr_reader :worksheet
 
     # Serialize the object
     # @param [String] str serialized output will be appended to this object if provided.
     # @return [String]
     def to_xml_string(str = '')
-       return unless worksheet.fit_to_page?
-      str << "<sheetPr><pageSetUpPr fitToPage=\"%s\"></pageSetUpPr></sheetPr>" % worksheet.fit_to_page?
+      update_properties
+      str << "<sheetPr #{serialized_attributes}>"
+      page_setup_pr.to_xml_string(str)
+      str << "</sheetPr>"
+    end
+
+    # The PageSetUpPr for this sheet pr object
+    # @return [PageSetUpPr]
+    def page_setup_pr
+      @page_setup_pr ||= PageSetUpPr.new
+    end
+
+    private
+
+    def update_properties
+      page_setup_pr.fit_to_page = worksheet.fit_to_page?
+      if worksheet.auto_filter.columns.size > 0
+        self.filter_mode = 1
+        self.enable_format_conditions_calculation = 1
+      end
     end
   end
 end

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

@@ -4,110 +4,9 @@ module Axlsx
   # The SheetProtection object manages worksheet protection options per sheet.
   class SheetProtection
 
-    # If 1 or true then AutoFilters should not be allowed to operate when the sheet is protected.
-    # If 0 or false then AutoFilters should be allowed to operate when the sheet is protected.
-    # @return [Boolean]
-    # default true 
-    attr_reader :auto_filter
-
-    # If 1 or true then deleting columns should not be allowed when the sheet is protected. 
-    # If 0 or false then deleting columns should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :delete_columns
-
-    # If 1 or true then deleting rows should not be allowed when the sheet is protected.
-    # If 0 or false then deleting rows should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :delete_rows
-
-    # If 1 or true then formatting cells should not be allowed when the sheet is protected.
-    # If 0 or false then formatting cells should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :format_cells
-
-    # If 1 or true then formatting columns should not be allowed when the sheet is protected.
-    # If 0 or false then formatting columns should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :format_columns
-
-    # If 1 or true then formatting rows should not be allowed when the sheet is protected. 
-    # If 0 or false then formatting rows should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :format_rows
-
-    # If 1 or true then inserting columns should not be allowed when the sheet is protected. 
-    # If 0 or false then inserting columns should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :insert_columns
-
-    # If 1 or true then inserting hyperlinks should not be allowed when the sheet is protected. 
-    # If 0 or false then inserting hyperlinks should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :insert_hyperlinks
-
-    # If 1 or true then inserting rows should not be allowed when the sheet is protected. 
-    # If 0 or false then inserting rows should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :insert_rows
-
-    # If 1 or true then editing of objects should not be allowed when the sheet is protected. 
-    # If 0 or false then objects are allowed to be edited when the sheet is protected.
-    # @return [Boolean]
-    # default false
-    attr_reader :objects
-
-    # If 1 or true then PivotTables should not be allowed to operate when the sheet is protected.
-    # If 0 or false then PivotTables should be allowed to operate when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :pivot_tables
-
-    # Specifies the salt which was prepended to the user-supplied password before it was hashed using the hashing algorithm
-    # @return [String]
-    attr_reader :salt_value
-
-    # If 1 or true then Scenarios should not be edited when the sheet is protected.
-    # If 0 or false then Scenarios are allowed to be edited when the sheet is protected.
-    # @return [Boolean]
-    # default false
-    attr_reader :scenarios
-
-    # If 1 or true then selection of locked cells should not be allowed when the sheet is protected.
-    # If 0 or false then selection of locked cells should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default false
-    attr_reader :select_locked_cells
-
-    # If 1 or true then selection of unlocked cells should not be allowed when the sheet is protected.
-    # If 0 or false then selection of unlocked cells should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default false
-    attr_reader :select_unlocked_cells
-
-    # If 1 or true then the sheet is protected. 
-    # If 0 or false then the sheet is not protected. 
-    # @return [Boolean]
-    # default true
-    attr_reader :sheet
-
-    # If 1 or true then sorting should not be allowed when the sheet is protected.
-    # If 0 or false then sorting should be allowed when the sheet is protected.
-    # @return [Boolean]
-    # default true
-    attr_reader :sort
-
-    # Password hash
-    # @return [String]
-    # default nil
-    attr_reader :password
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
 
     # Creates a new SheetProtection instance
     # @option options [Boolean] sheet @see SheetProtection#sheet
@@ -127,64 +26,62 @@ module Axlsx
     # @option options [Boolean] pivot_tables @see SheetProtection#pivot_tables
     # @option options [Boolean] select_unlocked_cells @see SheetProtection#select_unlocked_cells
     # @option options [String] password. The password required for unlocking. @see SheetProtection#password=
-    # @option options [Boolean] objects @see SheetProtection#objects
     def initialize(options={})
       @objects = @scenarios = @select_locked_cells = @select_unlocked_cells = false
       @sheet = @format_cells = @format_rows = @format_columns = @insert_columns = @insert_rows = @insert_hyperlinks = @delete_columns = @delete_rows = @sort = @auto_filter = @pivot_tables = true
       @password = nil
+      parse_options options
+    end
 
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+    boolean_attr_accessor :sheet, :objects, :scenarios, :format_cells, :format_columns, :format_rows,
+      :insert_columns, :insert_rows, :insert_hyperlinks, :delete_columns, :delete_rows,
+      :select_locked_cells, :sort, :auto_filter, :pivot_tables, :select_unlocked_cells
+
+    serializable_attributes :sheet, :objects, :scenarios, :format_cells, :format_columns, :format_rows,
+      :insert_columns, :insert_rows, :insert_hyperlinks, :delete_columns, :delete_rows,
+      :select_locked_cells, :sort, :auto_filter, :pivot_tables, :select_unlocked_cells, :salt, :password
+
+    # Specifies the salt which was prepended to the user-supplied password before it was hashed using the hashing algorithm
+    # @return [String]
+    attr_reader :salt_value
+
+    # Password hash
+    # @return [String]
+    # default nil
+    attr_reader :password
+
+    # This block is intended to implement the salt_value, hash_value and spin count as per the ECMA-376 standard. 
+    # However, it does not seem to actually work in EXCEL - instead they are using their old retro algorithm shown below 
+    # defined in the transitional portion of the speck. I am leaving this code in in the hope that someday Ill be able to 
+    # figure out why it does not work, and if Excel even supports it.
+    #     def propper_password=(v)
+    #       @algorithm_name = v == nil ? nil : 'SHA-1'
+    #       @salt_value = @spin_count = @hash_value = v if v == nil
+    #       return if v == nil
+    #       require 'digest/sha1'
+    #       @spin_count = 10000
+    #       @salt_value = Digest::SHA1.hexdigest(rand(36**8).to_s(36))
+    #       @spin_count.times do |count|
+    #         @hash_value = Digest::SHA1.hexdigest((@hash_value ||= (@salt_value + v.to_s)) + Array(count).pack('V'))
+    #       end
+    #     end
+
+    # encodes password for protection locking
+    def password=(v)
+      return if v == nil
+      @password = create_password_hash(v)
     end
 
+    # Serialize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<sheetProtection '
+      serialized_attributes str
+      str << '/>'
+    end
 
-     # create validating setters for boolean values
-     # @return [Boolean] 
-     [:sheet, :objects, :scenarios, :select_locked_cells, :sort,
-     :select_unlocked_cells, :format_cells, :format_rows, :format_columns,
-     :insert_columns, :insert_rows, :insert_hyperlinks, :delete_columns,
-     :delete_rows, :auto_filter, :pivot_tables].each do |f_name|
-       define_method "#{f_name.to_s}=".to_sym do |v|
-         Axlsx::validate_boolean(v)
-         instance_variable_set "@#{f_name.to_s}".to_sym, v
-       end
-     end
-
-     # This block is intended to implement the salt_value, hash_value and spin count as per the ECMA-376 standard. 
-     # However, it does not seem to actually work in EXCEL - instead they are using their old retro algorithm shown below 
-     # defined in the transitional portion of the speck. I am leaving this code in in the hope that someday Ill be able to 
-     # figure out why it does not work, and if Excel even supports it.
-#     def propper_password=(v)
-#       @algorithm_name = v == nil ? nil : 'SHA-1'
-#       @salt_value = @spin_count = @hash_value = v if v == nil
-#       return if v == nil
-#       require 'digest/sha1'
-#       @spin_count = 10000
-#       @salt_value = Digest::SHA1.hexdigest(rand(36**8).to_s(36))
-#       @spin_count.times do |count|
-#         @hash_value = Digest::SHA1.hexdigest((@hash_value ||= (@salt_value + v.to_s)) + Array(count).pack('V'))
-#       end
-#     end
-
-
-
-     # encodes password for protection locking
-     def password=(v)
-       return if v == nil
-        @password = create_password_hash(v)
-     end
-
-     # Serialize the object
-     # @param [String] str
-     # @return [String]
-     def to_xml_string(str = '')
-       str << '<sheetProtection '
-       str << instance_values.map{ |k,v| k.gsub(/_(.)/){ $1.upcase } << %{="#{v.to_s}"} }.join(' ')
-       str << '/>'
-     end
-
-  private
+    private
     # Creates a password hash for a given password
     # @return [String]
     def create_password_hash(password)
@@ -196,7 +93,6 @@ module Axlsx
       password_as_string[2..3] + password_as_string[0..1]
     end
 
-
     # Encodes a given password
     # Based on the algorithm provided by Daniel Rentz of OpenOffice.
     # http://www.openoffice.org/sc/excelfileformat.pdf, Revision 1.42, page 115 (21.05.2012)