write_xlsx 1.11.1 → 1.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cabafeb058f3742956ec06251cab5ecf67d9b76cd5db3ec659e2e4184d2c1483
-  data.tar.gz: 95a68e0390bff44e03dc8577b31162c1d1c2cb80d77f3943947e1114327afb01
+  metadata.gz: 9dae4b31e210af6cea2f7df87d92e29d48e8b36d7408cfc0c542b4aa0fe4ea22
+  data.tar.gz: 3c1be9afcd157d1c7a4aabf6f0688b049a80699133e6a3d31d17874bce453b5a
 SHA512:
-  metadata.gz: 70a98e3ffc2be69574805f72a63678b2023cc3aef9a1c1a97c5f8a13de80de29c641c573d8c8c9bd7d33da088827a15fb6feb3b4c7591b50ffb26cb321591b49
-  data.tar.gz: 1d387aa195a7a35f0b664e4ff155ca71de765ad6ae886df66debc9063d1fea8c4c905ab10a7aef735d69813b79faa1d6e7ded96e70ce23a75df56e5f172b1648
+  metadata.gz: 7975e43767efe81a4d32819a62ce805d88c51c879e7456f9ea653be43521501bf79612d61ea95ab065efcf5bf7c43fa7f4c2e657a0ab09e211310200237faceb
+  data.tar.gz: 03f711b7f01ba88e9e84676ce442737bf8c7cd14db67cd04bdd50aa30eddaad850133d476e11b7a0c0ed25f485740810d6724e0449f7343cc10345bc67ba9c5c

data/Changes

@@ -1,5 +1,14 @@
 Change history of write_xlsx rubygem.
 
+2023-12-26 v1.11.2
+    Fix issue where header images in chartsheets weren't displayed.
+    Add support for custom table total functions.
+    Add chart option to display N/A as empty cells.
+    Add support for leader lines to all chart types.
+    Fix issue where column formulas were overwritten by table data
+    add Worksheet#very_hidden method.
+    Add add trendline equation formatting for chart.
+
 2023-08-09 v1.11.1
     Fixed issue #110. Redefining costant Struct::ColInfo
 

data/examples/shape_all.rb

@@ -218,7 +218,7 @@ shapes_list.each_line do |line|
   line = line.chomp
   next unless line =~ /^\w/    # Skip blank lines and comments.
 
-  sheet, name = line.split(/\t/)
+  sheet, name = line.split("\t")
   if last_sheet != sheet
     worksheet = workbook.add_worksheet(sheet)
     row       = 2

data/lib/write_xlsx/chart/pie.rb

@@ -123,8 +123,7 @@ module Writexlsx
       # Write the <c:legend> element.
       #
       def write_legend
-        position = @legend.position
-        allowed  = %w[right left top bottom]
+        allowed = %w[right left top bottom]
         delete_series = @legend.delete_series || []
 
         if @legend.position =~ /^overlay_/
@@ -207,6 +206,19 @@ module Writexlsx
       def write_first_slice_ang
         @writer.empty_tag('c:firstSliceAng', [['val', @rotation]])
       end
+
+      #
+      # Write the <c:showLeaderLines> element. This is for Pie/Doughnut charts.
+      # Other chart types only supported leader lines after Excel 2015 via an
+      # extension element.
+      #
+      def write_show_leader_lines
+        val  = 1
+
+        attributes = [['val', val]]
+
+        @writer.empty_tag('c:showLeaderLines', attributes)
+      end
     end
   end
 end

data/lib/write_xlsx/chart/series.rb

@@ -59,10 +59,13 @@ module Writexlsx
     class Trendline < Chartline
       attr_reader :name, :forward, :backward, :order, :period
       attr_reader :intercept, :display_equation, :display_r_squared
+      attr_reader :label
 
       def initialize(params)
         super(params)
 
+        @label = trendline_label_properties(params[:label])
+
         @name              = params[:name]
         @forward           = params[:forward]
         @backward          = params[:backward]
@@ -76,6 +79,51 @@ module Writexlsx
 
       private
 
