rails_admin_import 1.3.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 433bf6ef9b6b129fe87eaefcf77c073074c525ee
-  data.tar.gz: 6aa3d4adba6761d8dd66fa2546013402484a97fd
+SHA256:
+  metadata.gz: b0b71f8452cd6e451b12a22c3d3afb9418bd9308857e11522007db476f014e29
+  data.tar.gz: df443cf15365e4c8ad61d81db2f9ba49bb582388cb9022f24ebeaacea2725b83
 SHA512:
-  metadata.gz: 848291b1ee4367e81937750690f228500d3e3f54d3832b4fea4c9e3261b7f80fe3d6c6540eec54c5d422fcb577f1ca2ed225b980403409f336b31c5f6e3ab634
-  data.tar.gz: 6967a8a96dcd8a63496341bf958700e862b6e2076ec82fd213bd72813e97051d0a48e44ca4eccd0ed790b5196414790504d00108ca7f1b89621b9b84d94fd812
+  metadata.gz: 901d0f3cc189f9a51acf9e7cd492f66f28958a8a205c183f31138367caecb3639b7c6d47c66e866459e7b4739a2b51b93c44b47dc1c23f5d7932fe5563cffa8b
+  data.tar.gz: f9187fe631aa5e2e0ac0c2fcacc7d4a966d682fff9afefcb047608aaf4e9bb8587b56a615da95de7b429df05e9b9ecdff30c00f7320b0a0e3db090894036ba04

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Change Log
 
+# 2.3.0 / 2021-06-11
+
+- Added an option to pass filename for each record. Thanks @waheedi
+- Enumeration translation. Thanks @zaknafain
+
+# 2.2.0 / 2019-02-24
+
+- Switch to using CharlockHolmes for character detection. Thanks @codealchemy
+- Readme improvements. Thanks @olleolleolle
+
+# 2.1.0 / 2017-11-18
+
+- French translation. Thanks @rodinux
+- Check for blank headers. Thanks @JuandGirald
+- Italian translation. Thanks @aprofiti
+- Remove haml dependency. Thanks @prem-prakash
+- Japanese translation. Thanks @higumachan
+- Multiple mapping keys. Thanks @dmitrypol
+- Add more hooks during import
+
+# 2.0.0 / 2016-05-04
+
+- Pull in the encoding list from the Encoding module instead of RailsAdmin. Thanks @baldursson, @patricklewis and @lucasff
+
+# 1.4.0 / 2016-02-26
+
+- Implement row limit (default maximum is 1000 rows). Thanks @codealchemy!
+- Document mapping keys. Thanks @zrisher!
+- Ignore columns with blank headers in CSV files
+
 # 1.3.1 / 2016-02-11
 
 - Bugfix: Create log/import directory when logging config option is enabled. Thanks @yovasx2!

data/README.md

@@ -1,17 +1,15 @@
 # Rails Admin Import
 
-[![Build Status](https://travis-ci.org/monkbroc/rails_admin_import.svg?branch=master)](https://travis-ci.org/monkbroc/rails_admin_import)
+[![Build Status](https://github.com/monkbroc/rails_admin_import/actions/workflows/ruby.yml/badge.svg)](https://github.com/monkbroc/rails_admin_import/actions/workflows/ruby.yml)
 
 Plugin functionality to add generic import to Rails Admin from CSV, JSON and XLSX files
 
-*This Readme is for version 1.x. If you are still using version 0.1.x, see [this branch](https://github.com/stephskardal/rails_admin_import/tree/legacy)*
-
 ## Installation
 
 * First, add to Gemfile:
 
-```
-gem "rails_admin_import", "~> 1.2"
+```ruby
+gem "rails_admin_import", "~> 2.3"
 ```
 
 * Define configuration in `config/initializers/rails_admin_import.rb`:
@@ -28,8 +26,10 @@ RailsAdmin.config do |config|
 
   # Optional:
   # Configure global RailsAdminImport options
+  # Configure pass filename to records hashes
   config.configure_with(:import) do |config|
     config.logging = true
+    config.pass_filename = true
   end
 
   # Optional:
@@ -51,11 +51,109 @@ cannot :import, :all
 can :import, [User, Model1, Model2]
 ```
 
-## File format
+## Usage
+
+Model instances can be both created and updated from import data. Any fields
+can be imported as long as they are allowed by the model's configuration.
+Associated records can be looked up for both singular and plural relationships.
+Both updating existing records and associating records requires the use of
+**mapping keys**.
+
+### Mapping Keys
+
+Every importable class has a mapping key that uniquely identifies its
+instances. The mapping key can be one or more fields. The value for
+these fields can then be provided in import data, either to update the
+existing record or to attach it through an association to another model.
+This concept exists because `id`s are often not constant when moving
+records between data stores.
+
+For example, a `User` model may have an `email` field. When uploading a set
+of users where some already exist in our database, we can select "email" as
+our mapping key and then provide that field on each record in our data,
+allowing us to update existing records with matching emails.
+
+Using a csv formatted example:
+
+```
+Email,First name,Last name
+peter.gibbons@initech.com,Peter,Gibbons
+michael.bolton@initech.com,Michael,Bolton
+```
+
+would look for existing users with those emails. If one was found, its name
+fields would be updated. Otherwise, a new one would be created.
+
+For updating building owners, the mapping key could be `street_address` and
+`zip_code`.
+
+Similarly, if each user has favorite books, we could set the mapping key
+for `Book` to be `isbn` and then include the isbn for their books within each
+user record. The syntax for this is to use the name of the associated model as
+the field name, no matter what actual mapping key has been selected. So
+a user record would have one or more fields named "Book" that include each
+associated book's ISBN.
+
+Again using a csv formatted example:
+
+```
+Email, Book, Book, Book
+peter.gibbons@initech.com, 9781119997870, 9780671027032
+michael.bolton@initech.com, 9780446677479
+```
+
+would look up books with those ISBNs and attach them to those users.
+
+Mapping keys can be selected on the import page. Their defaults can also be
+globally configured in the config file:
+
+```ruby
+RailsAdmin.config do |config|
+  config.model 'User' do
+    import do
+      mapping_key :email
+      # for multiple values, use mapping_key [:first_name, :last_name]
+      mapping_key_list [:email, :some_other_id]
+    end
+  end
+end
+```
+
+Since in models with large number of fields it doesn't make sense to use
+most of them as mapping values, you can add `mapping_key_list` to
+restrict which fields can be selected as mapping key in the UI during import.
+
+Note that a matched record must exist when attaching associated models, or the
+imported record will fail and be skipped.
+
+Complex associations (`has_one ..., :through` or polymorphic associations)
+need to be dealt with via custom logic called by one of the import hooks
+(see below for more detail on using hooks).  If we wanted to import
+`Service`s and attach them to a `User`, but the user relationship
+existed through an intermediary model called `ServiceProvider`, we could
+provide a `user_email` field in our records and handle the actual
+association with an import hook:
+
+```ruby
+class Service < ActiveRecord::Base
+  belongs_to :service_provider
+  has_one :user, through: :service_provider
+
+  def before_import_save(record)
+    if (email = record[:user_email]) && (user = User.find_by_email(email))
+      self.service_provider = user.service_provider
+    end
+  end
+end
+```
+
+Importing new records by id is not recommended since it ignores the sequences of ids in database. That will lead to `ERROR: duplicate key value violates unique constraint` in future. You can work around this issue by adding an `import_id` column to your model, renaming the `id` column in your CSV to `import_id` and using `import_id` as the update lookup field.
+
+### File format
 
 The format is inferred by the extension (.csv, .json or .xlsx).
 
-### CSV
+#### CSV
 
 The first line must contain attribute names. They will be converted to lowercase and underscored (First Name ==> first_name).
 
@@ -71,29 +169,58 @@ Peter,Gibbons,IT,Management
 Michael,Bolton,IT,
 ```
 
-### JSON
+Blank lines will be skipped.
+
+#### JSON
 
 The file must be an array or an object with a root key the same name as the plural model name, i.e. the default Rails JSON output format with include_root_in_json on or off.
 
-### XLSX
+#### XLSX
 
 The Microsoft Excel XLM format (XLSX) is supported, but not the old binary Microsoft Excel format (XLS).
 
 The expected rows and columns are the same as for the CSV format (first line contains headers, multiple columns for "many" associations).
 
+Blank lines will be skipped.
+
 ## Configuration
 
 ### Global configuration options
 
+```ruby
+RailsAdmin.config do |config|
+  config.actions do
+    all
+    import
+  end
+
+  # Default global RailsAdminImport options
+  config.configure_with(:import) do |config|
+    config.logging = false
+    config.line_item_limit = 1000
+    config.update_if_exists = false
+    config.pass_filename = false
+    config.rollback_on_error = false
+    config.header_converter = lambda do |header|
+      header.parameterize.underscore if header.present?
+    end
+    config.csv_options = {}
+  end
+end
+```
+
 * __logging__ (default `false`): Save a copy of each imported file to log/import and a detailed import log to log/rails_admin_import.log
 
-* __line_item_limit__ (default `1000`): max number of items that can be imported at one time. TODO: Currently this is suggested but not enforced.
+* __line_item_limit__ (default `1000`): max number of items that can be imported at one time.
+
+* __update_if_exists__ (default `false`): default value for the "Update if exists" checkbox on the import page.
 
 * __rollback_on_error__ (default `false`): import records in a transaction and rollback if there is one error. Only for ActiveRecord, not Mongoid.
 
 * __header_converter__ (default `lambda { ... }`): a lambda to convert each CSV header text string to a model attribute name. The default header converter converts to lowercase and replaces spaces with underscores.
 
 * __csv_options__ (default `{}`): a hash of options that will be passed to a new [CSV](http://ruby-doc.org/stdlib-2.0.0/libdoc/csv/rdoc/CSV.html) instance
+* __pass_filename__ (default `false`): Access the uploaded file name in your model actions, for example if set to true, inside each record, there will be an addtional property `record[:filename_importer]` which contains the file name of the currently uploaded file.
 
 ### Model-specific configuration
 
@@ -157,7 +284,7 @@ end
 RailsAdmin.config do |config|
   config.model 'User' do
     import do
-      default_excluded_fields [:created_at, :updated_at]
+      default_excluded_fields [:created_at, :updated_at, :deleted_at, :c_at, :u_at]
     end
   end
 end
@@ -165,18 +292,56 @@ end
 
 ## Import hooks
 
-
-Define instance methods on your models to be hooked into the import process, if special/additional processing is required on the data:
+Define methods on your models to be hooked into the import process, if special/additional processing is required on the data:
 
 ```ruby
 # some model
 class User < ActiveRecord::Base
+  def self.before_import
+    # called on the model class once before importing any individual records
+  end
+
+  def self.before_import_find(record)
+    # called on the model class before finding or creating the new record
+    # maybe modify the import record that will be used to find the model
+    # throw :skip to skip importing this record
+    throw :skip unless record[:email].ends_with? "@mycompany.com"
+  end
+
+  def before_import_attributes(record)
+    # called on the blank new model or the found model before fields are imported
+    # maybe delete fields from the import record that you don't need
+    # throw :skip to skip importing this record
+  end
+
+  def before_import_associations(record)
+    # called on the model with attributes but before associations are imported
+    # do custom import of associations
+    # make sure to delete association fields from the import record to avoid double import
+    record.delete(:my_association)
+    # throw :skip to skip importing this record
+  end
+
   def before_import_save(record)
-    # Your custom special sauce
+    # called on the model before it is saved but after all fields and associations have been imported
+    # make final modifications to the record
+    # throw :skip to skip importing this record
   end
 
   def after_import_save(record)
-    # Your custom special sauce
+    # called on the model after it is saved
+  end
+
+  def after_import_association_error(record)
+    # called on the model when an association cannot be found
+  end
+
+  def after_import_error(record)
+    # called on the model when save fails
+  end
+
+  def self.after_import
+    # called once on the model class after importing all individual records
   end
 end
 ```
@@ -185,7 +350,35 @@ For example, you could
 
 * Set an attribute on a Devise User model to skip checking for a password when importing a new model.
 
-* Download a file based on a URL from the import file and set a Paperclip file attribute on the model.
+* Import an image into Carrierwave via a URL provided in the CSV.
+
+```ruby
+def before_import_save(record)
+  self.remote_image_url = record[:image] if record[:image].present?  
+end
+```
+
+* Skip some validations when importing.
+
+```ruby
+class User < ActiveRecord::Base
+  # Non-persistent attribute to allow creating a new user without a password
+  # Password will be set by the user by following a link in the invitation email
+  attr_accessor :allow_blank_password
+
+  devise :validatable
+
+  # Called by Devise to enable/disable password presence validation
+  def password_required?
+    allow_blank_password ? false : super
+  end
+
+  # Don't require a password when importing users
+  def before_import_save(record)
+    self.allow_blank_password = true
+  end
+end
+```
 
 
 ## ORM: ActiveRecord and Mongoid
@@ -201,10 +394,32 @@ Since the import functionality is rarely used in many applications, some gems ar
 
 If you prefer to eager load all dependecies at boot, use this line in your `Gemfile`.
 
-```
+```ruby
 gem "rails_admin_import", "~> 1.2.0", require: "rails_admin_import/eager_load"
 ```
 
+## Import error due to Rails class reloading
+
+![error due to class reloading](https://user-images.githubusercontent.com/2566348/51355874-0f83ad00-1a7e-11e9-8e58-46bc4699f2e6.jpg)
+
+If you get an error like `Error during import: MyModel(#70286054976500) expected, got MyModel(#70286114743280)`, you need restart the rails server and redo the import. This is due to the fact that Rails reloads the ActiveRecord model classes in development when you make changes to them and Rails Admin is still using the old class.
+
+Another suggestion is to set `config.cache_classes = true` to true in your `development.rb` for Rails Admin Import to work around the ActiveRecord model class reloading issue. See [this comment](https://github.com/stephskardal/rails_admin_import/issues/88#issuecomment-455374671) for more information.
+
+## Customize the UI
+
+If you want to hide all the advanced fields from the import UI, you can copy [`app/views/rails_admin/main/import.html.haml`](app/views/rails_admin/main/import.html.haml) to your project at the same path. Add `.hidden` at the end of lines you want to hide.
+
+For example:
+
+```haml
+    .form-group.control-group.hidden
+      %label.col-sm-2.control-label= t("admin.import.update_if_exists")
+      .col-sm-10.controls
+        = check_box_tag :update_if_exists, '1', true, :class => "form-control"
+        %p.help-block= t('admin.import.help.update_if_exists')
+```
+
 ## Upgrading
 
 * Move global config to `config.configure_with(:import)` in `config/initializers/rails_admin_import.rb`.
@@ -217,6 +432,18 @@ gem "rails_admin_import", "~> 1.2.0", require: "rails_admin_import/eager_load"
 
 * Support for importing file attributes was removed since I couldn't understand how it works. It should be possible to reimplement it yourself using post import hooks. Open an issue to discuss how to put back support for importing files into the gem.
 
+## Community-contributed translations
+
+* [Spanish translation](https://gist.github.com/yovasx2/dc0e9512e6c6243f840c) by Giovanni Alberto
+
+* [French translation](https://github.com/rodinux/rails_admin_import.fr-MX.yml) by Rodolphe Robles. (I suggest to translate also rails admin.fr and your locales.fr to resolve an issue with DatePicker)
+
+* [Italian translation](https://gist.github.com/aprofiti/ec3dc452898c8c48534b59eeb2701765) by Alessandro Profiti
+
+* [Japanese translation](https://gist.github.com/higumachan/c4bf669d6446ec509386229f916ba5fc) by Yuta Hinokuma
+
+* [Brazilian Portuguese translation](https://gist.github.com/tteurs/5a87ff4bc5f24692dab05b3cde0ca9df) by Matheo Gracia Pegoraro
+
 ## Run tests
 
 1. Clone the repository to your machine
@@ -235,6 +462,13 @@ Original author: [Steph Skardal](https://github.com/stephskardal)
 Maintainer (since May 2015): [Julien Vanier](https://github.com/monkbroc)
 
 
+## Release
+
+- Update `lib/rails_admin_import/version.rb`
+- Update the install instructions at [the top of the readme](#installation)
+- Commit to git
+- `rake release`
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/Rakefile

@@ -12,4 +12,6 @@ RSpec::Core::RakeTask.new(:spec)
 
 task test: :spec
 
-task default: :spec
+task :default do
+  system("bundle exec rake spec")
+end

data/app/views/rails_admin/main/import.html.haml

@@ -1,3 +1,14 @@
+:ruby
+  translations = {
+    add: t('admin.import.enumeration.add'),
+    chooseAll: t('admin.import.enumeration.choose_all'),
+    clearAll: t('admin.import.enumeration.clear_all'),
+    down: t('admin.import.enumeration.down'),
+    remove: t('admin.import.enumeration.remove'),
+    search: t('admin.import.enumeration.search'),
+    up: t('admin.import.enumeration.up')
+  }
+
 = render "results"
 
 = form_tag import_path(@abstract_model), :multipart => true, class: 'form-horizontal denser' do
@@ -24,20 +35,22 @@
       %label.col-sm-2.control-label{for: "encoding"}= t("admin.import.encoding")
       .col-sm-10.controls
         = select_tag 'encoding',
-          options_for_select(RailsAdmin::CSVConverter::TARGET_ENCODINGS),
-          include_blank: true, data: { enumeration: true }
+          options_for_select(Encoding.name_list.sort),
+          include_blank: true, data: { enumeration: true, options: { regional: translations } }
         %p.help-block= t('admin.import.help.encoding', name: 'UTF-8')
     .form-group.control-group
       %label.col-sm-2.control-label= t("admin.import.update_if_exists")
       .col-sm-10.controls
-        = check_box_tag :update_if_exists, '1', false, :class => "form-control"
+        = check_box_tag :update_if_exists, '1', RailsAdminImport.config.update_if_exists, :class => "form-control"
         %p.help-block= t('admin.import.help.update_if_exists')
     .form-group.control-group
       %label.col-sm-2.control-label{for: "update_lookup"}= t("admin.import.update_lookup")
       .col-sm-10.controls
         = select_tag 'update_lookup',
           options_for_select(@import_model.update_lookup_field_names,
-          @import_model.config.mapping_key.to_s), data: { enumeration: true }
+            Array.wrap(@import_model.config.mapping_key).map(&:to_s)),
+          multiple: true,
+          data: { enumeration: true, options: { regional: translations } }
 
   - unless @import_model.association_fields.empty?
     %fieldset
@@ -52,8 +65,9 @@
             = t("admin.import.mapping")
           .col-sm-10.controls
             = select_tag "associations[#{field.name}]",
-              options_for_select(@import_model.associated_model_fields(field).map(&:name),
-              @import_model.associated_config(field).mapping_key.to_s), data: { enumeration: true }
+              options_for_select(@import_model.associated_model_fields(field),
+                Array.wrap(@import_model.associated_config(field).mapping_key).first.to_s),
+              data: { enumeration: true, options: { regional: translations } }
 
   %br
   .form-actions

data/config/locales/README.md

@@ -0,0 +1,3 @@
+See the [community contributed translation section of the README](https://github.com/stephskardal/rails_admin_import#community-contributed-translations) for more languages.
+
+To contribute a new translation, please put it in a gist and submit a pull request to link your translation in the README.

data/config/locales/import.en.yml

@@ -1,50 +1,53 @@
-
 en:
   admin:
     actions:
       import:
-        title: "Import"
-        menu: "Import"
-        breadcrumb: "Import"
-        link: "Import"
-        bulk_link: "Import"
-        done: "Imported"
+        breadcrumb: Import
+        bulk_link: Import
+        done: Imported
+        link: Import
+        menu: Import
+        title: Import
     import:
-      model_fields: "Model fields"
-      association_fields: "Association fields"
-
-      file: "Data file"
-      missing_file: "You must select a file"
-      format: "File format"
-      invalid_format: "Invalid import format."
-      missing_update_lookup: "Your file must contain a column for the 'Update lookup field' you selected."
-      invalid_json: "The JSON data should be an array of records or an object with a key '%{root_key}' set to an array of records"
-      update_if_exists: "Update if exists"
-      update_lookup: "Update lookup field"
-      mapping: "mapping"
-      encoding: "Encoding"
-      legend:
-        fields: "Fields to import"
-        upload: "Upload file"
-        mapping: "Related fields mapping"
-      import_success:
-        create: "Created %{name}"
-        update: "Updated %{name}"
-      import_error:
-        create: "Failed to create %{name}: %{error}"
-        update: "Failed to update %{name}: %{error}"
-        general: "Error during import: %{error}"
-        old_import_hook: >
-          The import hook %{model}.%{method} should take only 1 argument.
-          Data may not imported correctly.
-          See Upgrading section readme in Rails Admin Import.
-      association_not_found: "Association not found. %{error}"
+      association_fields: Association fields
+      association_not_found: 'Association not found. %{error}'
+      encoding: Encoding
+      enumeration:
+        add: Add new
+        choose_all: Choose all
+        clear_all: Clear all
+        down: Down
+        remove: Remove
+        search: Search
+        up: Up
+      file: Data file
+      format: File format
       help:
-        model_fields: "The fields above may be included in the import file."
-        association_fields: >
-          These fields map to other tables in the database, lookup via attribute selected below.
-          For "many" associations, you may include multiple columns with the same header in the CSV file.
-        update_if_exists: "Update records found with the lookup field below instead of creating new records"
-        file_limit: "Please limit upload file to %{limit} line items."
-        encoding: "Choose file encoding. Leave empty to auto-detect. Ignored for JSON."
-
+        association_fields: |
+          These fields map to other tables in the database, lookup via attribute selected below. For "many" associations, you may include multiple columns with the same header in the CSV file.
+        encoding: Choose file encoding. Leave empty to auto-detect. Ignored for JSON.
+        file_limit: 'Please limit upload file to %{limit} line items.'
+        model_fields: The fields above may be included in the import file.
+        update_if_exists: Update records found with the lookup field below instead of creating new records
+      import_error:
+        create: 'Failed to create %{name}: %{error}'
+        general: 'Error during import: %{error}'
+        line_item_limit: 'Please limit upload file to %{limit} line items.'
+        old_import_hook: |
+          The import hook %{model}.%{method} should take only 1 argument. Data may not imported correctly. See Upgrading section readme in Rails Admin Import.
+        update: 'Failed to update %{name}: %{error}'
+      import_success:
+        create: 'Created %{name}'
+        update: 'Updated %{name}'
+      invalid_format: Invalid import format.
+      invalid_json: 'The JSON data should be an array of records or an object with a key ''%{root_key}'' set to an array of records'
+      legend:
+        fields: Fields to import
+        mapping: Related fields mapping
+        upload: Upload file
+      mapping: mapping
+      missing_file: You must select a file
+      missing_update_lookup: Your file must contain a column for the 'Update lookup field' you selected.
+      model_fields: Model fields
+      update_if_exists: Update if exists
+      update_lookup: Update lookup field(s)

data/lib/rails_admin_import/config.rb

@@ -6,11 +6,15 @@ module RailsAdminImport
       attr_accessor :logging
       attr_accessor :line_item_limit
       attr_accessor :rollback_on_error
+      attr_accessor :update_if_exists
       attr_accessor :header_converter
       attr_accessor :csv_options
+      attr_accessor :pass_filename
 
       # Default is to downcase headers and add underscores to convert into attribute names
       HEADER_CONVERTER = lambda do |header|
+        # check for nil/blank headers
+        next if header.blank?
         header.parameterize.underscore
       end
 
@@ -31,7 +35,9 @@ module RailsAdminImport
         @logging = false
         @line_item_limit = 1000
         @rollback_on_error = false
+        @update_if_exists = false
         @header_converter = HEADER_CONVERTER
+        @pass_filename = false
         @csv_options = {}
       end
     end

data/lib/rails_admin_import/config/sections/import.rb

@@ -9,8 +9,12 @@ module RailsAdmin
           :name
         end
 
+        register_instance_option(:mapping_key_list) do
+          []
+        end
+
         register_instance_option(:default_excluded_fields) do
-          [:id, :_id, :created_at, :updated_at]
+          [:id, :_id, :created_at, :updated_at, :c_at, :u_at, :deleted_at]
         end
       end
     end

data/lib/rails_admin_import/formats/csv_importer.rb

@@ -1,9 +1,11 @@
 require "csv"
+require "charlock_holmes"
 
 module RailsAdminImport
   module Formats
     class CSVImporter < FileImporter
       Formats.register(:csv, self)
+      Formats.register(:CSV, self)
 
       autoload :CharDet, "rchardet"
 
@@ -15,8 +17,9 @@ module RailsAdminImport
 
       # A method that yields a hash of attributes for each record to import
       def each_record
-        CSV.foreach(filename, csv_options) do |row|
-          yield convert_to_attributes(row)
+        CSV.foreach(filename, **csv_options) do |row|
+          attr = convert_to_attributes(row)
+          yield attr unless attr.all? { |field, value| value.blank? }
         end
       end
 
@@ -51,9 +54,9 @@ module RailsAdminImport
       end
 
       def detect_encoding
-        charset = CharDet.detect File.read(filename)
-        if charset["confidence"] > 0.6
-          from_encoding = charset["encoding"]
+        charset = CharlockHolmes::EncodingDetector.detect File.read(filename)
+        if charset[:confidence] > 0.6
+          from_encoding = charset[:encoding]
           from_encoding = "UTF-8" if from_encoding == "ascii"
         end
         from_encoding
@@ -61,7 +64,7 @@ module RailsAdminImport
 
       def convert_to_attributes(row)
         row.each_with_object({}) do |(field, value), record|
-          break if field.nil?
+          next if field.blank?
           field = field.to_sym
           if import_model.has_multiple_values?(field)
             field = import_model.pluralize_field(field)

data/lib/rails_admin_import/formats/json_importer.rb

@@ -2,6 +2,7 @@ module RailsAdminImport
   module Formats
     class JSONImporter < FileImporter
       Formats.register(:json, self)
+      Formats.register(:JSON, self)
 
       # A method that yields a hash of attributes for each record to import
       def each_record

data/lib/rails_admin_import/formats/xlsx_importer.rb

@@ -4,6 +4,7 @@ module RailsAdminImport
   module Formats
     class XLSXImporter < FileImporter
       Formats.register(:xlsx, self)
+      Formats.register(:XLSX, self)
 
       autoload :SimpleXlsxReader, "simple_xlsx_reader"
 
@@ -18,7 +19,8 @@ module RailsAdminImport
         sheet = doc.sheets.first
         @headers = convert_headers(sheet.headers)
         sheet.data.each do |row|
-          yield convert_to_attributes(row)
+          attr = convert_to_attributes(row)
+          yield attr unless attr.all? { |field, value| value.blank? }
         end
       end
 
@@ -33,7 +35,7 @@ module RailsAdminImport
       def convert_to_attributes(row)
         row_with_headers = @headers.zip(row)
         row_with_headers.each_with_object({}) do |(field, value), record|
-          break if field.nil?
+          next if field.nil?
           field = field.to_sym
           if import_model.has_multiple_values?(field)
             field = import_model.pluralize_field(field)

data/lib/rails_admin_import/import_logger.rb

@@ -7,7 +7,7 @@ module RailsAdminImport
         @logger = Logger.new(File.join(Rails.root, "log", log_file_name))
       end
     end
-    
+
     def info(message)
       if RailsAdminImport.config.logging
         @logger.info message

data/lib/rails_admin_import/import_model.rb

@@ -63,7 +63,11 @@ module RailsAdminImport
     end
 
     def update_lookup_field_names
-      @update_lookup_field_names ||= model_fields.map(&:name) + belongs_to_fields.map(&:foreign_key)
+      if @config.mapping_key_list.present?
+        @update_lookup_field_names = @config.mapping_key_list
+      else
+        @update_lookup_field_names ||= model_fields.map(&:name) + belongs_to_fields.map(&:foreign_key)
+      end
     end
 
     def associated_object(field, mapping_field, value)
@@ -82,9 +86,13 @@ module RailsAdminImport
 
     def associated_model_fields(field)
       @associated_fields ||= {}
-      @associated_fields[field] ||= associated_config(field).visible_fields.select { |f|
-        !f.association?
-      }
+      if associated_config(field).mapping_key_list.present?
+        @associated_fields[field] ||= associated_config(field).mapping_key_list
+      else
+        @associated_fields[field] ||= associated_config(field).visible_fields.select { |f|
+          !f.association?
+        }.map(&:name)
+      end
     end
 
     def has_multiple_values?(field_name)

data/lib/rails_admin_import/importer.rb

@@ -16,18 +16,26 @@ module RailsAdminImport
       begin
         init_results
 
-        # TODO: re-implement file size check
-        # if file_check.readlines.size > RailsAdminImport.config.line_item_limit
-        #   return results = { :success => [], :error => ["Please limit upload file to #{RailsAdminImport.config.line_item_limit} line items."] }
-        # end
+        if records.count > RailsAdminImport.config.line_item_limit
+          return results = {
+            success: [],
+            error: [I18n.t('admin.import.import_error.line_item_limit', limit: RailsAdminImport.config.line_item_limit)]
+          }
+        end
+
+        perform_global_callback(:before_import)
 
         with_transaction do
           records.each do |record|
-            import_record(record)
+            catch :skip do
+              import_record(record)
+            end
           end
 
           rollback_if_error
         end
+
+        perform_global_callback(:after_import)
       rescue Exception => e
         report_general_error("#{e} (#{e.backtrace.first})")
       end
@@ -62,19 +70,28 @@ module RailsAdminImport
     end
 
     def import_record(record)
-      if update_lookup && !record.has_key?(update_lookup)
+      if params["file"] && RailsAdminImport.config.pass_filename
+        record.merge!({:filename_importer => params[:file].original_filename})
+      end
+
+      perform_model_callback(import_model.model, :before_import_find, record)
+
+      if update_lookup && !(update_lookup - record.keys).empty?
         raise UpdateLookupError, I18n.t("admin.import.missing_update_lookup")
-      end 
+      end
 
       object = find_or_create_object(record, update_lookup)
+      return if object.nil?
       action = object.new_record? ? :create : :update
 
       begin
+        perform_model_callback(object, :before_import_associations, record)
         import_single_association_data(object, record)
         import_many_association_data(object, record)
       rescue AssociationNotFound => e
         error = I18n.t("admin.import.association_not_found", :error => e.to_s)
         report_error(object, action, error)
+        perform_model_callback(object, :after_import_association_error, record)
         return
       end
 
@@ -85,12 +102,13 @@ module RailsAdminImport
         perform_model_callback(object, :after_import_save, record)
       else
         report_error(object, action, object.errors.full_messages.join(", "))
+        perform_model_callback(object, :after_import_error, record)
       end
     end
 
     def update_lookup
       @update_lookup ||= if params[:update_if_exists] == "1"
-                           params[:update_lookup].to_sym
+                           params[:update_lookup].map(&:to_sym)
                          end
     end
 
@@ -142,7 +160,7 @@ module RailsAdminImport
              name: result_count,
                action: I18n.t("admin.actions.import.done"))
     end
-    
+
     def perform_model_callback(object, method_name, record)
       if object.respond_to?(method_name)
         # Compatibility: Old import hook took 2 arguments.
@@ -166,6 +184,11 @@ module RailsAdminImport
       end
     end
 
+    def perform_global_callback(method_name)
+      object = import_model.model
+      object.send(method_name) if object.respond_to?(method_name)
+    end
+
     def find_or_create_object(record, update)
       field_names = import_model.model_fields.map(&:name)
       new_attrs = record.select do |field_name, value|
@@ -174,13 +197,19 @@ module RailsAdminImport
 
       model = import_model.model
       object = if update.present?
-                 model.where(update => record[update]).first
-               end 
+                 query = update.each_with_object({}) do
+                   |field, query| query[field] = record[field]
+                 end
+                 model.where(query).first
+               end
 
       if object.nil?
-        object = model.new(new_attrs)
+        object = model.new
+        perform_model_callback(object, :before_import_attributes, record)
+        object.attributes = new_attrs
       else
-        object.attributes = new_attrs.except(update.to_sym)
+        perform_model_callback(object, :before_import_attributes, record)
+        object.attributes = new_attrs.except(update.map(&:to_sym))
       end
       object
     end
@@ -221,4 +250,3 @@ module RailsAdminImport
     end
   end
 end
-

data/lib/rails_admin_import/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminImport
-  VERSION = "1.3.1"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_import
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Steph Skardal
 - Julien Vanier
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2021-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,33 +40,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.6
 - !ruby/object:Gem::Dependency
-  name: haml
+  name: charlock_holmes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rchardet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: simple_xlsx_reader
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +67,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
 - steph@endpoint.com
 - jvanier@gmail.com
@@ -96,6 +82,7 @@ files:
 - app/views/rails_admin/main/_results.html.haml
 - app/views/rails_admin/main/_section.html.haml
 - app/views/rails_admin/main/import.html.haml
+- config/locales/README.md
 - config/locales/import.en.yml
 - lib/rails_admin_import.rb
 - lib/rails_admin_import/action.rb
@@ -119,7 +106,7 @@ homepage: https://github.com/stephskardal/rails_admin_import
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,10 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Import functionality for Rails Admin
 test_files: []
-has_rdoc: