write_xlsx 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cabafeb058f3742956ec06251cab5ecf67d9b76cd5db3ec659e2e4184d2c1483
-  data.tar.gz: 95a68e0390bff44e03dc8577b31162c1d1c2cb80d77f3943947e1114327afb01
+  metadata.gz: b8f704b9674f7d6de467d512cea780114dccc51ed88d99ad4d57727fdafd32b4
+  data.tar.gz: 54df4aec8346b1935bb3b0ba283c11b04f415b3b644308ab8f4cce2f0595d14d
 SHA512:
-  metadata.gz: 70a98e3ffc2be69574805f72a63678b2023cc3aef9a1c1a97c5f8a13de80de29c641c573d8c8c9bd7d33da088827a15fb6feb3b4c7591b50ffb26cb321591b49
-  data.tar.gz: 1d387aa195a7a35f0b664e4ff155ca71de765ad6ae886df66debc9063d1fea8c4c905ab10a7aef735d69813b79faa1d6e7ded96e70ce23a75df56e5f172b1648
+  metadata.gz: ecbd4957e8b5ee4d9c77e46da68ddfa0f877dd94166551a20c1b76a782209db761a43a86bae340657181ec8993bdc277ee67b66c4c889bc5ad418e6fe2b953c5
+  data.tar.gz: c2a9f0b209de183bbb87ddceb0897dca8708b372d7bb8a5fb7953595440fdaceac60fe4500dafe2ed74585208c6f17b03c554e20c4b5d05af2ec019854b0a259

data/.rubocop.yml

@@ -82,6 +82,9 @@ Naming/HeredocDelimiterNaming:
 Naming/MethodName:
   Enabled: false
 
+Naming/MethodParameterName:
+  Enabled: false
+
 Naming/VariableNumber:
   Enabled: false
 

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/README.md

@@ -85,7 +85,7 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
 Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
-Copyright (c) 2012-2023 Hideo NAKAMURA.
+Copyright (c) 2012-2024 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

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

@@ -146,10 +146,10 @@ module Writexlsx
         return
       end
 
-      # Indent is only allowed for horizontal left, right and distributed. If it
-      # is defined for any other alignment or no alignment has been set then
-      # default to left alignment.
-      @text_h_align = 1 if @indent != 0 && ![1, 3, 7].include?(@text_h_align)
+      # Indent is only allowed for some alignment properties. If it is defined
+      # for any other alignment or no alignment has been set then default to
+      # left alignment.
+      @text_h_align = 1 if @indent != 0 && ![1, 3, 7].include?(@text_h_align) && ![1, 3, 5].include?(@text_v_align)
 
       # Check for properties that are mutually exclusive.
       @shrink       = 0 if @text_wrap != 0
@@ -178,8 +178,8 @@ module Writexlsx
       align << %w[vertical justify]     if @text_v_align == 4
       align << %w[vertical distributed] if @text_v_align == 5
 
-      align << ['indent',       @indent]   if @indent   != 0
       align << ['textRotation', @rotation] if @rotation != 0
+      align << ['indent',       @indent]   if @indent   != 0
 
       align << ['wrapText',     1] if @text_wrap != 0
       align << ['shrinkToFit',  1] if @shrink    != 0
@@ -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/content_types.rb

@@ -199,6 +199,28 @@ module Writexlsx
         )
       end
 
+      def add_richvalue
+        add_override(
+          '/xl/richData/rdRichValueTypes.xml',
+          'application/vnd.ms-excel.rdrichvaluetypes+xml'
+        )
+
+        add_override(
+          '/xl/richData/rdrichvalue.xml',
+          'application/vnd.ms-excel.rdrichvalue+xml'
+        )
+
+        add_override(
+          '/xl/richData/rdrichvaluestructure.xml',
+          'application/vnd.ms-excel.rdrichvaluestructure+xml'
+        )
+
+        add_override(
+          '/xl/richData/richValueRel.xml',
+          'application/vnd.ms-excel.richvaluerel+xml'
+        )
+      end
+
       private
 
       def change_the_workbook_xml_content_type_from_xlsx_to_xlsm