write_xlsx 0.72.3.beta1 → 0.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d6e30ec99cbb2730ee191dc212d2c30806486f1
-  data.tar.gz: d67dbc2cc225f0cb7dde96feebaf39600a718039
+  metadata.gz: bd7c9924a9f5ccf9b80207b867a7bff175bc382a
+  data.tar.gz: bb3b383fc98310774db112b3a3452d4b41bfab40
 SHA512:
-  metadata.gz: d78099249c92fdc5f11f4d977a97d9b1e70b1ee9469ec3a6a0f96e298046703996c9841320c9e2c4276df8907700b33d7055588b1e72fa902737c256999f25a4
-  data.tar.gz: f78e06828d1e804f0a17730b5b80305082ead39dfd650c535f4289fe7ef35f51d43abf2e1f6550766c0be24ea30fa1fc5be6d2e5c08d405bd2f468cddd2c2ee5
+  metadata.gz: 945b9f957e1c8b223aad62bc58b9b73fa1d8df6213d69df9286f1995fc31f3629a417a2c0f3063c4a2fc29c374b6d0453ae435774d6984c54c081ea97d9ef118
+  data.tar.gz: 0e473012b15e3133e4f2a5df0ebf83a8cdad8f12c8cd9e078258cb9f7ff29a9c6a9c062e1ca627bc725fa58941b0e4ec7450e21de8abda3bb19258ed23515831

data/Changes

@@ -1,5 +1,11 @@
 Change history of write_xlsx rubygem.
 
+2013-11-13 v0.73.0
+   Added custom error bar option to charts.
+   Fix for tables added in non-sequential order.
+   Fix for scatter charts with markers on non-marker series.
+   Fix for charts with star style markers
+
 2013-09-21 v0.72.3.beta1
    speed up when script handles large number of cells.
 

data/README.md

@@ -1,6 +1,6 @@
 # write_xlsx
 
-gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem. write_xlsx is converted from Perl's module [Excel::Writer::XLSX-0.72](https://github.com/jmcnamara/excel-writer-xlsx) .
+gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem. write_xlsx is converted from Perl's module [Excel::Writer::XLSX-0.73](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 

data/lib/write_xlsx/chart/axis.rb

@@ -11,7 +11,7 @@ module Writexlsx
       attr_accessor :defaults, :reverse
       attr_accessor :min, :max
       attr_accessor :minor_unit, :major_unit, :minor_unit_type, :major_unit_type
-      attr_accessor :log_base, :crossing, :position, :label_position, :visible
+      attr_accessor :log_base, :crossing, :position, :position_axis, :label_position, :visible
       attr_accessor :num_format, :num_format_linked, :num_font
       attr_accessor :major_gridlines, :minor_gridlines, :major_tick_mark
 
@@ -31,6 +31,7 @@ module Writexlsx
         @major_unit_type   = args[:major_unit_type]
         @log_base          = args[:log_base]
         @crossing          = args[:crossing]
+        @position_axis     = args[:position_axis]
         @label_position    = args[:label_position]
         @num_format        = args[:num_format]
         @num_format_linked = args[:num_format_linked]
@@ -50,8 +51,21 @@ module Writexlsx
         @position = args[:position]
         @position = @position.downcase[0, 1] if @position
 
+        # Set the position for a category axis on or between the tick marks.
+        if @position_axis
+          if @position_axis == 'on_tick'
+            @position_axis = 'midCat'
+          elsif @position_axis == 'between'
+            # Doesn't neet to be modified.
+          else
+            # Otherwise use the default value.
+            @position_axis = nil
+          end
+        end
+
         # Set the font properties if present.
         @num_font  = @chart.convert_font_args(args[:num_font])
+        @name_font = @chart.convert_font_args(args[:name_font])
       end
 
       #

data/lib/write_xlsx/chart/scatter.rb

@@ -255,7 +255,7 @@ module Writexlsx
           # Go through each series and define default values.
           @series.each do |series|
             # Set a marker type unless there is already a user defined type.
