active_admin_import 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f72286b16c17763984dba1b9da29ada72f8f7be7e64e5ae64010a1dcd7926af3
-  data.tar.gz: 2f50c17a8aed4cf2f02d8f28e2e83976e1af4fb593d5fcd763339f4a221be7ca
+  metadata.gz: f6e8f38e5549666b0bc1cd0d996f53fc0bebdfa5449750434fa4dbeb2ec4bc3b
+  data.tar.gz: 47298769ad0b0c7dfae9b21b470cf78b1164e6978aeb374ee9d4991de037814e
 SHA512:
-  metadata.gz: 8921862e1b2de5bfa6d72f5655fe3cc0fc9d2ac7b4410d8ded785521443daf4b582d8e9b2978645c66bb0446b6d11478d7e72e452c70433274d118baa35e6127
-  data.tar.gz: 332150892d0732efeabf1b7a3de70fa81c9910e6f235ac08b83710eb993709281fb62aec6c21388f6ea9786cf7afb9791dffabdd7c651ac4275cd1ffebd57b3f
+  metadata.gz: b45454513b6a1312b1dd0490ab0f34def99e0928177a3fc209220be9fcb7d6cb371b0c9d086818ef8318f62d97ef39f8f38264acdef32d5795af02c90d54332c
+  data.tar.gz: c8a7a5aa657e2e78f9678e5e4da6ab348af718473b5431bdbbd84393050b58da560970da80b4d81904e901ddc13e7ca1f98b63e5bcb2367c41c8f2aa023cc7d3

data/.github/workflows/test.yml

@@ -16,19 +16,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2', '3.3', '3.4']
-        rails: ['7.1.0', '7.2.0', '8.0.0']
+        ruby: ['3.3', '3.4', '4.0']
+        rails: ['7.2.0', '8.0.0', '8.1.0']
         activeadmin: ['3.2.0', '3.3.0', '3.4.0', '3.5.1']
         exclude:
+          # ActiveAdmin 3.2.0 predates Rails 8 support.
           - rails: '8.0.0'
             activeadmin: '3.2.0'
+          - rails: '8.1.0'
+            activeadmin: '3.2.0'
         include:
+          # ActiveAdmin 4 requires railties >= 7.2, so cover its floor and the
+          # newest supported Rails releases.
           - ruby: '3.4'
             rails: '7.2.0'
             activeadmin: '4.0.0.beta22'
           - ruby: '3.4'
             rails: '8.0.0'
             activeadmin: '4.0.0.beta22'
+          - ruby: '3.4'
+            rails: '8.1.0'
+            activeadmin: '4.0.0.beta22'
     env:
       RAILS: ${{ matrix.rails }}
       AA: ${{ matrix.activeadmin }}

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 gemspec
 
-default_rails_version = '7.1.0'
-default_activeadmin_version = '3.2.0'
+default_rails_version = '8.0.0'
+default_activeadmin_version = '3.5.1'
 
 # `~> 4.0.0.beta22` would admit 4.0.0 GA — pin prereleases exactly so the
 # CI cell tests the AA build it claims to test.

data/README.md

@@ -225,7 +225,43 @@ end
 
 ##### Update existing records by id
 
-Delete colliding rows just before each batch insert:
+Two strategies, depending on your database and whether you need validations.
+
+###### Native upsert (recommended where supported)
+
+On databases that support upserts (MySQL, PostgreSQL 9.5+, SQLite 3.24+),
+`:on_duplicate_key_update` updates colliding rows and inserts new ones in a
+single statement — no extra delete. The option is passed straight to
+`activerecord-import`, so its shape depends on the adapter:
+
+```ruby
+# PostgreSQL / SQLite
+on_duplicate_key_update: { conflict_target: [:id], columns: %i[name last_name birthday] }
+
+# MySQL (infers the key from the columns)
+on_duplicate_key_update: %i[name last_name birthday]
+```
+
+```ruby
+ActiveAdmin.register Author do
+  active_admin_import validate: false,
+                      on_duplicate_key_update: { conflict_target: [:id], columns: %i[name last_name birthday] }
+end
+```
+
+Notes:
+
+* Only the columns you list are updated; other columns on the existing row keep their values.
+* Use `validate: false` — `activerecord-import` runs uniqueness validations against the very rows the upsert is about to overwrite, so `validates_uniqueness_of` would otherwise reject the update.
+* Active Record callbacks are not fired for bulk imports.
+
+###### Delete-then-insert (any database)
+
+When you can't rely on upsert support — an older database, or you need your model
+validations to run — delete the colliding rows just before each batch insert.
+The old row is gone before the insert, so `validates_uniqueness_of` doesn't trip,
+at the cost of a second query and full-row **replacement** (columns absent from
+the CSV are reset, not preserved):
 
 ```ruby
 ActiveAdmin.register Post do
@@ -235,8 +271,6 @@ ActiveAdmin.register Post do
 end
 ```
 
