write_xlsx 1.11.0 → 1.11.2

data/lib/write_xlsx/package/conditional_format.rb

@@ -411,7 +411,7 @@ module Writexlsx
         # Check for a cell reference in A1 notation and substitute row and column
         user_range = if args[0].to_s =~ (/^\D/) && (args[0] =~ /,/)
                        # Check for a user defined multiple range like B3:K6,B8:K11.
-                       args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub(/\$/, '')
+                       args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub("$", '')
                      end
 
         if (row_col_array = row_col_notation(args.first))
@@ -769,7 +769,7 @@ module Writexlsx
         attr = super
         attr << ['percent', 1]             if criteria == '%'
         attr << ['bottom',  1]             if direction
-        attr << ['rank',    (value || 10)]
+        attr << ['rank',    value || 10]
         attr
       end
     end
@@ -818,9 +818,9 @@ module Writexlsx
           write_cfvo(min_type, min_value)
           write_cfvo(mid_type, mid_value) if mid_type
           write_cfvo(max_type, max_value)
-          write_color(@writer, 'rgb', min_color)
-          write_color(@writer, 'rgb', mid_color)  if mid_color
-          write_color(@writer, 'rgb', max_color)
+          write_color('rgb', min_color)
+          write_color('rgb', mid_color)  if mid_color
+          write_color('rgb', max_color)
         end
       end
     end
@@ -844,7 +844,7 @@ module Writexlsx
           write_cfvo(min_type, min_value)
           write_cfvo(max_type, max_value)
 
-          write_color(@writer, 'rgb', bar_color)
+          write_color('rgb', bar_color)
         end
       end
 

data/lib/write_xlsx/package/packager.rb

@@ -142,13 +142,12 @@ module Writexlsx
       def write_app_file
         app = Package::App.new(@workbook)
 
+        # Add the Worksheet parts.
+        app.add_worksheet_part_names
         # Add the Worksheet heading pairs.
         app.add_worksheet_heading_pairs
         # Add the Chartsheet heading pairs.
         app.add_chartsheet_heading_pairs
-
-        # Add the Worksheet parts.
-        app.add_worksheet_part_names
         # Add the Chartsheet parts.
         app.add_chartsheet_part_names
         # Add the Named Range heading pairs.

data/lib/write_xlsx/package/styles.rb

@@ -59,6 +59,8 @@ module Writexlsx
       def palette_color(index)
         if index.to_s =~ /^#([0-9A-F]{6})$/i
           "FF#{::Regexp.last_match(1).upcase}"
+        elsif index == 0x40
+          "Automatic"
         else
           "FF#{super(index)}"
         end
@@ -186,15 +188,6 @@ module Writexlsx
         end
       end
 
-      #
-      # Write the <color> element.
-      #
-      def write_color(name, value)
-        attributes = [[name, value]]
-
-        @writer.empty_tag('color', attributes)
-      end
-
       #
       # Write the <fills> element.
       #
@@ -284,10 +277,14 @@ module Writexlsx
       def write_pattern_fill(format, dxf_format)
         bg_color, fg_color = bg_and_fg_color(format, dxf_format)
 
-        @writer.empty_tag('fgColor', [['rgb', palette_color(fg_color)]]) if fg_color && fg_color != 0
+        if fg_color && fg_color != 0 && fg_color != 0x40  # 'Automatic'
+          @writer.empty_tag('fgColor', [['rgb', palette_color(fg_color)]])
+        end
 
         if bg_color && bg_color != 0
-          @writer.empty_tag('bgColor', [['rgb', palette_color(bg_color)]])
+          if bg_color != 0x40 # 'Automatic'
+            @writer.empty_tag('bgColor', [['rgb', palette_color(bg_color)]])
+          end
         elsif !dxf_format && format.pattern <= 1
           @writer.empty_tag('bgColor', [['indexed', 64]])
         end
@@ -390,10 +387,11 @@ module Writexlsx
         attributes = [[:style, BORDER_STYLES[style]]]
 
         @writer.tag_elements(type, attributes) do
-          if color == 0
+          if [0, 0x40].include?(color) # 'Automatic'
             @writer.empty_tag('color', [['auto', 1]])
-          else
+          elsif color != 0 && color != 0x40 # 'Automatic'
             color = palette_color(color)
+
             @writer.empty_tag('color', [['rgb', color]])
           end
         end

data/lib/write_xlsx/package/table.rb

@@ -12,13 +12,14 @@ module Writexlsx
       class ColumnData
         attr_reader :id
         attr_accessor :name, :format, :formula, :name_format
-        attr_accessor :total_string, :total_function
+        attr_accessor :total_string, :total_function, :custom_total
 
         def initialize(id, param = {})
           @id             = id
           @name           = "Column#{id}"
           @total_string   = ''
           @total_function = ''
+          @custom_total   = ''
           @formula        = ''
           @format         = nil
           @name_format    = nil
@@ -51,6 +52,7 @@ module Writexlsx
 
         add_the_table_columns
         write_the_cell_data_if_supplied
+        write_any_columns_formulas_after_the_user_supplied_table_data
         store_filter_cell_positions
       end
 
@@ -78,7 +80,7 @@ module Writexlsx
           # Set up the default column data.
           col_data = Package::Table::ColumnData.new(col_id + 1, @param[:columns])
 
-          overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
+          overwrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
 
           # Store the column data.
           @columns << col_data
@@ -89,7 +91,7 @@ module Writexlsx
         end    # Table columns.
       end
 
-      def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
+      def overwrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
         # Check if there are user defined values for this column.
         if @param[:columns] && (user_data = @param[:columns][col_id])
           # Map user defined values to internal values.
@@ -156,6 +158,23 @@ module Writexlsx
         end
       end
 
+      def write_any_columns_formulas_after_the_user_supplied_table_data
+        col_id = 0
+
+        (@col1..@col2).each do |col|
+          column_data = @columns[col_id]
+          if ptrue?(column_data) && ptrue?(column_data.formula)
+            formula_format = @col_formats[col_id]
+            formula        = column_data.formula
+
+            (@first_data_row..@last_data_row).each do |row|
+              @worksheet.write_formula(row, col, formula, formula_format)
+            end
+          end
+          col_id += 1
+        end
+      end
+
       def store_filter_cell_positions
         if ptrue?(@param[:autofilter])
           (@col1..@col2).each do |col|
@@ -234,25 +253,45 @@ module Writexlsx
         ]
       end
 
-      def handle_the_column_formula(col_data, col_num, formula, format)
+      def handle_the_column_formula(col_data, _col_num, formula, _format)
         return unless formula
 
-        col_data.formula = formula.sub(/^=/, '').gsub(/@/, '[#This Row],')
+        formula = formula.sub(/^=/, '').gsub(/@/, '[#This Row],')
 
-        (@first_data_row..@last_data_row).each do |row|
-          @worksheet.write_formula(row, col_num, col_data.formula, format)
-        end
+        # Escape any future functions.
+        col_data.formula = @worksheet.prepare_formula(formula, 1)
+
+        # (@first_data_row..@last_data_row).each do |row|
+        #   @worksheet.write_formula(row, col_num, col_data.formula, format)
+        # end
       end
 
       def handle_the_function_for_the_table_row(row2, col_data, col_num, user_data)
-        function = user_data[:total_function].downcase.gsub(/[_\s]/, '')
+        formula = ''
+        function = user_data[:total_function]
+        function = 'countNums' if function == 'count_nums'
+        function = 'stdDev'    if function == 'std_dev'
 
-        function = 'countNums' if function == 'countnums'
-        function = 'stdDev'    if function == 'stddev'
+        subtotals = {
+          average:   101,
+          countNums: 102,
+          count:     103,
+          max:       104,
+          min:       105,
+          stdDev:    106,
+          sum:       109,
+          var:       110
+        }
 
-        col_data.total_function = function
+        if subtotals[function.to_sym]
+          formula = table_function_to_formula(function, col_data.name)
+        else
+          formula = @worksheet.prepare_formula(function, 1)
+          col_data.custom_total = formula
+          function = 'custom'
+        end
 
-        formula = table_function_to_formula(function, col_data.name)
+        col_data.total_function = function
         @worksheet.write_formula(row2, col_num, formula, user_data[:format], user_data[:total_value])
       end
 
@@ -260,10 +299,10 @@ module Writexlsx
       # Convert a table total function to a worksheet formula.
       #
       def table_function_to_formula(function, col_name)
-        col_name = col_name.gsub(/'/, "''")
-                           .gsub(/#/, "'#")
-                           .gsub(/\[/, "'[")
-                           .gsub(/\]/, "']")
+        col_name = col_name.gsub("'", "''")
+                           .gsub("#", "'#")
+                           .gsub("[", "'[")
+                           .gsub("]", "']")
 
         subtotals = {
           average:   101,
@@ -395,10 +434,16 @@ module Writexlsx
 
         attributes << [:dataDxfId, col_data.format] if col_data.format
 
-        if ptrue?(col_data.formula)
+        if ptrue?(col_data.formula) || ptrue?(col_data.custom_total)
           @writer.tag_elements('tableColumn', attributes) do
-            # Write the calculatedColumnFormula element.
-            write_calculated_column_formula(col_data.formula)
+            if ptrue?(col_data.formula)
+              # Write the calculatedColumnFormula element.
+              write_calculated_column_formula(col_data.formula)
+            end
+            if ptrue?(col_data.custom_total)
+              # Write the totalsRowFormula element.
+              write_totals_row_formula(col_data.custom_total)
+            end
           end
         else
           @writer.empty_tag('tableColumn', attributes)
@@ -425,6 +470,15 @@ module Writexlsx
       def write_calculated_column_formula(formula)
         @writer.data_element('calculatedColumnFormula', formula)
       end
+
+      #
+      # _write_totals_row_formula()
+      #
+      # Write the <totalsRowFormula> element.
+      #
+      def write_totals_row_formula(formula)
+        @writer.data_element('totalsRowFormula', formula)
+      end
     end
   end
 end

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -29,33 +29,28 @@ module Writexlsx
         io_write(str)
       end
 
-      def tag_elements(tag, attributes = [])
+      def tag_elements(tag, attributes = nil)
         start_tag(tag, attributes)
         yield
         end_tag(tag)
       end
 
-      def tag_elements_str(tag, attributes = [])
+      def tag_elements_str(tag, attributes = nil)
         start_tag_str(tag, attributes) +
           yield +
           end_tag_str(tag)
       end
 
-      def start_tag(tag, attr = [])
+      def start_tag(tag, attr = nil)
         io_write(start_tag_str(tag, attr))
       end
 
-      def start_tag_str(tag, attr = [])
-        if attr.empty?
-          result = @tag_start_cache[tag]
-          unless result
-            result = "<#{tag}>"
-            @tag_start_cache[tag] = result
-          end
+      def start_tag_str(tag, attr = nil)
+        if attr.nil? || attr.empty?
+          @tag_start_cache[tag] ||= "<#{tag}>"
         else
-          result = "<#{tag}#{key_vals(attr)}>"
+          "<#{tag}#{key_vals(attr)}>"
         end
-        result
       end
 
       def end_tag(tag)
@@ -63,28 +58,15 @@ module Writexlsx
       end
 
       def end_tag_str(tag)
-        result = @tag_end_cache[tag]
-        unless result
-          result = "</#{tag}>"
-          @tag_end_cache[tag] = result
-        end
-        result
+        @tag_end_cache[tag] ||= "</#{tag}>"
       end
 
-      def empty_tag(tag, attr = [])
+      def empty_tag(tag, attr = nil)
         str = "<#{tag}#{key_vals(attr)}/>"
         io_write(str)
       end
 
-      def empty_tag_encoded(tag, attr = [])
-        io_write(empty_tag_encoded_str(tag, attr))
-      end
-
-      def empty_tag_encoded_str(tag, attr = [])
-        "<#{tag}#{key_vals(attr)}/>"
-      end
-
-      def data_element(tag, data, attr = [])
+      def data_element(tag, data, attr = nil)
         tag_elements(tag, attr) { io_write(escape_data(data)) }
       end
 
@@ -126,31 +108,37 @@ module Writexlsx
 
       private
 
-      def key_val(key, val)
-        %( #{key}="#{val}")
-      end
-
       def key_vals(attribute)
-        attribute
-          .inject('') { |str, attr| str + key_val(attr.first, escape_attributes(attr.last)) }
+        if attribute
+          result = "".dup
+          attribute.each do |attr|
+            # Generate and concat %( #{key}="#{val}") values for attribute pair
+            result << " "
+            result << attr.first.to_s
+            result << '="'
+            result << escape_attributes(attr.last).to_s
+            result << '"'
+          end
+          result
+        end
       end
 
       def escape_attributes(str = '')
-        return str unless str.to_s =~ /["&<>\n]/
+        return str unless str.respond_to?(:match) && str =~ /["&<>\n]/
 
         str
-          .gsub(/&/, "&amp;")
-          .gsub(/"/, "&quot;")
-          .gsub(/</, "&lt;")
-          .gsub(/>/, "&gt;")
-          .gsub(/\n/, "&#xA;")
+          .gsub("&", "&amp;")
+          .gsub('"', "&quot;")
+          .gsub("<", "&lt;")
+          .gsub(">", "&gt;")
+          .gsub("\n", "&#xA;")
       end
 
       def escape_data(str = '')
-        if str.to_s =~ /[&<>]/
-          str.gsub(/&/, '&amp;')
-             .gsub(/</, '&lt;')
-             .gsub(/>/, '&gt;')
+        if str.respond_to?(:match) && str =~ /[&<>]/
+          str.gsub("&", '&amp;')
+             .gsub("<", '&lt;')
+             .gsub(">", '&gt;')
         else
           str
         end

data/lib/write_xlsx/sheets.rb

@@ -252,9 +252,13 @@ module Writexlsx
         ['sheetId', sheet_id]
       ]
 
-      attributes << %w[state hidden] if sheet.hidden?
+      if sheet.hidden?
+        attributes << %w[state hidden]
+      elsif sheet.very_hidden?
+        attributes << %w[state veryHidden]
+      end
       attributes << r_id_attributes(sheet_id)
-      writer.empty_tag_encoded('sheet', attributes)
+      writer.empty_tag('sheet', attributes)
     end
   end
 end

data/lib/write_xlsx/sparkline.rb

@@ -43,13 +43,13 @@ module Writexlsx
       # Cleanup the input ranges.
       @ranges.collect! do |range|
         # Remove the absolute reference $ symbols.
-        range = range.gsub(/\$/, '')
+        range = range.gsub("$", '')
         # Convert a simple range into a full Sheet1!A1:D1 range.
         range = "#{sheetname}!#{range}" unless range =~ /!/
         range
       end
       # Cleanup the input locations.
-      @locations.collect! { |location| location.gsub(/\$/, '') }
+      @locations.collect! { |location| location.gsub("$", '') }
 
       # Map options.
       @high      = param[:high_point]

data/lib/write_xlsx/utility.rb

@@ -31,10 +31,12 @@ module Writexlsx
     #
     # xl_rowcol_to_cell($row, col, row_absolute, col_absolute)
     #
-    def xl_rowcol_to_cell(row, col, row_absolute = false, col_absolute = false)
-      row += 1      # Change from 0-indexed to 1 indexed.
+    def xl_rowcol_to_cell(row_or_name, col, row_absolute = false, col_absolute = false)
+      if row_or_name.is_a?(Integer)
+        row_or_name += 1      # Change from 0-indexed to 1 indexed.
+      end
       col_str = xl_col_to_name(col, col_absolute)
-      "#{col_str}#{absolute_char(row_absolute)}#{row}"
+      "#{col_str}#{absolute_char(row_absolute)}#{row_or_name}"
     end
 
     #
@@ -53,7 +55,7 @@ module Writexlsx
 
       # Convert base26 column string to number
       # All your Base are belong to us.
-      chars = col.split(//)
+      chars = col.split("")
       expn = 0
       col = 0
 
@@ -112,7 +114,7 @@ module Writexlsx
     #
     def xl_string_pixel_width(string)
       length = 0
-      string.to_s.split(//).each { |char| length += CHAR_WIDTHS[char] || 8 }
+      string.to_s.split("").each { |char| length += CHAR_WIDTHS[char] || 8 }
 
       length
     end
@@ -128,7 +130,7 @@ module Writexlsx
       name = sheetname.dup
       if name =~ /\W/ && !(name =~ /^'/)
         # Double quote and single quoted strings.
-        name = name.gsub(/'/, "''")
+        name = name.gsub("'", "''")
         name = "'#{name}'"
       end
       name
@@ -159,7 +161,7 @@ module Writexlsx
       seconds   = 0 # Time expressed as fraction of 24h hours in seconds
 
       # Split into date and time.
-      date, time = date_time.split(/T/)
+      date, time = date_time.split("T")
 
       # We allow the time portion of the input DateTime to be optional.
       if time
@@ -207,7 +209,7 @@ module Writexlsx
       # becomes 100 for 4 and 100 year leapdays and 400 for 400 year leapdays.
       #
       epoch   = date_1904? ? 1904 : 1900
-      offset  = date_1904? ?    4 :    0
+      offset  = date_1904? ? 4 : 0
       norm    = 300
       range   = year - epoch
 
@@ -248,7 +250,7 @@ module Writexlsx
     def escape_url(url)
       unless url =~ /%[0-9a-fA-F]{2}/
         # Escape the URL escape symbol.
-        url = url.gsub(/%/, "%25")
+        url = url.gsub("%", "%25")
 
         # Escape whitespae in URL.
         url = url.gsub(/[\s\x00]/, '%20')
@@ -341,7 +343,7 @@ module Writexlsx
     #
     # Write the <color> element.
     #
-    def write_color(writer, name, value) # :nodoc:
+    def write_color(name, value, writer = @writer) # :nodoc:
       attributes = [[name, value]]
 
       writer.empty_tag('color', attributes)
@@ -751,8 +753,8 @@ module Writexlsx
       # Adjust the colour index.
       idx = index - 8
 
-      rgb = @palette[idx]
-      sprintf("%02X%02X%02X", *rgb)
+      r, g, b = @palette[idx]
+      sprintf("%02X%02X%02X", r, g, b)
     end
 
     #

data/lib/write_xlsx/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WriteXLSX_VERSION = "1.11.0"
+WriteXLSX_VERSION = "1.11.2"

data/lib/write_xlsx/workbook.rb

@@ -715,7 +715,7 @@ module Writexlsx
 
       # Split the cell range into 2 cells or else use single cell for both.
       if cells =~ /:/
-        cell_1, cell_2 = cells.split(/:/)
+        cell_1, cell_2 = cells.split(":")
       else
         cell_1 = cells
         cell_2 = cells
@@ -724,7 +724,7 @@ module Writexlsx
       # Remove leading/trailing apostrophes and convert escaped quotes to single.
       sheetname.sub!(/^'/, '')
       sheetname.sub!(/'$/, '')
-      sheetname.gsub!(/''/, "'")
+      sheetname.gsub!("''", "'")
 
       row_start, col_start = xl_cell_to_rowcol(cell_1)
       row_end,   col_end   = xl_cell_to_rowcol(cell_2)
@@ -988,7 +988,6 @@ module Writexlsx
       num_formats        = []
       unique_num_formats = {}
       index              = 164
-      num_format_count   = 0
 
       (@xf_formats + @dxf_formats).each do |format|
         num_format = format.num_format

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-
-# frozen__literal: true
+# frozen_string_literal: true
 
 module Writexlsx
   class Worksheet
@@ -13,10 +12,10 @@ module Writexlsx
       # attributes for the <cell> element. This is the innermost loop so efficiency is
       # important where possible.
       #
-      def cell_attributes(worksheet, row, col) # :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.
@@ -49,8 +48,8 @@ module Writexlsx
         @token
       end
 
-      def write_cell(worksheet, row, col)
-        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, col)) do
+      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
@@ -70,8 +69,8 @@ module Writexlsx
       end
 
       TYPE_STR_ATTRS = %w[t s].freeze
-      def write_cell(worksheet, row, col)
-        attributes = cell_attributes(worksheet, row, col)
+      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)
@@ -102,11 +101,11 @@ module Writexlsx
         @result || 0
       end
 
-      def write_cell(worksheet, row, col)
+      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(worksheet, row, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
         if @result && !(@result.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
           if truefalse[@result]
             attributes << %w[t b]
@@ -138,8 +137,8 @@ module Writexlsx
         @result || 0
       end
 
-      def write_cell(worksheet, row, col)
-        worksheet.writer.tag_elements('c', cell_attributes(worksheet, row, col)) do
+      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
@@ -160,9 +159,9 @@ module Writexlsx
         @result || 0
       end
 
-      def write_cell(worksheet, row, col)
+      def write_cell(worksheet, row, row_name, col)
         # Add metadata linkage for dynamic array formulas.
-        attributes = cell_attributes(worksheet, row, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
         attributes << %w[cm 1]
 
         worksheet.writer.tag_elements('c', attributes) do
@@ -184,8 +183,8 @@ module Writexlsx
         @token
       end
 
-      def write_cell(worksheet, row, col)
-        attributes = cell_attributes(worksheet, row, col)
+      def write_cell(worksheet, row, row_name, col)
+        attributes = cell_attributes(worksheet, row, row_name, col)
 
         attributes << %w[t b]
         worksheet.writer.tag_elements('c', attributes) do
@@ -203,8 +202,8 @@ module Writexlsx
         ''
       end
 
-      def write_cell(worksheet, row, col)
-        worksheet.writer.empty_tag('c', cell_attributes(worksheet, row, col))
+      def write_cell(worksheet, row, row_name, col)
+        worksheet.writer.empty_tag('c', cell_attributes(worksheet, row, row_name, col))
       end
     end
   end