write_xlsx 1.09.5 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '080f089bfba0e7182c26bb8fab6d08f7515cbf828bbd358c5166b6fcf3fc689f'
-  data.tar.gz: 074e380eeace6467f5ab04fa18ad032452b61c82013f3ae5e2254d5eb068c86e
+  metadata.gz: 66e9354b51872770af7121d5581615b53c0cb3b7e86c221b0ecee60fe54dae4b
+  data.tar.gz: 97d6ae9ed6dee9e57e98981e105da155ef405fd5ea40ea17e8057871f02d90d9
 SHA512:
-  metadata.gz: d17f85e3491ed06d5dd39e94c11cdcb6b1abfeda6124143575da1e839d8ca88b8d4bcb06c51a7a94a813c06439c395e209424cf7fd0e1dd9616ed769a3538fc9
-  data.tar.gz: 112c2336c1bde5435637c6b68e8ae9af98062bc884c1a82b378e8bd0e5d8c5733a23b261a10c8fd5654c4b66ac8bcf765a8ccf1a23887bd70f25634d24d10e17
+  metadata.gz: a86f539563acd7da100be9fb11e1e3da99c1985200e21eaa91ca9db3f69ea130038f0ecead40ea0ba6efcc5b4f433dcd4acf039006faa65adb60ed88d0d5f005
+  data.tar.gz: f98a3ac1110600e8e2c578127f85a804c1237d44069481f6c0baacc27ff6f21eddbb96f063c544239730ba059a16f7637f39ebfd902f3cc87be4995401bf303b

data/.rubocop.yml

@@ -59,6 +59,7 @@ Metrics/MethodLength:
 
 Metrics/ParameterLists:
   Max: 12
+  MaxOptionalParameters: 6
 
 Metrics/PerceivedComplexity:
   Max: 50
@@ -89,7 +90,8 @@ Style/FormatStringToken:
   EnforcedStyle: unannotated
 
 Style/HashSyntax:
-  Enabled: false
+  EnforceStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: either
 
 Style/NumericLiterals:
   MinDigits: 10
@@ -100,6 +102,9 @@ Style/OptionalBooleanParameter:
 Style/RaiseArgs:
   Enabled: false
 
+Style/SlicingWithRange:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: false
 

data/Changes

@@ -1,5 +1,13 @@
 Change history of write_xlsx rubygem.
 
+2023-01-31 v1.10.1
+    Fixed PR #99. Remove range [1..] style to work on Ruby 2.5.
+
+2023-01-29 v.1.10.0
+    Ruby version 2.5.0 or later are required.
+
+    Added support for new Excel 365 dynamic functions.
+
 2023-01-18 v1.09.5
     Fixed issue #92. Worksheet#write raises with Time instance token.
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2022 Hideo NAKAMURA
+Copyright (c) 2012-2023 Hideo NAKAMURA
 
 MIT License
 

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.09](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.09)
+[Excel::Writer::XLSX](https://github.com/jmcnamara/excel-writer-xlsx)
 
 ## Description
 

data/examples/autofilter.rb

@@ -22,8 +22,9 @@ worksheet3 = workbook.add_worksheet
 worksheet4 = workbook.add_worksheet
 worksheet5 = workbook.add_worksheet
 worksheet6 = workbook.add_worksheet
+worksheet7 = workbook.add_worksheet
 
-bold = workbook.add_format(:bold => 1)
+bold = workbook.add_format(bold: 1)
 
 # Extract the data embedded at the end of this file.
 headings = DATA.gets.split
@@ -127,14 +128,12 @@ end
 ###############################################################################
 #
 #
-# Example 5. Autofilter with filter for blanks.
+# Example 5. Autofilter with filter list condition in one of the columns.
 #
 
-# Create a blank cell in our test data.
-data[5][0] = ''
-
 worksheet5.autofilter('A1:D51')
-worksheet5.filter_column('A', 'x eq Blanks')
+
+worksheet5.filter_column_list('A', %w[East North South])
 
 #
 # Hide the rows that don't match the filter criteria.
@@ -144,7 +143,7 @@ row = 1
 data.each do |row_data|
   region = row_data[0]
 
-  worksheet5.set_row(row, nil, nil, 1) unless region == ''
+  worksheet5.set_row(row, nil, nil, 1) unless %w[East North South].include?(region)
 
   worksheet5.write(row, 0, row_data)
   row += 1
@@ -153,11 +152,14 @@ end
 ###############################################################################
 #
 #
-# Example 6. Autofilter with filter for non-blanks.
+# Example 6. Autofilter with filter for blanks.
 #
 
+# Create a blank cell in our test data.
+data[5][0] = ''
+
 worksheet6.autofilter('A1:D51')
-worksheet6.filter_column('A', 'x eq NonBlanks')
+worksheet6.filter_column('A', 'x == Blanks')
 
 #
 # Hide the rows that don't match the filter criteria.
@@ -167,7 +169,7 @@ row = 1
 data.each do |row_data|
   region = row_data[0]
 
-  worksheet6.set_row(row, nil, nil, 1) unless region != ''
+  worksheet6.set_row(row, nil, nil, 1) unless region == ''
 
   worksheet6.write(row, 0, row_data)
   row += 1
@@ -175,6 +177,33 @@ end
 
 workbook.close
 
+###############################################################################
+#
+#
+# Example 7. Autofilter with filter for non-blanks.
+#
+
+worksheet7.autofilter('A1:D51')
+worksheet7.filter_column('A', 'x == NonBlanks')
+
+#
+# Hide the rows that don't match the filter criteria.
+#
+row = 1
+
+data.each do |row_data|
+  region = row_data[0]
+
+  worksheet7.set_row(row, nil, nil, 1) unless region != ''
+
+  worksheet7.write(row, 0, row_data)
+  row += 1
+end
+
+workbook.close
+
+
+
 __END__
 Region    Item      Volume    Month
 East      Apple     9000      July

data/examples/chart_area.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_area.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Number', 'Batch 1', 'Batch 2']
@@ -27,27 +27,27 @@ worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart = workbook.add_chart(:type => 'area', :embedded => 1)
+chart = workbook.add_chart(type: 'area', embedded: 1)
 
 # Configure the first series.
 chart.add_series(
-  :name       => '=Sheet1!$B$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  name:       '=Sheet1!$B$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Configure second series. Note alternative use of array ref to define
 # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
 chart.add_series(
-  :name       => '=Sheet1!$C$1',
-  :categories => ['Sheet1', 1, 6, 0, 0],
-  :values     => ['Sheet1', 1, 6, 2, 2]
+  name:       '=Sheet1!$C$1',
+  categories: ['Sheet1', 1, 6, 0, 0],
+  values:     ['Sheet1', 1, 6, 2, 2]
 )
 
 # Add a chart title and some axis labels.
-chart.set_title(:name => 'Results of sample analysis')
-chart.set_x_axis(:name => 'Test number')
-chart.set_y_axis(:name => 'Sample length (mm)')
+chart.set_title(name: 'Results of sample analysis')
+chart.set_x_axis(name: 'Test number')
+chart.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart.set_style(11)
@@ -55,7 +55,7 @@ chart.set_style(11)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D2', chart,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_bar.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_bar.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Number', 'Batch 1', 'Batch 2']
@@ -27,27 +27,27 @@ worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart = workbook.add_chart(:type => 'bar', :embedded => 1)
+chart = workbook.add_chart(type: 'bar', embedded: 1)
 
 # Configure the first series.
 chart.add_series(
-  :name       => '=Sheet1!$B$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  name:       '=Sheet1!$B$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Configure second series. Note alternative use of array ref to define
 # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
 chart.add_series(
-  :name       => '=Sheet1!$C$1',
-  :categories => ['Sheet1', 1, 6, 0, 0],
-  :values     => ['Sheet1', 1, 6, 2, 2]
+  name:       '=Sheet1!$C$1',
+  categories: ['Sheet1', 1, 6, 0, 0],
+  values:     ['Sheet1', 1, 6, 2, 2]
 )
 
 # Add a chart title and some axis labels.
-chart.set_title(:name => 'Results of sample analysis')
-chart.set_x_axis(:name => 'Test number')
-chart.set_y_axis(:name => 'Sample length (mm)')
+chart.set_title(name: 'Results of sample analysis')
+chart.set_x_axis(name: 'Test number')
+chart.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart.set_style(11)
@@ -55,7 +55,7 @@ chart.set_style(11)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D2', chart,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_clustered.rb

@@ -12,7 +12,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_clustered.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Types',  'Sub Type',   'Value 1', 'Value 2', 'Value 3']
@@ -28,34 +28,34 @@ worksheet.write('A1', headings, bold)
 worksheet.write_col('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart = workbook.add_chart(:type => 'column', :embedded => 1)
+chart = workbook.add_chart(type: 'column', embedded: 1)
 
 # Configure the series. Note, that the categories are 2D ranges (from column A
 # to column B). This creates the clusters. The series are shown as formula
 # strings for clarity but you can also use the array syntax. See the docs.
 chart.add_series(
-  :name       => '=Sheet1!$C$1',
-  :categories => '=Sheet1!$A$2:$B$6',
-  :values     => '=Sheet1!$C$2:$C$6'
+  name:       '=Sheet1!$C$1',
+  categories: '=Sheet1!$A$2:$B$6',
+  values:     '=Sheet1!$C$2:$C$6'
 )
 
 chart.add_series(
-  :name       => '=Sheet1!$D$1',
-  :categories => '=Sheet1!$A$2:$B$6',
-  :values     => '=Sheet1!$D$2:$D$6'
+  name:       '=Sheet1!$D$1',
+  categories: '=Sheet1!$A$2:$B$6',
+  values:     '=Sheet1!$D$2:$D$6'
 )
 
 chart.add_series(
-  :name       => '=Sheet1!$E$1',
-  :categories => '=Sheet1!$A$2:$B$6',
-  :values     => '=Sheet1!$E$2:$E$6'
+  name:       '=Sheet1!$E$1',
+  categories: '=Sheet1!$A$2:$B$6',
+  values:     '=Sheet1!$E$2:$E$6'
 )
 
 # Set the Excel chart style.
 chart.set_style(37)
 
 # Turn off the legend.
-chart.set_legend(:position => 'none')
+chart.set_legend(position: 'none')
 
 # Insert the chart into the worksheet.
 worksheet.insert_chart('G3', chart)

data/examples/chart_column.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_column.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Number', 'Batch 1', 'Batch 2']
@@ -27,27 +27,27 @@ worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart = workbook.add_chart(:type => 'column', :embedded => 1)
+chart = workbook.add_chart(type: 'column', embedded: 1)
 
 # Configure the first series.
 chart.add_series(
-  :name       => '=Sheet1!$B$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  name:       '=Sheet1!$B$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Configure second series. Note alternative use of array ref to define
 # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
 chart.add_series(
-  :name       => '=Sheet1!$C$1',
-  :categories => ['Sheet1', 1, 6, 0, 0],
-  :values     => ['Sheet1', 1, 6, 2, 2]
+  name:       '=Sheet1!$C$1',
+  categories: ['Sheet1', 1, 6, 0, 0],
+  values:     ['Sheet1', 1, 6, 2, 2]
 )
 
 # Add a chart title and some axis labels.
-chart.set_title(:name => 'Results of sample analysis')
-chart.set_x_axis(:name => 'Test number')
-chart.set_y_axis(:name => 'Sample length (mm)')
+chart.set_title(name: 'Results of sample analysis')
+chart.set_x_axis(name: 'Test number')
+chart.set_y_axis(name: 'Sample length (mm)')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart.set_style(11)
@@ -55,7 +55,7 @@ chart.set_style(11)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D2', chart,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_combined.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_combined.xlsx')
 worksheet = workbook.add_worksheet
-bold      = workbook.add_format(:bold => 1)
+bold      = workbook.add_format(bold: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = ['Number', 'Batch 1', 'Batch 2']
@@ -32,23 +32,23 @@ worksheet.write('A2', data)
 #
 
 # Create a new column chart. This will use this as the primary chart.
-column_chart1 = workbook.add_chart(:type => 'column', :embedded => 1)
+column_chart1 = workbook.add_chart(type: 'column', embedded: 1)
 
 # Configure the data series for the primary chart.
 column_chart1.add_series(
-  :name       => '=Sheet1!$B$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  name:       '=Sheet1!$B$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Create a new column chart. This will use this as the secondary chart.
-line_chart1 = workbook.add_chart(:type => 'line', :embedded => 1)
+line_chart1 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Configure the data series for the secondary chart.
 line_chart1.add_series(
-  :name       => '=Sheet1!$C$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7'
+  name:       '=Sheet1!$C$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7'
 )
 
 # Combine the charts.
@@ -56,9 +56,9 @@ column_chart1.combine(line_chart1)
 
 # Add a chart title and some axis labels. Note, this is done via the
 # primary chart.
-column_chart1.set_title(:name => 'Combined chart - same Y axis')
-column_chart1.set_x_axis(:name => 'Test number')
-column_chart1.set_y_axis(:name => 'Sample length (mm)')
+column_chart1.set_title(name: 'Combined chart - same Y axis')
+column_chart1.set_x_axis(name: 'Test number')
+column_chart1.set_y_axis(name: 'Sample length (mm)')
 
 # Insert the chart into the worksheet
 worksheet.insert_chart('E2', column_chart1)
@@ -69,38 +69,38 @@ worksheet.insert_chart('E2', column_chart1)
 #
 
 # Create a new column chart. This will use this as the primary chart.
-column_chart2 = workbook.add_chart(:type => 'column', :embedded => 1)
+column_chart2 = workbook.add_chart(type: 'column', embedded: 1)
 
 # Configure the data series for the primary chart.
 column_chart2.add_series(
-  :name       => '=Sheet1!$B$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$B$2:$B$7'
+  name:       '=Sheet1!$B$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$B$2:$B$7'
 )
 
 # Create a new column chart. This will use this as the secondary chart.
-line_chart2 = workbook.add_chart(:type => 'line', :embedded => 1)
+line_chart2 = workbook.add_chart(type: 'line', embedded: 1)
 
 # Configure the data series for the secondary chart. We also set a
 # secondary Y axis via (y2_axis). This is the only difference between
 # this and the first example, apart from the axis label below.
 line_chart2.add_series(
-  :name       => '=Sheet1!$C$1',
-  :categories => '=Sheet1!$A$2:$A$7',
-  :values     => '=Sheet1!$C$2:$C$7',
-  :y2_axis    => 1
+  name:       '=Sheet1!$C$1',
+  categories: '=Sheet1!$A$2:$A$7',
+  values:     '=Sheet1!$C$2:$C$7',
+  y2_axis:    1
 )
 
 # Combine the charts.
 column_chart2.combine(line_chart2)
 
 # Add a chart title and some axis labels.
-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_title(name: 'Combine chart - secondary Y axis')
+column_chart2.set_x_axis(name: 'Test number')
+column_chart2.set_y_axis(name: 'Sample length (mm)')
 
 # NOTE: the y2 properties are on the secondary chart.
-line_chart2.set_y_axis(:name => 'Target length (mm)')
+line_chart2.set_y_axis(name: 'Target length (mm)')
 
 # Insert the chart into the worksheet
 worksheet.insert_chart('E18', column_chart2)