write_xlsx 0.97.0 → 1.04.0

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -219,10 +219,17 @@ def check_valid_citeria_types
       end
 
       def convert_date_time_value_if_required
-        @date_1904 = date_1904?
         if @validate == 'date' || @validate == 'time'
-          unless convert_date_time_value(:value) && convert_date_time_value(:maximum)
-            raise WriteXLSXOptionParameterError, "Invalid date/time value."
+          date_time = convert_date_time(@value)
+          if date_time
+            @value = date_time
+          end
+
+          if @maximum
+            date_time = convert_date_time(@maximum)
+            if date_time
+              @maximum = date_time
+            end
           end
         end
       end
@@ -292,17 +299,6 @@ def valid_criteria_type  # :nodoc:
         }
       end
 
-      def convert_date_time_value(key)  # :nodoc:
-        value = instance_variable_get("@#{key}")
-        if value && value.to_s =~ /T/
-          date_time = convert_date_time(value)
-          instance_variable_set("@#{key}", date_time) if date_time
-          date_time
-        else
-          true
-        end
-      end
-
       def date_1904?
         @date_1904
       end

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -7,19 +7,19 @@ class Hyperlink   # :nodoc:
 
       attr_reader :str, :tip
 
-      MAXIMUM_URLS_SIZE = 255
+      MAXIMUM_URLS_SIZE = 2079
 
-      def self.factory(url, str = nil, tip = nil)
+      def self.factory(url, str = nil, tip = nil, max_url_length = MAXIMUM_URLS_SIZE)
         if url =~ /^internal:(.+)/
-          InternalHyperlink.new($~[1], str, tip)
+          InternalHyperlink.new($~[1], str, tip, max_url_length)
         elsif url =~ /^external:(.+)/
-          ExternalHyperlink.new($~[1], str, tip)
+          ExternalHyperlink.new($~[1], str, tip, max_url_length)
         else
-          new(url, str, tip)
+          new(url, str, tip, max_url_length)
         end
       end
 
-      def initialize(url, str, tip)
+      def initialize(url, str, tip, max_url_length)
         # The displayed string defaults to the url string.
         str ||= url.dup
 
@@ -33,8 +33,8 @@ def initialize(url, str, tip)
         url = escape_url(url)
 
         # 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."
+        if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
+          raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation."
         end
 
         @url       = url
@@ -61,33 +61,12 @@ def external_hyper_link
       def display_on
         @display = @url_str
       end
-
-      private
-
-      def escape_url(url)
-        unless url =~ /%[0-9a-fA-F]{2}/
-          # Escape the URL escape symbol.
-          url = url.gsub(/%/, "%25")
-
-          # Escape whitespae in URL.
-          url = url.gsub(/[\s\x00]/, '%20')
-
-          # Escape other special characters in URL.
-          re = /(["<>\[\]`^{}])/
-          while re =~ url
-            match = $~[1]
-            url = url.sub(re, sprintf("%%%x", match.ord))
-          end
-        end
-
-        url
-      end
     end
 
     class InternalHyperlink < Hyperlink
       undef external_hyper_link
 
-      def initialize(url, str, tip)
+      def initialize(url, str, tip, max_url_length)
         @url = url
         # The displayed string defaults to the url string.
         str ||= @url.dup
@@ -98,9 +77,9 @@ def initialize(url, str, tip)
         # Copy string for use in hyperlink elements.
         @url_str = @str.dup
 
-        # Excel limits escaped URL to 255 characters.
-        if @url.bytesize > MAXIMUM_URLS_SIZE
-          raise "URL '#{@url}' > #{MAXIMUM_URLS_SIZE} characters, it exceeds Excel's limit for URLS."
+        # Excel limits escaped URL to #{max_url_length} characters.
+        if @url.bytesize > max_url_length
+          raise "URL '#{@url}' > #{max_url_length} characters, it exceeds Excel's limit for URLS."
         end
 
         @tip = tip
@@ -118,7 +97,7 @@ def attributes(row, col, dummy = nil)
     end
 
     class ExternalHyperlink < Hyperlink
-      def initialize(url, str, tip)
+      def initialize(url, str, tip, max_url_length)
         # The displayed string defaults to the url string.
         str ||= url.dup
 
@@ -145,9 +124,9 @@ def initialize(url, str, tip)
         url = url.sub(%r!^.\\!, '')
         @url_str   = url_str
 
-        # 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."
+        # Excel limits the escaped URL and location/anchor to max_url_length characters.
+        if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
+          raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation."
         end
 
         @url       = url

data/test/chart/test_write_legend_pos.rb

@@ -7,9 +7,17 @@ def setup
     @chart = Writexlsx::Chart.new('Bar')
   end
 
-  def test_write_legend_pos
+  def test_write_legend_pos_default
     expected = '<c:legendPos val="r"/>'
     result = @chart.__send__('write_legend_pos', 'r')
     assert_equal(expected, result)
   end
+
+  def test_write_legend_overlay_top_right
+    expected = '<c:legend><c:legendPos val="tr"/><c:layout/><c:overlay val="1"/></c:legend>'
+    @chart.set_legend(:position => 'overlay_top_right')
+    @chart.__send__('write_legend')
+    result = @chart.instance_variable_get(:@writer).string
+    assert_equal(expected, result)
+  end
 end

data/test/chartsheet/test_write_sheet_protection.rb

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestChartsheetWriteSheetProtection < Minitest::Test
+  def setup
+    workbook = WriteXLSX.new(StringIO.new)
+    workbook.add_chart(:type => 'line')
+    @chartsheet = workbook.sheets.first
+  end
+
+  def test_chartsheet_write_sheet_protection
+    expected = '<sheetProtection password="83AF" content="1" objects="1"/>'
+
+    @chartsheet.protect('', {})
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection
+    expected = '<sheetProtection password="83AF" content="1" objects="1"/>'
+
+    @chartsheet.protect('password', {})
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_without_password_and_content
+    expected = '<sheetProtection content="1"/>'
+
+    @chartsheet.protect('', {:objects => 0})
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_with_opjects0_option
+    expected = '<sheetProtection password="83AF" content="1"/>'
+
+    @chartsheet.protect('password', { :objects => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_without_password
+    expected = '<sheetProtection objects="1"/>'
+
+    @chartsheet.protect('', { :content => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_without_password_and_content_option
+    expected = ''
+
+    @chartsheet.protect('', { :content => 0, :objects => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection) || ''
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_with_password_and_content_objects_option
+    expected = '<sheetProtection password="83AF"/>'
+
+    @chartsheet.protect('password', { :content => 0, :objects => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_with_password_full_options
+    expected = '<sheetProtection password="83AF" content="1" objects="1"/>'
+
+    options = {
+      :objects               => 1,
+      :scenarios             => 1,
+      :format_cells          => 1,
+      :format_columns        => 1,
+      :format_rows           => 1,
+      :insert_columns        => 1,
+      :insert_rows           => 1,
+      :insert_hyperlinks     => 1,
+      :delete_columns        => 1,
+      :delete_rows           => 1,
+      :select_locked_cells   => 0,
+      :sort                  => 1,
+      :autofilter            => 1,
+      :pivot_tables          => 1,
+      :select_unlocked_cells => 0
+    }
+    @chartsheet.protect('password', options)
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+end

data/test/drawing/test_drawing_chart_01.rb

@@ -4,8 +4,12 @@
 
 class DrawingChart011 < Minitest::Test
   def test_drawing_chart_01
-    @obj = Writexlsx::Drawing.new
-    @obj.add_drawing_object(1, 4, 8, 457200, 104775, 12, 22, 152400, 180975)
+    @obj = Writexlsx::Drawings.new
+    dimensions = [4, 8, 457200, 104775, 12, 22, 152400, 180975]
+    drawing = Writexlsx::Drawing.new(
+      1, dimensions, nil, nil, nil, nil, 1, 1
+    )
+    @obj.add_drawing_object(drawing)
     @obj.embedded = true
     @obj.assemble_xml_file
     result = got_to_array(@obj.xml_str)

data/test/drawing/test_drawing_image_01.rb

@@ -4,9 +4,18 @@
 
 class DrawingImage011 < Minitest::Test
   def test_drawing_image_01
-    @obj = Writexlsx::Drawing.new
-    @obj.add_drawing_object(2, 2, 1, 0, 0, 3, 6, 533257, 190357,
-                           1219200, 190500, 1142857, 1142857, 'republic.png')
+    @obj = Writexlsx::Drawings.new
+    dimensions = [
+      2, 1, 0, 0, 3, 6, 533257, 190357, 1219200, 190500
+    ]
+    drawing = Writexlsx::Drawing.new(
+      2, dimensions, 1142857, 1142857, 'republic.png', nil, 2, 1
+    )
+    @obj.add_drawing_object(drawing)
+    # @obj.add_drawing_object(
+    #   2, 2, 1, 0, 0, 3, 6, 533257, 190357,
+    #   1219200, 190500, 1142857, 1142857, 'republic.png', nil, 2
+    # )
     @obj.embedded = true
     @obj.assemble_xml_file
     result = got_to_array(@obj.xml_str)

data/test/drawing/test_drawing_shape_01.rb

@@ -8,12 +8,15 @@ def test_drawing_shape_01
     shape = Writexlsx::Shape.new
     shape.id = 1000
 
-    @obj = Writexlsx::Drawing.new
+    @obj = Writexlsx::Drawings.new
     @obj.embedded = 1
-    @obj.add_drawing_object(
-                               3, 4, 8, 209550, 95250, 12, 22, 209660,
-                               96260, 10000, 20000, 95250, 190500, 'rect 1', shape
-                               )
+    dimensions = [
+      4, 8, 209550, 95250, 12, 22, 209660, 96260, 10000, 20000
+    ]
+    drawing = Writexlsx::Drawing.new(
+      3, dimensions, 95250, 190500, 'rect 1', shape, 1
+    )
+    @obj.add_drawing_object(drawing)
     @obj.assemble_xml_file
     result = got_to_array(@obj.xml_str)
     expected = expected_to_array(<<EOS

data/test/drawing/test_drawing_shape_02.rb

@@ -13,12 +13,19 @@ def test_drawing_shape_02
     # Set bulk shape properties via set_properties method
     shape.set_properties(:type => 'straightConnector1', :connect => 1)
 
-    @obj = Writexlsx::Drawing.new
+    @obj = Writexlsx::Drawings.new
     @obj.embedded = 1
-    @obj.add_drawing_object(
-                               3, 4, 8, 209550, 95250, 12, 22, 209660,
-                               96260, 10000, 20000, 95250, 190500, 'Connector 1', shape
-                               )
+    dimensions = [
+      4, 8, 209550, 95250, 12, 22, 209660, 96260, 10000, 20000
+    ]
+    drawing = Writexlsx::Drawing.new(
+      3, dimensions, 95250, 190500, 'Connector 1', shape, 1
+    )
+    @obj.add_drawing_object(drawing)
+    # @obj.add_drawing_object(
+    #   3, 4, 8, 209550, 95250, 12, 22, 209660,
+    #   96260, 10000, 20000, 95250, 190500, 'Connector 1', shape, 1
+    # )
     @obj.assemble_xml_file
     result = got_to_array(@obj.xml_str)
     expected = expected_to_array(<<EOS

data/test/drawing/test_drawing_shape_03.rb

@@ -13,12 +13,15 @@ def test_drawing_shape_03
     shape.end         = 1002
     shape.end_index   = 4
 
-    @obj = Writexlsx::Drawing.new
+    @obj = Writexlsx::Drawings.new
     @obj.embedded = 1
-    @obj.add_drawing_object(
-                               3, 4, 8, 209550, 95250, 12, 22, 209660,
-                               96260, 10000, 20000, 95250, 190500, '', shape
-                               )
+    dimensions = [
+      4, 8, 209550, 95250, 12, 22, 209660, 96260, 10000, 20000
+    ]
+    drawing = Writexlsx::Drawing.new(
+      3, dimensions, 95250, 190500, '', shape, 1
+    )
+    @obj.add_drawing_object(drawing)
     @obj.__send__('write_nv_cxn_sp_pr', 1, shape)
 
     result = got_to_array(@obj.xml_str)

data/test/drawing/test_drawing_shape_04.rb

@@ -19,36 +19,20 @@ def test_drawing_shape_04
     shape.palette[0] = [0x00, 0x00, 0x00, 0x00]
     shape.palette[7] = [0x00, 0x00, 0x00, 0x00]
 
-    @obj = Writexlsx::Drawing.new
+    @obj = Writexlsx::Drawings.new
     @obj.embedded = 2
-    @obj.add_drawing_object(
-                               3, 4, 8, 209550, 95250, 12, 22, 209660,
-                               96260, 10000, 20000, 95250, 190500, 'rect 1', shape
-                               )
+    dimensions = [
+      4, 8, 209550, 95250, 12, 22, 209660, 96260, 10000, 20000
+    ]
+    drawing = Writexlsx::Drawing.new(
+      3, dimensions, 95250, 190500, 'rect 1', shape, 1
+    )
+    @obj.add_drawing_object(drawing)
     @obj.assemble_xml_file
 
     result = got_to_array(@obj.xml_str)
     expected = expected_to_array(expected_str)
     assert_equal(expected, result)
-
-    drawing1 = Writexlsx::Drawing.new
-    @worksheet.instance_variable_set(:@drawing, drawing1)
-    inserted = @worksheet.insert_shape(4, 8, shape, 300, 400)
-
-    # Force the shape cell x offset to be non-integer
-    inserted.x_offset += 0.5
-    @worksheet.__send__(:prepare_shape, 0, 1)
-
-    # Truncate drawing object to just the dimensions
-    drawing1.instance_variable_get(:@drawings)[0] =
-      drawing1.instance_variable_get(:@drawings)[0][0..12]
-
-    # Verify fractional dimensions have been rounded
-    expected = [
-                3, 12, 24, 423862, 0, 13, 26, 290512,
-                95250, 7739062, 4572000, 476250, 476250
-               ]
-    assert_equal(expected, drawing1.instance_variable_get(:@drawings)[0])
   end
 
   def expected_str

data/test/drawing/test_drawing_shape_05.rb

@@ -19,14 +19,17 @@ def test_drawing_shape_05
     shape.flip_h   = 1
     shape.rotation = 90
 
-    @obj = Writexlsx::Drawing.new
+    @obj = Writexlsx::Drawings.new
     @obj.instance_variable_set(:@palette, @worksheet.instance_variable_get(:@palette))
     @obj.embedded = 1
 
-    @obj.add_drawing_object(
-                            3, 4, 8, 209550, 95250, 12, 22, 209660,
-                            96260, 10000, 20000, 95250, 190500, '', shape
-                            )
+    dimensions = [
+      4, 8, 209550, 95250, 12, 22, 209660, 96260, 10000, 20000
+    ]
+    drawing = Writexlsx::Drawing.new(
+      3, dimensions, 95250, 190500, '', shape, 1
+    )
+    @obj.add_drawing_object(drawing)
     @obj.__send__(:write_a_xfrm, 100, 200, 10, 20, shape)
 
     result = got_to_array(@obj.xml_str)

data/test/drawing/test_drawing_shape_06.rb

@@ -16,13 +16,18 @@ def test_drawing_shape_06
     shape = Writexlsx::Shape.new
     shape.adjustments = -10, 100, 20
 
-    @obj = Writexlsx::Drawing.new
+    @obj = Writexlsx::Drawings.new
     @obj.embedded = 1
-
-    @obj.add_drawing_object(
-                            3, 4, 8, 209550, 95250, 12, 22, 209660,
-                            96260, 10000, 20000, 95250, 190500, '', shape
-                            )
+    dimensions = [
+      4, 8, 209550, 95250, 12, 22, 209660, 96260, 10000, 20000
+    ]
+    drawing = Writexlsx::Drawing.new(
+      3, dimensions, 95250, 190500, '', shape, 1
+    )
+    @obj.add_drawing_object(drawing)
+                            # 3, 4, 8, 209550, 95250, 12, 22, 209660,
+                            # 96260, 10000, 20000, 95250, 190500, '', shape
+                            # )
     @obj.__send__(:write_a_av_lst, shape)
 
     result = got_to_array(@obj.xml_str)