write_xlsx 1.08.0 → 1.08.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bce1d8cc8f140d38ac7d9149e644d8b1d5133c80933fc2faa2a33d25dcbd168
-  data.tar.gz: 4edf0897d13ec8cee0b545177fe4117286067ba2e14b89c2866192885414633b
+  metadata.gz: 9ab3f33d51239105a5d5c8e0765ada850496c199a370e713353c56d0e0764e4b
+  data.tar.gz: 4b379953050d7a9a5c4151742825c7672c66e60b7c37146531f8d0075d32b634
 SHA512:
-  metadata.gz: 267233a3a8222f817bc455b5d8723bf29808854a7b5410c090becd44baee604201b53792f03b29db84c2fa82f9a4085e11175893abb11bab50b1a74c9f0526e8
-  data.tar.gz: bc5138fcae79f92aaa9a5d6d708575e9615cec51e4c229ec46e0e75e45bc1eca37056f27466f321c8ad6376119bd37c61754b8809c991fd2352ca8a1108089f0
+  metadata.gz: 128e52ae31ef667b30e8c6649c1747abf75750e48bd1a7a9a95cedd69ab3699f55755c9ef2686da4252642c662ed871b41ebb90cabe6d23e56f319b958db89b9
+  data.tar.gz: 31b68e29186266b216aaf8dc2035619292999146e79a9388c1d46dcbdd4704d17688586733dc8bb2b6284865340a68d62c7de6cd738a1ed9f6e68c83f388e94e

data/lib/write_xlsx/package/table.rb

@@ -189,6 +189,14 @@ module Writexlsx
         param[:header_row]  ||= 1
         param[:autofilter]  ||= 1
 
+        # Check that there are enough rows.
+        num_rows = row2 - row1
+        num_rows -= 1 if ptrue?(param[:header_row])
+
+        if num_rows < 0
+          raise "Must have at least one data row in in add_table()"
+        end
+
         # If the header row if off the default is to turn autofilter off.
         param[:autofilter] = 0 if param[:header_row] == 0
 

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "1.08.0"
+WriteXLSX_VERSION = "1.08.1"

data/lib/write_xlsx/worksheet.rb

@@ -381,6 +381,7 @@ module Writexlsx
       @comments = Package::Comments.new(self)
       @buttons_array          = []
       @header_images_array    = []
+      @ignore_errors          = nil
 
       @validations = []
 
@@ -431,6 +432,7 @@ module Writexlsx
           write_header_footer
           write_row_breaks
           write_col_breaks
+          write_ignored_errors
           write_drawings
           write_legacy_drawing
           write_legacy_drawing_hf
@@ -1224,14 +1226,10 @@ module Writexlsx
     # distribution.
     #
     def set_header(string = '', margin = 0.3, options = {})
-      raise 'Header string must be less than 255 characters' if string.length >= 255
+      raise 'Header string must be less than 255 characters' if string.length > 255
       # Replace the Excel placeholder &[Picture] with the internal &G.
       @page_setup.header = string.gsub(/&\[Picture\]/, '&G')
 
-      if string.size >= 255
-        raise 'Header string must be less than 255 characters'
-      end
-
       if options[:align_with_margins]
         @page_setup.header_footer_aligns = options[:align_with_margins]
       end
@@ -1272,17 +1270,13 @@ module Writexlsx
     # The syntax of the set_footer() method is the same as set_header()
     #
     def set_footer(string = '', margin = 0.3, options = {})
-      raise 'Footer string must be less than 255 characters' if string.length >= 255
+      raise 'Footer string must be less than 255 characters' if string.length > 255
 
       @page_setup.footer                = string.dup
 
       # Replace the Excel placeholder &[Picture] with the internal &G.
       @page_setup.footer = string.gsub(/&\[Picture\]/, '&G')
 
-      if string.size >= 255
-        raise 'Header string must be less than 255 characters'
-      end
-
       if options[:align_with_margins]
         @page_setup.header_footer_aligns = options[:align_with_margins]
       end
@@ -6087,6 +6081,30 @@ module Writexlsx
       end
     end
 
+    #
+    # Ignore worksheet errors/warnings in user defined ranges.
+    #
+    def ignore_errors(ignores)
+      # List of valid input parameters.
+      valid_parameter_keys = [
+        :number_stored_as_text,
+        :eval_error,
+        :formula_differs,
+        :formula_range,
+        :formula_unlocked,
+        :empty_cell_reference,
+        :list_data_validation,
+        :calculated_column,
+        :two_digit_text_year
+      ]
+
+      unless (ignores.keys - valid_parameter_keys).empty?
+        raise "Unknown parameter '#{ignores.key - valid_parameter_keys}' in ignore_errors()."
+      end
+
+      @ignore_errors = ignores
+    end
+
     def write_ext(url)
       attributes = [
         ['xmlns:x14', "#{OFFICE_URL}spreadsheetml/2009/9/main"],
@@ -6528,10 +6546,19 @@ module Writexlsx
           target = escape_url(url)
         end
         if url =~ /^external:/
-          target = escape_url(url.sub(/^external:/, 'file:///'))
+          target = escape_url(url.sub(/^external:/, ''))
+
           # Additional escape not required in worksheet hyperlinks
           target = target.gsub(/#/, '%23')
+
+          # Prefix absolute paths (not relative) with file:///
+          if target =~ /^\w:/ || target =~ /^\\\\/
+            target = "file:///#{target}"
+          else
+            target = target.gsub(/\\/, '/')
+          end
         end
+
         if url =~ /^internal:/
           target      = url.sub(/^internal:/, '#')
           target_mode = nil
@@ -8139,5 +8166,44 @@ EOS
       end
       col
     end
+
+    #
+    # Write the <ignoredErrors> element.
+    #
+    def write_ignored_errors
+      return unless @ignore_errors
+
+      ignore = @ignore_errors
+
+      @writer.tag_elements('ignoredErrors' ) do
+        {
+          :number_stored_as_text => 'numberStoredAsText',
+          :eval_error            => 'evalError',
+          :formula_differs       => 'formula',
+          :formula_range         => 'formulaRange',
+          :formula_unlocked      => 'unlockedFormula',
+          :empty_cell_reference  => 'emptyCellReference',
+          :list_data_validation  => 'listDataValidation',
+          :calculated_column     => 'calculatedColumn',
+          :two_digit_text_year   => 'twoDigitTextYear'
+        }.each do |key, value|
+          if ignore[key]
+            write_ignored_error(value, ignore[key])
+          end
+        end
+      end
+    end
+
+    #
+    # Write the <ignoredError> element.
+    #
+    def write_ignored_error(type, sqref)
+      attributes = {
+        'sqref' => sqref,
+        type    => 1
+      }
+
+      @writer.empty_tag('ignoredError', attributes)
+    end
   end
 end

data/test/regression/test_header04.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionHeader04 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_header04
+    @xlsx = 'header04.xlsx'
+    workbook    = WriteXLSX.new(@io)
+    worksheet   = workbook.add_worksheet
+
+    worksheet.set_header(
+      '&CŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽŽ'
+    )
+
+    workbook.close
+
+    compare_for_regression(
+      [],
+      {
+        'xl/worksheets/sheet1.xml' => [ '<pageMargins', '<pageSetup' ]
+      })
+  end
+end

data/test/regression/test_hyperlink50.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionHyperlink50 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true) if @tempfile
+  end
+
+  def test_hyperlink50
+    @xlsx = 'hyperlink50.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.insert_image(
+      'E9', 'test/regression/images/red.png',
+      :url => 'external:..\Book1.xlsx'
+    )
+
+    workbook.close
+
+    compare_for_regression
+  end
+end

data/test/regression/test_hyperlink51.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionHyperlink51 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true) if @tempfile
+  end
+
+  def test_hyperlink51
+    @xlsx = 'hyperlink51.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.insert_image(
+      'E9', 'test/regression/images/red.png',
+      :url => 'external:C:\Temp\Book1.xlsx'
+    )
+
+    workbook.close
+
+    compare_for_regression
+  end
+end

