csv-importer 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ef35d5c77f6bc1eba14f38b6d68737e393ebb69
-  data.tar.gz: c670a2d4fa3b6dda957170eaeb1e46931ba57521
+  metadata.gz: 9de355b09e3f3610054a0e2ca5c7f27b6e333c1c
+  data.tar.gz: 759a79fb7217f50959c265cf433351460a21e7f4
 SHA512:
-  metadata.gz: 6efcbaf329d95b552f8a43201d816c2f0649ef20d511084e00f6a211f94eaa8f6042f9e04de7892ca3f2892d95f9a1dfa1e819558d56a9d7f0e3f188344eb774
-  data.tar.gz: d0d251d39386bef710e3773fed1a0d32a3ee3d3a11db5485682748a6ebf128ab045f2d6522d4143982a65473347f36ed67c3a79f0ca8934b500b21b5cf78cbc6
+  metadata.gz: 41d3f8ffff6fa2b92bf02a15c02e9713171d44c898efc929ff8daa79a6f7f9b6a9a666f586abb4874d4a7e738a58d2e2d72035fa447f2c80d5a62bf4ddefafd2
+  data.tar.gz: 721a1e4e3b86de3e633d5c62bb7cd5f602af14e82daa2257af1d9bb88bf3ef07e3ef3201ac327434a1310467210478cce1603600b4cb7c82fa88f4b47f15d721

data/CHANGELOG.md

@@ -1,6 +1,41 @@
 # Change Log
 
