write_xlsx 1.09.3 → 1.09.5

data/examples/tables.rb

@@ -32,13 +32,12 @@ worksheet13 = workbook.add_worksheet
 
 currency_format = workbook.add_format(:num_format => '$#,##0')
 
-
 # Some sample data for the table.
 data = [
-    [ 'Apples',  10000, 5000, 8000, 6000 ],
-    [ 'Pears',   2000,  3000, 4000, 5000 ],
-    [ 'Bananas', 6000,  6000, 6500, 6000 ],
-    [ 'Oranges', 500,   300,  200,  700 ]
+  ['Apples',  10000, 5000, 8000, 6000],
+  ['Pears',   2000,  3000, 4000, 5000],
+  ['Bananas', 6000,  6000, 6500, 6000],
+  ['Oranges', 500,   300,  200,  700]
 ]
 
 ###############################################################################
@@ -56,7 +55,6 @@ worksheet1.write('B1', caption)
 # Add a table to the worksheet.
 worksheet1.add_table('B3:F7')
 
-
 ###############################################################################
 #
 # Example 2.
@@ -72,7 +70,6 @@ worksheet2.write('B1', caption)
 # Add a table to the worksheet.
 worksheet2.add_table('B3:F7', { :data => data })
 
-
 ###############################################################################
 #
 # Example 3.
@@ -145,7 +142,6 @@ worksheet6.add_table('B3:F7', { :banded_rows => 0, :banded_columns => 1 })
 # Table data can also be written separately, as an array or individual cells.
 worksheet6.write_col('B4', data)
 
-
 ###############################################################################
 #
 # Example 7.
@@ -160,17 +156,17 @@ worksheet7.write('B1', caption)
 
 # Add a table to the worksheet.
 worksheet7.add_table(
-    'B3:F7',
-    {
-        :data    => data,
-        :columns => [
-            { :header => 'Product' },
-            { :header => 'Quarter 1' },
-            { :header => 'Quarter 2' },
-            { :header => 'Quarter 3' },
-            { :header => 'Quarter 4' }
-        ]
-    }
+  'B3:F7',
+  {
+    :data    => data,
+    :columns => [
+      { :header => 'Product' },
+      { :header => 'Quarter 1' },
+      { :header => 'Quarter 2' },
+      { :header => 'Quarter 3' },
+      { :header => 'Quarter 4' }
+    ]
+  }
 )
 
 ###############################################################################
@@ -187,24 +183,23 @@ worksheet8.write('B1', caption)
 
 # Add a table to the worksheet.
 worksheet8.add_table(
-    'B3:G7',
-    {
-        :data    => data,
-        :columns => [
-            { :header => 'Product' },
-            { :header => 'Quarter 1' },
-            { :header => 'Quarter 2' },
-            { :header => 'Quarter 3' },
-            { :header => 'Quarter 4' },
-            {
-                :header  => 'Year',
-                :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
-            }
-        ]
-    }
+  'B3:G7',
+  {
+    :data    => data,
+    :columns => [
+      { :header => 'Product' },
+      { :header => 'Quarter 1' },
+      { :header => 'Quarter 2' },
+      { :header => 'Quarter 3' },
+      { :header => 'Quarter 4' },
+      {
+        :header  => 'Year',
+        :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
+      }
+    ]
+  }
 )
 
-
 ###############################################################################
 #
 # Example 9.
@@ -219,25 +214,24 @@ worksheet9.write('B1', caption)
 
 # Add a table to the worksheet.
 worksheet9.add_table(
-    'B3:G8',
-    {
-        :data      => data,
-        :total_row => 1,
-        :columns   => [
-            { :header => 'Product' },
-            { :header => 'Quarter 1' },
-            { :header => 'Quarter 2' },
-            { :header => 'Quarter 3' },
-            { :header => 'Quarter 4' },
-            {
-                :header  => 'Year',
-                :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
-            }
-        ]
-    }
+  'B3:G8',
+  {
+    :data      => data,
+    :total_row => 1,
+    :columns   => [
+      { :header => 'Product' },
+      { :header => 'Quarter 1' },
+      { :header => 'Quarter 2' },
+      { :header => 'Quarter 3' },
+      { :header => 'Quarter 4' },
+      {
+        :header  => 'Year',
+        :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
+      }
+    ]
+  }
 )
 