data/test/regression/test_ignore_error01.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionIgnoreError01 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_ignore_error01
+    @xlsx = 'ignore_error01.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_string('A1', '123')
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_ignore_error02.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionIgnoreError02 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_ignore_error02
+    @xlsx = 'ignore_error02.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_string('A1', '123')
+    worksheet.ignore_errors(number_stored_as_text: 'A1')
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_ignore_error03.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionIgnoreError03 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_ignore_error03
+    @xlsx = 'ignore_error03.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    (0..9).each do |row|
+      worksheet.write_string(row, 0, '123')
+    end
+    worksheet.ignore_errors(number_stored_as_text: 'A1:A10')
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_ignore_error04.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionIgnoreError04 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_ignore_error04
+    @xlsx = 'ignore_error04.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_string('A1', '123')
+    worksheet.write_string('C3', '123')
+    worksheet.write_string('E5', '123')
+    worksheet.ignore_errors(number_stored_as_text: 'A1 C3 E5')
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_ignore_error05.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionIgnoreError05 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_ignore_error05
+    @xlsx = 'ignore_error05.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_string('A1', '123')
+    worksheet.write_formula('A2', '=1/0', nil, '#DIV/0!')
+
+    worksheet.ignore_errors(
+      number_stored_as_text: 'A1',
+      eval_error: 'A2'
+    )
+
+    workbook.close
+    compare_for_regression(
+      ['xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels'],
+      {}
+    )
+  end
+end

data/test/regression/test_ignore_error06.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionIgnoreError06 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_ignore_error06
+    @xlsx = 'ignore_error06.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_formula('A1', '=B1')
+    worksheet.write_formula('A2', '=B1')
+    worksheet.write_formula('A3', '=B3')
+
+    worksheet.ignore_errors(
+      :formula_differs => 'A2'
+    )
+
+    workbook.close
+    compare_for_regression(
+      ['xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels'],
+      {}
+    )
+  end
+end

data/test/regression/test_table26.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionTable26 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true) if @tempfile
+  end
+
+  def test_table26
+    @xlsx = 'table26.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    # Set the column width to match the target worksheet.
+    worksheet.set_column('C:D', 10.288)
+    worksheet.set_column('F:G', 10.288)
+
+    # Add the table.
+    worksheet.add_table('C2:D3')
+    worksheet.add_table('F3:G3', :header_row => 0)
+
+    # These tables should be ignored since the ranges are incorrect.
+    assert_raises(RuntimeError) do
+      worksheet.add_table('I2:J2')
+    end
+
+    assert_raises(RuntimeError) do
+      worksheet.add_table('L3:M3', header_row: 1)
+    end
+
+    workbook.close
+    compare_for_regression
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 1.08.0
+  version: 1.08.1
 platform: ruby
 authors:
 - Hideo NAKAMURA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -907,6 +907,7 @@ files:
 - test/regression/test_header01.rb
 - test/regression/test_header02.rb
 - test/regression/test_header03.rb
+- test/regression/test_header04.rb
 - test/regression/test_header_image01.rb
 - test/regression/test_header_image02.rb
 - test/regression/test_header_image03.rb
@@ -973,6 +974,14 @@ files:
 - test/regression/test_hyperlink47.rb
 - test/regression/test_hyperlink48.rb
 - test/regression/test_hyperlink49.rb
+- test/regression/test_hyperlink50.rb
+- test/regression/test_hyperlink51.rb
+- test/regression/test_ignore_error01.rb
+- test/regression/test_ignore_error02.rb
+- test/regression/test_ignore_error03.rb
+- test/regression/test_ignore_error04.rb
+- test/regression/test_ignore_error05.rb
+- test/regression/test_ignore_error06.rb
 - test/regression/test_image01.rb
 - test/regression/test_image02.rb
 - test/regression/test_image03.rb
@@ -1178,6 +1187,7 @@ files:
 - test/regression/test_table23.rb
 - test/regression/test_table24.rb
 - test/regression/test_table25.rb
+- test/regression/test_table26.rb
 - test/regression/test_tutorial01.rb
 - test/regression/test_tutorial02.rb
 - test/regression/test_tutorial03.rb
@@ -1670,6 +1680,7 @@ files:
 - test/regression/xlsx_files/header01.xlsx
 - test/regression/xlsx_files/header02.xlsx
 - test/regression/xlsx_files/header03.xlsx
+- test/regression/xlsx_files/header04.xlsx
 - test/regression/xlsx_files/header_image01.xlsx
 - test/regression/xlsx_files/header_image02.xlsx
 - test/regression/xlsx_files/header_image03.xlsx
@@ -1738,6 +1749,14 @@ files:
 - test/regression/xlsx_files/hyperlink47.xlsx
 - test/regression/xlsx_files/hyperlink48.xlsx
 - test/regression/xlsx_files/hyperlink49.xlsx
+- test/regression/xlsx_files/hyperlink50.xlsx
+- test/regression/xlsx_files/hyperlink51.xlsx
+- test/regression/xlsx_files/ignore_error01.xlsx
+- test/regression/xlsx_files/ignore_error02.xlsx
+- test/regression/xlsx_files/ignore_error03.xlsx
+- test/regression/xlsx_files/ignore_error04.xlsx
+- test/regression/xlsx_files/ignore_error05.xlsx
+- test/regression/xlsx_files/ignore_error06.xlsx
 - test/regression/xlsx_files/image01.xlsx
 - test/regression/xlsx_files/image02.xlsx
 - test/regression/xlsx_files/image03.xlsx
@@ -1943,6 +1962,7 @@ files:
 - test/regression/xlsx_files/table23.xlsx
 - test/regression/xlsx_files/table24.xlsx
 - test/regression/xlsx_files/table25.xlsx
+- test/regression/xlsx_files/table26.xlsx
 - test/regression/xlsx_files/tutorial01.xlsx
 - test/regression/xlsx_files/tutorial02.xlsx
 - test/regression/xlsx_files/tutorial03.xlsx
@@ -2807,6 +2827,7 @@ test_files:
 - test/regression/test_header01.rb
 - test/regression/test_header02.rb
 - test/regression/test_header03.rb
+- test/regression/test_header04.rb
 - test/regression/test_header_image01.rb
 - test/regression/test_header_image02.rb
 - test/regression/test_header_image03.rb
@@ -2873,6 +2894,14 @@ test_files:
 - test/regression/test_hyperlink47.rb
 - test/regression/test_hyperlink48.rb
 - test/regression/test_hyperlink49.rb
+- test/regression/test_hyperlink50.rb
+- test/regression/test_hyperlink51.rb
+- test/regression/test_ignore_error01.rb
+- test/regression/test_ignore_error02.rb
+- test/regression/test_ignore_error03.rb
+- test/regression/test_ignore_error04.rb
+- test/regression/test_ignore_error05.rb
+- test/regression/test_ignore_error06.rb
 - test/regression/test_image01.rb
 - test/regression/test_image02.rb
 - test/regression/test_image03.rb
@@ -3078,6 +3107,7 @@ test_files:
 - test/regression/test_table23.rb
 - test/regression/test_table24.rb
 - test/regression/test_table25.rb
+- test/regression/test_table26.rb
 - test/regression/test_tutorial01.rb
 - test/regression/test_tutorial02.rb
 - test/regression/test_tutorial03.rb
@@ -3570,6 +3600,7 @@ test_files:
 - test/regression/xlsx_files/header01.xlsx
 - test/regression/xlsx_files/header02.xlsx
 - test/regression/xlsx_files/header03.xlsx
+- test/regression/xlsx_files/header04.xlsx
 - test/regression/xlsx_files/header_image01.xlsx
 - test/regression/xlsx_files/header_image02.xlsx
 - test/regression/xlsx_files/header_image03.xlsx
@@ -3638,6 +3669,14 @@ test_files:
 - test/regression/xlsx_files/hyperlink47.xlsx
 - test/regression/xlsx_files/hyperlink48.xlsx
 - test/regression/xlsx_files/hyperlink49.xlsx
+- test/regression/xlsx_files/hyperlink50.xlsx
+- test/regression/xlsx_files/hyperlink51.xlsx
+- test/regression/xlsx_files/ignore_error01.xlsx
+- test/regression/xlsx_files/ignore_error02.xlsx
+- test/regression/xlsx_files/ignore_error03.xlsx
+- test/regression/xlsx_files/ignore_error04.xlsx
+- test/regression/xlsx_files/ignore_error05.xlsx
+- test/regression/xlsx_files/ignore_error06.xlsx
 - test/regression/xlsx_files/image01.xlsx
 - test/regression/xlsx_files/image02.xlsx
 - test/regression/xlsx_files/image03.xlsx
@@ -3843,6 +3882,7 @@ test_files:
 - test/regression/xlsx_files/table23.xlsx
 - test/regression/xlsx_files/table24.xlsx
 - test/regression/xlsx_files/table25.xlsx
+- test/regression/xlsx_files/table26.xlsx
 - test/regression/xlsx_files/tutorial01.xlsx
 - test/regression/xlsx_files/tutorial02.xlsx
 - test/regression/xlsx_files/tutorial03.xlsx