ndr_import 3.1.5 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 154d097959db5f976eb388923cb0ec092ca7a082
-  data.tar.gz: 5189ab2452d9faa4757d0217677edffb5e6b9f89
+  metadata.gz: 5d79b720417de07bd9f4db6de53c08600ee190ac
+  data.tar.gz: d267da10cc8446fe3272b6aab0e6792e6d77b3e2
 SHA512:
-  metadata.gz: 604fe52d17f3741882d0402cd523db3461aa846f437c65f3afaad9e1ea9d7f080d46efa363175a027eedcf2502544f99b0cf144d70b28770e3d9d86c8adcc99d
-  data.tar.gz: ed7332ec167e80547d684a9b8df986f65cbf82de9c3f42e60fa49a8c5dfe060a6507fb0b9a213fa812ab1137121b5acaf390de614cef9fcd12cc6a58feb50f65
+  metadata.gz: 47a472805cd80bede14e404c026dbfdaa4a0b1f7cd1cd48f33d4c83fc27e66b0b41f91f3a64b4fdd77486f302d2ee58a0fd2c3280a9d93e128f1fc55aace7634
+  data.tar.gz: 515cd22f7ae8a0c2b5faa8b3d2b9f5aac08932772637bd189bfe791c3446f2daa42317a87993af8dd642969b289ef0ab880bc647a795ea9e7a9c06f89c6359ad

data/code_safety.yml

@@ -75,7 +75,7 @@ file safety:
   lib/ndr_import/file/excel.rb:
     comments: 
     reviewed_by: joshpencheon
-    safe_revision: 80ce15cc5ca15019400d4cd24c3353191bec00cc
+    safe_revision: 334d53bb9e8698bba3d92b4dbd71b36faacae629
   lib/ndr_import/file/pdf.rb:
     comments: 
     reviewed_by: timgentry
@@ -163,7 +163,7 @@ file safety:
   lib/ndr_import/version.rb:
     comments: another check?
     reviewed_by: joshpencheon
-    safe_revision: 03305d1e8a6fab607565886bdd7ce4d63a0cdba1
+    safe_revision: 749aa9bb66f6e07b52acab1096f6f866034fc676
   ndr_import.gemspec:
     comments: 
     reviewed_by: josh.pencheon
@@ -179,7 +179,7 @@ file safety:
   test/file/excel_test.rb:
     comments: 
     reviewed_by: joshpencheon
-    safe_revision: 80ce15cc5ca15019400d4cd24c3353191bec00cc
+    safe_revision: 334d53bb9e8698bba3d92b4dbd71b36faacae629
   test/file/pdf_test.rb:
     comments: 
     reviewed_by: timgentry
@@ -340,6 +340,14 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: 8c30f89f0562ab120769c166d4e93ff839c055f7
+  test/resources/sheet_streaming.xls:
+    comments: 
+    reviewed_by: joshpencheon
+    safe_revision: 334d53bb9e8698bba3d92b4dbd71b36faacae629
+  test/resources/sheet_streaming.xlsx:
+    comments: 
+    reviewed_by: joshpencheon
+    safe_revision: 334d53bb9e8698bba3d92b4dbd71b36faacae629
   test/resources/standard_mappings.yml:
     comments: 
     reviewed_by: timgentry

data/lib/ndr_import/file/excel.rb

@@ -18,8 +18,8 @@ module NdrImport
         return enum_for(:tables) unless block_given?
 
         workbook = load_workbook(@filename)
-        workbook.each_with_pagename do |tablename, sheet|
-          yield tablename, excel_rows(workbook, sheet)
+        workbook.sheets.each do |sheet_name|
+          yield sheet_name, excel_rows(workbook, sheet_name)
         end
       end
 
@@ -49,37 +49,38 @@ module NdrImport
       private
 
       # Iterate through the sheet line by line, yielding each one in turn.
-      def excel_rows(workbook, sheet, &block)
-        return enum_for(:excel_rows, workbook, sheet) unless block
+      def excel_rows(workbook, sheet_name, &block)
+        return enum_for(:excel_rows, workbook, sheet_name) unless block
 
         if workbook.is_a?(Roo::Excelx)
           # FIXME: xlsx_rows(sheet, &block) should produce the same output as xls_rows
-          xls_rows(sheet, &block)
+          xls_rows(workbook, sheet_name, &block)
         else
-          xls_rows(sheet, &block)
+          xls_rows(workbook, sheet_name, &block)
         end
       end
 
       # Iterate through an xls sheet line by line, yielding each one in turn.
