write_xlsx 0.85.8 → 0.87.0

data/lib/write_xlsx/chart/axis.rb

@@ -14,7 +14,7 @@ class Axis < Caption
       attr_reader :display_units_visible, :display_units
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
-      attr_reader :major_gridlines, :minor_gridlines, :reverse
+      attr_reader :interval_tick, :major_gridlines, :minor_gridlines, :reverse
       attr_reader :line, :fill, :text_axis
       #
       # Convert user defined axis values into axis instance.
@@ -27,7 +27,7 @@ def merge_with_hash(params) # :nodoc:
           :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,
-          :major_tick_mark, :line, :fill
+          :interval_tick, :major_tick_mark, :line, :fill
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
         @visible           = args[:visible] || 1
 

data/lib/write_xlsx/chart/series.rb

@@ -8,22 +8,30 @@ class Chartline
       include Writexlsx::Utility
       include Writexlsx::Gradient
 
-      attr_reader :line, :fill, :type
+      attr_reader :line, :fill, :type, :gradient, :pattern
 
       def initialize(params)
         @line      = params[:line]
         @fill      = params[:fill]
+        @pattern   = params[:pattern]
+        @gradient  = params[:gradient]
         # Set the line properties for the marker..
         @line = line_properties(@line)
         # Allow 'border' as a synonym for 'line'.
         @line = line_properties(params[:border]) if params[:border]
-
-        # Set the gradient fill properties for the series.
-        @gradient = gradient_properties(params[:gradient])
-
         # Set the fill properties for the marker.
         @fill = fill_properties(@fill)
+        # Set the pattern properties for the series.
+        @pattern = pattern_properties(@pattern)
+        # Set the gradient fill properties for the series.
+        @gradient = gradient_properties(@gradient)
+        # Pattern fill overrides solid fill.
         @fill = nil if ptrue?(@gradient)
+        # Gradient fill overrides solid and pattern fills.
+        if ptrue?(@gradient)
+          @pattern = nil
+          @fill    = nil
+        end
       end
 
       def line_defined?
@@ -170,7 +178,7 @@ class Series
       include Writexlsx::Gradient
 
       attr_reader :values, :categories, :name, :name_formula, :name_id
-      attr_reader :cat_data_id, :val_data_id, :fill, :gradient
+      attr_reader :cat_data_id, :val_data_id, :fill, :pattern, :gradient
       attr_reader :trendline, :smooth, :labels, :invert_if_negative
       attr_reader :x2_axis, :y2_axis, :error_bars, :points
       attr_accessor :line, :marker
@@ -184,13 +192,21 @@ def initialize(chart, params = {})
 
         set_data_ids(params)
 
-        @line = line_properties(params[:border] || params[:line])
-        @fill = fill_properties(params[:fill])
-
+        @line       = line_properties(params[:border] || params[:line])
+        @fill       = fill_properties(params[:fill])
+        @pattern    = pattern_properties(params[:pattern])
         @gradient   = gradient_properties(params[:gradient])
-        @fill       = nil if ptrue?(@gradient)
+        # Pattern fill overrides solid fill.
+        @fill       = nil if ptrue?(@pattern)
+        # Gradient fill overrides solid and patter fills.
+        if ptrue?(@gradient)
+          @pattern = nil
+          @fill    = nil
+        end
 
+        # Set the marker properties for the series.
         @marker     = Marker.new(params[:marker]) if params[:marker]
+        # 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]

data/lib/write_xlsx/format.rb

@@ -506,7 +506,7 @@ def self.color(color_code)
     def set_align(location)
       return unless location             # No default
 
-      location.downcase!
+      location = location.downcase
 
       set_text_h_align(1) if location == 'left'
       set_text_h_align(2) if location == 'centre'
@@ -582,7 +582,7 @@ def set_border_color(color)
     def set_rotation(rotation)
       if rotation == 270
         rotation = 255
-      elsif rotation >= -90 || rotation <= 90
+      elsif rotation >= -90 && rotation <= 90
         rotation = -rotation + 90 if rotation < 0
       else
         raise "Rotation #{rotation} outside range: -90 <= angle <= 90"
@@ -844,6 +844,10 @@ def write_font_family_scheme(writer)
           writer.empty_tag('family', [ ['val', @font_family] ])
       end
 
+      if ptrue?(@font_charset)
+        writer.empty_tag('charset', [ ['val', @font_charset] ])
+      end
+
       if @font == 'Calibri' && !ptrue?(@hyperlink)
         writer.empty_tag('scheme', [ ['val', @font_scheme] ])
       end

data/lib/write_xlsx/package/app.rb

@@ -32,6 +32,7 @@ def assemble_xml_file
             write_company
             write_links_up_to_date
             write_shared_doc
+            write_hyperlink_base
             write_hyperlinks_changed
             write_app_version
           end
@@ -220,6 +221,17 @@ def write_shared_doc
         @writer.data_element('SharedDoc', data)
       end
 
+      #
+      # Write the <HyperlinkBase> element.
+      #
+      def write_hyperlink_base
+        data = @properties[:hyperlink_base]
+
+        return unless data
+
+        @writer.data_element('HyperlinkBase', data)
+      end
+
       #
       # Write the <HyperlinksChanged> element.
       #

data/lib/write_xlsx/package/comments.rb

@@ -41,11 +41,13 @@ def initialize(workbook, worksheet, row, col, string, options = {})
       def backgrount_color(color)
         color_id = Format.color(color)
 
-        if color_id == 0
+        if color_id.to_s =~ /^#[0-9A-F]{6}/i
+          @color = color_id.to_s
+        elsif color_id == 0
           @color = '#ffffe1'
         else
           rgb = @workbook.palette[color_id - 8]
-          @color = "##{rgb_color(rgb)} [#{color_id}]\n"
+          @color = "##{rgb_color(rgb)} [#{color_id}]"
         end
       end
 

data/lib/write_xlsx/package/conditional_format.rb

@@ -71,6 +71,7 @@ def attributes
         attr << ['type' , type]
         attr << ['dxfId',    format]   if format
         attr << ['priority', priority]
+        attr << ['stopIfTrue', 1] if stop_if_true
         attr
       end
 
@@ -86,6 +87,10 @@ def priority
         @param[:priority]
       end
 
+      def stop_if_true
+        @param[:stop_if_true]
+      end
+
       def criteria
         @param[:criteria]
       end
@@ -306,7 +311,7 @@ def range_start_cell_for_conditional_formatting(*args)  # :nodoc:
 
       def row_col_param_for_conditional_formatting(*args)
         # Check for a cell reference in A1 notation and substitute row and column
-        if args[0] =~ /^\D/
+        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] =~ /,/
         end
@@ -383,7 +388,7 @@ def check_conditional_formatting_parameters(param)  # :nodoc:
       end
 
       def convert_date_time_if_required(val)
-        if val =~ /T/
+        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
@@ -401,6 +406,7 @@ def valid_parameter_for_conditional_formatting
          :value,
          :minimum,
          :maximum,
+         :stop_if_true,
          :min_type,
          :mid_type,
          :max_type,

data/lib/write_xlsx/package/shared_strings.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
@@ -8,11 +9,13 @@ class SharedStrings
 
       include Writexlsx::Utility
 
+      PRESERVE_SPACE_ATTRIBUTES = ['xml:space', 'preserve'].freeze
+
       def initialize
         @writer        = Package::XMLWriterSimple.new
         @strings       = [] # string table
         @strings_index = {} # string table index
-        @count         = {} # count
+        @count         = 0 # count
       end
 
       def index(string, params = {})
@@ -21,18 +24,18 @@ def index(string, params = {})
       end
 
       def add(string)
-        str = string.dup
-        if @count[str]
-          @count[str] += 1
-        else
+        unless @strings_index[string]
+          # Only first time the string will be append to list
+          # next time we only check and not #dup it
+          str = string.dup.freeze
           @strings << str
           @strings_index[str] = @strings.size - 1
-          @count[str] = 1
         end
+        @count += 1
       end
 
       def string(index)
-        @strings[index].dup
+        @strings[index]
       end
 
       def empty?
@@ -79,7 +82,6 @@ def write_sst_strings
       # Write the <si> element.
       #
       def write_si(string)