-            if !series.marker || series.marker[:_defined] == 0
+            unless ptrue?(series.marker)
               series.marker = { :type => 'none', :_defined => 1 }
             end
           end

data/lib/write_xlsx/chart/series.rb

@@ -83,7 +83,7 @@ class Series
       :diamond    => 'diamond',
       :triangle   => 'triangle',
       :x          => 'x',
-      :star       => 'start',
+      :star       => 'star',
       :dot        => 'dot',
       :short_dash => 'dot',
       :dash       => 'dash',
@@ -160,17 +160,22 @@ class Series
 
     # Default values.
     error_bars = {
-      :_type      => 'fixedVal',
-      :_value     => 1,
-      :_endcap    => 1,
-      :_direction => 'both'
+      :_type         => 'fixedVal',
+      :_value        => 1,
+      :_endcap       => 1,
+      :_direction    => 'both',
+      :_plus_values  => [1],
+      :_minus_values => [1],
+      :_plus_data    => [],
+      :_minus_data   => []
     }
 
     types = {
       :fixed              => 'fixedVal',
       :percentage         => 'percentage',
       :standard_deviation => 'stdDev',
-      :standard_error     => 'stdErr'
+      :standard_error     => 'stdErr',
+      :custom             => 'cust'
     }
 
     # Check the error bars type.
@@ -203,6 +208,12 @@ class Series
       end
     end
 
+    # Set any custom values
+    error_bars[:_plus_values]  = params[:plus_values]  if params[:plus_values]
+    error_bars[:_minus_values] = params[:minus_values] if params[:minus_values]
+    error_bars[:_plus_data]    = params[:plus_data]    if params[:plus_data]
+    error_bars[:_minus_data]   = params[:minus_data]   if params[:minus_data]
+
     # Set the line properties for the error bars.
     error_bars[:_line] = line_properties(params[:line])
 

data/lib/write_xlsx/chart.rb

@@ -118,6 +118,7 @@ module Writexlsx
       @y_offset          = 0
       @table             = nil
       @smooth_allowed    = 0
+      @cross_between     = 'between'
 
       set_default_properties
     end
@@ -211,8 +212,9 @@ module Writexlsx
     # Set the properties of the chart legend.
     #
     def set_legend(params)
-      @legend_position = params[:position] || 'right'
+      @legend_position      = params[:position] || 'right'
       @legend_delete_series = params[:delete_series]
+      @legend_font          = convert_font_args(params[:font])
     end
 
     #
@@ -680,7 +682,10 @@ module Writexlsx
       attributes << ['i',  font[:_italic]]    if font[:_italic]
       attributes << ['u',  'sng']             if font[:_underline]
 
-      attributes << ['baseline', font[:_baseline]]
+      # Turn off baseline when testing fonts that don't have it.
+      if font[:_baseline] != -1
+        attributes << ['baseline', font[:_baseline]]
+      end
       attributes
     end
 
@@ -1018,6 +1023,13 @@ module Writexlsx
       write_num_or_str_ref('c:strRef', formula, data, type)
     end
 
+    #
+    # Write the <c:numLit> element for literal number list elements.
+    #
+    def write_num_lit(data)
+      write_num_base('c:numLit', data)
+    end
+
     #
     # Write the <c:f> element.
     #
@@ -1189,7 +1201,7 @@ module Writexlsx
         write_crossing(x_axis.crossing)
 
         # Write the c:crossBetween element.
-        write_cross_between
+        write_cross_between(x_axis.position_axis)
 
         # Write the c:majorUnit element.
         write_c_major_unit(y_axis.major_unit)
@@ -1467,8 +1479,8 @@ module Writexlsx
     #
     # Write the <c:crossBetween> element.
     #
-    def write_cross_between # :nodoc:
-      val  = @cross_between || 'between'
+    def write_cross_between(val = nil) # :nodoc:
+      val ||= @cross_between
 
       @writer.empty_tag('c:crossBetween', [ ['val', val] ])
     end
@@ -1513,8 +1525,8 @@ module Writexlsx
     # Write the <c:legend> element.
     #
     def write_legend # :nodoc:
-      position      = @legend_position
-      overlay       = false
+      position = @legend_position
+      overlay  = false
 
       if @legend_delete_series && @legend_delete_series.kind_of?(Array)
         @delete_series = @legend_delete_series
@@ -1547,6 +1559,10 @@ module Writexlsx
         end if @delete_series
         # Write the c:layout element.
         write_layout
+        # Write the c:txPr element.
+        if ptrue?(@legend_font)
+          write_tx_pr(nil, @legend_font)
+        end
         # Write the c:overlay element.
         write_overlay if overlay
       end
@@ -2107,7 +2123,11 @@ module Writexlsx
     # Write the <c:numCache> element.
     #
     def write_num_cache(data) # :nodoc:
-      @writer.tag_elements('c:numCache') do
+      write_num_base('c:numCache', data)
+    end
+
+    def write_num_base(tag, data)
+      @writer.tag_elements(tag) do
 
         # Write the c:formatCode element.
         write_format_code('General')
@@ -2115,9 +2135,7 @@ module Writexlsx
         # Write the c:ptCount element.
         write_pt_count(data.size)
 
-        (0..data.size - 1).each do |i|
-          token = data[i]
-
+        data.each_with_index do |token, i|
           # Write non-numeric data as 0.
           if token &&
               !(token.to_s =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/)
@@ -2356,7 +2374,13 @@ module Writexlsx
           write_no_end_cap
         end
 
-        if error_bars[:_type] != 'stdErr'
+        case error_bars[:_type]
+        when 'stdErr'
+          # Don't need to write a c:errValType tag.
+        when 'cust'
+          # Write the custom error tags.
+          write_custom_error(error_bars)
+        else
           # Write the c:val element.
           write_error_val(error_bars[:_value])
         end
@@ -2401,6 +2425,30 @@ module Writexlsx
       @writer.empty_tag('c:val', [ ['val', val] ])
     end
 
+    #
+    # Write the custom error bars type.
+    #
+    def write_custom_error(error_bars)
+      if ptrue?(error_bars[:_plus_values])
+        # Write the c:plus element.
+        @writer.tag_elements('c:plus') do
+          if error_bars[:_plus_values] =~ /^=/   # '=Sheet1!$A$1:$A$5'
+            write_num_ref(error_bars[:_plus_values], error_bars[:_plus_data], 'num')
+          else                                   # [1, 2, 3]
+            write_num_lit(error_bars[:_plus_values])
+          end
+        end
+        # Write the c:minus element.
+        @writer.tag_elements('c:minus') do
+          if error_bars[:_minus_values] =~ /^=/   # '=Sheet1!$A$1:$A$5'
+            write_num_ref(error_bars[:_minus_values], error_bars[:_minus_data], 'num')
+          else                                   # [1, 2, 3]
+            write_num_lit(error_bars[:_minus_values])
+          end
+        end
+      end
+    end
+
     #
     # Write the <c:upDownBars> element.
     #

data/lib/write_xlsx/package/table.rb

@@ -24,10 +24,11 @@ module Writexlsx
         end
       end
 
-      def initialize(worksheet, id, *args)
+      attr_reader :id, :name
+
+      def initialize(worksheet, *args)
         @worksheet = worksheet
         @writer  = Package::XMLWriterSimple.new
-        @id      = id
 
         @row1, @row2, @col1, @col2, @param = handle_args(*args)
         @columns = []
@@ -146,6 +147,11 @@ module Writexlsx
         end
       end
 
+      def prepare(id)
+        @id = id
+        @name ||= "Table#{id}"
+      end
+
       private
 
       def handle_args(*args)
@@ -264,12 +270,7 @@ module Writexlsx
       end
 
       def set_the_table_name
-        if @param[:name]
-          @name = @param[:name]
-        else
-          # Set a default name.
-          @name = "Table#{@id}"
-        end
+        @name = @param[:name] if @param[:name]
       end
 
       def set_the_table_and_autofilter_ranges
