write_xlsx 0.85.8 → 0.87.0

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.85.8"
+WriteXLSX_VERSION = "0.87.0"

data/lib/write_xlsx/workbook.rb

@@ -726,7 +726,7 @@ def define_name(name, formula)
 
       # Raise if the sheet index wasn't found.
       if !sheet_index
-       raise "Unknown sheet name #{sheetname} in defined_name()\n"
+       raise "Unknown sheet name #{sheetname} in defined_name()"
       end
 
       # Raise if the name contains invalid chars as defined by Excel help.
@@ -734,17 +734,17 @@ def define_name(name, formula)
       # http://office.microsoft.com/en-001/excel-help/define-and-use-names-in-formulas-HA010147120.aspx#BMsyntax_rules_for_names
       #
       if name =~ /\A[-0-9 !"#\$%&'\(\)\*\+,\.:;<=>\?@\[\]\^`\{\}~]/ || name =~ /.+[- !"#\$%&'\(\)\*\+,\\:;<=>\?@\[\]\^`\{\}~]/
-        raise "Invalid characters in name '#{name}' used in defined_name()\n"
+        raise "Invalid characters in name '#{name}' used in defined_name()"
       end
 
       # Raise if the name looks like a cell name.
       if name =~ %r(^[a-zA-Z][a-zA-Z]?[a-dA-D]?[0-9]+$)
-        raise "Invalid name '#{name}' looks like a cell name in defined_name()\n"
+        raise "Invalid name '#{name}' looks like a cell name in defined_name()"
       end
 
       # Raise if the name looks like a R1C1
       if name =~ /\A[rcRC]\Z/ || name =~ /\A[rcRC]\d+[rcRC]\d+\Z/
-        raise "Invalid name '#{name}' like a RC cell ref in defined_name()\n"
+        raise "Invalid name '#{name}' like a RC cell ref in defined_name()"
       end
 
       @defined_names.push([ name, sheet_index, formula.sub(/^=/, '') ])
@@ -786,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.
@@ -927,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
@@ -1632,9 +1633,10 @@ def prepare_vml_objects  #:nodoc:
     #
     def prepare_tables
       table_id = 0
+      seen     = {}
 
       sheets.each do |sheet|
-        table_id += sheet.prepare_tables(table_id + 1)
+        table_id += sheet.prepare_tables(table_id + 1, seen)
       end
     end
 

data/lib/write_xlsx/worksheet.rb

@@ -296,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
@@ -721,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
@@ -2528,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
@@ -4203,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
@@ -4831,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'.
@@ -5717,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)}
@@ -5811,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)}"
@@ -5869,12 +5970,18 @@ def prepare_header_vml_objects(vml_header_id, vml_drawing_id)
     #
     # Set the table ids for the worksheet tables.
     #
-    def prepare_tables(table_id)
+    def prepare_tables(table_id, seen)
       if tables_count > 0
         id = table_id
         tables.each do |table|
           table.prepare(id)
 
+          if seen[table.name]
+            raise "error: invalid duplicate table name '#{table.name}' found."
+          else
+            seen[table.name] = 1
+          end
+
           # Store the link used for the rels file.
           @external_table_links << ['/table', "../tables/table#{id}.xml"]
           id += 1
@@ -6100,7 +6207,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
@@ -6129,7 +6236,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}' " +
@@ -6157,7 +6264,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
 
@@ -7635,7 +7742,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/data_validation.rb

@@ -32,11 +32,17 @@ def initialize(*args)
         @value = @minimum if @minimum
 
         @validate = valid_validation_type[@validate.downcase]
-        if @validate == 'none'
+
+        # No action is required for validate type 'any'
+        # unless there are input messages.
+        if @validate == 'none' && !@input_message && !@input_title
           @validate_none = true
           return
         end
-        if ['list', 'custom'].include?(@validate)
+
+        # The any, list and custom validations don't have a criteria
+        # so we use a default of 'between'
+        if ['none', 'list', 'custom'].include?(@validate)
           @criteria  = 'between'
           @maximum   = nil
         end
@@ -59,7 +65,7 @@ def initialize(*args)
         end
         set_some_defaults
 
-      # A (for now) undocumented parameter to pass additional cell ranges.
+        # A (for now) undocumented parameter to pass additional cell ranges.
         @other_cells.each { |cells| @cells << cells } if has_key?(:other_cells)
       end
 
@@ -82,11 +88,15 @@ def validate_none?
       #
       def write_data_validation(writer) #:nodoc:
         @writer = writer
-        @writer.tag_elements('dataValidation', attributes) do
-          # Write the formula1 element.
-          write_formula_1(@value)
-          # Write the formula2 element.
-          write_formula_2(@maximum) if @maximum
+        if @validate == 'none'
+          @writer.empty_tag('dataValidation', attributes)
+        else
+          @writer.tag_elements('dataValidation', attributes) do
+            # Write the formula1 element.
+            write_formula_1(@value)
+            # Write the formula2 element.
+            write_formula_2(@maximum) if @maximum
+          end
         end
       end
 
@@ -136,8 +146,10 @@ def attributes
           end
         end
 
-        attributes << ['type', @validate]
-        attributes << ['operator', @criteria] if @criteria != 'between'
+        if @validate != 'none'
+          attributes << ['type', @validate]
+          attributes << ['operator', @criteria] if @criteria != 'between'
+        end
 
         if @error_type
           attributes << ['errorStyle', 'warning'] if @error_type == 1
@@ -282,7 +294,7 @@ def valid_criteria_type  # :nodoc:
 
       def convert_date_time_value(key)  # :nodoc:
         value = instance_variable_get("@#{key}")
-        if value && value =~ /T/
+        if value && value.to_s =~ /T/
           date_time = convert_date_time(value)
           instance_variable_set("@#{key}", date_time) if date_time
           date_time

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -26,17 +26,20 @@ def initialize(url, str, tip)
         # Strip the mailto header.
         normalized_str = str.sub(/^mailto:/, '')
 
+        # Split url into the link and optional anchor/location.
+        url, @url_str = url.split(/#/)
+        url  ||= ''
+
         # Escape URL unless it looks already escaped.
         url = escape_url(url)
 
-        # Excel limits escaped URL to 255 characters.
-        if url.bytesize > 255
-          raise "URL '#{url}' > 255 characters, it exceeds Excel's limit for URLS."
+        # Excel limits the escaped URL and location/anchor to 255 characters.
+        if url.bytesize > 255 || (!@url_str.nil? && @url_str.bytesize > 255)
+          raise "Ignoring URL '#{url}' where link or anchor > 255 characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation."
         end
 
         @url       = url
         @str       = normalized_str
-        @url_str   = nil
         @tip       = tip
       end
 
@@ -144,14 +147,15 @@ def initialize(url, str, tip)
 
         # Convert a ./dir/file.xlsx link to dir/file.xlsx.
         url = url.sub(%r!^.\\!, '')
+        @url_str   = url_str
 
-        # Excel limits escaped URL to 255 characters.
-        if url.bytesize > 255
-          raise "URL '#{url}' > 255 characters, it exceeds Excel's limit for URLS."
+        # Excel limits the escaped URL and location/anchor to 255 characters.
+        if url.bytesize > 255 || (!@url_str.nil? && @url_str.bytesize > 255)
+          raise "Ignoring URL '#{url}' where link or anchor > 255 characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation."
         end
+
         @url       = url
         @str       = str
-        @url_str   = url_str
         @tip       = tip
       end
     end

data/test/chart/test_add_series.rb

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/chart'
 
-class TestAddSeries < Test::Unit::TestCase
+class TestAddSeries < Minitest::Test
   def setup
     @chart = Writexlsx::Chart.new('Bar')
   end
@@ -18,6 +18,8 @@ def test_add_series_only_values
     series.instance_variable_set(:@val_data_id, 0)
     series.instance_variable_set(:@line, { :_defined => 0 })
     series.instance_variable_set(:@fill, { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -50,6 +52,8 @@ def test_add_series_with_categories_and_values
     series.instance_variable_set(:@val_data_id, 1)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -85,6 +89,8 @@ def test_add_series_only_values_checked_by_array
     series.instance_variable_set(:@val_data_id, 0)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -116,6 +122,8 @@ def test_add_series_both_checked_by_array
     series.instance_variable_set(:@val_data_id, 1)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -151,6 +159,8 @@ def test_add_series_secondary_axis
     series.instance_variable_set(:@val_data_id, 1)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)