write_xlsx 1.08.1 → 1.09.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab3f33d51239105a5d5c8e0765ada850496c199a370e713353c56d0e0764e4b
-  data.tar.gz: 4b379953050d7a9a5c4151742825c7672c66e60b7c37146531f8d0075d32b634
+  metadata.gz: c78b5986850521951ec007fd9a9e79f66ba5dc44e04a29f806e8d013733c8f30
+  data.tar.gz: 329091c1ce7407bb69f9436a0eb232ea3b9fb88775084358d8f8c53af2e9ce36
 SHA512:
-  metadata.gz: 128e52ae31ef667b30e8c6649c1747abf75750e48bd1a7a9a95cedd69ab3699f55755c9ef2686da4252642c662ed871b41ebb90cabe6d23e56f319b958db89b9
-  data.tar.gz: 31b68e29186266b216aaf8dc2035619292999146e79a9388c1d46dcbdd4704d17688586733dc8bb2b6284865340a68d62c7de6cd738a1ed9f6e68c83f388e94e
+  metadata.gz: b3897acdb3794718c0149862132773db326bc3d62397affc6623dfa49404462ef9cec421174c232d252acdc3f28804b46671307b48768720f0aa3f05d6b6458d
+  data.tar.gz: 77124e32563e0f17f7e322d3196537cd347926427682fb184732d270077537f1eb81de30425e059a126cbe413aadbc0615f79347d058ed53cc209c0a995c9b8f

data/.travis.yml

@@ -1,9 +1,18 @@
 language: ruby
 rvm:
+- 3.0.3
+- 3.0.2
+- 3.0.1
 - 3.0.0
+- 2.7.5
+- 2.7.4
+- 2.7.3
 - 2.7.2
 - 2.7.1
 - 2.7.0
+- 2.6.9
+- 2.6.8
+- 2.6.7
 - 2.6.6
 - 2.6.5
 - 2.6.4
@@ -11,6 +20,7 @@ rvm:
 - 2.6.2
 - 2.6.1
 - 2.6.0
+- 2.5.9
 - 2.5.8
 - 2.5.7
 - 2.5.6

data/Changes

@@ -1,5 +1,22 @@
 Change history of write_xlsx rubygem.
 
+2022-02-14 v1.09.2
+    Fixed issue #79. Worksheet#write calls the write_number
+    when multi-line string has a line with only numbers.
+
+2021-11-27 v1.09.1
+    Added Worksheet#keep_leading_zeros method to handle '001' as string in
+    Worksheet#write, write_row, and write_col method.
+
+2021-11-26 v1.09.0
+
+    Added support for background images in worksheets. See set_background().
+
+    Added support for GIF image files (and in Excel 365, animated GIF files).
+
+    Added support for pixel sizing in set_row() and set_column() via new
+    functions called set_row_pixels() and set_column_pixels().
+
 2021-11-19 v1.08.0
 
     Added ability to add accessibility options "description" and

data/README.md

@@ -5,7 +5,7 @@
 
 gem to create a new file in the Excel 2007+ XLSX format, and you can use the
 same interface as writeexcel gem. write_xlsx is converted from Perl's module
-[Excel::Writer::XLSX-1.08](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.08)
+[Excel::Writer::XLSX-1.09](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.09)
 
 ## Description
 

data/examples/background.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# An example of setting a worksheet background image with Excel::Writer::XLSX.
+#
+# Copyright 2000-2021, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('background.xlsx')
+worksheet = workbook.add_worksheet
+
+worksheet.set_background('republic.png')
+
+workbook.close

