caxlsx 3.2.0 → 3.4.0

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

@@ -1,29 +1,28 @@
-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
+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_data.rb

@@ -1,27 +1,25 @@
-module Axlsx
-
-  # This class manages the serialization of rows for worksheets
-  class SheetData
-
-    # Creates a new SheetData object
-    # @param [Worksheet] worksheet The worksheet that owns this sheet data.
-    def initialize(worksheet)
-      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet
-    end
-    
-    attr_reader :worksheet
-
-    # Serialize the sheet data
-    # @param [String] str the string this objects serializaton will be concacted to.
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<sheetData>'
-      worksheet.rows.each_with_index do |row, index| 
-        row.to_xml_string(index, str) 
-      end
-      str << '</sheetData>'
-    end
-    
-  end
-end
+module Axlsx
+  # This class manages the serialization of rows for worksheets
+  class SheetData
+    # Creates a new SheetData object
+    # @param [Worksheet] worksheet The worksheet that owns this sheet data.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # Serialize the sheet data
+    # @param [String] str the string this objects serializaton will be concacted to.
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<sheetData>'
+      worksheet.rows.each_with_index do |row, index|
+        row.to_xml_string(index, str)
+      end
+      str << '</sheetData>'
+    end
+  end
+end

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

@@ -1,17 +1,16 @@
 module Axlsx
-
-  #Sheet formatting properties
-  # <xsd:complexType name="CT_SheetFormatPr">
-  #   <xsd:attribute name="baseColWidth" type="xsd:unsignedInt" use="optional" default="8"/>
-  #   <xsd:attribute name="defaultColWidth" type="xsd:double" use="optional"/>
-  #   <xsd:attribute name="defaultRowHeight" type="xsd:double" use="required"/>
-  #   <xsd:attribute name="customHeight" type="xsd:boolean" use="optional" default="false"/>
-  #   <xsd:attribute name="zeroHeight" type="xsd:boolean" use="optional" default="false"/>
-  #   <xsd:attribute name="thickTop" type="xsd:boolean" use="optional" default="false"/>
-  #   <xsd:attribute name="thickBottom" type="xsd:boolean" use="optional" default="false"/>
-  #   <xsd:attribute name="outlineLevelRow" type="xsd:unsignedByte" use="optional" default="0"/>
-  #   <xsd:attribute name="outlineLevelCol" type="xsd:unsignedByte" use="optional" default="0"/>
-  #</xsd:complexType>
+  # Sheet formatting properties
+  # <xsd:complexType name="CT_SheetFormatPr">
+  #   <xsd:attribute name="baseColWidth" type="xsd:unsignedInt" use="optional" default="8"/>
+  #   <xsd:attribute name="defaultColWidth" type="xsd:double" use="optional"/>
+  #   <xsd:attribute name="defaultRowHeight" type="xsd:double" use="required"/>
+  #   <xsd:attribute name="customHeight" type="xsd:boolean" use="optional" default="false"/>
+  #   <xsd:attribute name="zeroHeight" type="xsd:boolean" use="optional" default="false"/>
+  #   <xsd:attribute name="thickTop" type="xsd:boolean" use="optional" default="false"/>
+  #   <xsd:attribute name="thickBottom" type="xsd:boolean" use="optional" default="false"/>
+  #   <xsd:attribute name="outlineLevelRow" type="xsd:unsignedByte" use="optional" default="0"/>
+  #   <xsd:attribute name="outlineLevelCol" type="xsd:unsignedByte" use="optional" default="0"/>
+  # </xsd:complexType>
 
   class SheetFormatPr
     include Axlsx::SerializedAttributes
@@ -29,29 +28,30 @@ module Axlsx
     # @option [Boolean] thick_bottom 'True' if rows have a thick bottom border by default.
     # @option [Integer] outline_level_row Highest number of outline level for rows in this sheet. These values shall be in synch with the actual sheet outline levels.
     # @option [Integer] outline_level_col Highest number of outline levels for columns in this sheet. These values shall be in synch with the actual sheet outline levels.
-    def initialize(options={})
+    def initialize(options = {})
       set_defaults
       parse_options options
     end
 
     serializable_attributes :base_col_width, :default_col_width, :default_row_height,
-      :custom_height, :zero_height, :thick_top, :thick_bottom,
-      :outline_level_row, :outline_level_col
+                            :custom_height, :zero_height, :thick_top, :thick_bottom,
+                            :outline_level_row, :outline_level_col
 
     float_attr_accessor :default_col_width, :default_row_height
 
     boolean_attr_accessor :custom_height, :zero_height, :thick_top, :thick_bottom
 
-    unsigned_int_attr_accessor :base_col_width, :outline_level_row, :outline_level_col 
+    unsigned_int_attr_accessor :base_col_width, :outline_level_row, :outline_level_col
 
     # serializes this object to an xml string
     # @param [String] str The string this objects serialization will be appended to
     # @return [String]
-    def to_xml_string(str='')
+    def to_xml_string(str = '')
       str << "<sheetFormatPr #{serialized_attributes}/>"
     end
 
     private
+
     def set_defaults
       @base_col_width = 8
       @default_row_height = 18

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

@@ -1,87 +1,87 @@
-module Axlsx
-
-  # The SheetPr class manages serialization of a worksheet's sheetPr element.
-  class SheetPr
-    include Axlsx::OptionsParser
-    include Axlsx::Accessors
-    include Axlsx::SerializedAttributes
-
-    serializable_attributes :sync_horizontal,
-                            :sync_vertical,
-                            :transition_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,
-                          :transition_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, options={})
-      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet
-      @outline_pr = nil
-      parse_options options
-    end
-
-    # The worksheet these properties apply to!
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # The tab color of the sheet.
-    # @return [Color]
-    attr_reader :tab_color
-
-    # Serialize the object
-    # @param [String] str serialized output will be appended to this object if provided.
-    # @return [String]
-    def to_xml_string(str = '')
-      update_properties
-      str << "<sheetPr #{serialized_attributes}>"
-      tab_color.to_xml_string(str, 'tabColor') if tab_color
-      outline_pr.to_xml_string(str) if @outline_pr
-      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
-    
-    # The OutlinePr for this sheet pr object
-    # @return [OutlinePr]
-    def outline_pr
-      @outline_pr ||= OutlinePr.new
-    end
-
-    # @see tab_color
-    def tab_color=(v)
-      @tab_color ||= Color.new(:rgb => v)
-    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
+module Axlsx
+  # The SheetPr class manages serialization of a worksheet's sheetPr element.
+  class SheetPr
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
+
+    serializable_attributes :sync_horizontal,
+                            :sync_vertical,
+                            :transition_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,
+                          :transition_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, options = {})
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
+      @worksheet = worksheet
+      @outline_pr = nil
+      parse_options options
+    end
+
+    # The worksheet these properties apply to!
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # The tab color of the sheet.
+    # @return [Color]
+    attr_reader :tab_color
+
+    # Serialize the object
+    # @param [String] str serialized output will be appended to this object if provided.
+    # @return [String]
+    def to_xml_string(str = '')
+      update_properties
+      str << "<sheetPr #{serialized_attributes}>"
+      tab_color.to_xml_string(str, 'tabColor') if tab_color
+      outline_pr.to_xml_string(str) if @outline_pr
+      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
+
+    # The OutlinePr for this sheet pr object
+    # @return [OutlinePr]
+    def outline_pr
+      @outline_pr ||= OutlinePr.new
+    end
+
+    # @see tab_color
+    def tab_color=(v)
+      @tab_color = Color.new(:rgb => v)
+    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

@@ -1,118 +1,117 @@
-# encoding: UTF-8
-module Axlsx
-
-  # The SheetProtection object manages worksheet protection options per sheet.
-  class SheetProtection
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-    include Axlsx::Accessors
-
-    # Creates a new SheetProtection instance
-    # @option options [Boolean] sheet @see SheetProtection#sheet
-    # @option options [Boolean] objects @see SheetProtection#objects
-    # @option options [Boolean] scenarios @see SheetProtection#scenarios
-    # @option options [Boolean] format_cells @see SheetProtection#objects
-    # @option options [Boolean] format_columns @see SheetProtection#format_columns
-    # @option options [Boolean] format_rows @see SheetProtection#format_rows
-    # @option options [Boolean] insert_columns @see SheetProtection#insert_columns
-    # @option options [Boolean] insert_rows @see SheetProtection#insert_rows
-    # @option options [Boolean] insert_hyperlinks @see SheetProtection#insert_hyperlinks
-    # @option options [Boolean] delete_columns @see SheetProtection#delete_columns
-    # @option options [Boolean] delete_rows @see SheetProtection#delete_rows
-    # @option options [Boolean] select_locked_cells @see SheetProtection#select_locked_cells
-    # @option options [Boolean] sort @see SheetProtection#sort
-    # @option options [Boolean] auto_filter @see SheetProtection#auto_filter
-    # @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=
-    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
-
-    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 = '')
-      serialized_tag('sheetProtection', str)
-    end
-
-    private
-    # Creates a password hash for a given password
-    # @return [String]
-    def create_password_hash(password)
-      encoded_password = encode_password(password)
-
-      password_as_hex = [encoded_password].pack("v")
-      password_as_string = password_as_hex.unpack("H*").first.upcase
-
-      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)
-    # @return [String]
-    def encode_password(password)
-      i = 0
-      chars = password.split(//)
-      count = chars.size
-
-      chars.collect! do |char|
-        i += 1
-        char     = char.unpack('c')[0] << i #ord << i
-        low_15   = char & 0x7fff
-        high_15  = char & 0x7fff << 15
-        high_15  = high_15 >> 15
-        char     = low_15 | high_15
-      end
-
-      encoded_password  = 0x0000
-      chars.each { |c| encoded_password ^= c }
-      encoded_password ^= count
-      encoded_password ^= 0xCE4B
-    end
-  end
-end
+module Axlsx
+  # The SheetProtection object manages worksheet protection options per sheet.
+  class SheetProtection
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
+
+    # Creates a new SheetProtection instance
+    # @option options [Boolean] sheet @see SheetProtection#sheet
+    # @option options [Boolean] objects @see SheetProtection#objects
+    # @option options [Boolean] scenarios @see SheetProtection#scenarios
+    # @option options [Boolean] format_cells @see SheetProtection#objects
+    # @option options [Boolean] format_columns @see SheetProtection#format_columns
+    # @option options [Boolean] format_rows @see SheetProtection#format_rows
+    # @option options [Boolean] insert_columns @see SheetProtection#insert_columns
+    # @option options [Boolean] insert_rows @see SheetProtection#insert_rows
+    # @option options [Boolean] insert_hyperlinks @see SheetProtection#insert_hyperlinks
+    # @option options [Boolean] delete_columns @see SheetProtection#delete_columns
+    # @option options [Boolean] delete_rows @see SheetProtection#delete_rows
+    # @option options [Boolean] select_locked_cells @see SheetProtection#select_locked_cells
+    # @option options [Boolean] sort @see SheetProtection#sort
+    # @option options [Boolean] auto_filter @see SheetProtection#auto_filter
+    # @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=
+    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
+
+    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 = '')
+      serialized_tag('sheetProtection', str)
+    end
+
+    private
+
+    # Creates a password hash for a given password
+    # @return [String]
+    def create_password_hash(password)
+      encoded_password = encode_password(password)
+
+      password_as_hex = [encoded_password].pack("v")
+      password_as_string = password_as_hex.unpack("H*").first.upcase
+
+      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)
+    # @return [String]
+    def encode_password(password)
+      i = 0
+      chars = password.split(//)
+      count = chars.size
+
+      chars.collect! do |char|
+        i += 1
+        char     = char.unpack('c')[0] << i # ord << i
+        low_15   = char & 0x7fff
+        high_15  = char & 0x7fff << 15
+        high_15  = high_15 >> 15
+        char     = low_15 | high_15
+      end
+
+      encoded_password = 0x0000
+      chars.each { |c| encoded_password ^= c }
+      encoded_password ^= count
+      encoded_password ^= 0xCE4B
+    end
+  end
+end