csv_step_importer 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010566e1eef5979197228e21e4b1767c46b4a01dac5b2c5b2a5ab0ced475728a
-  data.tar.gz: a471e746cef84c4466b064d73da3d8528d68a285cd579b3f5a51ed9ba81a1ffb
+  metadata.gz: 38a5dd24101512b6117a0d8d33020b52ccedbeb816b9b49a64473471b471bd64
+  data.tar.gz: 1c2bccce9e7945daba6bd90ac18aa68a77f14b401f8c1af6bc0f8d619d94dca9
 SHA512:
-  metadata.gz: e85c978b53a36fc142780d740b20929a5352ab9c76c537e6ce323893425192da56d5ace7c1b01fea93ea5388f0daa160955d2d2b1908afc752273b512e0f7ef3
-  data.tar.gz: ca0dc39aed81533c2de6323e7b112f83783845846a83eb346db641b8ed65adc76ce9b53bb0ba846638ffcca8c88a41e67f490e91587c4a15c868a3746f5754c3
+  metadata.gz: fe1abd4a1c0078c4af1e629e769612c8dce19a718522607e692b3d323ff681cbc83335073e4924d94f2aa6fcdccbe045e638febea102d15625adb742aa65f307
+  data.tar.gz: a63422a10246541cfa0537538c625c51c55746bfa1730ad718bd2895f6955e87ef8893de3d90cf687d8eb0d9cc25794bb44cf919d21aa1585add255b97f053f5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv_step_importer (0.7.2)
+    csv_step_importer (0.7.4)
       activemodel
       activerecord-import
       activesupport

data/README.md

@@ -1,8 +1,11 @@
-# CSVStepImporter
+# csv_step_importer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/csv_step_importer`. To experiment with that code, run `bin/console` for an interactive prompt.
+A library to validate, speed up and organize bulk insertion of complex CSV data, including multi-table data.
 
-TODO: Delete this and the text above, and describe your gem
+It depends on
+
+- [zdennis/activerecord-import](https://github.com/zdennis/activerecord-import)
+- [GitHub - tilo/smarter_csv](https://github.com/tilo/smarter_csv)
 
 ## Installation
 
@@ -22,7 +25,64 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Hello world
+
+Create a new rails application:
+
+```shell
+rails new currency_wiki --database=mysql
+cd currency_wiki
+echo "gem 'csv_step_importer'" >> Gemfile
+bundle install
+rails g model currency code:string:uniq name:string
+rails db:create db:migrate
+```
+
+Then edit the model like this:
+
+/app/models/currency.rb
+
+```ruby
+class Currency < ApplicationRecord
+  class ImportableModel < CSVStepImporter::Model::ImportableModel
+    # The model to be updated
+    def model_class
+      ::Currency
+    end
+
+    def columns
+      [:code, :name, :created_at, :updated_at]
+    end
+
+    def on_duplicate_key_update
+      [:name, :updated_at]
+    end
+  end
+end
+```
+
+
+Create a test CSV file and upload it
+
+```shell
+rails c
+```
+
+```ruby
+File.open("currencies.csv", "w") do |file|
+  file.write(<<~CSV)
+    Name,Code
+    Euro,EUR
+    United States dollar,USD
+    Japanese Yen,JPY
+  CSV
+end
+
+CSVStepImporter::File.new(path: 'currencies.csv', processor_classes: [Currency::ImportableModel]).save
+
+puts Currency.all.to_yaml
+```
+
 
 ## Development
 
@@ -32,7 +92,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/csv_step_importer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fruwe/csv_step_importer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the CSVStepImporter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/csv_step_importer/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CSVStepImporter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fruwe/csv_step_importer/blob/master/CODE_OF_CONDUCT.md).

data/lib/csv_step_importer/model/importable_model.rb

@@ -19,7 +19,8 @@ module CSVStepImporter
 
       # set to nil in order to deactivate
       def reflector_class
-        CSVStepImporter::Model::Reflector
+        # in order to enable reflections return reflector class: CSVStepImporter::Model::Reflector
+        nil
       end
 
       # example: env[:company].company_users

data/lib/csv_step_importer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CSVStepImporter
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_step_importer
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Christian-Manuel Butzke