write_xlsx 1.09.3 → 1.11.2

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -6,27 +6,26 @@ module Writexlsx
     class CellData   # :nodoc:
       include Writexlsx::Utility
 
-      attr_reader :row, :col, :token, :xf
-      attr_reader :result, :range, :link_type, :url, :tip
+      attr_reader :xf
 
       #
       # attributes for the <cell> element. This is the innermost loop so efficiency is
       # important where possible.
       #
-      def cell_attributes #:nodoc:
+      def cell_attributes(worksheet, row, row_name, col) # :nodoc:
         xf_index = xf ? xf.get_xf_index : 0
         attributes = [
-          ['r', xl_rowcol_to_cell(row, col)]
+          ['r', xl_rowcol_to_cell(row_name, col)]
         ]
 
         # Add the cell format index.
         if xf_index != 0
           attributes << ['s', xf_index]
-        elsif @worksheet.set_rows[row] && @worksheet.set_rows[row][1]
-          row_xf = @worksheet.set_rows[row][1]
+        elsif worksheet.set_rows[row] && worksheet.set_rows[row][1]
+          row_xf = worksheet.set_rows[row][1]
           attributes << ['s', row_xf.get_xf_index]
-        elsif @worksheet.col_formats[col]
-          col_xf = @worksheet.col_formats[col]
+        elsif worksheet.col_info[col] && worksheet.col_info[col].format
+          col_xf = worksheet.col_info[col].format
           attributes << ['s', col_xf.get_xf_index]
         end
         attributes
@@ -38,38 +37,43 @@ module Writexlsx
     end
 
     class NumberCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, num, xf)
-        @worksheet = worksheet
-        @row, @col, @token, @xf = row, col, num, xf
+      attr_reader :token
+
+      def initialize(num, xf)
+        @token = num
+        @xf = xf
       end
 
       def data
         @token
       end
 
-      def write_cell
-        @worksheet.writer.tag_elements('c', cell_attributes) do
-          @worksheet.write_cell_value(token)
+      def write_cell(worksheet, row, row_name, col)
+        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, row_name, col)) do
+          worksheet.write_cell_value(token)
         end
       end
     end
 
     class StringCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, index, xf)
-        @worksheet = worksheet
-        @row, @col, @token, @xf = row, col, index, xf
+      attr_reader :token, :raw_string
+
+      def initialize(index, xf, raw_string)
+        @token = index
+        @xf = xf
+        @raw_string = raw_string
       end
 
       def data
-        { :sst_id => token }
+        { sst_id: token }
       end
 
-      TYPE_STR_ATTRS = ['t', 's'].freeze
-      def write_cell
-        attributes = cell_attributes
+      TYPE_STR_ATTRS = %w[t s].freeze
+      def write_cell(worksheet, row, row_name, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
         attributes << TYPE_STR_ATTRS
-        @worksheet.writer.tag_elements('c', attributes) do
-          @worksheet.write_cell_value(token)
+        worksheet.writer.tag_elements('c', attributes) do
+          worksheet.write_cell_value(token)
         end
       end
 
@@ -78,111 +82,128 @@ module Writexlsx
       end
     end
 
+    class RichStringCellData < StringCellData # :nodoc:
+    end
+
+    class DateTimeCellData < NumberCellData # :nodoc:
+    end
+
     class FormulaCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, formula, xf, result)
-        @worksheet = worksheet
-        @row, @col, @token, @xf, @result = row, col, formula, xf, result
+      attr_reader :token, :result, :range, :link_type, :url
+
+      def initialize(formula, xf, result)
+        @token = formula
+        @xf = xf
+        @result = result
       end
 
       def data
         @result || 0
       end
 
-      def write_cell
-        truefalse = {'TRUE' => 1, 'FALSE' => 0}
+      def write_cell(worksheet, row, row_name, col)
+        truefalse = { 'TRUE' => 1, 'FALSE' => 0 }
         error_code = ['#DIV/0!', '#N/A', '#NAME?', '#NULL!', '#NUM!', '#REF!', '#VALUE!']
 
-        attributes = cell_attributes
-        if @result &&  !(@result.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
+        attributes = cell_attributes(worksheet, row, row_name, col)
+        if @result && !(@result.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
           if truefalse[@result]
-            attributes << ['t', 'b']
+            attributes << %w[t b]
             @result = truefalse[@result]
           elsif error_code.include?(@result)
-            attributes << ['t', 'e']
+            attributes << %w[t e]
           else
-            attributes << ['t', 'str']
+            attributes << %w[t str]
           end
         end
-        @worksheet.writer.tag_elements('c', attributes) do
-          @worksheet.write_cell_formula(token)
-          @worksheet.write_cell_value(result || 0)
+        worksheet.writer.tag_elements('c', attributes) do
+          worksheet.write_cell_formula(token)
+          worksheet.write_cell_value(result || 0)
         end
       end
     end
 
     class FormulaArrayCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, formula, xf, range, result)
-        @worksheet = worksheet
-        @row, @col, @token, @xf, @range, @result = row, col, formula, xf, range, result
+      attr_reader :token, :result, :range, :link_type, :url
+
+      def initialize(formula, xf, range, result)
+        @token = formula
+        @xf = xf
+        @range = range
+        @result = result
       end
 
       def data
         @result || 0
       end
 
-      def write_cell
-        @worksheet.writer.tag_elements('c', cell_attributes) do
-          @worksheet.write_cell_array_formula(token, range)
-          @worksheet.write_cell_value(result)
+      def write_cell(worksheet, row, row_name, col)
+        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, row_name, col)) do
+          worksheet.write_cell_array_formula(token, range)
+          worksheet.write_cell_value(result)
         end
       end
     end
 
     class DynamicFormulaArrayCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, formula, xf, range, result)
-        @worksheet = worksheet
-        @row, @col, @token, @xf, @range, @result = row, col, formula, xf, range, result
+      attr_reader :token, :result, :range, :link_type, :url
+
+      def initialize(formula, xf, range, result)
+        @token = formula
+        @xf = xf
+        @range = range
+        @result = result
       end
 
       def data
         @result || 0
       end
 
-      def write_cell
+      def write_cell(worksheet, row, row_name, col)
         # Add metadata linkage for dynamic array formulas.
-        attributes = cell_attributes
-        attributes << ['cm', '1']
+        attributes = cell_attributes(worksheet, row, row_name, col)
+        attributes << %w[cm 1]
 
-        @worksheet.writer.tag_elements('c', attributes) do
-          @worksheet.write_cell_array_formula(token, range)
-          @worksheet.write_cell_value(result)
+        worksheet.writer.tag_elements('c', attributes) do
+          worksheet.write_cell_array_formula(token, range)
+          worksheet.write_cell_value(result)
         end
       end
     end
 
     class BooleanCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, val, xf)
-        @worksheet = worksheet
-        @row, @col, @token, @xf = row, col, val, xf
+      attr_reader :token
+
+      def initialize(val, xf)
+        @token = val
+        @xf = xf
       end
 
       def data
         @token
       end
 
-      def write_cell
-        attributes = cell_attributes
+      def write_cell(worksheet, row, row_name, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
 
-        attributes << ['t', 'b']
-        @worksheet.writer.tag_elements('c', attributes) do
-          @worksheet.write_cell_value(token)
+        attributes << %w[t b]
+        worksheet.writer.tag_elements('c', attributes) do
+          worksheet.write_cell_value(token)
         end
       end
     end
 
-
     class BlankCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, xf)
-        @worksheet = worksheet
-        @row, @col, @xf = row, col, xf
+      def initialize(xf)
+        @xf = xf
       end
 
       def data
         ''
       end
 
-      def write_cell
-        @worksheet.writer.empty_tag('c', cell_attributes)
+      def write_cell(worksheet, row, row_name, col)
+        worksheet.writer.empty_tag('c', cell_attributes(worksheet, row, row_name, col))
       end
     end
   end

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Worksheet
@@ -12,16 +13,30 @@ module Writexlsx
 
       def initialize(*args)
         # Check for a cell reference in A1 notation and substitute row and column.
-        row1, col1, row2, col2, options = row_col_notation(args)
+        if (row_col_array = row_col_notation(args.first))
+          case row_col_array.size
+          when 2
+            row1, col1 = row_col_array
+            row2, col2, options = args[1..-1]
+          when 4
+            row1, col1, row2, col2 = row_col_array
+            options = args[1]
+          end
+        else
+          row1, col1, row2, col2, options = args
+        end
+
         if row2.respond_to?(:keys)
           options_to_instance_variable(row2.dup)
-          row2, col2 = row1, col1
+          row2 = row1
+          col2 = col1
         elsif options.respond_to?(:keys)
           options_to_instance_variable(options.dup)
         else
           raise WriteXLSXInsufficientArgumentError
         end
         raise WriteXLSXInsufficientArgumentError if [row1, col1, row2, col2].include?(nil)
+
         check_for_valid_input_params
 
         check_dimensions(row1, col1)
@@ -42,7 +57,7 @@ module Writexlsx
 
         # The any, list and custom validations don't have a criteria
         # so we use a default of 'between'
-        if ['none', 'list', 'custom'].include?(@validate)
+        if %w[none list custom].include?(@validate)
           @criteria  = 'between'
           @maximum   = nil
         end
@@ -56,13 +71,10 @@ module Writexlsx
 
         convert_date_time_value_if_required
         # Check that the input title doesn't exceed the maximum length.
-        if @input_title && @input_title.length > 32
-          raise "Length of input title '#{@input_title}' exceeds Excel's limit of 32"
-        end
+        raise "Length of input title '#{@input_title}' exceeds Excel's limit of 32" if @input_title && @input_title.length > 32
         # Check that the input message doesn't exceed the maximum length.
-        if @input_message && @input_message.length > 255
-          raise "Length of input message '#{@input_message}' exceeds Excel's limit of 255"
-        end
+        raise "Length of input message '#{@input_message}' exceeds Excel's limit of 255" if @input_message && @input_message.length > 255
+
         set_some_defaults
 
         # A (for now) undocumented parameter to pass additional cell ranges.
@@ -76,7 +88,7 @@ module Writexlsx
       end
 
       def keys
-        self.instance_variables.collect { |v| v.to_s.sub(/@/, '').to_sym }
+        instance_variables.collect { |v| v.to_s.sub(/@/, '').to_sym }
       end
 
       def validate_none?
@@ -86,7 +98,7 @@ module Writexlsx
       #
       # Write the <dataValidation> element.
       #
-      def write_data_validation(writer) #:nodoc:
+      def write_data_validation(writer) # :nodoc:
         @writer = writer
         if @validate == 'none'
           @writer.empty_tag('dataValidation', attributes)
@@ -105,9 +117,9 @@ module Writexlsx
       #
       # Write the <formula1> element.
       #
-      def write_formula_1(formula) #:nodoc:
+      def write_formula_1(formula) # :nodoc:
         # Convert a list array ref into a comma separated string.
-        formula   = %!"#{formula.join(',')}"! if formula.kind_of?(Array)
+        formula   = %("#{formula.join(",")}") if formula.is_a?(Array)
 
         formula = formula.sub(/^=/, '') if formula.respond_to?(:sub)
 
@@ -117,7 +129,7 @@ module Writexlsx
       #
       # Write the <formula2> element.
       #
-      def write_formula_2(formula) #:nodoc:
+      def write_formula_2(formula) # :nodoc:
         formula = formula.sub(/^=/, '') if formula.respond_to?(:sub)
 
         @writer.data_element('formula2', formula)
@@ -147,8 +159,8 @@ module Writexlsx
         end
 
         if @error_type
-          attributes << ['errorStyle', 'warning'] if @error_type == 1
-          attributes << ['errorStyle', 'information'] if @error_type == 2
+          attributes << %w[errorStyle warning] if @error_type == 1
+          attributes << %w[errorStyle information] if @error_type == 2
         end
         attributes << ['allowBlank',       1] if @ignore_blank != 0
         attributes << ['showDropDown',     1] if @dropdown     == 0
@@ -176,9 +188,8 @@ module Writexlsx
       def check_for_valid_input_params
         check_parameter(self, valid_validation_parameter, 'data_validation')
 
-        unless has_key?(:validate)
-          raise WriteXLSXOptionParameterError, "Parameter :validate is required in data_validation()"
-        end
+        raise WriteXLSXOptionParameterError, "Parameter :validate is required in data_validation()" unless has_key?(:validate)
+
         unless valid_validation_type.has_key?(@validate.downcase)
           raise WriteXLSXOptionParameterError,
                 "Unknown validation type '#{@validate}' for parameter :validate in data_validation()"
@@ -190,9 +201,7 @@ module Writexlsx
       end
 
       def check_criteria_required
-        unless has_key?(:criteria)
-          raise WriteXLSXOptionParameterError, "Parameter :criteria is required in data_validation()"
-        end
+        raise WriteXLSXOptionParameterError, "Parameter :criteria is required in data_validation()" unless has_key?(:criteria)
       end
 
       def check_maximum_value_when_criteria_is_between_or_notbetween
@@ -216,81 +225,77 @@ module Writexlsx
       def convert_date_time_value_if_required
         if @validate == 'date' || @validate == 'time'
           date_time = convert_date_time(@value)
-          if date_time
-            @value = date_time
-          end
+          @value = date_time if date_time
 
           if @maximum
             date_time = convert_date_time(@maximum)
-            if date_time
-              @maximum = date_time
-            end
+            @maximum = date_time if date_time
           end
         end
       end
 
       def error_type_hash
-        {'stop' => 0, 'warning' => 1, 'information' => 2}
+        { 'stop' => 0, 'warning' => 1, 'information' => 2 }
       end
 
       def valid_validation_type # :nodoc:
         {
-          'any'             => 'none',
-          'any value'       => 'none',
-          'whole number'    => 'whole',
-          'whole'           => 'whole',
-          'integer'         => 'whole',
-          'decimal'         => 'decimal',
-          'list'            => 'list',
-          'date'            => 'date',
-          'time'            => 'time',
-          'text length'     => 'textLength',
-          'length'          => 'textLength',
-          'custom'          => 'custom'
+          'any'          => 'none',
+          'any value'    => 'none',
+          'whole number' => 'whole',
+          'whole'        => 'whole',
+          'integer'      => 'whole',
+          'decimal'      => 'decimal',
+          'list'         => 'list',
+          'date'         => 'date',
+          'time'         => 'time',
+          'text length'  => 'textLength',
+          'length'       => 'textLength',
+          'custom'       => 'custom'
         }
       end
 
       # List of valid input parameters.
       def valid_validation_parameter
-        [
-          :validate,
-          :criteria,
-          :value,
-          :source,
-          :minimum,
-          :maximum,
-          :ignore_blank,
-          :dropdown,
-          :show_input,
-          :input_title,
-          :input_message,
-          :show_error,
-          :error_title,
-          :error_message,
-          :error_type,
-          :other_cells
+        %i[
+          validate
+          criteria
+          value
+          source
+          minimum
+          maximum
+          ignore_blank
+          dropdown
+          show_input
+          input_title
+          input_message
+          show_error
+          error_title
+          error_message
+          error_type
+          other_cells
         ]
       end
 
       # List of valid criteria types.
       def valid_criteria_type  # :nodoc:
         {
-          'between'                     => 'between',
-          'not between'                 => 'notBetween',
-          'equal to'                    => 'equal',
-          '='                           => 'equal',
-          '=='                          => 'equal',
-          'not equal to'                => 'notEqual',
-          '!='                          => 'notEqual',
-          '<>'                          => 'notEqual',
-          'greater than'                => 'greaterThan',
-          '>'                           => 'greaterThan',
-          'less than'                   => 'lessThan',
-          '<'                           => 'lessThan',
-          'greater than or equal to'    => 'greaterThanOrEqual',
-          '>='                          => 'greaterThanOrEqual',
-          'less than or equal to'       => 'lessThanOrEqual',
-          '<='                          => 'lessThanOrEqual'
+          'between'                  => 'between',
+          'not between'              => 'notBetween',
+          'equal to'                 => 'equal',
+          '='                        => 'equal',
+          '=='                       => 'equal',
+          'not equal to'             => 'notEqual',
+          '!='                       => 'notEqual',
+          '<>'                       => 'notEqual',
+          'greater than'             => 'greaterThan',
+          '>'                        => 'greaterThan',
+          'less than'                => 'lessThan',
+          '<'                        => 'lessThan',
+          'greater than or equal to' => 'greaterThanOrEqual',
+          '>='                       => 'greaterThanOrEqual',
+          'less than or equal to'    => 'lessThanOrEqual',
+          '<='                       => 'lessThanOrEqual'
         }
       end
 

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Worksheet
@@ -27,15 +28,13 @@ module Writexlsx
         normalized_str = str.sub(/^mailto:/, '')
 
         # Split url into the link and optional anchor/location.
-        url, @url_str = url.split(/#/, 2)
+        url, @url_str = url.split("#", 2)
 
         # Escape URL unless it looks already escaped.
         url = escape_url(url)
 
         # Excel limits the escaped URL and location/anchor to 255 characters.
-        if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
-          raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation."
-        end
+        raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
 
         @url       = url
         @str       = normalized_str
@@ -45,7 +44,7 @@ module Writexlsx
       def attributes(row, col, id)
         ref = xl_rowcol_to_cell(row, col)
 
-        attr = [ ['ref', ref] ]
+        attr = [['ref', ref]]
         attr << r_id_attributes(id)
 
         attr << ['location', @url_str] if @url_str
@@ -78,14 +77,12 @@ module Writexlsx
         @url_str = @str.dup
 
         # Excel limits escaped URL to #{max_url_length} characters.
-        if @url.bytesize > max_url_length
-          raise "URL '#{@url}' > #{max_url_length} characters, it exceeds Excel's limit for URLS."
-        end
+        raise "URL '#{@url}' > #{max_url_length} characters, it exceeds Excel's limit for URLS." if @url.bytesize > max_url_length
 
         @tip = tip
       end
 
-      def attributes(row, col, dummy = nil)
+      def attributes(row, col, _dummy = nil)
         attr = [
           ['ref', xl_rowcol_to_cell(row, col)],
           ['location', @url]
@@ -102,32 +99,30 @@ module Writexlsx
         str ||= url.dup
 
         # For external links change the directory separator from Unix to Dos.
-        url = url.gsub(%r|/|, '\\')
-        str.gsub!(%r|/|, '\\')
+        url = url.gsub(%r{/}, '\\')
+        str = str.gsub(%r{/}, '\\')
 
         # Strip the mailto header.
-        str.sub!(/^mailto:/, '')
+        str = str.sub(/^mailto:/, '')
 
         # Split url into the link and optional anchor/location.
-        url, url_str = url.split(/#/, 2)
+        url, url_str = url.split("#", 2)
 
         # Escape URL unless it looks already escaped.
         url = escape_url(url)
 
         # Add the file:/// URI to the url if non-local.
-        if url =~ %r![:]! ||        # Windows style "C:/" link.
-           url =~ %r!^\\\\!        # Network share.
+        if url =~ /:/ ||        # Windows style "C:/" link.
+           url =~ /^\\\\/        # Network share.
           url = "file:///#{url}"
         end
 
         # Convert a ./dir/file.xlsx link to dir/file.xlsx.
-        url = url.sub(%r!^.\\!, '')
+        url = url.sub(/^.\\/, '')
         @url_str   = url_str
 
         # Excel limits the escaped URL and location/anchor to max_url_length characters.
-        if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
-          raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation."
-        end
+        raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
 
         @url       = url
         @str       = str