active_admin_import 5.0.0 → 6.0.0

data/lib/active_admin_import/options.rb

@@ -16,6 +16,7 @@ module ActiveAdminImport
       :ignore,
       :template,
       :template_object,
+      :result_class,
       :resource_class,
       :resource_label,
       :plural_resource_label,
@@ -26,7 +27,7 @@ module ActiveAdminImport
 
     def self.options_for(config, options = {})
       unless options.key? :template_object
-        options[:template_object] = ActiveAdminImport::Model.new
+        options[:template_object] = -> { ActiveAdminImport::Model.new }
       end
 
       {

data/lib/active_admin_import/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveAdminImport
-  VERSION = '5.0.0'
+  VERSION = '6.0.0'
 end

data/spec/fixtures/files/author_invalid_format.txt

@@ -0,0 +1,2 @@
+Name,Last name,Birthday
+John,Doe,1986-05-01

data/spec/fixtures/files/authors_values_exceeded_headers.csv

@@ -0,0 +1,3 @@
+Birthday,Name,Last name
+1986-05-01,John,Doe
+1988-11-16,Jane,Roe, exceeded value

data/spec/fixtures/files/post_comments.csv

@@ -0,0 +1,3 @@
+"Body"
+"First comment"
+"Second comment"

data/spec/import_spec.rb

@@ -27,7 +27,7 @@ describe 'import', type: :feature do
     zip_file = File.expand_path("./spec/fixtures/files/#{name}.zip")
 
     begin
-      Zip::File.open(zip_file, Zip::File::CREATE) do |z|
+      Zip::File.open(zip_file, create: true) do |z|
         z.add "#{name}.csv", File.expand_path("./spec/fixtures/files/#{name}.csv")
       end
       instance_eval &block
@@ -96,6 +96,38 @@ describe 'import', type: :feature do
         end
         include_examples 'successful inserts for author'
       end
+
+      context 'when template object passed like proc' do
+        before do
+          add_post_resource(template_object: -> { ActiveAdminImport::Model.new(author_id: author.id) },
+                            validate: true,
+                            before_batch_import: lambda do |importer|
+                              importer.csv_lines.map! { |row| row << importer.model.author_id }
+                              importer.headers.merge!(:'Author Id' => :author_id)
+                            end
+          )
+
+          visit '/admin/posts/import'
+          upload_file!(:posts_for_author)
+        end
+
+        include_examples 'successful inserts for author'
+
+        context 'after successful import try without file' do
+          let(:after_successful_import_do!) do
+            # reload page
+            visit '/admin/posts/import'
+            # submit form without file
+            find_button('Import').click
+          end
+
+          it 'should render validation error' do
+            after_successful_import_do!
+
+            expect(page).to have_content I18n.t('active_admin_import.no_file_error')
+          end
+        end
+      end
     end
 
     context 'for csv with author name' do
@@ -424,6 +456,36 @@ describe 'import', type: :feature do
           expect(Author.count).to eq(2)
         end
       end
+
+      context 'with empty csv and auto detect encoding' do
+        let(:options) do
+          attributes = { force_encoding: :auto }
+          { template_object: ActiveAdminImport::Model.new(attributes) }
+        end
+
+        before do
+          upload_file!(:empty)
+        end
+
+        it 'should render warning' do
+          expect(page).to have_content I18n.t('active_admin_import.file_empty_error')
+          expect(Author.count).to eq(0)
+        end
+      end
+
+      context 'with csv which has exceeded values' do
+        before do
+          upload_file!(:authors_values_exceeded_headers)
+        end
+
+        it 'should render warning' do
+          # 5 columns: 'birthday, name, last_name, created_at, updated_at'
+          # 6 values: '"1988-11-16", "Jane", "Roe", " exceeded value", datetime, datetime'
+          msg = 'Number of values (6) exceeds number of columns (5)'
+          expect(page).to have_content I18n.t('active_admin_import.file_error', message: msg)
+          expect(Author.count).to eq(0)
+        end
+      end
     end
 
     context 'with callback procs options' do
@@ -526,4 +588,147 @@ describe 'import', type: :feature do
       expect { add_author_resource(options) }.to raise_error(ArgumentError)
     end
   end
+
+  context 'when submitting empty form after validation error' do
+    let(:options) { {} }
+
+    before do
+      add_author_resource(options)
+      visit '/admin/authors/import'
+    end
+
+    it 'should NOT reuse cached file from previous submission' do
+      expect do
+        upload_file!(:author_broken_header)
+        expect(page).to have_content("can't write unknown attribute")
+      end.not_to change { Author.count }
+
+      # Second submission without selecting a file
+      expect do
+        find_button('Import').click
+        expect(page).to have_content(I18n.t('active_admin_import.no_file_error'))
+      end.not_to change { Author.count }
+    end
+  end
+
+  context 'when importing file with invalid format and auto force_encoding' do
+    let(:options) { { template_object: ActiveAdminImport::Model.new(force_encoding: :auto) } }
+
+    before do
+      add_author_resource(options)
+      visit '/admin/authors/import'
+    end
+
+    it 'should reject invalid file format before encoding' do
+      expect do
+        upload_file!(:author_invalid_format, 'txt')
+        expect(page).to have_content I18n.t('active_admin_import.file_format_error')
+      end.not_to change { Author.count }
+    end
+  end
+
+  context 'with active_admin_import_context defined on the controller' do
+    before { Author.create!(name: 'John', last_name: 'Doe') }
+
+    let(:author) { Author.take }
+
+    context 'when context returns request-derived attributes' do
+      before do
+        author_id = author.id
+        add_post_resource(
+          template_object: ActiveAdminImport::Model.new(author_id: author_id),
+          before_batch_import: lambda do |importer|
+            ip = importer.model.request_ip
+            a_id = importer.model.author_id
+            importer.csv_lines.map! { |row| row << ip << a_id }
+            importer.headers.merge!(:'Request Ip' => :request_ip, :'Author Id' => :author_id)
+          end,
+          controller_block: proc do
+            def active_admin_import_context
+              { request_ip: request.remote_ip }
+            end
+          end
+        )
+        visit '/admin/posts/import'
+        upload_file!(:posts_for_author)
+      end
+
+      it 'merges the context into the import model so callbacks see it' do
+        expect(page).to have_content 'Successfully imported 2 posts'
+        expect(Post.count).to eq(2)
+        Post.all.each do |post|
+          expect(post.request_ip).to eq('127.0.0.1')
+          expect(post.author_id).to eq(author.id)
+        end
+      end
+    end
+
+    context 'when context returns parent id for a nested belongs_to resource' do
+      let(:post) { Post.create!(title: 'A post', body: 'body', author: author) }
+
+      before do
+        add_nested_post_comment_resource(
+          before_batch_import: lambda do |importer|
+            importer.csv_lines.map! { |row| row << importer.model.post_id }
+            importer.headers.merge!(:'Post Id' => :post_id)
+          end,
+          controller_block: proc do
+            def active_admin_import_context
+              { post_id: parent.id }
+            end
+          end
+        )
+        visit "/admin/posts/#{post.id}/post_comments/import"
+        upload_file!(:post_comments)
+      end
+
+      it 'automatically assigns the parent post_id to every imported comment' do
+        expect(page).to have_content 'Successfully imported 2 post comments'
+        expect(PostComment.count).to eq(2)
+        expect(PostComment.where(post_id: post.id).count).to eq(2)
+      end
+    end
+  end
+
+  # PG-only: activerecord-import populates `result.ids` reliably on PostgreSQL
+  # via RETURNING. On MySQL/SQLite the array is not populated by default, so
+  # the assertion would not be meaningful there. The :result_class option
+  # itself works on every adapter — this spec just demonstrates the canonical
+  # PR #191 use case (collecting inserted ids) on the adapter that supports it.
+  if ENV['DB'] == 'postgres'
+    context 'with custom result_class (PostgreSQL)' do
+      # Subclass that captures inserted ids alongside the standard counters.
+      # Lives in user-land so the gem itself stays free of adapter-specific
+      # quirks around RETURNING. This is the example documented in the README.
+      class ImportResultWithIds < ActiveAdminImport::ImportResult
+        attr_reader :ids
+
+        def initialize
+          super
+          @ids = []
+        end
+
+        def add(batch_result, qty)
+          super
+          @ids.concat(Array(batch_result.ids))
+        end
+      end
+
+      before do
+        add_author_resource(result_class: ImportResultWithIds) do |result, _options|
+          # Expose the captured ids on the flash so the test asserts via the
+          # rendered page rather than closure capture.
+          flash[:notice] = "Imported ids: [#{result.ids.sort.join(',')}]"
+        end
+        visit '/admin/authors/import'
+        upload_file!(:authors)
+      end
+
+      it 'collects the ids of inserted records via the custom subclass' do
+        expect(Author.count).to eq(2)
+        expected = "Imported ids: [#{Author.pluck(:id).sort.join(',')}]"
+        expect(page).to have_content(expected)
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
-# frozen_string_literal: true
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH << File.expand_path('../support', __FILE__)
@@ -10,22 +11,18 @@ require 'bundler'
 Bundler.setup
 
 ENV['RAILS_ENV'] = 'test'
-# Ensure the Active Admin load path is happy
 require 'rails'
 ENV['RAILS'] = Rails.version
-ENV['RAILS_ROOT'] = File.expand_path("../rails/rails-#{ENV['RAILS']}", __FILE__)
-# Create the test app if it doesn't exists
+ENV['DB'] ||= 'sqlite'
+ENV['RAILS_ROOT'] = File.expand_path("../rails/rails-#{ENV['RAILS']}-#{ENV['DB']}", __FILE__)
 system 'rake setup' unless File.exist?(ENV['RAILS_ROOT'])
 
 require 'active_model'
-# require ActiveRecord to ensure that Ransack loads correctly
 require 'active_record'
 require 'action_view'
 require 'active_admin'
 ActiveAdmin.application.load_paths = [ENV['RAILS_ROOT'] + '/app/admin']
 require ENV['RAILS_ROOT'] + '/config/environment.rb'
-# Disabling authentication in specs so that we don't have to worry about
-# it allover the place
 ActiveAdmin.application.authentication_method = false
 ActiveAdmin.application.current_user_method = false
 
@@ -33,21 +30,20 @@ require 'rspec/rails'
 require 'support/admin'
 require 'capybara/rails'
 require 'capybara/rspec'
-require 'capybara/poltergeist'
+require 'capybara/cuprite'
 
-Capybara.register_driver :poltergeist do |app|
-  Capybara::Poltergeist::Driver.new(app, js_errors: true,
-                                         timeout: 80,
-                                         debug: true,
-                                         phantomjs_options: ['--debug=no', '--load-images=no'])
+Capybara.server = :webrick
+Capybara.register_driver :cuprite do |app|
+  Capybara::Cuprite::Driver.new(app, headless: true, window_size: [1280, 800])
 end
-
-Capybara.javascript_driver = :poltergeist
+Capybara.javascript_driver = :cuprite
+Capybara.default_max_wait_time = 5
 
 RSpec.configure do |config|
   config.use_transactional_fixtures = false
 
   config.before(:suite) do
+    ActiveRecord::Migration.maintain_test_schema!
     DatabaseCleaner.strategy = :truncation
     DatabaseCleaner.clean_with(:truncation)
   end

data/spec/support/admin.rb

@@ -8,8 +8,24 @@ def add_author_resource(options = {}, &block)
 end
 
 def add_post_resource(options = {}, &block)
+  cb = options.delete(:controller_block)
   ActiveAdmin.register Post do
     config.filters = false
+    controller(&cb) if cb
+    active_admin_import(options, &block)
+  end
+  Rails.application.reload_routes!
+end
+
+def add_nested_post_comment_resource(options = {}, &block)
+  cb = options.delete(:controller_block)
+  ActiveAdmin.register Post do
+    config.filters = false
+  end
+  ActiveAdmin.register PostComment do
+    config.filters = false
+    belongs_to :post
+    controller(&cb) if cb
     active_admin_import(options, &block)
   end
   Rails.application.reload_routes!

data/spec/support/rails_template.rb

@@ -1,29 +1,60 @@
-# frozen_string_literal: true
-# Rails template to build the sample app for specs
+create_file "app/assets/config/manifest.js", skip: true
+
+db = ENV['DB'] || 'sqlite'
+case db
+when 'mysql'
+  remove_file 'config/database.yml'
+  create_file 'config/database.yml', <<~YAML
+    default: &default
+      adapter: mysql2
+      encoding: utf8mb4
+      pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+      host: <%= ENV.fetch("DB_HOST", "127.0.0.1") %>
+      port: <%= ENV.fetch("DB_PORT", 3306) %>
+      username: <%= ENV.fetch("DB_USERNAME", "root") %>
+      password: <%= ENV.fetch("DB_PASSWORD", "root") %>
+
+    test:
+      <<: *default
+      database: active_admin_import_test
+  YAML
+when 'postgres', 'postgresql'
+  remove_file 'config/database.yml'
+  create_file 'config/database.yml', <<~YAML
+    default: &default
+      adapter: postgresql
+      encoding: unicode
+      pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+      host: <%= ENV.fetch("DB_HOST", "127.0.0.1") %>
+      port: <%= ENV.fetch("DB_PORT", 5432) %>
+      username: <%= ENV.fetch("DB_USERNAME", "postgres") %>
+      password: <%= ENV.fetch("DB_PASSWORD", "postgres") %>
+
+    test:
+      <<: *default
+      database: active_admin_import_test
+  YAML
+end
+
+generate :model, 'author name:string{10}:uniq last_name:string birthday:date --force'
+generate :model, 'post title:string:uniq body:text request_ip:string author:references --force'
+generate :model, 'post_comment body:text post:references --force'
 
-generate :model, 'author name:string{10}:uniq last_name:string birthday:date'
-generate :model, 'post title:string:uniq body:text author:references'
-
-# Add validation
 inject_into_file 'app/models/author.rb', "  validates_presence_of :name\n  validates_uniqueness_of :last_name\n", before: 'end'
-inject_into_file 'app/models/post.rb', "  validates_presence_of :author\n", before: 'end'
-
-# Configure default_url_options in test environment
-inject_into_file 'config/environments/test.rb', "  config.action_mailer.default_url_options = { :host => 'example.com' }\n", after: "config.cache_classes = true\n"
+inject_into_file 'app/models/post.rb', "  validates_presence_of :author\n  has_many :post_comments\n", before: 'end'
 
-# Add our local Active Admin to the load path
-inject_into_file 'config/environment.rb', "\n$LOAD_PATH.unshift('#{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))}')\nrequire \"active_admin\"\n", after: "require File.expand_path('../application', __FILE__)"
-
-run 'rm Gemfile'
+# Add our local Active Admin to the load path (Rails 7.1+)
+gsub_file "config/environment.rb",
+  'require_relative "application"',
+  "require_relative \"application\"\n$LOAD_PATH.unshift('#{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))}')\nrequire \"active_admin\"\n"
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 generate :'active_admin:install --skip-users'
 generate :'formtastic:install'
 
-run 'rm -r test'
-run 'rm -r spec'
-
+run 'rm -rf test'
 route "root :to => 'admin/dashboard#index'"
+rake 'db:create db:migrate'
 
-rake 'db:migrate'
+run 'rm -f Gemfile Gemfile.lock'

data/tasks/test.rake

@@ -1,7 +1,21 @@
-# frozen_string_literal: true
-desc 'Creates a test rails app for the specs to run against'
+desc "Creates a test rails app for the specs to run against"
 task :setup do
   require 'rails/version'
-  system('mkdir spec/rails') unless File.exist?('spec/rails')
-  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template.rb --skip-spring  --skip-turbolinks  --skip-bootsnap"
+
+  db = ENV['DB'] || 'sqlite'
+  rails_db = case db
+             when 'mysql' then 'mysql'
+             when 'postgres', 'postgresql' then 'postgresql'
+             else 'sqlite3'
+             end
+
+  rails_new_opts = %W(
+    --skip-turbolinks
+    --skip-spring
+    --skip-bootsnap
+    -d #{rails_db}
+    -m
+    spec/support/rails_template.rb
+  )
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING}-#{db} #{rails_new_opts.join(' ')}"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_import
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Igor Fedoronchuk
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-import
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rchardet
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +57,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: The most efficient way to import for Active Admin
 email:
 - fedoronchuk@gmail.com
@@ -73,10 +78,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -108,17 +112,20 @@ files:
 - spec/fixtures/files/author.csv
 - spec/fixtures/files/author_broken_header.csv
 - spec/fixtures/files/author_invalid.csv
+- spec/fixtures/files/author_invalid_format.txt
 - spec/fixtures/files/authors.csv
 - spec/fixtures/files/authors_bom.csv
 - spec/fixtures/files/authors_invalid_db.csv
 - spec/fixtures/files/authors_invalid_model.csv
 - spec/fixtures/files/authors_no_headers.csv
+- spec/fixtures/files/authors_values_exceeded_headers.csv
 - spec/fixtures/files/authors_win1251_win_endline.csv
 - spec/fixtures/files/authors_with_ids.csv
 - spec/fixtures/files/authors_with_semicolons.csv
 - spec/fixtures/files/authors_with_tabs.tsv
 - spec/fixtures/files/empty.csv
 - spec/fixtures/files/only_headers.csv
+- spec/fixtures/files/post_comments.csv
 - spec/fixtures/files/posts.csv
 - spec/fixtures/files/posts_for_author.csv
 - spec/fixtures/files/posts_for_author_no_headers.csv
@@ -130,11 +137,10 @@ files:
 - spec/support/admin.rb
 - spec/support/rails_template.rb
 - tasks/test.rake
-homepage: http://github.com/Fivell/active_admin_import
+homepage: https://github.com/activeadmin-plugins/active_admin_import
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,39 +148,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: ActiveAdmin import based on activerecord-import gem.
-test_files:
-- spec/fixtures/files/author.csv
-- spec/fixtures/files/author_broken_header.csv
-- spec/fixtures/files/author_invalid.csv
-- spec/fixtures/files/authors.csv
-- spec/fixtures/files/authors_bom.csv
-- spec/fixtures/files/authors_invalid_db.csv
-- spec/fixtures/files/authors_invalid_model.csv
-- spec/fixtures/files/authors_no_headers.csv
-- spec/fixtures/files/authors_win1251_win_endline.csv
-- spec/fixtures/files/authors_with_ids.csv
-- spec/fixtures/files/authors_with_semicolons.csv
-- spec/fixtures/files/authors_with_tabs.tsv
-- spec/fixtures/files/empty.csv
-- spec/fixtures/files/only_headers.csv
-- spec/fixtures/files/posts.csv
-- spec/fixtures/files/posts_for_author.csv
-- spec/fixtures/files/posts_for_author_no_headers.csv
-- spec/import_result_spec.rb
-- spec/import_spec.rb
-- spec/model_spec.rb
-- spec/spec_helper.rb
-- spec/support/active_model_lint.rb
-- spec/support/admin.rb
-- spec/support/rails_template.rb
+test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-script: bundle exec rspec spec
-env:
-  matrix:
-    - RAILS=5.2.6
-    - RAILS=6.0.4
-    - RAILS=6.1.4
-rvm:
-  - 2.6.7
-  - 2.7.4
-  - 3.0.2
-jobs:
-  exclude:
-    - rvm: 3.0.1
-      env: RAILS=5.2.6

