iron-import 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: e0c9cad49ed06dfb8000477555421a8c109c3d13a112619039372c58ea0e3475
-  data.tar.gz: 9a686352b1c0158fd87fdcda9c021390e6707508dfdc77a9712f6f8a372c32e5
+SHA1:
+  metadata.gz: b0adebf4d34c81c82f83ec23454028316ee1ca4c
+  data.tar.gz: f40fc82e0d0fa4bad0930ed86c5de98a31adc0fc
 SHA512:
-  metadata.gz: 7c38498e700b3bc7174cb5cc5762c15b390cf0f9dbb83bd5af12a43fa702eed58245c43fdba71b1a201fc0c8bab5c79e3aa287c82bd1074cf1a9844318beb702
-  data.tar.gz: 24b26fec53dfb0b348413754e66b628aa1008eaf98e6c5fbaacb5b546ba7c3bff969e96657b0866ee5f0dc591f1c4a32f2a2cd9b89e7908eb057e22d7b98209d
+  metadata.gz: 92ec6f0156219b3d30a144db3b2260bb9593667c1e030c9922f19d0e36a54e8c7b25944f07c1aab4023525e3c734becd56d56c1bbf1b26cefb8955f7872c058e
+  data.tar.gz: 99eeeb1b52b4a2d7eaec2c9186d8900467c66ea31e1057055c5ba54dc21e6e50ae1d8b2f007cbd483610c37fe86a2b3beaf30375ceed646fe19abb921b7259a0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.8.8 / 2018-07-23
+* Add error when all rows have been filtered or none were found
+* Add Importer#allow_empty! to suppress same
+* Improve error message when unable to detect file/stream format
+
 == 0.8.7 / 2018-05-03
 * Improve Importer#read_lines and Importer#import to rewind the stream at end of processing
 

data/Version.txt

@@ -1 +1 @@
-0.8.7
+0.8.8

data/lib/iron/import/data_reader.rb

@@ -29,14 +29,8 @@ class Importer
       data = nil
       if is_stream?(source)
         data = DataReader::for_stream(importer, source)
-        unless data
-          importer.add_error("Unable to find format handler for stream")
-        end
       else
         data = DataReader::for_path(importer, source)
-        unless data
-          importer.add_error("Unable to find format handler for file #{source}")
-        end
       end
       data
     end

data/lib/iron/import/importer.rb

@@ -107,6 +107,9 @@ class Importer
 
   # When true, skips header detection
   dsl_flag :headerless
+  # When true, does not record an error if all rows are filtered or there are none
+  # present at all
+  dsl_flag :allow_empty
   # Explicitly sets the row number (1-indexed) where data rows begin,
   # usually left defaulted to nil to automatically start after the header
   # row, or on the first row if #headerless! is set.
@@ -398,7 +401,7 @@ class Importer
 
     # Verify we got one
     unless @reader
-      add_error("Unable to find format handler for format :#{format} on import of #{path_or_stream.class.name} source - aborting")
+      add_error("Unable to find format handler for format :#{format || :auto} on import of #{path_or_stream.class.name} source - aborting")
       return block ? self : false
     end
     
@@ -414,14 +417,20 @@ class Importer
       # Find our column layout, start of data, etc
       if find_header(raw_rows)
         # Now, run all the data and add it as a Row instance
+        any = false
         raw_rows.each_with_index do |raw, index|
           row_num = index + 1
           if row_num >= @data.start_row
-            add_row(row_num, raw)
+            any = add_row(row_num, raw) || any
           end
         end
         # We've found a workable sheet/table/whatever, stop looking
         loaded = true
+        # Check to see if it contained any valid rows, add an error in case all rows are filtered
+        # or there just aren't any
+        unless any || has_errors? || allow_empty?
+          add_error("No unfiltered rows found - check your column headers")
+        end
         true
         
       else
@@ -431,8 +440,8 @@ class Importer
       end
     end
     
-    # Verify that we found a working set of rows
-    unless loaded
+    # Verify that we found a working set of rows, add an error if needed if not
+    unless has_errors? || loaded
       # If we have any missing headers, note that fact
       if @missing_headers && @missing_headers.count > 0
         add_error("Unable to locate required column header for column(s): " + @missing_headers.collect{|c| ":#{c}"}.list_join(', '))
@@ -511,9 +520,9 @@ class Importer
   # Your block can access the #rows to do whatever
   # logging, reporting etc. is desired.
   def on_success(&block)
-    raise 'Invalid block passed to Importer#on_succes: block may accept 0 or 1arguments' if block.arity > 1
+    raise 'Invalid block passed to Importer#on_success: block may accept 0 or 1 arguments' if block.arity > 1
     
-    if @data.rows.any? && !has_errors?
+    if !has_errors?
       case block.arity
       when 0 then DslProxy.exec(self, &block)
       when 1 then DslProxy.exec(self, @data.rows, &block)
@@ -526,9 +535,18 @@ class Importer
   # Call with a block accepting an array of Column objects and returning
   # true if the columns in the array should constitute a valid header row.  Intended
   # for use with optional columns to define multiple supported column sets, or
-  # conditionally required secondary columns.  Columns will be passed in in the
-  # order detected, so you can use ordering to help determine which columns are
-  # required if that helps.
+  # conditionally required secondary columns.  
+  #
+  # Columns will be passed in in the order detected, with full Column info, so you can use ordering 
+  # to help determine which columns are required if that helps.  
+  #
+  # Sample using the simpler #column accessor method:
+  #
+  # validate_columns do |cols|
+  #   unless column(:optional_col).present? || column(:other_optional_col).present?
+  #     add_error('You must include either Optional Col or Other Optional Col!')
+  #   end
+  # end
   def validate_columns(&block)
     raise 'Invalid block passed to Importer#validate_columns: block should accept a single argument' if block.arity != 1
     @column_validator = block
@@ -537,9 +555,9 @@ class Importer
   # Call with a block accepting a single Row instance.  Just like Column#validate, you
   # can fail by returning false, calling #add_error(msg) or by raising an exception.
   # The intent of this method of validation is to allow using the full row context to
-  # validate 
+  # validate rather than looking at each column's value in isolation.
   def validate_rows(&block)
-    raise 'Invalid block passed to Importer#validate_columns: block should accept a single Row argument' if block.arity != 1
+    raise 'Invalid block passed to Importer#validate_rows: block should accept a single Row argument' if block.arity != 1
     @row_validator = block
   end
   
@@ -679,9 +697,9 @@ class Importer
       end
     end
 
-    # We is good
+    # Add the row - may contain errors
     @data.rows << row
-    row
+    !has_errors?
   end
   
   def rows

data/spec/importer/importer_spec.rb

@@ -155,13 +155,8 @@ describe Importer do
     importer = Importer.build do
       column :foo
     end
-    was_run = false
-
-    importer.on_error do
-      was_run = true
-    end
-    was_run.should be_false
 
+    was_run = false
     importer.add_error('An error')
     importer.on_error do
       was_run = true
@@ -175,11 +170,6 @@ describe Importer do
     end
 
     was_run = false
-    importer.on_success do
-      was_run = true
-    end
-    was_run.should be_false
-
     importer.import_string("foo\n1")
     importer.has_errors?.should be_false
     importer.on_success do
@@ -335,4 +325,33 @@ describe Importer do
     stream.pos.should == 0
   end
   
+  it 'should report an error when all rows are filtered' do
+    importer = Importer.build do
+      column :num, :type => :int
+      filter do |row|
+        row[:num] < 50
+      end
+    end
+
+    importer.import_string("num\n1\n2")
+    importer.error_summary.should be_nil
+    
+    importer.import_string("num\n100\n101")
+    importer.error_summary.should_not be_nil
+    importer.error_summary.should include('No unfiltered rows found')
+  end
+  
+  it 'should not report an error when all rows filtered but #allow_empty! set' do
+    importer = Importer.build do
+      allow_empty!
+      column :num, :type => :int
+      filter do |row|
+        row[:num] < 50
+      end
+    end
+    
+    importer.import_string("num\n100\n101")
+    importer.error_summary.should be_nil
+  end
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iron-import
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.8
 platform: ruby
 authors:
 - Rob Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iron-extensions
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: CSV, HTML, XLS, and XLSX import processing support