write_xlsx 0.85.7 → 0.86.0

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,12 @@ def set_the_table_style
       end
 
       def set_the_table_name
-        @name = @param[:name] if @param[:name]
+        if @param[:name]
+          name = @param[:name]
+          
+          raise "Name '#{name} in add_table cannot contain spaces" if name =~ /\s/
+          @name = @param[:name]
+        end
       end
 
       def set_the_table_and_autofilter_ranges

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 #
 # XMLWriterSimple
 #
@@ -29,10 +30,9 @@ def tag_elements(tag, attributes = [])
       end
 
       def tag_elements_str(tag, attributes = [])
-        str = ''
-        str << start_tag_str(tag, attributes)
-        str << yield
-        str << end_tag_str(tag)
+        str = start_tag_str(tag, attributes) +
+              yield +
+              end_tag_str(tag)
       end
 
       def start_tag(tag, attr = [])
@@ -65,7 +65,7 @@ def empty_tag_encoded_str(tag, attr = [])
       end
 
       def data_element(tag, data, attr = [])
-        tag_elements(tag, attr) { io_write("#{escape_data(data)}") }
+        tag_elements(tag, attr) { io_write(escape_data(data)) }
       end
 
       #
@@ -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

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/col_name'
 
 module Writexlsx
@@ -243,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
@@ -303,11 +304,12 @@ def write_color(writer, name, value) #:nodoc:
       writer.empty_tag('color', attributes)
     end
 
+    PERL_TRUE_VALUES = [false, nil, 0, "0", "", [], {}].freeze
     #
     # return perl's boolean result
     #
     def ptrue?(value)
-      if [false, nil, 0, "0", "", [], {}].include?(value)
+      if PERL_TRUE_VALUES.include?(value)
         false
       else
         true

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.85.7"
+WriteXLSX_VERSION = "0.86.0"

data/lib/write_xlsx/workbook.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/package/packager'
 require 'write_xlsx/sheets'
@@ -785,17 +786,18 @@ def set_properties(params)
 
       # List of valid input parameters.
       valid = {
-        :title       => 1,
-        :subject     => 1,
-        :author      => 1,
-        :keywords    => 1,
-        :comments    => 1,
-        :last_author => 1,
-        :created     => 1,
-        :category    => 1,
-        :manager     => 1,
-        :company     => 1,
-        :status      => 1
+        :title          => 1,
+        :subject        => 1,
+        :author         => 1,
+        :keywords       => 1,
+        :comments       => 1,
+        :last_author    => 1,
+        :created        => 1,
+        :category       => 1,
+        :manager        => 1,
+        :company        => 1,
+        :status         => 1,
+        :hyperlink_base => 1
       }
 
       # Check for valid input parameters.
@@ -926,7 +928,7 @@ def set_calc_mode(mode, calc_id = nil)
     #
     def set_custom_color(index, red = 0, green = 0, blue = 0)
       # Match a HTML #xxyyzz style parameter
-      if red =~ /^#(\w\w)(\w\w)(\w\w)/
+      if red.to_s =~ /^#(\w\w)(\w\w)(\w\w)/
         red   = $1.hex
         green = $2.hex
         blue  = $3.hex
@@ -972,8 +974,9 @@ def date_1904? #:nodoc:
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
     #
-    def shared_string_index(str, params = {}) #:nodoc:
-      @shared_strings.index(str, params)
+    EMPTY_HASH = {}.freeze
+    def shared_string_index(str) #:nodoc:
+      @shared_strings.index(str, EMPTY_HASH)
     end
 
     def str_unique   # :nodoc:

data/lib/write_xlsx/worksheet.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/package/button'
 require 'write_xlsx/colors'
@@ -295,6 +296,7 @@ class Worksheet
     attr_reader :comments, :comments_author # :nodoc:
     attr_accessor :dxf_priority # :nodoc:
     attr_reader :vba_codename # :nodoc:
+    attr_writer :excel_version
 
     def initialize(workbook, index, name) #:nodoc:
       @writer = Package::XMLWriterSimple.new
@@ -720,7 +722,7 @@ def protect_default_settings  # :nodoc:
     #
     def set_column(*args)
       # Check for a cell reference in A1 notation and substitute row and column
-      if args[0] =~ /^\D/
+      if args[0].to_s =~ /^\D/
         row1, firstcol, row2, lastcol, *data = substitute_cellref(*args)
       else
         firstcol, lastcol, *data = args
