row_boat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42b9a926cbca073ac25906f8f3ca224d2d665b62
-  data.tar.gz: 28e138c7db5dfa6e8ef4139c82033551da7b6dfe
+  metadata.gz: 349a16106d1b36fe5758231d5f7569573892293f
+  data.tar.gz: 02a54356f10fbd87fc23b618301cc597e7028ded
 SHA512:
-  metadata.gz: cfc989f812ad764feae56ab730d64fe5f6f5e57306eef8cf46c3940f5ba22394916bd9bd7372d2468a4f06141d9348fa82eae5a7a49f8dc47f165f0e6bf1b5ab
-  data.tar.gz: 7007c0b60355e42523f5f6b4158c7ae5c82c7d80e012f557dda2093841db42be017f8c54f7e142ee761764ef5f2476d0073af1d35b58b636be393e9b8ea24afc
+  metadata.gz: fbbb578399fdafbbb597af6658d2d09935e9599805bfcccb640df24344e0c4db0a2c94c0b35d3afdef7aaa02948933e17d299fa017f375a22133245b99970eae
+  data.tar.gz: be36d03d5051fd7e1810da7be25f368cab0ee1c7a285f4bfc6907db746297c38785d3e8b4306f6aadf3f9cffc600816b15cb3a06e3cd9b5e11bf42a71b8f504a

data/API.md

@@ -155,13 +155,13 @@ ImportProduct.import("path/to/product.csv")
 
 ### Description
 
-It is required that you override this method with a hash that maps columns in your CSV to their preferred names.
+It is required that you override this method with either a hash that maps columns in your CSV to their preferred names or an array of your preferred column names.
 
-By default
+By default when using a hash
 - CSV column names are downcased symbols of what they look like in the CSV.
 - CSV columns that are not mapped are ignored when processing the CSV.
 
-If you're familiar with [SmarterCSV](https://github.com/tilo/smarter_csv#documentation), this method essentially defines your `:key_mapping` and with the `:remove_unmapped_keys` setting set to `true`.
+If you're familiar with [SmarterCSV](https://github.com/tilo/smarter_csv#documentation), this method essentially defines your `:key_mapping` with the `:remove_unmapped_keys` setting set to `true` when provided with a hash. When given an array it is the `:user_provided_headers` option.
 
 You can change these defaults by overriding the [`options`](#options) method.
 
@@ -177,6 +177,15 @@ class ImportProduct < RowBoat::Base
     }
   end
 end
+
+# or...
+
+class ImportProduct < RowBoat::Base
+  # other required configuration omitted for brevity
+  def column_mapping
+    [:name, :price_in_cents]
+  end
+end
 ```
 
 ## `preprocess_row`
@@ -187,6 +196,8 @@ Implement this method if you need to do some work on the row before the record i
 
 If you return `nil` from this method, the row will be skipped in the import.
 
+You also have access to `row_number` here.
+
 If the work you intend to do with the row only requires changing one attribute, it is recommended that you override [`value_converters`](#value_converters) instead of this.
 
 ### Example
@@ -195,7 +206,7 @@ If the work you intend to do with the row only requires changing one attribute,
   class ImportProduct < RowBoat::Base
     # required configuration omitted for brevity
     def preprocess_row(row)
-      { default: :value }.merge(row)
+      { position: row_number }.merge(row)
     end
     # or...
     def preprocess_row(row)

data/README.md

@@ -38,7 +38,7 @@ Or install it yourself as:
 
 #### [Full documentation can be found here.](/API.md#rowboat-api)
 
-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 :)
+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

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

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

data/lib/row_boat/base.rb

@@ -6,6 +6,8 @@ require "smarter_csv"
 
 module RowBoat
   class Base
+    InvalidColumnMapping = Class.new(StandardError)
+
     attr_reader :csv_source
 
     class << self
@@ -120,6 +122,7 @@ module RowBoat
     # @see #preprocess_row
     def preprocess_rows(rows)
       rows.each_with_object([]) do |row, preprocessed_rows|
+        increment_row_number
         preprocessed_row = preprocess_row(row)
         preprocessed_rows << preprocessed_row unless preprocessed_row.nil?
       end
@@ -153,13 +156,11 @@ module RowBoat
     def default_options
       {
         chunk_size: 500,
-        key_mapping: column_mapping,
         recursive: true,
-        remove_unmapped_keys: true,
         validate: true,
         value_converters: csv_value_converters,
         wrap_in_transaction: true
-      }
+      }.merge(column_mapping_options)
     end
 
     # @api private
@@ -229,6 +230,28 @@ module RowBoat
 
     private
 
+    # @private
+    attr_reader :row_number
+
+    # @api private
+    # @private
+    def increment_row_number
+      @row_number = row_number.to_i + 1
+    end
+
+    # @api private
+    # @private
+    def column_mapping_options
+      case column_mapping
+      when Hash
+        { key_mapping: column_mapping, remove_unmapped_keys: true }
+      when Array
+        { user_provided_headers: column_mapping }
+      else
+        raise InvalidColumnMapping, "#column_mapping must be a Hash or an Array: got `#{column_mapping}`"
+      end
+    end
+
     # @api private
     # @private
     def not_implemented_error_message(method_name)

data/lib/row_boat/version.rb

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

metadata

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