csv-importer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9de355b09e3f3610054a0e2ca5c7f27b6e333c1c
-  data.tar.gz: 759a79fb7217f50959c265cf433351460a21e7f4
+  metadata.gz: 07b837a8650d40afb4feb4be4b9d1679d4f7a41a
+  data.tar.gz: f74a63d0b1c65c647ca8ccd102151a2c542f1212
 SHA512:
-  metadata.gz: 41d3f8ffff6fa2b92bf02a15c02e9713171d44c898efc929ff8daa79a6f7f9b6a9a666f586abb4874d4a7e738a58d2e2d72035fa447f2c80d5a62bf4ddefafd2
-  data.tar.gz: 721a1e4e3b86de3e633d5c62bb7cd5f602af14e82daa2257af1d9bb88bf3ef07e3ef3201ac327434a1310467210478cce1603600b4cb7c82fa88f4b47f15d721
+  metadata.gz: 0b3453bf9dc18bc3dcd66b04b7901c5e68d9c66afa362d4e0ae9965dc82745a9380dd53e8d5fbdcc42cc7ab4b3501f3d1debfe2894e013b9fa08a7dc90012dcb
+  data.tar.gz: 633f1f1e78cb60a1dd911349ab5651d498acfb0a1ff8983f88e144a4d429de17a43d3e2bd43e12538a1a31c15edf327ccca290c908f727f06811253dc8aaf8d5

data/CHANGELOG.md

@@ -2,7 +2,31 @@
 
 All notable changes to this project will be documented in this file.
 
-## Unreleased
+## [0.3.0] - 2016-02-05
+
+### Added
+
+* Empty cells are now empty strings. You don't have to check for a nil
+  value when applying a transformation anymore.
+
+```ruby
+  # Prior to 0.3, an empty cell turns into `nil`
+  column :email, to: ->(email) { email.downcase unless email.nil? }
+
+  # From 0.3, an empty cell turns into `""`
+  column :email, to: ->(email) { email.downcase }
+```
+
+* You can now skip an import in the `after_build` callback:
+
+```ruby
+UserImport.new(file: csv_file) do
+  # Skip existing records
+  after_build do |user|
+    skip! if user.persisted?
+  end
+end
+```
 
 ## [0.2.0] - 2015-07-24
 
@@ -41,7 +65,7 @@ UserImport.new(file: csv_file, quote_char: "'")
 
 ```ruby
 UserImport.new(file: csv_file) do
-  after_build do
+  after_build do |user|
     user.import_by_user = current_user
   end
 end

data/README.md

@@ -169,7 +169,7 @@ Now, email could also be spelled "e-mail", or "mail", or even "courriel"
 Nice, emails should be downcased though, so let's do this.
 
 ```ruby
-  column :email, as: [/e.?mail/i, "courriel"], to: ->(email) { email.downcase if email }
+  column :email, as: [/e.?mail/i, "courriel"], to: ->(email) { email.downcase }
 ```
 
 If you need to do more advanced stuff, you've got access to the model:
@@ -209,7 +209,7 @@ class ImportUserCSV
 
   model User
 
-  column :email, to: ->(email) { email.downcase if email }
+  column :email, to: ->(email) { email.downcase }
 
   identifier :email
 end
@@ -236,7 +236,7 @@ class ImportUserCSV
 
   model User
 
-  column :email, to: ->(email) { email.downcase if email }
+  column :email, to: ->(email) { email.downcase }
 
   on_error :abort
 end
@@ -287,7 +287,7 @@ class ImportUserCSV
   column :email
 
   after_build do |user|
-    user.name = email.split('@').first if email
+    user.name = email.split('@').first
   end
 end
 
@@ -314,6 +314,20 @@ UserImport.new(file: my_file) do
 end
 ```
 
+### Skip import
+
+You can skip the import of a model by calling `skip!` in an
+`after_build` block:
+
+```ruby
+UserImport.new(file: csv_file) do
+  # Skip existing records
+  after_build do |user|
+    skip! if user.persisted?
+  end
+end
+```
+
 
 ### Validate the header
 

data/lib/csv_importer/csv_reader.rb

@@ -13,7 +13,7 @@ module CSVImporter
       @csv_rows ||= begin
         sane_content = sanitize_content(read_content)
         separator = detect_separator(sane_content)
-        cells = CSV.parse(sane_content, col_sep: separator, quote_char: quote_char)
+        cells = CSV.parse(sane_content, col_sep: separator, quote_char: quote_char, skip_blanks: true)
         sanitize_cells(cells)
       end
     end
@@ -54,11 +54,11 @@ module CSVImporter
       SEPARATORS.sort_by { |separator| csv_content.count(separator) }.last
     end
 
-    # Strip cells
+    # Remove trailing white spaces and ensure we always return a string
     def sanitize_cells(rows)
       rows.map do |cells|
         cells.map do |cell|
-          cell.strip if cell
+          cell ? cell.strip : ""
         end
       end
     end

data/lib/csv_importer/report.rb

@@ -21,6 +21,8 @@ module CSVImporter
     attribute :updated_rows, Array[Row], default: proc { [] }
     attribute :failed_to_create_rows, Array[Row], default: proc { [] }
     attribute :failed_to_update_rows, Array[Row], default: proc { [] }
+    attribute :create_skipped_rows, Array[Row], default: proc { [] }
+    attribute :update_skipped_rows, Array[Row], default: proc { [] }
 
     attribute :message_generator, Class, default: proc { ReportMessage }
 

data/lib/csv_importer/row.rb

@@ -11,6 +11,7 @@ module CSVImporter
     attribute :model_klass
     attribute :identifiers, Array[Symbol]
     attribute :after_build_blocks, Array[Proc], default: []
+    attribute :skip, Boolean, default: false
 
     # The model to be persisted
     def model
@@ -42,7 +43,7 @@ module CSVImporter
         set_attribute(model, column_definition, value)
       end
 
-      after_build_blocks.each { |block| block.call(model) }
+      after_build_blocks.each { |block| instance_exec(model, &block) }
 
       model
     end
@@ -99,5 +100,9 @@ module CSVImporter
     def build_model
       model_klass.new
     end
+
+    def skip!
+      self.skip = true
+    end
   end
 end

data/lib/csv_importer/runner.rb

@@ -52,10 +52,14 @@ module CSVImporter
             tags << :create
           end
 
-          if row.model.save
-            tags << :success
+          if row.skip?
+            tags << :skip
           else
-            tags << :failure
+            if row.model.save
+              tags << :success
+            else
+              tags << :failure
+            end
           end
 
           add_to_report(row, tags)
@@ -74,6 +78,10 @@ module CSVImporter
         report.updated_rows
       when [ :update, :failure ]
         report.failed_to_update_rows
+      when [ :create, :skip ]
+        report.create_skipped_rows
+      when [ :update, :skip ]
+        report.update_skipped_rows
       else
         raise "Invalid tags #{tags.inspect}"
       end

data/lib/csv_importer/version.rb

@@ -1,3 +1,3 @@
 module CSVImporter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv-importer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Philippe Creux
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: CSV Import for humans