-        string = string.dup
         attributes = []
 
         # Excel escapes control characters with _xHHHH_ and also escapes any
@@ -102,7 +104,7 @@ def write_si(string)
         end
 
         # Add attribute to preserve leading or trailing whitespace.
-        attributes << ['xml:space', 'preserve'] if string =~ /\A\s|\s\Z/
+        attributes << PRESERVE_SPACE_ATTRIBUTES if string =~ /\A\s|\s\Z/
 
         # Write any rich strings without further tags.
         if string =~ %r{^<r>} && string =~ %r{</r>$}
@@ -122,7 +124,7 @@ def add_c2_c3(string)
       end
 
       def total_count
-        @count.values.inject(0) { |sum, count| sum += count }
+        @count
       end
 
       def unique_count

data/lib/write_xlsx/package/styles.rb

@@ -49,7 +49,7 @@ def set_style_properties(xf_formats, palette, font_count, num_format_count, bord
       # based on the default or user defined values in the Workbook palette.
       #
       def palette_color(index)
-      if index =~ /^#([0-9A-F]{6})$/i
+      if index.to_s =~ /^#([0-9A-F]{6})$/i
         "FF#{$1.upcase}"
       else
         "FF#{super(index)}"

data/lib/write_xlsx/package/table.rb

@@ -10,7 +10,7 @@ class Table
 
       class ColumnData
         attr_reader :id
-        attr_accessor :name, :format, :formula
+        attr_accessor :name, :format, :formula, :name_format
         attr_accessor :total_string, :total_function
 
         def initialize(id, param = {})
@@ -20,6 +20,7 @@ def initialize(id, param = {})
           @total_function = ''
           @formula        = ''
           @format         = nil
+          @name_format    = nil
           @user_data      = param[id-1] if param
         end
       end
@@ -93,10 +94,14 @@ def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
             if user_data[:header] && !user_data[:header].empty?
               col_data.name = user_data[:header]
             end
+
+            # Get the header format if defined.
+            col_data.name_format = user_data[:header_format]
+            
             # Handle the column formula.
             handle_the_column_formula(
-                                      col_data, col_num, user_data[:formula], user_data[:format]
-                                      )
+              col_data, col_num, user_data[:formula], user_data[:format]
+            )
 
             # Handle the function for the total row.
             if user_data[:total_function]
@@ -123,7 +128,9 @@ def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
 
       def write_the_column_headers_to_the_worksheet(col_num, col_data)
         if @param[:header_row] != 0
-          @worksheet.write_string(@row1, col_num, col_data.name)
+          @worksheet.write_string(
+            @row1, col_num, col_data.name, col_data.name_format
+          )
         end
       end
 
@@ -268,7 +275,26 @@ def set_the_table_style
       end
 
       def set_the_table_name
-        @name = @param[:name] if @param[:name]
+        if @param[:name]
+          name = @param[:name]
+
+          # Raise if the name contains invalid chars as defined by Excel help.
+          if name !~ /^[\w\\][\w\\.]*$/ || name =~ /^\d/
+            raise "Invalid character in name '#{name} used in add_table()"
+          end
+
+          # Raise if the name looks like a cell name.
+          if name =~ /^[a-zA-Z][a-zA-Z]?[a-dA-D]?[0-9]+$/
+            ralse "Invalid name '#{name}' looks like a cell name in add_table()"
+          end
+
+          # Raise if the name looks like a R1C1.
+          if name =~ /^[rcRC]$/ || name =~ /^[rcRC]\d+[rcRC]\d+$/
+            raise "Invalid name '#{name}' like a RC cell ref in add_table()"
+          end          
+          
+          @name = @param[:name]
+        end
       end
 
       def set_the_table_and_autofilter_ranges

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -118,17 +118,18 @@ def key_vals(attribute)
       end
 
       def escape_attributes(str = '')