-
 ###############################################################################
 #
 # Example 10.
@@ -252,26 +246,25 @@ worksheet10.write('B1', caption)
 
 # Add a table to the worksheet.
 worksheet10.add_table(
-    'B3:G8',
-    {
-        :data      => data,
-        :total_row => 1,
-        :columns   => [
-            { :header => 'Product',   :total_string   => 'Totals' },
-            { :header => 'Quarter 1', :total_function => 'sum' },
-            { :header => 'Quarter 2', :total_function => 'sum' },
-            { :header => 'Quarter 3', :total_function => 'sum' },
-            { :header => 'Quarter 4', :total_function => 'sum' },
-            {
-                :header         => 'Year',
-                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
-                :total_function => 'sum'
-            }
-        ]
-    }
+  'B3:G8',
+  {
+    :data      => data,
+    :total_row => 1,
+    :columns   => [
+      { :header => 'Product',   :total_string   => 'Totals' },
+      { :header => 'Quarter 1', :total_function => 'sum' },
+      { :header => 'Quarter 2', :total_function => 'sum' },
+      { :header => 'Quarter 3', :total_function => 'sum' },
+      { :header => 'Quarter 4', :total_function => 'sum' },
+      {
+        :header         => 'Year',
+        :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        :total_function => 'sum'
+      }
+    ]
+  }
 )
 
-
 ###############################################################################
 #
 # Example 11.
@@ -286,27 +279,26 @@ worksheet11.write('B1', caption)
 
 # Add a table to the worksheet.
 worksheet11.add_table(
-    'B3:G8',
-    {
-        :data      => data,
-        :style     => 'Table Style Light 11',
-        :total_row => 1,
-        :columns   => [
-            { :header => 'Product',   :total_string   => 'Totals' },
-            { :header => 'Quarter 1', :total_function => 'sum' },
-            { :header => 'Quarter 2', :total_function => 'sum' },
-            { :header => 'Quarter 3', :total_function => 'sum' },
-            { :header => 'Quarter 4', :total_function => 'sum' },
-            {
-                :header         => 'Year',
-                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
-                :total_function => 'sum'
-            }
-        ]
-    }
+  'B3:G8',
+  {
+    :data      => data,
+    :style     => 'Table Style Light 11',
+    :total_row => 1,
+    :columns   => [
+      { :header => 'Product',   :total_string   => 'Totals' },
+      { :header => 'Quarter 1', :total_function => 'sum' },
+      { :header => 'Quarter 2', :total_function => 'sum' },
+      { :header => 'Quarter 3', :total_function => 'sum' },
+      { :header => 'Quarter 4', :total_function => 'sum' },
+      {
+        :header         => 'Year',
+        :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        :total_function => 'sum'
+      }
+    ]
+  }
 )
 
-
 ###############################################################################
 #
 # Example 12.
@@ -364,28 +356,28 @@ worksheet13.add_table(
       {
         :header         => 'Quarter 1',
         :total_function => 'sum',
-        :format         => currency_format,
+        :format         => currency_format
       },
       {
         :header         => 'Quarter 2',
         :total_function => 'sum',
-        :format         => currency_format,
+        :format         => currency_format
       },
       {
         :header         => 'Quarter 3',
         :total_function => 'sum',
-        :format         => currency_format,
+        :format         => currency_format
       },
       {
         :header         => 'Quarter 4',
         :total_function => 'sum',
-        :format         => currency_format,
+        :format         => currency_format
       },
       {
         :header         => 'Year',
         :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
         :total_function => 'sum',
-        :format         => currency_format,
+        :format         => currency_format
       }
     ]
   }

data/examples/update_range_format_with_params.rb

@@ -15,10 +15,10 @@ worksheet = workbook.add_worksheet
 common_format = workbook.add_format(align: 'center', border: 1)
 
 table_contents = [
-  ['Table', 'Header', 'Contents'],
-  ['table', 'body', 'contents'],
-  ['table', 'body', 'contents'],
-  ['table', 'body', 'contents']
+  %w[Table Header Contents],
+  %w[table body contents],
+  %w[table body contents],
+  %w[table body contents]
 ]
 
 worksheet.write_col(0, 0, table_contents, common_format)

data/lib/write_xlsx/chart/area.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 ###############################################################################
 #
 # Area - A class for writing Excel Area charts.
@@ -27,9 +28,7 @@ module Writexlsx
         @show_crosses  = false
 
         # Override and reset the default axis values.
-        if @subtype == 'percent_stacked'
-          @y_axis.defaults[:num_format] = '0%'
-        end
+        @y_axis.defaults[:num_format] = '0%' if @subtype == 'percent_stacked'
 
         set_y_axis
 
@@ -53,16 +52,16 @@ module Writexlsx
         series = axes_series(params)
         return if series.empty?
 
-        if @subtype == 'percent_stacked'
-          subtype = 'percentStacked'
-        else
-          subtype = @subtype
-        end
+        subtype = if @subtype == 'percent_stacked'
+                    'percentStacked'
+                  else
+                    @subtype
+                  end
         @writer.tag_elements('c:areaChart') do
           # Write the c:grouping element.
           write_grouping(subtype)
           # Write the series elements.
-          series.each {|s| write_series(s)}
+          series.each { |s| write_series(s) }
 
           # Write the c:dropLines element.
           write_drop_lines

data/lib/write_xlsx/chart/axis.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 require 'write_xlsx/chart/caption'
@@ -17,6 +18,7 @@ module Writexlsx
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
       attr_reader :interval_tick, :major_gridlines, :minor_gridlines, :reverse
       attr_reader :line, :fill, :text_axis, :label_align
+
       #
       # Convert user defined axis values into axis instance.
       #
@@ -24,11 +26,11 @@ module Writexlsx
         super
         args      = (defaults || {}).merge(params)
 