-### v0.1.3
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+## [0.2.0] - 2015-07-24
+
+### Added
+
+* `after_save` callback.
+
+```ruby
+progress_bar = ProgressBar.new
+
+UserImport.new(file: my_file) do
+  after_save do |user|
+    progress_bar.increment
+  end
+end
+```
+
+* You can define a composite identifier made of multiple columns.
+
+```ruby
+  # Update records with matching company_id AND employee_id
+  identifier :company_id, :employee_id
+```
+
+* You can set a custom `quote_char` at runtime. ([#26][] by [@shvetsovdm][])
+
+```ruby
+UserImport.new(file: csv_file, quote_char: "'")
+```
+
+## [0.1.3] - 2015-06-19
+
+### Added
 
 * You can now change the configuration at runtime. Example:
 
@@ -19,15 +54,23 @@ before saving it.
   enables you to use `id` as an identifier and import new entries
 without having to provide an `id`
 
-### v0.1.2
+## [0.1.2] - 2015-06-15
+
+### Fixed
 
 * `run!` was not *returning* a report object when the header was invalid.
 
-### v0.1.1
+## [0.1.1] - 2015-06-12
+
+### Changed
 
 * When calling `run!` on an import with invalid header we update the
 report object instead of raising an exception.
 
-### v0.1.0
+## [0.1.0] - 2015-06-11
 
 * Initial Release
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#26]: https://github.com/BrewhouseTeam/csv-importer/issues/26
+[@shvetsovdm]: https://github.com/shvetsovdm

data/README.md

@@ -24,8 +24,7 @@ Reporting progress and errors to the end-user is also key for a good
 experience.
 
 I went through this many times so I decided to build CSV Importer to
-save us a lot of trouble.
-
+save us the trouble.
 
 CSV Importer provides:
 
@@ -33,6 +32,9 @@ CSV Importer provides:
 * good reporting to the end user
 * support for wild encodings and CSV formats.
 
+It is compatible with ActiveRecord 4+ and any ORM that implements
+the class methods `transaction` and `find_by` and the instance method `save`.
+
 ## Usage tldr;
 
 Define your CSVImporter:
@@ -48,7 +50,7 @@ class ImportUserCSV
   column :last_name,  as: [ /last.?name/i, "nom" ]
   column :published,  to: ->(published, user) { user.published_at = published ? Time.now : nil }
 
-  identifier :email # will find_or_update via :email
+  identifier :email # will update_or_create via :email
 
   when_invalid :skip # or :abort
 end
@@ -215,6 +217,13 @@ end
 
 And yes, we'll look for an existing record using the downcased email. :)
 
+You can also define a composite identifier:
+
+```ruby
+  # Update records with matching company_id AND employee_id
+  identifier :company_id, :employee_id
+```
+
 ### Skip or Abort on error
 
 By default, we skip invalid records and report errors back to the user.
@@ -266,13 +275,12 @@ import = ImportUserCSV.new(file: my_file) do
 end
 ```
 
-### Preset attributes
+### `after_build` and `after_save` callbacks
 
 You can preset attributes (or perform any changes to the model) at
 configuration or runtime using `after_build`
 
 ```ruby
-
 class ImportUserCSV
   model User
 
@@ -292,6 +300,20 @@ import = ImportUserCSV.new(file: my_file) do
 end
 ```
 
+The `after_save` callback is run after each call to the method `save` no
+matter it fails or succeeds. It is quite handy to keep track of
+progress.
+
+```ruby
+progress_bar = ProgressBar.new
+
+UserImport.new(file: my_file) do
+  after_save do |user|
+    progress_bar.increment
+  end
+end
+```
+
 
 ### Validate the header
 
@@ -337,6 +359,32 @@ INVALID_EMAIL,bob
 
 The error returned should be: `{ "E-Mail" => "is invalid" }`
 
+### Custom quote char
+
+You can handle exotic quote chars with the `quote_char` option.
+
+```csv
+email,name
+bob@example.com,'bob "elvis" wilson'
+```
+
+```ruby
+import = ImportUserCSV.new(content: csv_content)
+import.run!
+import.report.status
+  # => :invalid_csv_file
+import.report.messages
+  # => CSV::MalformedCSVError: Illegal quoting in line 2.
+```
+
+Let's provide a valid quote char:
+
+```ruby
+import = ImportUserCSV.new(content: csv_content, quote_char: "'")
+import.run!
+  # => [ ["bob@example.com", "bob \"elvis\" wilson"] ]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/csv_importer.rb

@@ -30,14 +30,20 @@ require "csv_importer/dsl"
 module CSVImporter
   class Error < StandardError; end
 
+   # Setup DSL and config object
   def self.included(klass)
     klass.extend(Dsl)
-    klass.include(Dsl)
     klass.define_singleton_method(:config) do
       @config ||= Config.new
     end
   end
 
+  # Instance level config will run against this configurator
+  class Configurator < Struct.new(:config)
+    include Dsl
+  end
+
+
   # Defines the path, file or content of the csv file.
   # Also allows you to overwrite the configuration at runtime.
   #
@@ -51,7 +57,7 @@ module CSVImporter
     @config = self.class.config.dup
     @config.attributes = args.last
     @report = Report.new
-    instance_exec(&block) if block
+    Configurator.new(@config).instance_exec(&block) if block
   end
 
   attr_reader :csv, :report, :config
@@ -65,7 +71,7 @@ module CSVImporter
   def rows
     csv.rows.map do |row_array|
       Row.new(header: header, row_array: row_array, model_klass: config.model,
-              identifier: config.identifier, after_build_blocks: config.after_build_blocks)
+              identifiers: config.identifiers, after_build_blocks: config.after_build_blocks)
     end
   end
 
@@ -84,7 +90,8 @@ module CSVImporter
   # Run the import. Return a Report.
   def run!
     if valid_header?
-      @report = Runner.call(rows: rows, when_invalid: config.when_invalid)
+      @report = Runner.call(rows: rows, when_invalid: config.when_invalid,
+                            after_save_blocks: config.after_save_blocks)
     else
       @report
     end
@@ -92,4 +99,3 @@ module CSVImporter
     @report = Report.new(status: :invalid_csv_file, parser_error: e.message)
   end
 end
-

data/lib/csv_importer/config.rb

@@ -5,13 +5,18 @@ module CSVImporter
 
     attribute :model
     attribute :column_definitions, Array[ColumnDefinition], default: proc { [] }
-    attribute :identifier, Symbol
+    attribute :identifiers, Array[Symbol], default: []
     attribute :when_invalid, Symbol, default: proc { :skip }
     attribute :after_build_blocks, Array[Proc], default: []
+    attribute :after_save_blocks, Array[Proc], default: []
 
     def after_build(block)
       self.after_build_blocks << block
     end
+
+    def after_save(block)
+      self.after_save_blocks << block
+    end
   end
 end
 

data/lib/csv_importer/csv_reader.rb

@@ -7,12 +7,13 @@ module CSVImporter
     attribute :content, String
     attribute :file # IO
     attribute :path, String
+    attribute :quote_char, String, default: '"'
 
     def csv_rows
       @csv_rows ||= begin
         sane_content = sanitize_content(read_content)
         separator = detect_separator(sane_content)
-        cells = CSV.parse(sane_content, col_sep: separator)
+        cells = CSV.parse(sane_content, col_sep: separator, quote_char: quote_char)
         sanitize_cells(cells)
       end
     end

data/lib/csv_importer/dsl.rb

@@ -10,10 +10,12 @@ module CSVImporter
       config.column_definitions << options.merge(name: name)
     end
 
-    def identifier(identifier)
-      config.identifier = identifier
+    def identifier(*identifiers)
+      config.identifiers = identifiers
     end
 
+    alias_method :identifiers, :identifier
+
     def when_invalid(action)
       config.when_invalid = action
     end
@@ -21,5 +23,9 @@ module CSVImporter
     def after_build(&block)
       config.after_build(block)
     end
+
+    def after_save(&block)
+      config.after_save(block)
+    end
   end
 end

data/lib/csv_importer/row.rb

@@ -9,13 +9,14 @@ module CSVImporter
     attribute :header, Header
     attribute :row_array, Array[String]
     attribute :model_klass
-    attribute :identifier, Symbol
+    attribute :identifiers, Array[Symbol]
     attribute :after_build_blocks, Array[Proc], default: []
 
     # The model to be persisted
     def model
       @model ||= begin
         model = find_or_build_model
+
         set_attributes(model)
       end
     end
@@ -85,13 +86,14 @@ module CSVImporter
     end
 
     def find_model
-      return nil if identifier.nil?
+      return nil if identifiers.empty?
 
       model = build_model
       set_attributes(model)
-      if value = model.public_send(identifier)
-        model_klass.public_send("find_by_#{identifier}", value)
-      end
+      query = Hash[
+        identifiers.map { |identifier| [ identifier, model.public_send(identifier) ] }
+      ]
+      model_klass.find_by(query)
     end
 
     def build_model

data/lib/csv_importer/runner.rb

@@ -11,6 +11,7 @@ module CSVImporter
 
     attribute :rows, Array[Row]
     attribute :when_invalid, Symbol
+    attribute :after_save_blocks, Array[Proc], default: []
 
     attribute :report, Report, default: proc { Report.new }
 
@@ -58,6 +59,7 @@ module CSVImporter
           end
 
           add_to_report(row, tags)
+          after_save_blocks.each { |block| block.call(row.model) }
         end
       end
     end

data/lib/csv_importer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv-importer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Philippe Creux
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus