roo 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 416c34282c125b08fbf46e19c398f6a1c07d269a
-  data.tar.gz: 56a97234a7ddef8c1cd8aa0aa308949bc9f00d52
+  metadata.gz: 711650fb2132509af1a6df5cd4b5a3d83eaac68f
+  data.tar.gz: ca23282af485cfa63d4b4a761d4081841edd385c
 SHA512:
-  metadata.gz: 8d318576088c9fd269ffc3702c38aa00f9bca4bddf97f1125d0d289c9674b0bae4136dbf43b70f635bba8f597d14bd22894b739e5306ec0690aa244638a374dd
-  data.tar.gz: a578beb4286e83f6a308aac442bc39bc829badc7ff35d9b0b6914550ccf587106cfbcc9974c51c957d8c16cf08dacabdf7383be1170f91ed207834035a302d8a
+  metadata.gz: 7166103bc551a008905e6052369ed5cf714bd949d83021e3596cef8ae083fccead0faac1b28591bf28b09f977202955c4f2e92fda45a5961475eff4ea3caa93e
+  data.tar.gz: dc030d1d1530114289e8a420283fdf3131759ee107dfaa17bcc35c098e5d0e8b74fe984dc655b72a2701b211e3af3442f3cd79f0ad07e9cf1e7587496cfc7a16

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## [2.7.1] 2017-01-03
+### Fixed
+- Fixed regression where a CSV's encoding was being ignored [372](https://github.com/roo-rb/roo/pull/372)
+
 ## [2.7.0] 2016-12-31
 ### Fixed
 - Added rack server for testing Roo's download capabilities [365](https://github.com/roo-rb/roo/pull/365)

data/README.md

@@ -18,7 +18,7 @@ Install as a gem
 Or add it to your Gemfile
 
 ```ruby
-gem "roo", "~> 2.6.0"
+gem "roo", "~> 2.7.0"
 ```
 ## Usage
 
@@ -266,6 +266,9 @@ Roo's public methods have stayed relatively consistent between 1.13.x and 2.0.0,
 Roo uses Minitest and RSpec. The best of both worlds! Run `bundle exec rake` to
 run the tests/examples.
 
+You can run the tests/examples with Rspec like reporters by running
+`USE_REPORTERS=true bundle exec rake`
+
 Roo also has a few tests that take a long time (5+ seconds). To run these, use
 `LONG_RUN=true bundle exec rake`
 

data/lib/roo/base.rb

@@ -297,12 +297,11 @@ class Roo::Base
   end
 
   def parse(options = {})
-    ary = []
-    each(options) do |row|
-      yield(row) if block_given?
-      ary << row
+    results = each(options).map do |row|
+      block_given? ? yield(row) : row
     end
-    ary
+
+    options[:headers] == true ? results : results.drop(1)
   end
 
   def row_with(query, return_headers = false)

data/lib/roo/csv.rb

@@ -98,7 +98,7 @@ module Roo
 
     def set_row_count(sheet)
       @first_row[sheet] = 1
-      @last_row[sheet] = ::CSV.readlines(@filename).size
+      @last_row[sheet] = ::CSV.readlines(@filename, csv_options).size
       @last_row[sheet] = @first_row[sheet] if @last_row[sheet].zero?
 
       nil
@@ -106,7 +106,7 @@ module Roo
 
     def set_column_count(sheet)
       @first_column[sheet] = 1
-      @last_column[sheet] = (::CSV.readlines(@filename).first || []).size
+      @last_column[sheet] = (::CSV.readlines(@filename, csv_options).first || []).size
       @last_column[sheet] = @first_column[sheet] if @last_column[sheet].zero?
 
       nil

data/lib/roo/version.rb

@@ -1,3 +1,3 @@
 module Roo
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

data/spec/spec_helper.rb

@@ -5,5 +5,5 @@ require 'helpers'
 RSpec.configure do |c|
   c.include Helpers
   c.color = true
-  c.formatter = :documentation
+  c.formatter = :documentation if ENV["USE_REPORTERS"]
 end

data/test/formatters/test_csv.rb

@@ -44,7 +44,7 @@ class TestRooFormatterCSV < Minitest::Test
   # wird.
   # Besser: Methode um temporaeres Dir. portabel zu bestimmen
   def test_huge_document_to_csv
-    skip unless ENV["LONG_RUN"]
+    skip_long_test
 
     original_csv_path = File.join(TESTDIR, "Bibelbund.csv")
     with_each_spreadsheet(name: "Bibelbund", format: [:openoffice, :excelx]) do |workbook|
@@ -71,7 +71,7 @@ class TestRooFormatterCSV < Minitest::Test
   end
 
   def test_bug_quotes_excelx
-    skip unless ENV["LONG_RUN"]
+    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

data/test/formatters/test_xml.rb

@@ -3,20 +3,23 @@ require "test_helper"
 class TestRooFormatterXML < Minitest::Test
   def test_to_xml
     expected_sheet_count = 5
-    with_each_spreadsheet(name: "numbers1", encoding: "utf8") do |workbook|
+    options = { name: "numbers1", encoding: "utf8" }
+    with_each_spreadsheet(options) do |workbook|
       skip if defined? JRUBY_VERSION
       workbook.to_xml
       sheetname = workbook.sheets.first
       doc = Nokogiri::XML(workbook.to_xml)
-      all_cells = init_all_cells(workbook, sheetname)
 
       assert_equal expected_sheet_count, doc.xpath("//spreadsheet/sheet").count
 
       doc.xpath("//spreadsheet/sheet").each do |xml_sheet|
-        assert_equal sheetname, xml_sheet.attributes["name"].value
-        xml_sheet.children.each_with_index do |cell, i|
-          next unless cell.attributes["name"]
+        all_cells = init_all_cells(workbook, sheetname)
+        cells = xml_sheet.children.reject(&:text?)
 
+        assert_equal sheetname, xml_sheet.attribute("name").value
+        assert_equal all_cells.size, cells.size
+
+        cells.each_with_index do |cell, i|
           expected = [
             all_cells[i][:row],
             all_cells[i][:column],
@@ -24,11 +27,12 @@ class TestRooFormatterXML < Minitest::Test
             all_cells[i][:type],
           ]
           result = [
-            cell.attributes["row"],
-            cell.attributes["column"],
-            cell.content,
-            cell.attributes["type"],
+            cell.attribute("row").value,
+            cell.attribute("column").value,
+            cell.text,
+            cell.attribute("type").value,
           ]
+
           assert_equal expected, result
         end # end of sheet
         sheetname = workbook.sheets[workbook.sheets.index(sheetname) + 1]

data/test/helpers/test_accessing_files.rb

@@ -0,0 +1,60 @@
+# 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_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