roo 2.0.0 → 2.0.1

data/lib/roo/excelx/styles.rb

@@ -2,61 +2,63 @@ require 'roo/font'
 require 'roo/excelx/extractor'
 
 module Roo
-  class Excelx::Styles < Excelx::Extractor
-    # convert internal excelx attribute to a format
-    def style_format(style)
-      id = num_fmt_ids[style.to_i]
-      num_fmts[id] || Excelx::Format::STANDARD_FORMATS[id.to_i]
-    end
+  class Excelx
+    class Styles < Excelx::Extractor
+      # convert internal excelx attribute to a format
+      def style_format(style)
+        id = num_fmt_ids[style.to_i]
+        num_fmts[id] || Excelx::Format::STANDARD_FORMATS[id.to_i]
+      end
 
-    def definitions
-      @definitions ||= extract_definitions
-    end
+      def definitions
+        @definitions ||= extract_definitions
+      end
 
-    private
+      private
 
-    def num_fmt_ids
-      @num_fmt_ids ||= extract_num_fmt_ids
-    end
+      def num_fmt_ids
+        @num_fmt_ids ||= extract_num_fmt_ids
+      end
 
-    def num_fmts
-      @num_fmts ||= extract_num_fmts
-    end
+      def num_fmts
+        @num_fmts ||= extract_num_fmts
+      end
 
-    def fonts
-     @fonts ||= extract_fonts
-    end
+      def fonts
+        @fonts ||= extract_fonts
+      end
 
-    def extract_definitions
-      doc.xpath("//cellXfs").flat_map do |xfs|
-        xfs.children.map do |xf|
-          fonts[xf['fontId'].to_i]
+      def extract_definitions
+        doc.xpath('//cellXfs').flat_map do |xfs|
+          xfs.children.map do |xf|
+            fonts[xf['fontId'].to_i]
+          end
         end
       end
-    end
 
-    def extract_fonts
-      doc.xpath("//fonts/font").map do |font_el|
-        Font.new.tap do |font|
-          font.bold = !font_el.xpath('./b').empty?
-          font.italic = !font_el.xpath('./i').empty?
-          font.underline = !font_el.xpath('./u').empty?
+      def extract_fonts
+        doc.xpath('//fonts/font').map do |font_el|
+          Font.new.tap do |font|
+            font.bold = !font_el.xpath('./b').empty?
+            font.italic = !font_el.xpath('./i').empty?
+            font.underline = !font_el.xpath('./u').empty?
+          end
         end
       end
-    end
 
-    def extract_num_fmt_ids
-      doc.xpath("//cellXfs").flat_map do |xfs|
-        xfs.children.map do |xf|
-          xf['numFmtId']
+      def extract_num_fmt_ids
+        doc.xpath('//cellXfs').flat_map do |xfs|
+          xfs.children.map do |xf|
+            xf['numFmtId']
+          end
         end
       end
-    end
 
-    def extract_num_fmts
-      Hash[doc.xpath("//numFmt").map do |num_fmt|
-        [num_fmt['numFmtId'], num_fmt['formatCode']]
-      end]
+      def extract_num_fmts
+        Hash[doc.xpath('//numFmt').map do |num_fmt|
+          [num_fmt['numFmtId'], num_fmt['formatCode']]
+        end]
+      end
     end
   end
 end

data/lib/roo/excelx/workbook.rb

@@ -1,59 +1,59 @@
 require 'roo/excelx/extractor'
 
 module Roo
-  class Excelx::Workbook < Excelx::Extractor
-    class Label
-      attr_reader :sheet, :row, :col, :name
+  class Excelx
+    class Workbook < Excelx::Extractor
+      class Label
+        attr_reader :sheet, :row, :col, :name
 
-      def initialize(name, sheet, row, col)
-        @name = name
-        @sheet = sheet
-        @row = row.to_i
-        @col = ::Roo::Utils.letter_to_number(col)
-      end
+        def initialize(name, sheet, row, col)
+          @name = name
+          @sheet = sheet
+          @row = row.to_i
+          @col = ::Roo::Utils.letter_to_number(col)
+        end
 
-      def key
-        [@row, @col]
+        def key
+          [@row, @col]
+        end
       end
-    end
 
-    def initialize(path)
-      super
-      if !doc_exists?
-        raise ArgumentError, 'missing required workbook file'
+      def initialize(path)
+        super
+        fail ArgumentError, 'missing required workbook file' unless doc_exists?
       end
-    end
 
-    def sheets
-      doc.xpath("//sheet")
-    end
+      def sheets
+        doc.xpath('//sheet')
+      end
 
-    # aka labels
-    def defined_names
-      Hash[doc.xpath("//definedName").map do |defined_name|
-        # "Sheet1!$C$5"
-        sheet, coordinates = defined_name.text.split('!$', 2)
-        col,row = coordinates.split('$')
-        name = defined_name['name']
-        [name, Label.new(name, sheet,row,col)]
-      end]
-    end
+      # aka labels
+      def defined_names
+        Hash[doc.xpath('//definedName').map do |defined_name|
+          # "Sheet1!$C$5"
+          sheet, coordinates = defined_name.text.split('!$', 2)
+          col, row = coordinates.split('$')
+          name = defined_name['name']
+          [name, Label.new(name, sheet, row, col)]
+        end]
+      end
 
-    def base_date
-      @base_date ||=
+      def base_date
+        @base_date ||=
         begin
           # Default to 1900 (minus one day due to excel quirk) but use 1904 if
           # it's set in the Workbook's workbookPr
           # http://msdn.microsoft.com/en-us/library/ff530155(v=office.12).aspx
