write_xlsx 1.10.0 → 1.10.1

data/examples/chart_pie.rb

@@ -19,7 +19,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_pie.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 = %w[Category Values]
@@ -32,19 +32,19 @@ worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)
 
 # Create a new chart object. In this case an embedded chart.
-chart1 = workbook.add_chart(:type => 'pie', :embedded => 1)
+chart1 = workbook.add_chart(type: 'pie', embedded: 1)
 
 # Configure the series. Note the use of the array ref to define ranges:
 # [ $sheetname, $row_start, $row_end, $col_start, $col_end ].
 # See below for an alternative syntax.
 chart1.add_series(
-  :name       => 'Pie sales data',
-  :categories => ['Sheet1', 1, 3, 0, 0],
-  :values     => ['Sheet1', 1, 3, 1, 1]
+  name:       'Pie sales data',
+  categories: ['Sheet1', 1, 3, 0, 0],
+  values:     ['Sheet1', 1, 3, 1, 1]
 )
 
 # Add a title.
-chart1.set_title(:name => 'Popular Pie Types')
+chart1.set_title(name: 'Popular Pie Types')
 
 # Set an Excel chart style. Blue colors with white outline and shadow.
 chart1.set_style(10)
@@ -52,7 +52,7 @@ chart1.set_style(10)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'C2', chart1,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
@@ -60,26 +60,26 @@ worksheet.insert_chart(
 #
 
 # Create an example Pie chart like above.
-chart2 = workbook.add_chart(:type => 'pie', :embedded => 1)
+chart2 = workbook.add_chart(type: 'pie', embedded: 1)
 
 # Configure the series.
 chart2.add_series(
-  :name       => 'Pie sales data',
-  :categories => '=Sheet1!$A$2:$A$4',
-  :values     => '=Sheet1!$B$2:$B$4',
-  :points     => [
-    { :fill => { :color => '#5ABA10' } },
-    { :fill => { :color => '#FE110E' } },
-    { :fill => { :color => '#CA5C05' } }
+  name:       'Pie sales data',
+  categories: '=Sheet1!$A$2:$A$4',
+  values:     '=Sheet1!$B$2:$B$4',
+  points:     [
+    { fill: { color: '#5ABA10' } },
+    { fill: { color: '#FE110E' } },
+    { fill: { color: '#CA5C05' } }
   ]
 )
 
 # Add a title.
-chart2.set_title(:name => 'Pie Chart with user defined colors')
+chart2.set_title(name: 'Pie Chart with user defined colors')
 
 worksheet.insert_chart(
   'C18', chart2,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_radar.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_radar.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.
-chart1 = workbook.add_chart(:type => 'radar', :embedded => 1)
+chart1 = workbook.add_chart(type: 'radar', embedded: 1)
 
 # Configure the first series.
 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'
 )
 
 # Configure second series. Note alternative use of array ref to define
 # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
 chart1.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.
-chart1.set_title(:name => 'Results of sample analysis')
-chart1.set_x_axis(:name => 'Test number')
-chart1.set_y_axis(:name => 'Sample length (mm)')
+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)
@@ -55,36 +55,36 @@ chart1.set_style(11)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D2', chart1,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
 # Create a with_markers chart sub-type
 #
 chart2 = workbook.add_chart(
-  :type     => 'radar',
-  :embedded => 1,
-  :subtype  => 'with_markers'
+  type:     'radar',
+  embedded: 1,
+  subtype:  'with_markers'
 )
 
 # Configure the first series.
 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'
 )
 
 # Configure second series.
 chart2.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.
-chart2.set_title(:name  => 'Stacked Chart')
-chart2.set_x_axis(:name => 'Test number')
-chart2.set_y_axis(:name => 'Sample length (mm)')
+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)
@@ -92,36 +92,36 @@ chart2.set_style(12)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D18', chart2,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 #
 # Create a filled chart sub-type
 #
 chart3 = workbook.add_chart(
-  :type     => 'radar',
-  :embedded => 1,
-  :subtype  => 'filled'
+  type:     'radar',
+  embedded: 1,
+  subtype:  'filled'
 )
 
 # Configure the first series.
 chart3.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.
 chart3.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.
-chart3.set_title(:name  => 'Percent Stacked Chart')
-chart3.set_x_axis(:name => 'Test number')
-chart3.set_y_axis(:name => 'Sample length (mm)')
+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)
@@ -129,7 +129,7 @@ chart3.set_style(13)
 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart(
   'D34', chart3,
-  :x_offset => 25, :y_offset => 10
+  x_offset: 25, y_offset: 10
 )
 
 workbook.close

data/examples/chart_scatter.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_scatter.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 => 'scatter', :embedded => 1)
+chart = workbook.add_chart(type: 'scatter', 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(10)
@@ -55,7 +55,7 @@ chart.set_style(10)
 # 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_secondary_axis.rb

@@ -13,7 +13,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('chart_secondary_axis.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 = %w[Aliens Humans]
@@ -26,32 +26,32 @@ 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 => 'line', :embedded => 1)
+chart = workbook.add_chart(type: 'line', embedded: 1)
 
 # Configure the first series.
 chart.add_series(
-  :name    => '=Sheet1!$A$1',
-  :values  => '=Sheet1!$A$2:$A$7',
-  :y2_axis => 1
+  name:    '=Sheet1!$A$1',
+  values:  '=Sheet1!$A$2:$A$7',
+  y2_axis: 1
 )
 
 chart.add_series(
-  :name   => '=Sheet1!$B$1',
-  :values => '=Sheet1!$B$2:$B$7'
+  name:   '=Sheet1!$B$1',
+  values: '=Sheet1!$B$2:$B$7'
 )
 
-chart.set_legend(:position => 'right')
+chart.set_legend(position: 'right')
 
 # Add a chart title and some axis labels.
-chart.set_title(:name => 'Survey results')
-chart.set_x_axis(:name => 'Days')
-chart.set_y_axis(:name => 'Population', :major_gridlines => { :visible => 0 })
-chart.set_y2_axis(:name => 'Laser wounds')
+chart.set_title(name: 'Survey results')
+chart.set_x_axis(name: 'Days')
+chart.set_y_axis(name: 'Population', major_gridlines: { visible: 0 })
+chart.set_y2_axis(name: 'Laser wounds')
 
 # 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_stock.rb

@@ -13,9 +13,9 @@ require 'write_xlsx'
 
 workbook    = WriteXLSX.new('chart_stock.xlsx')
 worksheet   = workbook.add_worksheet
-bold        = workbook.add_format(:bold => 1)
-date_format = workbook.add_format(:num_format => 'dd/mm/yyyy')
-chart       = workbook.add_chart(:type => 'stock', :embedded => 1)
+bold        = workbook.add_format(bold: 1)
+date_format = workbook.add_format(num_format: 'dd/mm/yyyy')
+chart       = workbook.add_chart(type: 'stock', embedded: 1)
 
 # Add the worksheet data that the charts will refer to.
 headings = %w[Date High Low Close]
@@ -39,24 +39,24 @@ worksheet.set_column('A:D', 11)
 
 # Add a series for each of the High-Low-Close columns.
 chart.add_series(
-  :categories => '=Sheet1!$A$2:$A$6',
-  :values     => '=Sheet1!$B$2:$B$6'
+  categories: '=Sheet1!$A$2:$A$6',
+  values:     '=Sheet1!$B$2:$B$6'
 )
 
 chart.add_series(
-  :categories => '=Sheet1!$A$2:$A$6',
-  :values     => '=Sheet1!$C$2:$C$6'
+  categories: '=Sheet1!$A$2:$A$6',
+  values:     '=Sheet1!$C$2:$C$6'
 )
 
 chart.add_series(
-  :categories => '=Sheet1!$A$2:$A$6',
-  :values     => '=Sheet1!$D$2:$D$6'
+  categories: '=Sheet1!$A$2:$A$6',
+  values:     '=Sheet1!$D$2:$D$6'
 )
 
 # Add a chart title and some axis labels.
-chart.set_title(:name => 'High-Low-Close')
-chart.set_x_axis(:name => 'Date')
-chart.set_y_axis(:name => 'Share price')
+chart.set_title(name: 'High-Low-Close')
+chart.set_x_axis(name: 'Date')
+chart.set_y_axis(name: 'Share price')
 
 worksheet.insert_chart('E9', chart)
 

data/examples/chart_styles.rb

@@ -28,13 +28,13 @@ chart_types.each do |chart_type|
   0.step(89, 15) do |row_num|
     0.step(63, 8) do |col_num|
       chart = workbook.add_chart(
-        :type     => chart_type,
-        :embedded => 1
+        type:     chart_type,
+        embedded: 1
       )
 
-      chart.add_series(:values => '=Data!$A$1:$A$6')
-      chart.set_title(:name => "Style #{style_number}")
-      chart.set_legend(:none => 1)
+      chart.add_series(values: '=Data!$A$1:$A$6')
+      chart.set_title(name: "Style #{style_number}")
+      chart.set_legend(none: 1)
       chart.set_style(style_number)
 
       worksheet.insert_chart(row_num, col_num, chart)

data/examples/colors.rb

@@ -20,8 +20,8 @@ require 'write_xlsx'
 workbook = WriteXLSX.new("colors.xlsx")
 
 # Some common formats
-center  = workbook.add_format(:align => 'center')
-heading = workbook.add_format(:align => 'center', :bold => 1)
+center  = workbook.add_format(align: 'center')
+heading = workbook.add_format(align: 'center', bold: 1)
 
 ######################################################################
 #
@@ -83,9 +83,9 @@ i = 1
 #
 order.each do |index|
   format = workbook.add_format(
-    :fg_color => colors[index],
-    :pattern  => 1,
-    :border   => 1
+    fg_color: colors[index],
+    pattern:  1,
+    border:   1
   )
 
   worksheet1.write(i + 1, 0, index,                    center)
@@ -111,9 +111,9 @@ worksheet2.write(0, 3, "Name",  heading)
 
 (8..63).each do |i|
   format = workbook.add_format(
-    :fg_color => i,
-    :pattern  => 1,
-    :border   => 1
+    fg_color: i,
+    pattern:  1,
+    border:   1
   )
 
   worksheet2.write((i - 7), 0, i,                    center)
@@ -159,9 +159,9 @@ i = 1
 
 colors.each do |html_color, color|
   format = workbook.add_format(
-    :fg_color => html_color,
-    :pattern  => 1,
-    :border   => 1
+    fg_color: html_color,
+    pattern:  1,
+    border:   1
   )
 
   worksheet3.write(i + 1, 1, html_color, center)

data/examples/comments2.rb

@@ -5,7 +5,7 @@ require 'write_xlsx'
 
 workbook  = WriteXLSX.new('comments2.xlsx')
 
-text_wrap  = workbook.add_format(:text_wrap => 1, :valign => 'top')
+text_wrap  = workbook.add_format(text_wrap: 1, valign: 'top')
 worksheet1 = workbook.add_worksheet
 worksheet2 = workbook.add_worksheet
 worksheet3 = workbook.add_worksheet
@@ -59,7 +59,7 @@ cell_text = 'This cell comment is visible.'
 comment = 'Hello.'
 
 worksheet2.write('C3', cell_text, text_wrap)
-worksheet2.write_comment('C3', comment, :visible => 1)
+worksheet2.write_comment('C3', comment, visible: 1)
 
 cell_text = "This cell comment isn't visible (the default)."
 
@@ -88,7 +88,7 @@ cell_text = 'This cell comment is visible, explicitly.'
 comment = 'Hello.'
 
 worksheet3.write('C3', cell_text, text_wrap)
-worksheet3.write_comment('C3', comment, :visible => 1)
+worksheet3.write_comment('C3', comment, visible: 1)
 
 cell_text =
   'This cell comment is also visible because we used show_comments().'
@@ -103,7 +103,7 @@ cell_text = 'However, we can still override it locally.'
 comment = 'Hello.'
 
 worksheet3.write('C9', cell_text, text_wrap)
-worksheet3.write_comment('C9', comment, :visible => 0)
+worksheet3.write_comment('C9', comment, visible: 0)
 
 ###############################################################################
 #
@@ -131,28 +131,28 @@ cell_text = 'This cell comment is twice as wide.'
 comment = 'Hello.'
 
 worksheet4.write('C6', cell_text, text_wrap)
-worksheet4.write_comment('C6', comment, :x_scale => 2)
+worksheet4.write_comment('C6', comment, x_scale: 2)
 
 cell_text = 'This cell comment is twice as high.'
 
 comment = 'Hello.'
 
 worksheet4.write('C9', cell_text, text_wrap)
-worksheet4.write_comment('C9', comment, :y_scale => 2)
+worksheet4.write_comment('C9', comment, y_scale: 2)
 
 cell_text = 'This cell comment is scaled in both directions.'
 
 comment = 'Hello.'
 
 worksheet4.write('C16', cell_text, text_wrap)
-worksheet4.write_comment('C16', comment, :x_scale => 1.2, :y_scale => 0.8)
+worksheet4.write_comment('C16', comment, x_scale: 1.2, y_scale: 0.8)
 
 cell_text = 'This cell comment has width and height specified in pixels.'
 
 comment = 'Hello.'
 
 worksheet4.write('C19', cell_text, text_wrap)
-worksheet4.write_comment('C19', comment, :width => 200, :height => 20)
+worksheet4.write_comment('C19', comment, width: 200, height: 20)
 
 ###############################################################################
 #
@@ -179,21 +179,21 @@ cell_text = 'This cell comment has been moved to another cell.'
 comment = 'Hello.'
 
 worksheet5.write('C6', cell_text, text_wrap)
-worksheet5.write_comment('C6', comment, :start_cell => 'E4')
+worksheet5.write_comment('C6', comment, start_cell: 'E4')
 
 cell_text = 'This cell comment has been moved to another cell.'
 
 comment = 'Hello.'
 
 worksheet5.write('C9', cell_text, text_wrap)
-worksheet5.write_comment('C9', comment, :start_row => 8, :start_col => 4)
+worksheet5.write_comment('C9', comment, start_row: 8, start_col: 4)
 
 cell_text = 'This cell comment has been shifted within its default cell.'
 
 comment = 'Hello.'
 
 worksheet5.write('C12', cell_text, text_wrap)
-worksheet5.write_comment('C12', comment, :x_offset => 30, :y_offset => 12)
+worksheet5.write_comment('C12', comment, x_offset: 30, y_offset: 12)
 
 ###############################################################################
 #
@@ -212,7 +212,7 @@ cell_text = 'This cell comment has a different colour.'
 comment = 'Hello.'
 
 worksheet6.write('C3', cell_text, text_wrap)
-worksheet6.write_comment('C3', comment, :color => 'green')
+worksheet6.write_comment('C3', comment, color: 'green')
 
 cell_text = 'This cell comment has the default colour.'
 
@@ -226,7 +226,7 @@ cell_text = 'This cell comment has a different colour.'
 comment = 'Hello.'
 
 worksheet6.write('C9', cell_text, text_wrap)
-worksheet6.write_comment('C9', comment, :color => '#FF6600')
+worksheet6.write_comment('C9', comment, color: '#FF6600')
 
 ###############################################################################
 #
@@ -257,7 +257,7 @@ cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
 comment = 'Hello.'
 
 worksheet7.write(cell, cell_text, text_wrap)
-worksheet7.write_comment(cell, comment, :author => author)
+worksheet7.write_comment(cell, comment, author: author)
 
 author    = '€'
 cell      = 'C9'
@@ -266,7 +266,7 @@ cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
 comment = 'Hello.'
 
 worksheet7.write(cell, cell_text, text_wrap)
-worksheet7.write_comment(cell, comment, :author => author)
+worksheet7.write_comment(cell, comment, author: author)
 
 ###############################################################################
 #