write_xlsx 1.09.3 → 1.11.2

data/lib/write_xlsx/package/comments.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'write_xlsx/format'
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
-
     class Comment
       include Writexlsx::Utility
 
@@ -21,9 +22,10 @@ module Writexlsx
         options ||= {}
         @workbook    = workbook
         @worksheet   = worksheet
-        @row, @col   = row, col
+        @row = row
+        @col = col
         options_parse(row, col, options)
-        @string      = string[0, STR_MAX]
+        @string = string[0, STR_MAX]
         @start_row   ||= default_start_row(row)
         @start_col   ||= default_start_col(col)
         @visible     = options[:visible]
@@ -31,8 +33,8 @@ module Writexlsx
         @y_offset    = options[:y_offset] || default_y_offset(row)
         @x_scale     = options[:x_scale]  || 1
         @y_scale     = options[:y_scale]  || 1
-        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @width       = (0.5 + ((options[:width]  || DEFAULT_WIDTH)  * @x_scale)).to_i
+        @height      = (0.5 + ((options[:height] || DEFAULT_HEIGHT) * @y_scale)).to_i
         @vertices    = @worksheet.position_object_pixels(
           @start_col, @start_row, @x_offset, @y_offset,
           @width, @height
@@ -55,10 +57,9 @@ module Writexlsx
       # Minor modification to allow comparison testing. Change RGB colors
       # from long format, ffcc00 to short format fc0 used by VML.
       def rgb_color(rgb)
-        result = sprintf("%02x%02x%02x", *rgb)
-        if result =~ /^([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3$/
-          result = "#{$1}#{$2}#{$3}"
-        end
+        r, g, b = rgb
+        result = sprintf("%02x%02x%02x", r, g, b)
+        result = "#{::Regexp.last_match(1)}#{::Regexp.last_match(2)}#{::Regexp.last_match(3)}" if result =~ /^([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3$/
         result
       end
 
@@ -113,7 +114,8 @@ module Writexlsx
       end
 
       def v_shape_attributes(id, z_index)
-        attr = v_shape_attributes_base(id, z_index)
+        attr = v_shape_attributes_base(id)
+        attr << ['style', (v_shape_style_base(z_index, vertices) + style_addition).join]
         attr << ['fillcolor',   color]
         attr << ['o:insetmode', 'auto']
         attr
@@ -164,9 +166,9 @@ module Writexlsx
       #
       def write_shadow
         attributes = [
-          ['on',       't'],
-          ['color',    'black'],
-          ['obscured', 't']
+          %w[on t],
+          %w[color black],
+          %w[obscured t]
         ]
 
         @writer.empty_tag('v:shadow', attributes)
@@ -191,7 +193,7 @@ module Writexlsx
       #
       def write_client_data
         attributes = [
-          ['ObjectType', 'Note']
+          %w[ObjectType Note]
         ]
 
         @writer.tag_elements('x:ClientData', attributes) do
@@ -210,9 +212,7 @@ module Writexlsx
         end
       end
 
-      def writer=(w)
-        @writer = w
-      end
+      attr_writer :writer
 
       def font_name
         @font
@@ -227,7 +227,7 @@ module Writexlsx
         @start_row, @start_col = if @start_cell
                                    substitute_cellref(@start_cell)
                                  else
-                                   [ options[:start_row], options[:start_col] ]
+                                   [options[:start_row], options[:start_col]]
                                  end
         @visible     = options[:visible]
         @x_offset    = options[:x_offset]       || default_x_offset(col)
@@ -237,13 +237,12 @@ module Writexlsx
         @font        = options[:font]           || 'Tahoma'
         @font_size   = options[:font_size]      || 8
         @font_family = options[:font_family]    || 2
-        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @width       = (0.5 + ((options[:width]  || DEFAULT_WIDTH)  * @x_scale)).to_i
+        @height      = (0.5 + ((options[:height] || DEFAULT_HEIGHT) * @y_scale)).to_i
       end
     end
 
     class Comments
-
       include Writexlsx::Utility
 
       def initialize(worksheet)
@@ -312,7 +311,6 @@ module Writexlsx
 
       private
 
-
       def comments_visible?
         @worksheet.comments_visible?
       end
@@ -320,10 +318,10 @@ module Writexlsx
       #
       # Write the <comments> element.
       #
-      def write_comments
-        attributes = [ ['xmlns', XMLWriterSimple::XMLNS] ]
+      def write_comments(&block)
+        attributes = [['xmlns', XMLWriterSimple::XMLNS]]
 
-        @writer.tag_elements('comments', attributes) { yield }
+        @writer.tag_elements('comments', attributes, &block)
       end
 
       #
@@ -335,14 +333,14 @@ module Writexlsx
         @writer.tag_elements('authors') do
           comment_data.each do |comment|
             author = comment.author || ''
-            if author && !@author_ids[author]
-              # Store the author id.
-              @author_ids[author] = author_count
-              author_count += 1
+            next unless author && !@author_ids[author]
 
-              # Write the author element.
-              write_author(author)
-            end
+            # Store the author id.
+            @author_ids[author] = author_count
+            author_count += 1
+
+            # Write the author element.
+            write_author(author)
           end
         end
       end
@@ -367,8 +365,8 @@ module Writexlsx
       # Write the <comment> element.
       #
       def write_comment(comment)
-        ref       = xl_rowcol_to_cell( comment.row, comment.col )
-        attributes = [ ['ref', ref] ]
+        ref = xl_rowcol_to_cell(comment.row, comment.col)
+        attributes = [['ref', ref]]
 
         author_id = (@author_ids[comment.author] if comment.author) || 0
         attributes << ['authorId', author_id]
@@ -432,7 +430,7 @@ module Writexlsx
       # Write the <sz> element.
       #
       def write_sz(val)
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('sz', attributes)
       end
@@ -441,14 +439,14 @@ module Writexlsx
       # Write the <color> element.
       #
       def write_color
-        @writer.empty_tag('color', [ ['indexed', 81] ])
+        @writer.empty_tag('color', [['indexed', 81]])
       end
 
       #
       # Write the <rFont> element.
       #
       def write_r_font(val)
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('rFont', attributes)
       end
@@ -457,7 +455,7 @@ module Writexlsx
       # Write the <family> element.
       #
       def write_family(val)
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('family', attributes)
       end

data/lib/write_xlsx/package/conditional_format.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   module Package
@@ -7,8 +8,9 @@ module Writexlsx
 
       def self.factory(worksheet, *args)
         range, param  =
-               Package::ConditionalFormat.new(worksheet, nil, nil).
-                 range_param_for_conditional_formatting(*args)
+          Package::ConditionalFormat
+          .new(worksheet, nil, nil)
+          .range_param_for_conditional_formatting(*args)
 
         case param[:type]
         when 'cellIs'
@@ -39,7 +41,9 @@ module Writexlsx
       attr_reader :range
 
       def initialize(worksheet, range, param)
-        @worksheet, @range, @param = worksheet, range, param
+        @worksheet = worksheet
+        @range = range
+        @param = param
         @writer = @worksheet.writer
       end
 
@@ -53,7 +57,7 @@ module Writexlsx
         end
       end
 
-      def write_formula_tag(data) #:nodoc:
+      def write_formula_tag(data) # :nodoc:
         data = data.sub(/^=/, '') if data.respond_to?(:sub)
         @writer.data_element('formula', data)
       end
@@ -62,8 +66,8 @@ module Writexlsx
       # Write the <cfvo> element.
       #
       def write_cfvo(type, value, criteria = nil)
-        attributes = [ ['type', type] ]
-        attributes << [ 'val', value] if value
+        attributes = [['type', type]]
+        attributes << ['val', value] if value
 
         attributes << ['gte', 0] if ptrue?(criteria)
 
@@ -72,7 +76,7 @@ module Writexlsx
 
       def attributes
         attr = []
-        attr << ['type' , type]
+        attr << ['type', type]
         attr << ['dxfId',    format]   if format
         attr << ['priority', priority]
         attr << ['stopIfTrue', 1] if stop_if_true
@@ -122,6 +126,7 @@ module Writexlsx
       def min_type
         @param[:min_type]
       end
+
       def min_value
         @param[:min_value]
       end
@@ -222,21 +227,21 @@ module Writexlsx
       def handling_of_text_criteria
         case @param[:criteria]
         when 'containsText'
-          @param[:type]    = 'containsText';
+          @param[:type]    = 'containsText'
           @param[:formula] =
-            %Q!NOT(ISERROR(SEARCH("#{@param[:value]}",#{@start_cell})))!
+            %!NOT(ISERROR(SEARCH("#{@param[:value]}",#{@start_cell})))!
         when 'notContains'
-          @param[:type]    = 'notContainsText';
+          @param[:type]    = 'notContainsText'
           @param[:formula] =
-            %Q!ISERROR(SEARCH("#{@param[:value]}",#{@start_cell}))!
+            %!ISERROR(SEARCH("#{@param[:value]}",#{@start_cell}))!
         when 'beginsWith'
           @param[:type] = 'beginsWith'
           @param[:formula] =
-            %Q!LEFT(#{@start_cell},#{@param[:value].size})="#{@param[:value]}"!
+            %!LEFT(#{@start_cell},#{@param[:value].size})="#{@param[:value]}"!
         when 'endsWith'
           @param[:type] = 'endsWith'
           @param[:formula] =
-            %Q!RIGHT(#{@start_cell},#{@param[:value].size})="#{@param[:value]}"!
+            %!RIGHT(#{@start_cell},#{@param[:value].size})="#{@param[:value]}"!
         else
           raise "Invalid text criteria '#{@param[:criteria]} in conditional_formatting()"
         end
@@ -304,8 +309,8 @@ module Writexlsx
           @param[:min_color] ||= '#FF7128'
           @param[:max_color] ||= '#FFEF9C'
 
-          @param[:max_color] = palette_color( @param[:max_color] )
-          @param[:min_color] = palette_color( @param[:min_color] )
+          @param[:max_color] = palette_color(@param[:max_color])
+          @param[:min_color] = palette_color(@param[:min_color])
         when '3_color_scale'
           @param[:type] = 'colorScale'
 
@@ -329,17 +334,17 @@ module Writexlsx
           # Excel 2007 data bars don't use any additional formatting.
           @param[:format] = nil
 
-          if !@param[:min_type]
+          if @param[:min_type]
+            @param[:x14_min_type] = @param[:min_type]
+          else
             @param[:min_type]     = 'min'
             @param[:x14_min_type] = 'autoMin'
-          else
-            @param[:x14_min_type] = @param[:min_type]
           end
-          if !@param[:max_type]
+          if @param[:max_type]
+            @param[:x14_max_type] = @param[:max_type]
+          else
             @param[:max_type]     = 'max'
             @param[:x14_max_type] = 'autoMax'
-          else
-            @param[:x14_max_type] = @param[:max_type]
           end
 
           @param[:min_value]                      ||= 0
@@ -373,12 +378,8 @@ module Writexlsx
         if ptrue?(@param[:is_data_bar_2010])
           @worksheet.excel_version = 2010
 
-          if @param[:min_type] == 'min' && @param[:min_value] == 0
-            @param[:min_value] = nil
-          end
-          if @param[:max_type] == 'max' && @param[:max_value] == 0
-            @param[:max_value] = nil
-          end
+          @param[:min_value] = nil if @param[:min_type] == 'min' && @param[:min_value] == 0
+          @param[:max_value] = nil if @param[:max_type] == 'max' && @param[:max_value] == 0
 
           # Store range for Excel 2010 data bars.
           @param[:range] = range
@@ -395,8 +396,8 @@ module Writexlsx
       end
 
       def range_start_cell_for_conditional_formatting(*args)  # :nodoc:
-        row1, row2, col1, col2, user_range, param =
-                                            row_col_param_for_conditional_formatting(*args)
+        row1, row2, col1, col2, user_range, _param =
+          row_col_param_for_conditional_formatting(*args)
         range       = xl_range(row1, row2, col1, col2)
         @start_cell = xl_rowcol_to_cell(row1, col1)
 
@@ -408,15 +409,27 @@ module Writexlsx
 
       def row_col_param_for_conditional_formatting(*args)
         # Check for a cell reference in A1 notation and substitute row and column
-        if args[0].to_s =~ /^\D/
-          # Check for a user defined multiple range like B3:K6,B8:K11.
-          user_range = args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub(/\$/, '') if args[0] =~ /,/
+        user_range = if args[0].to_s =~ (/^\D/) && (args[0] =~ /,/)
+                       # Check for a user defined multiple range like B3:K6,B8:K11.
+                       args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub("$", '')
+                     end
+
+        if (row_col_array = row_col_notation(args.first))
+          if row_col_array.size == 2
+            row1, col1 = row_col_array
+            row2 = args[1]
+          elsif row_col_array.size == 4
+            row1, col1, row2, col2 = row_col_array
+            param = args[1]
+          end
+        else
+          row1, col1, row2, col2, param = args
         end
 
-        row1, col1, row2, col2, param = row_col_notation(args)
         if row2.respond_to?(:keys)
           param = row2
-          row2, col2 = row1, col1
+          row2 = row1
+          col2 = col1
         end
         raise WriteXLSXInsufficientArgumentError if [row1, col1, row2, col2, param].include?(nil)
 
@@ -432,19 +445,18 @@ module Writexlsx
       end
 
       def param_for_conditional_formatting(*args)  # :nodoc:
-        dummy, dummy, dummy, dummy, dummy, @param =
-                                           row_col_param_for_conditional_formatting(*args)
+        _dummy, _dummy, _dummy, _dummy, _dummy, @param =
+          row_col_param_for_conditional_formatting(*args)
         check_conditional_formatting_parameters(@param)
 
         @param[:format] = @param[:format].get_dxf_index if @param[:format]
         @param[:priority] = @worksheet.dxf_priority
 
         # Check for 2010 style data_bar parameters.
-        %i(data_bar_2010 bar_solid bar_border_color bar_negative_color
+        %i[data_bar_2010 bar_solid bar_border_color bar_negative_color
            bar_negative_color_same bar_negative_border_color
            bar_negative_border_color_same bar_no_border
-           bar_axis_position bar_axis_color bar_direction
-        ).each do |key|
+           bar_axis_position bar_axis_color bar_direction].each do |key|
           if @param[key]
             @param[:is_data_bar_2010] = 1
             break
@@ -466,9 +478,7 @@ module Writexlsx
         param[:type] = valid_type_for_conditional_formatting[param[:type].downcase]
 
         # Check for valid criteria types.
-        if param.has_key?(:criteria) && valid_criteria_type_for_conditional_formatting.has_key?(param[:criteria].downcase)
-          param[:criteria] = valid_criteria_type_for_conditional_formatting[param[:criteria].downcase]
-        end
+        param[:criteria] = valid_criteria_type_for_conditional_formatting[param[:criteria].downcase] if param.has_key?(:criteria) && valid_criteria_type_for_conditional_formatting.has_key?(param[:criteria].downcase)
 
         # Convert date/times value if required.
         if %w[date time cellIs].include?(param[:type])
@@ -481,17 +491,17 @@ module Writexlsx
 
         # Set properties for icon sets.
         if param[:type] == 'iconSet'
-          if !param[:icon_style]
+          unless param[:icon_style]
             raise "The 'icon_style' parameter must be specified when " +
                   "'type' == 'icon_set' in conditional_formatting()"
           end
 
           # Check for valid icon styles.
-          if !icon_set_styles[param[:icon_style]]
+          if icon_set_styles[param[:icon_style]]
+            param[:icon_style] = icon_set_styles[param[:icon_style]]
+          else
             raise "Unknown icon style '$param->{icon_style}' for parameter " +
                   "'icon_style' in conditional_formatting()"
-          else
-            param[:icon_style] = icon_set_styles[param[:icon_style]]
           end
 
           # Set the number of icons for the icon style.
@@ -507,26 +517,21 @@ module Writexlsx
 
         # 'Between' and 'Not between' criteria require 2 values.
         if param[:criteria] == 'between' || param[:criteria] == 'notBetween'
-          unless param.has_key?(:minimum) || param.has_key?(:maximum)
-            raise WriteXLSXOptionParameterError, "Invalid criteria : #{param[:criteria]}"
-          end
+          raise WriteXLSXOptionParameterError, "Invalid criteria : #{param[:criteria]}" unless param.has_key?(:minimum) || param.has_key?(:maximum)
         else
           param[:minimum] = nil
           param[:maximum] = nil
         end
 
         # Convert date/times value if required.
-        if param[:type] == 'date' || param[:type] == 'time'
-          unless convert_date_time_value(param, :value) || convert_date_time_value(param, :maximum)
-            raise WriteXLSXOptionParameterError
-          end
-        end
+        raise WriteXLSXOptionParameterError if (param[:type] == 'date' || param[:type] == 'time') && !(convert_date_time_value(param, :value) || convert_date_time_value(param, :maximum))
       end
 
       def convert_date_time_if_required(val)
         if val.to_s =~ /T/
           date_time = convert_date_time(val)
           raise "Invalid date/time value '#{val}' in conditional_formatting()" unless date_time
+
           date_time
         else
           val
@@ -535,40 +540,40 @@ module Writexlsx
 
       # List of valid input parameters for conditional_formatting.
       def valid_parameter_for_conditional_formatting
-        [
-          :type,
-          :format,
-          :criteria,
-          :value,
-          :minimum,
-          :maximum,
-          :stop_if_true,
-          :min_type,
-          :mid_type,
-          :max_type,
-          :min_value,
-          :mid_value,
-          :max_value,
-          :min_color,
-          :mid_color,
-          :max_color,
-          :bar_color,
-          :bar_negative_color,
-          :bar_negative_color_same,
-          :bar_solid,
-          :bar_border_color,
-          :bar_negative_border_color,
-          :bar_negative_border_color_same,
-          :bar_no_border,
-          :bar_direction,
-          :bar_axis_position,
-          :bar_axis_color,
-          :bar_only,
-          :icon_style,
-          :reverse_icons,
-          :icons_only,
-          :icons,
-          :data_bar_2010
+        %i[
+          type
+          format
+          criteria
+          value
+          minimum
+          maximum
+          stop_if_true
+          min_type
+          mid_type
+          max_type
+          min_value
+          mid_value
+          max_value
+          min_color
+          mid_color
+          max_color
+          bar_color
+          bar_negative_color
+          bar_negative_color_same
+          bar_solid
+          bar_border_color
+          bar_negative_border_color
+          bar_negative_border_color_same
+          bar_no_border
+          bar_direction
+          bar_axis_position
+          bar_axis_color
+          bar_only
+          icon_style
+          reverse_icons
+          icons_only
+          icons
+          data_bar_2010
         ]
       end
 
@@ -651,7 +656,7 @@ module Writexlsx
           "4_arrows_gray"           => "4ArrowsGray",        # 14
           "4_ratings"               => "4Rating",            # 15
           "5_arrows"                => "5Arrows",            # 16
-          "5_ratings"               => "5Rating",            # 17
+          "5_ratings"               => "5Rating"            # 17
         }
       end
 
@@ -664,9 +669,9 @@ module Writexlsx
         # Set the default icon properties.
         total_icons.times do
           props << {
-            :criteria => 0,
-            :value    => 0,
-            :type     => 'percent'
+            criteria: 0,
+            value:    0,
+            type:     'percent'
           }
         end
 
@@ -690,13 +695,11 @@ module Writexlsx
 
           # Ensure we don't set user properties for lowest icon.
           max_data = user_props.size
-          max_data = total_icons -1 if max_data >= total_icons
+          max_data = total_icons - 1 if max_data >= total_icons
 
           (0..max_data - 1).each do |i|
             # Set the user defined 'value' property.
-            if user_props[i][:value]
-              props[i][:value] = user_props[i][:value].to_s.sub(/^=/, '')
-            end
+            props[i][:value] = user_props[i][:value].to_s.sub(/^=/, '') if user_props[i][:value]
 
             # Set the user defined 'type' property.
             if user_props[i][:type]
@@ -710,17 +713,12 @@ module Writexlsx
               else
                 props[i][:type] = type
 
-                if props[i][:type] == 'number'
-                  props[i][:type] = 'num'
-                end
+                props[i][:type] = 'num' if props[i][:type] == 'number'
               end
             end
 
             # Set the user defined 'criteria' property.
-            if user_props[i][:criteria] && user_props[i][:criteria] == '>'
-              props[i][:criteria] = 1
-            end
-
+            props[i][:criteria] = 1 if user_props[i][:criteria] && user_props[i][:criteria] == '>'
           end
         end
         props
@@ -749,7 +747,7 @@ module Writexlsx
           if !(quoted_value =~ /(\$?)([A-Z]{1,3})(\$?)(\d+)/) &&
              !(quoted_value =~ numeric_regex) &&
              !(quoted_value =~ /^".*"$/)
-            quoted_value = (%Q!"#{value}"!)
+            quoted_value = %("#{value}")
           end
           write_cf_rule_formula_tag(quoted_value)
         end
@@ -761,9 +759,7 @@ module Writexlsx
         attr = super
         attr << ['aboveAverage', 0] if criteria =~ /below/
         attr << ['equalAverage', 1] if criteria =~ /equal/
-        if criteria =~ /([123]) std dev/
-          attr << ['stdDev', $~[1]]
-        end
+        attr << ['stdDev', $~[1]] if criteria =~ /([123]) std dev/
         attr
       end
     end
@@ -773,7 +769,7 @@ module Writexlsx
         attr = super
         attr << ['percent', 1]             if criteria == '%'
         attr << ['bottom',  1]             if direction
-        attr << ['rank',    (value || 10)]
+        attr << ['rank',    value || 10]
         attr
       end
     end
@@ -822,9 +818,9 @@ module Writexlsx
           write_cfvo(min_type, min_value)
           write_cfvo(mid_type, mid_value) if mid_type
           write_cfvo(max_type, max_value)
-          write_color(@writer, 'rgb', min_color)
-          write_color(@writer, 'rgb', mid_color)  if mid_color
-          write_color(@writer, 'rgb', max_color)
+          write_color('rgb', min_color)
+          write_color('rgb', mid_color)  if mid_color
+          write_color('rgb', max_color)
         end
       end
     end
@@ -833,9 +829,7 @@ module Writexlsx
       def write_cf_rule
         @writer.tag_elements('cfRule', attributes) do
           write_data_bar
-          if ptrue?(@param[:is_data_bar_2010])
-            write_data_bar_ext(@param)
-          end
+          write_data_bar_ext(@param) if ptrue?(@param[:is_data_bar_2010])
         end
       end
 
@@ -845,14 +839,12 @@ module Writexlsx
       def write_data_bar
         attributes = []
 
-        if ptrue?(bar_only)
-          attributes << ['showValue', 0]
-        end
-        @writer.tag_elements('dataBar',attributes) do
+        attributes << ['showValue', 0] if ptrue?(bar_only)
+        @writer.tag_elements('dataBar', attributes) do
           write_cfvo(min_type, min_value)
           write_cfvo(max_type, max_value)
 
-          write_color(@writer, 'rgb', bar_color)
+          write_color('rgb', bar_color)
         end
       end
 
@@ -900,7 +892,7 @@ module Writexlsx
       def write_icon_set
         attributes = []
         # Don't set attribute for default style.
-        attributes = [ ['iconSet', icon_style] ] if icon_style != '3TrafficLights'
+        attributes = [['iconSet', icon_style]] if icon_style != '3TrafficLights'
         attributes << ['showValue', 0]           if icons_only
         attributes << ['reverse', 1]             if reverse_icons