write_xlsx 1.11.0 → 1.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a7593970ecc4db14f2accbdc1634033ac9042cdd7680a20d4400ea1eda741f
-  data.tar.gz: 2ec671ba25dc571f612dc5b9d4a9c4ede2e147203d2e085313ea8b4a5f774377
+  metadata.gz: 9dae4b31e210af6cea2f7df87d92e29d48e8b36d7408cfc0c542b4aa0fe4ea22
+  data.tar.gz: 3c1be9afcd157d1c7a4aabf6f0688b049a80699133e6a3d31d17874bce453b5a
 SHA512:
-  metadata.gz: 255b8f5d60623d6c9966ba1209773129d3312238df315a16564d8c950fa39ac738296a9c788d4cb707abad7e659e9eaef528749fa7f1de7f93a2152e0534fbb4
-  data.tar.gz: c161bd9e8cfe47754f763a874ab83b183f76d7d290ecc53db1fa7a1ea1ec4433ee1d80efda0c139417321f02069db690fc113ab54104b5922b9c942210949e60
+  metadata.gz: 7975e43767efe81a4d32819a62ce805d88c51c879e7456f9ea653be43521501bf79612d61ea95ab065efcf5bf7c43fa7f4c2e657a0ab09e211310200237faceb
+  data.tar.gz: 03f711b7f01ba88e9e84676ce442737bf8c7cd14db67cd04bdd50aa30eddaad850133d476e11b7a0c0ed25f485740810d6724e0449f7343cc10345bc67ba9c5c

data/.rubocop.yml

@@ -102,7 +102,7 @@ Style/FormatStringToken:
   EnforcedStyle: unannotated
 
 Style/HashSyntax:
-  EnforceStyle: ruby19_no_mixed_keys
+  EnforcedStyle: ruby19_no_mixed_keys
   EnforcedShorthandSyntax: either
 
 Style/IfUnlessModifier:

data/Changes

@@ -1,5 +1,17 @@
 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
+
 2023-05-06 v1.11.0
     Added support for simulated worksheet `autofit()`.
 

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/area.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/axis.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'

data/lib/write_xlsx/chart/bar.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/caption.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Chart

data/lib/write_xlsx/chart/column.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/doughnut.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/legend.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Chart

data/lib/write_xlsx/chart/line.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/pie.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #
@@ -122,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_/
@@ -206,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/radar.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/scatter.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

data/lib/write_xlsx/chart/series.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Chart
@@ -58,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]
@@ -75,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',
@@ -182,6 +231,7 @@ module Writexlsx
       attr_reader :values, :categories, :name, :name_formula, :name_id
       attr_reader :cat_data_id, :val_data_id, :fill, :pattern, :gradient
       attr_reader :trendline, :smooth, :labels, :invert_if_negative
+      attr_reader :inverted_color
       attr_reader :x2_axis, :y2_axis, :error_bars, :points
       attr_accessor :line, :marker
 
@@ -217,10 +267,12 @@ module Writexlsx
 
         @label_positions = chart.label_positions
         @label_position_default = chart.label_position_default
-        @labels     = labels_properties(params[:data_labels])
+        @labels = labels_properties(params[:data_labels])
+        @inverted_color = params[:invert_if_negative_color]
 
-        %i[smooth invert_if_negative x2_axis y2_axis]
-          .each { |key| instance_variable_set("@#{key}", params[key]) }
+        %i[
+          smooth invert_if_negative x2_axis y2_axis
+        ].each { |key| instance_variable_set("@#{key}", params[key]) }
       end
 
       def ==(other)
@@ -228,7 +280,7 @@ module Writexlsx
           categories values name name_formula name_id
           cat_data_id val_data_id
           line fill gradient marker trendline
-          smooth labels invert_if_neg
+          smooth labels inverted_color
           x2_axis y2_axis error_bars points
         ]
         methods.each do |method|

data/lib/write_xlsx/chart/stock.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###############################################################################
 #

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,10 +961,62 @@ module Writexlsx
         write_val(series)
         # Write the c:smooth element.
         write_c_smooth(series.smooth) if ptrue?(@smooth_allowed)
+        # 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_inverted_fill(color)
+      uri = '{6F2FDCE9-48DA-4B69-8628-5D25D57E5C99}'
+      xmlns_c_14 =
+        'http://schemas.microsoft.com/office/drawing/2007/8/2/chart'
+
+      attributes_1 = [
+        ['uri', uri],
+        ['xmlns:c14', xmlns_c_14]
+      ]
+
+      attributes_2 = [
+        ['xmlns:c14', xmlns_c_14]
+      ]
+
+      @writer.tag_elements('c:extLst') do
+        @writer.tag_elements('c:ext', attributes_1) do
+          @writer.tag_elements('c14:invertSolidFillFmt') do
+            @writer.tag_elements('c14:spPr', attributes_2) do
+              write_a_solid_fill(color: color)
+            end
+          end
+        end
+      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)
@@ -2018,20 +2081,25 @@ module Writexlsx
         attributes << ['w', width]
       end
 
-      @writer.tag_elements('a:ln', attributes) do
-        # Write the line fill.
-        if ptrue?(line[:none])
-          # Write the a:noFill element.
-          write_a_no_fill
-        elsif ptrue?(line[:color])
-          # Write the a:solidFill element.
-          write_a_solid_fill(line)
-        end
-        # Write the line/dash type.
-        if line[:dash_type]
-          # Write the a:prstDash element.
-          write_a_prst_dash(line[:dash_type])
+      if ptrue?(line[:none]) || ptrue?(line[:color]) || line[:dash_type]
+        @writer.tag_elements('a:ln', attributes) do
+          # Write the line fill.
+          if ptrue?(line[:none])
+            # Write the a:noFill element.
+            write_a_no_fill
+          elsif ptrue?(line[:color])
+            # Write the a:solidFill element.
+            write_a_solid_fill(line)
+          end
+
+          # Write the line/dash type.
+          if line[:dash_type]
+            # Write the a:prstDash element.
+            write_a_prst_dash(line[:dash_type])
+          end
         end
+      else
+        @writer.empty_tag('a:ln', attributes)
       end
     end
 
@@ -2091,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
@@ -2168,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
 
@@ -2513,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
 
     #
@@ -2831,8 +2919,6 @@ module Writexlsx
     # Write the <a:fillToRect> element.
     #
     def write_a_fill_to_rect(type)
-      attributes = []
-
       attributes = if type == 'shape'
                      [
                        ['l', 50000],
@@ -2854,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/colors.rb

@@ -4,25 +4,26 @@
 module Writexlsx
   class Colors
     COLORS = {
-      aqua:    0x0F,
-      cyan:    0x0F,
-      black:   0x08,
-      blue:    0x0C,
-      brown:   0x10,
-      magenta: 0x0E,
-      fuchsia: 0x0E,
-      gray:    0x17,
-      grey:    0x17,
-      green:   0x11,
-      lime:    0x0B,
-      navy:    0x12,
-      orange:  0x35,
-      pink:    0x21,
-      purple:  0x14,
-      red:     0x0A,
-      silver:  0x16,
-      white:   0x09,
-      yellow:  0x0D
+      aqua:      0x0F,
+      cyan:      0x0F,
+      black:     0x08,
+      blue:      0x0C,
+      brown:     0x10,
+      magenta:   0x0E,
+      fuchsia:   0x0E,
+      gray:      0x17,
+      grey:      0x17,
+      green:     0x11,
+      lime:      0x0B,
+      navy:      0x12,
+      orange:    0x35,
+      pink:      0x21,
+      purple:    0x14,
+      red:       0x0A,
+      silver:    0x16,
+      white:     0x09,
+      yellow:    0x0D,
+      automatic: 0x40
     }   # :nodoc:
 
     ###############################################################################

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
@@ -584,14 +584,16 @@ module Writexlsx
         if theme == -1
         # Ignore for excel2003_style
         elsif ptrue?(theme)
-          write_color(writer, 'theme', theme)
+          write_color('theme', theme, writer)
         elsif ptrue?(@color_indexed)
-          write_color(writer, 'indexed', @color_indexed)
+          write_color('indexed', @color_indexed, writer)
         elsif ptrue?(@color)
           color = worksheet.palette_color(@color)
-          write_color(writer, 'rgb', color)
+          if color != 'Automatic'
+            write_color('rgb', color, writer)
+          end
         elsif !ptrue?(dxf_format)
-          write_color(writer, 'theme', 1)
+          write_color('theme', 1, writer)
         end
 
         unless ptrue?(dxf_format)
@@ -607,12 +609,12 @@ module Writexlsx
         writer.empty_tag('sz', [['val', size]])
 
         if ptrue?(theme)
-          write_color(writer, 'theme', theme)
+          write_color('theme', theme, writer)
         elsif ptrue?(@color)
           color = worksheet.palette_color(@color)
-          write_color(writer, 'rgb', color)
+          write_color('rgb', color, writer)
         else
-          write_color(writer, 'theme', 1)
+          write_color('theme', 1, writer)
         end
 
         writer.empty_tag('rFont', [['val', @font]])

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/comments.rb

@@ -57,7 +57,8 @@ module Writexlsx
       # Minor modification to allow comparison testing. Change RGB colors
       # from long format, ffcc00 to short format fc0 used by VML.
       def rgb_color(rgb)
-        result = sprintf("%02x%02x%02x", *rgb)
+        r, g, b = rgb
+        result = sprintf("%02x%02x%02x", r, g, b)
         result = "#{::Regexp.last_match(1)}#{::Regexp.last_match(2)}#{::Regexp.last_match(3)}" if result =~ /^([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3$/
         result
       end