write_xlsx 0.59.0 → 0.60.0

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -112,7 +112,7 @@ def escape_attributes(str = '')
       end
 
       def escape_data(str = '')
-        if str =~ /[&<>"]/
+        if str =~ /[&<>]/
           str.gsub(/&/, '&amp;').
             gsub(/</, '&lt;').
             gsub(/>/, '&gt;')

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.59.0"
+  VERSION = "0.60.0"
 end

data/lib/write_xlsx/workbook.rb

@@ -20,7 +20,8 @@ class Workbook
     attr_writer :firstsheet
     attr_reader :palette
     attr_reader :font_count, :num_format_count, :border_count, :fill_count, :custom_colors
-    attr_reader :worksheets, :sheetnames, :charts, :drawings, :num_comment_files, :named_ranges
+    attr_reader :worksheets, :sheetnames, :charts, :drawings
+    attr_reader :num_comment_files, :num_vml_files, :named_ranges
     attr_reader :doc_properties
     attr_reader :image_types, :images
     attr_reader :shared_strings
@@ -100,6 +101,7 @@ def initialize(file, default_formats = {})
       @custom_colors       = []
       @doc_properties      = {}
       @local_time          = Time.now
+      @num_vml_files       = 0
       @num_comment_files   = 0
       @optimization        = 0
       @x_window            = 240
@@ -1084,7 +1086,9 @@ def write_file_version #:nodoc:
     end
 
     def write_workbook_pr #:nodoc:
-      attributes = date_1904? ? ['date1904', 1] : []
+      attributes = []
+      attributes << 'codeName' << @vba_codename  if ptrue?(@vba_codename)
+      attributes << 'date1904' << 1              if date_1904?
       attributes << 'defaultThemeVersion' << 124226
       @writer.empty_tag('workbookPr', attributes)
     end
@@ -1207,10 +1211,14 @@ def store_workbook #:nodoc:
       # Set the active sheet.
       @worksheets[@activesheet].activate
 
-      prepare_comments      # Prepare the worksheet cell comments.
-      prepare_defined_names # Set the defined names for the worksheets such as Print Titles.
-      prepare_drawings      # Prepare the drawings, charts and images.
-      add_chart_data        # Add cached data to charts.
+      # Prepare the worksheet VML elements such as comments and buttons.
+      prepare_vml_objects
+      # Set the defined names for the worksheets such as Print Titles.
+      prepare_defined_names
+      # Prepare the drawings, charts and images.
+      prepare_drawings
+      # Add cached data to charts.
+      add_chart_data
 
       # Package the workbook.
       packager = Package::Packager.new
@@ -1458,31 +1466,33 @@ def prepare_defined_names #:nodoc:
     end
 
     #
-    # Iterate through the worksheets and set up the comment data.
+    # Iterate through the worksheets and set up the VML objects.
     #
-    def prepare_comments #:nodoc:
-      comment_id   = 0
-      vml_data_id  = 1
-      vml_shape_id = 1024
+    def prepare_vml_objects  #:nodoc:
+      comment_id    = 0
+      vml_data_id   = 1
+      vml_shape_id  = 1024
+      vml_files     = 0
+      comment_files = 0
 
       @worksheets.each do |sheet|
-        next unless sheet.has_comments?
+        next unless sheet.has_vml?
+        vml_files += 1
+        comment_files += 1 if sheet.has_comments?
 
         comment_id += 1
-        sheet.set_external_vml_links(comment_id)
-        sheet.set_external_comment_links(comment_id)
-        sheet.set_vml_data_id(vml_data_id)
-        sheet.vml_shape_id = vml_shape_id
+        count = sheet.prepare_vml_objects(vml_data_id, vml_shape_id, comment_id)
 
         # Each VML file should start with a shape id incremented by 1024.
         vml_data_id  +=    1 * ( ( 1024 + sheet.comments_count ) / 1024.0 ).to_i
         vml_shape_id += 1024 * ( ( 1024 + sheet.comments_count ) / 1024.0 ).to_i
       end
 
-      @num_comment_files = comment_id
+      @num_vml_files     = vml_files
+      @num_comment_files = comment_files
 
       # Add a font format for cell comments.
-      if comment_id > 0
+      if comment_files > 0
         format = Format.new(
             @xf_format_indices,
             @dxf_format_indices,

data/lib/write_xlsx/worksheet.rb

@@ -356,6 +356,7 @@ def orientation?
     attr_accessor :vml_shape_id, :rel_count, :hlink_refs # :nodoc:
     attr_reader :comments_author # :nodoc:
     attr_accessor :dxf_priority # :nodoc:
+    attr_reader :vba_codename # :nodoc:
 
     def initialize(workbook, index, name) #:nodoc:
       @writer = Package::XMLWriterSimple.new
@@ -421,7 +422,9 @@ def initialize(workbook, index, name) #:nodoc:
 
       @merge = []
 
+      @has_vml  = false
       @comments = Package::Comments.new(self)
+      @buttons_array          = []
 
       @validations = []
 
@@ -2102,6 +2105,8 @@ def write_comment(*args)
       check_dimensions(row, col)
       store_row_col_max_min_values(row, col)
 
+      @has_vml = true
+
       # Process the properties of the cell comment.
       @comments.add(Package::Comment.new(@workbook, self, row, col, string, options))
     end
@@ -2643,8 +2648,21 @@ def write_url(*args)
       # External links to URLs and to other Excel workbooks have slightly
       # different characteristics that we have to account for.
       if link_type == 1
-        # Substiture white space in url.
-        url = url.sub(/[\s\x00]/, '%20')
+        # 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.
         str = nil
@@ -3868,6 +3886,14 @@ def add_sparkline(param)
       @sparklines << sparkline
     end
 
+    #
+    # Insert a button form object into the worksheet.
+    #
+    def insert_button(*args)
+      @buttons_array << button_params(*(row_col_notation(args)))
+      @has_vml = 1
+    end
+
     #
     # :call-seq:
     #   data_validation(cell_or_cell_range, options)
@@ -4729,6 +4755,10 @@ def comments_count # :nodoc:
       @comments.size
     end
 
+    def has_vml?  # :nodoc:
+      @has_vml
+    end
+
     def has_comments? # :nodoc:
       !@comments.empty?
     end
@@ -4994,6 +5024,38 @@ def get_palette_color(index) #:nodoc:
       sprintf("FF%02X%02X%02X", *rgb[0, 3])
     end
 
+    def buttons_data  # :nodoc:
+      @buttons_array
+    end
+
+    #
+    # Turn the HoH that stores the comments into an array for easier handling
+    # and set the external links for comments and buttons.
+    #
+    def prepare_vml_objects(vml_data_id, vml_shape_id, comment_id)
+      @external_vml_links <<
+        [ '/vmlDrawing', "../drawings/vmlDrawing#{comment_id}.vml"]
+
+      if has_comments?
+        @comments_array = @comments.sorted_comments
+        @external_comment_links <<
+          [ '/comments', "../comments#{comment_id}.xml" ]
+      end
+
+      count         = @comments.size
+      start_data_id = vml_data_id
+
+      # The VML o:idmap data id contains a comma separated range when there is
+      # more than one 1024 block of comments, like this: data="1,2".
+      (1 .. (count / 1024)).each do |i|
+        vml_data_id = "#{vml_data_id},#{start_data_id + i}"
+      end
+      @vml_data_id = vml_data_id
+      @vml_shape_id = vml_shape_id
+
+      count
+    end
+
     private
 
     def check_for_valid_input_params(param)
@@ -5712,6 +5774,70 @@ def validate_shape(shape, index)
       end
     end
 
+    #
+    # This method handles the parameters passed to insert_button as well as
+    # calculating the comment object position and vertices.
+    #
+    def button_params(row, col, params)
+      button = { :_row => row, :_col => col }
+
+      button_number = 1 + @buttons_array.size
+
+      # Set the button caption.
+      caption = params[:caption] || "Button #{button_number}"
+
+      button[:_font] = { :_caption => caption }
+
+      # Set the macro name.
+      if params[:macro]
+        button[:_macro] = "[0]!#{params[:macro]}"
+      else
+        button[:_macro] = "[0]!Button#{button_number}_Click"
+      end
+
+      # Ensure that a width and height have been set.
+      default_width  = 64
+      default_height = 20
+      params[:width]  = default_width  if !params[:width]
+      params[:height] = default_height if !params[:height]
+
+      # Set the x/y offsets.
+      params[:x_offset] = 0 if !params[:x_offset]
+      params[:y_offset] = 0 if !params[:y_offset]
+
+      # Scale the size of the comment box if required.
+      if params[:x_scale]
+        params[:width] = params[:width] * params[:x_scale]
+      end
+      if params[:y_scale]
+        params[:height] = params[:height] * params[:y_scale]
+      end
+
+      # Round the dimensions to the nearest pixel.
+      params[:width]  = (0.5 + params[:width]).to_i
+      params[:height] = (0.5 + params[:height]).to_i
+
+      params[:start_row] = row
+      params[:start_col] = col
+
+      # Calculate the positions of comment object.
+      vertices = position_object_pixels(
+                                        params[:start_col],
+                                        params[:start_row],
+                                        params[:x_offset],
+                                        params[:y_offset],
+                                        params[:width],
+                                        params[:height]
+                                        )
+
+      # Add the width and height for VML.
+      vertices << [params[:width], params[:height]]
+
+      button[:_vertices] = vertices
+
+      button
+    end
+
     #
     # Based on the algorithm provided by Daniel Rentz of OpenOffice.
     #
@@ -5757,8 +5883,13 @@ def write_worksheet #:nodoc:
     # Write the <sheetPr> element for Sheet level properties.
     #
     def write_sheet_pr #:nodoc:
-      return if !fit_page? && !filter_on? && !tab_color? && !outline_changed?
+      if !fit_page? && !filter_on? && !tab_color? &&
+          !outline_changed? && !vba_codename?
+        return
+      end
+      codename = @vba_codename
       attributes = []
+      (attributes << 'codeName'   << codename) if codename
       (attributes << 'filterMode' << 1) if filter_on?
 
       if fit_page? || tab_color? || outline_changed?
@@ -6678,7 +6809,7 @@ def write_drawing(id) #:nodoc:
     # Write the <legacyDrawing> element.
     #
     def write_legacy_drawing #:nodoc:
-      return unless has_comments?
+      return unless @has_vml
 
       # Increment the relationship id for any drawings or comments.
       @rel_count += 1
@@ -7653,6 +7784,10 @@ def outline_changed?
       ptrue?(@outline_changed)
     end
 
+    def vba_codename?
+      ptrue?(@vba_codename)
+    end
+
     def zoom_scale_normal? #:nodoc:
       ptrue?(@zoom_scale_normal)
     end

data/test/package/vml/test_write_div.rb

@@ -6,7 +6,7 @@
 class TestWriteDiv < Test::Unit::TestCase
   def test_write_div
     vml = Writexlsx::Package::Vml.new
-    vml.__send__('write_div')
+    vml.__send__('write_div', 'left')
     result = vml.instance_variable_get(:@writer).string
     expected = '<div style="text-align:left"></div>'
     assert_equal(expected, result)

data/test/package/vml/test_write_fill.rb

@@ -4,11 +4,19 @@
 require 'write_xlsx/package/vml'
 
 class TestWriteFill < Test::Unit::TestCase
-  def test_write_fill
+  def test_write_comment_fill
     vml = Writexlsx::Package::Vml.new
-    vml.__send__('write_fill')
+    vml.__send__('write_comment_fill')
     result = vml.instance_variable_get(:@writer).string
     expected = '<v:fill color2="#ffffe1"/>'
     assert_equal(expected, result)
   end
+
+  def test_write_button_fill
+    vml = Writexlsx::Package::Vml.new
+    vml.__send__('write_button_fill')
+    result = vml.instance_variable_get(:@writer).string
+    expected = '<v:fill color2="buttonFace [67]" o:detectmouseclick="t"/>'
+    assert_equal(expected, result)
+  end
 end

data/test/package/vml/test_write_path.rb

@@ -6,7 +6,7 @@
 class TestWritePath < Test::Unit::TestCase
   def test_write_path
     vml = Writexlsx::Package::Vml.new
-    vml.__send__('write_path', 't', 'rect')
+    vml.__send__('write_comment_path', 't', 'rect')
     result = vml.instance_variable_get(:@writer).string
     expected = '<v:path gradientshapeok="t" o:connecttype="rect"/>'
     assert_equal(expected, result)
@@ -14,9 +14,17 @@ def test_write_path
 
   def test_write_path_without_gradientshapeok
     vml = Writexlsx::Package::Vml.new
-    vml.__send__('write_path', nil, 'none')
+    vml.__send__('write_comment_path', nil, 'none')
     result = vml.instance_variable_get(:@writer).string
     expected = '<v:path o:connecttype="none"/>'
     assert_equal(expected, result)
   end
+
+  def test_write_button_path
+    vml = Writexlsx::Package::Vml.new
+    vml.__send__('write_button_path')
+    result = vml.instance_variable_get(:@writer).string
+    expected = '<v:path shadowok="f" o:extrusionok="f" strokeok="f" fillok="f" o:connecttype="rect"/>'
+    assert_equal(expected, result)
+  end
 end

data/test/package/vml/test_write_shapetype.rb

@@ -6,9 +6,17 @@
 class TestWriteShapetype < Test::Unit::TestCase
   def test_write_shapetype
     vml = Writexlsx::Package::Vml.new
-    vml.__send__('write_shapetype')
+    vml.__send__('write_comment_shapetype')
     result = vml.instance_variable_get(:@writer).string
     expected = '<v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202" path="m,l,21600r21600,l21600,xe"><v:stroke joinstyle="miter"/><v:path gradientshapeok="t" o:connecttype="rect"/></v:shapetype>'
     assert_equal(expected, result)
   end
+
+  def test_write_shapetype2
+    vml = Writexlsx::Package::Vml.new
+    vml.__send__('write_button_shapetype')
+    result = vml.instance_variable_get(:@writer).string
+    expected = '<v:shapetype id="_x0000_t201" coordsize="21600,21600" o:spt="201" path="m,l,21600r21600,l21600,xe"><v:stroke joinstyle="miter"/><v:path shadowok="f" o:extrusionok="f" strokeok="f" fillok="f" o:connecttype="rect"/><o:lock v:ext="edit" shapetype="t"/></v:shapetype>'
+    assert_equal(expected, result)
+  end
 end

data/test/package/vml/test_write_textbox.rb

@@ -6,7 +6,7 @@
 class TestWriteTextbox < Test::Unit::TestCase
   def test_write_textbox
     vml = Writexlsx::Package::Vml.new
-    vml.__send__('write_textbox')
+    vml.__send__('write_comment_textbox')
     result = vml.instance_variable_get(:@writer).string
     expected = '<v:textbox style="mso-direction-alt:auto"><div style="text-align:left"></div></v:textbox>'
     assert_equal(expected, result)

data/test/regression/test_button01.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionButton01 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_button01
+    @xlsx = 'button01.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+
+    worksheet.insert_button('C2', {})
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

data/test/regression/test_button02.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionButton02 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_button02
+    @xlsx = 'button02.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+
+    worksheet.insert_button('B4',
+                            {
+                              :x_offset => 4,
+                              :y_offset => 3,
+                              :caption  => 'my text'
+                            }
+                            )
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end