write_xlsx 1.02.0 → 1.08.1

data/lib/write_xlsx/worksheet.rb

@@ -359,6 +359,8 @@ module Writexlsx
       @shape_hash             = {}
       @drawing_rels           = {}
       @drawing_rels_id        = 0
+      @vml_drawing_rels       = {}
+      @vml_drawing_rels_id    = 0
       @header_images          = []
       @footer_images          = []
 
@@ -379,6 +381,7 @@ module Writexlsx
       @comments = Package::Comments.new(self)
       @buttons_array          = []
       @header_images_array    = []
+      @ignore_errors          = nil
 
       @validations = []
 
@@ -386,6 +389,9 @@ module Writexlsx
       @data_bars_2010 = []
       @dxf_priority   = 1
 
+      @protected_ranges     = []
+      @num_protected_ranges = 0
+
       if excel2003_style?
         @original_row_height      = 12.75
         @default_row_height       = 12.75
@@ -412,6 +418,7 @@ module Writexlsx
           write_cols
           write_sheet_data
           write_sheet_protection
+          write_protected_ranges
           # write_sheet_calc_pr
           write_phonetic_pr if excel2003_style?
           write_auto_filter
@@ -425,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
@@ -614,7 +622,25 @@ module Writexlsx
 
       # Set the password after the user defined values.
       @protect[:password] =
-        sprintf("%X", encode_password(password)) if password && password != ''
+        encode_password(password) if password && password != ''
+    end
+
+    #
+    # Unprotect ranges within a protected worksheet.
+    #
+    def unprotect_range(range, range_name = nil, password = nil)
+      if range.nil?
+        raise "The range must be defined in unprotect_range())\n"
+      else
+        range.gsub!(/\$/, "")
+        range.sub!(/^=/, "")
+        @num_protected_ranges += 1
+      end
+
+      range_name ||= "Range#{@num_protected_ranges}"
+      password   &&= encode_password(password)
+
+      @protected_ranges << [range, range_name, password]
     end
 
     def protect_default_settings  # :nodoc:
@@ -816,12 +842,7 @@ module Writexlsx
         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
 
-        # If the first and last cell are the same write a single cell.
-        if row_first == row_last && col_first == col_last
-          sqref = active_cell
-        else
-          sqref = xl_range(row_first, row_last, col_first, col_last)
-        end
+        sqref = xl_range(row_first, row_last, col_first, col_last)
       else          # Single cell selection.
         sqref = active_cell
       end
@@ -1205,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
@@ -1253,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
@@ -2512,7 +2525,9 @@ module Writexlsx
       col1, col2 = col2, col1 if col1 > col2
 
       # Check that row and col are valid and store max and min values
+      check_dimensions(row1, col1)
       check_dimensions(row2, col2)
+      store_row_col_max_min_values(row1, col1)
       store_row_col_max_min_values(row2, col2)
 
       # Define array range
@@ -3044,14 +3059,16 @@ module Writexlsx
 
       if options.first.class == Hash
         # Newer hash bashed options
-        params = options.first
-        x_offset = params[:x_offset]
-        y_offset = params[:y_offset]
-        x_scale  = params[:x_scale]
-        y_scale  = params[:y_scale]
-        anchor   = params[:object_position]
-        url      = params[:url]
-        tip      = params[:tip]
+        params      = options.first
+        x_offset    = params[:x_offset]
+        y_offset    = params[:y_offset]
+        x_scale     = params[:x_scale]
+        y_scale     = params[:y_scale]
+        anchor      = params[:object_position]
+        url         = params[:url]
+        tip         = params[:tip]
+        description = params[:description]
+        decorative  = params[:decorative]
       else
         x_offset, y_offset, x_scale, y_scale, anchor = options
       end
@@ -3063,7 +3080,7 @@ module Writexlsx
 
       @images << [
         row, col, image, x_offset, y_offset,
-        x_scale, y_scale, url, tip, anchor
+        x_scale, y_scale, url, tip, anchor, description, decorative
       ]
     end
 