+      #
+      # Convert user defined trendline label properties to the structure required
+      # internally.
+      #
+      def trendline_label_properties(_label)
+        return unless _label || _label.is_a?(Hash)
+
+        # Copy the user supplied properties.
+        label = {}
+
+        # Set the font properties for the label.
+        label[:font] = convert_font_args(_label[:font]) if ptrue?(_label[:font])
+
+        # Set the line properties for the label.
+        line = line_properties(_label[:line])
+
+        # Allow 'border' as a synonym for 'line'.
+        line = line_properties(_label[:border]) if ptrue?(_label[:border])
+
+        # Set the fill properties for the label.
+        fill = fill_properties(_label[:fill])
+
+        # Set the pattern properties for the label.
+        pattern = pattern_properties(_label[:pattern])
+
+        # Set the gradient fill properties for the label.
+        gradient = gradient_properties(_label[:gradient])
+
+        # Pattern fill overrides solid fill.
+        fill = nil if ptrue?(pattern)
+
+        # Gradient fill overrides solid and pattern fills.
+        if ptrue?(gradient)
+          pattern = nil
+          fill    = nil
+        end
+
+        label[:line]     = line
+        label[:fill]     = fill
+        label[:pattern]  = pattern
+        label[:gradient] = gradient
+
+        label
+      end
+
       def types
         {
           exponential:    'exp',

data/lib/write_xlsx/chart.rb

@@ -568,6 +568,13 @@ module Writexlsx
       @is_secondary
     end
 
+    #
+    # Set the option for displaying #N/A as an empty cell in a chart.
+    #
+    def show_na_as_empty_cell
+      @show_na_as_empty = true
+    end
+
     private
 
     def axis_setup
@@ -598,6 +605,7 @@ module Writexlsx
       @cross_between     = 'between'
       @date_category     = false
       @show_blanks       = 'gap'
+      @show_na_as_empty  = false
       @show_hidden_data  = false
       @show_crosses      = true
     end
@@ -782,6 +790,9 @@ module Writexlsx
 
         # Write the c:dispBlanksAs element.
         write_disp_blanks_as
+
+        # Write the c:extLst element.
+        write_ext_lst_display_na if @show_na_as_empty
       end
     end
 
@@ -950,12 +961,13 @@ module Writexlsx
         write_val(series)
         # Write the c:smooth element.
         write_c_smooth(series.smooth) if ptrue?(@smooth_allowed)
-        write_ext_lst(series.inverted_color) if series.inverted_color
+        # Write the c:extLst element.
+        write_ext_lst_inverted_fill(series.inverted_color) if series.inverted_color
       end
       @series_index += 1
     end
 
-    def write_ext_lst(color)
+    def write_ext_lst_inverted_fill(color)
       uri = '{6F2FDCE9-48DA-4B69-8628-5D25D57E5C99}'
       xmlns_c_14 =
         'http://schemas.microsoft.com/office/drawing/2007/8/2/chart'
@@ -980,6 +992,31 @@ module Writexlsx
       end
     end
 
+    #
+    # Write the <c:extLst> element for the display N/A as empty cell option.
+    #
+    def write_ext_lst_display_na
+      uri        = '{56B9EC1D-385E-4148-901F-78D8002777C0}'
+      xmlns_c_16 = 'http://schemas.microsoft.com/office/drawing/2017/03/chart'
+
+      attributes1 = [
+        ['uri', uri],
+        ['xmlns:c16r3', xmlns_c_16]
+      ]
+
+      attributes2 = [
+        ['val', 1]
+      ]
+
+      @writer.tag_elements('c:extLst') do
+        @writer.tag_elements('c:ext', attributes1) do
+          @writer.tag_elements('c16r3:dataDisplayOptions16') do
+            @writer.empty_tag('c16r3:dispNaAsBlank', attributes2)
+          end
+        end
+      end
+    end
+
     def write_ser_base(series)
       # Write the c:idx element.
       write_idx(@series_index)
@@ -2122,7 +2159,7 @@ module Writexlsx
           # Write the c:dispEq element.
           write_disp_eq
           # Write the c:trendlineLbl element.
-          write_trendline_lbl
+          write_trendline_lbl(trendline)
         end
       end
     end
@@ -2199,12 +2236,18 @@ module Writexlsx
     #
     # Write the <c:trendlineLbl> element.
     #
-    def write_trendline_lbl
+    def write_trendline_lbl(trendline)
       @writer.tag_elements('c:trendlineLbl') do
         # Write the c:layout element.
         write_layout
         # Write the c:numFmt element.
         write_trendline_num_fmt
+        # Write the c:spPr element for the label formatting.
+        write_sp_pr(trendline.label)
+        # Write the data label font elements.
+        if trendline.label && ptrue?(trendline.label[:font])
+          write_axis_font(trendline.label[:font])
+        end
       end
     end
 
@@ -2544,11 +2587,25 @@ module Writexlsx
       @writer.data_element('c:separator', data)
     end
 
-    #
-    # Write the <c:showLeaderLines> element.
-    #
+    # Write the <c:showLeaderLines> element. This is different for Pie/Doughnut
+    # charts. Other chart types only supported leader lines after Excel 2015 via
+    # an extension element.
     def write_show_leader_lines
-      @writer.empty_tag('c:showLeaderLines', [['val', 1]])
+      uri        = '{CE6537A1-D6FC-4f65-9D91-7224C49458BB}'
+      xmlns_c_15 = 'http://schemas.microsoft.com/office/drawing/2012/chart'
+
+      attributes1 = [
+        ['uri', uri],
+        ['xmlns:c15', xmlns_c_15]
+      ]
+
+      attributes2 = [['val',  1]]
+
+      @writer.tag_elements('c:extLst') do
+        @writer.tag_elements('c:ext', attributes1) do
+          @writer.empty_tag('c15:showLeaderLines', attributes2)
+        end
+      end
     end
 
     #
@@ -2862,8 +2919,6 @@ module Writexlsx
     # Write the <a:fillToRect> element.
     #
     def write_a_fill_to_rect(type)
-      attributes = []
-
       attributes = if type == 'shape'
                      [
                        ['l', 50000],
@@ -2885,8 +2940,6 @@ module Writexlsx
     # Write the <a:tileRect> element.
     #
     def write_a_tile_rect(type)
-      attributes = []
-
       attributes = if type == 'shape'
                      []
                    else

data/lib/write_xlsx/chartsheet.rb

@@ -54,6 +54,8 @@ module Writexlsx
           write_header_footer
           # Write the drawing element.
           write_drawings
+          # Write the legaacyDrawingHF element.
+          write_legacy_drawing_hf
           # Close the worksheet tag.
         end
       end
@@ -145,6 +147,10 @@ module Writexlsx
       @chart.show_blanks_as(*args)
     end
 
+    def show_na_as_empty_cell
+      @chart.show_na_as_empty_cell(*args)
+    end
+
     def show_hidden_data(*args)
       @chart.show_hidden_data(*args)
     end
@@ -185,7 +191,10 @@ module Writexlsx
     end
 
     def external_links
-      [@external_drawing_links]
+      [
+        @external_drawing_links,
+        @external_vml_links
+      ]
     end
 
     private

data/lib/write_xlsx/col_name.rb

@@ -7,12 +7,16 @@ class ColName
   include Singleton
 
   def initialize
-    @col_str_table = {}
+    @col_str_table = []
+    @row_str_table = []
   end
 
   def col_str(col)
-    @col_str_table[col] = col_str_build(col) unless @col_str_table[col]
-    @col_str_table[col]
+    @col_str_table[col] ||= col_str_build(col)
+  end
+
+  def row_str(row)
+    @row_str_table[row] ||= row.to_s
   end
 
   private

data/lib/write_xlsx/format.rb

@@ -324,7 +324,7 @@ module Writexlsx
         return colors[color_code.downcase.to_sym] if colors[color_code.downcase.to_sym]
 
         # or the default color if string is unrecognised,
-        return 0x00 if color_code =~ /\D/
+        0x00 if color_code =~ /\D/
       else
         # or an index < 8 mapped into the correct range,
         return color_code + 8 if color_code < 8

data/lib/write_xlsx/package/app.rb

@@ -46,7 +46,9 @@ module Writexlsx
         add_heading_pair(
           [
             'Worksheets',
-            @workbook.worksheets.reject { |s| s.is_chartsheet? }.count
+            @workbook.worksheets.reject do |s|
+              s.is_chartsheet? || s.very_hidden?
+            end.count
           ]
         )
       end
@@ -57,14 +59,16 @@ module Writexlsx
 
       def add_worksheet_part_names
         @workbook.worksheets
-                 .reject { |sheet| sheet.is_chartsheet? }
-                 .each   { |sheet| add_part_name(sheet.name) }
+          .reject { |sheet| sheet.is_chartsheet? || sheet.very_hidden? }
+          .each  do |sheet|
+          add_part_name(sheet.name)
+        end
       end
 
       def add_chartsheet_part_names
         @workbook.worksheets
-                 .select { |sheet| sheet.is_chartsheet? }
-                 .each   { |sheet| add_part_name(sheet.name) }
+          .select { |sheet| sheet.is_chartsheet? }
+          .each   { |sheet| add_part_name(sheet.name) }
       end
 
       def add_part_name(part_name)

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

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/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')

data/lib/write_xlsx/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WriteXLSX_VERSION = "1.11.1"
+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)

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -12,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.
@@ -48,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
@@ -69,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)
@@ -101,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]
@@ -137,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
@@ -159,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
@@ -183,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
@@ -202,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

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -28,7 +28,7 @@ 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)
@@ -106,7 +106,7 @@ module Writexlsx
         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)