data/CHANGELOG.md

@@ -1,33 +0,0 @@
-# Changelog
-## [5.0.0] - 2021-11-16
-- Ruby 3 compatibility added #190  | @clinejj
-- Support for a non UTF-8 file when zip uploading #185| @naokirin 
-- Rails 6 supported #183 | @pnghai
-- Drop ruby 2.4 support #192 | @Fivell
-
-
-## [4.2.0] - 2020-02-05
-- generic exception for import added #175 | @linqueta
-
-## [4.1.2] - 2019-12-16
-- allow application/octet-stream content-type #172 | @dmitry-sinina
-- Allow activerecord-import >= 0.27 #171 | @sagium 
-
-## [4.1.1] - 2019-09-20
-- Fix column slicing #168 | @doredesign
-- Handle errors on base #163
-
-## [4.1.0] - 2019-01-15
-- Upgrade dependencies: `activerecord-import` to >=0.27.1 | @jkowens
-
-## [4.0.0] - 2018-07-19
-- Adde German translation | @morris-frank
-- Remove support for Ruby 2.1 and Rails 4
-
-## [3.1.0] - 2018-04-10
-- Lower dependency of ActiveAdmin to >= 1.0.0.pre2
-- Add possibility to skip columns/values in CSV (batch_slice_columns method)
-
-[Unreleased]: https://github.com/activeadmin-plugins/active_admin_import/compare/v4.0.0...HEAD
-[4.0.0]: https://github.com/activeadmin-plugins/active_admin_import/compare/v3.1.0...v4.0.0
-[3.1.0]: https://github.com/activeadmin-plugins/active_admin_import/compare/3.0.0...v3.1.0