write_xlsx 1.10.2 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c1fe583292a7a5318db09651b114e58358646a8706b5b4d35fc01c1850ec6c
-  data.tar.gz: 424d3f3a1983e4de16de9a943c67718874e7ef7e4a78c440767ecf8c68f0ef88
+  metadata.gz: cabafeb058f3742956ec06251cab5ecf67d9b76cd5db3ec659e2e4184d2c1483
+  data.tar.gz: 95a68e0390bff44e03dc8577b31162c1d1c2cb80d77f3943947e1114327afb01
 SHA512:
-  metadata.gz: 4603c1400dd60ec345b8cf4db50ae1c03e87716192a074d2a767cebc7cfc085439c733ea11167cf900efc3aae3fe555a32639731d36338100bf9fbb170f28fd5
-  data.tar.gz: 3ccbb69460382ae8074cc62fc896daa1aa608dbbb6ff894bb1fc425643c0ac3b9e91cc55b0c8e2de05a50113b179621db83fcea033b9b201bf56957f833624e3
+  metadata.gz: 70a98e3ffc2be69574805f72a63678b2023cc3aef9a1c1a97c5f8a13de80de29c641c573d8c8c9bd7d33da088827a15fb6feb3b4c7591b50ffb26cb321591b49
+  data.tar.gz: 1d387aa195a7a35f0b664e4ff155ca71de765ad6ae886df66debc9063d1fea8c4c905ab10a7aef735d69813b79faa1d6e7ded96e70ce23a75df56e5f172b1648

data/.rubocop.yml

@@ -8,6 +8,9 @@ AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
 
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
@@ -33,6 +36,9 @@ Layout/HeredocIndentation:
 Layout/LineLength:
   Max: 7000
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
 Lint/DuplicateBranch:
   IgnoreLiteralBranches: true
   Exclude:
@@ -60,6 +66,9 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Max: 400
 
+Metrics/ModuleLength:
+  Max: 1000
+
 Metrics/ParameterLists:
   Max: 12
   MaxOptionalParameters: 6
@@ -93,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,23 @@
 Change history of write_xlsx rubygem.
 
