roo 1.13.1 → 2.10.1

data/test/helpers/test_accessing_files.rb

@@ -0,0 +1,81 @@
+# Tests for "Accessing Files" which includes opening and closing files.
+module TestAccesingFiles
+  def test_close
+    with_each_spreadsheet(name: "numbers1") do |oo|
+      next unless (tempdir = oo.instance_variable_get("@tmpdir"))
+      oo.close
+      refute File.exist?(tempdir), "Expected #{tempdir} to be cleaned up"
+    end
+  end
+
+  # NOTE: Ruby 2.4.0 changed the way GC works. The last Roo object created by
+  #       with_each_spreadsheet wasn't getting GC'd until after the process
+  #       ended.
+  #
+  #       That behavior change broke this test. In order to fix it, I forked the
+  #       process and passed the temp directories from the forked process in
+  #       order to check if they were removed properly.
+  def test_finalize
+    skip if defined? JRUBY_VERSION
+
+    read, write = IO.pipe
+    pid = Process.fork do
+      with_each_spreadsheet(name: "numbers1") do |oo|
+        write.puts oo.instance_variable_get("@tmpdir")
+      end
+    end
+
+    Process.wait(pid)
+    write.close
+    tempdirs = read.read.split("\n")
+    read.close
+
+    refute tempdirs.empty?
+    tempdirs.each do |tempdir|
+      refute File.exist?(tempdir), "Expected #{tempdir} to be cleaned up"
+    end
+  end
+
+  def test_finalize_twice
+    skip if defined? JRUBY_VERSION
+
+    instance = Class.new { include Roo::Tempdir }.new
+
+    tempdir = instance.make_tempdir(instance, "my_temp_prefix", nil)
+    assert File.exist?(tempdir), "Expected #{tempdir} to initially exist"
+
+    pid = Process.fork do
+      # Inside the forked process finalize does not affect the parent process's state, but does
+      # delete the tempfile on disk
+      instance.finalize_tempdirs(instance.object_id)
+    end
+
+    Process.wait(pid)
+    refute File.exist?(tempdir), "Expected #{tempdir} to have been cleaned up by child process"
+
+    instance.finalize_tempdirs(instance.object_id)
+    refute File.exist?(tempdir), "Expected #{tempdir} to still have been cleaned up"
+  end
+
+  def test_cleanup_on_error
+    # NOTE: This test was occasionally failing because when it started running
+    #       other tests would have already added folders to the temp directory,
+    #       polluting the directory. You'd end up in a situation where there
+    #       would be less folders AFTER this ran than originally started.
+    #
+    #       Instead, just use a custom temp directory to test the functionality.
+    ENV["ROO_TMP"] = Dir.tmpdir + "/test_cleanup_on_error"
+    Dir.mkdir(ENV["ROO_TMP"]) unless File.exist?(ENV["ROO_TMP"])
+    expected_dir_contents = Dir.open(ENV["ROO_TMP"]).to_a
+    with_each_spreadsheet(name: "non_existent_file", ignore_errors: true) {}
+
+    assert_equal expected_dir_contents, Dir.open(ENV["ROO_TMP"]).to_a
+    Dir.rmdir ENV["ROO_TMP"] if File.exist?(ENV["ROO_TMP"])
+    ENV.delete "ROO_TMP"
+  end
+
+  def test_name_with_leading_slash
+    xlsx = Roo::Excelx.new(File.join(TESTDIR, "/name_with_leading_slash.xlsx"))
+    assert_equal 1, xlsx.sheets.count
+  end
+end

data/test/helpers/test_comments.rb

@@ -0,0 +1,43 @@
+module TestComments
+  def test_comment
+    options = { name: "comments", format: [:openoffice, :libreoffice, :excelx] }
+    with_each_spreadsheet(options) do |oo|
+      assert_equal "Kommentar fuer B4", oo.comment("b", 4)
+      assert_equal "Kommentar fuer B5", oo.comment("b", 5)
+    end
+  end
+
+  def test_no_comment
+    options = { name: "comments", format: [:openoffice, :excelx] }
+    with_each_spreadsheet(options) do |oo|
+      # There are no comments at the second sheet.
+      assert_nil oo.comment("b", 4, oo.sheets[1])
+    end
+  end
+
+  def test_comments
+    options = { name: "comments", format: [:openoffice, :libreoffice, :excelx] }
+    expexted_comments = [
+      [4, 2, "Kommentar fuer B4"],
+      [5, 2, "Kommentar fuer B5"],
+    ]
+
+    with_each_spreadsheet(options) do |oo|
+      assert_equal expexted_comments, oo.comments(oo.sheets.first), "comments error in class #{oo.class}"
+    end
+  end
+
+  def test_empty_sheet_comments
+    options = { name: "emptysheets", format: [:openoffice, :excelx] }
+    with_each_spreadsheet(options) do |oo|
+      assert_equal [], oo.comments, "An empty sheet's formulas should be an empty array"
+    end
+  end
+
+  def test_comments_from_google_sheet_exported_as_xlsx
+    expected_comments = [[1, 1, "this is a comment\n\t-Steven Daniels"]]
+    with_each_spreadsheet(name: "comments-google", format: [:excelx]) do |oo|
+      assert_equal expected_comments, oo.comments(oo.sheets.first), "comments error in class #{oo.class}"
+    end
+  end
+end

data/test/helpers/test_formulas.rb

@@ -0,0 +1,9 @@
+module TestFormulas
+  def test_empty_sheet_formulas
+    options = { name: "emptysheets", format: [:openoffice, :excelx] }
+    with_each_spreadsheet(options) do |oo|
+      oo.default_sheet = oo.sheets.first
+      assert_equal [], oo.formulas, "An empty sheet's formulas should be an empty array"
+    end
+  end
+end

data/test/helpers/test_labels.rb

@@ -0,0 +1,103 @@
+module TestLabels
+  def test_labels
+    options = { name: "named_cells", format: [:openoffice, :excelx, :libreoffice] }
+    expected_labels = [
+      ["anton", [5, 3, "Sheet1"]],
+      ["berta", [4, 2, "Sheet1"]],
+      ["caesar", [7, 2, "Sheet1"]],
+    ]
+    with_each_spreadsheet(options) do |oo|
+      assert_equal expected_labels, oo.labels, "error with labels array in class #{oo.class}"
+    end
+  end
+
+  def test_labeled_cells
+    options = { name: "named_cells", format: [:openoffice, :excelx, :libreoffice] }
+    with_each_spreadsheet(options) do |oo|
+      oo.default_sheet = oo.sheets.first
+      begin
+        row, col = oo.label("anton")
+      rescue ArgumentError
+        puts "labels error at #{oo.class}"
+        raise
+      end
+      assert_equal 5, row
+      assert_equal 3, col
+
+      row, col = oo.label("anton")
+      assert_equal "Anton", oo.cell(row, col)
+
+      row, col = oo.label("berta")
+      assert_equal "Bertha", oo.cell(row, col)
+
+      row, col = oo.label("caesar")
+      assert_equal "Cäsar", oo.cell(row, col)
+
+      row, col = oo.label("never")
+      assert_nil row
+      assert_nil col
+
+      row, col, sheet = oo.label("anton")
+      assert_equal 5, row
+      assert_equal 3, col
+      assert_equal "Sheet1", sheet
+
+      assert_equal "Anton", oo.anton
+      assert_raises(NoMethodError) do
+        row, col = oo.never
+      end
+
+      # Reihenfolge row, col,sheet analog zu #label
+      expected_labels = [
+        ["anton", [5, 3, "Sheet1"]],
+        ["berta", [4, 2, "Sheet1"]],
+        ["caesar", [7, 2, "Sheet1"]],
+      ]
+      assert_equal expected_labels, oo.labels, "error with labels array in class #{oo.class}"
+    end
+  end
+
+  def test_label
+    options = { name: "named_cells", format: [:openoffice, :excelx, :libreoffice] }
+    with_each_spreadsheet(options) do |oo|
+      begin
+        row, col = oo.label("anton")
+      rescue ArgumentError
+        puts "labels error at #{oo.class}"
+        raise
+      end
+
+      assert_equal 5, row, "error with label in class #{oo.class}"
+      assert_equal 3, col, "error with label in class #{oo.class}"
+
+      row, col = oo.label("anton")
+      assert_equal "Anton", oo.cell(row, col), "error with label in class #{oo.class}"
+
+      row, col = oo.label("berta")
+      assert_equal "Bertha", oo.cell(row, col), "error with label in class #{oo.class}"
+
+      row, col = oo.label("caesar")
+      assert_equal "Cäsar", oo.cell(row, col), "error with label in class #{oo.class}"
+
+      row, col = oo.label("never")
+      assert_nil row
+      assert_nil col
+
+      row, col, sheet = oo.label("anton")
+      assert_equal 5, row
+      assert_equal 3, col
+      assert_equal "Sheet1", sheet
+    end
+  end
+
+  def test_method_missing_anton
+    options = { name: "named_cells", format: [:openoffice, :excelx, :libreoffice] }
+    with_each_spreadsheet(options) do |oo|
+      # oo.default_sheet = oo.sheets.first
+      assert_equal "Anton", oo.anton
+      assert_raises(NoMethodError) do
+        oo.never
+      end
+    end
+  end
+end

