write_xlsx 0.85.9 → 1.09.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee225c252867f895e976e92e0cf2d1fa0617c8d1ab08277dced0f8c53037f0ae
-  data.tar.gz: 846527548749de579fc47f7cdd0df9826032fcb1b15cd500c441e6ffd339c3fa
+  metadata.gz: c78b5986850521951ec007fd9a9e79f66ba5dc44e04a29f806e8d013733c8f30
+  data.tar.gz: 329091c1ce7407bb69f9436a0eb232ea3b9fb88775084358d8f8c53af2e9ce36
 SHA512:
-  metadata.gz: 89fe866dcb96df87a917ddf9ef666d5583c5ece4c20424020fffbf55a648e1cbc8fa9cd6c6acd25e979528108c653414879fd020533e20740f7024c1a4678e69
-  data.tar.gz: e065e79287b82fe2b423cf119c008d92dc4c7f982acf1d98a4feb3da1d1ead8d8f8a8cc3c40e62162cf6315408875806366eeb6b058cd65f64197492cf0fe0bb
+  metadata.gz: b3897acdb3794718c0149862132773db326bc3d62397affc6623dfa49404462ef9cec421174c232d252acdc3f28804b46671307b48768720f0aa3f05d6b6458d
+  data.tar.gz: 77124e32563e0f17f7e322d3196537cd347926427682fb184732d270077537f1eb81de30425e059a126cbe413aadbc0615f79347d058ed53cc209c0a995c9b8f

data/.gitignore

@@ -6,6 +6,7 @@ GTAGS
 .bundle
 .config
 .yardoc
+.byebug_history
 Gemfile.lock
 InstalledFiles
 _site

data/.travis.yml

@@ -1,7 +1,60 @@
 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
+- 2.6.3
+- 2.6.2
+- 2.6.1
+- 2.6.0
+- 2.5.9
+- 2.5.8
+- 2.5.7
+- 2.5.6
+- 2.5.5
+- 2.5.4
+- 2.5.3
+- 2.5.2
+- 2.5.1
+- 2.5.0
+- 2.4.10
+- 2.4.9
+- 2.4.8
+- 2.4.7
+- 2.4.6
+- 2.4.5
+- 2.4.4
+- 2.4.3
+- 2.4.2
+- 2.4.1
+- 2.4.0
+- 2.3.8
+- 2.3.7
+- 2.3.6
+- 2.3.5
+- 2.3.4
+- 2.3.3
+- 2.3.2
 - 2.3.1
 - 2.3.0
+- 2.2.10
+- 2.2.9
+- 2.2.8
+- 2.2.7
+- 2.2.6
 - 2.2.5
 - 2.2.4
 - 2.2.3
@@ -20,4 +73,3 @@ rvm:
 - 2.1.1
 - 2.1.0
 - 2.0.0
-- 1.9.3

data/Changes

@@ -1,5 +1,247 @@
 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
+    "decorative" to images via insert_image().
+
+    Added the workbook read_only_recommended() method to set the Excel
+    "Read-only Recommended" option that is available when saving a file.
+
+    Added option to set a chart crossing to 'min' as well as the existing
+    'max' option. The 'min' option isn't available in the Excel interface
+    but can be enabled via VBA.
+
+    Added option to unprotect ranges in protected worksheets.
+
+    Added check, and warning, for worksheet tables with no data row.  Either
+    with or without a header row.
+
+    Added ignore_errors() worksheet method to ignore Excel worksheet
+    errors/warnings in user defined ranges.
+
+    Fixed issue where pattern formats without colours where given a default
+    black fill colour.
+
+    Fix issue where custom chart data labels didn't inherit the position for
+    the data labels in the series.
+
+    Fixed issue with relative url links in images.
+
+    Fixed issue where headers/footers were restricted to 254 characters
+    instead of 255.
+
+2021-02-17 v1.07.0
+
+   Added support for Border, Fill, Pattern and Gradient formatting to chart
+   data labels and chart custom data labels.
+
+
+2021-02-15 v1.06.0
+
+   Fix for issue where array formulas weren't included in the output file
+   for certain ranges/conditions.
+
+
+2021-02-15 v1.05.0
+
+   Added support for custom data labels in charts.
+
+   Remove ruby-1.9.3 travil CI check.
+
+
+2021-02-14 v1.04.0
+
+   Added support for "stacked" and "percent_stacked" Line charts.
+
+   Fix for worksheet objects (charts and images) that are inserted with an
+   offset that starts in a hidden cell.
+
+   Removed error in add_worksheet() for sheet name "History" which is a
+   reserved name in English version of Excel. However, this is an allowed
+   worksheet name in some Excel variants so the warning has been turned into
+   a documentation note instead.
+
+
+2021-02-13 v1.03.0
+
+   Fix for duplicate images being copied to an Excel::Writer::XLSX
+   file. Excel uses an optimization where it only stores one copy of a
+   repeated/duplicate image in a workbook. WriteXLSX didn't do
+   this which meant that the file size would increase when then was a large
+   number of repeated images. This release fixes that issue and replicates
+   Excel's behaviour.
+
+2021-02-12 v1.02.0
+
+   Added support for hyperlinks in worksheet images.
+
+   Increased allowable url length from 255 to 2079 characters, as allowed in
+   more recent versions of Excel.
+
+
+2021-02-08 v1.01.0
+
+   Added support for stacked and East Asian vertical chart fonts.
+
+   Added option to control positioning of charts or images when cells are
+   resized.
+
+   Added support for combining Pie/Doughnut charts.
+
+   Fixed sizing of cell comment boxes when they cross columns/rows that have
+   size changes that occur after the comment is written. Comments should
+   now behave like other worksheet objects such as images and charts.
+
+   Fix for structured reference in chart ranges.
+
+2021-01-23 v1.00.0
+
+   Fixed issue where images that started in hidden rows/columns weren't placed
+   correctly in the worksheet.
+
+
+2021-01-08 v0.99.0
+
+   Added font and font_size parameters to write_comment().
+
+   Allow formulas in date field of data_validation().
+
+   Added top_left chart legend position.
+
+   Added legend formatting options.
+
+   Added set_tab_ratio() method to set the ratio between the worksheet tabs
+   and the horizontal slider.
+
+   Added worksheet hide_row_col_headers() method to turn off worksheet row
+   and column headings.
+
+   Add functionality to align chart category axis labels.
+
+   Fix for issue with special characters in worksheet table functions.
+
+   Fix handling of 'num_format': '0' in duplicate formats.
+
+
+2021-01-03 v0.98.0
+
+   fixed for autofilter rule with blanks plus another filter.
+
+2021-01-02 v0.97.0
+
+   Added Excel 2010 data bar features such as solid fills and control over
+   the display of negative values.
+
+   Added default formatting for hyperlinks if none is specified. The format
+   is the Excel hyperlink style so links change colour after they are
+   clicked.
+
+   Fixed missing plotarea formatting in pie/doughnut charts.
+
+2020-12-31 v0.96.0
+
+   Added icon sets to conditional formatting.
+
+2020-12-30 v0.95.0
+
+   Added workbook set_size() method.
+
+2020-12-30 v0.94.0
+
+   Added font support to chart tables.
+
+2020-12-30 v0.93.0
+
+   Added trendline properties: intercept, display_equation and
+   display_r_squared.
+
+2020-12-30 v0.92.0
+
+   Fix for insert_image issue when handling images with zero dpi.
+
+2020-12-30 v0.91.0
+
+   Add set_custom_property() workbook method to set custom document
+   properties.
+
+2020-12-28 v0.90.0
+
+   Added worksheet_by_name() workbook method to retrieve a worksheet
+   in a workbook by name.
+
+   Fixed issue where internal file creation and modification dates where
+   in the local timezone instead of UTC.
+
+   Fixed issue with "external:" urls with space in sheetname.
+
+   Fixed issue where Unicode full-width number strings were treated as
+   numbers in write().
+
+2020-12-27 v0.89.0
+
+   Added write_boolean() worksheet method to write Excel boolean values.
+
+
+2020-12-26 v0.88.0
+
+   Added transparency option to solid fills in chart areas.
+
+   Added options to configure chart axis tick placement.
+
+2020-12-26 v0.87.0
+
+   Added chart pattern and gradient fills.
+
+   Added option to set chart tick interval.
+
+   Add checks for valid and non-duplicate worksheet table names.
+
+   Added support for table header formatting and a fix for wrapped lines in
+   the header.
+
+   use minitest instead of test-unit
+
+2020-11-01 v0.86.0
+   Fix for images with negative offsets.
+
+   Allow hyperlinks longer than 255 characters when the link and anchor
+   are each less than or equal to 255 characters.
+
+   Added hyperlink_base document property.
+
+   Added option to allow data validation input messages with the ‘any’
+   validate parameter.
+
+   Added "stop if true" feature to conditional formatting.
+
+   Added better support and documentation for html colours throughout
+   the module. The use of the Excel97 colour palette is supported for
+   backward compatibility but deprecated.
+
+2020-10-23 v0.85.11
+   Added Worksheet#update_range_format_with_params
+
+2020-10-23 v0.85.10
+   Fix frozen string litterals problems in Format#set_align
+
 2020-09-07 v0.85.9
    apply pull-request #59 and #60
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Hideo NAKAMURA
+Copyright (c) 2012-2021 Hideo NAKAMURA
 
 MIT License
 

data/README.md

@@ -5,11 +5,11 @@
 
 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-0.84](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-1.09](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.09)
 
 ## Description
 
-Reference doc : http://cxn03651.github.io/write_xlsx/
+Reference doc : https://cxn03651.github.io/write_xlsx/
 
 The WriteXLSX supports the following features:
 * Multiple worksheets
@@ -84,14 +84,14 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 ## Copyright
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
-Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp)
-Copyright (c) 2012-2018 Hideo NAKAMURA.
+Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
+Copyright (c) 2012-2021 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 
 ## Contributing to write_xlsx
 
-* repsitory: http://github.com/cxn03651/write_xlsx
+* repsitory: https://github.com/cxn03651/write_xlsx
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/examples/a_simple.rb

@@ -7,7 +7,7 @@
 # write text and numbers to an Excel xlsx file.
 #
 # reverse(c), March 2001, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -34,11 +34,6 @@ worksheet.write(7, 0, '=A3 + A6')
 worksheet.write(8, 0, '=IF(A5>3,"Yes", "No")')
 
 # Write a hyperlink
-hyperlink_format = workbook.add_format(
-                     :color     => 'blue',
-                     :underline => 1
-                                      )
-
-worksheet.write(10, 0, 'http://www.ruby-lang.org/', hyperlink_format)
+worksheet.write(10, 0, 'http://www.ruby-lang.org/')
 
 workbook.close

data/examples/add_vba_project.rb

@@ -10,7 +10,7 @@
 # used to extract the vbaProject.bin file.
 #
 # reverse('(c)'), November 2012, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/array_formula.rb

@@ -7,7 +7,7 @@
 # array formulas.
 #
 # reverse(c), August 2004, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

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

@@ -6,7 +6,7 @@
 # A demo of an Area chart in Excel::Writer::XLSX.
 #
 # reverse('ｩ'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -53,6 +53,9 @@ chart.set_y_axis(:name => 'Sample length (mm)')
 chart.set_style(11)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_bar.rb

@@ -6,7 +6,7 @@
 # A demo of an Bar chart in Excel::Writer::XLSX.
 #
 # reverse('c'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -53,6 +53,9 @@ chart.set_y_axis(:name => 'Sample length (mm)')
 chart.set_style(11)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_clustered.rb

@@ -5,7 +5,7 @@
 # A demo of a clustered category chart in Excel::Writer::XLSX.
 #
 # reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/chart_column.rb

@@ -6,7 +6,7 @@
 # A demo of an Area chart in Excel::Writer::XLSX.
 #
 # reverse('ｩ'), March 2011, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -53,6 +53,9 @@ chart.set_y_axis(:name => 'Sample length (mm)')
 chart.set_style(11)
 
 # Insert the chart into the worksheet (with an offset).
-worksheet.insert_chart('D2', chart, 25, 10)
+worksheet.insert_chart(
+  'D2', chart,
+  :x_offset => 25, :y_offset => 10
+)
 
 workbook.close

data/examples/chart_combined.rb

@@ -6,7 +6,7 @@
 # An example of a Combined chart in WriteXLSX.
 #
 # reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -99,7 +99,9 @@ column_chart2.combine(line_chart2)
 column_chart2.set_title(:name => 'Combine chart - secondary Y axis')
 column_chart2.set_x_axis(:name => 'Test number')
 column_chart2.set_y_axis(:name => 'Sample length (mm)')
-column_chart2.set_y2_axis(:name => 'Target length (mm)')
+
+# Note: the y2 properties are on the secondary chart.
+line_chart2.set_y_axis(:name => 'Target length (mm)')
 
 # Insert the chart into the worksheet
 worksheet.insert_chart('E18', column_chart2)