-        [
-          :reverse, :min, :max, :minor_unit, :major_unit, :minor_unit_type,
-          :major_unit_type, :log_base, :crossing, :position_axis,
-          :label_position, :num_format, :num_format_linked, :interval_unit,
-          :interval_tick, :line, :fill, :label_align
+        %i[
+          reverse min max minor_unit major_unit minor_unit_type
+          major_unit_type log_base crossing position_axis
+          label_position num_format num_format_linked interval_unit
+          interval_tick line fill label_align
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
         set_major_minor_gridlines(args)
 
@@ -94,7 +96,7 @@ module Writexlsx
 
       def set_major_minor_gridlines(args)
         # Map major/minor_gridlines properties.
-        [:major_gridlines, :minor_gridlines].each do |lines|
+        %i[major_gridlines minor_gridlines].each do |lines|
           if args[lines] && ptrue?(args[lines][:visible])
             instance_variable_set("@#{lines}", Gridline.new(args[lines]))
           else
@@ -108,7 +110,6 @@ module Writexlsx
       # Convert user defined display units to internal units.
       #
       def get_display_units(display_units)
-
         return unless ptrue?(display_units)
 
         types = {
@@ -123,19 +124,14 @@ module Writexlsx
           'trillions'         => 'trillions'
         }
 
-        if types[display_units]
-          return types[display_units]
-        else
-          # warn "Unknown display_units type '$display_units'\n"
-          return
-        end
+        types[display_units] || warn("Unknown display_units type '$display_units'\n")
       end
 
       #
       # Convert user tick types to internal units.
       #
       def get_tick_type(tick_type)
-        return if !ptrue?(tick_type)
+        return unless ptrue?(tick_type)
 
         types = {
           'outside' => 'out',
@@ -144,11 +140,7 @@ module Writexlsx
           'cross'   => 'cross'
         }
 
-        if(types[tick_type])
-          return types[tick_type]
-        else
-          raise "Unknown tick_type type '#{tick_type}'\n"
-        end
+        types[tick_type] || raise("Unknown tick_type type '#{tick_type}'\n")
       end
 
       def set_display_units(args)
@@ -156,11 +148,7 @@ module Writexlsx
       end
 
       def set_display_units_visible(args)
-        if args[:display_units_visible]
-          @display_units_visible = args[:display_units_visible]
-        else
-          @display_units_visible = 1
-        end
+        @display_units_visible = args[:display_units_visible] || 1
       end
 
       def set_position(args)

data/lib/write_xlsx/chart/bar.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 ###############################################################################
 #
 # Bar - A class for writing Excel Bar charts.
@@ -47,10 +48,7 @@ module Writexlsx
       # charts to ensure that their combined chart is on a secondary axis.
       #
       def combine(chart)
-
-        unless chart.is_secondary?
-          raise 'Charts combined with Bar charts must be on a secondary axis'
-        end
+        raise 'Charts combined with Bar charts must be on a secondary axis' unless chart.is_secondary?
 
         super
       end
@@ -62,9 +60,7 @@ module Writexlsx
         if params[:primary_axes] != 0
           # Reverse X and Y axes for Bar charts.
           @y_axis, @x_axis = @x_axis, @y_axis
-          if @y2_axis.position == 'r'
-            @y2_axis.position = 't'
-          end
+          @y2_axis.position = 't' if @y2_axis.position == 'r'
         end
 
         # Write the c:barChart element.
@@ -75,7 +71,7 @@ module Writexlsx
       # Write the <c:barDir> element.
       #
       def write_bar_dir
-        @writer.empty_tag('c:barDir', [ ['val', 'bar'] ])
+        @writer.empty_tag('c:barDir', [%w[val bar]])
       end
 
       #

data/lib/write_xlsx/chart/column.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 ###############################################################################
 #
 # Column - A class for writing Excel Column charts.
@@ -34,9 +35,7 @@ module Writexlsx
         @horiz_val_axis = 0
 
         # Override and reset the default axis values.
-        if @subtype == 'percent_stacked'
-          @y_axis.defaults[:num_format] = '0%'
-        end
+        @y_axis.defaults[:num_format] = '0%' if @subtype == 'percent_stacked'
 
         set_y_axis
 
@@ -62,7 +61,7 @@ module Writexlsx
       # Write the <c:barDir> element.
       #
       def write_bar_dir
-        @writer.empty_tag('c:barDir', [ ['val', 'col'] ])
+        @writer.empty_tag('c:barDir', [%w[val col]])
       end
 
       #

data/lib/write_xlsx/chart/doughnut.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 ###############################################################################
 #
 # Doughnut - A class for writing Excel Doughnut charts.
@@ -39,7 +40,7 @@ module Writexlsx
         if size >= 10 && size <= 90
           @hole_size = size
         else
-          raise "Hole size $size outside Excel range: 10 <= size <= 90";
+          raise "Hole size $size outside Excel range: 10 <= size <= 90"
         end
       end
 
@@ -83,7 +84,7 @@ module Writexlsx
       # Write the <c:holeSize> element.
       #
       def write_hole_size
-        @writer.empty_tag('c:holeSize', [ ['val', @hole_size] ])
+        @writer.empty_tag('c:holeSize', [['val', @hole_size]])
       end
     end
   end

data/lib/write_xlsx/chart/line.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 ###############################################################################
 #
 # Line - A class for writing Excel Line charts.
@@ -22,28 +23,26 @@ module Writexlsx
 
       def initialize(subtype)
         super(subtype)
-        @subtype        = @subtype || 'standard'
+        @subtype ||= 'standard'
         @default_marker = Marker.new(:type => 'none')
         @smooth_allowed = 1
 
         # Override and reset the default axis values.
-        if @subtype == 'percent_stacked'
-          @y_axis.defaults[:num_format] = '0%'
-        end
+        @y_axis.defaults[:num_format] = '0%' if @subtype == 'percent_stacked'
 
         set_y_axis
 
         # Set the available data label positions for this chart type.
         @label_position_default = 'right'
         @label_positions = {
-          'center'      => 'ctr',
-          'right'       => 'r',
-          'left'        => 'l',
-          'above'       => 't',
-          'below'       => 'b',
+          'center' => 'ctr',
+          'right'  => 'r',
+          'left'   => 'l',
+          'above'  => 't',
+          'below'  => 'b',
           # For backward compatibility.
-          'top'         => 't',
-          'bottom'      => 'b'
+          'top'    => 't',
+          'bottom' => 'b'
         }
       end
 
@@ -62,17 +61,17 @@ module Writexlsx
         series = axes_series(params)
         return if series.empty?
 
-        if @subtype == 'percent_stacked'
-          subtype = 'percentStacked'
-        else
-          subtype = @subtype
-        end
+        subtype = if @subtype == 'percent_stacked'
+                    'percentStacked'
+                  else
+                    @subtype
+                  end
 
         @writer.tag_elements('c:lineChart') do
           # Write the c:grouping element.
           write_grouping(subtype)
           # Write the series elements.
-          series.each {|s| write_series(s)}
+          series.each { |s| write_series(s) }
 
           # Write the c:dropLines element.
           write_drop_lines

data/lib/write_xlsx/chart/pie.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 ###############################################################################
 #
 # Pie - A class for writing Excel Pie charts.
@@ -47,6 +48,7 @@ module Writexlsx
       #
       def set_rotation(rotation)
         return unless rotation
+
         if rotation >= 0 && rotation <= 360
           @rotation = rotation
         else
@@ -71,7 +73,7 @@ module Writexlsx
           # Write the c:varyColors element.
           write_vary_colors
           # Write the series elements.
-          @series.each {|s| write_series(s)}
+          @series.each { |s| write_series(s) }
           # Write the c:firstSliceAng element.
           write_first_slice_ang
         end
@@ -94,11 +96,11 @@ module Writexlsx
           # Configure a combined chart if present.
           if second_chart
             # Secondary axis has unique id otherwise use same as primary.
-            if second_chart.is_secondary?
-              second_chart.id = 1000 + @id
-            else
-              second_chart.id = @id
-            end
+            second_chart.id = if second_chart.is_secondary?
+                                1000 + @id
+                              else
+                                @id
+                              end
 
             # Share the same filehandle for writing
             second_chart.writer = @writer
@@ -121,7 +123,7 @@ module Writexlsx
       #
       def write_legend
         position = @legend.position
-        allowed  = %w(right left top bottom)
+        allowed  = %w[right left top bottom]
         delete_series = @legend.delete_series || []
 
         if @legend.position =~ /^overlay_/
@@ -157,9 +159,7 @@ module Writexlsx
       #
       def write_tx_pr_legend(horiz, font)
         rotation = nil
-        if ptrue?(font) && font[:_rotation]
-          rotation = font[:_rotation]
-        end
+        rotation = font[:_rotation] if ptrue?(font) && font[:_rotation]
 
         @writer.tag_elements('c:txPr') do
           # Write the a:bodyPr element.
@@ -187,7 +187,7 @@ module Writexlsx
       # Write the <a:pPr> element for legends.
       #
       def write_a_p_pr_legend(font)
-        @writer.tag_elements('a:pPr', [ ['rtl', 0] ]) do
+        @writer.tag_elements('a:pPr', [['rtl', 0]]) do
           # Write the a:defRPr element.
           write_a_def_rpr(font)
         end
@@ -197,14 +197,14 @@ module Writexlsx
       # Write the <c:varyColors> element.
       #
       def write_vary_colors
-        @writer.empty_tag('c:varyColors', [ ['val', 1] ])
+        @writer.empty_tag('c:varyColors', [['val', 1]])
       end
 
       #
       # Write the <c:firstSliceAng> element.
       #
       def write_first_slice_ang
-        @writer.empty_tag('c:firstSliceAng', [ ['val', @rotation] ])
+        @writer.empty_tag('c:firstSliceAng', [['val', @rotation]])
       end
     end
   end