write_xlsx 1.09.3 → 1.11.2

data/lib/write_xlsx/chart/line.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 ###############################################################################
 #
 # Line - A class for writing Excel Line charts.
@@ -22,28 +24,26 @@ module Writexlsx
 
       def initialize(subtype)
         super(subtype)
-        @subtype        = @subtype || 'standard'
-        @default_marker = Marker.new(:type => 'none')
+        @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 +62,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,6 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 ###############################################################################
 #
 # Pie - A class for writing Excel Pie charts.
@@ -47,6 +49,7 @@ module Writexlsx
       #
       def set_rotation(rotation)
         return unless rotation
+
         if rotation >= 0 && rotation <= 360
           @rotation = rotation
         else
@@ -71,7 +74,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 +97,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
@@ -120,8 +123,7 @@ module Writexlsx
       # Write the <c:legend> element.
       #
       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,27 @@ 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
+
+      #
+      # Write the <c:showLeaderLines> element. This is for Pie/Doughnut charts.
+      # Other chart types only supported leader lines after Excel 2015 via an
+      # extension element.
+      #
+      def write_show_leader_lines
+        val  = 1
+
+        attributes = [['val', val]]
+
+        @writer.empty_tag('c:showLeaderLines', attributes)
       end
     end
   end

data/lib/write_xlsx/chart/radar.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 ###############################################################################
 #
 # Radar - A class for writing Excel Radar charts.
@@ -31,12 +33,10 @@ module Writexlsx
       def initialize(subtype)
         super(subtype)
         @subtype = subtype || 'marker'
-        if @subtype == 'marker'
-          @default_marker = Marker.new(:type => 'none')
-        end
+        @default_marker = Marker.new(type: 'none') if @subtype == 'marker'
 
         # Override and reset the default axis values.
-        @x_axis.defaults[:major_gridlines] = { :visible => 1 }
+        @x_axis.defaults[:major_gridlines] = { visible: 1 }
         set_x_axis
 
         # Hardcode major_tick_mark for now untill there is an accessor.
@@ -59,11 +59,11 @@ module Writexlsx
       # Write the <c:radarChart> element.
       #
       def write_radar_chart(params)
-        if ptrue?(params[:primary_axes])
-          series = get_primary_axes_series
-        else
-          series = get_secondary_axes_series
-        end
+        series = if ptrue?(params[:primary_axes])
+                   get_primary_axes_series
+                 else
+                   get_secondary_axes_series
+                 end
 
         return if series.empty?
 
@@ -86,7 +86,7 @@ module Writexlsx
         val = 'marker'
         val = 'filled' if @subtype == 'filled'
 
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('c:radarStyle', attributes)
       end

data/lib/write_xlsx/chart/scatter.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 ###############################################################################
 #
 # Scatter - A class for writing Excel Scatter charts.
@@ -32,21 +34,21 @@ module Writexlsx
         # 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
 
       #
       # Override parent method to add a warning.
       #
-      def combine(chart)
+      def combine(_chart)
         raise 'Combined chart not currently supported with scatter chart as the primary chart'
       end
 
@@ -62,16 +64,16 @@ module Writexlsx
       # Write the <c:scatterChart> element.
       #
       def write_scatter_chart(params)
-        if params[:primary_axes] == 1
-          series = get_primary_axes_series
-        else
-          series = get_secondary_axes_series
-        end
+        series = if params[:primary_axes] == 1
+                   get_primary_axes_series
+                 else
+                   get_secondary_axes_series
+                 end
         return if series.empty?
 
-        style   = 'lineMarker'
+        style = 'lineMarker'
         # Set the user defined chart subtype
-        style = 'smoothMarker' if ['smooth_with_markers', 'smooth'].include?(@subtype)
+        style = 'smoothMarker' if %w[smooth_with_markers smooth].include?(@subtype)
 
         # Add default formatting to the series data.
         modify_series_formatting
@@ -80,7 +82,7 @@ module Writexlsx
           # Write the c:scatterStyle element.
           write_scatter_style(style)
           # Write the series elements.
-          series.each {|s| write_series(s)}
+          series.each { |s| write_series(s) }
           # Write the c:marker element.
           write_marker_value
           # Write the c:axId elements
@@ -122,8 +124,8 @@ module Writexlsx
           write_layout(@plotarea.layout, 'plot')
 
           # Write the subclass chart type elements for primary and secondary axes.
-          write_chart_type(:primary_axes => 1)
-          write_chart_type(:primary_axes => 0)
+          write_chart_type(primary_axes: 1)
+          write_chart_type(primary_axes: 0)
 
           # Write c:catAx and c:valAx elements for series using primary axes.
           write_cat_val_axis(@x_axis, @y_axis, @axis_ids, 'b')
@@ -187,7 +189,7 @@ module Writexlsx
       # Write the <c:scatterStyle> element.
       #
       def write_scatter_style(val)
-        @writer.empty_tag('c:scatterStyle', [ ['val', val] ])
+        @writer.empty_tag('c:scatterStyle', [['val', val]])
       end
 
       #
@@ -200,9 +202,7 @@ module Writexlsx
           # Go through each series and define default values.
           @series.each do |series|
             # Set a line type unless there is already a user defined type.
-            unless series.line_defined?
-              series.line = line_properties(:width => 2.25, :none => 1, :_defined => 1)
-            end
+            series.line = line_properties(width: 2.25, none: 1, _defined: 1) unless series.line_defined?
           end
         end
 
@@ -211,9 +211,7 @@ module Writexlsx
           # Go through each series and define default values.
           @series.each do |series|
             # Set a marker type unless there is already a user defined type.
-            unless ptrue?(series.marker)
-              series.marker = Marker.new(:type => 'none', :_defined => 1)
-            end
+            series.marker = Marker.new(type: 'none', _defined: 1) unless ptrue?(series.marker)
           end
         end
       end

data/lib/write_xlsx/chart/series.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Chart
@@ -58,10 +59,13 @@ module Writexlsx
     class Trendline < Chartline
       attr_reader :name, :forward, :backward, :order, :period
       attr_reader :intercept, :display_equation, :display_r_squared
+      attr_reader :label
 
       def initialize(params)
         super(params)
 
+        @label = trendline_label_properties(params[:label])
+
         @name              = params[:name]
         @forward           = params[:forward]
         @backward          = params[:backward]
@@ -75,14 +79,59 @@ module Writexlsx
 
       private
 
+      #
+      # Convert user defined trendline label properties to the structure required
+      # internally.
+      #
+      def trendline_label_properties(_label)
+        return unless _label || _label.is_a?(Hash)
+
+        # Copy the user supplied properties.
+        label = {}
+
+        # Set the font properties for the label.
+        label[:font] = convert_font_args(_label[:font]) if ptrue?(_label[:font])
+
+        # Set the line properties for the label.
+        line = line_properties(_label[:line])
+
+        # Allow 'border' as a synonym for 'line'.
+        line = line_properties(_label[:border]) if ptrue?(_label[:border])
+
+        # Set the fill properties for the label.
+        fill = fill_properties(_label[:fill])
+
+        # Set the pattern properties for the label.
+        pattern = pattern_properties(_label[:pattern])
+
+        # Set the gradient fill properties for the label.
+        gradient = gradient_properties(_label[:gradient])
+
+        # Pattern fill overrides solid fill.
+        fill = nil if ptrue?(pattern)
+
+        # Gradient fill overrides solid and pattern fills.
+        if ptrue?(gradient)
+          pattern = nil
+          fill    = nil
+        end
+
+        label[:line]     = line
+        label[:fill]     = fill
+        label[:pattern]  = pattern
+        label[:gradient] = gradient
+
+        label
+      end
+
       def types
         {
-          :exponential    => 'exp',
-          :linear         => 'linear',
-          :log            => 'log',
-          :moving_average => 'movingAvg',
-          :polynomial     => 'poly',
-          :power          => 'power'
+          exponential:    'exp',
+          linear:         'linear',
+          log:            'log',
+          moving_average: 'movingAvg',
+          polynomial:     'poly',
+          power:          'power'
         }
       end
     end
@@ -93,9 +142,7 @@ module Writexlsx
       def initialize(params)
         super(params)
 
-        if params[:type]
-          @type = value_or_raise(types, params[:type], 'maker type')
-        end
+        @type = value_or_raise(types, params[:type], 'maker type') if params[:type]
 
         @size      = params[:size]
         @automatic = false
@@ -110,20 +157,20 @@ module Writexlsx
 
       def types
         {
-          :automatic  => 'automatic',
-          :none       => 'none',
-          :square     => 'square',
-          :diamond    => 'diamond',
-          :triangle   => 'triangle',
-          :x          => 'x',
-          :star       => 'star',
-          :dot        => 'dot',
-          :short_dash => 'dot',
-          :dash       => 'dash',
-          :long_dash  => 'dash',
-          :circle     => 'circle',
-          :plus       => 'plus',
-          :picture    => 'picture'
+          automatic:  'automatic',
+          none:       'none',
+          square:     'square',
+          diamond:    'diamond',
+          triangle:   'triangle',
+          x:          'x',
+          star:       'star',
+          dot:        'dot',
+          short_dash: 'dot',
+          dash:       'dash',
+          long_dash:  'dash',
+          circle:     'circle',
+          plus:       'plus',
+          picture:    'picture'
         }
       end
     end
@@ -157,11 +204,11 @@ module Writexlsx
 
       def types
         {
-          :fixed              => 'fixedVal',
-          :percentage         => 'percentage',
-          :standard_deviation => 'stdDev',
-          :standard_error     => 'stdErr',
-          :custom             => 'cust'
+          fixed:              'fixedVal',
+          percentage:         'percentage',
+          standard_deviation: 'stdDev',
+          standard_error:     'stdErr',
+          custom:             'cust'
         }
       end
 
@@ -184,6 +231,7 @@ module Writexlsx
       attr_reader :values, :categories, :name, :name_formula, :name_id
       attr_reader :cat_data_id, :val_data_id, :fill, :pattern, :gradient
       attr_reader :trendline, :smooth, :labels, :invert_if_negative
+      attr_reader :inverted_color
       attr_reader :x2_axis, :y2_axis, :error_bars, :points
       attr_accessor :line, :marker
 
@@ -192,7 +240,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)
 
@@ -213,23 +261,30 @@ module Writexlsx
         # Set the trendline properties for the series.
         @trendline  = Trendline.new(params[:trendline]) if params[:trendline]
         @error_bars = errorbars(params[:x_error_bars], params[:y_error_bars])
-        @points     = params[:points].collect { |p| p ? Point.new(p) : p } if params[:points]
+        if params[:points]
+          @points = params[:points].collect { |p| p ? Point.new(p) : p }
+        end
 
         @label_positions = chart.label_positions
         @label_position_default = chart.label_position_default
-        @labels     = labels_properties(params[:data_labels])
+        @labels = labels_properties(params[:data_labels])
+        @inverted_color = params[:invert_if_negative_color]
 
-        [:smooth, :invert_if_negative, :x2_axis, :y2_axis].
-          each { |key| instance_variable_set("@#{key}", params[key]) }
+        %i[
+          smooth invert_if_negative x2_axis y2_axis
+        ].each { |key| instance_variable_set("@#{key}", params[key]) }
       end
 
       def ==(other)
-        methods = %w[categories values name name_formula name_id
-                 cat_data_id val_data_id
-                 line fill gradient marker trendline
-                 smooth labels invert_if_neg x2_axis y2_axis error_bars points ]
+        methods = %w[
+          categories values name name_formula name_id
+          cat_data_id val_data_id
+          line fill gradient marker trendline
+          smooth labels inverted_color
+          x2_axis y2_axis error_bars points
+        ]
         methods.each do |method|
-          return false unless self.instance_variable_get("@#{method}") == other.instance_variable_get("@#{method}")
+          return false unless instance_variable_get("@#{method}") == other.instance_variable_get("@#{method}")
         end
         true
       end