data/lib/write_xlsx/worksheet.rb

@@ -228,15 +228,26 @@ module Writexlsx
     #
     # Hide this worksheet.
     #
-    def hide
-      @hidden = true
+    def hide(hidden = :hidden)
+      @hidden = hidden
       @selected = false
       @workbook.activesheet = 0 if @workbook.activesheet == @index
       @workbook.firstsheet  = 0 if @workbook.firstsheet  == @index
     end
 
+    #
+    # Hide this worksheet. This can only be unhidden from VBA.
+    #
+    def very_hidden
+      hide(:very_hidden)
+    end
+
     def hidden? # :nodoc:
-      @hidden
+      @hidden == :hidden
+    end
+
+    def very_hidden? # :nodoc:
+      @hidden == :very_hidden
     end
 
     #
@@ -271,7 +282,7 @@ module Writexlsx
       if range.nil?
         raise "The range must be defined in unprotect_range())\n"
       else
-        range = range.gsub(/\$/, "")
+        range = range.gsub("$", "")
         range = range.sub(/^=/, "")
         @num_protected_ranges += 1
       end
@@ -612,8 +623,17 @@ module Writexlsx
     #
     # This method is used to display the worksheet in "Page View/Layout" mode.
     #
-    def set_page_view(flag = true)
-      @page_view = !!flag
+    def set_page_view(flag = 1)
+      @page_view = flag
+    end
+
+    #
+    # set_pagebreak_view
+    #
+    # Set the page view mode.
+    #
+    def set_pagebreak_view
+      @page_view = 2
     end
 
     #
@@ -648,7 +668,7 @@ module Writexlsx
       raise 'Header string must be less than 255 characters' if string.length > 255
 
       # Replace the Excel placeholder &[Picture] with the internal &G.
-      @page_setup.header = string.gsub(/&\[Picture\]/, '&G')
+      @page_setup.header = string.gsub("&[Picture]", '&G')
 
       @page_setup.header_footer_aligns = options[:align_with_margins] if options[:align_with_margins]
 
@@ -664,7 +684,7 @@ module Writexlsx
       end
 
       # placeholeder /&G/ の数
-      placeholder_count = @page_setup.header.scan(/&G/).count
+      placeholder_count = @page_setup.header.scan("&G").count
 
       image_count = @header_images.count
 
@@ -685,7 +705,7 @@ module Writexlsx
       @page_setup.footer = string.dup
 
       # Replace the Excel placeholder &[Picture] with the internal &G.
-      @page_setup.footer = string.gsub(/&\[Picture\]/, '&G')
+      @page_setup.footer = string.gsub("&[Picture]", '&G')
 
       @page_setup.header_footer_aligns = options[:align_with_margins] if options[:align_with_margins]
 
@@ -701,7 +721,7 @@ module Writexlsx
       end
 
       # placeholeder /&G/ の数
-      placeholder_count = @page_setup.footer.scan(/&G/).count
+      placeholder_count = @page_setup.footer.scan("&G").count
 
       image_count = @footer_images.count
 
@@ -1320,7 +1340,7 @@ module Writexlsx
     # Utility method to strip equal sign and array braces from a formula
     # and also expand out future and dynamic array formulas.
     #
-    def prepare_formula(given_formula)
+    def prepare_formula(given_formula, expand_future_functions = nil)
       # Ignore empty/null formulas.
       return given_formula unless ptrue?(given_formula)
 
@@ -1331,26 +1351,46 @@ module Writexlsx
       return formula if formula =~ /_xlfn\./
 
       # Expand dynamic array formulas.
