csv-importer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2e473bcdd6155c530c3b6c8006b51468aee8c36
-  data.tar.gz: 4801594f03a9fa3bff2ff0513ba627992db5e473
+  metadata.gz: 7ef35d5c77f6bc1eba14f38b6d68737e393ebb69
+  data.tar.gz: c670a2d4fa3b6dda957170eaeb1e46931ba57521
 SHA512:
-  metadata.gz: a497a2962a71fbdc9de86c616322542a39786e119a0ddb3e63aa7e6962212abff1f24efe9eb0865d20fb7ccc234d9c9b853ae471c90a9ea042cd4689da841d67
-  data.tar.gz: 8de23f9e3c71ca2c05b85c9de92a97a84457374d9e6b50b8b4a2622dcd4490f82359a0fa41ac5e64ae492ed298b8feebe7ebe2b4a9ea6e145e0257cdcd7b838c
+  metadata.gz: 6efcbaf329d95b552f8a43201d816c2f0649ef20d511084e00f6a211f94eaa8f6042f9e04de7892ca3f2892d95f9a1dfa1e819558d56a9d7f0e3f188344eb774
+  data.tar.gz: d0d251d39386bef710e3773fed1a0d32a3ee3d3a11db5485682748a6ebf128ab045f2d6522d4143982a65473347f36ed67c3a79f0ca8934b500b21b5cf78cbc6

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .DS_Store
+/spec/examples.txt

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Change Log
+
+### v0.1.3
+
+* You can now change the configuration at runtime. Example:
+
+```ruby
+UserImport.new(file: csv_file) do
+  after_build do
+    user.import_by_user = current_user
+  end
+end
+```
+
+* Add `after_build` hooks to perform arbitrary operations on a model
+before saving it.
+
+* `identifier` does not have to be a required attribute anymore. That
+  enables you to use `id` as an identifier and import new entries
+without having to provide an `id`
+
+### v0.1.2
+
+* `run!` was not *returning* a report object when the header was invalid.
+
+### v0.1.1
+
+* When calling `run!` on an import with invalid header we update the
+report object instead of raising an exception.
+
+### v0.1.0
+
+* Initial Release

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in csv-importer.gemspec
 gemspec
 
-gem 'rspec'
+gem 'rspec', '~> 3.3.0'
 gem 'guard-rspec'
 gem 'activemodel'
 gem 'simplecov', require: nil

data/Guardfile

@@ -48,6 +48,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
 
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  # Specs are fast, let's run them all!
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec" }
 
 end

data/README.md

@@ -123,7 +123,8 @@ class ImportUserCSV
 end
 ```
 
-You can change the configuration at runtime to import associated records.
+You can change the configuration at runtime to scope down to associated
+records.
 
 ```ruby
 class Team
@@ -132,9 +133,12 @@ end
 
 team = Team.find(1)
 
-ImportUserCSV.new(path: "tmp/my_file.csv", model: team.users)
+ImportUserCSV.new(path: "tmp/my_file.csv") do
+  model team.users
+end
 ```
 
+
 ### Define columns and their mapping
 
 This is where the fun begins.
@@ -157,37 +161,19 @@ Now, email could also be spelled "e-mail", or "mail", or even "courriel"
 
 
 ```ruby
-class ImportUserCSV
-  include CSVImporter
-
-  model User
-
   column :email, as: [/e.?mail/i, "courriel"]
-end
 ```
 
 Nice, emails should be downcased though, so let's do this.
 
 ```ruby
-class ImportUserCSV
-  include CSVImporter
-
-  model User
-
   column :email, as: [/e.?mail/i, "courriel"], to: ->(email) { email.downcase if email }
-end
 ```
 
 If you need to do more advanced stuff, you've got access to the model:
 
 ```ruby
-class ImportUserCSV
-  include CSVImporter
-
-  model User
-
   column :email, as: [/e.?mail/i, "courriel"], to: ->(email, user) { user.email = email.downcase; model.super_user! if email[/@brewhouse.io\z/] }
-end
 ```
 
 Now, what if the user does not provide the email column? It's not worth
@@ -275,9 +261,38 @@ easy:
 
 ```ruby
 team = Team.find(1)
-import = ImportUserCSV.new(file: my_file, model: team.users)
+import = ImportUserCSV.new(file: my_file) do
+  model team.users
+end
+```
+
+### Preset attributes
+
+You can preset attributes (or perform any changes to the model) at
+configuration or runtime using `after_build`
+
+```ruby
+
+class ImportUserCSV
+  model User
+
+  column :email
+
+  after_build do |user|
+    user.name = email.split('@').first if email
+  end
+end
+
+# assuming `current_user` is available
+
+import = ImportUserCSV.new(file: my_file) do
+  after_build do |user|
+    user.created_by_user = current_user
+  end
+end
 ```
 
+
 ### Validate the header
 
 On a web application, as soon as a CSV file is uploaded, you can check

data/lib/csv_importer.rb

@@ -32,8 +32,9 @@ module CSVImporter
 
   def self.included(klass)
     klass.extend(Dsl)
-    klass.define_singleton_method(:csv_importer_config) do
-      @csv_importer_config ||= Config.new
+    klass.include(Dsl)
+    klass.define_singleton_method(:config) do
+      @config ||= Config.new
     end
   end
 
@@ -45,11 +46,12 @@ module CSVImporter
   #   .new(file: my_csv_file)
   #   .new(path: "subscribers.csv", model: newsletter.subscribers)
   #
-  def initialize(*args)
+  def initialize(*args, &block)
     @csv = CSVReader.new(*args)
-    @config = self.class.csv_importer_config.dup
+    @config = self.class.config.dup
     @config.attributes = args.last
     @report = Report.new
+    instance_exec(&block) if block
   end
 
   attr_reader :csv, :report, :config
@@ -61,8 +63,10 @@ module CSVImporter
 
   # Initialize and return the `Row`s for the current CSV file
   def rows
-    csv.rows.map { |row_array| Row.new(header: header, row_array: row_array,
-                                       model_klass: config.model, identifier: config.identifier) }
+    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)
+    end
   end
 
   def valid_header?

data/lib/csv_importer/config.rb

@@ -7,6 +7,11 @@ module CSVImporter
     attribute :column_definitions, Array[ColumnDefinition], default: proc { [] }
     attribute :identifier, Symbol
     attribute :when_invalid, Symbol, default: proc { :skip }
+    attribute :after_build_blocks, Array[Proc], default: []
+
+    def after_build(block)
+      self.after_build_blocks << block
+    end
   end
 end
 

data/lib/csv_importer/dsl.rb

@@ -3,19 +3,23 @@ module CSVImporter
   # It is a thin proxy to the Config object
   module Dsl
     def model(model_klass)
-      csv_importer_config.model = model_klass
+      config.model = model_klass
     end
 
     def column(name, options={})
-      csv_importer_config.column_definitions << options.merge(name: name)
+      config.column_definitions << options.merge(name: name)
     end
 
     def identifier(identifier)
-      csv_importer_config.identifier = identifier
+      config.identifier = identifier
     end
 
     def when_invalid(action)
-      csv_importer_config.when_invalid = action
+      config.when_invalid = action
+    end
+
+    def after_build(&block)
+      config.after_build(block)
     end
   end
 end

data/lib/csv_importer/row.rb

@@ -9,17 +9,13 @@ module CSVImporter
     attribute :header, Header
     attribute :row_array, Array[String]
     attribute :model_klass
-    attribute :identifier
+    attribute :identifier, Symbol
+    attribute :after_build_blocks, Array[Proc], default: []
 
     # The model to be persisted
     def model
       @model ||= begin
-        model = if identifier
-          find_or_build_model
-        else
-          build_model
-        end
-
+        model = find_or_build_model
         set_attributes(model)
       end
     end
@@ -33,13 +29,20 @@ module CSVImporter
     def set_attributes(model)
       header.columns.each do |column|
         value = csv_attributes[column.name]
-        column_definition = column.definition
+        begin
+          value = value.dup if value
+        rescue TypeError
+          # can't dup Symbols, Integer etc...
+        end
 
+        column_definition = column.definition
         next if column_definition.nil?
 
         set_attribute(model, column_definition, value)
       end
 
+      after_build_blocks.each { |block| block.call(model) }
+
       model
     end
 
@@ -78,10 +81,17 @@ module CSVImporter
     end
 
     def find_or_build_model
+      find_model || build_model
+    end
+
+    def find_model
+      return nil if identifier.nil?
+
       model = build_model
       set_attributes(model)
-      value = model.public_send(identifier)
-      model_klass.public_send("find_by_#{identifier}", value) || build_model
+      if value = model.public_send(identifier)
+        model_klass.public_send("find_by_#{identifier}", value)
+      end
     end
 
     def build_model

data/lib/csv_importer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv-importer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Philippe Creux
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile