write_xlsx 1.04.0 → 1.07.0

data/lib/write_xlsx/chart/series.rb

@@ -296,10 +296,110 @@ def labels_properties(labels) # :nodoc:
           labels[:separator] = separators[separator]
         end
 
+
+        # Set the line properties for the data labels.
+        line = line_properties( labels[:line] )
+
+        # Allow 'border' as a synonym for 'line'.
+        if labels[:border]
+          line = line_properties(labels[:border])
+        end
+
+        # Set the fill properties for the labels.
+        fill = fill_properties(labels[:fill])
+
+        # Set the pattern properties for the labels.
+        pattern = pattern_properties(labels[:pattern])
+
+        # Set the gradient fill properties for the labels.
+        gradient = gradient_properties(labels[:gradient])
+
+        # Pattern fill overrides solid fill.
+        if pattern
+          fill = nil
+        end
+
+        # Gradient fill overrides solid and pattern fills.
+        if gradient
+          pattern = nil
+          fill    = nil
+        end
+
+        labels[:line]     = line
+        labels[:fill]     = fill
+        labels[:pattern]  = pattern
+        labels[:gradient] = gradient
+
         if labels[:font]
           labels[:font] = convert_font_args(labels[:font])
         end
 
+        if labels[:custom]
+          # Duplicate, and modify, the custom label properties.
+          custom = []
+
+          labels[:custom].each do |label|
+            if !label
+              custom << nil
+              next
+            end
+
+            property = label.dup
+
+            # Convert formula.
+            if property[:value] && property[:value] =~ /^=[^!]+!\$/
+              property[:formula] = property[:value]
+            end
+
+            if property[:formula]
+              property[:formula] = property[:formula].sub(/^=/, '')
+
+              data_id = @chart.data_id(property[:formula], property[:data])
+              property[:data_id] = data_id
+            end
+
+            if property[:font]
+              property[:font] = convert_font_args(property[:font])
+            end
+
+            # Allow 'border' as a synonym for 'line'.
+            if property[:border]
+              line = line_properties(property[:border])
+            else
+              # Set the line properties for the data labels.
+              line = line_properties(property[:line])
+            end
+
+            # Set the fill properties for the labels.
+            fill = fill_properties(property[:fill])
+
+            # Set the pattern properties for the labels.
+            pattern = pattern_properties(property[:pattern])
+
+            # Set the gradient fill properties for the labels.
+            gradient = gradient_properties(property[:gradient])
+
+            # Pattern fill overrides solid fill.
+            if pattern
+              fill = nil
+            end
+
+            # Gradient fill overrides solid and pattern fills.
+            if gradient
+              pattern = nil
+              fill    = nil
+            end
+
+            property[:line]     = line
+            property[:fill]     = fill
+            property[:pattern]  = pattern
+            property[:gradient] = gradient
+
+            custom << property
+          end
+          labels[:custom] = custom
+        end
+
         labels
       end
     end

data/lib/write_xlsx/utility.rb

@@ -804,9 +804,9 @@ def params_to_font(params)
     #
     # Write the <c:txPr> element.
     #
-    def write_tx_pr(is_y_axis, font) # :nodoc:
+    def write_tx_pr(font, is_y_axis = nil) # :nodoc:
       rotation = nil
-      if font && font[:_rotation]
+      if font && font.respond_to?(:[]) && font[:_rotation]
         rotation = font[:_rotation]
       end
       @writer.tag_elements('c:txPr') do
@@ -903,6 +903,7 @@ def write_def_rpr_r_pr_common(font, style_attributes, tag)  # :nodoc:
     #
     def get_font_latin_attributes(font)
       return [] unless font
+      return [] unless font.respond_to?(:[])
 
       attributes = []
       attributes << ['typeface', font[:_name]]            if ptrue?(font[:_name])
@@ -959,6 +960,7 @@ def color(color_code) # :nodoc:
     #
     def get_font_style_attributes(font)
       return [] unless font
+      return [] unless font.respond_to?(:[])
 
       attributes = []
       attributes << ['sz', font[:_size]]      if ptrue?(font[:_size])

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "1.04.0"
+WriteXLSX_VERSION = "1.07.0"

data/lib/write_xlsx/worksheet.rb

@@ -2514,7 +2514,9 @@ def write_array_formula(*args)
       col1, col2 = col2, col1 if col1 > col2
 
       # Check that row and col are valid and store max and min values
+      check_dimensions(row1, col1)
       check_dimensions(row2, col2)