-        return str if !(str =~ /["&<>]/)
+        return str if !(str.to_s =~ /["&<>\n]/)
 
         str.
           gsub(/&/, "&amp;").
           gsub(/"/, "&quot;").
           gsub(/</, "&lt;").
-          gsub(/>/, "&gt;")
+          gsub(/>/, "&gt;").
+          gsub(/\n/, "&#xA;")
       end
 
       def escape_data(str = '')
-        if str =~ /[&<>]/
+        if str.to_s =~ /[&<>]/
           str.gsub(/&/, '&amp;').
             gsub(/</, '&lt;').
             gsub(/>/, '&gt;')

data/lib/write_xlsx/utility.rb

@@ -244,7 +244,7 @@ def put_deprecate_message(method)
 
     # Check for a cell reference in A1 notation and substitute row and column
     def row_col_notation(args)   # :nodoc:
-      if args[0] =~ /^\D/
+      if args[0].to_s =~ /^\D/
         substitute_cellref(*args)
       else
         args
@@ -543,6 +543,91 @@ def fill_properties(fill) # :nodoc:
       line_fill_properties(fill)
     end
 
+    #
+    # Convert user defined pattern properties to the structure required internally.
+    #
+    def pattern_properties(args) # :nodoc:
+      pattern = {}
+
+      return nil unless args
+
+      # Check the pattern type is present.
+      return nil unless args.has_key?(:pattern)
+
+      # Check the foreground color is present.
+      retuen nil unless args.has_key?(:fg_color)
+
+      types = {
+        'percent_5'                 => 'pct5',
+        'percent_10'                => 'pct10',
+        'percent_20'                => 'pct20',
+        'percent_25'                => 'pct25',
+        'percent_30'                => 'pct30',
+        'percent_40'                => 'pct40',
+
+        'percent_50'                => 'pct50',
+        'percent_60'                => 'pct60',
+        'percent_70'                => 'pct70',
+        'percent_75'                => 'pct75',
+        'percent_80'                => 'pct80',
+        'percent_90'                => 'pct90',
+
+        'light_downward_diagonal'   => 'ltDnDiag',
+        'light_upward_diagonal'     => 'ltUpDiag',
+        'dark_downward_diagonal'    => 'dkDnDiag',
+        'dark_upward_diagonal'      => 'dkUpDiag',
+        'wide_downward_diagonal'    => 'wdDnDiag',
+        'wide_upward_diagonal'      => 'wdUpDiag',
+
+        'light_vertical'            => 'ltVert',
+        'light_horizontal'          => 'ltHorz',
+        'narrow_vertical'           => 'narVert',
+        'narrow_horizontal'         => 'narHorz',
+        'dark_vertical'             => 'dkVert',
+        'dark_horizontal'           => 'dkHorz',
+
+        'dashed_downward_diagonal'  => 'dashDnDiag',
+        'dashed_upward_diagonal'    => 'dashUpDiag',
+        'dashed_horizontal'         => 'dashHorz',
+        'dashed_vertical'           => 'dashVert',
+        'small_confetti'            => 'smConfetti',
+        'large_confetti'            => 'lgConfetti',
+
+        'zigzag'                    => 'zigZag',
+        'wave'                      => 'wave',
+        'diagonal_brick'            => 'diagBrick',
+        'horizontal_brick'          => 'horzBrick',
+        'weave'                     => 'weave',
+        'plaid'                     => 'plaid',
+
+        'divot'                     => 'divot',
+        'dotted_grid'               => 'dotGrid',
+        'dotted_diamond'            => 'dotDmnd',
+        'shingle'                   => 'shingle',
+        'trellis'                   => 'trellis',
+        'sphere'                    => 'sphere',
+
+        'small_grid'                => 'smGrid',
+        'large_grid'                => 'lgGrid',
+        'small_check'               => 'smCheck',
+        'large_check'               => 'lgCheck',
+        'outlined_diamond'          => 'openDmnd',
+        'solid_diamond'             => 'solidDmnd'        
+      }
+
+      # Check for valid types.
+      if types[args[:pattern]]
+        pattern[:pattern] = types[args[:pattern]]
+      else
+        raise "Unknown pattern type '#{args[:pattern]}'"
+      end
+
+      pattern[:bg_color] = args[:bg_color] || '#FFFFFF'
+      pattern[:fg_color] = args[:fg_color]
+
+      pattern
+    end
+    
     def line_fill_properties(params)
       return { :_defined => 0 } unless params
       ret = params.dup