xlsxwriter 0.2.1.pre.2 → 0.2.2

data/ext/xlsxwriter/worksheet.c

@@ -664,7 +664,7 @@ worksheet_insert_chart_(int argc, VALUE *argv, VALUE self) {
   lxw_row_t row;
   lxw_col_t col;
   VALUE chart, opts = Qnil;
-  lxw_image_options options;
+  lxw_chart_options options;
   char with_options = '\0';
 
   rb_check_arity(argc, 2, 4);
@@ -683,7 +683,7 @@ worksheet_insert_chart_(int argc, VALUE *argv, VALUE self) {
   }
 
   if (!NIL_P(opts)) {
-    options = val_to_lxw_image_options(opts, &with_options);
+    options = val_to_lxw_chart_options(opts, &with_options);
   }
 
   struct worksheet *ptr;
@@ -1508,6 +1508,25 @@ int extract_range(int argc, VALUE *argv, lxw_row_t *row_from, lxw_col_t *col_fro
       setter;                                         \
     }                                                 \
   }
+lxw_chart_options
+val_to_lxw_chart_options(VALUE opts, char *with_options) {
+  VALUE val;
+  lxw_chart_options options = {
+    .x_offset = 0,
+    .y_offset = 0,
+    .x_scale = 1.0,
+    .y_scale = 1.0
+  };
+  SET_IMG_OPT("offset",   options.x_offset = options.y_offset = NUM2INT(val));
+  SET_IMG_OPT("x_offset", options.x_offset =                    NUM2INT(val));
+  SET_IMG_OPT("y_offset",                    options.y_offset = NUM2INT(val));
+  SET_IMG_OPT("scale",    options.x_scale  = options.y_scale  = NUM2DBL(val));
+  SET_IMG_OPT("x_scale",  options.x_scale  =                    NUM2DBL(val));
+  SET_IMG_OPT("y_scale",                     options.y_scale  = NUM2DBL(val));
+  SET_IMG_OPT("object_position", options.object_position = NUM2INT(val));
+  return options;
+}
+
 lxw_image_options
 val_to_lxw_image_options(VALUE opts, char *with_options) {
   VALUE val;
@@ -1523,7 +1542,10 @@ val_to_lxw_image_options(VALUE opts, char *with_options) {
   SET_IMG_OPT("scale",    options.x_scale  = options.y_scale  = NUM2DBL(val));
   SET_IMG_OPT("x_scale",  options.x_scale  =                    NUM2DBL(val));
   SET_IMG_OPT("y_scale",                     options.y_scale  = NUM2DBL(val));
+  SET_IMG_OPT("object_position", options.object_position = NUM2INT(val));
   SET_IMG_OPT("description", options.description = StringValueCStr(val));
+  SET_IMG_OPT("url", options.url = StringValueCStr(val));
+  SET_IMG_OPT("tip", options.tip = StringValueCStr(val));
   return options;
 }
 #undef SET_IMG_OPT
@@ -1535,6 +1557,7 @@ init_xlsxwriter_worksheet() {
   cWorksheet = rb_define_class_under(mXlsxWriter, "Worksheet", rb_cObject);
 
   rb_define_alloc_func(cWorksheet, worksheet_alloc);
+  rb_define_attr(cWorksheet, "workbook", 1, 0);
   rb_define_method(cWorksheet, "initialize", worksheet_init, -1);
   rb_define_method(cWorksheet, "free", worksheet_release, 0);
   rb_define_method(cWorksheet, "write_string", worksheet_write_string_, -1);
@@ -1632,6 +1655,12 @@ init_xlsxwriter_worksheet() {
   MAP_LXW_WH_CONST1(VALIDATION_CRITERIA_LESS_THAN);
   MAP_LXW_WH_CONST1(VALIDATION_CRITERIA_GREATER_THAN_OR_EQUAL_TO);
   MAP_LXW_WH_CONST1(VALIDATION_CRITERIA_LESS_THAN_OR_EQUAL_TO);
+
+  MAP_LXW_WH_CONST1(OBJECT_POSITION_DEFAULT);
+  MAP_LXW_WH_CONST1(OBJECT_MOVE_AND_SIZE);
+  MAP_LXW_WH_CONST1(OBJECT_MOVE_DONT_SIZE);
+  MAP_LXW_WH_CONST1(OBJECT_DONT_MOVE_DONT_SIZE);
+  MAP_LXW_WH_CONST1(OBJECT_MOVE_AND_SIZE_AFTER);
 #undef MAP_LXW_WH_CONST1
 #undef MAP_LXW_WH_CONST
 }

data/ext/xlsxwriter/worksheet.h

@@ -12,6 +12,7 @@ lxw_col_t value_to_col(VALUE value);
 int extract_cell(int argc, VALUE *argv, lxw_row_t *row, lxw_col_t *col);
 int extract_range(int argc, VALUE *argv, lxw_row_t *row1, lxw_col_t *col1,
                                          lxw_row_t *row2, lxw_col_t *col2);
+lxw_chart_options val_to_lxw_chart_options(VALUE opts, char *with_options);
 lxw_image_options val_to_lxw_image_options(VALUE opts, char *with_options);
 
 void init_xlsxwriter_worksheet();

data/ext/xlsxwriter/xlsxwriter.c

@@ -4,6 +4,7 @@
 #include "chartsheet.h"
 #include "format.h"
 #include "rich_string.h"
+#include "shared_strings.h"
 #include "workbook.h"
 #include "workbook_properties.h"
 #include "worksheet.h"
@@ -44,4 +45,5 @@ void Init_xlsxwriter() {
   init_xlsxwriter_chart();
   init_xlsxwriter_chartsheet();
   init_xlsxwriter_rich_string();
+  init_xlsxwriter_shared_strings_table();
 }

data/lib/xlsxwriter/rich_string.rb

@@ -55,10 +55,8 @@ module XlsxWriter
       parts.map(&:first)
     end
 
-
     private
 
-
     def make_part(str, format)
       [
         str.frozen? ? str.to_str : str.to_str.clone.freeze,

data/lib/xlsxwriter/version.rb

@@ -2,5 +2,5 @@
 
 module XlsxWriter
   # :nodoc:
-  VERSION = '0.2.1.pre.2'.freeze
+  VERSION = '0.2.2'
 end

data/lib/xlsxwriter/worksheet.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 module XlsxWriter
-
   class Worksheet
     # Last row number written with #add_row
     attr_reader :current_row, :col_auto_widths
 
     # Thiner characters list used for column width logic mimicking axlsx behaviour
-    THIN_CHARS = '^.acfijklrstxzFIJL()-'.freeze
+    THIN_CHARS = '^.acfijklrstxzFIJL()-'
 
     # Write a +row+. If no +types+ passed XlsxWriter tries to deduce them automatically.
     #
@@ -51,6 +50,7 @@ module XlsxWriter
           write_blank(row_idx, idx, cell_style)
         when :skip, :empty
           # write nothing
+          nil
         when nil
           case value
           when Numeric

data/test/{run-test.rb → run_test.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-lib_dir = File.join(base_dir, "lib")
-test_dir = File.join(base_dir, "test")
+base_dir = File.expand_path('..', __dir__)
+lib_dir = File.join(base_dir, 'lib')
+test_dir = File.join(base_dir, 'test')
 
 $LOAD_PATH.unshift(lib_dir)
 

data/test/support/chart_test.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module ChartTest
-  def chart_test(fname, type, data = self::DATA, &block)
-    test fname do |wb|
+  def chart_test(fname, type, data = self::DATA, ref_file_name: nil, &_block)
+    test fname, ref_file_name: ref_file_name do |wb|
       wb.add_worksheet do |ws|
         data.each { |row| ws.add_row row }
 
         wb.add_chart(type) do |chart|
-          yield chart
+          yield chart, ws
 
           ws.insert_chart 'E9', chart
         end

data/test/support/with_xlsx_file.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'xlsxwriter'
 
 module WithXlsxFile
-  def with_xlsx_file(file_path = 'tmp/test.xlsx', **opts)
+  def with_xlsx_file(file_path = 'tmp/test.xlsx', **opts, &block)
     after = opts.delete :after
     XlsxWriter::Workbook.open(file_path, opts) do |wb|
-      yield wb
+      block.call(wb)
     end
     after.call if after
   ensure

data/test/support/xlsx_comparable.rb

@@ -1,9 +1,18 @@
 # frozen_string_literal: true
 
+require 'diffy'
 require 'test/unit'
 require 'zip'
 
 module XlsxComparable
+  def assert_long_seq_equal(expected, actual)
+    expected = expected.join("\n")
+    actual = actual.join("\n")
+    diff = Diffy::Diff.new(expected, actual).to_s(:color)
+    full_message = "diff: \n#{diff}"
+    assert_block(full_message) { expected == actual }
+  end
+
   def assert_xlsx_equal(got_path, exp_path, ignore_files = [], ignore_elements = {})
     Zip::File.open(exp_path) do |exp_zip|
       Zip::File.open(got_path) do |got_zip|
@@ -17,38 +26,22 @@ module XlsxComparable
           exp_xml_str = exp_zip.read(exp_entry.name)
           got_xml_str = got_zip.read(exp_entry.name)
 
-          if %w(.png .jpeg .bmp .bin).include?(File.extname(exp_entry.name))
+          if %w[.png .jpeg .bmp .bin].include?(File.extname(exp_entry.name))
             exp_xml_str.force_encoding('BINARY')
             assert_equal(exp_xml_str, got_xml_str)
             next
           end
 
-          case exp_entry.name
-          when 'docProps/core.xml'
-            exp_xml_str.gsub!(/ ?John/, '')
-            exp_xml_str.gsub!(/\d{4}-\d\d-\d\dT\d\d\:\d\d:\d\dZ/, '')
-            got_xml_str.gsub!(/\d{4}-\d\d-\d\dT\d\d\:\d\d:\d\dZ/, '')
-          when 'xl/workbook.xml'
-            exp_xml_str.gsub!(/<workbookView[^>]*>/, '<workbookView/>')
-            exp_xml_str.gsub!(/<calcPr[^>]*>/, '<calcPr/>')
-            got_xml_str.gsub!(/<workbookView[^>]*>/, '<workbookView/>')
-            got_xml_str.gsub!(/<calcPr[^>]*>/, '<calcPr/>')
-          when %r{xl/worksheets/sheet\d+.xml}
-            exp_xml_str.gsub!(/horizontalDpi="200" /, '')
-            exp_xml_str.gsub!(/verticalDpi="200" /, '')
-            exp_xml_str.gsub!(/(<pageSetup[^>]*) r:id="rId1"/, '\1')
-          when %r{xl/charts/chart\d+.xml}
-            exp_xml_str.gsub!(/<c:pageMargins[^>]*>/, '<c:pageMargins/>')
-            got_xml_str.gsub!(/<c:pageMargins[^>]*>/, '<c:pageMargins/>')
-          end
+          _sanitize_for_comparison(exp_entry.name, exp_xml_str, got_xml_str)
 
           got_xml = _xml_to_list(got_xml_str)
 
-          if exp_entry.name =~ /.vml\z/
-            exp_xml = _vml_to_list(exp_xml_str)
-          else
-            exp_xml = _xml_to_list(exp_xml_str)
-          end
+          exp_xml =
+            if exp_entry.name =~ /.vml\z/
+              _vml_to_list(exp_xml_str)
+            else
+              _xml_to_list(exp_xml_str)
+            end
 
           if ignore_elements.key?(exp_entry.name)
             patterns = ignore_elements[exp_entry.name]
@@ -61,7 +54,7 @@ module XlsxComparable
             exp_xml = _sort_rel_file_data(exp_xml)
           end
 
-          assert_equal exp_xml, got_xml
+          assert_long_seq_equal exp_xml, got_xml
         end
       end
     end
@@ -86,7 +79,7 @@ module XlsxComparable
       line.strip!
       next if line == ''
 
-      line.tr!(?', ?")
+      line.tr!("'", '"')
       line << ' ' if line =~ /"$/
       line << "\n" if line =~ />$/
       line.gsub!('><', ">\n<")
@@ -107,4 +100,25 @@ module XlsxComparable
 
     xml_elements
   end
+
+  def _sanitize_for_comparison(name, exp_xml_str, got_xml_str)
+    case name
+    when 'docProps/core.xml'
+      exp_xml_str.gsub!(/ ?John/, '')
+      exp_xml_str.gsub!(/\d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ/, '')
+      got_xml_str.gsub!(/\d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ/, '')
+    when 'xl/workbook.xml'
+      exp_xml_str.gsub!(/<workbookView[^>]*>/, '<workbookView/>')
+      exp_xml_str.gsub!(/<calcPr[^>]*>/, '<calcPr/>')
+      got_xml_str.gsub!(/<workbookView[^>]*>/, '<workbookView/>')
+      got_xml_str.gsub!(/<calcPr[^>]*>/, '<calcPr/>')
+    when %r{xl/worksheets/sheet\d+.xml}
+      exp_xml_str.gsub!(/horizontalDpi="200" /, '')
+      exp_xml_str.gsub!(/verticalDpi="200" /, '')
+      exp_xml_str.gsub!(/(<pageSetup[^>]*) r:id="rId1"/, '\1')
+    when %r{xl/charts/chart\d+.xml}
+      exp_xml_str.gsub!(/<c:pageMargins[^>]*>/, '<c:pageMargins/>')
+      got_xml_str.gsub!(/<c:pageMargins[^>]*>/, '<c:pageMargins/>')
+    end
+  end
 end

data/test/test_array_formula.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative './xlsx_func_testcase'
+
+class TestArrayFormula < XlsxWriterTestCase
+  test 'array_formula01' do |wb, t|
+    t.ignore_files = %w(
+      xl/calcChain.xml
+      [Content_Types].xml
+      xl/_rels/workbook.xml.rels
+    )
+    ws = wb.add_worksheet nil
+
+    ws.write_number(0, 1, 0, nil)
+    ws.write_number(1, 1, 0, nil)
+    ws.write_number(2, 1, 0, nil)
+    ws.write_number(0, 2, 0, nil)
+    ws.write_number(1, 2, 0, nil)
+    ws.write_number(2, 2, 0, nil)
+
+    ws.write_array_formula(0, 0, 2, 0, '{=SUM(B1:C1*B2:C2)}', nil)
+  end
+
+  test 'array_formula02' do |wb, t|
+    t.ignore_files = %w(
+      xl/calcChain.xml
+      [Content_Types].xml
+      xl/_rels/workbook.xml.rels
+    )
+    ws = wb.add_worksheet
+    wb.add_format(:bold, bold: true)
+
+    ws.write_number(0, 1, 0, nil)
+    ws.write_number(1, 1, 0, nil)
+    ws.write_number(2, 1, 0, nil)
+    ws.write_number(0, 2, 0, nil)
+    ws.write_number(1, 2, 0, nil)
+    ws.write_number(2, 2, 0, nil)
+
+    ws.write_array_formula(0, 0, 2, 0, '{=SUM(B1:C1*B2:C2)}', :bold)
+  end
+end

data/test/test_autofilter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative './xlsx_func_testcase'
+
+class TestAutofilter < XlsxWriterTestCase
+  ROWS = [
+    %w[Region Item Volume Month],
+    ['East',  'Apple',  9000,   'July'],
+    ['East',  'Apple',  5000,   'July'],
+    ['South', 'Orange', 9000,   'September'],
+    ['North', 'Apple',  2000,   'November'],
+    ['West',  'Apple',  9000,   'November'],
+    ['South', 'Pear',   7000,   'October'],
+    ['North', 'Pear',   9000,   'August'],
+    ['West',  'Orange', 1000,   'December'],
+    ['West',  'Grape',  1000,   'November'],
+    ['South', 'Pear',   10_000, 'April'],
+    ['West',  'Grape',  6000,   'January'],
+    ['South', 'Orange', 3000,   'May'],
+    ['North', 'Apple',  3000,   'December'],
+    ['South', 'Apple',  7000,   'February'],
+    ['West',  'Grape',  1000,   'December'],
+    ['East',  'Grape',  8000,   'February'],
+    ['South', 'Grape',  10_000, 'June'],
+    ['West',  'Pear',   7000,   'December'],
+    ['South', 'Apple',  2000,   'October'],
+    ['East',  'Grape',  7000,   'December'],
+    ['North', 'Grape',  6000,   'April'],
+    ['East',  'Pear',   8000,   'February'],
+    ['North', 'Apple',  7000,   'August'],
+    ['North', 'Orange', 7000,   'July'],
+    ['North', 'Apple',  6000,   'June'],
+    ['South', 'Grape',  8000,   'September'],
+    ['West',  'Apple',  3000,   'October'],
+    ['South', 'Orange', 10_000, 'November'],
+    ['West',  'Grape',  4000,   'July'],
+    ['North', 'Orange', 5000,   'August'],
+    ['East',  'Orange', 1000,   'November'],
+    ['East',  'Orange', 4000,   'October'],
+    ['North', 'Grape',  5000,   'August'],
+    ['East',  'Apple',  1000,   'December'],
+    ['South', 'Apple',  10_000, 'March'],
+    ['East',  'Grape',  7000,   'October'],
+    ['West',  'Grape',  1000,   'September'],
+    ['East',  'Grape',  10_000, 'October'],
+    ['South', 'Orange', 8000,   'March'],
+    ['North', 'Apple',  4000,   'July'],
+    ['South', 'Orange', 5000,   'July'],
+    ['West',  'Apple',  4000,   'June'],
+    ['East',  'Apple',  5000,   'April'],
+    ['North', 'Pear',   3000,   'August'],
+    ['East',  'Grape',  9000,   'November'],
+    ['North', 'Orange', 8000,   'October'],
+    ['East',  'Apple',  10_000, 'June'],
+    ['South', 'Pear',   1000,   'December'],
+    ['North', 'Grape',  10_000, 'July'],
+    ['East',  'Grape',  6000,   'February']
+  ].freeze
+
+  test 'autofilter00' do |wb|
+    ws = wb.add_worksheet
+
+    ROWS.each { |row| ws.add_row row }
+  end
+
+  test 'autofilter01' do |wb|
+    ws = wb.add_worksheet
+
+    ROWS.each { |row| ws.add_row row }
+    ws.autofilter('A1', 50, 3)
+  end
+end

data/test/{test-chart-area.rb → test_chart_area.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './xlsx-func-testcase'
+require_relative './xlsx_func_testcase'
 
 class TestChartArea < XlsxWriterTestCase
   DATA = [
@@ -9,7 +9,7 @@ class TestChartArea < XlsxWriterTestCase
     [3,  6,  9],
     [4,  8, 12],
     [5, 10, 15]
-  ]
+  ].freeze
 
   test 'chart_area01' do |wb|
     wb.add_worksheet do |ws|

data/test/{test-chart-axis.rb → test_chart_axis.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './xlsx-func-testcase'
+require_relative './xlsx_func_testcase'
 require_relative './support/chart_test'
 
 class TestChartAxis < XlsxWriterTestCase
@@ -11,16 +11,16 @@ class TestChartAxis < XlsxWriterTestCase
     [2,  4,  6],
     [3,  6,  9],
     [4,  8, 12],
-    [5, 10, 15],
-  ]
+    [5, 10, 15]
+  ].freeze
 
   DATA2 = [
     [1, 8,  3],
     [2, 7,  6],
     [3, 6,  9],
     [4, 8,  12],
-    [5, 10, 15],
-  ]
+    [5, 10, 15]
+  ].freeze
 
   chart_test 'chart_axis01', XlsxWriter::Workbook::Chart::BAR do |chart|
     chart.axis_id_1 = 58_955_648
@@ -71,7 +71,7 @@ class TestChartAxis < XlsxWriterTestCase
 
   test 'chart_axis06' do |wb|
     wb.add_worksheet do |ws|
-      [ [2, 60], [4, 30], [6, 10] ].each { |row| ws.add_row row }
+      [[2, 60], [4, 30], [6, 10]].each { |row| ws.add_row row }
       wb.add_chart(XlsxWriter::Workbook::Chart::PIE) do |chart|
         chart.add_series '=Sheet1!$A$1:$A$3', '=Sheet1!$B$1:$B$3'
         chart.title = 'Title'
@@ -279,8 +279,8 @@ class TestChartAxis < XlsxWriterTestCase
   end
 
   chart_test 'chart_axis26', XlsxWriter::Workbook::Chart::LINE do |chart|
-    chart.axis_id_1 = 73_048_448
-    chart.axis_id_2 = 73_049_984
+    chart.axis_id_1 = 108_315_392
+    chart.axis_id_2 = 108_329_216
 
     chart.add_series '=Sheet1!$A$1:$A$5'
     chart.add_series '=Sheet1!$B$1:$B$5'
@@ -290,8 +290,8 @@ class TestChartAxis < XlsxWriterTestCase
   end
 
   chart_test 'chart_axis27', XlsxWriter::Workbook::Chart::LINE do |chart|
-    chart.axis_id_1 = 73_048_448
-    chart.axis_id_2 = 73_049_984
+    chart.axis_id_1 = 108_315_392
+    chart.axis_id_2 = 108_329_216
 
     chart.add_series '=Sheet1!$A$1:$A$5'
     chart.add_series '=Sheet1!$B$1:$B$5'
@@ -301,8 +301,8 @@ class TestChartAxis < XlsxWriterTestCase
   end
 
   chart_test 'chart_axis28', XlsxWriter::Workbook::Chart::LINE do |chart|
-    chart.axis_id_1 = 45_451_904
-    chart.axis_id_2 = 47_401_600
+    chart.axis_id_1 = 115_375_104
+    chart.axis_id_2 = 115_390_720
 
     chart.add_series '=Sheet1!$A$1:$A$5'
     chart.add_series '=Sheet1!$B$1:$B$5'
@@ -312,8 +312,8 @@ class TestChartAxis < XlsxWriterTestCase
   end
 
   chart_test 'chart_axis29', XlsxWriter::Workbook::Chart::LINE do |chart|
-    chart.axis_id_1 = 45_444_480
-    chart.axis_id_2 = 47_402_368
+    chart.axis_id_1 = 145_169_024
+    chart.axis_id_2 = 145_176_448
 
     chart.add_series '=Sheet1!$A$1:$A$5'
     chart.add_series '=Sheet1!$B$1:$B$5'
@@ -356,8 +356,8 @@ class TestChartAxis < XlsxWriterTestCase
   end
 
   chart_test 'chart_axis33', XlsxWriter::Workbook::Chart::LINE do |chart|
-    chart.axis_id_1 = 68_827_008
-    chart.axis_id_2 = 68_898_816
+    chart.axis_id_1 = 143_682_944
+    chart.axis_id_2 = 143_946_496
 
     chart.add_series '=Sheet1!$A$1:$A$5'
     chart.add_series '=Sheet1!$B$1:$B$5'