row_boat 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c200c2448e877d0874f0535bf586603d7d86f66c
-  data.tar.gz: 68754e3bb5debe047ba3b48f31a3f3f6849ddbd7
+  metadata.gz: 3b62eece81abe5efcd17486c08f0e2ba6b654bd9
+  data.tar.gz: 6d3958463a1c159b07dc00ac3a820334b8189094
 SHA512:
-  metadata.gz: 35dda1c8b70719bb5f047fd7e9f3cd6824328096c7018ceae05e09e9790c99d8b8ad18fd7a9aa069a0df84c615a6bc00b29a24e824035f81cfa0c6d9f73cdbd2
-  data.tar.gz: 8111ee6feb86822b686a2b896ed5fc29e82563107ebe2fb80e85fe1df4dd2f3712ff8111262b395c9ac9596c59f8981b702e6b5c7e4969479ab038a35949ac38
+  metadata.gz: de9025837e9acad6c5ae29b838db3a48583a6f258b74e48833788ff6186046d678959513e7e98214b09b723b4d079940f3eec880e7a8cbe36de4323bcf4fd64d
+  data.tar.gz: 2fb52393859c0e1ec2ce272a6a888fbdaf032afc5a64ab1a2ea93946b3a8176d47e6a238b63a34cdd7435ee2aad5f03a6ca80e8b1aaef444c1529ef493418b50

data/API.md

@@ -48,6 +48,7 @@ It returns a hash containing
 - `:invalid_records` - an array of all records that failed to import since they were invalid. If you've configured the `:validate` option to be `false` it will be an empty array.
 - `:total_inserted` - the total number of records inserted into the database.
 - `:inserted_ids` - an array of all of the ids of records inserted into the database.
+- `:skipped_rows` - every row skipped by returning `nil` from [`preprocess_row`](#preprocess_row).
 
 If you want to pass additional information to help import CSVs, *don't override this method*. It just passes through to [`initialize`](#initialize) so override that :)
 
@@ -195,7 +196,7 @@ end
 
 Implement this method if you need to do some work on the row before the record is inserted/updated.
 
-If you return `nil` from this method, the row will be skipped in the import.
+If you return `nil` from this method, the row will be skipped in the import. You can access these rows in the return value from [`.import`](#import) (the `:skipped_rows` key).
 
 You also have access to `row_number` here.
 

data/README.md

@@ -23,17 +23,13 @@ It uses [SmarterCSV](https://github.com/tilo/smarter_csv) and [`activerecord-imp
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "row_boat", "~> 0.1"
+gem "row_boat", "~> 0.4"
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install row_boat
-
 ## Basic Usage
 
 #### [Full documentation can be found here.](/API.md#rowboat-api)
@@ -41,7 +37,7 @@ Or install it yourself as:
 Below we're defining the required methods ([`import_into`](/API.md#import_into) and [`column_mapping`](/API.md#column_mapping)) and a few additional options as well (via [`value_converters`](/API.md#value_converters) and [`options`](/API.md#options)). Checkout [API.md](/API.md#rowboat-api) for the full documentation for more details :)
 
 ```ruby
-class ImportProduct
+class ImportProduct < RowBoat::Base
   # required
   def import_into
     Product # The ActiveRecord class we want to import records into.

data/gemfiles/csv_import_1.1_and_0.18.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    row_boat (0.3.0)
+    row_boat (0.4.0)
       activerecord (>= 5.0.0)
       activerecord-import (~> 0.18.2)
       smarter_csv (~> 1.1)

data/lib/row_boat/base.rb

@@ -16,7 +16,7 @@ module RowBoat
       # @overload import(csv_source)
       #   @param csv_source [String, #read] a CSV-like object that SmarterCSV can read.
       #
-      # @return [Hash] a hash with +:invalid_records+, +:total_inserted+ and +:inserted_ids+.
+      # @return [Hash] a hash with +:invalid_records+, +:total_inserted+, +:inserted_ids+, and +:skipped_rows+.
       #
       # @see https://github.com/tilo/smarter_csv#documentation SmarterCSV Docs
       def import(*args, &block)
@@ -40,7 +40,7 @@ module RowBoat
     # Parses the csv and inserts/updates the database. You probably won't call this method directly,
     # instead you would call {RowBoat::Base.import}.
     #
-    # @return [Hash] a hash with +:invalid_records+, +:total_inserted+ and +:inserted_ids+.
+    # @return [Hash] a hash with +:invalid_records+, +:total_inserted+, +:inserted_ids+, and +:skipped_rows+.
     def import
       import_results = []
 
@@ -124,7 +124,7 @@ module RowBoat
       rows.each_with_object([]) do |row, preprocessed_rows|
         increment_row_number
         preprocessed_row = preprocess_row(row)
-        preprocessed_rows << preprocessed_row unless preprocessed_row.nil?
+        preprocessed_row ? preprocessed_rows << preprocessed_row : add_skipped_row(row)
       end
     end
 
@@ -246,12 +246,21 @@ module RowBoat
     # @private
     attr_reader :row_number
 
+    # @api private
+    # @private
+    attr_reader :skipped_rows
+
     # @api private
     # @private
     def increment_row_number
       @row_number = row_number.to_i + 1
     end
 
+    def add_skipped_row(row)
+      @skipped_rows ||= []
+      skipped_rows << row
+    end
+
     # @api private
     # @private
     def column_mapping_options
@@ -297,7 +306,8 @@ module RowBoat
       import_results.each_with_object(
         invalid_records: [],
         total_inserted: 0,
-        inserted_ids: []
+        inserted_ids: [],
+        skipped_rows: skipped_rows
       ) do |import_result, total_results|
         total_results[:invalid_records] += import_result.failed_instances
         total_results[:total_inserted] += import_result.num_inserts

data/lib/row_boat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RowBoat
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: row_boat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Crismali
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord