write_xlsx 0.65.1 → 0.69.0

data/lib/write_xlsx/worksheet.rb

@@ -790,7 +790,7 @@ def set_selection(*args)
         if row_first == row_last && col_first == col_last
           sqref = active_cell
         else
-          sqref = xl_range(row_first, col_first, row_last, col_last)
+          sqref = xl_range(row_first, row_last, col_first, col_last)
         end
       end
 
@@ -5463,10 +5463,6 @@ def set_comments_author(author)
       self.comments_author = author
     end
 
-    def comments_count # :nodoc:
-      @comments.size
-    end
-
     def has_vml?  # :nodoc:
       @has_vml
     end
@@ -5475,13 +5471,17 @@ def has_comments? # :nodoc:
       !@comments.empty?
     end
 
+    def has_shapes?
+      @has_shapes
+    end
+
     def is_chartsheet? # :nodoc:
       !!@is_chartsheet
     end
 
-    def set_external_vml_links(comment_id) # :nodoc:
+    def set_external_vml_links(vml_drawing_id) # :nodoc:
       @external_vml_links <<
-        ['/vmlDrawing', "../drawings/vmlDrawing#{comment_id}.vml"]
+        ['/vmlDrawing', "../drawings/vmlDrawing#{vml_drawing_id}.vml"]
     end
 
     def set_external_comment_links(comment_id) # :nodoc:
@@ -5662,7 +5662,7 @@ def comments_visible? # :nodoc:
       !!@comments_visible
     end
 
-    def comments_array # :nodoc:
+    def sorted_comments # :nodoc:
       @comments.sorted_comments
     end
 
@@ -5734,28 +5734,21 @@ def drawing_links
     # 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
+    def prepare_vml_objects(vml_data_id, vml_shape_id, vml_drawing_id, comment_id)
+      set_external_vml_links(vml_drawing_id)
+      set_external_comment_links(comment_id) if has_comments?
 
       # 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}"
+      (1 .. num_comments_block).each do |i|
+        vml_data_id = "#{vml_data_id},#{vml_data_id + i}"
       end
       @vml_data_id = vml_data_id
       @vml_shape_id = vml_shape_id
+    end
 
-      count
+    def num_comments_block
+      @comments.size / 1024
     end
 
     def tables_count
@@ -6244,6 +6237,7 @@ def prepare_shape(index, drawing_id)
         @drawing = Drawing.new
         @drawing.embedded = 1
         @external_drawing_links << ['/drawing', "../drawings/drawing#{drawing_id}.xml"]
+        @has_shapes = true
       end
 
       # Validate the he shape against various rules.
@@ -6593,14 +6587,10 @@ def write_rows #:nodoc:
 
         # Write the cells if the row contains data.
         if @cell_data_table[row_num]
-          if !@set_rows[row_num]
-            write_row_element(row_num, span)
-          else
-            write_row_element(row_num, span, *(@set_rows[row_num]))
+          args = @set_rows[row_num] || []
+          write_row_element(row_num, span, *args) do
+            write_cell_column_dimension(row_num)
           end
-
-          write_cell_column_dimension(row_num)
-          @writer.end_tag('row')
         elsif @comments[row_num]
           write_empty_row(row_num, span, *(@set_rows[row_num]))
         else
@@ -6610,40 +6600,6 @@ def write_rows #:nodoc:
       end
     end
 
-    #
-    # Write out the worksheet data as a single row with cells. This method is
-    # used when memory optimisation is on. A single row is written and the data
-    # table is reset. That way only one row of data is kept in memory at any one
-    # time. We don't write span data in the optimised case since it is optional.
-    #
-    def write_single_row(current_row = 0) #:nodoc:
-      row_num     = @previous_row
-
-      # Set the new previous row as the current row.
-      @previous_row = current_row
-
-      # Skip row if it doesn't contain row formatting, cell data or a comment.
-      return not_contain_formatting_or_data?(row_num)
-
-      # Write the cells if the row contains data.
-      if @cell_data_table[row_num]
-        if !@set_rows[row_num]
-          write_row(row_num)
-        else
-          write_row(row_num, nil, @set_rows[row_num])
-        end
-
-        write_cell_column_dimension(row_num)
-        @writer.end_tag('row')
-      else
-        # Row attributes or comments only.
-        write_empty_row(row_num, nil, @set_rows[row_num])
-      end
-
-      # Reset table.
-      @cell_data_table = {}
-    end
-
     def not_contain_formatting_or_data?(row_num) # :nodoc:
       !@set_rows[row_num] && !@cell_data_table[row_num] && !@comments.has_comment_in_row?(row_num)
     end