@@ -2188,7 +2190,7 @@ def write_comment(*args)
     def write_number(*args)
       # Check for a cell reference in A1 notation and substitute row and column
       row, col, num, xf = row_col_notation(args)
-      raise WriteXLSXInsufficientArgumentError if [row, col, num].include?(nil)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil? || num.nil?
 
       # Check that row and col are valid and store max and min values
       check_dimensions(row, col)
@@ -2230,13 +2232,13 @@ def write_string(*args)
       # Check for a cell reference in A1 notation and substitute row and column
       row, col, str, xf = row_col_notation(args)
       str &&= str.to_s
-      raise WriteXLSXInsufficientArgumentError if [row, col, str].include?(nil)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil? || str.nil?
 
       # Check that row and col are valid and store max and min values
       check_dimensions(row, col)
       store_row_col_max_min_values(row, col)
 
-      index = shared_string_index(str[0, STR_MAX])
+      index = shared_string_index(str.length > STR_MAX ? str[0, STR_MAX] : str)
 
       store_data_to_table(StringCellData.new(self, row, col, index, xf))
     end
@@ -2527,6 +2529,91 @@ def write_array_formula(*args)
       end
     end
 
+    #
+    # :call-seq:
+    #   update_format_with_params(row, col, format_params)
+    #
+    # Update formatting of the cell to the specified row and column (zero indexed).
+    #
+    #     worksheet.update_format_with_params(0, 0, color: 'red')
+    #
+    # This method is used to update formatting of the cell keeping cell contents 
+    # and formatting.
+    #
+    # If the cell doesn't have CellData object, this method create a CellData 
+    # using write_blank method.
+    # If the cell has CellData, this method fetch contents and format of cell from 
+    # the CellData object and recreate CellData using write method.
+    #
+    def update_format_with_params(*args)
+      row, col, params = row_col_notation(args)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil? || params.nil?
+
+      # Check that row and col are valid and store max and min values
+      check_dimensions(row, col)
+      store_row_col_max_min_values(row, col)
+
+      format = nil
+      cell_data = nil
+      if @cell_data_table[row].nil? || @cell_data_table[row][col].nil?
+        format = @workbook.add_format(params)
+        write_blank(row, col, format)
+      else
+        if @cell_data_table[row][col].xf.nil?
+          format = @workbook.add_format(params)
+          cell_data = @cell_data_table[row][col]
+        else
+          format = @workbook.add_format
+          cell_data = @cell_data_table[row][col]
+          format.copy(cell_data.xf)
+          format.set_format_properties(params)
+        end
+        # keep original value of cell
+        if cell_data.is_a? FormulaCellData
+          value = "=#{cell_data.token}"
+        elsif cell_data.is_a? FormulaArrayCellData
+          value = "{=#{cell_data.token}}"
+        elsif cell_data.is_a? StringCellData
+          value = @workbook.shared_strings.string(cell_data.data[:sst_id])
+        else
+          value = cell_data.data
+        end
+        write(row, col, value, format)
+      end
+    end
+
+    #
+    # :call-seq:
+    #   update_range_format_with_params(row_first, col_first, row_last, col_last, format_params)
+    #
+    # Update formatting of cells in range to the specified row and column (zero indexed).
+    #
+    #     worksheet.update_range_format_with_params(0, 0, 3, 3, color: 'red')
+    #
+    # This method is used to update formatting of multiple cells keeping cells' contents 
+    # and formatting.
+    #
+    #
+    def update_range_format_with_params(*args)
+      row_first, col_first, row_last, col_last, params = row_col_notation(args)
+
+      raise WriteXLSXInsufficientArgumentError if [row_first, col_first, row_last, col_last, params].include?(nil)
+
+      # Swap last row/col with first row/col as necessary
+      row_first,  row_last  = row_last,  row_first  if row_first > row_last
+      col_first, col_last = col_last, col_first if col_first > col_last
+
+      # Check that column number is valid and store the max value
+      check_dimensions(row_last, col_last)
+      store_row_col_max_min_values(row_last, col_last)
+
+      (row_first..row_last).each do |row|
+        (col_first..col_last).each do |col|
+          update_format_with_params(row, col, params)
+        end
+      end
+    end
+
     #
     # The outline_settings() method is used to control the appearance of
     # outlines in Excel. Outlines are described in
@@ -4202,7 +4289,7 @@ def conditional_formatting(*args)
     #     :header
     #     :formula
     #     :total_string
-    #     :total_function
+    #     :
     #     :format
     #
     # The column data must be specified as an array of hash. For example to
@@ -4830,9 +4917,8 @@ def insert_button(*args)
     #     :custom
     #
     # +:any+ is used to specify that the type of data is unrestricted.
-    # This is the same as not applying a data validation. It is only
-    # provided for completeness and isn't used very often in the
-    # context of WriteXLSX.
+    # This is usefl to display an input message without restricting the data
+    # that can be entered.
     #
     # +:integer+ restricts the cell to integer values. Excel refers to this
     # as 'whole number'.
@@ -5716,6 +5802,22 @@ def get_range_data(row_start, col_start, row_end, col_end) # :nodoc:
     #    width        # Width of object frame.
     #    height       # Height of object frame.
     def position_object_pixels(col_start, row_start, x1, y1, width, height) #:nodoc:
+      # Adjust start column for negative offsets.
+      while x1 < 0 && col_start > 0
+        x1 += size_col(col_start - 1)
+        col_start -= 1
+      end
+
+      # Adjust start row for negative offsets.
+      while y1 < 0 && row_start > 0
+        y1 += size_row(row_start - 1)
+        row_start -= 1
+      end
+      
+      # Ensure that the image isn't shifted off the page at top left.
+      x1 = 0 if x1 < 0
+      y1 = 0 if y1 < 0
+      
       # Calculate the absolute x offset of the top-left vertex.
       if @col_size_changed
         x_abs = (0 .. col_start-1).inject(0) {|sum, col| sum += size_col(col)}
@@ -5810,7 +5912,7 @@ def excel2003_style? # :nodoc:
     # based on the default or user defined values in the Workbook palette.
     #
     def palette_color(index) #:nodoc:
-      if index =~ /^#([0-9A-F]{6})$/i
+      if index.to_s =~ /^#([0-9A-F]{6})$/i
         "FF#{$1.upcase}"
       else
         "FF#{super(index)}"
@@ -6099,7 +6201,7 @@ def parse_filter_tokens(expression, tokens)     #:nodoc:
       # Special handling of "Top" filter expressions.
       if tokens[0] =~ /^top|bottom$/i
         value = tokens[1]
-        if (value =~ /\D/ or value.to_i < 1 or value.to_i > 500)
+        if (value.to_s =~ /\D/ or value.to_i < 1 or value.to_i > 500)
           raise "The value '#{value}' in expression '#{expression}' " +
           "must be in the range 1 to 500"
         end
@@ -6128,7 +6230,7 @@ def parse_filter_tokens(expression, tokens)     #:nodoc:
       end
 
       # Special handling for Blanks/NonBlanks.
-      if (token =~ /^blanks|nonblanks$/i)
+      if (token.to_s =~ /^blanks|nonblanks$/i)
         # Only allow Equals or NotEqual in this context.
         if (operator != 2 and operator != 5)
           raise "The operator '#{tokens[1]}' in expression '#{expression}' " +
@@ -6156,7 +6258,7 @@ def parse_filter_tokens(expression, tokens)     #:nodoc:
 
       # if the string token contains an Excel match character then change the
       # operator type to indicate a non "simple" equality.
-      if (operator == 2 and token =~ /[*?]/)
+      if (operator == 2 and token.to_s =~ /[*?]/)
         operator = 22
       end
 
@@ -7510,8 +7612,8 @@ def calc_spans(data, row_num, span_min, span_max)
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
     #
-    def shared_string_index(str, params = {}) #:nodoc:
-      @workbook.shared_string_index(str, params)
+    def shared_string_index(str) #:nodoc:
+      @workbook.shared_string_index(str)
     end
 
     #
@@ -7634,7 +7736,7 @@ def set_active_pane_and_cell_selections(row, col, top_row, left_col, active_cell
 
     def prepare_filter_column(col) # :nodoc:
       # Check for a column reference in A1 notation and substitute.
-      if col =~ /^\D/
+      if col.to_s =~ /^\D/
         col_letter = col
 
         # Convert col ref to a cell ref and then to a col number.

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Worksheet
@@ -63,9 +64,10 @@ def data
         { :sst_id => token }
       end
 
+      TYPE_STR_ATTRS = ['t', 's'].freeze
       def write_cell
         attributes = cell_attributes
-        attributes << ['t', 's']
+        attributes << TYPE_STR_ATTRS
         @worksheet.writer.tag_elements('c', attributes) do
           @worksheet.write_cell_value(token)
         end