write_xlsx 0.85.9 → 1.09.2

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -16,8 +16,8 @@ module Writexlsx
       def cell_attributes #:nodoc:
         xf_index = xf ? xf.get_xf_index : 0
         attributes = [
-                      ['r', xl_rowcol_to_cell(row, col)]
-                     ]
+          ['r', xl_rowcol_to_cell(row, col)]
+        ]
 
         # Add the cell format index.
         if xf_index != 0
@@ -100,7 +100,7 @@ module Writexlsx
           elsif error_code.include?(@result)
             attributes << ['t', 'e']
           else
-             attributes << ['t', 'str']
+            attributes << ['t', 'str']
           end
         end
         @worksheet.writer.tag_elements('c', attributes) do
@@ -128,6 +128,49 @@ module Writexlsx
       end
     end
 
+    class DynamicFormulaArrayCellData < CellData # :nodoc:
+      def initialize(worksheet, row, col, formula, xf, range, result)
+        @worksheet = worksheet
+        @row, @col, @token, @xf, @range, @result = row, col, formula, xf, range, result
+      end
+
+      def data
+        @result || 0
+      end
+
+      def write_cell
+        # Add metadata linkage for dynamic array formulas.
+        attributes = cell_attributes
+        attributes << ['cm', '1']
+
+        @worksheet.writer.tag_elements('c', attributes) do
+          @worksheet.write_cell_array_formula(token, range)
+          @worksheet.write_cell_value(result)
+        end
+      end
+    end
+
+    class BooleanCellData < CellData # :nodoc:
+      def initialize(worksheet, row, col, val, xf)
+        @worksheet = worksheet
+        @row, @col, @token, @xf = row, col, val, xf
+      end
+
+      def data
+        @token
+      end
+
+      def write_cell
+        attributes = cell_attributes
+
+        attributes << ['t', 'b']
+        @worksheet.writer.tag_elements('c', attributes) do
+          @worksheet.write_cell_value(token)
+        end
+      end
+    end
+
+
     class BlankCellData < CellData # :nodoc:
       def initialize(worksheet, row, col, xf)
         @worksheet = worksheet

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -32,11 +32,17 @@ module Writexlsx
         @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 @@ module Writexlsx
         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 @@ module Writexlsx
       #
       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
 
@@ -128,16 +138,13 @@ 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 += xl_rowcol_to_cell(row_first, col_first)
-          else
-            sqref += xl_range(row_first, row_last, col_first, col_last)
-          end
+          sqref += xl_range(row_first, row_last, col_first, col_last)
         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
@@ -174,11 +181,11 @@ module Writexlsx
         end
         unless valid_validation_type.has_key?(@validate.downcase)
           raise WriteXLSXOptionParameterError,
-          "Unknown validation type '#{@validate}' for parameter :validate in data_validation()"
+                "Unknown validation type '#{@validate}' for parameter :validate in data_validation()"
         end
         if @error_type && !error_type_hash.has_key?(@error_type.downcase)
           raise WriteXLSXOptionParameterError,
-          "Unknown criteria type '#param[:error_type}' for parameter :error_type in data_validation()"
+                "Unknown criteria type '#param[:error_type}' for parameter :error_type in data_validation()"
         end
       end
 
@@ -192,7 +199,7 @@ module Writexlsx
         if @criteria == 'between' || @criteria == 'notBetween'
           unless has_key?(:maximum)
             raise WriteXLSXOptionParameterError,
-            "Parameter :maximum is required in data_validation() when using :between or :not between criteria"
+                  "Parameter :maximum is required in data_validation() when using :between or :not between criteria"
           end
         else
           @maximum = nil
@@ -202,15 +209,22 @@ module Writexlsx
       def check_valid_citeria_types
         unless valid_criteria_type.has_key?(@criteria.downcase)
           raise WriteXLSXOptionParameterError,
-          "Unknown criteria type '#{@criteria}' for parameter :criteria in data_validation()"
+                "Unknown criteria type '#{@criteria}' for parameter :criteria in data_validation()"
         end
       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
@@ -239,22 +253,22 @@ module Writexlsx
       # List of valid input parameters.
       def valid_validation_parameter
         [
-         :validate,
-         :criteria,
-         :value,
-         :source,
-         :minimum,
-         :maximum,
-         :ignore_blank,
-         :dropdown,
-         :show_input,
-         :input_title,
-         :input_message,
-         :show_error,
-         :error_title,
-         :error_message,
-         :error_type,
-         :other_cells
+          :validate,
+          :criteria,
+          :value,
+          :source,
+          :minimum,
+          :maximum,
+          :ignore_blank,
+          :dropdown,
+          :show_input,
+          :input_title,
+          :input_message,
+          :show_error,
+          :error_title,
+          :error_message,
+          :error_type,
+          :other_cells
         ]
       end
 
@@ -280,17 +294,6 @@ module Writexlsx
         }
       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,36 +7,38 @@ module Writexlsx
 
       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
 
         # Strip the mailto header.
         normalized_str = str.sub(/^mailto:/, '')
 
+        # Split url into the link and optional anchor/location.
+        url, @url_str = url.split(/#/, 2)
+
         # 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 > 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
         @str       = normalized_str
-        @url_str   = nil
         @tip       = tip
       end
 
@@ -59,33 +61,12 @@ module Writexlsx
       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
@@ -96,9 +77,9 @@ module Writexlsx
         # 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
@@ -106,9 +87,9 @@ module Writexlsx
 
       def attributes(row, col, dummy = nil)
         attr = [
-                ['ref', xl_rowcol_to_cell(row, col)],
-                ['location', @url]
-               ]
+          ['ref', xl_rowcol_to_cell(row, col)],
+          ['location', @url]
+        ]
 
         attr << ['tooltip', @tip] if @tip
         attr << ['display', @str]
@@ -116,7 +97,7 @@ module Writexlsx
     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
 
@@ -127,31 +108,29 @@ module Writexlsx
         # Strip the mailto header.
         str.sub!(/^mailto:/, '')
 
+        # Split url into the link and optional anchor/location.
+        url, url_str = url.split(/#/, 2)
+
         # Escape URL unless it looks already escaped.
         url = escape_url(url)
 
-        # External Workbook links need to be modified into the right format.
-        # The URL will look something like 'c:\temp\file.xlsx#Sheet!A1'.
-        # We need the part to the left of the # as the URL and the part to
-        # the right as the "location" string (if it exists).
-        url, url_str = url.split(/#/)
-
         # Add the file:/// URI to the url if non-local.
         if url =~ %r![:]! ||        # Windows style "C:/" link.
-            url =~ %r!^\\\\!        # Network share.
+           url =~ %r!^\\\\!        # Network share.
           url = "file:///#{url}"
         end
 
         # 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 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
         @str       = str
-        @url_str   = url_str
         @tip       = tip
       end
     end

data/lib/write_xlsx/worksheet/page_setup.rb

@@ -105,12 +105,12 @@ module Writexlsx
         attributes << ['pageOrder',       "overThenDown"] if @across
         attributes << ['firstPageNumber', @page_start]    if @page_start && @page_start > 1
         attributes << ['orientation',
-          if @orientation
-            'portrait'
-          else
-            'landscape'
-          end
-        ]
+                       if @orientation
+                         'portrait'
+                       else
+                         'landscape'
+                       end
+                      ]
         attributes << ['blackAndWhite', 1]      if @black_white
         attributes << ['useFirstPageNumber', 1] if ptrue?(@page_start)
 
@@ -180,12 +180,12 @@ module Writexlsx
 
       def margin_attributes    # :nodoc:
         [
-         ['left',   @margin_left],
-         ['right',  @margin_right],
-         ['top',    @margin_top],
-         ['bottom', @margin_bottom],
-         ['header', @margin_header],
-         ['footer', @margin_footer]
+          ['left',   @margin_left],
+          ['right',  @margin_right],
+          ['top',    @margin_top],
+          ['bottom', @margin_bottom],
+          ['header', @margin_header],
+          ['footer', @margin_footer]
         ]
       end
     end