+      store_row_col_max_min_values(row1, col1)
       store_row_col_max_min_values(row2, col2)
 
       # Define array range
@@ -3363,9 +3365,11 @@ def merge_range(*args)
       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
 
-      # Check that column number is valid and store the max value
-      check_dimensions(row_last, col_last)
-      store_row_col_max_min_values(row_last, col_last)
+      # Check that the data range is valid and store the max and min values.
+      check_dimensions(row_first, col_first)
+      check_dimensions(row_last,  col_last)
+      store_row_col_max_min_values(row_first, col_first)
+      store_row_col_max_min_values(row_last,  col_last)
 
       # Store the merge range.
       @merge << [row_first, col_first, row_last, col_last]
@@ -3428,9 +3432,11 @@ def merge_range_type(type, *args)
       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
 
-      # Check that column number is valid and store the max value
-      check_dimensions(row_last, col_last)
-      store_row_col_max_min_values(row_last, col_last)
+      # Check that the data range is valid and store the max and min values.
+      check_dimensions(row_first, col_first)
+      check_dimensions(row_last,  col_last)
+      store_row_col_max_min_values(row_first, col_first)
+      store_row_col_max_min_values(row_last,  col_last)
 
       # Store the merge range.
       @merge << [row_first, col_first, row_last, col_last]

data/test/regression/test_array_formula04.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionArrayFormula04 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_array_formula04
+    @xlsx = 'array_formula04.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    worksheet.write_array_formula(
+      'A1:A3',
+      '{=SUM(B1:C1*B2:C2)}',
+      nil,
+      0
+    )
+
+    workbook.close
+    compare_for_regression(
+      [ 'xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels' ],
+      {'xl/workbook.xml' => ['<workbookView']}
+    )
+  end
+end

data/test/regression/test_chart_data_labels26.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels26 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_data_labels26
+    @xlsx = 'chart_data_labels26.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [48514944, 48516480])
+
+    data = [
+      [ 1,  2,  3,  4,  5],
+      [ 2,  4,  6,  8, 10],
+      [ 3,  6,  9, 12, 15],
+      [10, 20, 30, 40, 50]
+    ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(
+      :values      => '=Sheet1!$A$1:$A$5',
+      :data_labels => {:value    => 1, :custom => [{:value => 33}]}
+    )
+
+    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_for_regression
+  end
+end

data/test/regression/test_chart_data_labels27.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels27 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_data_labels27
+    @xlsx = 'chart_data_labels27.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [48514944, 48516480])
+
+    data = [
+      [ 1,  2,  3,  4,  5],
+      [ 2,  4,  6,  8, 10],
+      [ 3,  6,  9, 12, 15],
+      [10, 20, 30, 40, 50]
+    ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(
+      :values      => '=Sheet1!$A$1:$A$5',
+      :data_labels => {:value    => 1, :custom => [{:value => '=Sheet1!$D$1'}]}
+    )
+
+    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_for_regression
+  end
+end

data/test/regression/test_chart_data_labels28.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels28 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_data_labels28
+    @xlsx = 'chart_data_labels28.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [48514944, 48516480])
+
+    data = [
+      [ 1,  2,  3,  4,  5],
+      [ 2,  4,  6,  8, 10],
+      [ 3,  6,  9, 12, 15],
+      ['foo', 'bar']
+    ]
+
+    worksheet.write('A1', data)
+
+    custom = [
+      {:value => 123},
+      {:value => 'abc'},
+      nil,
+      {:formula => 'Sheet1!$D$1'},
+      {:formula => 'Sheet1!$D$2'}
+    ]
+
+    chart.add_series(
+      :values      => '=Sheet1!$A$1:$A$5',
+      :data_labels => {:value    => 1, :custom => custom }
+    )
+
+    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_for_regression
+  end
+end

data/test/regression/test_chart_data_labels29.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels29 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_data_labels29
+    @xlsx = 'chart_data_labels29.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [67858816, 67863296])
+
+    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',
+      :data_labels => {:value    => 1, :custom => [{:delete => 1}] }
+    )
+
+    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_for_regression
+  end
+end

data/test/regression/test_chart_data_labels30.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels30 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_data_labels30
+    @xlsx = 'chart_data_labels30.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [67858816, 67863296])
+
+    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',
+      :data_labels => {
+        :value    => 1,
+        :custom => [{:delete => 1}, nil, {:delete => 1}, nil, {:delete => 1}]
+      }
+    )
+
+    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_for_regression
+  end
+end