@@ -3361,9 +3378,11 @@ module Writexlsx
       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)
+      # Check that the data range is valid and store the max and min values.
+      check_dimensions(row_first, col_first)
+      check_dimensions(row_last,  col_last)
+      store_row_col_max_min_values(row_first, col_first)
+      store_row_col_max_min_values(row_last,  col_last)
 
       # Store the merge range.
       @merge << [row_first, col_first, row_last, col_last]
@@ -3426,9 +3445,11 @@ module Writexlsx
       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)
+      # Check that the data range is valid and store the max and min values.
+      check_dimensions(row_first, col_first)
+      check_dimensions(row_last,  col_last)
+      store_row_col_max_min_values(row_first, col_first)
+      store_row_col_max_min_values(row_last,  col_last)
 
       # Store the merge range.
       @merge << [row_first, col_first, row_last, col_last]
@@ -5736,7 +5757,7 @@ module Writexlsx
       name = chart.name
 
       # Create a Drawing object to use with worksheet unless one already exists.
-      drawing = Drawing.new(drawing_type, dimensions, 0, 0, name, nil, anchor, drawing_rel_index, 0, nil)
+      drawing = Drawing.new(drawing_type, dimensions, 0, 0, name, nil, anchor, drawing_rel_index, 0, nil, 0)
       if !drawings?
         @drawings = Drawings.new
         @drawings.add_drawing_object(drawing)
@@ -5868,27 +5889,24 @@ module Writexlsx
       y_abs += y1
 
       # Adjust start column for offsets that are greater than the col width.
-      if size_col(col_start) > 0
-        while x1 >= size_col(col_start)
-          x1 -= size_col(col_start)
-          col_start += 1
-        end
+      while x1 >= size_col(col_start, anchor)
+        x1 -= size_col(col_start)
+        col_start += 1
       end
 
       # Adjust start row for offsets that are greater than the row height.
-      if size_row(row_start) > 0
-        while y1 >= size_row(row_start)
-          y1 -= size_row(row_start)
-          row_start += 1
-        end
+      while y1 >= size_row(row_start, anchor)
+        y1 -= size_row(row_start)
+        row_start += 1
       end
 
       # Initialise end cell to the same as the start cell.
       col_end = col_start
       row_end = row_start
 
-      width  += x1 if size_col(col_start) > 0
-      height += y1 if size_row(row_start) > 0
+      # Only offset the image in the cell if the row/col isn't hidden.
+      width  += x1 if size_col(col_start, anchor) > 0
+      height += y1 if size_row(row_start, anchor) > 0
 
       # Subtract the underlying cell widths to find the end cell of the object.
       while width >= size_col(col_end, anchor)
@@ -6063,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"],
@@ -6100,6 +6142,18 @@ module Writexlsx
       end
     end
 
+    #
+    # Get the index used to address a vml_drawing rel link.
+    #
+    def get_vml_drawing_rel_index(target)
+      if @vml_drawing_rels[target]
+        @vml_drawing_rels[target]
+      else
+        @vml_drawing_rels_id += 1
+        @vml_drawing_rels[target] = @vml_drawing_rels_id
+      end
+    end
+
     def hyperlinks_count
       @hyperlinks.keys.inject(0) { |s, n| s += @hyperlinks[n].keys.size }
     end
@@ -6447,13 +6501,13 @@ module Writexlsx
     #
     # Set up image/drawings.
     #
-    def prepare_image(index, image_id, drawing_id, width, height, name, image_type, x_dpi = 96, y_dpi = 96) #:nodoc:
+    def prepare_image(index, image_id, drawing_id, width, height, name, image_type, x_dpi = 96, y_dpi = 96, md5 = nil) #:nodoc:
       x_dpi ||= 96
       y_dpi ||= 96
       drawing_type = 2
 
       row, col, image, x_offset, y_offset,
-      x_scale, y_scale, url, tip, anchor = @images[index]
+      x_scale, y_scale, url, tip, anchor, description, decorative = @images[index]
 
       width  *= x_scale
       height *= y_scale
@@ -6468,7 +6522,7 @@ module Writexlsx
       height = (0.5 + (height * 9_525)).to_i
 
       # Create a Drawing object to use with worksheet unless one already exists.
-      drawing = Drawing.new(drawing_type, dimensions, width, height, name, nil, anchor, 0, 0, tip)
+      drawing = Drawing.new(drawing_type, dimensions, width, height, name, nil, anchor, 0, 0, tip, decorative)
       if !drawings?
         drawings = Drawings.new
         drawings.embedded = 1
@@ -6481,6 +6535,10 @@ module Writexlsx
       end
       drawings.add_drawing_object(drawing)
 
+      if description
+        drawing.description = description
+      end
+
       if url
         rel_type = '/hyperlink'
         target_mode = 'External'
@@ -6488,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
@@ -6503,24 +6570,30 @@ Ignoring URL #{target} where link or anchor > 255 characters since it exceeds Ex
 EOS
         end
 
-        if target
+        if target && !@drawing_rels[url]
           @drawing_links << [rel_type, target, target_mode]
         end
-        drawing.url_rel_index = drawing_rel_index
+        drawing.url_rel_index = drawing_rel_index(url)
       end
 
-      drawing.rel_index = drawing_rel_index
-      @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"]
+      if !@drawing_rels[md5]
+        @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"]
+      end
+      drawing.rel_index = drawing_rel_index(md5)
     end
     public :prepare_image
 
-    def prepare_header_image(image_id, width, height, name, image_type, position, x_dpi, y_dpi)
+    def prepare_header_image(image_id, width, height, name, image_type, position, x_dpi, y_dpi, md5)
       # Strip the extension from the filename.
       body = name.dup
       body[/\.[^\.]+$/, 0] = ''
 
-      @header_images_array << [width, height, body, position, x_dpi, y_dpi]
-      @vml_drawing_links   << ['/image', "../media/image#{image_id}.#{image_type}" ]
+      if !@vml_drawing_rels[md5]
+        @vml_drawing_links   << ['/image', "../media/image#{image_id}.#{image_type}" ]
+      end
+
+      ref_id = get_vml_drawing_rel_index(md5)
+      @header_images_array << [width, height, body, position, x_dpi, y_dpi, ref_id]
     end
     public :prepare_header_image
 
@@ -6628,7 +6701,7 @@ EOS
       shape.calc_position_emus(self)
 
       drawing_type = 3
-      drawing = Drawing.new(drawing_type, shape.dimensions, shape.width_emu, shape.height_emu, shape.name, shape, shape.anchor, drawing_rel_index, 0, nil)
+      drawing = Drawing.new(drawing_type, shape.dimensions, shape.width_emu, shape.height_emu, shape.name, shape, shape.anchor, drawing_rel_index, 0, nil, 0)
       drawings.add_drawing_object(drawing)
     end
     public :prepare_shape
@@ -6718,6 +6791,8 @@ EOS
       chars.each { |c| encoded_password ^= c }
       encoded_password ^= count
       encoded_password ^= 0xCE4B
+
+      sprintf("%X", encoded_password)
     end
 
     #
@@ -7533,6 +7608,32 @@ EOS
       @writer.empty_tag('sheetProtection', attributes)
     end
 
+    #
+    # Write the <protectedRanges> element.
+    #
+    def write_protected_ranges
+      return if @num_protected_ranges == 0
+
+      @writer.tag_elements('protectedRanges') do
+        @protected_ranges.each do |protected_range|
+          write_protected_range(*protected_range)
+        end
+      end
+    end
+
+    #
+    # Write the <protectedRange> element.
+    #
+    def write_protected_range(sqref, name, password)
+      attributes = []
+
+      attributes << ['password', password] if password
+      attributes << ['sqref',    sqref]
+      attributes << ['name',     name]
+
+      @writer.empty_tag('protectedRange', attributes)
+    end
+
     #
     # Write the <drawing> elements.
     #
@@ -8065,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/drawing/{test_write_ext.rb → test_write_xdr_ext.rb}

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/drawing'
 
-class TestWriteExt < Minitest::Test
+class TestWriteXdrExt < Minitest::Test
   def setup
     @drawing = Writexlsx::Drawings.new
   end
@@ -10,7 +10,7 @@ class TestWriteExt < Minitest::Test
   def test_write_ext
     expected = '<xdr:ext cx="9308969" cy="6078325"/>'
 
-    @drawing.__send__(:write_ext, 9308969, 6078325)
+    @drawing.__send__(:write_xdr_ext, 9308969, 6078325)
     result = @drawing.instance_variable_get(:@writer).string
 
     assert_equal(expected, result)

data/test/regression/test_array_formula04.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionArrayFormula04 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_array_formula04
+    @xlsx = 'array_formula04.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_array_formula(
+      'A1:A3',
+      '{=SUM(B1:C1*B2:C2)}',
+      nil,
+      0
+    )
+
+    workbook.close
+    compare_for_regression(
+      [ 'xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels' ],
+      {'xl/workbook.xml' => ['<workbookView']}
+    )
+  end
+end

data/test/regression/test_chart_crossing01.rb

@@ -33,7 +33,7 @@ class TestRegressionChartCrossing01 < Minitest::Test
 
     chart.set_y_axis(:crossing => 'max')
 
-    # Not stictly required. Just to match reference file.
+    # Not strictly required. Just to match reference file.
     chart.set_x_axis(:position => 't')
 
     worksheet.insert_chart('E9', chart)

data/test/regression/test_chart_crossing05.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartCrossing05 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_crossing05
+    @xlsx = 'chart_crossing05.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [55948032, 55950336])
+
+    data = [
+            [1, 2, 3,  4,  5],
+            [2, 4, 6,  8, 10],
+            [3, 6, 9, 12, 15]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(:values => '=Sheet1!$A$1:$A$5')
+    chart.add_series(:values => '=Sheet1!$B$1:$B$5')
+    chart.add_series(:values => '=Sheet1!$C$1:$C$5')
+
+    chart.set_x_axis(:crossing => 'min')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression(
+      nil,
+      {
+        'xl/charts/chart1.xml' => [ '<c:pageMargins' ]
+      }
+    )
+  end
+end

data/test/regression/test_chart_crossing06.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartCrossing06 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_crossing06
+    @xlsx = 'chart_crossing06.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [72794880, 72796416])
+
+    data = [
+            [1, 2, 3,  4,  5],
+            [2, 4, 6,  8, 10],
+            [3, 6, 9, 12, 15]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(:values => '=Sheet1!$A$1:$A$5')
+    chart.add_series(:values => '=Sheet1!$B$1:$B$5')
+    chart.add_series(:values => '=Sheet1!$C$1:$C$5')
+
+    chart.set_y_axis(:crossing => 'min')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression(
+      nil,
+      {
+        'xl/charts/chart1.xml' => [ '<c:pageMargins' ]
+      }
+    )
+  end
+end

data/test/regression/test_chart_data_labels26.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels26 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_data_labels26
+    @xlsx = 'chart_data_labels26.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [48514944, 48516480])
+
+    data = [
+      [ 1,  2,  3,  4,  5],
+      [ 2,  4,  6,  8, 10],
+      [ 3,  6,  9, 12, 15],
+      [10, 20, 30, 40, 50]
+    ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(
+      :values      => '=Sheet1!$A$1:$A$5',
+      :data_labels => {:value    => 1, :custom => [{:value => 33}]}
+    )
+
+    chart.add_series(:values => '=Sheet1!$B$1:$B$5')
+    chart.add_series(:values => '=Sheet1!$C$1:$C$5')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression
+  end
+end