rails_admin_import 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c799862da18cc280ba530ca0bdf89c492f725573
-  data.tar.gz: 83702de0110d5d0646c3323933367020761427a8
+SHA256:
+  metadata.gz: b0b71f8452cd6e451b12a22c3d3afb9418bd9308857e11522007db476f014e29
+  data.tar.gz: df443cf15365e4c8ad61d81db2f9ba49bb582388cb9022f24ebeaacea2725b83
 SHA512:
-  metadata.gz: aa86b09270e22dcbfcc2b4b98b98597fc3d27711eab969064b1a7f87ee94316779ef5f9b751f7187464c71f30c4d23b1363ee1e93d8056ab95f4379f8482ac6d
-  data.tar.gz: 6c2191818eb60e4ddab360ec9adcec4a9cf899acf2d8e9e96842f3e73cdc0c8d7e59174b223bed94092d7aad74a2334ebfc4cd229f387bd2dfd83e349a1dd757
+  metadata.gz: 901d0f3cc189f9a51acf9e7cd492f66f28958a8a205c183f31138367caecb3639b7c6d47c66e866459e7b4739a2b51b93c44b47dc1c23f5d7932fe5563cffa8b
+  data.tar.gz: f9187fe631aa5e2e0ac0c2fcacc7d4a966d682fff9afefcb047608aaf4e9bb8587b56a615da95de7b429df05e9b9ecdff30c00f7320b0a0e3db090894036ba04

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # 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

data/README.md

@@ -1,6 +1,6 @@
 # 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
 
@@ -8,8 +8,8 @@ Plugin functionality to add generic import to Rails Admin from CSV, JSON and XLS
 
 * First, add to Gemfile:
 
-```
-gem "rails_admin_import", "~> 2.2"
+```ruby
+gem "rails_admin_import", "~> 2.3"
 ```
 
 * Define configuration in `config/initializers/rails_admin_import.rb`:
@@ -26,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:
@@ -72,11 +74,13 @@ 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.
 
@@ -91,17 +95,19 @@ 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
@@ -128,7 +134,7 @@ 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
@@ -193,11 +199,10 @@ RailsAdmin.config 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|
-      # check for nil/blank headers
-      next if header.blank?
-      header.parameterize.underscore
+      header.parameterize.underscore if header.present?
     end
     config.csv_options = {}
   end
@@ -215,6 +220,7 @@ end
 * __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
 
@@ -346,7 +352,7 @@ For example, you could
 
 * 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
@@ -354,7 +360,7 @@ 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
@@ -388,7 +394,7 @@ 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"
 ```
 
@@ -405,7 +411,8 @@ Another suggestion is to set `config.cache_classes = true` to true in your `deve
 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

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
@@ -25,7 +36,7 @@
       .col-sm-10.controls
         = select_tag 'encoding',
           options_for_select(Encoding.name_list.sort),
-          include_blank: true, data: { enumeration: true }
+          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")
@@ -39,7 +50,7 @@
           options_for_select(@import_model.update_lookup_field_names,
             Array.wrap(@import_model.config.mapping_key).map(&:to_s)),
           multiple: true,
-          data: { enumeration: true }
+          data: { enumeration: true, options: { regional: translations } }
 
   - unless @import_model.association_fields.empty?
     %fieldset
@@ -56,7 +67,7 @@
             = select_tag "associations[#{field.name}]",
               options_for_select(@import_model.associated_model_fields(field),
                 Array.wrap(@import_model.associated_config(field).mapping_key).first.to_s),
-              data: { enumeration: true }
+              data: { enumeration: true, options: { regional: translations } }
 
   %br
   .form-actions

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(s)"
-      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}"
-        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.
-      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

@@ -9,6 +9,7 @@ module RailsAdminImport
       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|
@@ -36,6 +37,7 @@ module RailsAdminImport
         @rollback_on_error = false
         @update_if_exists = false
         @header_converter = HEADER_CONVERTER
+        @pass_filename = false
         @csv_options = {}
       end
     end

data/lib/rails_admin_import/formats/csv_importer.rb

@@ -17,7 +17,7 @@ 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|
+        CSV.foreach(filename, **csv_options) do |row|
           attr = convert_to_attributes(row)
           yield attr unless attr.all? { |field, value| value.blank? }
         end

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/importer.rb

@@ -70,6 +70,10 @@ module RailsAdminImport
     end
 
     def import_record(record)
+      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?

data/lib/rails_admin_import/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_import
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Steph Skardal
 - Julien Vanier
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2021-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: simple_xlsx_reader
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
 - steph@endpoint.com
 - jvanier@gmail.com
@@ -106,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
@@ -121,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Import functionality for Rails Admin
 test_files: []