caxlsx 4.0.0 → 4.2.0

data/lib/axlsx/workbook/worksheet/auto_filter/sort_state.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'axlsx/workbook/worksheet/auto_filter/sort_condition'
+require_relative 'sort_condition'
 
 module Axlsx
   # This class performs sorting on a range in a worksheet
@@ -21,7 +21,7 @@ module Axlsx
     # It requires a column_index for the sorting, descending and the custom order are optional.
     # @param [Integer] column_index Zero-based index indicating the AutoFilter column to which the sorting should be applied to
     # @param [Symbol] order The order the column should be sorted on, can only be :asc or :desc
-    # @param [Array] custom_list An array containg a custom sorting list in order.
+    # @param [Array] custom_list An array containing a custom sorting list in order.
     # @return [SortCondition]
     def add_sort_condition(column_index:, order: :asc, custom_list: [])
       sort_conditions << SortCondition.new(column_index: column_index, order: order, custom_list: custom_list)

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

@@ -63,19 +63,19 @@ module Axlsx
     end
 
     def first_row
-      @first_row ||= first_cell.scan(/\d+/).first
+      @first_row ||= first_cell[/\d+/]
     end
 
     def first_col
-      @first_col ||= first_cell.scan(/\D+/).first
+      @first_col ||= first_cell[/\D+/]
     end
 
     def last_row
-      @last_row ||= last_cell.scan(/\d+/).first
+      @last_row ||= last_cell[/\d+/]
     end
 
     def last_col
-      @last_col ||= last_cell.scan(/\D+/).first
+      @last_col ||= last_cell[/\D+/]
     end
   end
 end

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

@@ -2,7 +2,7 @@
 
 module Axlsx
   # A cell in a worksheet.
-  # Cell stores inforamation requried to serialize a single worksheet cell to xml. You must provde the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you do not supply the :style option. Changing the cell's type will recast the value to the type specified. Altering the cell's value via the property accessor will also automatically cast the provided value to the cell's type.
+  # Cell stores information required to serialize a single worksheet cell to xml. You must provide the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you do not supply the :style option. Changing the cell's type will recast the value to the type specified. Altering the cell's value via the property accessor will also automatically cast the provided value to the cell's type.
   # @note The recommended way to generate cells is via Worksheet#add_row
   #
   # @see Worksheet#add_row
@@ -41,7 +41,7 @@ module Axlsx
       self.type = type unless type == :string
 
       val = options.delete(:style)
-      self.style = val unless val.nil? || val.zero?
+      self.style = val unless val.nil? || val == 0
       val = options.delete(:formula_value)
       self.formula_value = val unless val.nil?
       val = options.delete(:escape_formulas)
@@ -57,11 +57,11 @@ module Axlsx
     # you need to set this.
     attr_accessor :formula_value
 
-    # An array of available inline styes.
+    # An array of available inline styles.
     # TODO change this to a hash where each key defines attr name and validator (and any info the validator requires)
-    # then move it out to a module so we can re-use in in other classes.
+    # then move it out to a module so we can reuse in in other classes.
     # needs to define bla=(v) and bla methods on the class that hook into a
-    # set_attr method that kicks the suplied validator and updates the instance_variable
+    # set_attr method that kicks the supplied validator and updates the instance_variable
     # for the key
     INLINE_STYLES = [:value, :type, :font_name, :charset,
                      :family, :b, :i, :strike, :outline,
@@ -189,7 +189,9 @@ module Axlsx
     attr_reader :font_name
 
     # @see font_name
-    def font_name=(v) set_run_style :validate_string, :font_name, v; end
+    def font_name=(v)
+      set_run_style :validate_string, :font_name, v
+    end
 
     # The inline charset property for the cell
     # As far as I can tell, this is pretty much ignored. However, based on the spec it should be one of the following:
@@ -216,7 +218,9 @@ module Axlsx
     attr_reader :charset
 
     # @see charset
-    def charset=(v) set_run_style :validate_unsigned_int, :charset, v; end
+    def charset=(v)
+      set_run_style :validate_unsigned_int, :charset, v
+    end
 
     # The inline family property for the cell
     # @return [Integer]
@@ -237,49 +241,63 @@ module Axlsx
     attr_reader :b
 
     # @see b
-    def b=(v) set_run_style :validate_boolean, :b, v; end
+    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
+    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
+    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
+    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
+    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
+    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
+    def extend=(v)
+      set_run_style :validate_boolean, :extend, v
+    end
 
     # The inline underline property for the cell.
     # It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting
@@ -307,7 +325,9 @@ module Axlsx
     attr_reader :sz
 
     # @see sz
-    def sz=(v) set_run_style :validate_unsigned_int, :sz, v; end
+    def sz=(v)
+      set_run_style :validate_unsigned_int, :sz, v
+    end
 
     # The inline vertical alignment property for the cell
     # this must be one of [:baseline, :subscript, :superscript]
@@ -529,14 +549,14 @@ module Axlsx
 
       case type
       when :date
-        self.style = STYLE_DATE if style.zero?
+        self.style = STYLE_DATE if style == 0
         if !v.is_a?(Date) && v.respond_to?(:to_date)
           v.to_date
         else
           v
         end
       when :time
-        self.style = STYLE_DATE if style.zero?
+        self.style = STYLE_DATE if style == 0
         if !v.is_a?(Time) && v.respond_to?(:to_time)
           v.to_time
         else

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

@@ -7,7 +7,7 @@ module Axlsx
       # Calls the proper serialization method based on type.
       # @param [Integer] row_index The index of the cell's row
       # @param [Integer] column_index The index of the cell's column
-      # @param [String] str The string to apend serialization to.
+      # @param [String] str The string to append serialization to.
       # @return [String]
       def to_xml_string(row_index, column_index, cell, str = +'')
         str << '<c r="'

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

@@ -40,10 +40,16 @@ module Axlsx
     attr_reader :val
 
     # @see type
-    def type=(v); Axlsx.validate_conditional_formatting_value_object_type(v); @type = v end
+    def type=(v)
+      Axlsx.validate_conditional_formatting_value_object_type(v)
+      @type = v
+    end
 
     # @see gte
-    def gte=(v); Axlsx.validate_boolean(v); @gte = v end
+    def gte=(v)
+      Axlsx.validate_boolean(v)
+      @gte = v
+    end
 
     # @see val
     def val=(v)

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

@@ -110,7 +110,7 @@ module Axlsx
     def width=(v)
       # Removing this validation make a 10% difference in performance
       # as it is called EVERY TIME A CELL IS ADDED - the proper solution
-      # is to only set this if a calculated value is greated than the
+      # is to only set this if a calculated value is greater than the
       # current @width value.
       # TODO!!!
       # Axlsx.validate_unsigned_numeric(v) unless v == nil
@@ -121,17 +121,30 @@ module Axlsx
     # updates the width for this col based on the cells autowidth and
     # an optionally specified fixed width
     # @param [Cell] cell The cell to use in updating this col's width
-    # @param [Integer] fixed_width If this is specified the width is set
-    # to this value and the cell's attributes are ignored.
+    # @param [Numeric, :auto, :ignore, nil] fixed_width Decides how the width
+    # of the cell should be updated. If this is specified as as Numeric the
+    # width is set to this value and the cell's attributes are ignored. If set
+    # to `nil` or `:auto` and `use_autowidth` is true, it uses the autowidth of
+    # the cell. If set to `:ignore`, the cell's width is not changed. In any
+    # case the col's width is set to the new value only if the current width is
+    # smaller than the new one, so that the largest width of all cells in this
+    # column is used.
     # @param [Boolean] use_autowidth If this is false, the cell's
     # autowidth value will be ignored.
     def update_width(cell, fixed_width = nil, use_autowidth = true)
-      if fixed_width.is_a? Numeric
-        self.width = fixed_width
-      elsif use_autowidth
-        cell_width = cell.autowidth
-        self.width = cell_width unless (width || 0) > (cell_width || 0)
-      end
+      cell_width =
+        case fixed_width
+        when Numeric
+          fixed_width
+        when nil, :auto
+          cell.autowidth if use_autowidth
+        when :ignore
+          nil
+        else
+          raise ArgumentError, "fixed_with must be a Numeric, :auto, :ignore or nil, but is '#{fixed_width.inspect}'"
+        end
+
+      self.width = cell_width unless (width || 0) > (cell_width || 0)
     end
 
     # Serialize this columns data to an xml string

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

@@ -7,7 +7,7 @@ module Axlsx
   class ColBreaks < SimpleTypedList
     # Instantiates a new list restricted to Break types
     def initialize
-      super Break
+      super(Break)
     end
 
     # A column break specific helper for adding a break.

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

@@ -7,7 +7,7 @@ module Axlsx
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
 
-      super Col
+      super(Col)
       @worksheet = worksheet
     end
 

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

@@ -11,8 +11,8 @@ module Axlsx
     # @param [Hash] options
     # @option [String] author the author of the comment
     # @option [String] text The text for the comment
-    # @option [String] ref The refence (e.g. 'A3' where this comment will be anchored.
-    # @option [Boolean] visible This controls the visiblity of the associated vml_shape.
+    # @option [String] ref The reference (e.g. 'A3' where this comment will be anchored.
+    # @option [Boolean] visible This controls the visibility of the associated vml_shape.
     def initialize(comments, options = {})
       raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
 

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

@@ -37,7 +37,7 @@ module Axlsx
     # @note the author, text and ref options are required
     # @option options [String] author The name of the author for this comment
     # @option options [String] text The text for this comment
-    # @option options [Stirng|Cell] ref The cell that this comment is attached to.
+    # @option options [String|Cell] ref The cell that this comment is attached to.
     def add_comment(options = {})
       raise ArgumentError, "Comment require an author" unless options[:author]
       raise ArgumentError, "Comment requires text" unless options[:text]

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

@@ -61,9 +61,15 @@ module Axlsx
     end
 
     # @see rules
-    def rules=(v); @rules = v end
+    def rules=(v)
+      @rules = v
+    end
+
     # @see sqref
-    def sqref=(v); Axlsx.validate_string(v); @sqref = v end
+    def sqref=(v)
+      Axlsx.validate_string(v)
+      @sqref = v
+    end
 
     # Serializes the conditional formatting element
     # @example Conditional Formatting XML looks like:
@@ -77,7 +83,7 @@ module Axlsx
     def to_xml_string(str = +'')
       str << '<conditionalFormatting sqref="' << sqref << '">'
       rules.each_with_index do |rule, index|
-        str << ' ' unless index.zero?
+        str << ' ' unless index == 0
         rule.to_xml_string(str)
       end
       str << '</conditionalFormatting>'

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

@@ -24,7 +24,7 @@ module Axlsx
     # @option options [Integer] rank If a top/bottom N rule, the value of N
     # @option options [Integer] stdDev The number of standard deviations above or below the average to match
     # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
-    # @option options [Symbol]  timePeriod The time period in a date occuring... rule
+    # @option options [Symbol]  timePeriod The time period in a date occurring... rule
     # @option options [String] formula The formula to match against in i.e. an equal rule. Use a [minimum, maximum] array for cellIs between/notBetween conditionals.
     def initialize(options = {})
       @color_scale = @data_bar = @icon_set = @formula = nil
@@ -155,33 +155,88 @@ module Axlsx
     end
 
     # @see type
-    def type=(v); Axlsx.validate_conditional_formatting_type(v); @type = v end
+    def type=(v)
+      Axlsx.validate_conditional_formatting_type(v)
+      @type = v
+    end
+
     # @see aboveAverage
-    def aboveAverage=(v); Axlsx.validate_boolean(v); @aboveAverage = v end
+    def aboveAverage=(v)
+      Axlsx.validate_boolean(v)
+      @aboveAverage = v
+    end
+
     # @see bottom
-    def bottom=(v); Axlsx.validate_boolean(v); @bottom = v end
+    def bottom=(v)
+      Axlsx.validate_boolean(v)
+      @bottom = v
+    end
+
     # @see dxfId
-    def dxfId=(v); Axlsx.validate_unsigned_numeric(v); @dxfId = v end
+    def dxfId=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @dxfId = v
+    end
+
     # @see equalAverage
-    def equalAverage=(v); Axlsx.validate_boolean(v); @equalAverage = v end
+    def equalAverage=(v)
+      Axlsx.validate_boolean(v)
+      @equalAverage = v
+    end
+
     # @see priority
-    def priority=(v); Axlsx.validate_unsigned_numeric(v); @priority = v end
+    def priority=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @priority = v
+    end
+
     # @see operator
-    def operator=(v); Axlsx.validate_conditional_formatting_operator(v); @operator = v end
+    def operator=(v)
+      Axlsx.validate_conditional_formatting_operator(v)
+      @operator = v
+    end
+
     # @see text
-    def text=(v); Axlsx.validate_string(v); @text = v end
+    def text=(v)
+      Axlsx.validate_string(v)
+      @text = v
+    end
+
     # @see percent
-    def percent=(v); Axlsx.validate_boolean(v); @percent = v end
+    def percent=(v)
+      Axlsx.validate_boolean(v)
+      @percent = v
+    end
+
     # @see rank
-    def rank=(v); Axlsx.validate_unsigned_numeric(v); @rank = v end
+    def rank=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @rank = v
+    end
+
     # @see stdDev
-    def stdDev=(v); Axlsx.validate_unsigned_numeric(v); @stdDev = v end
+    def stdDev=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @stdDev = v
+    end
+
     # @see stopIfTrue
-    def stopIfTrue=(v); Axlsx.validate_boolean(v); @stopIfTrue = v end
+    def stopIfTrue=(v)
+      Axlsx.validate_boolean(v)
+      @stopIfTrue = v
+    end
+
     # @see timePeriod
-    def timePeriod=(v); Axlsx.validate_time_period_type(v); @timePeriod = v end
+    def timePeriod=(v)
+      Axlsx.validate_time_period_type(v)
+      @timePeriod = v
+    end
+
     # @see formula
-    def formula=(v); [*v].each { |x| Axlsx.validate_string(x) }; @formula = [*v].map { |form| ::CGI.escapeHTML(form) } end
+    def formula=(v)
+      [*v].each { |x| Axlsx.validate_string(x) }
+      @formula = [*v].map { |form| ::CGI.escapeHTML(form) }
+    end
 
     # @see color_scale
     def color_scale=(v)

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # A simple, self serializing class for storing conditional formattings
+  # A simple, self serializing class for storing conditional formatting
   class ConditionalFormattings < SimpleTypedList
     # creates a new Tables object
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
 
-      super ConditionalFormatting
+      super(ConditionalFormatting)
       @worksheet = worksheet
     end
 
@@ -15,7 +15,7 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
-    # serialize the conditional formattings
+    # serialize the conditional formatting
     def to_xml_string(str = +'')
       return if empty?
 

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

@@ -178,31 +178,58 @@ module Axlsx
     attr_reader :type
 
     # @see formula1
-    def formula1=(v); Axlsx.validate_string(v); @formula1 = v end
+    def formula1=(v)
+      Axlsx.validate_string(v)
+      @formula1 = v
+    end
 
     # @see formula2
-    def formula2=(v); Axlsx.validate_string(v); @formula2 = v end
+    def formula2=(v)
+      Axlsx.validate_string(v)
+      @formula2 = v
+    end
 
     # @see allowBlank
-    def allowBlank=(v); Axlsx.validate_boolean(v); @allowBlank = v end
+    def allowBlank=(v)
+      Axlsx.validate_boolean(v)
+      @allowBlank = v
+    end
 
     # @see error
-    def error=(v); Axlsx.validate_string(v); @error = v end
+    def error=(v)
+      Axlsx.validate_string(v)
+      @error = v
+    end
 
     # @see errorStyle
-    def errorStyle=(v); Axlsx.validate_data_validation_error_style(v); @errorStyle = v end
+    def errorStyle=(v)
+      Axlsx.validate_data_validation_error_style(v)
+      @errorStyle = v
+    end
 
     # @see errorTitle
-    def errorTitle=(v); Axlsx.validate_string(v); @errorTitle = v end
+    def errorTitle=(v)
+      Axlsx.validate_string(v)
+      @errorTitle = v
+    end
 
     # @see operator
-    def operator=(v); Axlsx.validate_data_validation_operator(v); @operator = v end
+    def operator=(v)
+      Axlsx.validate_data_validation_operator(v)
+      @operator = v
+    end
 
     # @see prompt
-    def prompt=(v); Axlsx.validate_string(v); @prompt = v end
+    def prompt=(v)
+      Axlsx.validate_string(v)
+      @prompt = v
+    end
 
     # @see promptTitle
-    def promptTitle=(v); Axlsx.validate_string(v); @promptTitle = v end
+    def promptTitle=(v)
+      Axlsx.validate_string(v)
+      @promptTitle = v
+    end
 
     # @see showDropDown
     def showDropDown=(v)
@@ -219,16 +246,28 @@ module Axlsx
     end
 
     # @see showErrorMessage
-    def showErrorMessage=(v); Axlsx.validate_boolean(v); @showErrorMessage = v end
+    def showErrorMessage=(v)
+      Axlsx.validate_boolean(v)
+      @showErrorMessage = v
+    end
 
     # @see showInputMessage
-    def showInputMessage=(v); Axlsx.validate_boolean(v); @showInputMessage = v end
+    def showInputMessage=(v)
+      Axlsx.validate_boolean(v)
+      @showInputMessage = v
+    end
 
     # @see sqref
-    def sqref=(v); Axlsx.validate_string(v); @sqref = v end
+    def sqref=(v)
+      Axlsx.validate_string(v)
+      @sqref = v
+    end
 
     # @see type
-    def type=(v); Axlsx.validate_data_validation_type(v); @type = v end
+    def type=(v)
+      Axlsx.validate_data_validation_type(v)
+      @type = v
+    end
 
     # Serializes the data validation
     # @param [String] str
@@ -239,7 +278,7 @@ module Axlsx
 
       str << '<dataValidation '
       h.each_with_index do |key_value, index|
-        str << ' ' unless index.zero?
+        str << ' ' unless index == 0
         str << key_value.first << '="' << Axlsx.booleanize(key_value.last).to_s << '"'
       end
       str << '>'

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # A simple, self serializing class for storing conditional formattings
+  # A simple, self serializing class for storing conditional formatting
   class DataValidations < SimpleTypedList
     # creates a new Tables object
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
 
-      super DataValidation
+      super(DataValidation)
       @worksheet = worksheet
     end
 
@@ -15,7 +15,7 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
-    # serialize the conditional formattings
+    # serialize the conditional formatting
     def to_xml_string(str = +'')
       return if empty?
 

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

@@ -3,9 +3,9 @@
 require "date"
 
 module Axlsx
-  # The DateTimeConverter class converts both data and time types to their apprpriate Excel serializations
+  # The DateTimeConverter class converts both data and time types to their appropriate Excel serializations
   class DateTimeConverter
-    # The date_to_serial method converts Date objects to the equivelant Excel serialized forms
+    # The date_to_serial method converts Date objects to the equivalent Excel serialized forms
     # @param [Date] date the date to be serialized
     # @return [Numeric]
     def self.date_to_serial(date)

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

@@ -28,7 +28,7 @@ module Axlsx
 
     attr_reader :worksheet
 
-    # the full refernece for this dimension
+    # the full reference for this dimension
     # @return [String]
     def sqref
       "#{first_cell_reference}:#{last_cell_reference}"