data/test/helpers/test_sheets.rb

@@ -0,0 +1,55 @@
+# NOTE: Putting these tests into modules in order to share them across different
+#       test classes, i.e. both TestRooExcelx and TestRooOpenOffice should run
+#       sheet related tests.
+#
+#       This will allow me to reuse these test cases when I add new classes for
+#       Roo's future API.
+# Sheet related tests
+module TestSheets
+  def test_sheets
+    sheet_names = ["Tabelle1", "Name of Sheet 2", "Sheet3", "Sheet4", "Sheet5"]
+    with_each_spreadsheet(name: "numbers1") do |oo|
+      assert_equal sheet_names, oo.sheets
+      assert_raises(RangeError) { oo.default_sheet = "no_sheet" }
+      assert_raises(TypeError)  { oo.default_sheet = [1, 2, 3] }
+      oo.sheets.each do |sheet_name|
+        oo.default_sheet = sheet_name
+        assert_equal sheet_name, oo.default_sheet
+      end
+    end
+  end
+
+  def test_sheetname
+    bad_sheet_name = "non existing sheet name"
+    with_each_spreadsheet(name: "numbers1") do |oo|
+      oo.default_sheet = "Name of Sheet 2"
+      assert_equal "I am sheet 2", oo.cell("C", 5)
+      assert_raises(RangeError) { oo.default_sheet = bad_sheet_name }
+      assert_raises(RangeError) { oo.default_sheet = bad_sheet_name }
+      assert_raises(RangeError) { oo.cell("C", 5, bad_sheet_name) }
+      assert_raises(RangeError) { oo.celltype("C", 5, bad_sheet_name) }
+      assert_raises(RangeError) { oo.empty?("C", 5, bad_sheet_name) }
+      assert_raises(RangeError) { oo.formula?("C", 5, bad_sheet_name) }
+      assert_raises(RangeError) { oo.formula("C", 5, bad_sheet_name) }
+      assert_raises(RangeError) { oo.set("C", 5, 42, bad_sheet_name) }
+      assert_raises(RangeError) { oo.formulas(bad_sheet_name) }
+      assert_raises(RangeError) { oo.to_yaml({}, 1, 1, 1, 1, bad_sheet_name) }
+    end
+  end
+
+  def test_info_doesnt_set_default_sheet
+    sheet_name = "Sheet3"
+    with_each_spreadsheet(name: "numbers1") do |oo|
+      oo.default_sheet = sheet_name
+      oo.info
+      assert_equal sheet_name, oo.default_sheet
+    end
+  end
+
+  def test_bug_numbered_sheet_names
+    options = { name: "bug-numbered-sheet-names", format: :excelx }
+    with_each_spreadsheet(options) do |oo|
+      oo.each_with_pagename {}
+    end
+  end
+end

data/test/helpers/test_styles.rb

