write_xlsx 0.64.1 → 0.65.0

data/lib/write_xlsx/workbook.rb

@@ -1,8 +1,10 @@
 # -*- coding: utf-8 -*-
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/package/packager'
+require 'write_xlsx/sheets'
 require 'write_xlsx/worksheet'
 require 'write_xlsx/chartsheet'
+require 'write_xlsx/formats'
 require 'write_xlsx/format'
 require 'write_xlsx/shape'
 require 'write_xlsx/utility'
@@ -14,6 +16,8 @@ require 'digest/md5'
 
 module Writexlsx
 
+  OFFICE_URL = 'http://schemas.microsoft.com/office/'   # :nodoc:
+
   # The WriteXLSX provides an object oriented interface to a new Excel workbook.
   # The following methods are available through a new workbook.
   #
@@ -34,12 +38,9 @@ module Writexlsx
 
     include Writexlsx::Utility
 
-    BASE_NAME = { :sheet => 'Sheet', :chart => 'Chart'}  # :nodoc:
-
     attr_writer :firstsheet  # :nodoc:
     attr_reader :palette  # :nodoc:
-    attr_reader :font_count, :num_format_count, :border_count, :fill_count, :custom_colors  # :nodoc:
-    attr_reader :worksheets, :sheetnames, :charts, :drawings  # :nodoc:
+    attr_reader :worksheets, :charts, :drawings  # :nodoc:
     attr_reader :num_comment_files, :num_vml_files, :named_ranges  # :nodoc:
     attr_reader :doc_properties  # :nodoc:
     attr_reader :image_types, :images  # :nodoc:
@@ -97,19 +98,12 @@ module Writexlsx
       @firstsheet          = 0
       @selected            = 0
       @fileclosed          = false
-      @sheet_name          = 'Sheet'
-      @chart_name          = 'Chart'
-      @sheetname_count     = 0
-      @chartname_count     = 0
-      @worksheets          = []
+      @worksheets          = Sheets.new
       @charts              = []
       @drawings            = []
-      @sheetnames          = []
-      @formats             = []
+      @formats             = Formats.new
       @xf_formats          = []
-      @xf_format_indices   = {}
       @dxf_formats         = []
-      @dxf_format_indices  = {}
       @font_count          = 0
       @num_format_count    = 0
       @defined_names       = []
@@ -265,7 +259,7 @@ module Writexlsx
       write_book_views
 
       # Write the worksheet names and ids.
-      write_sheets
+      @worksheets.write_sheets(@writer)
 
       # Write the workbook defined names.
       write_defined_names
@@ -305,7 +299,6 @@ module Writexlsx
       name  = check_sheetname(name)
       worksheet = Worksheet.new(self, @worksheets.size, name)
       @worksheets << worksheet
-      @sheetnames << name
       worksheet
     end
 
@@ -403,7 +396,6 @@ module Writexlsx
         chartsheet = Chartsheet.new(self, @worksheets.size, sheetname)
         chartsheet.chart   = chart
         @worksheets << chartsheet
-        @sheetnames << sheetname
       end
       @charts << chart
       ptrue?(embedded) ? chart : chartsheet
@@ -422,15 +414,9 @@ module Writexlsx
     # Format properties and how to set them.
     #
     def add_format(properties = {})
-      init_data = [
-        @xf_format_indices,
-        @dxf_format_indices,
-        properties
-      ]
+      format = Format.new(@formats, properties)
 
-      format = Format.new(*init_data)
-
-      @formats.push(format)    # Store format reference
+      @formats.formats.push(format)    # Store format reference
 
       format
     end
@@ -716,7 +702,7 @@ module Writexlsx
       if name =~ /^(.*)!(.*)$/
         sheetname   = $1
         name        = $2
-        sheet_index = get_sheet_index(sheetname)
+        sheet_index = @worksheets.index_by_name(sheetname)
       else
         sheet_index = -1   # Use -1 to indicate global names.
       end
@@ -946,12 +932,21 @@ module Writexlsx
       @shared_strings.empty?
     end
 
-    def xf_formats     # :nodoc:
-      @xf_formats.dup
+    def chartsheet_count
+      @worksheets.chartsheet_count
     end
 
-    def dxf_formats    # :nodoc:
-      @dxf_formats.dup
+    def style_properties
+      [
+       @xf_formats,
+       @palette,
+       @font_count,
+       @num_format_count,
+       @border_count,
+       @fill_count,
+       @custom_colors,
+       @dxf_formats
+      ]
     end
 
     private
@@ -1037,52 +1032,11 @@ module Writexlsx
     # invalid characters and if the name is unique in the workbook.
     #
     def check_sheetname(name) #:nodoc:
-      make_and_check_sheet_chart_name(:sheet, name)
+      @worksheets.make_and_check_sheet_chart_name(:sheet, name)
     end
 
     def check_chart_sheetname(name)
-      make_and_check_sheet_chart_name(:chart, name)
-    end
-
-    def make_and_check_sheet_chart_name(type, name)
-      count = sheet_chart_count_increment(type)
-      name = "#{BASE_NAME[type]}#{count}" unless ptrue?(name)
-
-      check_valid_sheetname(name)
-      name
-    end
-
-    def sheet_chart_count_increment(type)
-      case type
-      when :sheet
-        @sheetname_count += 1
-      when :chart
-        @chartname_count += 1
-      end
-    end
-
-    def check_valid_sheetname(name)
-      # Check that sheet name is <= 31. Excel limit.
-      raise "Sheetname #{name} must be <= #{SHEETNAME_MAX} chars" if name.length > SHEETNAME_MAX
-
-      # Check that sheetname doesn't contain any invalid characters
-      invalid_char = /[\[\]:*?\/\\]/
-      if name =~ invalid_char
-        raise 'Invalid character []:*?/\\ in worksheet name: ' + name
-      end
-
-      # Check that the worksheet name doesn't already exist since this is a fatal
-      # error in Excel 97. The check must also exclude case insensitive matches.
-      unless is_sheetname_uniq?(name)
-        raise "Worksheet name '#{name}', with case ignored, is already used."
-      end
-    end
-
-    def is_sheetname_uniq?(name)
-      @worksheets.each do |worksheet|
-        return false if name.downcase == worksheet.name.downcase
-      end
-      true
+      @worksheets.make_and_check_sheet_chart_name(:chart, name)
     end
 
     #
@@ -1184,29 +1138,6 @@ module Writexlsx
       @writer.empty_tag('workbookView', attributes)
     end
 
-    def write_sheets #:nodoc:
-      @writer.tag_elements('sheets') do
-        id_num = 1
-        @worksheets.each do |sheet|
-          write_sheet(sheet.name, id_num, sheet.hidden?)
-          id_num += 1
-        end
-      end
-    end
-
-    def write_sheet(name, sheet_id, hidden = false) #:nodoc:
-      attributes = [
-        'name',    name,
-        'sheetId', sheet_id
-      ]
-
-      if hidden
-        attributes << 'state' << 'hidden'
-      end
-      attributes << 'r:id' << "rId#{sheet_id}"
-      @writer.empty_tag_encoded('sheet', attributes)
-    end
-
     def write_calc_pr #:nodoc:
       attributes = ['calcId', 124519]
       @writer.empty_tag('calcPr', attributes)
@@ -1219,9 +1150,10 @@ module Writexlsx
 
     def write_ext #:nodoc:
       tag = 'ext'
+      uri = "#{OFFICE_URL}mac/excel/2008/main"
       attributes = [
-        'xmlns:mx', 'http://schemas.microsoft.com/office/mac/excel/2008/main',
-        'uri', 'http://schemas.microsoft.com/office/mac/excel/2008/main'
+        'xmlns:mx', uri,
+        'uri', uri
       ]
       @writer.tag_elements(tag, attributes) { write_mx_arch_id }
     end
@@ -1289,8 +1221,7 @@ module Writexlsx
       add_chart_data
 
       # Package the workbook.
-      packager = Package::Packager.new
-      packager.add_workbook(self)
+      packager = Package::Packager.new(self)
       packager.set_package_dir(@tempdir)
       packager.create_package
 
@@ -1328,7 +1259,7 @@ module Writexlsx
     # formats.
     #
     def prepare_formats #:nodoc:
-      @formats.each do |format|
+      @formats.formats.each do |format|
         xf_index  = format.xf_index
         dxf_index = format.dxf_index
 
@@ -1562,8 +1493,7 @@ module Writexlsx
       # Add a font format for cell comments.
       if comment_files > 0
         format = Format.new(
-            @xf_format_indices,
-            @dxf_format_indices,
+            @formats,
             :font          => 'Tahoma',
             :size          => 8,
             :color_indexed => 81,
@@ -1572,7 +1502,7 @@ module Writexlsx
 
         format.get_xf_index
 
-        @formats << format
+        @formats.formats << format
       end
     end
 
@@ -1728,7 +1658,7 @@ module Writexlsx
 
         drawing_id += 1
 
-        (0 .. chart_count - 1).each do |index|
+        sheet.charts.each_with_index do |chart, index|
           chart_ref_id += 1
           sheet.prepare_chart(index, chart_ref_id, drawing_id)
         end
@@ -1758,23 +1688,6 @@ module Writexlsx
       @drawing_count = drawing_id
     end
 
-    #
-    # Convert a sheet name to its index. Return undef otherwise.
-    #
-    def get_sheet_index(sheetname) #:nodoc:
-      sheet_count = @sheetnames.size
-      sheet_index = nil
-
-      sheetname.sub!(/^'/, '')
-      sheetname.sub!(/'$/, '')
-
-      ( 0 .. sheet_count - 1 ).each do |i|
-        sheet_index = i if sheetname == @sheetnames[i]
-      end
-
-      sheet_index
-    end
-
     #
     # Extract information from the image file such as dimension, type, filename,
     # and extension. Also keep track of previously seen images to optimise out

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -0,0 +1,291 @@
+# -*- encoding: utf-8 -*-
+
+module Writexlsx
+  class Worksheet
+    class DataValidation   # :nodoc:
+      include Writexlsx::Utility
+
+      attr_reader :value, :source, :minimum, :maximum, :validate, :criteria
+      attr_reader :error_type, :cells, :other_cells
+      attr_reader :ignore_blank, :dropdown, :show_input, :show_error
+      attr_reader :error_title, :error_message, :input_title, :input_message
+
+      def initialize(*args)
+        # Check for a cell reference in A1 notation and substitute row and column.
+        row1, col1, row2, col2, options = row_col_notation(args)
+        if row2.respond_to?(:keys)
+          options_to_instance_variable(row2.dup)
+          row2, col2 = row1, col1
+        elsif options.respond_to?(:keys)
+          options_to_instance_variable(options.dup)
+        else
+          raise WriteXLSXInsufficientArgumentError
+        end
+        raise WriteXLSXInsufficientArgumentError if [row1, col1, row2, col2].include?(nil)
+        check_for_valid_input_params
+
+        check_dimensions(row1, col1)
+        check_dimensions(row2, col2)
+        @cells = [[row1, col1, row2, col2]]
+
+        @value = @source  if @source
+        @value = @minimum if @minimum
+
+        @validate = valid_validation_type[@validate.downcase]
+        if @validate == 'none'
+          @validate_none = true
+          return
+        end
+        if ['list', 'custom'].include?(@validate)
+          @criteria  = 'between'
+          @maximum   = nil
+        end
+
+        check_criteria_required
+        check_valid_citeria_types
+        @criteria = valid_criteria_type[@criteria.downcase]
+
+        check_maximum_value_when_criteria_is_between_or_notbetween
+        @error_type = has_key?(:error_type) ? error_type_hash[@error_type.downcase] : 0
+
+        convert_date_time_value_if_required
+        set_some_defaults
+
+      # A (for now) undocumented parameter to pass additional cell ranges.
+        @other_cells.each { |cells| @cells << cells } if has_key?(:other_cells)
+      end
+
+      def options_to_instance_variable(params)
+        params.each do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+      end
+
+      def keys
+        self.instance_variables.collect { |v| v.to_s.sub(/@/, '').to_sym }
+      end
+
+      def validate_none?
+        @validate_none
+      end
+
+      #
+      # Write the <dataValidation> element.
+      #
+      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
+        end
+      end
+
+      private
+
+      #
+      # Write the <formula1> element.
+      #
+      def write_formula_1(formula) #:nodoc:
+        # Convert a list array ref into a comma separated string.
+        formula   = %!"#{formula.join(',')}"! if formula.kind_of?(Array)
+
+        formula = formula.sub(/^=/, '') if formula.respond_to?(:sub)
+
+        @writer.data_element('formula1', formula)
+      end
+
+      #
+      # Write the <formula2> element.
+      #
+      def write_formula_2(formula) #:nodoc:
+        formula = formula.sub(/^=/, '') if formula.respond_to?(:sub)
+
+        @writer.data_element('formula2', formula)
+      end
+
+      def attributes
+        sqref      = ''
+        attributes = []
+
+        # Set the cell range(s) for the data validation.
+        @cells.each do |cells|
+          # Add a space between multiple cell ranges.
+          sqref += ' ' if sqref != ''
+
+          row_first, col_first, row_last, col_last = cells
+
+          # Swap last row/col for 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
+
+          # 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
+        end
+
+        attributes << 'type' << @validate
+        attributes << 'operator' << @criteria if @criteria != 'between'
+
+        if @error_type
+          attributes << 'errorStyle' << 'warning' if @error_type == 1
+          attributes << 'errorStyle' << 'information' if @error_type == 2
+        end
+        attributes << 'allowBlank'       << 1 if @ignore_blank != 0
+        attributes << 'showDropDown'     << 1 if @dropdown     == 0
+        attributes << 'showInputMessage' << 1 if @show_input   != 0
+        attributes << 'showErrorMessage' << 1 if @show_error   != 0
+
+        attributes << 'errorTitle'  << @error_title   if @error_title
+        attributes << 'error'       << @error_message if @error_message
+        attributes << 'promptTitle' << @input_title   if @input_title
+        attributes << 'prompt'      << @input_message if @input_message
+        attributes << 'sqref'       << sqref
+      end
+
+      def has_key?(key)
+        keys.index(key)
+      end
+
+      def set_some_defaults
+        @ignore_blank ||= 1
+        @dropdown     ||= 1
+        @show_input   ||= 1
+        @show_error   ||= 1
+      end
+
+      def check_for_valid_input_params
+        check_parameter(self, valid_validation_parameter, 'data_validation')
+
+        unless has_key?(:validate)
+          raise WriteXLSXOptionParameterError, "Parameter :validate is required in data_validation()"
+        end
+        unless valid_validation_type.has_key?(@validate.downcase)
+          raise WriteXLSXOptionParameterError,
+          "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()"
+        end
+      end
+
+      def check_criteria_required
+        unless has_key?(:criteria)
+          raise WriteXLSXOptionParameterError, "Parameter :criteria is required in data_validation()"
+        end
+      end
+
+      def check_maximum_value_when_criteria_is_between_or_notbetween
+        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"
+          end
+        else
+          @maximum = nil
+        end
+      end
+
+      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()"
+        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."
+          end
+        end
+      end
+
+      def error_type_hash
+        {'stop' => 0, 'warning' => 1, 'information' => 2}
+      end
+
+      def valid_validation_type # :nodoc:
+        {
+          'any'             => 'none',
+          'any value'       => 'none',
+          'whole number'    => 'whole',
+          'whole'           => 'whole',
+          'integer'         => 'whole',
+          'decimal'         => 'decimal',
+          'list'            => 'list',
+          'date'            => 'date',
+          'time'            => 'time',
+          'text length'     => 'textLength',
+          'length'          => 'textLength',
+          'custom'          => 'custom'
+        }
+      end
+
+      # 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
+        ]
+      end
+
+      # List of valid criteria types.
+      def valid_criteria_type  # :nodoc:
+        {
+          'between'                     => 'between',
+          'not between'                 => 'notBetween',
+          'equal to'                    => 'equal',
+          '='                           => 'equal',
+          '=='                          => 'equal',
+          'not equal to'                => 'notEqual',
+          '!='                          => 'notEqual',
+          '<>'                          => 'notEqual',
+          'greater than'                => 'greaterThan',
+          '>'                           => 'greaterThan',
+          'less than'                   => 'lessThan',
+          '<'                           => 'lessThan',
+          'greater than or equal to'    => 'greaterThanOrEqual',
+          '>='                          => 'greaterThanOrEqual',
+          'less than or equal to'       => 'lessThanOrEqual',
+          '<='                          => 'lessThanOrEqual'
+        }
+      end
+
+      def convert_date_time_value(key)  # :nodoc:
+        value = instance_variable_get("@#{key}")
+        if value && value =~ /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
+    end
+  end
+end

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -0,0 +1,111 @@
+# -*- encoding: utf-8 -*-
+
+module Writexlsx
+  class Worksheet
+    class Hyperlink   # :nodoc:
+      include Writexlsx::Utility
+
+      attr_reader :url, :link_type, :str, :url_str
+      attr_accessor :tip, :display
+
+      def initialize(url, str = nil)
+        link_type = 1
+
+        # Remove the URI scheme from internal links.
+        if url =~ /^internal:/
+          url = url.sub(/^internal:/, '')
+          link_type = 2
+          # Remove the URI scheme from external links.
+        elsif url =~ /^external:/
+          url = url.sub(/^external:/, '')
+          link_type = 3
+        end
+
+        # The displayed string defaults to the url string.
+        str ||= url.dup
+
+        # For external links change the directory separator from Unix to Dos.
+        if link_type == 3
+          url = url.gsub(%r|/|, '\\')
+          str.gsub!(%r|/|, '\\')
+        end
+
+        # Strip the mailto header.
+        str.sub!(/^mailto:/, '')
+
+        # Copy string for use in hyperlink elements.
+        url_str = str.dup
+
+        # External links to URLs and to other Excel workbooks have slightly
+        # different characteristics that we have to account for.
+        if link_type == 1
+          # Escape URL unless it looks already escaped.
+          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
+
+          # Ordinary URL style external links don't have a "location" string.
+          url_str = nil
+        elsif link_type == 3
+          # 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 = "file:///#{url}"
+          end
+
+          # Convert a ./dir/file.xlsx link to dir/file.xlsx.
+          url = url.sub(%r!^.\\!, '')
+
+          # Treat as a default external link now that the data has been modified.
+          link_type = 1
+        end
+
+        # Excel limits escaped URL to 255 characters.
+        if url.bytesize > 255
+          raise "URL '#{url}' > 255 characters, it exceeds Excel's limit for URLS."
+        end
+        @url       = url
+        @link_type = link_type
+        @str       = str
+        @url_str   = url_str
+      end
+
+      def write_external_attributes(row, col, id)
+        ref = xl_rowcol_to_cell(row, col)
+
+        attributes = ['ref', ref, 'r:id', "rId#{id}"]
+
+        attributes << 'location' << url_str if url_str
+        attributes << 'display'  << display if display
+        attributes << 'tooltip'  << tip     if tip
+        attributes
+      end
+
+      def write_internal_attributes(row, col)
+        ref = xl_rowcol_to_cell(row, col)
+
+        attributes = ['ref', ref, 'location', url]
+
+        attributes << 'tooltip' << tip if tip
+        attributes << 'display' << str
+      end
+    end
+  end
+end