-      formula = expand_formula(formula, 'LET\(')
+      formula = expand_formula(formula, 'ANCHORARRAY\(')
+      formula = expand_formula(formula, 'BYCOL\(')
+      formula = expand_formula(formula, 'BYROW\(')
+      formula = expand_formula(formula, 'CHOOSECOLS\(')
+      formula = expand_formula(formula, 'CHOOSEROWS\(')
+      formula = expand_formula(formula, 'DROP\(')
+      formula = expand_formula(formula, 'EXPAND\(')
+      formula = expand_formula(formula, 'FILTER\(', '._xlws')
+      formula = expand_formula(formula, 'HSTACK\(')
       formula = expand_formula(formula, 'LAMBDA\(')
+      formula = expand_formula(formula, 'MAKEARRAY\(')
+      formula = expand_formula(formula, 'MAP\(')
+      formula = expand_formula(formula, 'RANDARRAY\(')
+      formula = expand_formula(formula, 'REDUCE\(')
+      formula = expand_formula(formula, 'SCAN\(')
+      formula = expand_formula(formula, 'SEQUENCE\(')
       formula = expand_formula(formula, 'SINGLE\(')
+      formula = expand_formula(formula, 'SORT\(', '._xlws')
       formula = expand_formula(formula, 'SORTBY\(')
+      formula = expand_formula(formula, 'SWITCH\(')
+      formula = expand_formula(formula, 'TAKE\(')
+      formula = expand_formula(formula, 'TEXTSPLIT\(')
+      formula = expand_formula(formula, 'TOCOL\(')
+      formula = expand_formula(formula, 'TOROW\(')
       formula = expand_formula(formula, 'UNIQUE\(')
-      formula = expand_formula(formula, 'XMATCH\(')
+      formula = expand_formula(formula, 'VSTACK\(')
+      formula = expand_formula(formula, 'WRAPCOLS\(')
+      formula = expand_formula(formula, 'WRAPROWS\(')
       formula = expand_formula(formula, 'XLOOKUP\(')
-      formula = expand_formula(formula, 'SEQUENCE\(')
-      formula = expand_formula(formula, 'RANDARRAY\(')
-      formula = expand_formula(formula, 'SORT\(', '._xlws')
-      formula = expand_formula(formula, 'ANCHORARRAY\(')
-      formula = expand_formula(formula, 'FILTER\(', '._xlws')
 
-      return formula unless @use_future_functions
+      if !@use_future_functions && !ptrue?(expand_future_functions)
+        return formula
+      end
 
       # Future functions.
       formula = expand_formula(formula, 'ACOTH\(')
       formula = expand_formula(formula, 'ACOT\(')
       formula = expand_formula(formula, 'AGGREGATE\(')
       formula = expand_formula(formula, 'ARABIC\(')
+      formula = expand_formula(formula, 'ARRAYTOTEXT\(')
       formula = expand_formula(formula, 'BASE\(')
       formula = expand_formula(formula, 'BETA.DIST\(')
       formula = expand_formula(formula, 'BETA.INV\(')
@@ -1415,7 +1455,9 @@ module Writexlsx
       formula = expand_formula(formula, 'IMSINH\(')
       formula = expand_formula(formula, 'IMTAN\(')
       formula = expand_formula(formula, 'ISFORMULA\(')
+      formula = expand_formula(formula, 'ISOMITTED\(')
       formula = expand_formula(formula, 'ISOWEEKNUM\(')
+      formula = expand_formula(formula, 'LET\(')
       formula = expand_formula(formula, 'LOGNORM.DIST\(')
       formula = expand_formula(formula, 'LOGNORM.INV\(')
       formula = expand_formula(formula, 'MAXIFS\(')
@@ -1450,24 +1492,26 @@ module Writexlsx
       formula = expand_formula(formula, 'SKEW.P\(')
       formula = expand_formula(formula, 'STDEV.P\(')
       formula = expand_formula(formula, 'STDEV.S\(')
-      formula = expand_formula(formula, 'SWITCH\(')
       formula = expand_formula(formula, 'T.DIST.2T\(')
       formula = expand_formula(formula, 'T.DIST.RT\(')
       formula = expand_formula(formula, 'T.DIST\(')
       formula = expand_formula(formula, 'T.INV.2T\(')
       formula = expand_formula(formula, 'T.INV\(')
       formula = expand_formula(formula, 'T.TEST\(')
+      formula = expand_formula(formula, 'TEXTAFTER\(')
+      formula = expand_formula(formula, 'TEXTBEFORE\(')
       formula = expand_formula(formula, 'TEXTJOIN\(')
       formula = expand_formula(formula, 'UNICHAR\(')
       formula = expand_formula(formula, 'UNICODE\(')