@@ -245,7 +300,8 @@ module Writexlsx
       #
       def aref_to_formula(data) # :nodoc:
         # If it isn't an array ref it is probably a formula already.
-        return data unless data.kind_of?(Array)
+        return data unless data.is_a?(Array)
+
         xl_range_formula(*data)
       end
 
@@ -257,8 +313,8 @@ module Writexlsx
 
       def errorbars(x, y)
         {
-          :_x_error_bars => x ? Errorbars.new(x) : nil,
-          :_y_error_bars => y ? Errorbars.new(y) : nil
+          _x_error_bars: x ? Errorbars.new(x) : nil,
+          _y_error_bars: y ? Errorbars.new(y) : nil
         }
       end
 
@@ -272,11 +328,11 @@ module Writexlsx
         position = labels[:position]
         if ptrue?(position)
           if @label_positions[position]
-            if position == @label_position_default
-              labels[:position] = nil
-            else
-              labels[:position] = @label_positions[position]
-            end
+            labels[:position] = if position == @label_position_default
+                                  nil
+                                else
+                                  @label_positions[position]
+                                end
           else
             raise "Unsupported label position '#{position}' for this chart type"
           end
@@ -293,17 +349,15 @@ module Writexlsx
         separator = labels[:separator]
         unless separator.nil? || separator.empty?
           raise "unsuppoted label separator #{separator}" unless separators[separator]
+
           labels[:separator] = separators[separator]
         end
 
-
         # Set the line properties for the data labels.
-        line = line_properties( labels[:line] )
+        line = line_properties(labels[:line])
 
         # Allow 'border' as a synonym for 'line'.
-        if labels[:border]
-          line = line_properties(labels[:border])
-        end
+        line = line_properties(labels[:border]) if labels[:border]
 
         # Set the fill properties for the labels.
         fill = fill_properties(labels[:fill])
@@ -315,9 +369,7 @@ module Writexlsx
         gradient = gradient_properties(labels[:gradient])
 
         # Pattern fill overrides solid fill.
-        if pattern
-          fill = nil
-        end
+        fill = nil if pattern
 
         # Gradient fill overrides solid and pattern fills.
         if gradient
@@ -330,16 +382,14 @@ module Writexlsx
         labels[:pattern]  = pattern
         labels[:gradient] = gradient
 
-        if labels[:font]
-          labels[:font] = convert_font_args(labels[:font])
-        end
+        labels[:font] = convert_font_args(labels[:font]) if labels[:font]
 
         if labels[:custom]
           # Duplicate, and modify, the custom label properties.
           custom = []
 
           labels[:custom].each do |label|
-            if !label
+            unless label
               custom << nil
               next
             end
@@ -347,9 +397,7 @@ module Writexlsx
             property = label.dup
 
             # Convert formula.
-            if property[:value] && property[:value] =~ /^=[^!]+!\$/
-              property[:formula] = property[:value]
-            end
+            property[:formula] = property[:value] if property[:value] && property[:value].to_s =~ /^=[^!]+!\$/
 
             if property[:formula]
               property[:formula] = property[:formula].sub(/^=/, '')
@@ -358,17 +406,10 @@ module Writexlsx
               property[:data_id] = data_id
             end
 
-            if property[:font]
-              property[:font] = convert_font_args(property[:font])
-            end
+            property[:font] = convert_font_args(property[:font]) if property[:font]
 
             # Allow 'border' as a synonym for 'line'.
-            if property[:border]
-              line = line_properties(property[:border])
-            else
-              # Set the line properties for the data labels.
-              line = line_properties(property[:line])
-            end
+            line = line_properties(property[:border] || property[:line])
 
             # Set the fill properties for the labels.
             fill = fill_properties(property[:fill])
@@ -380,9 +421,7 @@ module Writexlsx
             gradient = gradient_properties(property[:gradient])
 
             # Pattern fill overrides solid fill.
-            if pattern
-              fill = nil
-            end
+            fill = nil if pattern
 
             # Gradient fill overrides solid and pattern fills.
             if gradient