-          result = Date.new(1899,12,30) # default
-          doc.css("workbookPr[date1904]").each do |workbookPr|
-            if workbookPr["date1904"] =~ /true|1/i
-              result = Date.new(1904,01,01)
+          result = Date.new(1899, 12, 30) # default
+          doc.css('workbookPr[date1904]').each do |workbookPr|
+            if workbookPr['date1904'] =~ /true|1/i
+              result = Date.new(1904, 01, 01)
               break
             end
           end
           result
         end
+      end
     end
   end
 end

data/lib/roo/open_office.rb

@@ -13,7 +13,7 @@ class Roo::OpenOffice < Roo::Base
 
     @only_visible_sheets = options[:only_visible_sheets]
     file_type_check(filename,'.ods','an Roo::OpenOffice', file_warning, packed)
-    @tmpdir = make_tmpdir(filename.split('/').last, options[:tmpdir_root])
+    @tmpdir = make_tmpdir(File.basename(filename), options[:tmpdir_root])
     @filename = local_filename(filename, @tmpdir, packed)
     #TODO: @cells_read[:default] = false
     Zip::File.open(@filename) do |zip_file|
@@ -38,6 +38,9 @@ class Roo::OpenOffice < Roo::Base
     @font_style_definitions = Hash.new
     @comment = Hash.new
     @comments_read = Hash.new
+  rescue => e # clean up any temp files, but only if an error was raised
+    close
+    raise e
   end
 
   def method_missing(m,*args)

data/lib/roo/version.rb

@@ -1,3 +1,3 @@
 module Roo
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/lib/roo/excelx_spec.rb

@@ -36,6 +36,15 @@ describe Roo::Excelx do
         expect(Roo::Excelx.new(path, cell_max: 100)).to be_a(Roo::Excelx)
       end
     end
+
+    context 'file path is a Pathname' do
+      let(:path) { Pathname.new('test/files/file_item_error.xlsx') }
+
+      it 'creates an instance' do
+        expect(subject).to be_a(Roo::Excelx)
+      end
+    end
+
   end
 
   describe '#cell' do
@@ -411,5 +420,32 @@ describe Roo::Excelx do
         expect(index).to eq 4
       end
     end
+
+    context 'with offset option' do
+      let(:offset) { 3 }
+
+      it 'returns the expected result' do
+        index = 0
+        subject.each_row_streaming(offset: offset) do |row|
+          expect(row.map(&:value)).to eq expected_rows[index + offset]
+          index += 1
+        end
+        expect(index).to eq 11
+      end
+    end
+
+    context 'with offset and max_rows options' do
+      let(:offset) { 3 }
+      let(:max_rows) { 3 }
+
+      it 'returns the expected result' do
+        index = 0
+        subject.each_row_streaming(offset: offset, max_rows: max_rows) do |row|
+          expect(row.map(&:value)).to eq expected_rows[index + offset]
+          index += 1
+        end
+        expect(index).to eq 4
+      end
+    end
   end
 end

data/spec/lib/roo/openoffice_spec.rb

@@ -9,6 +9,17 @@ describe Roo::OpenOffice do
     it 'creates an instance' do
       expect(subject).to be_a(Roo::OpenOffice)
     end
+
+    context 'file path is a Pathname' do
+      subject do
+        Roo::OpenOffice.new(Pathname.new('test/files/numbers1.ods'))
+      end
+
+      it 'creates an instance' do
+        expect(subject).to be_a(Roo::OpenOffice)
+      end
+    end
+    
   end
 
   # OpenOffice is an alias of LibreOffice. See libreoffice_spec.

data/test/test_generic_spreadsheet.rb

@@ -2,30 +2,29 @@
 require File.dirname(__FILE__) + '/test_helper'
 
 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)
+      def cell(row, col, sheet = nil)
         sheet ||= default_sheet
-        @cell[sheet][[row,col]]
+        @cell[sheet][[row, col]]
       end
 
-      def celltype(row, col, sheet=nil)
+      def celltype(row, col, sheet = nil)
         sheet ||= default_sheet
-        @cell_type[sheet][[row,col]]
+        @cell_type[sheet][[row, col]]
       end
 
       def sheets
-        ['my_sheet','blank sheet']
+        ['my_sheet', 'blank sheet']
       end
     end
     @oo = @klass.new
@@ -33,37 +32,37 @@ class TestBase < Minitest::Test
   end
 
   context 'private method Roo::Base.uri?(filename)' do
-    should "return true when passed a filename starts with http(s)://" 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 "return false when passed a filename which does not start with http(s)://" do
+    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 "return false when passed non-String object such as Tempfile" do
+    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_raises(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
@@ -78,17 +77,16 @@ class TestBase < Minitest::Test
     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
@@ -96,35 +94,43 @@ class TestBase < Minitest::Test
     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
 
   def test_to_csv_with_separator
-    assert_equal expected_csv_with_semicolons,@oo.to_csv(nil, ';')
+    assert_equal expected_csv_with_semicolons, @oo.to_csv(nil, ';')
   end
-protected
-  def setup_test_sheet(workbook=nil)
+
+  protected
+
+  def setup_test_sheet(workbook = nil)
     workbook ||= @oo
     set_sheet_values(workbook)
     set_sheet_types(workbook)
@@ -133,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)
@@ -203,9 +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 /\,/, ';'
+    expected_csv.gsub(/\,/, ';')
   end
 end