roo 1.13.2 → 2.0.1

data/spec/lib/roo/utils_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+RSpec.describe ::Roo::Utils do
+  subject { described_class }
+
+  context '#number_to_letter' do
+    ('A'..'Z').to_a.each_with_index do |letter, index|
+      it "should return '#{ letter }' when passed #{ index + 1 }" do
+        expect(described_class.number_to_letter(index + 1)).to eq(letter)
+      end
+    end
+
+    {
+      27 => 'AA', 26*2 => 'AZ', 26*3 => 'BZ', 26**2 + 26 => 'ZZ', 26**2 + 27 => 'AAA',
+      26**3 + 26**2 + 26 => 'ZZZ', 1.0 => 'A', 676 => 'YZ', 677 => 'ZA'
+    }.each do |key, value|
+      it "should return '#{value}' when passed #{key}" do
+        expect(described_class.number_to_letter(key)).to eq(value)
+      end
+    end
+  end
+
+  context '#letter_to_number' do
+    it "should give 1 for 'A' and 'a'" do
+      expect(described_class.letter_to_number('A')).to eq(1)
+      expect(described_class.letter_to_number('a')).to eq(1)
+    end
+
+    it "should give the correct value for 'Z'" do
+      expect(described_class.letter_to_number('Z')).to eq(26)
+    end
+
+    it "should give the correct value for 'AA' regardless of case mixing" do
+      %w(AA aA Aa aa).each do |key|
+        expect(described_class.letter_to_number(key)).to eq(27)
+      end
+    end
+
+    { 'AB' => 28, 'AZ' => 26*2, 'BZ' => 26*3, 'ZZ' => 26**2 + 26 }.each do |key, value|
+      it "should give the correct value for '#{key}'" do
+        expect(described_class.letter_to_number(key)).to eq(value)
+      end
+    end
+  end
+
+  context '.split_coordinate' do
+    it "returns the expected result" do
+      expect(described_class.split_coordinate('A1')).to eq [1, 1]
+      expect(described_class.split_coordinate('B2')).to eq [2, 2]
+      expect(described_class.split_coordinate('R2')).to eq [2, 18]
+      expect(described_class.split_coordinate('AR31')).to eq [31, 18 + 26]
+    end
+  end
+
+  context '.split_coord' do
+    it "returns the expected result" do
+      expect(described_class.split_coord('A1')).to eq ["A", 1]
+      expect(described_class.split_coord('B2')).to eq ["B", 2]
+      expect(described_class.split_coord('R2')).to eq ["R", 2]
+      expect(described_class.split_coord('AR31')).to eq ["AR", 31]
+    end
+
+    it "raises an error when appropriate" do
+      expect { described_class.split_coord('A') }.to raise_error(ArgumentError)
+      expect { described_class.split_coord('2') }.to raise_error(ArgumentError)
+    end
+  end
+
+
+  context '.num_cells_in_range' do
+    it "returns the expected result" do
+      expect(described_class.num_cells_in_range('A1:B2')).to eq 4
+      expect(described_class.num_cells_in_range('B2:E3')).to eq 8
+      expect(described_class.num_cells_in_range('R2:Z10')).to eq 81
+      expect(described_class.num_cells_in_range('AR31:AR32')).to eq 2
+      expect(described_class.num_cells_in_range('A1')).to eq 1
+    end
+
+    it "raises an error when appropriate" do
+      expect { described_class.num_cells_in_range('A1:B1:B2') }.to raise_error(ArgumentError)
+    end
+  end
+
+  context '.load_xml' do
+    it 'returns the expected result' do
+      expect(described_class.load_xml('test/files/sheet1.xml')).to be_a(Nokogiri::XML::Document)
+      expect(described_class.load_xml('test/files/sheet1.xml').
+                 remove_namespaces!.xpath("/worksheet/dimension").map do |dim|
+                  dim.attributes["ref"].value end.first).to eq "A1:B11"
+    end
+  end
+
+  context '.each_element' do
+    it 'returns the expected result' do
+      described_class.each_element('test/files/sheet1.xml', 'dimension') do |dim|
+        expect(dim.attributes["ref"].value).to eq "A1:B11"
+      end
+      rows = []
+      described_class.each_element('test/files/sheet1.xml', 'row') do |row|
+        rows << row
+      end
+      expect(rows.size).to eq 11
+      expect(rows[2].attributes["r"].value).to eq "3"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
-require File.expand_path("../../lib/roo", __FILE__)
+require 'simplecov'
+require 'roo'
 
 require 'vcr'
 

data/test/test_generic_spreadsheet.rb

@@ -1,124 +1,68 @@
 # -*- encoding: utf-8 -*-
 require File.dirname(__FILE__) + '/test_helper'
 
-class TestBase < Test::Unit::TestCase
-
+class TestBase < Minitest::Test
   def setup
     @klass = Class.new(Roo::Base) do
-      def initialize(filename='some_file')
+      def initialize(filename = 'some_file')
         super
         @filename = filename
       end
 
-      def read_cells(sheet=nil)
+      def read_cells(sheet = nil)
         @cells_read[sheet] = true
       end
 
-      def cell(row, col, sheet=nil)
-        sheet ||= @default_sheet
-        @cell[sheet][[row,col]]
+      def cell(row, col, sheet = nil)
+        sheet ||= default_sheet
+        @cell[sheet][[row, col]]
       end
 
-      def celltype(row, col, sheet=nil)
-        sheet ||= @default_sheet
-        @cell_type[sheet][[row,col]]
+      def celltype(row, col, sheet = nil)
+        sheet ||= default_sheet
+        @cell_type[sheet][[row, col]]
       end
 
       def sheets
-        ['my_sheet','blank sheet']
+        ['my_sheet', 'blank sheet']
       end
     end
     @oo = @klass.new
     setup_test_sheet(@oo)
   end
 
-  context 'Roo::Base.letter_to_number(letter)' do
-    should "give us 1 for 'A' and 'a'" do
-      assert_equal 1, Roo::Base.letter_to_number('A')
-      assert_equal 1, Roo::Base.letter_to_number('a')
-    end
-
-    should "give us the correct value for 'Z'" do
-      assert_equal 26, Roo::Base.letter_to_number('Z')
-    end
-
-    should "give us the correct value for 'AA' regardless of case mixing" do
-      assert_equal 27, Roo::Base.letter_to_number('AA')
-      assert_equal 27, Roo::Base.letter_to_number('aA')
-      assert_equal 27, Roo::Base.letter_to_number('Aa')
-      assert_equal 27, Roo::Base.letter_to_number('aa')
-    end
-
-    should "give us the correct value for 'AB'" do
-      assert_equal 28, Roo::Base.letter_to_number('AB')
-    end
-
-    should "give us the correct value for 'AZ'" do
-      assert_equal 26*2, Roo::Base.letter_to_number('AZ')
+  context 'private method Roo::Base.uri?(filename)' do
+    should 'return true when passed a filename starts with http(s)://' do
+      assert_equal true, @oo.send(:uri?, 'http://example.com/')
+      assert_equal true, @oo.send(:uri?, 'https://example.com/')
     end
 
-    should "give us the correct value for 'BZ'" do
-      assert_equal 26*3, Roo::Base.letter_to_number('BZ')
+    should 'return false when passed a filename which does not start with http(s)://' do
+      assert_equal false, @oo.send(:uri?, 'example.com')
     end
 