@@ -287,7 +288,7 @@ module Writexlsx
 
         attributes = [
                       ['xmlns',       xmlns],
-                      ['id',          @id],
+                      ['id',          id],
                       ['name',        @name],
                       ['displayName', @name],
                       ['ref',         @range]

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.72.3.beta1"
+  VERSION = "0.73.0"
 end

data/lib/write_xlsx/workbook.rb

@@ -45,7 +45,6 @@ module Writexlsx
     attr_reader :doc_properties  # :nodoc:
     attr_reader :image_types, :images  # :nodoc:
     attr_reader :shared_strings  # :nodoc:
-    attr_accessor :table_count  # :nodoc:
     attr_reader :vba_project  # :nodoc:
     #
     # A new Excel workbook is created using the +new+ constructor
@@ -1210,6 +1209,9 @@ module Writexlsx
       # Add cached data to charts.
       add_chart_data
 
+      # Prepare the worksheet tables.
+      prepare_tables
+
       # Package the workbook.
       packager = Package::Packager.new(self)
       packager.set_package_dir(@tempdir)
@@ -1497,6 +1499,17 @@ module Writexlsx
       add_font_format_for_cell_comments if num_comment_files > 0
     end
 
+    #
+    # Set the table ids for the worksheet tables.
+    #
+    def prepare_tables
+      table_id = 0
+
+      sheets.each do |sheet|
+        table_id += sheet.prepare_tables(table_id + 1)
+      end
+    end
+
     def add_font_format_for_cell_comments
       format = Format.new(
                           @formats,
@@ -1666,17 +1679,13 @@ module Writexlsx
           sheet.prepare_chart(index, chart_ref_id, drawing_id)
         end
 
-        (0 .. image_count - 1).each do |index|
-          filename = sheet.images[index][2]
-
-          image_id, type, width, height, name = get_image_properties(filename)
-
+        sheet.images.each_with_index do |image, index|
+          image_id, type, width, height, name = get_image_properties(image[2])
           image_ref_id += 1
-
           sheet.prepare_image(index, image_ref_id, drawing_id, width, height, name, type)
         end
 
-        (0..shape_count - 1).each do |index|
+        sheet.shapes.each_with_index do |shape, index|
           sheet.prepare_shape(index, drawing_id)
         end
 

data/lib/write_xlsx/worksheet.rb

@@ -4213,11 +4213,7 @@ module Writexlsx
     #
     def add_table(*args)
       # Table count is a member of Workbook, global to all Worksheet.
-      @workbook.table_count += 1
-      id = @workbook.table_count
-      table = Package::Table.new(self, id, *args)
-
-      @external_table_links << ['/table', "../tables/table#{id}.xml"]
+      table = Package::Table.new(self, *args)
       @tables << table
       table
     end
@@ -5746,6 +5742,23 @@ module Writexlsx
       @vml_shape_id = vml_shape_id
     end
 
+    #
+    # Set the table ids for the worksheet tables.
+    #
+    def prepare_tables(table_id)
+      if tables_count > 0
+        id = table_id
+        tables.each do |table|
+          table.prepare(id)
+
+          # Store the link used for the rels file.
+          @external_table_links << ['/table', "../tables/table#{id}.xml"]
+          id += 1
+        end
+      end
+      tables_count || 0
+    end
+
     def num_comments_block
       @comments.size / 1024
     end

data/test/package/table/test_table01.rb

@@ -12,6 +12,7 @@ class TestTable01 < Test::Unit::TestCase
   def test_table01
     # Set the table properties.
     @worksheet.add_table('C3:F13')
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table02.rb

@@ -12,6 +12,7 @@ class TestTable02 < Test::Unit::TestCase
   def test_table02
     # Set the table properties.
     @worksheet.add_table('D4:I15', :style => 'Table Style Light 17')
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table03.rb

@@ -20,6 +20,7 @@ class TestTable03 < Test::Unit::TestCase
                            :banded_columns => 1
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table04.rb

@@ -17,6 +17,7 @@ class TestTable04 < Test::Unit::TestCase
                            :autofilter => 0
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table05.rb

@@ -17,6 +17,7 @@ class TestTable05 < Test::Unit::TestCase
                            :header_row => 0
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table06.rb

@@ -22,6 +22,7 @@ class TestTable06 < Test::Unit::TestCase
                                        ]
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table07.rb

@@ -17,6 +17,7 @@ class TestTable07 < Test::Unit::TestCase
                            :total_row => 1
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table08.rb

@@ -23,6 +23,7 @@ class TestTable08 < Test::Unit::TestCase
                                        ]
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table09.rb