@@ -6657,12 +6613,24 @@ def write_cell_column_dimension(row_num)  # :nodoc:
     #
     # Write the <row> element.
     #
-    def write_row_element(r, spans = nil, height = nil, format = nil, hidden = false, level = 0, collapsed = false, empty_row = false) #:nodoc:
+    def write_row_element(*args)  # :nodoc:
+      @writer.tag_elements('row', row_attributes(args)) do
+        yield
+      end
+    end
+
+    #
+    # Write and empty <row> element, i.e., attributes only, no cell data.
+    #
+    def write_empty_row(*args) #:nodoc:
+      @writer.empty_tag('row', row_attributes(args))
+    end
+
+    def row_attributes(args)
+      r, spans, height, format, hidden, level, collapsed, empty_row = args
       height    ||= @default_row_height
       hidden    ||= 0
       level     ||= 0
-      collapsed ||= 0
-      empty_row ||= 0
       xf_index = format ? format.get_xf_index : 0
 
       attributes = ['r',  r + 1]
@@ -6679,20 +6647,7 @@ def write_row_element(r, spans = nil, height = nil, format = nil, hidden = false
       if @excel_version == 2010
         attributes << 'x14ac:dyDescent' << '0.25'
       end
-      if ptrue?(empty_row)
-        @writer.empty_tag('row', attributes)
-      else
-        @writer.start_tag('row', attributes)
-      end
-    end
-
-    #
-    # Write and empty <row> element, i.e., attributes only, no cell data.
-    #
-    def write_empty_row(*args) #:nodoc:
-        new_args = args.dup
-        new_args[7] = 1
-        write_row_element(*new_args)
+      attributes
     end
 
     #
@@ -7148,10 +7103,9 @@ def write_tab_color #:nodoc:
     # Write the <outlinePr> element.
     #
     def write_outline_pr
-      attributes = []
-
       return unless outline_changed?
 
+      attributes = []
       attributes << "applyStyles"  << 1 if @outline_style != 0
       attributes << "summaryBelow" << 0 if @outline_below == 0
       attributes << "summaryRight" << 0 if @outline_right == 0
@@ -7228,7 +7182,7 @@ def write_table_parts
     # Write the <tablePart> element.
     #
     def write_table_part(id)
-      @writer.empty_tag('tablePart', ['r:id', "rId#{id}"])
+      @writer.empty_tag('tablePart', r_id_attributes(id))
     end
 
     def increment_rel_id_and_write_r_id(tag)
@@ -7237,7 +7191,7 @@ def increment_rel_id_and_write_r_id(tag)
     end
 
     def write_r_id(tag, id)
-      @writer.empty_tag(tag, ['r:id', "rId#{id}"])
+      @writer.empty_tag(tag, r_id_attributes(id))
     end
 
     #

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -90,7 +90,8 @@ def initialize(url, str = nil)
       def write_external_attributes(row, col, id)
         ref = xl_rowcol_to_cell(row, col)
 
-        attributes = ['ref', ref, 'r:id', "rId#{id}"]
+        attributes = ['ref', ref]
+        attributes += r_id_attributes(id)
 
         attributes << 'location' << url_str if url_str
         attributes << 'display'  << display if display

data/test/drawing/test_write_c_chart.rb

@@ -10,7 +10,7 @@ def setup
   def test_write_c_chart
     expected = '<c:chart xmlns:c="http://schemas.openxmlformats.org/drawingml/2006/chart" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" r:id="rId1"/>'
 
-    @drawing.__send__(:write_c_chart, 'rId1')
+    @drawing.__send__(:write_c_chart, 1)
     result = @drawing.instance_variable_get(:@writer).string
 
     assert_equal(expected, result)

data/test/package/table/test_table13.rb

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx'
+require 'stringio'
+
+class TestTable13 < Test::Unit::TestCase
+  def setup
+    workbook = WriteXLSX.new(StringIO.new)
+    @worksheet = workbook.add_worksheet
+  end
+
+  def test_table13_add_table_should_not_change_style_string
+    style = 'Table Style Light 17'
+    # Set the table properties.
+    @worksheet.add_table('D4:I15', :style => style)
+
+    # add_table should not change style string.
+    assert_equal('Table Style Light 17', style)
+  end
+
+  def test_table13_add_table_should_not_change_formula_string
+    formula = '=SUM(Table1[@[Column1]:[Column3]])'
+    @worksheet.add_table(
+                         'C2:F14',
+                         {
+                           :total_row => 1,
+                           :columns   => [
+                                          {:total_string => 'Total'},
+                                          {},
+                                          {},
+                                          {
+                                            :total_function => 'count',
+                                            :format         => @format,
+                                            :formula        => formula
+                                          }
+                                         ]
+                         }
+                         )
+
+    # add_table should not change style string.
+    assert_equal('=SUM(Table1[@[Column1]:[Column3]])', formula)
+  end
+
+  def test_table13_add_table_should_not_change_total_function_string
+    total_function = 'std Dev'
+    # Set the table properties.
+
+    @worksheet.add_table(
+                         'B2:K8',
+                         {
+                           :total_row => 1,
+                           :columns => [
+                                        {:total_string => 'Total'},
+                                        {},
+                                        {:total_function => 'Average'},
+                                        {:total_function => 'COUNT'},
+                                        {:total_function => 'count_nums'},
+                                        {:total_function => 'max'},
+                                        {:total_function => 'min'},
+                                        {:total_function => 'sum'},
+                                        {:total_function => total_function},
+                                        {:total_function => 'var'}
+                                       ]
+                         }
+                         )
+    # add_table should not change total_function string.
+    assert_equal('std Dev', total_function)
+  end
+end

data/test/regression/test_button08.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionButton08 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_button08
+    @xlsx = 'button08.xlsx'
+    workbook   = WriteXLSX.new(@xlsx)
+    worksheet1 = workbook.add_worksheet
+    worksheet2 = workbook.add_worksheet
+
+    worksheet1.insert_button('C2', {})
+
+    worksheet2.write_comment('A1', 'Foo')
+
+    worksheet2.comments_author = 'John'
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

data/test/regression/test_chart_axis25.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartAxis25 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_axis25
+    @xlsx = 'chart_axis25.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, [47471232, 48509696])
+    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.set_x_axis(:num_format => '[$¥-411]#,##0.00')
+    chart.set_y_axis(:num_format => '0.00%')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx),
+                                @xlsx,
+                                nil,
+                                { 'xl/charts/chart1.xml' => ['<c:pageMargins'] }
+                                )
+  end
+end

data/test/regression/test_chart_axis26.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartAxis26 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_axis26
+    @xlsx = 'chart_axis26.xlsx'
+    workbook    = WriteXLSX.new(@xlsx)
+    worksheet   = workbook.add_worksheet
+    chart       = workbook.add_chart(:type => 'line', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [73048448, 73049984])
+
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    chart.set_x_axis(:num_font => {:rotation => 45})
+
+    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')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx),
+                                @xlsx,
+                                nil,
+                                { 'xl/charts/chart1.xml' => ['<a:defRPr'] }
+                                )
+  end
+end

data/test/regression/test_chart_axis27.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartAxis27 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_axis27
+    @xlsx = 'chart_axis27.xlsx'
+    workbook    = WriteXLSX.new(@xlsx)
+    worksheet   = workbook.add_worksheet
+    chart       = workbook.add_chart(:type => 'line', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [73048448, 73049984])
+
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    chart.set_x_axis(:num_font => {:rotation => -35})
+
+    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')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx),
+                                @xlsx,
+                                nil,
+                                { 'xl/charts/chart1.xml' => ['<a:defRPr'] }
+                                )
+  end
+end