caxlsx 3.2.0 → 3.4.0

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

@@ -1,164 +1,173 @@
-# 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
-  # @see Worksheet#add_row
-  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.
-    # 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
-    #   If the types option is not set, the cell will automatically determine its type.
-    #   If the style option is defined and is an Integer, it is applied to all cells created.
-    #   If the style option is an array, style is applied by index for each cell.
-    #   If the style option is not defined, the default style (0) is applied to each cell.
-    # @param [Worksheet] worksheet
-    # @option options [Array] values
-    # @option options [Array, Symbol] types
-    # @option options [Array, Integer] style
-    # @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={})
-      self.worksheet = worksheet
-      super(Cell, nil, values.size + options[:offset].to_i)
-      self.height = options.delete(:height)
-      worksheet.rows << self
-      array_to_cells(values, options)
-    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
-
-    # The worksheet this row belongs to
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # Row height measured in point size. There is no margin padding on row height.
-    # @return [Float]
-    def height
-      defined?(@ht) ? @ht : nil
-    end
-
-    # Outlining level of the row, when outlining is on
-    # @return [Integer]
-    attr_reader :outline_level
-    alias :outlineLevel :outline_level
-
-    # The style applied to the row. This affects the entire row.
-    # @return [Integer]
-    attr_reader :s
-
-    # @see Row#s
-    def s=(v)
-      Axlsx.validate_unsigned_numeric(v)
-      @custom_format = true 
-      @s = v
-    end
-
-    # @see Row#outline
-    def outline_level=(v)
-      Axlsx.validate_unsigned_numeric(v)
-      @outline_level = v
-    end
-    
-    alias :outlineLevel= :outline_level=
-
-    # The index of this row in the worksheet
-    # @return [Integer]
-    def row_index
-      worksheet.rows.index(self)
-    end
-
-    # Serializes the row
-    # @param [Integer] r_index The row index, 0 based.
-    # @param [String] str The string this rows xml will be appended to.
-    # @return [String]
-    def to_xml_string(r_index, str = '')
-      serialized_tag('row', str, :r => r_index + 1) do
-        tmp = '' # time / memory tradeoff, lots of calls to rubyzip costs more
-                 # time..
-        each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, tmp) }
-        str << tmp
-      end
-    end
-
-    # Adds a single cell to the row based on the data provided and updates the worksheet's autofit data.
-    # @return [Cell]
-    def add_cell(value = '', options = {})
-      c = Cell.new(self, value, options)
-      self << c
-      worksheet.send(:update_column_info, self, [])
-      c
-    end
-
-    # sets the color for every cell in this row
-    def color=(color)
-      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
-    def style=(style)
-      each_with_index do | cell, index |
-        cell.style = style.is_a?(Array) ? style[index] : style
-      end
-    end
-
-    # @see height
-    def height=(v)
-      unless v.nil?
-        Axlsx::validate_unsigned_numeric(v)
-        @custom_height = true
-        @ht = v
-      end
-    end
-    
-    # return cells
-    def cells
-      self
-    end
-
-    private
-
-    # assigns the owning worksheet for this row
-    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.
-    # If value option is defined and is a symbol it is applied to all the cells created.
-    # If the value option is an array, cell types are applied by index for each cell
-    # If the style option is defined and is an Integer, it is applied to all cells created.
-    # If the style option is an array, style is applied by index for each cell.
-    # @option options [Array] values
-    # @option options [Array, Symbol] types
-    # @option options [Array, Integer] style
-    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[: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
+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
+  # @see Worksheet#add_row
+  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.
+    # 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
+    #   If the types option is not set, the cell will automatically determine its type.
+    #   If the style option is defined and is an Integer, it is applied to all cells created.
+    #   If the style option is an array, style is applied by index for each cell.
+    #   If the style option is not defined, the default style (0) is applied to each cell.
+    # @param [Worksheet] worksheet
+    # @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 = {})
+      self.worksheet = worksheet
+      super(Cell, nil, values.size + options[:offset].to_i)
+      self.height = options.delete(:height)
+      worksheet.rows << self
+      array_to_cells(values, options)
+    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
+
+    # The worksheet this row belongs to
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # Row height measured in point size. There is no margin padding on row height.
+    # @return [Float]
+    def height
+      defined?(@ht) ? @ht : nil
+    end
+
+    # Outlining level of the row, when outlining is on
+    # @return [Integer]
+    attr_reader :outline_level
+    alias :outlineLevel :outline_level
+
+    # The style applied to the row. This affects the entire row.
+    # @return [Integer]
+    attr_reader :s
+
+    # @see Row#s
+    def s=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @custom_format = true
+      @s = v
+    end
+
+    # @see Row#outline
+    def outline_level=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @outline_level = v
+    end
+
+    alias :outlineLevel= :outline_level=
+
+    # The index of this row in the worksheet
+    # @return [Integer]
+    def row_index
+      worksheet.rows.index(self)
+    end
+
+    # Serializes the row
+    # @param [Integer] r_index The row index, 0 based.
+    # @param [String] str The string this rows xml will be appended to.
+    # @return [String]
+    def to_xml_string(r_index, str = '')
+      serialized_tag('row', str, :r => r_index + 1) do
+        tmp = '' # time / memory tradeoff, lots of calls to rubyzip costs more
+                 # time..
+        each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, tmp) }
+        str << tmp
+      end
+    end
+
+    # Adds a single cell to the row based on the data provided and updates the worksheet's autofit data.
+    # @return [Cell]
+    def add_cell(value = '', options = {})
+      c = Cell.new(self, value, options)
+      self << c
+      worksheet.send(:update_column_info, self, [])
+      c
+    end
+
+    # Sets the color for every cell in this row.
+    def color=(color)
+      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.
+    def style=(style)
+      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?
+        Axlsx::validate_unsigned_numeric(v)
+        @custom_height = true
+        @ht = v
+      end
+    end
+
+    # return cells
+    def cells
+      self
+    end
+
+    private
+
+    # assigns the owning worksheet for this row
+    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.
+    # If value option is defined and is a symbol it is applied to all the cells created.
+    # If the value option is an array, cell types are applied by index for each cell
+    # If the style option is defined and is an Integer, it is applied to all cells created.
+    # If the style option is an array, style is applied by index for each cell.
+    # @option options [Array] values
+    # @option options [Array, Symbol] types
+    # @option options [Array, Integer] style
+    # @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 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,33 +1,32 @@
-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
-
-    # Adds a row break
-    # @param [Hash] options The options for the break to be created.
-    # max and man values are fixed.
-    # @see Break
-    def add_break(options)
-      # force feed the excel default
-      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='')
-      return if empty?
-      str << ('<rowBreaks count="' << self.size.to_s << '" manualBreakCount="' << self.size.to_s << '">')
-      each { |brk| brk.to_xml_string(str) }
-      str << '</rowBreaks>'
-    end
-  end
-end
+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
+
+    # Adds a row break
+    # @param [Hash] options The options for the break to be created.
+    # max and man values are fixed.
+    # @see Break
+    def add_break(options)
+      # force feed the excel default
+      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 = '')
+      return if empty?
+
+      str << ('<rowBreaks count="' << self.size.to_s << '" manualBreakCount="' << self.size.to_s << '">')
+      each { |brk| brk.to_xml_string(str) }
+      str << '</rowBreaks>'
+    end
+  end
+end

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

@@ -1,101 +1,99 @@
-# 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
-
-    # 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.
-    # Therefore, this value needs to be aware of the order in which the range references are
-    # written in sqref.
-    # When this value is out of range then activeCell can be used.
-    # @see type
-    # @return [Integer]
-    # default nil
-    attr_reader :active_cell_id
-
-    # Pane
-    # The pane to which this selection belongs.
-    # 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 
-    #                  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 
-    #                  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
-    #                  been applied, dividing the pane into right and left
-    #                  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 
-    #                  specifies the right pane.
-    # @see type
-    # @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
-
-    # @see active_cell
-    def active_cell=(v)
-      cell = (v.class == Axlsx::Cell ? v.r_abs : v)
-      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 = 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 = '')
-      serialized_tag 'selection', str
-    end
-  end
-end
+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
+
+    # 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.
+    # Therefore, this value needs to be aware of the order in which the range references are
+    # written in sqref.
+    # When this value is out of range then activeCell can be used.
+    # @see type
+    # @return [Integer]
+    # default nil
+    attr_reader :active_cell_id
+
+    # Pane
+    # The pane to which this selection belongs.
+    # 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
+    #                  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
+    #                  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
+    #                  been applied, dividing the pane into right and left
+    #                  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
+    #                  specifies the right pane.
+    # @see type
+    # @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
+
+    # @see active_cell
+    def active_cell=(v)
+      cell = (v.class == Axlsx::Cell ? v.r_abs : v)
+      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 = 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 = '')
+      serialized_tag 'selection', str
+    end
+  end
+end