-      def xls_rows(sheet)
-        return enum_for(:xls_rows, sheet) unless block_given?
-        return unless sheet.first_row # NULL Sheet (TODO: perhaps XLSX only, use xlsx_rows...)
-
-        sheet.first_row.upto(sheet.last_row) do |row|
-          line = []
-          sheet.first_column.upto(sheet.last_column) do |col|
-            line << cast_excel_value(sheet.cell(row, col))
-          end
-          yield line
+      def xls_rows(workbook, sheet_name)
+        return enum_for(:xls_rows, workbook, sheet_name) unless block_given?
+
+        activate_sheet!(workbook, sheet_name)
+        return unless workbook.first_row
+        (workbook.first_row..workbook.last_row).each do |row|
+          activate_sheet!(workbook, sheet_name)
+          columns = (workbook.first_column..workbook.last_column)
+          yield columns.map { |col| cast_excel_value(workbook.cell(row, col)) }
         end
       end
 
       # Iterate through an xlsx sheet line by line, yielding each one in turn.
       # This method uses streaming https://github.com/roo-rb/roo#excel-xlsx-and-xlsm-support
-      def xlsx_rows(sheet)
-        return enum_for(:xlsx_rows, sheet) unless block_given?
+      def xlsx_rows(workbook, sheet_name)
+        return enum_for(:xlsx_rows, workbook, sheet_name) unless block_given?
+
+        activate_sheet!(workbook, sheet_name)
 
-        sheet.each_row_streaming(:pad_cells => true) do |row|
+        workbook.each_row_streaming(:pad_cells => true) do |row|
           yield row.map { |cell| cast_excel_value(cell.value) }
         end
       end
@@ -125,6 +126,14 @@ module NdrImport
         FileUtils.mkdir_p(SafeFile.safepath_to_string(SafeFile.dirname(dest)))
         FileUtils.cp(SafeFile.safepath_to_string(source), SafeFile.safepath_to_string(dest))
       end
+
+      # Sets `sheet_name' to be the default (i.e. active) sheet in `workbook'.
+      # This setting applies to the Roo object, so needs to re-applied if (for example)
+      # streaming rows from multiple sheets simultaneously - something that was problematic
+      # with Workbook#each_with_pagename.
+      def activate_sheet!(workbook, sheet_name)
+        workbook.sheet(sheet_name)
+      end
     end
 
     Registry.register(Excel, 'xls', 'xlsx')

data/lib/ndr_import/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # This stores the current version of the NdrImport gem
 module NdrImport
-  VERSION = '3.1.5'.freeze
+  VERSION = '3.1.6'.freeze
 end

data/test/file/excel_test.rb

@@ -33,9 +33,28 @@ module NdrImport
         file_path = @permanent_test_files.join('blank_tab_test.xlsx')
         handler   = NdrImport::File::Excel.new(file_path, nil)
 
-        handler.tables.each do |_tablename, sheet|
-          assert_instance_of Enumerator, sheet
-          assert sheet.to_a.is_a?(Array)
+        sheets = handler.tables.map { |_tablename, sheet| sheet }
+
+        assert_equal %w(column_a column_b column_c column_d), sheets[0].next
+        assert_equal %w(11111 ABC123 8888888888 2), sheets[0].next
+        assert_equal %w(column_a column_b column_c column_d), sheets[1].next
+        assert_equal %w(11111 ABC123 8888888888 3), sheets[1].next
+        assert_raises(StopIteration) { sheets[2].next }
+      end
+
+      %w(sheet_streaming.xlsx sheet_streaming.xls).each do |filename|
+        test "should be able to stream from multiple sheets at once from #{filename}" do
+          file_path = @permanent_test_files.join(filename)
+          handler   = NdrImport::File::Excel.new(file_path, nil)
+
+          sheets = handler.tables.map { |_tablename, sheet| sheet }
+
+          assert_equal %w(1A1 1B1), sheets[0].next
+          assert_raises(StopIteration) { sheets[2].next }
+          assert_equal %w(2A1 2B1), sheets[1].next
+          assert_equal %w(2A2 2B2), sheets[1].next
+          assert_equal %w(1A2 1B2), sheets[0].next
+          assert_raises(StopIteration) { sheets[2].next }
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_import
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.1.6
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -372,6 +372,8 @@ files:
 - test/resources/not_a_word_file.doc
 - test/resources/sample_xls.xls
 - test/resources/sample_xlsx.xlsx
+- test/resources/sheet_streaming.xls
+- test/resources/sheet_streaming.xlsx
 - test/resources/standard_mappings.yml
 - test/resources/txt_file_xls_extension.xls
 - test/resources/txt_file_xlsx_extension.xlsx
@@ -453,6 +455,8 @@ test_files:
 - test/resources/not_a_word_file.doc
 - test/resources/sample_xls.xls
 - test/resources/sample_xlsx.xlsx
+- test/resources/sheet_streaming.xls
+- test/resources/sheet_streaming.xlsx
 - test/resources/standard_mappings.yml
 - test/resources/txt_file_xls_extension.xls
 - test/resources/txt_file_xlsx_extension.xlsx