@@ -0,0 +1,62 @@
+module TestStyles
+  def test_cell_styles
+    # styles only valid in excel spreadsheets?
+    # TODO: what todo with other spreadsheet types
+    with_each_spreadsheet(name: "style", format: [:excelx]) do |oo|
+      # bold
+      assert_equal true, oo.font(1, 1).bold?
+      assert_equal false, oo.font(1, 1).italic?
+      assert_equal false, oo.font(1, 1).underline?
+
+      # italic
+      assert_equal false, oo.font(2, 1).bold?
+      assert_equal true, oo.font(2, 1).italic?
+      assert_equal false, oo.font(2, 1).underline?
+
+      # normal
+      assert_equal false, oo.font(3, 1).bold?
+      assert_equal false, oo.font(3, 1).italic?
+      assert_equal false, oo.font(3, 1).underline?
+
+      # underline
+      assert_equal false, oo.font(4, 1).bold?
+      assert_equal false, oo.font(4, 1).italic?
+      assert_equal true, oo.font(4, 1).underline?
+
+      # bold italic
+      assert_equal true, oo.font(5, 1).bold?
+      assert_equal true, oo.font(5, 1).italic?
+      assert_equal false, oo.font(5, 1).underline?
+
+      # bold underline
+      assert_equal true, oo.font(6, 1).bold?
+      assert_equal false, oo.font(6, 1).italic?
+      assert_equal true, oo.font(6, 1).underline?
+
+      # italic underline
+      assert_equal false, oo.font(7, 1).bold?
+      assert_equal true, oo.font(7, 1).italic?
+      assert_equal true, oo.font(7, 1).underline?
+
+      # bolded row
+      assert_equal true, oo.font(8, 1).bold?
+      assert_equal false, oo.font(8, 1).italic?
+      assert_equal false, oo.font(8, 1).underline?
+
+      # bolded col
+      assert_equal true, oo.font(9, 2).bold?
+      assert_equal false, oo.font(9, 2).italic?
+      assert_equal false, oo.font(9, 2).underline?
+
+      # bolded row, italic col
+      assert_equal true, oo.font(10, 3).bold?
+      assert_equal true, oo.font(10, 3).italic?
+      assert_equal false, oo.font(10, 3).underline?
+
+      # normal
+      assert_equal false, oo.font(11, 4).bold?
+      assert_equal false, oo.font(11, 4).italic?
+      assert_equal false, oo.font(11, 4).underline?
+    end
+  end
+end

data/test/roo/test_base.rb

