write_xlsx 0.85.11 → 0.90.0

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.85.11"
+WriteXLSX_VERSION = "0.90.0"

data/lib/write_xlsx/workbook.rb

@@ -203,6 +203,14 @@ def sheets(*args)
       end
     end
 
+    #
+    # Return a worksheet object in the workbook using the sheetname.
+    #
+    def worksheet_by_name(sheetname = nil)
+      sheets.select { |s| s.name == sheetname }.first
+    end
+    alias get_worksheet_by_name worksheet_by_name
+
     #
     # Set the date system: false = 1900 (the default), true = 1904
     #
@@ -726,7 +734,7 @@ def define_name(name, formula)
 
       # Raise if the sheet index wasn't found.
       if !sheet_index
-       raise "Unknown sheet name #{sheetname} in defined_name()\n"
+       raise "Unknown sheet name #{sheetname} in defined_name()"
       end
 
       # Raise if the name contains invalid chars as defined by Excel help.
@@ -734,17 +742,17 @@ def define_name(name, formula)
       # http://office.microsoft.com/en-001/excel-help/define-and-use-names-in-formulas-HA010147120.aspx#BMsyntax_rules_for_names
       #
       if name =~ /\A[-0-9 !"#\$%&'\(\)\*\+,\.:;<=>\?@\[\]\^`\{\}~]/ || name =~ /.+[- !"#\$%&'\(\)\*\+,\\:;<=>\?@\[\]\^`\{\}~]/
-        raise "Invalid characters in name '#{name}' used in defined_name()\n"
+        raise "Invalid characters in name '#{name}' used in defined_name()"
       end
 
       # Raise if the name looks like a cell name.
       if name =~ %r(^[a-zA-Z][a-zA-Z]?[a-dA-D]?[0-9]+$)
-        raise "Invalid name '#{name}' looks like a cell name in defined_name()\n"
+        raise "Invalid name '#{name}' looks like a cell name in defined_name()"
       end
 
       # Raise if the name looks like a R1C1
       if name =~ /\A[rcRC]\Z/ || name =~ /\A[rcRC]\d+[rcRC]\d+\Z/
-        raise "Invalid name '#{name}' like a RC cell ref in defined_name()\n"
+        raise "Invalid name '#{name}' like a RC cell ref in defined_name()"
       end
 
       @defined_names.push([ name, sheet_index, formula.sub(/^=/, '') ])
@@ -786,17 +794,18 @@ def set_properties(params)
 
       # List of valid input parameters.
       valid = {
-        :title       => 1,
-        :subject     => 1,
-        :author      => 1,
-        :keywords    => 1,
-        :comments    => 1,
-        :last_author => 1,
-        :created     => 1,
-        :category    => 1,
-        :manager     => 1,
-        :company     => 1,
-        :status      => 1
+        :title          => 1,
+        :subject        => 1,
+        :author         => 1,
+        :keywords       => 1,
+        :comments       => 1,
+        :last_author    => 1,
+        :created        => 1,
+        :category       => 1,
+        :manager        => 1,
+        :company        => 1,
+        :status         => 1,
+        :hyperlink_base => 1
       }
 
       # Check for valid input parameters.
@@ -805,7 +814,7 @@ def set_properties(params)
       end
 
       # Set the creation time unless specified by the user.
-      params[:created] = @local_time unless params.has_key?(:created)
+      params[:created] = @createtime unless params.has_key?(:created)
 
       @doc_properties = params.dup
     end
@@ -1632,9 +1641,10 @@ def prepare_vml_objects  #:nodoc:
     #
     def prepare_tables
       table_id = 0
+      seen     = {}
 
       sheets.each do |sheet|
-        table_id += sheet.prepare_tables(table_id + 1)
+        table_id += sheet.prepare_tables(table_id + 1, seen)
       end
     end
 

data/lib/write_xlsx/worksheet.rb

@@ -296,6 +296,7 @@ class Worksheet
     attr_reader :comments, :comments_author # :nodoc:
     attr_accessor :dxf_priority # :nodoc:
     attr_reader :vba_codename # :nodoc:
+    attr_writer :excel_version
 
     def initialize(workbook, index, name) #:nodoc:
       @writer = Package::XMLWriterSimple.new
@@ -2528,6 +2529,26 @@ def write_array_formula(*args)
       end
     end
 
+    #
+    # write_boolean(row, col, val, format)
+    #
+    # Write a boolean value to the specified row and column (zero indexed).
+    #
+    def write_boolean(*args)
+      row, col, val, xf = row_col_notation(args)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil?
+
+      val = val ? 1 : 0  # Boolean value.
+      # xf : cell format.
+      type = 'l'                 # The data type
+
+      # Check that row and col are valid and store max and min values
+      check_dimensions(row, col)
+      store_row_col_max_min_values(row, col)
+
+      store_data_to_table(BooleanCellData.new(self, row, col, val, xf))
+    end
+
     #
     # :call-seq:
     #   update_format_with_params(row, col, format_params)
@@ -2536,12 +2557,12 @@ def write_array_formula(*args)
     #
     #     worksheet.update_format_with_params(0, 0, color: 'red')
     #
-    # This method is used to update formatting of the cell keeping cell contents 
+    # This method is used to update formatting of the cell keeping cell contents
     # and formatting.
     #
-    # If the cell doesn't have CellData object, this method create a CellData 
+    # If the cell doesn't have CellData object, this method create a CellData
     # using write_blank method.
-    # If the cell has CellData, this method fetch contents and format of cell from 
+    # If the cell has CellData, this method fetch contents and format of cell from
     # the CellData object and recreate CellData using write method.
     #
     def update_format_with_params(*args)
@@ -2589,7 +2610,7 @@ def update_format_with_params(*args)
     #
     #     worksheet.update_range_format_with_params(0, 0, 3, 3, color: 'red')
     #
-    # This method is used to update formatting of multiple cells keeping cells' contents 
+    # This method is used to update formatting of multiple cells keeping cells' contents
     # and formatting.
     #
     #
@@ -4288,7 +4309,7 @@ def conditional_formatting(*args)
     #     :header
     #     :formula
     #     :total_string
-    #     :total_function
+    #     :
     #     :format
     #
     # The column data must be specified as an array of hash. For example to
@@ -4916,9 +4937,8 @@ def insert_button(*args)
     #     :custom
     #
     # +:any+ is used to specify that the type of data is unrestricted.
-    # This is the same as not applying a data validation. It is only
-    # provided for completeness and isn't used very often in the
-    # context of WriteXLSX.
+    # This is usefl to display an input message without restricting the data
+    # that can be entered.
     #
     # +:integer+ restricts the cell to integer values. Excel refers to this
     # as 'whole number'.
@@ -5802,6 +5822,22 @@ def get_range_data(row_start, col_start, row_end, col_end) # :nodoc:
     #    width        # Width of object frame.
     #    height       # Height of object frame.
     def position_object_pixels(col_start, row_start, x1, y1, width, height) #:nodoc:
+      # Adjust start column for negative offsets.
+      while x1 < 0 && col_start > 0
+        x1 += size_col(col_start - 1)
+        col_start -= 1
+      end
+
+      # Adjust start row for negative offsets.
+      while y1 < 0 && row_start > 0
+        y1 += size_row(row_start - 1)
+        row_start -= 1
+      end
+
+      # Ensure that the image isn't shifted off the page at top left.
+      x1 = 0 if x1 < 0
+      y1 = 0 if y1 < 0
+
       # Calculate the absolute x offset of the top-left vertex.
       if @col_size_changed
         x_abs = (0 .. col_start-1).inject(0) {|sum, col| sum += size_col(col)}
@@ -5954,12 +5990,18 @@ def prepare_header_vml_objects(vml_header_id, vml_drawing_id)
     #
     # Set the table ids for the worksheet tables.
     #
-    def prepare_tables(table_id)
+    def prepare_tables(table_id, seen)
       if tables_count > 0
         id = table_id
         tables.each do |table|
           table.prepare(id)
 
+          if seen[table.name]
+            raise "error: invalid duplicate table name '#{table.name}' found."
+          else
+            seen[table.name] = 1
+          end
+
           # Store the link used for the rels file.
           @external_table_links << ['/table', "../tables/table#{id}.xml"]
           id += 1

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -128,6 +128,27 @@ def write_cell
       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 @@ def initialize(*args)
         @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 @@ def initialize(*args)
         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 @@ def validate_none?
       #
       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
 
@@ -136,8 +146,10 @@ def attributes
           end
         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

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -26,17 +26,19 @@ def initialize(url, str, tip)
         # 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 > 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."
         end
 
         @url       = url
         @str       = normalized_str
-        @url_str   = nil
         @tip       = tip
       end
 
@@ -127,15 +129,12 @@ def initialize(url, str, tip)
         # 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.
@@ -144,14 +143,15 @@ def initialize(url, str, tip)
 
         # 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 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."
         end
+
         @url       = url
         @str       = str
-        @url_str   = url_str
         @tip       = tip
       end
     end

data/test/chart/test_add_series.rb

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/chart'
 
-class TestAddSeries < Test::Unit::TestCase
+class TestAddSeries < Minitest::Test
   def setup
     @chart = Writexlsx::Chart.new('Bar')
   end
@@ -18,6 +18,8 @@ def test_add_series_only_values
     series.instance_variable_set(:@val_data_id, 0)
     series.instance_variable_set(:@line, { :_defined => 0 })
     series.instance_variable_set(:@fill, { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -50,6 +52,8 @@ def test_add_series_with_categories_and_values
     series.instance_variable_set(:@val_data_id, 1)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -85,6 +89,8 @@ def test_add_series_only_values_checked_by_array
     series.instance_variable_set(:@val_data_id, 0)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -116,6 +122,8 @@ def test_add_series_both_checked_by_array
     series.instance_variable_set(:@val_data_id, 1)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)
@@ -151,6 +159,8 @@ def test_add_series_secondary_axis
     series.instance_variable_set(:@val_data_id, 1)
     series.instance_variable_set(:@line          , { :_defined => 0 })
     series.instance_variable_set(:@fill          , { :_defined => 0 })
+    series.instance_variable_set(:@pattern, nil)
+    series.instance_variable_set(:@gradient, nil)
     series.instance_variable_set(:@marker, nil)
     series.instance_variable_set(:@trendline, nil)
     series.instance_variable_set(:@smooth, nil)

data/test/chart/test_process_names.rb

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/chart'
 
-class TestProcessNames < Test::Unit::TestCase
+class TestProcessNames < Minitest::Test
   def setup
     @chart = Writexlsx::Chart.new('Bar')
   end

data/test/chart/test_write_a_latin.rb

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/chart'
 
-class TestWriteALatin < Test::Unit::TestCase
+class TestWriteALatin < Minitest::Test
   def setup
     @chart = Writexlsx::Chart.new('Bar')
   end

data/test/chart/test_write_auto.rb

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/chart'
 
-class TestWriteAuto < Test::Unit::TestCase
+class TestWriteAuto < Minitest::Test
   def setup
     @chart = Writexlsx::Chart.new('Bar')
   end