data/examples/ignore_errors.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+##############################################################################
+#
+# An example of turning off worksheet cells errors/warnings using the
+# Excel::Writer::XLSX module.
+#
+# Copyright 2000-2021, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('ignore_errors.xlsx')
+worksheet = workbook.add_worksheet
+
+# Write strings that looks like numbers. This will cause an Excel warning.
+worksheet.write_string('C2', '123')
+worksheet.write_string('C3', '123')
+
+# Write a divide by zero formula. This will also cause an Excel warning.
+worksheet.write_formula('C5', '=1/0')
+worksheet.write_formula('C6', '=1/0')
+
+# Turn off some of the warnings:
+worksheet.ignore_errors(
+  :number_stored_as_text => 'C3',
+  :eval_error => 'C6'
+)
+
+# Write some descriptions for the cells and make the column wider for clarity.
+worksheet.set_column('B:B', 16)
+worksheet.write('B2', 'Warning:')
+worksheet.write('B3', 'Warning turned off:')
+worksheet.write('B5', 'Warning:')
+worksheet.write('B6', 'Warning turned off:')
+
+workbook.close

data/examples/keep_leading_zeros.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('keep_leading_zeros.xlsx')
+worksheet = workbook.add_worksheet
+
+worksheet.keep_leading_zeros(true)
+worksheet.write('A1', '001')
+worksheet.write('B1', 'written as string.')
+worksheet.write('A2', '012')
+worksheet.write('B2', 'written as string.')
+worksheet.write('A3', '123')
+worksheet.write('B3', 'written as number.')
+
+workbook.close

data/lib/write_xlsx/chart/axis.rb

@@ -87,8 +87,8 @@ module Writexlsx
 
       def num_fmt_attributes
         [
-         ['formatCode',   @num_format],
-         ['sourceLinked', source_linked]
+          ['formatCode',   @num_format],
+          ['sourceLinked', source_linked]
         ]
       end
 
@@ -175,7 +175,7 @@ module Writexlsx
           if @position_axis == 'on_tick'
             @position_axis = 'midCat'
           elsif @position_axis == 'between'
-            # Doesn't neet to be modified.
+          # Doesn't neet to be modified.
           else
             # Otherwise use the default value.
             @position_axis = nil

data/lib/write_xlsx/chart/scatter.rb

@@ -17,21 +17,6 @@ require 'write_xlsx/utility'
 
 module Writexlsx
   class Chart
-    # The Scatter chart module also supports the following sub-types:
-    #
-    #     markers_only (the default)
-    #     straight_with_markers
-    #     straight
-    #     smooth_with_markers
-    #     smooth
-    # These can be specified at creation time via the add_chart() Worksheet
-    # method:
-    #
-    #     chart = workbook.add_chart(
-    #         :type    => 'scatter',
-    #         :subtype => 'straight_with_markers'
-    #     )
-    #
     class Scatter < self
       include Writexlsx::Utility
       include Writexlsx::WriteDPtPoint

data/lib/write_xlsx/chart/series.rb

@@ -192,7 +192,7 @@ module Writexlsx
         @values     = aref_to_formula(params[:values])
         @categories = aref_to_formula(params[:categories])
         @name, @name_formula =
-          chart.process_names(params[:name], params[:name_formula])
+               chart.process_names(params[:name], params[:name_formula])
 
         set_data_ids(params)
 

data/lib/write_xlsx/chart.rb

@@ -165,16 +165,16 @@ module Writexlsx
     include Writexlsx::Utility
     include Writexlsx::Gradient
 
-    attr_accessor :id, :name   # :nodoc:
-    attr_writer :index, :palette, :protection   # :nodoc:
-    attr_reader :embedded, :formula_ids, :formula_data   # :nodoc:
-    attr_reader :x_scale, :y_scale, :x_offset, :y_offset # :nodoc:
-    attr_reader :width, :height  # :nodoc:
+    attr_accessor :id, :name                                         # :nodoc:
+    attr_writer :index, :palette, :protection                        # :nodoc:
+    attr_reader :embedded, :formula_ids, :formula_data               # :nodoc:
+    attr_reader :x_scale, :y_scale, :x_offset, :y_offset             # :nodoc:
+    attr_reader :width, :height                                      # :nodoc:
     attr_reader :label_positions, :label_position_default, :combined # :nodoc:
-    attr_writer :date_category, :already_inserted
-    attr_writer :series_index
-    attr_writer :writer
-    attr_reader :x2_axis, :y2_axis, :axis2_ids
+    attr_writer :date_category, :already_inserted                    # :nodoc:
+    attr_writer :series_index                                        # :nodoc:
+    attr_writer :writer                                              # :nodoc:
+    attr_reader :x2_axis, :y2_axis, :axis2_ids                       # :nodoc:
 
     #
     # Factory method for returning chart objects based on their class type.
@@ -1057,7 +1057,7 @@ module Writexlsx
     end
 
     def write_val_base(formula, data_id, tag) # :nodoc:
-      data    = @formula_data[data_id]
+      data = @formula_data[data_id]
 
       @writer.tag_elements(tag) do
         # Unlike Cat axes data should only be numeric.
@@ -1408,11 +1408,11 @@ module Writexlsx
 
     def write_scaling_with_param(param)
       write_scaling(
-                    param.reverse,
-                    param.min,
-                    param.max,
-                    param.log_base
-                    )
+        param.reverse,
+        param.min,
+        param.max,
+        param.log_base
+      )
     end
     #
     # Write the <c:scaling> element.
@@ -1443,7 +1443,7 @@ module Writexlsx
     # Write the <c:orientation> element.
     #
     def write_orientation(reverse = nil) # :nodoc:
-      val     = ptrue?(reverse) ? 'maxMin' : 'minMax'
+      val = ptrue?(reverse) ? 'maxMin' : 'minMax'
 
       @writer.empty_tag('c:orientation', [ ['val', val] ])
     end
@@ -1499,9 +1499,9 @@ module Writexlsx
       source_linked = 0
 
       attributes = [
-                    ['formatCode',   format_code],
-                    ['sourceLinked', source_linked]
-                   ]
+        ['formatCode',   format_code],
+        ['sourceLinked', source_linked]
+      ]
 
       @writer.empty_tag('c:numFmt', attributes)
     end
@@ -1778,13 +1778,13 @@ module Writexlsx
       footer = 0.3
 
       attributes = [
-                    ['b',      b],
-                    ['l',      l],
-                    ['r',      r],
-                    ['t',      t],
-                    ['header', header],
-                    ['footer', footer]
-                   ]
+        ['b',      b],
+        ['l',      l],
+        ['r',      r],
+        ['t',      t],
+        ['header', header],
+        ['footer', footer]
+      ]
 
       @writer.empty_tag('c:pageMargins', attributes)
     end
@@ -2272,7 +2272,7 @@ module Writexlsx
         data.each_with_index do |token, i|
           # Write non-numeric data as 0.
           if token &&
-              !(token.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
+             !(token.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
             token = 0
           end
 
@@ -2703,7 +2703,7 @@ module Writexlsx
     end
 
     def write_num_ref_or_lit(values, data)
-      if values.to_s =~ /^=/                     # '=Sheet1!$A$1:$A$5'
+      if values.to_s =~ /^=/                # '=Sheet1!$A$1:$A$5'
         write_num_ref(values, data, 'num')
       else                                  # [1, 2, 3]
         write_num_lit(values)

data/lib/write_xlsx/chartsheet.rb

@@ -204,9 +204,9 @@ module Writexlsx
       mc_preserve_attributes = 'mv:*'
 
       attributes = [
-                    ['xmlns',   xmlns],
-                    ['xmlns:r', xmlns_r]
-                   ]
+        ['xmlns',   xmlns],
+        ['xmlns:r', xmlns_r]
+      ]
 
       @writer.tag_elements('chartsheet', attributes) do
         yield

data/lib/write_xlsx/drawing.rb

@@ -9,7 +9,7 @@ module Writexlsx
 
     def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil, decorative = nil)
       @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip, @decorative =
-        type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip, decorative
+                                                                                                            type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip, decorative
     end
   end
 
@@ -70,8 +70,8 @@ module Writexlsx
     def write_drawing_workspace
       schema    = 'http://schemas.openxmlformats.org/drawingml/'
       attributes = [
-          ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
-          ['xmlns:a',    "#{schema}2006/main"]
+        ['xmlns:xdr', "#{schema}2006/spreadsheetDrawing"],
+        ['xmlns:a',    "#{schema}2006/main"]
       ]
 
       @writer.tag_elements('xdr:wsDr', attributes) { yield }
@@ -166,7 +166,7 @@ module Writexlsx
       end
     end
 
-      #
+    #
     # Write the <xdr:from> element.
     #
     def write_from(col, row, col_offset, row_offset)
@@ -487,9 +487,9 @@ module Writexlsx
 
 
       attributes = [
-                    ['xmlns:c', xmlns_c],
-                    ['xmlns:r', xmlns_r]
-                   ]
+        ['xmlns:c', xmlns_c],
+        ['xmlns:r', xmlns_r]
+      ]
       attributes << r_id_attributes(id)
 
       @writer.empty_tag('c:chart', attributes)
@@ -519,9 +519,9 @@ module Writexlsx
       else
         # Add attribute for shapes.
         attributes = [
-                      [:macro, ''],
-                      [:textlink, '']
-                     ]
+          [:macro, ''],
+          [:textlink, '']
+        ]
         @writer.tag_elements('xdr:sp', attributes) do
 
           # Write the xdr:nvSpPr element.
@@ -554,17 +554,17 @@ module Writexlsx
 
           if shape.start
             attributes = [
-                          ['id', shape.start],
-                          ['idx', shape.start_index]
-                         ]
+              ['id', shape.start],
+              ['idx', shape.start_index]
+            ]
             @writer.empty_tag('a:stCxn', attributes)
           end
 
           if shape.end
             attributes = [
-                          ['id', shape.end],
-                          ['idx', shape.end_index]
-                         ]
+              ['id', shape.end],
+              ['idx', shape.end_index]
+            ]
             @writer.empty_tag('a:endCxn', attributes)
           end
         end
@@ -808,9 +808,9 @@ module Writexlsx
             adj_int = (adj * 1000).to_i
 
             attributes = [
-                          [:name, "adj#{suffix}"],
-                          [:fmla, "val #{adj_int}"]
-                         ]
+              [:name, "adj#{suffix}"],
+              [:fmla, "val #{adj_int}"]
+            ]
             @writer.empty_tag('a:gd', attributes)
           end
         end
@@ -867,15 +867,15 @@ module Writexlsx
     #
     def write_tx_body(shape)
       attributes = [
-                    [:vertOverflow, "clip"],
-                    [:wrap,         "square"],
-                    [:lIns,         "27432"],
-                    [:tIns,         "22860"],
-                    [:rIns,         "27432"],
-                    [:bIns,         "22860"],
-                    [:anchor,       shape.valign],
-                    [:upright,      "1"]
-                   ]
+        [:vertOverflow, "clip"],
+        [:wrap,         "square"],
+        [:lIns,         "27432"],
+        [:tIns,         "22860"],
+        [:rIns,         "27432"],
+        [:bIns,         "22860"],
+        [:anchor,       shape.valign],
+        [:upright,      "1"]
+      ]
       @writer.tag_elements('xdr:txBody') do
         @writer.empty_tag('a:bodyPr', attributes)
         @writer.empty_tag('a:lstStyle')
@@ -885,9 +885,9 @@ module Writexlsx
           rotation *= 60000
 
           attributes = [
-                        [:algn, shape.align],
-                        [:rtl, rotation]
-                       ]
+            [:algn, shape.align],
+            [:rtl, rotation]
+          ]
           @writer.tag_elements('a:pPr', attributes) do
             attributes = [ [:sz, "1000"] ]
             @writer.empty_tag('a:defRPr', attributes)
@@ -903,14 +903,14 @@ module Writexlsx
             strike    = ptrue?(shape.format[:font_strikeout]) ? 'Strike' : 'noStrike'
 
             attributes = [
-                          [:lang,     "en-US"],
-                          [:sz,       size],
-                          [:b,        bold],
-                          [:i,        italic],
-                          [:u,        underline],
-                          [:strike,   strike],
-                          [:baseline, 0]
-                         ]
+              [:lang,     "en-US"],
+              [:sz,       size],
+              [:b,        bold],
+              [:i,        italic],
+              [:u,        underline],
+              [:strike,   strike],
+              [:baseline, 0]
+            ]
             @writer.tag_elements('a:rPr', attributes) do
               color = shape.format[:color]
               if color