@@ -0,0 +1,182 @@
+require "test_helper"
+
+class TestRooBase < Minitest::Test
+  def test_info
+    # NOTE: unfortunately, the ods and xlsx versions of numbers1 are not
+    #       identical, so this test fails for Open Office.
+    expected_templ = File.read("#{TESTDIR}/expected_results/numbers_info.yml")
+    with_each_spreadsheet(name: "numbers1", format: [:excelx]) do |workbook|
+      ext = get_extension(workbook)
+      expected = Kernel.format(expected_templ, ext)
+      assert_equal expected.strip, workbook.info.strip
+    end
+  end
+
+  def test_column
+    with_each_spreadsheet(name: "numbers1") do |workbook|
+      expected = [1.0, 5.0, nil, 10.0, Date.new(1961, 11, 21), "tata", nil, nil, nil, nil, "thisisa11", 41.0, nil, nil, 41.0, "einundvierzig", nil, Date.new(2007, 5, 31)]
+      assert_equal expected, workbook.column(1)
+      assert_equal expected, workbook.column("a")
+    end
+  end
+
+  def test_column_huge_document
+    skip_long_test
+    with_each_spreadsheet(name: "Bibelbund", format: [:openoffice, :excelx]) do |workbook|
+      workbook.default_sheet = workbook.sheets.first
+      assert_equal 3735, workbook.column("a").size
+    end
+  end
+
+  def test_simple_spreadsheet_find_by_condition
+    with_each_spreadsheet(name: "simple_spreadsheet") do |workbook|
+      workbook.header_line = 3
+      results = workbook.find(:all, conditions: { "Comment" => "Task 1" })
+      assert_equal Date.new(2007, 05, 07), results[1]["Date"]
+      assert_equal 10.75, results[1]["Start time"]
+      assert_equal 12.50, results[1]["End time"]
+      assert_equal 0, results[1]["Pause"]
+      assert_equal 1.75, results[1]["Sum"]
+      assert_equal "Task 1", results[1]["Comment"]
+    end
+  end
+
+  def test_bug_bbu
+    expected_templ = File.read("#{TESTDIR}/expected_results/bbu_info.txt")
+    with_each_spreadsheet(name: "bbu", format: [:openoffice, :excelx]) do |workbook|
+      ext = get_extension(workbook)
+      expected_result = Kernel.format(expected_templ, ext)
+      assert_equal expected_result.strip, workbook.info.strip
+
+      workbook.default_sheet = workbook.sheets[1] # empty sheet
+      assert_nil workbook.first_row
+      assert_nil workbook.last_row
+      assert_nil workbook.first_column
+      assert_nil workbook.last_column
+    end
+  end
+
+  def test_find_by_row_huge_document
+    skip_long_test
+    options = { name: "Bibelbund", format: [:openoffice, :excelx] }
+    with_each_spreadsheet(options) do |workbook|
+      workbook.default_sheet = workbook.sheets.first
+      result = workbook.find 20
+      assert result
+      assert_equal "Brief aus dem Sekretariat", result[0]
+
+      result = workbook.find 22
+      assert result
+      assert_equal "Brief aus dem Skretariat. Tagung in Amberg/Opf.", result[0]
+    end
+  end
+
+  def test_find_by_row
+    with_each_spreadsheet(name: "numbers1") do |workbook|
+      workbook.header_line = nil
+      result = workbook.find 16
+      assert result
+      assert_nil workbook.header_line
+      # keine Headerlines in diesem Beispiel definiert
+      assert_equal "einundvierzig", result[0]
+      # assert_equal false, results
+      result = workbook.find 15
+      assert result
+      assert_equal 41, result[0]
+    end
+  end
+
+  def test_find_by_row_if_header_line_is_not_nil
+    with_each_spreadsheet(name: "numbers1") do |workbook|
+      workbook.header_line = 2
+      refute_nil workbook.header_line
+      results = workbook.find 1
+      assert results
+      assert_equal 5, results[0]
+      assert_equal 6, results[1]
+      results = workbook.find 15
+      assert results
+      assert_equal "einundvierzig", results[0]
+    end
+  end
+
+  def test_find_by_conditions
+    skip_long_test
+    expected_results = [
+      {
+        "VERFASSER" => "Almassy, Annelene von",
+        "INTERNET" => nil,
+        "SEITE" => 316.0,
+        "KENNUNG" => "Aus dem Bibelbund",
+        "OBJEKT" => "Bibel+Gem",
+        "PC" => "#C:\\Bibelbund\\reprint\\BuG1982-3.pdf#",
+        "NUMMER" => "1982-3",
+        "TITEL" => "Brief aus dem Sekretariat"
+      },
+      {
+        "VERFASSER" => "Almassy, Annelene von",
+        "INTERNET" => nil,
+        "SEITE" => 222.0,
+        "KENNUNG" => "Aus dem Bibelbund",
+        "OBJEKT" => "Bibel+Gem",
+        "PC" => "#C:\\Bibelbund\\reprint\\BuG1983-2.pdf#",
+        "NUMMER" => "1983-2",
+        "TITEL" => "Brief aus dem Sekretariat"
+      }
+    ]
+
+    expected_results_size = 2
+    options = { name: "Bibelbund", format: [:openoffice, :excelx] }
+    with_each_spreadsheet(options) do |workbook|
+      results = workbook.find(:all, conditions: { "TITEL" => "Brief aus dem Sekretariat" })
+      assert_equal expected_results_size, results.size
+      assert_equal expected_results, results
+
+      conditions = {
+        "TITEL" => "Brief aus dem Sekretariat",
+        "VERFASSER" => "Almassy, Annelene von"
+      }
+      results = workbook.find(:all, conditions: conditions)
+      assert_equal expected_results, results
+      assert_equal expected_results_size, results.size
+
+      results = workbook.find(:all, conditions: { "VERFASSER" => "Almassy, Annelene von" })
+      assert_equal 13, results.size
+    end
+  end
+
+  def test_find_by_conditions_with_array_option
+    expected_results = [
+      [
+        "Brief aus dem Sekretariat",
+        "Almassy, Annelene von",
+        "Bibel+Gem",
+        "1982-3",
+        316.0,
+        nil,
+        "#C:\\Bibelbund\\reprint\\BuG1982-3.pdf#",
+        "Aus dem Bibelbund",
+      ],
+      [
+        "Brief aus dem Sekretariat",
+        "Almassy, Annelene von",
+        "Bibel+Gem",
+        "1983-2",
+        222.0,
+        nil,
+        "#C:\\Bibelbund\\reprint\\BuG1983-2.pdf#",
+        "Aus dem Bibelbund",
+      ]
+    ]
+    options = { name: "Bibelbund", format: [:openoffice, :excelx] }
+    with_each_spreadsheet(options) do |workbook|
+      conditions = {
+        "TITEL" => "Brief aus dem Sekretariat",
+        "VERFASSER" => "Almassy, Annelene von"
+      }
+      results = workbook.find(:all, conditions: conditions, array: true)
+      assert_equal 2, results.size
+      assert_equal expected_results, results
+    end
+  end
+end