-    should "give us the correct value for 'ZZ'" do
-      assert_equal 26**2 + 26,Roo::Base.letter_to_number('ZZ')
-    end
-  end
-
-  context "Roo::Base.number_to_letter" do
-    Roo::Base::LETTERS.each_with_index do |l,i|
-      should "return '#{l}' when passed #{i+1}" do
-        assert_equal l,Roo::Base.number_to_letter(i+1)
-      end
-    end
-
-    should "return 'AA' when passed 27" do
-      assert_equal 'AA',Roo::Base.number_to_letter(27)
-    end
-
-    should "return 'AZ' when passed #{26*2}" do
-      assert_equal 'AZ', Roo::Base.number_to_letter(26*2)
-    end
-
-    should "return 'BZ' when passed #{26*3}" do
-      assert_equal 'BZ', Roo::Base.number_to_letter(26*3)
-    end
-
-    should "return 'ZZ' when passed #{26**2 + 26}" do
-      assert_equal 'ZZ',Roo::Base.number_to_letter(26**2 + 26)
-    end
-
-    should "return 'AAA' when passed #{26**2 + 27}" do
-      assert_equal 'AAA',Roo::Base.number_to_letter(26**2 + 27)
-    end
-
-    should "return 'ZZZ' when passed #{26**3 + 26**2 + 26}" do
-      assert_equal 'ZZZ',Roo::Base.number_to_letter(26**3 + 26**2 + 26)
-    end
-
-    should "return the correct letter when passed a Float" do
-      assert_equal 'A',Roo::Base.number_to_letter(1.0)
+    should 'return false when passed non-String object such as Tempfile' do
+      assert_equal false, @oo.send(:uri?, Tempfile.new('test'))
     end
   end
 
   def test_setting_invalid_type_does_not_update_cell
-    @oo.set(1,1,1)
-    assert_raise(ArgumentError){@oo.set(1,1, :invalid_type)}
-    assert_equal 1, @oo.cell(1,1)
-    assert_equal :float, @oo.celltype(1,1)
+    @oo.set(1, 1, 1)
+    assert_raises(ArgumentError) { @oo.set(1, 1, :invalid_type) }
+    assert_equal 1, @oo.cell(1, 1)
+    assert_equal :float, @oo.celltype(1, 1)
   end
 
   def test_first_row
-    assert_equal 5,@oo.first_row
+    assert_equal 5, @oo.first_row
   end
 
   def test_last_row
-    assert_equal 16,@oo.last_row
+    assert_equal 16, @oo.last_row
   end
 
   def test_first_column
-    assert_equal 1,@oo.first_column
+    assert_equal 1, @oo.first_column
   end
 
   def test_first_column_as_letter
@@ -133,17 +77,16 @@ class TestBase < Test::Unit::TestCase
     assert_equal 'G', @oo.last_column_as_letter
   end
 
-  #TODO: inkonsequente Lieferung Fixnum/Float
   def test_rows
-    assert_equal [41.0,42.0,43.0,44.0,45.0, nil, nil], @oo.row(12)
-    assert_equal [nil, nil, "dreiundvierzig", "vierundvierzig", "fuenfundvierzig", nil, nil], @oo.row(16)
+    assert_equal [41.0, 42.0, 43.0, 44.0, 45.0, nil, nil], @oo.row(12)
+    assert_equal [nil, '"Hello world!"', 'dreiundvierzig', 'vierundvierzig', 'fuenfundvierzig', nil, nil], @oo.row(16)
   end
 
   def test_empty_eh
-    assert @oo.empty?(1,1)
-    assert !@oo.empty?(8,3)
-    assert @oo.empty?("A",11)
-    assert !@oo.empty?("A",12)
+    assert @oo.empty?(1, 1)
+    assert !@oo.empty?(8, 3)
+    assert @oo.empty?('A', 11)
+    assert !@oo.empty?('A', 12)
   end
 
   def test_reload
@@ -151,31 +94,43 @@ class TestBase < Test::Unit::TestCase
     assert @oo.instance_variable_get(:@cell).empty?
   end
 
+  def test_each
+    oo_each = @oo.each
+    assert_instance_of Enumerator, oo_each
+    assert_equal [nil, '"Hello world!"', 'dreiundvierzig', 'vierundvierzig', 'fuenfundvierzig', nil, nil], oo_each.to_a.last
+  end
+
   def test_to_yaml
