roo 1.13.1 → 2.10.1

data/spec/lib/roo/base_spec.rb

@@ -1,7 +1,295 @@
 require 'spec_helper'
 
-describe Roo::GenericSpreadsheet do
-  it 'is an alias of Base' do
-    expect(Roo::GenericSpreadsheet).to eq(Roo::Base)
+describe Roo::Base do
+  let(:klass) do
+    Class.new(Roo::Base) do
+      def initialize(filename, data = {})
+        super(filename)
+        @data ||= data
+      end
+
+      def read_cells(sheet = default_sheet)
+        return if @cells_read[sheet]
+        type_map = { String => :string, Date => :date, Numeric => :float }
+
+        @cell[sheet] = @data
+        @cell_type[sheet] = Hash[@data.map { |k, v| [k, type_map.find {|type,_| v.is_a?(type) }.last ] }]
+        @first_row[sheet] = @data.map { |k, _| k[0] }.min
+        @last_row[sheet] = @data.map { |k, _| k[0] }.max
+        @first_column[sheet] = @data.map { |k, _| k[1] }.min
+        @last_column[sheet] = @data.map { |k, _| k[1] }.max
+        @cells_read[sheet] = true
+      end
+
+      def cell(row, col, sheet = nil)
+        sheet ||= default_sheet
+        read_cells(sheet)
+        @cell[sheet][[row, col]]
+      end
+
+      def celltype(row, col, sheet = nil)
+        sheet ||= default_sheet
+        read_cells(sheet)
+        @cell_type[sheet][[row, col]]
+      end
+
+      def sheets
+        ['my_sheet', 'blank sheet']
+      end
+    end
+  end
+
+  let(:spreadsheet_data) do
+    {
+      [3, 1] => 'Header',
+
+      [5, 1] => Date.civil(1961, 11, 21),
+
+      [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,
+
+      [15, 3] => 43.0,
+      [15, 4] => 44.0,
+      [15, 5] => 45.0,
+
+      [16, 2] => '"Hello world!"',
+      [16, 3] => 'forty-three',
+      [16, 4] => 'forty-four',
+      [16, 5] => 'forty-five'
+    }
+  end
+
+  let(:spreadsheet) { klass.new('some_file', spreadsheet_data) }
+
+  describe '#uri?' do
+    it 'should return true when passed a filename starting with http(s)://' do
+      expect(spreadsheet.send(:uri?, 'http://example.com/')).to be_truthy
+      expect(spreadsheet.send(:uri?, 'https://example.com/')).to be_truthy
+    end
+
+    it 'should return false when passed a filename which does not start with http(s)://' do
+      expect(spreadsheet.send(:uri?, 'example.com')).to be_falsy
+    end
+
+    it 'should return false when passed non-String object such as Tempfile' do
+      expect(spreadsheet.send(:uri?, Tempfile.new('test'))).to be_falsy
+    end
+  end
+
+  describe '#set' do
+    it 'should not update cell when setting an invalid type' do
+      spreadsheet.set(1, 1, 1)
+      expect { spreadsheet.set(1, 1, :invalid_type) }.to raise_error(ArgumentError)
+      expect(spreadsheet.cell(1, 1)).to eq(1)
+      expect(spreadsheet.celltype(1, 1)).to eq(:float)
+    end
+  end
+
+  describe '#first_row' do
+    it 'should return the first row' do
+      expect(spreadsheet.first_row).to eq(3)
+    end
+  end
+
+  describe '#last_row' do
+    it 'should return the last row' do
+      expect(spreadsheet.last_row).to eq(16)
+    end
+  end
+
+  describe '#first_column' do
+    it 'should return the first column' do
+      expect(spreadsheet.first_column).to eq(1)
+    end
+  end
+
+  describe '#first_column_as_letter' do
+    it 'should return the first column as a letter' do
+      expect(spreadsheet.first_column_as_letter).to eq('A')
+    end
+  end
+
+  describe '#last_column' do
+    it 'should return the last column' do
+      expect(spreadsheet.last_column).to eq(7)
+    end
+  end
+
+  describe '#last_column_as_letter' do
+    it 'should return the last column as a letter' do
+      expect(spreadsheet.last_column_as_letter).to eq('G')
+    end
+  end
+
+  describe "#row" do
+    it "should return the specified row" do
+      expect(spreadsheet.row(12)).to eq([41.0, 42.0, 43.0, 44.0, 45.0, nil, nil])
+      expect(spreadsheet.row(16)).to eq([nil, '"Hello world!"', "forty-three", "forty-four", "forty-five", nil, nil])
+    end
+
+    it "should return the specified row if default_sheet is set by a string" do
+      spreadsheet.default_sheet = "my_sheet"
+      expect(spreadsheet.row(12)).to eq([41.0, 42.0, 43.0, 44.0, 45.0, nil, nil])
+      expect(spreadsheet.row(16)).to eq([nil, '"Hello world!"', "forty-three", "forty-four", "forty-five", nil, nil])
+    end
+
+    it "should return the specified row if default_sheet is set by an integer" do
+      spreadsheet.default_sheet = 0
+      expect(spreadsheet.row(12)).to eq([41.0, 42.0, 43.0, 44.0, 45.0, nil, nil])
+      expect(spreadsheet.row(16)).to eq([nil, '"Hello world!"', "forty-three", "forty-four", "forty-five", nil, nil])
+    end
+  end
+
+  describe '#row_with' do
+    context 'with a matching header row' do
+      it 'returns the row number' do
+        expect(spreadsheet.row_with([/Header/])). to eq 3
+      end
+    end
+
+    context 'without a matching header row' do
+      it 'raises an error' do
+        expect { spreadsheet.row_with([/Missing Header/]) }.to \
+          raise_error(Roo::HeaderRowNotFoundError)
+      end
+
+      it 'returns missing headers' do
+        expect { spreadsheet.row_with([/Header/, /Missing Header 1/, /Missing Header 2/]) }.to \
+          raise_error(Roo::HeaderRowNotFoundError, '[/Missing Header 1/, /Missing Header 2/]')
+      end
+    end
+  end
+
+  describe '#empty?' do
+    it 'should return true when empty' do
+      expect(spreadsheet.empty?(1, 1)).to be_truthy
+      expect(spreadsheet.empty?(8, 3)).to be_falsy
+      expect(spreadsheet.empty?('A', 11)).to be_truthy
+      expect(spreadsheet.empty?('A', 12)).to be_falsy
+    end
+  end
+
+  describe '#reload' do
+    it 'should return reinitialize the spreadsheet' do
+      spreadsheet.reload
+      expect(spreadsheet.instance_variable_get(:@cell).empty?).to be_truthy
+    end
+  end
+
+  describe '#each_with_pagename' do
+    context 'when block given' do
+      it 'iterate with sheet and sheet_name' do
+        sheet_names = []
+        spreadsheet.each_with_pagename do |sheet_name, sheet|
+          sheet_names << sheet_name
+        end
+        expect(sheet_names).to eq ['my_sheet', 'blank sheet']
+      end
+    end
+
+    context 'when called without block' do
+      it 'should return an enumerator with all the rows' do
+        each_with_pagename = spreadsheet.each_with_pagename
+        expect(each_with_pagename).to be_a(Enumerator)
+        expect(each_with_pagename.to_a.last).to eq([spreadsheet.default_sheet, spreadsheet])
+      end
+    end
+  end
+
+  describe '#each' do
+    it 'should return an enumerator with all the rows' do
+      each = spreadsheet.each
+      expect(each).to be_a(Enumerator)
+      expect(each.to_a.last).to eq([nil, '"Hello world!"', 'forty-three', 'forty-four', 'forty-five', nil, nil])
+    end
+  end
+
+  describe "#default_sheet=" do
+    it "should correctly set the default sheet if passed a string" do
+      spreadsheet.default_sheet = "my_sheet"
+      expect(spreadsheet.default_sheet).to eq("my_sheet")
+    end
+
+    it "should correctly set the default sheet if passed an integer" do
+      spreadsheet.default_sheet = 0
+      expect(spreadsheet.default_sheet).to eq("my_sheet")
+    end
+
+    it "should correctly set the default sheet if passed an integer for the second sheet" do
+      spreadsheet.default_sheet = 1
+      expect(spreadsheet.default_sheet).to eq("blank sheet")
+    end
+
+    it "should raise an error if passed a sheet that does not exist as an integer" do
+      expect { spreadsheet.default_sheet = 10 }.to raise_error RangeError
+    end
+
+    it "should raise an error if passed a sheet that does not exist as a string" do
+      expect { spreadsheet.default_sheet = "does_not_exist" }.to raise_error RangeError
+    end
+  end
+
+  describe '#to_yaml' do
+    it 'should convert the spreadsheet to yaml' do
+      expect(spreadsheet.to_yaml({}, 5, 1, 5, 1)).to eq("--- \n" + yaml_entry(5, 1, 'date', '1961-11-21'))
+      expect(spreadsheet.to_yaml({}, 8, 3, 8, 3)).to eq("--- \n" + yaml_entry(8, 3, 'string', 'thisisc8'))
+
+      expect(spreadsheet.to_yaml({}, 12, 3, 12, 3)).to eq("--- \n" + yaml_entry(12, 3, 'float', 43.0))
+
+      expect(spreadsheet.to_yaml({}, 12, 3, 12)).to eq(
+        "--- \n" + yaml_entry(12, 3, 'float', 43.0) +
+        yaml_entry(12, 4, 'float', 44.0) +
+        yaml_entry(12, 5, 'float', 45.0))
+
+      expect(spreadsheet.to_yaml({}, 12, 3)).to eq(
+      "--- \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', 'forty-three') +
+        yaml_entry(16, 4, 'string', 'forty-four') +
+        yaml_entry(16, 5, 'string', 'forty-five'))
+    end
+  end
+
+  let(:expected_csv) do
+    <<EOS
+,,,,,,
+,,,,,,
+"Header",,,,,,
+,,,,,,
+1961-11-21,,,,,,
+,,,,,,
+,,,,,,
+,,"thisisc8",,,,"thisisg8"
+,,,,,,
+,,,,,,
+,,,,,,
+41,42,43,44,45,,
+,,,,,,
+,,,,,,
+,,43,44,45,,
+,"""Hello world!""","forty-three","forty-four","forty-five",,
+EOS
+  end
+
+  let(:expected_csv_with_semicolons) { expected_csv.gsub(/\,/, ';') }
+
+  describe '#to_csv' do
+    it 'should convert the spreadsheet to csv' do
+      expect(spreadsheet.to_csv).to eq(expected_csv)
+    end
+
+    it 'should convert the spreadsheet to csv using the separator when is passed on the parameter' do
+      expect(spreadsheet.to_csv(nil, ';')).to eq(expected_csv_with_semicolons)
+    end
   end
 end

data/spec/lib/roo/csv_spec.rb

@@ -10,12 +10,33 @@ describe Roo::CSV do
     end
   end
 
+  describe '.new with stream' do
+    let(:csv) { Roo::CSV.new(File.read(path)) }
+    it 'creates an instance' do
+      expect(csv).to be_a(Roo::CSV)
+    end
+  end
+
   describe '#parse' do
-    subject {
+    subject do
       csv.parse(options)
-    }
+    end
     context 'with headers: true' do
-      let(:options) { {headers: true} }
+      let(:options) { { headers: true } }
+
+      it "doesn't blow up" do
+        expect { subject }.to_not raise_error
+      end
+    end
+  end
+
+  describe '#parse_with_clean_option' do
+    subject do
+      csv.parse(options)
+    end
+    context 'with clean: true' do
+      let(:options) { {clean: true} }
+      let(:path) { 'test/files/parse_with_clean_option.csv' }
 
       it "doesn't blow up" do
         expect { subject }.to_not raise_error
@@ -25,30 +46,36 @@ describe Roo::CSV do
 
   describe '#csv_options' do
     context 'when created with the csv_options option' do
-      let(:options) {
+      let(:options) do
         {
           col_sep: '\t',
           quote_char: "'"
         }
-      }
+      end
 
       it 'returns the csv options' do
         csv = Roo::CSV.new(path, csv_options: options)
-        csv.csv_options.should == options
+        expect(csv.csv_options).to eq(options)
       end
     end
 
     context 'when created without the csv_options option' do
       it 'returns a hash' do
         csv = Roo::CSV.new(path)
-        csv.csv_options.should == {}
+        expect(csv.csv_options).to eq({})
       end
     end
   end
-end
 
-describe Roo::Csv do
-  it 'is an alias of LibreOffice' do
-    expect(Roo::Csv).to eq(Roo::CSV)
+  describe '#set_value' do
+    it 'returns the cell value' do
+      expect(csv.set_value('A', 1, 'some-value', nil)).to eq('some-value')
+    end
+  end
+
+  describe '#set_type' do
+    it 'returns the cell type' do
+      expect(csv.set_type('A', 1, 'some-type', nil)).to eq('some-type')
+    end
   end
 end

data/spec/lib/roo/excelx/cell/time_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe Roo::Excelx::Cell::Time do
+  it "should set the cell value to the correct number of seconds" do
+    value = 0.05513888888888888 # '1:19:24'
+    excelx_type = [:numeric_or_formula, "h:mm:ss"]
+    base_timestamp = Date.new(1899, 12, 30).to_time.to_i
+    time_cell = Roo::Excelx::Cell::Time.new(value, nil, excelx_type, 1, nil, base_timestamp, nil)
+    expect(time_cell.value).to eq(1*60*60 + 19*60 + 24) # '1:19:24' in seconds
+    # use case from https://github.com/roo-rb/roo/issues/310
+    value = 0.523761574074074   # '12:34:13' in seconds
+    time_cell = Roo::Excelx::Cell::Time.new(value, nil, excelx_type, 1, nil, base_timestamp, nil)
+    expect(time_cell.value).to eq(12*60*60 + 34*60 + 13) # 12:34:13 in seconds
+  end
+end

data/spec/lib/roo/excelx/format_spec.rb

@@ -11,8 +11,8 @@ describe Roo::Excelx::Format do
       '0%' => :percentage,
       '0.00%' => :percentage,
       '0.00E+00' => :float,
-      '# ?/?' => :float, #??? TODO:
-      '# ??/??' => :float, #??? TODO:
+      '# ?/?' => :float, # ??? TODO:
+      '# ??/??' => :float, # ??? TODO:
       'mm-dd-yy' => :date,
       'd-mmm-yy' => :date,
       'd-mmm' => :date,
@@ -33,17 +33,18 @@ describe Roo::Excelx::Format do
       '##0.0E+0' => :float,
       '@' => :float,
       #-- zusaetzliche Formate, die nicht standardmaessig definiert sind:
-      "yyyy\\-mm\\-dd" => :date,
+      'yyyy\\-mm\\-dd' => :date,
       'dd/mm/yy' => :date,
       'hh:mm:ss' => :time,
-      "dd/mm/yy\\ hh:mm" => :datetime,
+      'dd/mm/yy\\ hh:mm' => :datetime,
       'dd/mmm/yy\\ hh:mm' => :datetime,
       'dd/mmm/yy' => :date, # 2011-05-21
       'yyyy-mm-dd' => :date, # 2011-09-16
-      'yyyy-mm-dd;@' => :date
+      'yyyy-mm-dd;@' => :date,
+      '#0_);[Red]\(0\)' => :float
     }.each do |format, type|
       it "translates #{format} to #{type}" do
