write_xlsx 0.60.0 → 0.61.0

data/lib/write_xlsx/worksheet.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/package/button'
 require 'write_xlsx/colors'
 require 'write_xlsx/format'
 require 'write_xlsx/drawing'
@@ -171,6 +172,10 @@ module Writexlsx
         end
         attributes
       end
+
+      def display_url_string?
+        true
+      end
     end
 
     class NumberCellData < CellData # :nodoc:
@@ -207,6 +212,10 @@ module Writexlsx
           @worksheet.write_cell_value(token)
         end
       end
+
+      def display_url_string?
+        false
+      end
     end
 
     class FormulaCellData < CellData # :nodoc:
@@ -249,41 +258,6 @@ module Writexlsx
       end
     end
 
-    class HyperlinkCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, index, xf, link_type, url, str, tip)
-        @worksheet = worksheet
-        @row, @col, @token, @xf, @link_type, @url, @str, @tip =
-          row, col, index, xf, link_type, url, str, tip
-      end
-
-      def data
-        { :sst_id => token }
-      end
-
-      def write_cell
-        attributes = cell_attributes
-        attributes << 't' << 's'
-        @worksheet.writer.tag_elements('c', attributes) do
-          @worksheet.write_cell_value(token)
-        end
-
-        if link_type == 1
-          # External link with rel file relationship.
-          @worksheet.rel_count += 1
-          @worksheet.hlink_refs <<
-            [
-             link_type,    row,     col,
-             @worksheet.rel_count, @str, @tip
-            ]
-
-          @worksheet.external_hyper_links << [ '/hyperlink', @url, 'External' ]
-        elsif link_type
-          # External link with rel file relationship.
-          @worksheet.hlink_refs << [link_type, row, col, @url, @str, @tip ]
-        end
-      end
-    end
-
     class BlankCellData < CellData # :nodoc:
       def initialize(worksheet, row, col, index, xf)
         @worksheet = worksheet
@@ -420,6 +394,9 @@ module Writexlsx
       @outline_row_level = 0
       @outline_col_level = 0
 
+      @default_row_height     = 15
+      @default_row_rezoed     = 0
+
       @merge = []
 
       @has_vml  = false
@@ -2642,8 +2619,8 @@ module Writexlsx
       check_dimensions(row, col)
       store_row_col_max_min_values(row, col)
 
-      # Store the URL displayed text in the shared string table.
-      index = shared_string_index(str[0, STR_MAX])
+      # 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.
@@ -2665,13 +2642,13 @@ module Writexlsx
         end
 
         # Ordinary URL style external links don't have a "location" string.
-        str = nil
+        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, str = url.split(/#/)
+        url, url_str = url.split(/#/)
 
         # Add the file:/// URI to the url if non-local.
         if url =~ %r![:]! ||        # Windows style "C:/" link.
@@ -2698,7 +2675,18 @@ module Writexlsx
         raise "URL '#{url}' added but number of URLS is over Excel's limit of 65,530 URLS per worksheet."
       end
 
-      store_data_to_table(HyperlinkCellData.new(self, row, col, index, xf, link_type, url, str, tip))
+      # Write the hyperlink string.
+      write_string(row, col, str, xf)
+
+      # Store the hyperlink data in a separate structure.
+      @hyperlinks      ||= {}
+      @hyperlinks[row] ||= {}
+      @hyperlinks[row][col] = {
+        :_link_type => link_type,
+        :_url       => url,
+        :_str       => url_str,
+        :_tip       => tip
+      }
     end
 
     #
@@ -2765,7 +2753,7 @@ module Writexlsx
 
     #
     # :call-seq:
-    #   insert_chart(row, column, chart [ , x, y, scale_x, scale_y ] )
+    #   insert_chart(row, column, chart [ , x, y, x_scale, y_scale ] )
     #
     # Insert a chart into a worksheet. The chart argument should be a Chart
     # object or else it is assumed to be a filename of an external binary file.
@@ -2787,7 +2775,7 @@ module Writexlsx
     # Writexlsx::Chart for details on how to configure it. See also the
     # chart_*.rb programs in the examples directory of the distro.
     #
-    # The x, y, scale_x and scale_y parameters are optional.
+    # The x, y, x_scale and y_scale parameters are optional.
     #
     # The parameters x and y can be used to specify an offset from the top
     # left hand corner of the cell specified by row and column. The offset
@@ -2795,7 +2783,7 @@ module Writexlsx
     #
     #     worksheet1.insert_chart('E2', chart, 3, 3)
     #
-    # The parameters scale_x and scale_y can be used to scale the inserted
+    # The parameters x_scale and y_scale can be used to scale the inserted
     # image horizontally and vertically:
     #
     #     # Scale the width by 120% and the height by 150%
@@ -2803,29 +2791,35 @@ module Writexlsx
     #
     def insert_chart(*args)
       # Check for a cell reference in A1 notation and substitute row and column.
-      row, col, chart, x_offset, y_offset, scale_x, scale_y = row_col_notation(args)
+      row, col, chart, x_offset, y_offset, x_scale, y_scale = row_col_notation(args)
       raise WriteXLSXInsufficientArgumentError if [row, col, chart].include?(nil)
 
       x_offset ||= 0
       y_offset ||= 0
-      scale_x  ||= 1
-      scale_y  ||= 1
+      x_scale  ||= 1
+      y_scale  ||= 1
 
       raise "Not a Chart object in insert_chart()" unless chart.is_a?(Chart) || chart.is_a?(Chartsheet)
       raise "Not a embedded style Chart object in insert_chart()" if chart.respond_to?(:embedded) && chart.embedded == 0
 
-      @charts << [row, col, chart, x_offset, y_offset, scale_x, scale_y]
+      # Use the values set with chart.size, if any.
+      x_scale  = chart.x_scale  if chart.x_scale  != 1
+      y_scale  = chart.y_scale  if chart.y_scale  != 1
+      x_offset = chart.x_offset if ptrue?(chart.x_offset)
+      y_offset = chart.y_offset if ptrue?(chart.y_offset)
+
+      @charts << [row, col, chart, x_offset, y_offset, x_scale, y_scale]
     end
 
     #
     # :call-seq:
-    #   insert_image(row, column, filename [ , x, y, scale_x, scale_y ] )
+    #   insert_image(row, column, filename [ , x, y, x_scale, y_scale ] )
     #
     # Partially supported. Currently only works for 96 dpi images. This
     # will be fixed in an upcoming release.
     #--
     # This method can be used to insert a image into a worksheet. The image
-    # can be in PNG, JPEG or BMP format. The x, y, scale_x and scale_y
+    # can be in PNG, JPEG or BMP format. The x, y, x_scale and y_scale
     # parameters are optional.
     #
     #     worksheet1.insert_image('A1', 'ruby.bmp')
@@ -2842,7 +2836,7 @@ module Writexlsx
     # cell. This can be occasionally useful if you wish to align two or more
     # images relative to the same cell.
     #
-    # The parameters scale_x and scale_y can be used to scale the inserted
+    # The parameters x_scale and y_scale can be used to scale the inserted
     # image horizontally and vertically:
     #
     #     # Scale the inserted image: width x 2.0, height x 0.8
@@ -2864,15 +2858,15 @@ module Writexlsx
     #
     def insert_image(*args)
       # Check for a cell reference in A1 notation and substitute row and column.
-      row, col, image, x_offset, y_offset, scale_x, scale_y = row_col_notation(args)
+      row, col, image, x_offset, y_offset, x_scale, y_scale = row_col_notation(args)
       raise WriteXLSXInsufficientArgumentError if [row, col, image].include?(nil)
 
       x_offset ||= 0
       y_offset ||= 0
-      scale_x  ||= 1
-      scale_y  ||= 1
+      x_scale  ||= 1
+      y_scale  ||= 1
 
-      @images << [row, col, image, x_offset, y_offset, scale_x, scale_y]
+      @images << [row, col, image, x_offset, y_offset, x_scale, y_scale]
     end
 
     #
@@ -2985,7 +2979,7 @@ module Writexlsx
     #
     def set_row(*args)
       row = args[0]
-      height = args[1] || 15
+      height = args[1] || @default_height
       xf     = args[2]
       hidden = args[3] || 0
       level  = args[4] || 0
@@ -2993,6 +2987,9 @@ module Writexlsx
 
       return if row.nil?
 
+      # Get the default row height.
+      default_height = @default_row_height
+
       # Use min col in check_dimensions. Default to 0 if undefined.
       min_col = @dim_colmin || 0
 
@@ -3000,10 +2997,12 @@ module Writexlsx
       check_dimensions(row, min_col)
       store_row_col_max_min_values(row, min_col)
 
+      height ||= default_height
+
       # If the height is 0 the row is hidden and the height is the default.
       if height == 0
         hidden = 1
-        height = 15
+        height = default_height
       end
 
       # Set the limits for the outline levels (0 <= x <= 7).
@@ -3022,6 +3021,25 @@ module Writexlsx
       @row_sizes[row] = height
     end
 
+    #
+    # Set the default row properties
+    #
+    def set_default_row(height = nil, zero_height = nil)
+      height      ||= 15
+      zero_height ||= 0
+
+      if height != 15
+        @default_row_height = height
+
+        # Store the row change to allow optimisations.
+        @row_size_changed = 1
+      end
+
+      if ptrue?(zero_height)
+        @default_row_zeroed = 1
+      end
+    end
+
     #
     # merge_range(first_row, first_col, last_row, last_col, string, format)
     #
@@ -3822,7 +3840,7 @@ module Writexlsx
       sparkline[:_ranges].collect! do |range|
         # Remove the absolute reference $ symbols.
         range = range.gsub(/\$/, '')
-        # Convert a simiple range into a full Sheet1!A1:D1 range.
+        # Convert a simple range into a full Sheet1!A1:D1 range.
         range = "#{sheetname}!#{range}" unless range =~ /!/
         range
       end
@@ -4767,24 +4785,6 @@ module Writexlsx
       !!@is_chartsheet
     end
 
-    #
-    # Turn the HoH that stores the comments into an array for easier handling
-    # and set the external links.
-    #
-    def set_vml_data_id(vml_data_id) # :nodoc:
-      count = @comments.sorted_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
-
-      count
-    end
-
     def set_external_vml_links(comment_id) # :nodoc:
       @external_vml_links <<
         ['/vmlDrawing', "../drawings/vmlDrawing#{comment_id}.vml"]
@@ -4801,15 +4801,19 @@ module Writexlsx
     def prepare_chart(index, chart_id, drawing_id) # :nodoc:
       drawing_type = 1
 
-      row, col, chart, x_offset, y_offset, scale_x, scale_y  = @charts[index]
+      row, col, chart, x_offset, y_offset, x_scale, y_scale  = @charts[index]
       chart.id = chart_id - 1
-      scale_x ||= 0
-      scale_y ||= 0
+      x_scale ||= 0
+      y_scale ||= 0
 
-      width  = (0.5 + (480 * scale_x)).to_i
-      height = (0.5 + (288 * scale_y)).to_i
+      # Use user specified dimensions, if any.
+      width  = chart.width  if ptrue?(chart.width)
+      height = chart.height if ptrue?(chart.height)
 
-      dimensions = position_object_emus(col, row, x_offset, y_offset, width, height)
+      width  = (0.5 + (width  * x_scale)).to_i
+      height = (0.5 + (height * y_scale)).to_i
+
+      dimensions = position_object_emus(col, row, x_offset, y_offset, width, height, false)
 
       # Set the chart name for the embedded object if it has been specified.
       name = chart.name
@@ -5409,8 +5413,7 @@ module Writexlsx
     # The vertices are expressed as English Metric Units (EMUs). There are 12,700
     # EMUs per point. Therefore, 12,700 * 3 /4 = 9,525 EMUs per pixel.
     #
-    def position_object_emus(col_start, row_start, x1, y1, width, height) #:nodoc:
-      is_drawing = true
+    def position_object_emus(col_start, row_start, x1, y1, width, height, is_drawing = true) #:nodoc:
       col_start, row_start, x1, y1, col_end, row_end, x2, y2, x_abs, y_abs =
         position_object_pixels(col_start, row_start, x1, y1, width, height, is_drawing)
 
@@ -5506,7 +5509,7 @@ module Writexlsx
           pixels = (4 / 3.0 * height).to_i
         end
       else
-        pixels = 20
+        pixels = (4 / 3.0 * @default_row_height).to_i
       end
       pixels
     end
@@ -5518,10 +5521,10 @@ module Writexlsx
       drawing_type = 2
       drawing
 
-      row, col, image, x_offset, y_offset, scale_x, scale_y = @images[index]
+      row, col, image, x_offset, y_offset, x_scale, y_scale = @images[index]
 
-      width  *= scale_x
-      height *= scale_y
+      width  *= x_scale
+      height *= y_scale
 
       dimensions = position_object_emus(col, row, x_offset, y_offset, width, height)
 
@@ -5565,7 +5568,7 @@ module Writexlsx
     # See add_shape() for details on how to create the Shape object
     # and Excel::Writer::XLSX::Shape for details on how to configure it.
     #
-    # The x, y, scale_x and scale_y parameters are optional.
+    # The x, y, x_scale and y_scale parameters are optional.
     #
     # The parameters x and y can be used to specify an offset
     # from the top left hand corner of the cell specified by row and col.
@@ -5573,7 +5576,7 @@ module Writexlsx
     #
     #   worksheet1.insert_shape('E2', chart, 3, 3)
     #
-    # The parameters scale_x and scale_y can be used to scale the
+    # The parameters x_scale and y_scale can be used to scale the
     # inserted shape horizontally and vertically:
     #
     #   # Scale the width by 120% and the height by 150%
@@ -5582,7 +5585,7 @@ module Writexlsx
     #
     def insert_shape(*args)
       # Check for a cell reference in A1 notation and substitute row and column.
-      row_start, column_start, shape, x_offset, y_offset, scale_x, scale_y =
+      row_start, column_start, shape, x_offset, y_offset, x_scale, y_scale =
         row_col_notation(args)
       if [row_start, column_start, shape].include?(nil)
         raise "Insufficient arguments in insert_shape()"
@@ -5596,8 +5599,8 @@ module Writexlsx
 
       # Override shape scale if supplied as an argument. Otherwise, use the
       # existing shape scale factors.
-      shape[:scale_x] = scale_x if scale_x
-      shape[:scale_y] = scale_y if scale_y
+      shape[:scale_x] = x_scale if x_scale
+      shape[:scale_y] = y_scale if y_scale
 
       # Assign a shape ID.
       while true
@@ -5779,20 +5782,20 @@ module Writexlsx
     # calculating the comment object position and vertices.
     #
     def button_params(row, col, params)
-      button = { :_row => row, :_col => col }
+      button = Writexlsx::Package::Button.new
 
       button_number = 1 + @buttons_array.size
 
       # Set the button caption.
       caption = params[:caption] || "Button #{button_number}"
 
-      button[:_font] = { :_caption => caption }
+      button.font = { :_caption => caption }
 
       # Set the macro name.
       if params[:macro]
-        button[:_macro] = "[0]!#{params[:macro]}"
+        button.macro = "[0]!#{params[:macro]}"
       else
-        button[:_macro] = "[0]!Button#{button_number}_Click"
+        button.macro = "[0]!Button#{button_number}_Click"
       end
 
       # Ensure that a width and height have been set.
@@ -5833,7 +5836,7 @@ module Writexlsx
       # Add the width and height for VML.
       vertices << [params[:width], params[:height]]
 
-      button[:_vertices] = vertices
+      button.vertices = vertices
 
       button
     end
@@ -6015,9 +6018,16 @@ module Writexlsx
     #
     def write_sheet_format_pr #:nodoc:
       base_col_width     = 10
-      default_row_height = 15
 
-      attributes = ['defaultRowHeight', default_row_height]
+      attributes = ['defaultRowHeight', @default_row_height]
+      if @default_row_height != 15
+        attributes << 'customHeight' << 1
+      end
+
+      if ptrue?(@default_row_zeroed)
+        attributes << 'zeroHeight' << 1
+      end
+
       attributes << 'outlineLevelRow' << @outline_row_level if @outline_row_level > 0
       attributes << 'outlineLevelCol' << @outline_col_level if @outline_col_level > 0
       if @excel_version == 2010
@@ -6120,7 +6130,7 @@ module Writexlsx
           write_empty_row(row_num, span, *(@set_rows[row_num]))
         else
           # Row attributes only.
-          write_empty_row(row_num, nil, *(@set_rows[row_num]))
+          write_empty_row(row_num, span, *(@set_rows[row_num]))
         end
       end
     end
@@ -6172,8 +6182,8 @@ module Writexlsx
     #
     # Write the <row> element.
     #
-    def write_row_element(r, spans = nil, height = 15, format = nil, hidden = false, level = 0, collapsed = false, empty_row = false) #:nodoc:
-      height    ||= 15
+    def write_row_element(r, spans = nil, height = nil, format = nil, hidden = false, level = 0, collapsed = false, empty_row = false) #:nodoc:
+      height    ||= @default_row_height
       hidden    ||= 0
       level     ||= 0
       collapsed ||= 0
@@ -6182,14 +6192,14 @@ module Writexlsx
 
       attributes = ['r',  r + 1]
 
-      (attributes << 'spans'        << spans) if spans
-      (attributes << 's'            << xf_index) if xf_index != 0
-      (attributes << 'customFormat' << 1    ) if format
-      (attributes << 'ht'           << height) if height != 15
-      (attributes << 'hidden'       << 1    ) if ptrue?(hidden)
-      (attributes << 'customHeight' << 1    ) if height != 15
-      (attributes << 'outlineLevel' << level) if ptrue?(level)
-      (attributes << 'collapsed'    << 1    ) if ptrue?(collapsed)
+      (attributes << 'spans'        << spans)    if spans
+      (attributes << 's'            << xf_index) if ptrue?(xf_index)
+      (attributes << 'customFormat' << 1    )    if ptrue?(format)
+      (attributes << 'ht'           << height)   if height != 15
+      (attributes << 'hidden'       << 1    )    if ptrue?(hidden)
+      (attributes << 'customHeight' << 1    )    if height != 15
+      (attributes << 'outlineLevel' << level)    if ptrue?(level)
+      (attributes << 'collapsed'    << 1    )    if ptrue?(collapsed)
 
       if @excel_version == 2010
         attributes << 'x14ac:dyDescent' << '0.25'
@@ -6679,12 +6689,64 @@ module Writexlsx
     end
 
     #
-    # Write the <hyperlinks> element. The attributes are different for internal
-    # and external links.
+    # Process any sored hyperlinks in row/col order and write the <hyperlinks>
+    # element. The attributes are different for internal and external links.
     #
     def write_hyperlinks #:nodoc:
+      return unless @hyperlinks
+
+      # Sort the hyperlinks into row order.
+      row_nums = @hyperlinks.keys.sort
+
+      # Exit if there are no hyperlinks to process.
+      return if row_nums.empty?
+
+      # Iterate over the rows.
+      row_nums.each do |row_num|
+        # Sort the hyperlinks into column order.
+        col_nums = @hyperlinks[row_num].keys.sort
+        # Iterate over the columns.
+        col_nums.each do |col_num|
+          # Get the link data for this cell.
+          link      = @hyperlinks[row_num][col_num]
+          link_type = link[:_link_type]
+
+          # If the cell isn't a string then we have to add the url as
+          # the string to display
+          if  ptrue?(@cell_data_table)          &&
+              ptrue?(@cell_data_table[row_num]) &&
+              ptrue?(@cell_data_table[row_num][col_num])
+            if @cell_data_table[row_num][col_num].display_url_string?
+              display = link[:_url]
+            else
+              display = nil
+            end
+          end
+
+          if link_type == 1
+            # External link with rel file relationship.
+            @rel_count += 1
+            @hlink_refs << [
+                            link_type, row_num, col_num,
+                            @rel_count, link[:_str], display, link[:_tip]
+                           ]
+            # Links for use by the packager.
+            @external_hyper_links << [
+                                      '/hyperlink', link[:_url], 'External'
+                                     ]
+          else
+            # Internal link with rel file relationship.
+            @hlink_refs << [
+                            link_type, row_num, col_num,
+                            link[:_url], link[:_str], link[:_tip]
+                           ]
+          end
+        end
+      end
+
       return if @hlink_refs.empty?
 
+      # Write the hyperlink elements.
       @writer.tag_elements('hyperlinks') do
         @hlink_refs.each do |aref|
           type, *args = aref
@@ -6701,13 +6763,14 @@ module Writexlsx
     #
     # Write the <hyperlink> element for external links.
     #
-    def write_hyperlink_external(row, col, id, location = nil, tooltip = nil) #:nodoc:
+    def write_hyperlink_external(row, col, id, location = nil, display = nil, tooltip = nil) #:nodoc:
       ref = xl_rowcol_to_cell(row, col)
       r_id = "rId#{id}"
 
       attributes = ['ref', ref, 'r:id', r_id]
 
       attributes << 'location' << location  if location
+      attributes << 'display'  << display   if display
       attributes << 'tooltip'  << tooltip   if tooltip
 
       @writer.empty_tag('hyperlink', attributes)
@@ -7712,8 +7775,8 @@ module Writexlsx
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
     #
-    def shared_string_index(str) #:nodoc:
-      @workbook.shared_string_index(str)
+    def shared_string_index(str, params = {}) #:nodoc:
+      @workbook.shared_string_index(str, params)
     end
 
     #

data/test/drawing/test_write_row.rb

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/drawing'
 
-class TestWriteRow < Test::Unit::TestCase
+class TestDrawingWriteRow < Test::Unit::TestCase
   def setup
     @drawing = Writexlsx::Drawing.new
   end

data/test/regression/test_chart_size01.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartSize01 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_size01
+    @xlsx = 'chart_size01.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [61355904, 61365248])
+
+    data = [
+            [1, 2, 3,  4,  5],
+            [2, 4, 6,  8, 10],
+            [3, 6, 9, 12, 15]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(:values => '=Sheet1!$A$1:$A$5')
+    chart.add_series(:values => '=Sheet1!$B$1:$B$5')
+    chart.add_series(:values => '=Sheet1!$C$1:$C$5')
+
+    chart.size(:width => 512, :height => 320)
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end