data/test/roo/test_csv.rb

@@ -0,0 +1,88 @@
+require "test_helper"
+
+class TestRooCSV < Minitest::Test
+  def test_sheets
+    file = filename("numbers1")
+    workbook = roo_class.new(File.join(TESTDIR, file))
+    assert_equal ["default"], workbook.sheets
+    assert_raises(RangeError) { workbook.default_sheet = "no_sheet" }
+    assert_raises(TypeError)  { workbook.default_sheet = [1, 2, 3] }
+    workbook.sheets.each do |sh|
+      workbook.default_sheet = sh
+      assert_equal sh, workbook.default_sheet
+    end
+  end
+
+  def test_download_uri_with_query_string
+    file = filename("simple_spreadsheet")
+    port = 12_347
+    url = "#{local_server(port)}/#{file}?query-param=value"
+
+    start_local_server(file, port) do
+      csv = roo_class.new(url)
+      assert_equal "Task 1", csv.cell("f", 4)
+      assert_equal 1, csv.first_row
+      assert_equal 13, csv.last_row
+      assert_equal 1, csv.first_column
+      assert_equal 6, csv.last_column
+    end
+  end
+
+  def test_open_stream
+    file = filename("Bibelbund")
+    file_contents = File.read File.join(TESTDIR, file)
+    stream = StringIO.new(file_contents)
+    csv = roo_class.new(stream)
+
+    assert_equal "Aktuelle Seite", csv.cell("h", 12)
+    assert_equal 1, csv.first_row
+    assert_equal 3735, csv.last_row
+    assert_equal 1, csv.first_column
+    assert_equal 8, csv.last_column
+  end
+
+  def test_nil_rows_and_lines_csv
+    # x_123
+    oo = Roo::CSV.new(File.join(TESTDIR,'Bibelbund.csv'))
+    oo.default_sheet = oo.sheets.first
+    assert_equal 1, oo.first_row
+    assert_equal 3735, oo.last_row
+    assert_equal 1, oo.first_column
+    assert_equal 8, oo.last_column
+  end
+
+  def test_empty_csv
+    # x_123
+    oo = Roo::CSV.new(File.join(TESTDIR,'emptysheets.csv'))
+    oo.default_sheet = oo.sheets.first
+    assert_equal 1, oo.first_row
+    assert_equal 1, oo.last_row
+    assert_equal 1, oo.first_column
+    assert_equal 1, oo.last_column
+  end
+
+  def test_csv_parsing_with_headers
+    return unless CSV
+    headers = ["TITEL", "VERFASSER", "OBJEKT", "NUMMER", "SEITE", "INTERNET", "PC", "KENNUNG"]
+
+    oo = Roo::Spreadsheet.open(File.join(TESTDIR, "Bibelbund.csv"))
+    parsed = oo.parse(headers: true)
+    assert_equal headers, parsed[1].keys
+  end
+
+  def test_iso_8859_1
+    file = File.open(File.join(TESTDIR, "iso_8859_1.csv"))
+    options = { csv_options: { col_sep: ";", encoding: Encoding::ISO_8859_1 } }
+    workbook = Roo::CSV.new(file.path, options)
+    result = workbook.last_column
+    assert_equal(19, result)
+  end
+
+  def roo_class
+    Roo::CSV
+  end
+
+  def filename(name)
+    "#{name}.csv"
+  end
+end