-        Roo::Excelx::Format.to_type(format).should == type
+        expect(Roo::Excelx::Format.to_type(format)).to eq(type)
       end
     end
   end

data/spec/lib/roo/excelx/relationships_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Roo::Excelx::Relationships do
+  subject(:relationships) { Roo::Excelx::Relationships.new Roo::Excelx.new(path).rels_files[0] }
+
+  describe "#include_type?" do
+    [
+      ["with hyperlink type", "test/files/link.xlsx", true, false],
+      ["with nil path", "test/files/Bibelbund.xlsx", false, false],
+      ["with comments type", "test/files/comments-google.xlsx", false, true],
+    ].each do |context_desc, file_path, hyperlink_value, comments_value|
+      context context_desc do
+        let(:path) { file_path }
+
+        it "should return #{hyperlink_value} for hyperlink" do
+          expect(subject.include_type?("hyperlink")).to be hyperlink_value
+        end
+
+        it "should return #{hyperlink_value} for link" do
+          expect(subject.include_type?("link")).to be hyperlink_value
+        end
+
+        it "should return false for hypelink" do
+          expect(subject.include_type?("hypelink")).to be false
+        end
+
+        it "should return false for coment" do
+          expect(subject.include_type?("coment")).to be false
+        end
+
+        it "should return #{comments_value} for comments" do
+          expect(subject.include_type?("comments")).to be comments_value
+        end
+
+        it "should return #{comments_value} for comment" do
+          expect(subject.include_type?("comment")).to be comments_value
+        end
+      end
+    end
+  end
+end

data/spec/lib/roo/excelx/sheet_doc_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Roo::Excelx::SheetDoc do
+  subject(:blank_children) { Roo::Excelx.new("test/files/blank_children.xlsx") }
+
+  example "#last_row" do
+    expect(subject.last_row).to eq 3
+  end
+end