@@ -29,6 +29,7 @@ class TestTable09 < Test::Unit::TestCase
                                        ]
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table10.rb

@@ -15,6 +15,7 @@ class TestTable10 < Test::Unit::TestCase
                          'C2:F13',
                          {:name => 'MyTable'}
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table11.rb

@@ -28,6 +28,7 @@ class TestTable11 < Test::Unit::TestCase
                                          ]
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_table12.rb

@@ -28,6 +28,7 @@ class TestTable12 < Test::Unit::TestCase
                                          ]
                          }
                          )
+    @worksheet.__send__(:prepare_tables, 1)
 
     table = @worksheet.tables[0]
     table.__send__(:assemble_xml_file)

data/test/package/table/test_write_auto_filter.rb

@@ -12,7 +12,7 @@ class TestTableWriteAutoFilter01 < Test::Unit::TestCase
   def test_table_write_auto_filter
     expected = '<autoFilter ref="C3:F13"/>'
 
-    table = Writexlsx::Package::Table.new(@worksheet, 0, 1, 1, 2, 2)
+    table = Writexlsx::Package::Table.new(@worksheet, 1, 1, 2, 2)
     table.instance_variable_set(:@autofilter, 'C3:F13')
 
     table.__send__(:write_auto_filter)

data/test/package/table/test_write_table_column.rb

@@ -11,7 +11,7 @@ class TestTableWriteTableColumn < Test::Unit::TestCase
   def test_table_write_table_column
     expected = '<tableColumn id="1" name="Column1"/>'
 
-    table = Writexlsx::Package::Table.new(@worksheet, 0, 1, 1, 2, 2)
+    table = Writexlsx::Package::Table.new(@worksheet, 1, 1, 2, 2)
     col_data = Writexlsx::Package::Table::ColumnData.new(1)
 
     table.__send__(:write_table_column, col_data)

data/test/package/table/test_write_table_style_info.rb

@@ -11,7 +11,7 @@ class TestTableWriteTableStyleInfo < Test::Unit::TestCase
   def test_table_write_table_style_info
     expected = '<tableStyleInfo name="TableStyleMedium9" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/>'
 
-    table = Writexlsx::Package::Table.new(@worksheet, 0, 1, 1, 2, 2)
+    table = Writexlsx::Package::Table.new(@worksheet, 1, 1, 2, 2)
     table.instance_variable_set(:@style,            'TableStyleMedium9')
     table.instance_variable_set(:@show_first_col,   0)
     table.instance_variable_set(:@show_last_col,    0)

data/test/regression/test_chart_axis30.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartAxis30 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_axis30
+    @xlsx = 'chart_axis30.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, [69200896, 69215360])
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    chart.set_x_axis(:position_axis => 'on_tick')
+
+    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,
+                                {}
+                                )
+  end
+end

data/test/regression/test_chart_axis31.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartAxis31 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_axis31
+    @xlsx = 'chart_axis31.xlsx'
+    workbook    = WriteXLSX.new(@xlsx)
+    worksheet   = workbook.add_worksheet
+    chart       = workbook.add_chart(:type => 'bar', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [90616960, 90618496])
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    chart.set_y_axis(:position_axis => 'on_tick')
+
+    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,
+                                {}
+                                )
+  end
+end