+      formula = expand_formula(formula, 'VALUETOTEXT\(')
       formula = expand_formula(formula, 'VAR.P\(')
       formula = expand_formula(formula, 'VAR.S\(')
       formula = expand_formula(formula, 'WEBSERVICE\(')
       formula = expand_formula(formula, 'WEIBULL.DIST\(')
+      formula = expand_formula(formula, 'XMATCH\(')
       formula = expand_formula(formula, 'XOR\(')
       expand_formula(formula, 'Z.TEST\(')
     end
-    private :prepare_formula
 
     #
     # :call-seq:
@@ -1551,7 +1595,7 @@ module Writexlsx
               end
 
       # Modify the formula string, as needed.
-      formula = prepare_formula(formula)
+      formula = prepare_formula(formula, 1)
 
       store_data_to_table(
         if type == 'a'
@@ -2926,7 +2970,7 @@ module Writexlsx
       tokens.map! do |token|
         token.sub!(/^"/, '')
         token.sub!(/"$/, '')
-        token.gsub!(/""/, '"')
+        token.gsub!('""', '"')
 
         # if token is number, convert to numeric.
         if token =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/
@@ -3208,13 +3252,13 @@ module Writexlsx
           target = escape_url(url.sub(/^external:/, ''))
 
           # Additional escape not required in worksheet hyperlinks
-          target = target.gsub(/#/, '%23')
+          target = target.gsub("#", '%23')
 
           # Prefix absolute paths (not relative) with file:///
           target = if target =~ /^\w:/ || target =~ /^\\\\/
                      "file:///#{target}"
                    else
-                     target.gsub(/\\/, '/')
+                     target.gsub("\\", '/')
                    end
         end
 
@@ -3437,7 +3481,7 @@ EOS
     def encode_password(password) # :nodoc:
       hash = 0
 
-      password.reverse.split(//).each do |char|
+      password.reverse.split("").each do |char|
         hash = ((hash >> 14) & 0x01) | ((hash << 1) & 0x7fff)
         hash ^= char.ord
       end
@@ -3559,16 +3603,27 @@ EOS
       attributes << ["showOutlineSymbols", 0] if @outline_on
 
       # Set the page view/layout mode if required.
-      # TODO. Add pageBreakPreview mode when requested.
-      attributes << %w[view pageLayout] if page_view?
+      case @page_view
+      when 1
+        attributes << %w[view pageLayout]
+      when 2
+        attributes << %w[view pageBreakPreview]
+      end
 
       # Set the first visible cell.
       attributes << ['topLeftCell', @top_left_cell] if ptrue?(@top_left_cell)
 
       # Set the zoom level.
       if @zoom != 100
-        attributes << ['zoomScale', @zoom] unless page_view?
-        attributes << ['zoomScaleNormal', @zoom] if zoom_scale_normal?
+        attributes << ['zoomScale', @zoom]
+
+        if @page_view == 1
+          attributes << ['zoomScalePageLayoutView', @zoom]
+        elsif @page_view == 2
+          attributes << ['zoomScaleSheetLayoutView', @zoom]
+        elsif ptrue?(@zoom_scale_normal)
+          attributes << ['zoomScaleNormal', @zoom]
+        end
       end
 
       attributes << ['workbookViewId', 0]
@@ -3754,9 +3809,10 @@ EOS
 
     def write_cell_column_dimension(row_num)  # :nodoc:
       row = @cell_data_table[row_num]
+      row_name = (row_num + 1).to_s
       (@dim_colmin..@dim_colmax).each do |col_num|
         if (cell = row[col_num])
-          cell.write_cell(self, row_num, col_num)
+          cell.write_cell(self, row_num, row_name, col_num)
         end
       end
     end
@@ -4755,10 +4811,6 @@ EOS
       ptrue?(@zoom_scale_normal)
     end
 
-    def page_view? # :nodoc:
-      !!@page_view
-    end
-
     def right_to_left? # :nodoc:
       !!@right_to_left
     end

data/write_xlsx.gemspec

@@ -20,9 +20,11 @@ Gem::Specification.new do |gem|
   end
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ['lib']
+  gem.add_runtime_dependency 'nkf'
   gem.add_runtime_dependency 'rubyzip', '>= 1.0.0'
   gem.add_development_dependency 'byebug'
   gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mutex_m'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-minitest'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.11.2
 platform: ruby
 authors:
 - Hideo NAKAMURA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nkf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -276,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format.