roo 2.3.0 → 2.10.1

data/spec/lib/roo/weak_instance_cache_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+if RUBY_PLATFORM == "java"
+  require 'java'
+  java_import 'java.lang.System'
+end
+
+describe Roo::Helpers::WeakInstanceCache do
+  let(:klass) do
+    Class.new do
+      include Roo::Helpers::WeakInstanceCache
+
+      def memoized_data
+        instance_cache(:@memoized_data) do
+          "Some Costly Operation #{rand(1000)}" * 1_000
+        end
+      end
+    end
+  end
+
+  subject do
+    klass.new
+  end
+
+  it 'should be lazy' do
+    expect(subject.instance_variables).to_not include(:@memoized_data)
+    data = subject.memoized_data
+    expect(subject.instance_variables).to include(:@memoized_data)
+  end
+
+
+  it 'should be memoized' do
+    data = subject.memoized_data
+    expect(subject.memoized_data).to equal(data)
+  end
+
+  it 'should recalculate after GC' do
+    expect(subject.instance_variables).to_not include(:@memoized_data)
+    GC.disable
+    subject.memoized_data && nil
+    expect(subject.instance_variables).to include(:@memoized_data)
+
+    force_gc
+    expect(subject.instance_variables).to_not include(:@memoized_data)
+    GC.disable
+    subject.memoized_data && nil
+    expect(subject.instance_variables).to include(:@memoized_data)
+  end
+
+  it 'must remove instance variable' do
+    expect(subject.instance_variables).to_not include(:@memoized_data)
+    GC.disable
+    subject.memoized_data && nil
+    expect(subject.instance_variables).to include(:@memoized_data)
+
+    force_gc
+    expect(subject.instance_variables).to_not include(:@memoized_data)
+  end
+
+  context '#inspect must not raise' do
+    it 'before calculation' do
+      expect{subject.inspect}.to_not raise_error
+    end
+    it 'after calculation' do
+      GC.disable
+      subject.memoized_data && nil
+      expect{subject.inspect}.to_not raise_error
+      expect(subject.inspect).to include("Some Costly Operation")
+      force_gc
+    end
+    it 'after GC' do
+      subject.memoized_data && nil
+      force_gc
+      expect(subject.instance_variables).to_not include(:@memoized_data)
+      expect{subject.inspect}.to_not raise_error
+      expect(subject.inspect).to_not include("Some Costly Operation")
+    end
+  end
+
+  if RUBY_PLATFORM == "java"
+    def force_gc
+      System.gc
+      sleep(0.1)
+    end
+  else
+    def force_gc
+      GC.start(full_mark: true, immediate_sweep: true)
+      sleep(0.1)
+      GC.start(full_mark: true, immediate_sweep: true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,9 @@
 require 'simplecov'
 require 'roo'
-require 'vcr'
-
 require 'helpers'
 
 RSpec.configure do |c|
   c.include Helpers
-end
-
-VCR.configure do |c|
-  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
-  c.hook_into :webmock # or :fakeweb
+  c.color = true
+  c.formatter = :documentation if ENV["USE_REPORTERS"]
 end

data/test/excelx/cell/test_attr_reader_default.rb

@@ -0,0 +1,72 @@
+require "test_helper"
+
+class TestAttrReaderDefault < Minitest::Test
+  def base
+    Roo::Excelx::Cell::Base
+  end
+
+  def boolean
+    Roo::Excelx::Cell::Boolean
+  end
+
+  def class_date
+    Roo::Excelx::Cell::Date
+  end
+
+  def datetime
+    Roo::Excelx::Cell::DateTime
+  end
+
+  def empty
+    Roo::Excelx::Cell::Empty
+  end
+
+  def number
+    Roo::Excelx::Cell::Number
+  end
+
+  def string
+    Roo::Excelx::Cell::String
+  end
+
+  def base_date
+    ::Date.new(1899, 12, 30)
+  end
+
+  def base_timestamp
+    ::Date.new(1899, 12, 30).to_datetime.to_time.to_i
+  end
+
+  def class_time
+    Roo::Excelx::Cell::Time
+  end
+
+  def test_cell_default_values
+    assert_values base.new(nil, nil, [], 1, nil, nil), default_type: :base, :@default_type => nil, style: 1, :@style => nil
+    assert_values boolean.new("1", nil, nil, nil, nil), default_type: :boolean, :@default_type => nil, cell_type: :boolean, :@cell_type => nil
+    assert_values class_date.new("41791", nil, [:numeric_or_formula, "mm-dd-yy"], 6, nil, base_date, nil), default_type: :date, :@default_type => nil
+    assert_values class_time.new("0.521", nil, [:numeric_or_formula, "hh:mm"], 6, nil, base_timestamp, nil), default_type: :time, :@default_type => nil
+    assert_values datetime.new("41791.521", nil, [:numeric_or_formula, "mm-dd-yy hh:mm"], 6, nil, base_timestamp, nil), default_type: :datetime, :@default_type => nil
+    assert_values empty.new(nil), default_type: nil, :@default_type => nil, style: nil, :@style => nil
+    assert_values number.new("42", nil, ["0"], nil, nil, nil), default_type: :float, :@default_type => nil
+    assert_values string.new("1", nil, nil, nil, nil), default_type: :string, :@default_type => nil, cell_type: :string, :@cell_type => nil
+
+    assert_values base.new(nil, nil, [], 2, nil, nil), style: 2, :@style => 2
+  end
+
+  def assert_values(object, value_hash)
+    value_hash.each do |attr_name, expected_value|
+      value = if attr_name.to_s.include?("@")
+                object.instance_variable_defined?(attr_name) ? object.instance_variable_get(attr_name) : nil
+              else
+                object.public_send(attr_name)
+              end
+
+      if expected_value
+        assert_equal expected_value, value
+      else
+        assert_nil value
+      end
+    end
+  end
+end

data/test/excelx/cell/test_base.rb

@@ -1,5 +1,4 @@
-require 'roo/excelx/cell/base'
-require 'roo/link'
+require 'test_helper'
 
 class TestRooExcelxCellBase < Minitest::Test
   def base
@@ -26,6 +25,11 @@ class TestRooExcelxCellBase < Minitest::Test
     refute cell.empty?
   end
 
+  def test_presence
+    cell = base.new(value, nil, [], nil, nil, nil)
+    assert_equal cell, cell.presence
+  end
+
   def test_cell_type_is_formula
     formula = true
     cell = base.new(value, formula, [], nil, nil, nil)

data/test/excelx/cell/test_boolean.rb

@@ -1,6 +1,4 @@
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/boolean'
-require 'roo/link'
+require 'test_helper'
 
 class TestRooExcelxCellNumber < Minitest::Test
   def boolean

data/test/excelx/cell/test_date.rb

@@ -1,9 +1,4 @@
-require 'date'
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/datetime'
-require 'roo/excelx/cell/date'
-require 'roo/link'
-require 'pry'
+require 'test_helper'
 
 class TestRooExcelxCellDate < Minitest::Test
   def date_cell

data/test/excelx/cell/test_datetime.rb

@@ -1,16 +1,13 @@
-require 'date'
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/datetime'
-require 'roo/link'
+require 'test_helper'
 
 class TestRooExcelxCellDateTime < Minitest::Test
   def test_cell_value_is_datetime
-    cell = datetime.new('30000.323212', nil, ['mm-dd-yy'], nil, nil, base_date, nil)
+    cell = datetime.new('30000.323212', nil, ['mm-dd-yy'], nil, nil, base_timestamp, nil)
     assert_kind_of ::DateTime, cell.value
   end
 
   def test_cell_type_is_datetime
-    cell = datetime.new('30000.323212', nil, [], nil, nil, base_date, nil)
+    cell = datetime.new('30000.323212', nil, [], nil, nil, base_timestamp, nil)
     assert_equal :datetime, cell.type
   end
 
@@ -22,7 +19,7 @@ class TestRooExcelxCellDateTime < Minitest::Test
       ['mmm-yy', 'JAN-15'],
       ['m/d/yy h:mm', '1/25/15 8:15']
     ].each do |format, formatted_value|