+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()`.
+
+    Refactored internal column property handling to allow column ranges
+    to be overridden (a common UX expectation).
+
+    Add `quote_prefix` format property.
+
+    Fix for duplicate number formats. Issue #283(excel-write-xlsx)
+
+    Add fix for worksheets with tables and background images.
+
+    Replace/fix the worksheet protection password algorithm
+    so that is works correctly for strings over 24 chars.
+
 2023-02-16 v1.10.2
     Fixed issue #104. Worksheet#write Ruby 3.2 removed Object#=~
     making it impossible to write Date objects

data/examples/autofit.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#
+# An example of using simulated autofit to automatically adjust the width of
+# worksheet columns based on the data in the cells.
+#
+# Copyright 2000-2023, John McNamara, jmcnamara@cpan.org
+#
+# SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later
+#
+# convert to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+require 'write_xlsx'
+
+workbook   = WriteXLSX.new('autofit.xlsx')
+worksheet  = workbook.add_worksheet
+
+# Write some worksheet data to demonstrate autofitting.
+worksheet.write(0, 0, "Foo")
+worksheet.write(1, 0, "Food")
+worksheet.write(2, 0, "Foody")
+worksheet.write(3, 0, "Froody")
+
+worksheet.write(0, 1, 12345)
+worksheet.write(1, 1, 12345678)
+worksheet.write(2, 1, 12345)
+
+worksheet.write(0, 2, "Some longer text")
+
+worksheet.write(0, 3, 'http://www.google.com')
+worksheet.write(1, 3, 'https://github.com')
+
+# Autofit the worksheet
+worksheet.autofit
+
+workbook.close

data/examples/chart_radar.rb

@@ -44,10 +44,8 @@ chart1.add_series(
   values:     ['Sheet1', 1, 6, 2, 2]
 )
 
-# Add a chart title and some axis labels.
+# Add a chart title.
 chart1.set_title(name: 'Results of sample analysis')
-chart1.set_x_axis(name: 'Test number')
-chart1.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart1.set_style(11)
@@ -81,10 +79,8 @@ chart2.add_series(
   values:     ['Sheet1', 1, 6, 2, 2]
 )
 
-# Add a chart title and some axis labels.
+# Add a chart title.
 chart2.set_title(name: 'Stacked Chart')
-chart2.set_x_axis(name: 'Test number')
-chart2.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart2.set_style(12)
@@ -118,10 +114,8 @@ chart3.add_series(
   values:     ['Sheet1', 1, 6, 2, 2]
 )
 
-# Add a chart title and some axis labels.
+# Add a chart title.
 chart3.set_title(name: 'Percent Stacked Chart')
-chart3.set_x_axis(name: 'Test number')
-chart3.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart3.set_style(13)

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
 
 ###############################################################################
 #

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
@@ -182,6 +183,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 +219,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 +232,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

@@ -371,7 +371,7 @@ module Writexlsx
     # Set on of the 42 built-in Excel chart styles. The default style is 2.
     #
     def set_style(style_id = 2)
-      style_id = 2 if style_id < 0 || style_id > 48
+      style_id = 2 if style_id < 1 || style_id > 48
       @style_id = style_id
     end
 
@@ -950,10 +950,36 @@ 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
       end
       @series_index += 1
     end
 
+    def write_ext_lst(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
+
     def write_ser_base(series)
       # Write the c:idx element.
       write_idx(@series_index)
@@ -2018,20 +2044,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
 

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

@@ -12,7 +12,7 @@ module Writexlsx
     attr_reader :diag_type, :diag_color, :font_only, :color_indexed                        # :nodoc:
     attr_reader :left, :left_color, :right, :right_color, :top, :top_color, :bottom, :bottom_color # :nodoc:
     attr_reader :font_scheme                                                                       # :nodoc:
-    attr_accessor :num_format_index, :border_index, :font_index                                    # :nodoc:
+    attr_accessor :quote_prefix, :num_format_index, :border_index, :font_index                                    # :nodoc:
     attr_accessor :fill_index, :font_condense, :font_extend, :diag_border                          # :nodoc:
     attr_accessor :bg_color, :fg_color, :pattern                                                   # :nodoc:
 
@@ -84,6 +84,7 @@ module Writexlsx
       @just_distrib   = 0
       @color_indexed  = 0
       @font_only      = 0
+      @quote_prefix   = 0
 
       set_format_properties(params) unless params.empty?
     end
@@ -213,7 +214,7 @@ module Writexlsx
     # Returns a unique hash key for the Format object.
     #
     def get_format_key
-      [get_font_key, get_border_key, get_fill_key, get_alignment_key, @num_format, @locked, @hidden].join(':')
+      [get_font_key, get_border_key, get_fill_key, get_alignment_key, @num_format, @locked, @hidden, @quote_prefix].join(':')
     end
 
     #
@@ -583,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)
@@ -606,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]])
@@ -642,6 +645,7 @@ module Writexlsx
         ['borderId', border_index],
         ['xfId', xf_id]
       ]
+      attributes << ['quotePrefix', 1] if ptrue?(quote_prefix)
       attributes << ['applyNumberFormat', 1] if num_format_index > 0
       # Add applyFont attribute if XF format uses a font element.
       attributes << ['applyFont', 1] if font_index > 0 && !ptrue?(@hyperlink)

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

data/lib/write_xlsx/package/conditional_format.rb

@@ -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/shared_strings.rb

@@ -11,11 +11,14 @@ module Writexlsx
 
       PRESERVE_SPACE_ATTRIBUTES = ['xml:space', 'preserve'].freeze
 
+      attr_reader :strings
+
       def initialize
         @writer        = Package::XMLWriterSimple.new
         @strings       = [] # string table
         @strings_index = {} # string table index
         @count         = 0 # count
+        @str_unique    = 0
       end
 
       def index(string, params = {})
@@ -25,10 +28,9 @@ module Writexlsx
 
       def add(string)
         unless @strings_index[string]
-          # Only first time the string will be append to list
-          # next time we only check and not #dup it
           str = string.frozen? ? string : string.freeze
           @strings << str
+          @str_unique += 1
           @strings_index[str] = @strings.size - 1
         end
         @count += 1
@@ -128,7 +130,7 @@ module Writexlsx
       end
 
       def unique_count
-        @strings.size
+        @str_unique
       end
     end
   end

data/lib/write_xlsx/package/styles.rb

@@ -14,7 +14,7 @@ module Writexlsx
         @xf_formats        = nil
         @palette           = []
         @font_count        = 0
-        @num_format_count  = 0
+        @num_formats       = []
         @border_count      = 0
         @fill_count        = 0
         @custom_colors     = []
@@ -38,18 +38,18 @@ module Writexlsx
       # Pass in the Format objects and other properties used to set the styles.
       #
       def set_style_properties(
-            xf_formats, palette, font_count, num_format_count, border_count,
+            xf_formats, palette, font_count, num_formats, border_count,
             fill_count, custom_colors, dxf_formats, has_comments
           )
-        @xf_formats       = xf_formats
-        @palette          = palette
-        @font_count       = font_count
-        @num_format_count = num_format_count
-        @border_count     = border_count
-        @fill_count       = fill_count
-        @custom_colors    = custom_colors
-        @dxf_formats      = dxf_formats
-        @has_comments     = has_comments
+        @xf_formats    = xf_formats
+        @palette       = palette
+        @font_count    = font_count
+        @num_formats   = num_formats
+        @border_count  = border_count
+        @fill_count    = fill_count
+        @custom_colors = custom_colors
+        @dxf_formats   = dxf_formats
+        @has_comments  = has_comments
       end
 
       #
@@ -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
@@ -77,7 +79,7 @@ module Writexlsx
       # Write the <numFmts> element.
       #
       def write_num_fmts
-        count = @num_format_count
+        count = @num_formats.size
 
         return if count == 0
 
@@ -85,11 +87,10 @@ module Writexlsx
 
         @writer.tag_elements('numFmts', attributes) do
           # Write the numFmts elements.
-          @xf_formats.each do |format|
-            # Ignore built-in number formats, i.e., < 164.
-            next unless format.num_format_index >= 164
-
-            write_num_fmt(format.num_format_index, format.num_format)
+          index = 164
+          @num_formats.each do |num_format|
+            write_num_fmt(index, num_format)
+            index += 1
           end
         end
       end
@@ -187,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.
       #
@@ -285,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
@@ -391,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