-    assert_equal "--- \n"+yaml_entry(5,1,"date","1961-11-21"), @oo.to_yaml({}, 5,1,5,1)
-    assert_equal "--- \n"+yaml_entry(8,3,"string","thisisc8"), @oo.to_yaml({}, 8,3,8,3)
-    assert_equal "--- \n"+yaml_entry(12,3,"float",43.0), @oo.to_yaml({}, 12,3,12,3)
+    assert_equal "--- \n" + yaml_entry(5, 1, 'date', '1961-11-21'), @oo.to_yaml({}, 5, 1, 5, 1)
+    assert_equal "--- \n" + yaml_entry(8, 3, 'string', 'thisisc8'), @oo.to_yaml({}, 8, 3, 8, 3)
+    assert_equal "--- \n" + yaml_entry(12, 3, 'float', 43.0), @oo.to_yaml({}, 12, 3, 12, 3)
     assert_equal \
-      "--- \n"+yaml_entry(12,3,"float",43.0) +
-      yaml_entry(12,4,"float",44.0) +
-      yaml_entry(12,5,"float",45.0), @oo.to_yaml({}, 12,3,12)
+      "--- \n" + yaml_entry(12, 3, 'float', 43.0) +
+        yaml_entry(12, 4, 'float', 44.0) +
+        yaml_entry(12, 5, 'float', 45.0), @oo.to_yaml({}, 12, 3, 12)
     assert_equal \
-      "--- \n"+yaml_entry(12,3,"float",43.0)+
-      yaml_entry(12,4,"float",44.0)+
-      yaml_entry(12,5,"float",45.0)+
-      yaml_entry(15,3,"float",43.0)+
-      yaml_entry(15,4,"float",44.0)+
-      yaml_entry(15,5,"float",45.0)+
-      yaml_entry(16,3,"string","dreiundvierzig")+
-      yaml_entry(16,4,"string","vierundvierzig")+
-      yaml_entry(16,5,"string","fuenfundvierzig"), @oo.to_yaml({}, 12,3)
+      "--- \n" + yaml_entry(12, 3, 'float', 43.0) +
+        yaml_entry(12, 4, 'float', 44.0) +
+        yaml_entry(12, 5, 'float', 45.0) +
+        yaml_entry(15, 3, 'float', 43.0) +
+        yaml_entry(15, 4, 'float', 44.0) +
+        yaml_entry(15, 5, 'float', 45.0) +
+        yaml_entry(16, 3, 'string', 'dreiundvierzig') +
+        yaml_entry(16, 4, 'string', 'vierundvierzig') +
+        yaml_entry(16, 5, 'string', 'fuenfundvierzig'), @oo.to_yaml({}, 12, 3)
   end
 
   def test_to_csv
-    assert_equal expected_csv,@oo.to_csv
+    assert_equal expected_csv, @oo.to_csv
   end
-protected
-  def setup_test_sheet(workbook=nil)
+
+  def test_to_csv_with_separator
+    assert_equal expected_csv_with_semicolons, @oo.to_csv(nil, ';')
+  end
+
+  protected
+
+  def setup_test_sheet(workbook = nil)
     workbook ||= @oo
     set_sheet_values(workbook)
     set_sheet_types(workbook)
@@ -184,68 +139,70 @@ protected
 
   def set_sheet_values(workbook)
     workbook.instance_variable_get(:@cell)[workbook.default_sheet] = {
-      [5,1] => Date.civil(1961,11,21).to_s,
+      [5, 1] => Date.civil(1961, 11, 21).to_s,
 
-      [8,3] => "thisisc8",
-      [8,7] => "thisisg8",
+      [8, 3] => 'thisisc8',
+      [8, 7] => 'thisisg8',
 
-      [12,1] => 41.0,
-      [12,2] => 42.0,
-      [12,3] => 43.0,
-      [12,4] => 44.0,
-      [12,5] => 45.0,
+      [12, 1] => 41.0,
+      [12, 2] => 42.0,
+      [12, 3] => 43.0,
+      [12, 4] => 44.0,
+      [12, 5] => 45.0,
 
-      [15,3] => 43.0,
-      [15,4] => 44.0,
-      [15,5] => 45.0,
+      [15, 3] => 43.0,
+      [15, 4] => 44.0,
+      [15, 5] => 45.0,
 
-      [16,3] => "dreiundvierzig",
-      [16,4] => "vierundvierzig",
-      [16,5] => "fuenfundvierzig"
+      [16, 2] => '"Hello world!"',
+      [16, 3] => 'dreiundvierzig',
+      [16, 4] => 'vierundvierzig',
+      [16, 5] => 'fuenfundvierzig'
     }
   end
 
   def set_sheet_types(workbook)
     workbook.instance_variable_get(:@cell_type)[workbook.default_sheet] = {
-      [5,1] => :date,
+      [5, 1] => :date,
 
-      [8,3] => :string,
-      [8,7] => :string,
+      [8, 3] => :string,
+      [8, 7] => :string,
 
-      [12,1] => :float,
-      [12,2] => :float,
-      [12,3] => :float,
-      [12,4] => :float,
-      [12,5] => :float,
+      [12, 1] => :float,
+      [12, 2] => :float,
+      [12, 3] => :float,
+      [12, 4] => :float,
+      [12, 5] => :float,
 
-      [15,3] => :float,
-      [15,4] => :float,
-      [15,5] => :float,
+      [15, 3] => :float,
+      [15, 4] => :float,
+      [15, 5] => :float,
 
-      [16,3] => :string,
-      [16,4] => :string,
-      [16,5] => :string,
+      [16, 2] => :string,
+      [16, 3] => :string,
+      [16, 4] => :string,
+      [16, 5] => :string
     }
   end
 
   def set_first_row(workbook)
     row_hash = workbook.instance_variable_get(:@first_row)