-      cell = datetime.new '42029.34375', nil, [format], nil, nil, base_date, nil
+      cell = datetime.new '42029.34375', nil, [format], nil, nil, base_timestamp, nil
       assert_equal formatted_value, cell.formatted_value
     end
   end
@@ -33,7 +30,7 @@ class TestRooExcelxCellDateTime < Minitest::Test
       ['h:mm:ss000 mm/yy', '8:15:00000 01/15'],
       ['mmm yyy', '2015-01-25 08:15:00']
     ].each do |format, formatted_value|
-      cell = datetime.new '42029.34375', nil, [format], nil, nil, base_date, nil
+      cell = datetime.new '42029.34375', nil, [format], nil, nil, base_timestamp, nil
       assert_equal formatted_value, cell.formatted_value
     end
   end
@@ -42,7 +39,7 @@ class TestRooExcelxCellDateTime < Minitest::Test
     Roo::Excelx::Cell::DateTime
   end
 
-  def base_date
-    Date.new(1899, 12, 30)
+  def base_timestamp
+    DateTime.new(1899, 12, 30).to_time.to_i
   end
 end

data/test/excelx/cell/test_empty.rb

@@ -1,8 +1,18 @@
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/empty'
+require 'test_helper'
 
 class TestRooExcelxCellEmpty < Minitest::Test
   def empty
     Roo::Excelx::Cell::Empty
   end
+
+  def test_empty?
+    cell = empty.new(nil)
+    assert_same  true, cell.empty?
+  end
+
+  def test_nil_presence
+    cell = empty.new(nil)
+    assert_nil cell.presence
+  end
+
 end

data/test/excelx/cell/test_number.rb

@@ -1,6 +1,4 @@
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/number'
-require 'roo/link'
+require 'test_helper'
 
 class TestRooExcelxCellNumber < Minitest::Test
   def number
@@ -17,11 +15,31 @@ class TestRooExcelxCellNumber < Minitest::Test
     assert_kind_of(Integer, cell.value)
   end
 
+  def test_scientific_notation
+    cell = Roo::Excelx::Cell::Number.new '1.2E-3', nil, ['0'], nil, nil, nil
+    assert_kind_of(Float, cell.value)
+  end
+
+  def test_simple_scientific_notation
+    cell = Roo::Excelx::Cell::Number.new '1E-3', nil, ['0'], nil, nil, nil
+    assert_kind_of(Float, cell.value)
+  end
+
+  def test_very_simple_scientific_notation
+    cell = Roo::Excelx::Cell::Number.new '1e6', nil, ['0'], nil, nil, nil
+    assert_kind_of(Float, cell.value)
+  end
+
   def test_percent
     cell = Roo::Excelx::Cell::Number.new '42.1', nil, ['0.00%'], nil, nil, nil
     assert_kind_of(Float, cell.value)
   end
 