-For databases that support upserts you can use `:on_duplicate_key_update` instead.
-
 ##### Tune batch size
 
 ```ruby

data/active_admin_import.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.summary = 'ActiveAdmin import based on activerecord-import gem.'
   gem.homepage = 'https://github.com/activeadmin-plugins/active_admin_import'
   gem.license = 'MIT'
-  gem.required_ruby_version = '>= 3.1.0'
+  gem.required_ruby_version = '>= 3.3.0'
   gem.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.name = 'active_admin_import'

data/lib/active_admin_import/importer.rb

@@ -82,23 +82,15 @@ module ActiveAdminImport
     # end
     #
     def batch_slice_columns(slice_columns)
-      # Only set @use_indexes for the first batch so that @use_indexes are in correct
-      # position for subsequent batches
-      unless defined?(@use_indexes)
-        @use_indexes = []
-        headers.values.each_with_index do |val, index|
-          @use_indexes << index if val.in?(slice_columns)
-        end
-        return csv_lines if @use_indexes.empty?
-
-        # slice CSV headers
-        @headers = headers.to_a.values_at(*@use_indexes).to_h
-      end
+      columns = headers.values
+      indexes = columns.each_index.select { |i| columns[i].in?(slice_columns) }
+      return csv_lines if indexes.empty?
 
-      # slice CSV values
-      csv_lines.map! do |line|
-        line.values_at(*@use_indexes)
-      end
+      # @headers is reset to the full set at the start of every batch (see
+      # #batch_import), so each call narrows the previous call's result and every
+      # batch slices the same way — calling this more than once now composes (#186).
+      @headers = headers.to_a.values_at(*indexes).to_h
+      csv_lines.map! { |line| line.values_at(*indexes) }
     end
 
     def values_at(header_key)
@@ -129,10 +121,18 @@ module ActiveAdminImport
     end
 
     def prepare_headers
-      headers = self.headers.present? ? self.headers.map(&:to_s) : yield
-      @headers = Hash[headers.zip(headers.map { |el| el.underscore.gsub(/\s+/, '_') })].with_indifferent_access
-      @headers.merge!(options[:headers_rewrites].symbolize_keys.slice(*@headers.symbolize_keys.keys))
-      @headers
+      names = self.headers.present? ? self.headers : yield
+      blank_positions = names.each_index.select { |i| names[i].to_s.strip.empty? }
+      unless blank_positions.empty?
+        raise ActiveAdminImport::Exception,
+              "blank column header at column #{blank_positions.map { |i| i + 1 }.join(', ')}"
+      end
+
+      names = names.map(&:to_s)
+      # @source_headers is the complete parsed header row; batch_import copies it
+      # into the per-batch working @headers (see #batch_import).
+      @source_headers = Hash[names.zip(names.map { |el| el.underscore.gsub(/\s+/, '_') })].with_indifferent_access
+      @source_headers.merge!(options[:headers_rewrites].symbolize_keys.slice(*@source_headers.symbolize_keys.keys))
     end
 
     def run_callback(name)
@@ -141,6 +141,9 @@ module ActiveAdminImport
 
     def batch_import
       batch_result = nil
+      # Every batch re-parses full-width rows, so restore the full header set
+      # before slicing; batch_slice_columns then narrows this working copy.
+      @headers = @source_headers.dup
       @resource.transaction do
         run_callback(:before_batch_import)
         batch_result = resource.import(headers.values, csv_lines, import_options)

data/lib/active_admin_import/version.rb

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

data/spec/fixtures/files/authors_blank_header_end.csv

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

data/spec/fixtures/files/authors_blank_header_middle.csv

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

data/spec/fixtures/files/authors_empty_header.csv

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

data/spec/fixtures/files/authors_many.csv

@@ -0,0 +1,6 @@
+Birthday,Name,Last name
+1986-05-01,John,Doe
+1988-11-16,Jane,Roe
+1990-01-01,Jack,Smith
+1991-02-02,Jill,Jones
+1992-03-03,Joe,Brown

data/spec/import_spec.rb

@@ -190,6 +190,36 @@ describe 'import', type: :feature do
     end
   end
 
+  # Issue #197: a CSV with an empty header cell used to crash with
+  # `undefined method 'underscore' for nil`, wherever the blank sits.
+  context 'with a blank column header' do
+    shared_examples 'a rejected blank header' do |fixture, column|
+      before do
+        add_author_resource
+        visit '/admin/authors/import'
+        upload_file!(fixture)
+      end
+
+      it 'reports a clear error and imports nothing' do
+        expect(page).to have_content "blank column header at column #{column}"
+        expect(page).to have_no_content 'undefined method'
+        expect(Author.count).to eq(0)
+      end
+    end
+
+    context 'at the beginning' do
+      it_behaves_like 'a rejected blank header', :authors_empty_header, 1
+    end
+
+    context 'in the middle' do
+      it_behaves_like 'a rejected blank header', :authors_blank_header_middle, 2
+    end
+
+    context 'at the end' do
+      it_behaves_like 'a rejected blank header', :authors_blank_header_end, 4
+    end
+  end
+
   context 'authors already exist' do
     before do
       Author.create!(id: 1, name: 'Jane', last_name: 'Roe')
@@ -217,6 +247,51 @@ describe 'import', type: :feature do
         expect(Author.find(2).name).to eq('Jane')
       end
     end
+
+    # Issue #187: update existing records by id without a delete_all workaround.
+    # On databases that support upserts, :on_duplicate_key_update lets a single
+    # import update colliding rows and insert new ones in one pass.
+    context 'upserting authors by id via :on_duplicate_key_update' do
+      before do
+        # Existing row shares its id with the first CSV row but carries a stale
+        # birthday; the second CSV row (id 2) has no match and must be inserted.
+        Author.delete_all
+        Author.create!(id: 1, name: 'John', last_name: 'Doe', birthday: '1900-01-01')
+
+        # The option shape is adapter-specific: MySQL infers the conflicting key
+        # and only wants the column list, while PostgreSQL/SQLite need an explicit
+        # :conflict_target (see README).
+        on_duplicate_key_update =
+          if ActiveRecord::Base.connection.adapter_name.match?(/mysql/i)
+            %i[name last_name birthday]
+          else
+            { conflict_target: [:id], columns: %i[name last_name birthday] }
+          end
+
+        add_author_resource(
+          # Uniqueness validation runs against the rows the upsert is about to
+          # overwrite, so it must be off for an id-based upsert (see README).
+          validate: false,
+          on_duplicate_key_update: on_duplicate_key_update
+        )
+        visit '/admin/authors/import'
+        upload_file!(:authors_with_ids)
+      end
+
+      it 'reports every row as imported' do
+        expect(page).to have_content 'Successfully imported 2 authors'
+      end
+
+      it 'updates the existing author instead of duplicating it' do
+        expect(Author.count).to eq(2)
+        expect(Author.find(1).birthday).to eq(Date.new(1986, 5, 1))
+      end
+
+      it 'inserts the non-colliding author' do
+        expect(Author.find(2).name).to eq('Jane')
+        expect(Author.find(2).last_name).to eq('Roe')
+      end
+    end
   end
 
   context 'with valid options' do
@@ -581,6 +656,56 @@ describe 'import', type: :feature do
     end
   end
 
+  # Issue #186: each call must slice the result of the previous one, not re-apply
+  # the first call's indices to an already-sliced row.
+  context "with successive batch_slice_columns calls" do
+    before do
+      # validate: false isolates the slicing behaviour from the model's
+      # uniqueness validation, which would otherwise reject a later batch's
+      # author for sharing a NULL last_name with an earlier one.
+      add_author_resource template_object: ActiveAdminImport::Model.new,
+                          validate: false,
+                          before_batch_import: lambda { |importer|
+                            importer.batch_slice_columns(%w(name last_name))
+                            importer.batch_slice_columns(%w(name))
+                          },
+                          batch_size: batch_size
+      visit "/admin/authors/import"
+      upload_file!(fixture)
+    end
+
+    context "within a single batch" do
+      let(:batch_size) { 2 } # authors.csv has 2 rows -> 1 batch
+      let(:fixture) { :authors }
+
+      it "narrows the columns progressively" do
+        expect(Author.pluck(:name, :last_name, :birthday)).to match_array(
+          [
+            ["Jane", nil, nil],
+            ["John", nil, nil]
+          ]
+        )
+      end
+    end
+
+    context "across several batches" do
+      let(:batch_size) { 2 } # authors_many.csv has 5 rows -> 3 batches
+      let(:fixture) { :authors_many }
+
+      it "narrows the columns progressively in every batch" do
+        expect(Author.pluck(:name, :last_name, :birthday)).to match_array(
+          [
+            ["John", nil, nil],
+            ["Jane", nil, nil],
+            ["Jack", nil, nil],
+            ["Jill", nil, nil],
+            ["Joe", nil, nil]
+          ]
+        )
+      end
+    end
+  end
+
   context 'with invalid options' do
     let(:options) { { invalid_option: :invalid_value } }
 

data/tasks/test.rake

@@ -24,7 +24,16 @@ task :setup do
   )
   # v4 drops sprockets-rails (see Gemfile), so skip the asset pipeline to
   # avoid the auto-generated `config/initializers/assets.rb` crashing at boot.
-  rails_new_opts.unshift('--skip-asset-pipeline') if aa_v4
+  if aa_v4
+    rails_new_opts.unshift('--skip-asset-pipeline')
+  else
+    # Rails 8.1 wires importmap-rails into the generated ApplicationController
+    # (`stale_when_importmap_changes`). The AA 3 app uses Sprockets, not
+    # importmap, so that gem is absent and the controller raises NameError at
+    # boot. Skip JavaScript so the macro is never generated — the specs run on
+    # rack_test and never execute JS anyway.
+    rails_new_opts.unshift('--skip-javascript')
+  end
 
   system "bundle exec rails new spec/rails/#{TestAppPaths.app_dir_name} #{rails_new_opts.join(' ')}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_import
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Igor Fedoronchuk
@@ -114,9 +114,13 @@ files:
 - spec/fixtures/files/author_invalid.csv
 - spec/fixtures/files/author_invalid_format.txt
 - spec/fixtures/files/authors.csv
+- spec/fixtures/files/authors_blank_header_end.csv
+- spec/fixtures/files/authors_blank_header_middle.csv
 - spec/fixtures/files/authors_bom.csv
+- spec/fixtures/files/authors_empty_header.csv
 - spec/fixtures/files/authors_invalid_db.csv
 - spec/fixtures/files/authors_invalid_model.csv
+- spec/fixtures/files/authors_many.csv
 - spec/fixtures/files/authors_no_headers.csv
 - spec/fixtures/files/authors_values_exceeded_headers.csv
 - spec/fixtures/files/authors_win1251_win_endline.csv
@@ -150,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="