-    row_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map{|k,v| k[0]}.min
+    row_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map { |k, _v| k[0] }.min
   end
 
   def set_last_row(workbook)
     row_hash = workbook.instance_variable_get(:@last_row)
-    row_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map{|k,v| k[0]}.max
+    row_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map { |k, _v| k[0] }.max
   end
 
   def set_first_col(workbook)
     col_hash = workbook.instance_variable_get(:@first_column)
-    col_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map{|k,v| k[1]}.min
+    col_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map { |k, _v| k[1] }.min
   end
 
   def set_last_col(workbook)
     col_hash = workbook.instance_variable_get(:@last_column)
-    col_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map{|k,v| k[1]}.max
+    col_hash[workbook.default_sheet] = workbook.instance_variable_get(:@cell)[workbook.default_sheet].map { |k, _v| k[1] }.max
   end
 
   def set_cells_read(workbook)
@@ -254,6 +211,27 @@ protected
   end
 
   def expected_csv
-    ",,,,,,\n,,,,,,\n,,,,,,\n,,,,,,\n1961-11-21,,,,,,\n,,,,,,\n,,,,,,\n,,\"thisisc8\",,,,\"thisisg8\"\n,,,,,,\n,,,,,,\n,,,,,,\n41,42,43,44,45,,\n,,,,,,\n,,,,,,\n,,43,44,45,,\n,,\"dreiundvierzig\",\"vierundvierzig\",\"fuenfundvierzig\",,\n"
+    <<EOS
+,,,,,,
+,,,,,,
+,,,,,,
+,,,,,,
+1961-11-21,,,,,,
+,,,,,,
+,,,,,,
+,,"thisisc8",,,,"thisisg8"
+,,,,,,
+,,,,,,
+,,,,,,
+41,42,43,44,45,,
+,,,,,,
+,,,,,,
+,,43,44,45,,
+,"""Hello world!""","dreiundvierzig","vierundvierzig","fuenfundvierzig",,
+EOS
+  end
+
+  def expected_csv_with_semicolons
+    expected_csv.gsub(/\,/, ';')
   end
 end

data/test/test_helper.rb

@@ -1,30 +1,20 @@
+require 'simplecov'
 # require deps
 require 'tmpdir'
 require 'fileutils'
-require 'test/unit'
+require 'minitest/autorun'
 require 'shoulda'
 require 'fileutils'
 require 'timeout'
 require 'logger'
 require 'date'
-require 'webmock/test_unit'
+require 'webmock/minitest'
 
 # require gem files
-require File.dirname(__FILE__) + '/../lib/roo'
+require 'roo'
 
 TESTDIR =  File.join(File.dirname(__FILE__), 'files')
 