+  def test_rounded_percent_formatted_value
+    cell = Roo::Excelx::Cell::Number.new '0.569999999995', nil, ['0%'], nil, nil, nil
+    assert_equal('57%', cell.formatted_value)
+  end
+
   def test_formats_with_negative_numbers
     [
       ['#,##0 ;(#,##0)', '(1,042)'],
@@ -35,7 +53,7 @@ class TestRooExcelxCellNumber < Minitest::Test
   end
 
   def test_numbers_with_cell_errors
-    %w(#N/A #REF! #NAME? #DIV/0! #NULL! #VALUE! #NUM!).each do |error|
+    Roo::Excelx::ERROR_VALUES.each do |error|
       cell = Roo::Excelx::Cell::Number.new error, nil, ['General'], nil, nil, nil
       assert_equal error, cell.value
       assert_equal error, cell.formatted_value
@@ -45,10 +63,15 @@ class TestRooExcelxCellNumber < Minitest::Test
   def test_formats
     [
       ['General', '1042'],
+      ['GENERAL', '1042'],
       ['0', '1042'],
+      ['000000', '001042'],
       ['0.00', '1042.00'],
+      ['0.0000', '1042.0000'],
+      ['0.000000000', '1042.000000000'],
       ['#,##0', '1,042'],
       ['#,##0.00', '1,042.00'],
+      ['#,##0.000', '1,042.000'],
       ['0%', '104200%'],
       ['0.00%', '104200.00%'],
       ['0.00E+00', '1.04E+03'],
@@ -57,6 +80,7 @@ class TestRooExcelxCellNumber < Minitest::Test
       ['#,##0.00;(#,##0.00)', '1,042.00'],
       ['#,##0.00;[Red](#,##0.00)', '1,042.00'],
       ['##0.0E+0', '1.0E+03'],
+      ["_-* #,##0.00\\ _€_-;\\-* #,##0.00\\ _€_-;_-* \"-\"??\\ _€_-;_-@_-", '1,042.00'],
       ['@', '1042']
     ].each do |style_format, result|
       cell = Roo::Excelx::Cell::Number.new '1042', nil, [style_format], nil, nil, nil

data/test/excelx/cell/test_string.rb

@@ -1,6 +1,4 @@
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/string'
-require 'roo/link'
+require 'test_helper'
 
 class TestRooExcelxCellString < Minitest::Test
   def string
@@ -27,4 +25,24 @@ class TestRooExcelxCellString < Minitest::Test
     cell = string.new '0', nil, nil, nil, nil
     assert_equal '0', cell.value
   end
+
+  def test_not_empty?
+    cell = string.new '1', nil, nil, nil, nil
+    assert_equal false, cell.empty?
+  end
+
+  def test_empty?
+    cell = string.new '', nil, nil, nil, nil
+    assert_equal true, cell.empty?
+  end
+
+  def test_presence
+    cell = string.new '1', nil, nil, nil, nil
+    assert_equal cell, cell.presence
+  end
+
+  def test_nil_presence
+    cell = string.new '', nil, nil, nil, nil
+    assert_nil cell.presence
+  end
 end

data/test/excelx/cell/test_time.rb

@@ -1,15 +1,12 @@
-require 'roo/excelx/cell/base'
-require 'roo/excelx/cell/datetime'
-require 'roo/excelx/cell/time'
-require 'roo/link'
+require 'test_helper'
 
 class TestRooExcelxCellTime < Minitest::Test
-  def time
+  def roo_time
     Roo::Excelx::Cell::Time
   end
 
-  def base_date
-    Date.new(1899, 12, 30)
+  def base_timestamp
+    DateTime.new(1899, 12, 30).to_time.to_i
   end
 
   def test_formatted_value
@@ -21,13 +18,13 @@ class TestRooExcelxCellTime < Minitest::Test
       ['[h]:mm:ss', '[1]:48:09'],
       ['mmss.0', '4809.0'] # Cell::Time always get rounded to the nearest second.
     ].each do |style_format, result|
-      cell = time.new(value, nil, [:numeric_or_formula, style_format], 6, nil, base_date, nil)
+      cell = roo_time.new(value, nil, [:numeric_or_formula, style_format], 6, nil, base_timestamp, nil)
       assert_equal result, cell.formatted_value, "Style=#{style_format} is not properly formatted"
     end
   end
 
   def test_value
-    cell = time.new('0.0751', nil, [:numeric_or_formula, 'h:mm'], 6, nil, base_date, nil)
-    assert_kind_of Fixnum, cell.value
+    cell = roo_time.new('0.0751', nil, [:numeric_or_formula, 'h:mm'], 6, nil, base_timestamp, nil)
+    assert_kind_of Integer, cell.value
   end
 end

data/test/excelx/test_coordinate.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestRooExcelxCoordinate < Minitest::Test
+  def row
+    10
+  end
+
+  def column
+    20
+  end
+
+  def coordinate
+    Roo::Excelx::Coordinate.new(row, column)
+  end
+
+  def array
+    [row, column]
+  end
+
+  def test_row
+    assert_same  row, coordinate.row
+  end
+
+  def test_column
+    assert_same  column, coordinate.column
+  end
+
+  def test_frozen?
+    assert coordinate.frozen?
+  end
+
+  def test_equality
+    hash = {}
+    hash[coordinate] = true
+    assert hash.key?(coordinate)
+    assert hash.key?(array)
+  end
+
+  def test_expand
+    r, c = coordinate
+    assert_same row, r
+    assert_same column, c
+  end
+
+  def test_aref
+    assert_same row, coordinate[0]
+    assert_same column, coordinate[1]
+  end
+end

data/test/formatters/test_csv.rb

@@ -0,0 +1,136 @@
+require "test_helper"
+
+class TestRooFormatterCSV < Minitest::Test
+  def test_date_time_to_csv
+    with_each_spreadsheet(name: "time-test") do |workbook|
+      Dir.mktmpdir do |tempdir|
+        csv_output = File.join(tempdir, "time_test.csv")
+        assert workbook.to_csv(csv_output)
+        assert File.exist?(csv_output)
+        assert_equal "", `diff --strip-trailing-cr #{TESTDIR}/time-test.csv #{csv_output}`
+        # --strip-trailing-cr is needed because the test-file use 0A and
+        # the test on an windows box generates 0D 0A as line endings
+      end
+    end
+  end
+
+  def test_boolean_to_csv
+    with_each_spreadsheet(name: "boolean") do |workbook|
+      Dir.mktmpdir do |tempdir|
+        csv_output = File.join(tempdir,"boolean.csv")
+        assert workbook.to_csv(csv_output)
+        assert File.exist?(csv_output)
+        assert_equal "", `diff --strip-trailing-cr #{TESTDIR}/boolean.csv #{csv_output}`
+        # --strip-trailing-cr is needed because the test-file use 0A and
+        # the test on an windows box generates 0D 0A as line endings
+      end
+    end
+  end
+
+  def test_link_to_csv
+    with_each_spreadsheet(name: "link", format: :excelx) do |workbook|
+      Dir.mktmpdir do |tempdir|
+        csv_output = File.join(tempdir, "link.csv")
+        assert workbook.to_csv(csv_output)
+        assert File.exist?(csv_output)
+        assert_equal "", `diff --strip-trailing-cr #{TESTDIR}/link.csv #{csv_output}`
+        # --strip-trailing-cr is needed because the test-file use 0A and
+        # the test on an windows box generates 0D 0A as line endings
+      end
+    end
+  end
+
+  # "/tmp/xxxx" darf man unter Windows nicht verwenden, weil das nicht erkannt
+  # wird.
+  # Besser: Methode um temporaeres Dir. portabel zu bestimmen
+  def test_huge_document_to_csv
+    skip_long_test
+
+    original_csv_path = File.join(TESTDIR, "Bibelbund.csv")
+    with_each_spreadsheet(name: "Bibelbund", format: [:openoffice, :excelx]) do |workbook|
+      Dir.mktmpdir do |tempdir|
+        new_csv_path = File.join(tempdir, "Bibelbund.csv")
+        assert_equal "Tagebuch des Sekret\303\244rs.    Letzte Tagung 15./16.11.75 Schweiz", workbook.cell(45, "A")
+        assert_equal "Tagebuch des Sekret\303\244rs.  Nachrichten aus Chile", workbook.cell(46, "A")
+        assert_equal "Tagebuch aus Chile  Juli 1977", workbook.cell(55, "A")
+        assert workbook.to_csv(new_csv_path)
+        assert File.exist?(new_csv_path)
+        assert FileUtils.identical?(original_csv_path, new_csv_path), "error in class #{workbook.class}"
+      end
+    end
+  end
+
+  def test_bug_empty_sheet
+    with_each_spreadsheet(name: "formula", format: [:openoffice, :excelx]) do |workbook|
+      workbook.default_sheet = "Sheet3" # is an empty sheet
+      Dir.mktmpdir do |tempdir|
+        workbook.to_csv(File.join(tempdir, "emptysheet.csv"))
+        assert_equal "", `cat #{File.join(tempdir, "emptysheet.csv")}`
+      end
+    end
+  end
+
+  def test_bug_quotes_excelx
+    skip_long_test
+    # TODO: run this test with a much smaller document
+    with_each_spreadsheet(name: "Bibelbund", format: [:openoffice, :excelx]) do |workbook|
+      workbook.default_sheet = workbook.sheets.first
+      assert_equal(
+        'Einflüsse der neuen Theologie in "de gereformeerde Kerken van Nederland"',
+        workbook.cell("A", 76)
+      )
+      workbook.to_csv("csv#{$$}")
+      assert_equal(
+        'Einflüsse der neuen Theologie in "de gereformeerde Kerken van Nederland"',
+        workbook.cell("A", 78)
+      )
+      File.delete_if_exist("csv#{$$}")
+    end
+  end
+
+  def test_bug_datetime_to_csv
+    with_each_spreadsheet(name: "datetime") do |workbook|
+      Dir.mktmpdir do |tempdir|
+        datetime_csv_file = File.join(tempdir, "datetime.csv")
+
+        assert workbook.to_csv(datetime_csv_file)
+        assert File.exist?(datetime_csv_file)
+        assert_equal "", file_diff("#{TESTDIR}/so_datetime.csv", datetime_csv_file)
+      end
+    end
+  end
+
+  def test_bug_datetime_offset_change
+    # DO NOT REMOVE Asia/Calcutta
+    [nil, "US/Eastern", "US/Pacific", "Asia/Calcutta"].each do |zone|
+      with_timezone(zone) do
+        with_each_spreadsheet(name: "datetime_timezone_ist_offset_change", format: %i[excelx openoffice libreoffice]) do |workbook|
+          Dir.mktmpdir do |tempdir|
+            datetime_csv_file = File.join(tempdir, "datetime_timezone_ist_offset_change.csv")
+
+            assert workbook.to_csv(datetime_csv_file)
+            assert File.exist?(datetime_csv_file)
+            assert_equal "", file_diff("#{TESTDIR}/so_datetime_timezone_ist_offset_change.csv", datetime_csv_file)
+          end
+        end
+      end
+    end
+  end
+
+  def test_true_class
+    assert_equal "true", cell_to_csv(1, 1)
+  end
+
+  def test_false_class
+    assert_equal "false", cell_to_csv(2, 1)
+  end
+
+  def test_date_class
+    assert_equal "2017-01-01", cell_to_csv(3, 1)
+  end
+
+  def cell_to_csv(row, col)
+    filename = File.join(TESTDIR, "formula_cell_types.xlsx")
+    Roo::Spreadsheet.open(filename).send("cell_to_csv", row, col, "Sheet1")
+  end
+end