caxlsx 3.3.0 → 3.4.0

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

@@ -1,8 +1,6 @@
 module Axlsx
-
   # The RichTextRun class creates and self serializing text run.
   class RichTextRun
-
     include Axlsx::OptionsParser
 
     attr_reader :value
@@ -13,7 +11,7 @@ module Axlsx
                      :shadow, :condense, :extend, :u,
                      :vertAlign, :sz, :color, :scheme].freeze
 
-    def initialize(value, options={})
+    def initialize(value, options = {})
       self.value = value
       parse_options(options)
     end
@@ -27,6 +25,7 @@ module Axlsx
     # The inline font_name property for the cell
     # @return [String]
     attr_reader :font_name
+
     # @see font_name
     def font_name=(v) set_run_style :validate_string, :font_name, v; end
 
@@ -53,6 +52,7 @@ module Axlsx
     # 255  OEM_CHARSET
     # @return [String]
     attr_reader :charset
+
     # @see charset
     def charset=(v) set_run_style :validate_unsigned_int, :charset, v; end
 
@@ -64,6 +64,7 @@ module Axlsx
     # 4 Script
     # 5 Decorative
     attr_reader :family
+
     # @see family
     def family=(v)
       set_run_style :validate_family, :family, v.to_i
@@ -72,42 +73,49 @@ module Axlsx
     # The inline bold property for the cell
     # @return [Boolean]
     attr_reader :b
+
     # @see b
     def b=(v) set_run_style :validate_boolean, :b, v; end
 
     # The inline italic property for the cell
     # @return [Boolean]
     attr_reader :i
+
     # @see i
     def i=(v) set_run_style :validate_boolean, :i, v; end
 
     # The inline strike property for the cell
     # @return [Boolean]
     attr_reader :strike
+
     # @see strike
     def strike=(v) set_run_style :validate_boolean, :strike, v; end
 
     # The inline outline property for the cell
     # @return [Boolean]
     attr_reader :outline
+
     # @see outline
     def outline=(v) set_run_style :validate_boolean, :outline, v; end
 
     # The inline shadow property for the cell
     # @return [Boolean]
     attr_reader :shadow
+
     # @see shadow
     def shadow=(v) set_run_style :validate_boolean, :shadow, v; end
 
     # The inline condense property for the cell
     # @return [Boolean]
     attr_reader :condense
+
     # @see condense
     def condense=(v) set_run_style :validate_boolean, :condense, v; end
 
     # The inline extend property for the cell
     # @return [Boolean]
     attr_reader :extend
+
     # @see extend
     def extend=(v) set_run_style :validate_boolean, :extend, v; end
 
@@ -117,6 +125,7 @@ module Axlsx
     # @return [String]
     # @note true is for backwards compatability and is reassigned to :single
     attr_reader :u
+
     # @see u
     def u=(v)
       v = :single if (v == true || v == 1 || v == :true || v == 'true')
@@ -126,14 +135,16 @@ module Axlsx
     # The inline color property for the cell
     # @return [Color]
     attr_reader :color
+
     # @param [String] v The 8 character representation for an rgb color #FFFFFFFF"
     def color=(v)
-      @color = v.is_a?(Color) ? v : Color.new(:rgb=>v)
+      @color = v.is_a?(Color) ? v : Color.new(:rgb => v)
     end
 
     # The inline sz property for the cell
     # @return [Inteter]
     attr_reader :sz
+
     # @see sz
     def sz=(v) set_run_style :validate_unsigned_int, :sz, v; end
 
@@ -141,6 +152,7 @@ module Axlsx
     # this must be one of [:baseline, :subscript, :superscript]
     # @return [Symbol]
     attr_reader :vertAlign
+
     # @see vertAlign
     def vertAlign=(v)
       RestrictionValidator.validate :cell_vertAlign, [:baseline, :subscript, :superscript], v
@@ -151,6 +163,7 @@ module Axlsx
     # this must be one of [:none, major, minor]
     # @return [Symbol]
     attr_reader :scheme
+
     # @see scheme
     def scheme=(v)
       RestrictionValidator.validate :cell_scheme, [:none, :major, :minor], v
@@ -162,6 +175,7 @@ module Axlsx
     # @return [Array]
     def autowidth(widtharray)
       return if value.nil?
+
       if styles.cellXfs[style].alignment && styles.cellXfs[style].alignment.wrap_text
         first = true
         value.to_s.split(/\r?\n/, -1).each do |line|
@@ -181,6 +195,7 @@ module Axlsx
     # Utility method for setting inline style attributes
     def set_run_style(validator, attr, value)
       return unless INLINE_STYLES.include?(attr.to_sym)
+
       Axlsx.send(validator, value) unless validator.nil?
       self.instance_variable_set :"@#{attr.to_s}", value
     end
@@ -190,7 +205,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       valid = RichTextRun::INLINE_STYLES
-      data = Hash[Axlsx.instance_values_for(self).map{ |k, v| [k.to_sym, v] }]
+      data = Hash[Axlsx.instance_values_for(self).map { |k, v| [k.to_sym, v] }]
       data = data.select { |key, value| valid.include?(key) && !value.nil? }
 
       str << '<r><rPr>'
@@ -223,6 +238,7 @@ module Axlsx
     # imagemagick and loading metrics for every character.
     def font_size
       return sz if sz
+
       font = styles.fonts[styles.cellXfs[style].fontId] || styles.fonts[0]
       (font.b || (defined?(@b) && @b)) ? (font.sz * 1.5) : font.sz
     end

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

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
   # A Row is a single row in a worksheet.
   # @note The recommended way to manage rows and cells is to use Worksheet#add_row
@@ -6,13 +5,13 @@ module Axlsx
   class Row < SimpleTypedList
     include SerializedAttributes
     include Accessors
-    
+
     # No support is provided for the following attributes
     # spans
     # thickTop
     # thickBottom
 
-   # 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
@@ -24,11 +23,12 @@ module Axlsx
     # @option options [Array] values
     # @option options [Array, Symbol] types
     # @option options [Array, Integer] style
+    # @option options [Array, Boolean] escape_formulas
     # @option options [Float] height the row's height (in points)
     # @option options [Integer] offset - add empty columns before values
     # @see Row#array_to_cells
     # @see Cell
-    def initialize(worksheet, values=[], options={})
+    def initialize(worksheet, values = [], options = {})
       self.worksheet = worksheet
       super(Cell, nil, values.size + options[:offset].to_i)
       self.height = options.delete(:height)
@@ -64,7 +64,7 @@ module Axlsx
     # @see Row#s
     def s=(v)
       Axlsx.validate_unsigned_numeric(v)
-      @custom_format = true 
+      @custom_format = true
       @s = v
     end
 
@@ -73,7 +73,7 @@ module Axlsx
       Axlsx.validate_unsigned_numeric(v)
       @outline_level = v
     end
-    
+
     alias :outlineLevel= :outline_level=
 
     # The index of this row in the worksheet
@@ -104,20 +104,29 @@ module Axlsx
       c
     end
 
-    # sets the color for every cell in this row
+    # Sets the color for every cell in this row.
     def color=(color)
-      each_with_index do | cell, index |
+      each_with_index do |cell, index|
         cell.color = color.is_a?(Array) ? color[index] : color
       end
     end
 
-    # sets the style for every cell in this row
+    # Sets the style for every cell in this row.
     def style=(style)
-      each_with_index do | cell, index |
+      each_with_index do |cell, index|
         cell.style = style.is_a?(Array) ? style[index] : style
       end
     end
 
+    # Sets escape_formulas for every cell in this row. This determines whether to treat
+    # values starting with an equals sign as formulas or as literal strings.
+    # @param [Array, Boolean] value The value to set.
+    def escape_formulas=(value)
+      each_with_index do |cell, index|
+        cell.escape_formulas = value.is_a?(Array) ? value[index] : value
+      end
+    end
+
     # @see height
     def height=(v)
       unless v.nil?
@@ -126,7 +135,7 @@ module Axlsx
         @ht = v
       end
     end
-    
+
     # return cells
     def cells
       self
@@ -135,7 +144,7 @@ module Axlsx
     private
 
     # assigns the owning worksheet for this row
-    def worksheet=(v) DataTypeValidator.validate :row_worksheet, Worksheet, v; @worksheet=v; end
+    def worksheet=(v) DataTypeValidator.validate :row_worksheet, Worksheet, v; @worksheet = v; end
 
     # Converts values, types, and style options into cells and associates them with this row.
     # A new cell is created for each item in the values array.
@@ -146,19 +155,19 @@ module Axlsx
     # @option options [Array] values
     # @option options [Array, Symbol] types
     # @option options [Array, Integer] style
-    def array_to_cells(values, options={})
+    # @option options [Array, Boolean] escape_formulas
+    def array_to_cells(values, options = {})
       DataTypeValidator.validate :array_to_cells, Array, values
       types, style, formula_values, escape_formulas, offset = options.delete(:types), options.delete(:style), options.delete(:formula_values), options.delete(:escape_formulas), options.delete(:offset)
       offset.to_i.times { |index| self[index] = Cell.new(self) } if offset
       values.each_with_index do |value, index|
         options[:style] = style.is_a?(Array) ? style[index] : style if style
         options[:type] = types.is_a?(Array) ? types[index] : types if types
-        options[:escape_formulas] = escape_formulas.is_a?(Array) ? escape_formulas[index] : escape_formulas if escape_formulas
+        options[:escape_formulas] = escape_formulas.is_a?(Array) ? escape_formulas[index] : escape_formulas unless escape_formulas.nil?
         options[:formula_value] = formula_values[index] if formula_values.is_a?(Array)
 
         self[index + offset.to_i] = Cell.new(self, value, options)
       end
     end
   end
-
 end

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

@@ -1,9 +1,7 @@
 module Axlsx
-
   # A collection of break objects that define row breaks (page breaks) for printing and preview
 
   class RowBreaks < SimpleTypedList
-
     def initialize
       super Break
     end
@@ -17,14 +15,15 @@ module Axlsx
       self << Break.new(options.merge(:max => 16383, :man => true))
       last
     end
- 
+
     # <rowBreaks count="3" manualBreakCount="3">
     # <brk id="1" max="16383" man="1"/>
     # <brk id="7" max="16383" man="1"/>
     # <brk id="13" max="16383" man="1"/>
     # </rowBreaks>
-    def to_xml_string(str='')
+    def to_xml_string(str = '')
       return if empty?
+
       str << ('<rowBreaks count="' << self.size.to_s << '" manualBreakCount="' << self.size.to_s << '">')
       each { |brk| brk.to_xml_string(str) }
       str << '</rowBreaks>'

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

@@ -1,11 +1,9 @@
-# encoding: UTF-8
 module Axlsx
   # Selection options for worksheet panes.
   #
   # @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
 
@@ -14,7 +12,7 @@ module Axlsx
     # @option options [Integer] active_cell_id Active Cell Index
     # @option options [Symbol] pane Pane
     # @option options [String] sqref Sequence of References
-    def initialize(options={})
+    def initialize(options = {})
       @active_cell = @active_cell_id = @pane = @sqref = nil
       parse_options options
     end
@@ -40,16 +38,16 @@ module Axlsx
 
     # Pane
     # The pane to which this selection belongs.
-    # Options are 
+    # Options are
     #  * bottom_left:  Bottom left pane, when both vertical and horizontal
     #                  splits are applied. This value is also used when only
-    #                  a horizontal split has been applied, dividing the pane 
-    #                  into upper and lower regions. In that case, this value 
+    #                  a horizontal split has been applied, dividing the pane
+    #                  into upper and lower regions. In that case, this value
     #                  specifies the bottom pane.
     #  * bottom_right: Bottom right pane, when both vertical and horizontal
     #                  splits are applied.
     #  * top_left:     Top left pane, when both vertical and horizontal splits
-    #                  are applied. This value is also used when only a horizontal 
+    #                  are applied. This value is also used when only a horizontal
     #                  split has been applied, dividing the pane into upper and lower
     #                  regions. In that case, this value specifies the top pane.
     #                  This value is also used when only a vertical split has
@@ -57,8 +55,8 @@ module Axlsx
     #                  regions. In that case, this value specifies the left pane
     #  * top_right:    Top right pane, when both vertical and horizontal
     #                  splits are applied. This value is also used when only
-    #                  a vertical split has been applied, dividing the pane 
-    #                  into right and left regions. In that case, this value 
+    #                  a vertical split has been applied, dividing the pane
+    #                  into right and left regions. In that case, this value
     #                  specifies the right pane.
     # @see type
     # @return [Symbol]

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

@@ -1,15 +1,14 @@
 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
+    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={})
+    def initialize(options = {})
       @full_calc_on_load = true
       parse_options options
     end
@@ -22,7 +21,7 @@ module Axlsx
     # @param [String] str the string to append this objects serialized
     # content to.
     # @return [String]
-    def to_xml_string(str='')
+    def to_xml_string(str = '')
       str << "<sheetCalcPr #{serialized_attributes}/>"
     end
   end

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

@@ -1,15 +1,14 @@
 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
@@ -17,11 +16,10 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<sheetData>'
-      worksheet.rows.each_with_index do |row, index| 
-        row.to_xml_string(index, str) 
+      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,5 +1,4 @@
 module Axlsx
-
   # The SheetPr class manages serialization of a worksheet's sheetPr element.
   class SheetPr
     include Axlsx::OptionsParser
@@ -30,8 +29,9 @@ module Axlsx
 
     # Creates a new SheetPr object
     # @param [Worksheet] worksheet The worksheet that owns this SheetPr object
-    def initialize(worksheet, options={})
+    def initialize(worksheet, options = {})
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
       @worksheet = worksheet
       @outline_pr = nil
       parse_options options
@@ -62,7 +62,7 @@ module Axlsx
     def page_setup_pr
       @page_setup_pr ||= PageSetUpPr.new
     end
-    
+
     # The OutlinePr for this sheet pr object
     # @return [OutlinePr]
     def outline_pr
@@ -71,7 +71,7 @@ module Axlsx
 
     # @see tab_color
     def tab_color=(v)
-      @tab_color ||= Color.new(:rgb => v)
+      @tab_color = Color.new(:rgb => v)
     end
 
     private

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

@@ -1,9 +1,6 @@
-# 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
@@ -26,7 +23,7 @@ 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=
-    def initialize(options={})
+    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
@@ -34,12 +31,12 @@ module Axlsx
     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
+                          :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
+                            :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]
@@ -50,9 +47,9 @@ module Axlsx
     # 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 
+    # 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'
@@ -69,6 +66,7 @@ module Axlsx
     # encodes password for protection locking
     def password=(v)
       return if v == nil
+
       @password = create_password_hash(v)
     end
 
@@ -80,6 +78,7 @@ module Axlsx
     end
 
     private
+
     # Creates a password hash for a given password
     # @return [String]
     def create_password_hash(password)
@@ -102,14 +101,14 @@ module Axlsx
 
       chars.collect! do |char|
         i += 1
-        char     = char.unpack('c')[0] << i #ord << i
+        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
+      encoded_password = 0x0000
       chars.each { |c| encoded_password ^= c }
       encoded_password ^= count
       encoded_password ^= 0xCE4B