-LOG_DIR = File.join(File.dirname(__FILE__),'../log')
-FileUtils.mkdir_p(LOG_DIR)
-
-LOG_FILE = File.join(LOG_DIR,'roo_test.log')
-$log = Logger.new(LOG_FILE)
-
-#$log.level = Logger::WARN
-$log.level = Logger::DEBUG
-
-DISPLAY_LOG = false
-
 # very simple diff implementation
 # output is an empty string if the files are equal
 # otherwise differences a printen (not compatible to
@@ -47,7 +37,7 @@ def file_diff(fn1,fn2)
       if f2.eof? == false
         while f2.eof? == false
           line2 = f2.gets
-          result ">#{line2}\n"
+          result << ">#{line2}\n"
         end
       end
     end
@@ -55,6 +45,10 @@ def file_diff(fn1,fn2)
   result
 end
 
+def yaml_entry(row,col,type,value)
+  "cell_#{row}_#{col}: \n  row: #{row} \n  col: #{col} \n  celltype: #{type} \n  value: #{value} \n"
+end
+
 class File
   def File.delete_if_exist(filename)
     if File.exist?(filename)
@@ -62,44 +56,3 @@ class File
     end
   end
 end
-
-class Test::Unit::TestCase
-  def key_of(spreadsheetname)
-    {
-      #'formula' => 'rt4Pw1WmjxFtyfrqqy94wPw',
-      'formula' => 'o10837434939102457526.3022866619437760118',
-      #"write.me" => 'r6m7HFlUOwst0RTUTuhQ0Ow',
-      "write.me" => '0AkCuGANLc3jFcHR1NmJiYWhOWnBZME4wUnJ4UWJXZHc',
-      #'numbers1' => "rYraCzjxTtkxw1NxHJgDU8Q",
-      'numbers1' => 'o10837434939102457526.4784396906364855777',
-      #'borders' => "r_nLYMft6uWg_PT9Rc2urXw",
-      'borders' => "o10837434939102457526.664868920231926255",
-      #'simple_spreadsheet' => "r3aMMCBCA153TmU_wyIaxfw",
-      'simple_spreadsheet' => "ptu6bbahNZpYe-L1vEBmgGA",
-      'testnichtvorhandenBibelbund.ods' => "invalidkeyforanyspreadsheet", # !!! intentionally false key
-      #"only_one_sheet" => "rqRtkcPJ97nhQ0m9ksDw2rA",
-      "only_one_sheet" => "o10837434939102457526.762705759906130135",
-      #'time-test' => 'r2XfDBJMrLPjmuLrPQQrEYw',
-      'time-test' => 'ptu6bbahNZpYBMhk01UfXSg',
-      #'datetime' => "r2kQpXWr6xOSUpw9MyXavYg",
-      'datetime' => "ptu6bbahNZpYQEtZwzL_dZQ",
-      'whitespace' => "rZyQaoFebVGeHKzjG6e9gRQ",
-      'matrix' => '0AkCuGANLc3jFdHY3cWtYUkM4bVdadjZ5VGpfTzFEUEE',
-    # 'numbers1' => "o10837434939102457526.4784396906364855777",
-    # 'borders' => "o10837434939102457526.664868920231926255",
-    # 'simple_spreadsheet' => "ptu6bbahNZpYe-L1vEBmgGA",
-    # 'testnichtvorhandenBibelbund.ods' => "invalidkeyforanyspreadsheet", # !!! intentionally false key
-    # "only_one_sheet" => "o10837434939102457526.762705759906130135",
-    # "write.me" => 'ptu6bbahNZpY0N0RrxQbWdw&hl',
-    # 'formula' => 'o10837434939102457526.3022866619437760118',
-    # 'time-test' => 'ptu6bbahNZpYBMhk01UfXSg',
-    # 'datetime' => "ptu6bbahNZpYQEtZwzL_dZQ",
-    }.fetch(spreadsheetname)
-  rescue KeyError
-    raise "unknown spreadsheetname: #{spreadsheetname}"
-  end
-
-  def yaml_entry(row,col,type,value)
-    "cell_#{row}_#{col}: \n  row: #{row} \n  col: #{col} \n  celltype: #{type} \n  value: #{value} \n"
-  end
-end