active_admin_import 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a624e96a7c740179d82959a81d6eceee7987813a6dbed662a5113eb41e76d2
-  data.tar.gz: 07ddbc628d18fa4b3a006a2709858001146f86d94f487368eca2c6e247f03ece
+  metadata.gz: ba919b0429b44accf46af4dcdc52ef1ddcf691a446cddf1bc434b38982c6b0c2
+  data.tar.gz: b54c35f3d81a3b170a8a27b657f1c0b8137c49716fab6b1ba0717845f1b15649
 SHA512:
-  metadata.gz: '08f7de1d997ace9ecb6e741e95f66be1a14bb1b044683f41d0c27d24ec4b1bd995f0a5e2feb2f20dca07704416e809a5735aa39dc153c7497bbbce650003db4b'
-  data.tar.gz: 8fc7ac974e5d03f6982fba484cc3ed2c54b9f5c9e3a38dd7a9ec1241100bb95e055639a75ffe79a9b3fffffbe06f3ab7c4a3ac162b8e63cd4316c7a73af2d7c8
+  metadata.gz: d949ae03350ff838eb97856d4c34afb610708dde36bee45d32b56de0bd1bf48a5e0adb4e67aaa549e1e35393cca146be755258fbc213422ab9a91b299769688e
+  data.tar.gz: 4ddc52d5273f06837f54a3806e56ebdad52c2a60581aa452b196de25885697348b13af8f56e27716ed2234b3771072f3f93e365035cdfc02b1539e7aa8385fb1

data/.gitignore

@@ -13,4 +13,7 @@ capybara-*.html
 /spec/tmp/*
 **.orig
 rerun.txt
-pickle-email-*.html
+pickle-email-*.html
+pkg
+spec/rails
+Gemfile.lock

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,4 +1,21 @@
 # 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

data/Gemfile

@@ -6,12 +6,13 @@ gemspec
 
 
 group :test do
-  default_rails_version = "~> 5.1"
+  default_rails_version = "~> 5.2.4"
   rails_version = ENV['RAILS'] || default_rails_version
+  gem 'sassc-rails'
   gem 'rails', rails_version
   gem 'rspec-rails'
   gem 'coveralls', require: false # Test coverage website. Go to https://coveralls.io
-  gem 'sqlite3'
+  gem "sqlite3", "~> 1.4.0"
   gem 'launchy'
   gem 'database_cleaner'
   gem 'capybara'

data/active_admin_import.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |gem|
   gem.name = 'active_admin_import'
   gem.require_paths = ['lib']
   gem.version = ActiveAdminImport::VERSION
-  gem.add_runtime_dependency 'activerecord-import', '~> 0.27'
-  gem.add_runtime_dependency 'rchardet', '~> 1.6'
-  gem.add_runtime_dependency 'rubyzip', '~> 1.2'
-  gem.add_dependency 'activeadmin', '>= 1.0.0.pre2'
+  gem.add_runtime_dependency 'activerecord-import', '>= 0.27'
+  gem.add_runtime_dependency 'rchardet', '>= 1.6'
+  gem.add_runtime_dependency 'rubyzip', '>= 1.2'
+  gem.add_dependency 'activeadmin', '>= 1.0.0'
 end

data/lib/active_admin_import/dsl.rb

@@ -92,7 +92,11 @@ module ActiveAdminImport
           else
             instance_exec result, options, &DEFAULT_RESULT_PROC
           end
-        rescue ActiveRecord::Import::MissingColumnError, NoMethodError, ActiveRecord::StatementInvalid, CSV::MalformedCSVError => e
+        rescue ActiveRecord::Import::MissingColumnError,
+               NoMethodError,
+               ActiveRecord::StatementInvalid,
+               CSV::MalformedCSVError,
+               ActiveAdminImport::Exception => e
           Rails.logger.error(I18n.t('active_admin_import.file_error', message: e.message))
           Rails.logger.error(e.backtrace.join("\n"))
           flash[:error] = I18n.t('active_admin_import.file_error', message: e.message[0..200])

data/lib/active_admin_import/exception.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module ActiveAdminImport
+  class Exception < StandardError
+  end
+end

data/lib/active_admin_import/import_result.rb

@@ -33,7 +33,10 @@ module ActiveAdminImport
       limit = options[:limit] || failed.count
       failed.first(limit).map do |record|
         errors = record.errors
-        (errors.full_messages.zip errors.keys.map { |k| record.send k }).map { |ms| ms.join(' - ') }.join(', ')
+        failed_values = errors.keys.map do |key|
+          key == :base ? nil : record.public_send(key)
+        end
+        errors.full_messages.zip(failed_values).map { |ms| ms.compact.join(' - ') }.join(', ')
       end.join(' ; ')
     end
   end

data/lib/active_admin_import/importer.rb

@@ -37,7 +37,7 @@ module ActiveAdminImport
     end
 
     def cycle(lines)
-      @csv_lines = CSV.parse(lines.join, @csv_options)
+      @csv_lines = CSV.parse(lines.join, **@csv_options)
       import_result.add(batch_import, lines.count)
     end
 
@@ -70,7 +70,7 @@ module ActiveAdminImport
       end
     end
 
-    # Use it when CSV file contain redundant columns
+    # Use this method when CSV file contains unnecessary columns
     #
     # Example:
     #
@@ -81,16 +81,22 @@ module ActiveAdminImport
     # end
     #
     def batch_slice_columns(slice_columns)
-      use_indexes = []
-      headers.values.each_with_index do |val, index|
-        use_indexes << index if val.in?(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
-      return csv_lines if use_indexes.empty?
-      # slice CSV headers
-      @headers = headers.to_a.values_at(*use_indexes).to_h
+
       # slice CSV values
       csv_lines.map! do |line|
-        line.values_at(*use_indexes)
+        line.values_at(*@use_indexes)
       end
     end
 
@@ -109,7 +115,7 @@ module ActiveAdminImport
       batch_size = options[:batch_size].to_i
       File.open(file.path) do |f|
         # capture headers if not exist
-        prepare_headers { CSV.parse(f.readline, @csv_options).first }
+        prepare_headers { CSV.parse(f.readline, **@csv_options).first }
         f.each_line do |line|
           lines << line if line.present?
           if lines.size == batch_size || f.eof?

data/lib/active_admin_import/model.rb

@@ -21,6 +21,7 @@ module ActiveAdminImport
         application/csv
         application/vnd.ms-excel
         application/vnd.msexcel
+        application/octet-stream
         text/tsv
         text/x-tsv
         text/tab-separated-values
@@ -109,7 +110,7 @@ module ActiveAdminImport
 
     def unzip_file
       Zip::File.open(file_path) do |zip_file|
-        self.file = Tempfile.new(CONST::TMP_FILE)
+        self.file = Tempfile.new(CONST::TMP_FILE, binmode: true)
         data = zip_file.entries.select(&:file?).first.get_input_stream.read
         file << data
         file.close

data/lib/active_admin_import/version.rb

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

data/lib/active_admin_import.rb

@@ -3,6 +3,7 @@ require 'activerecord-import'
 require 'active_admin'
 require 'active_admin_import/version'
 require 'active_admin_import/engine'
+require 'active_admin_import/exception'
 require 'active_admin_import/import_result'
 require 'active_admin_import/options'
 require 'active_admin_import/dsl'

data/spec/fixtures/files/authors.csv

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

data/spec/import_result_spec.rb

@@ -5,17 +5,18 @@ describe ActiveAdminImport::ImportResult do
   context 'failed_message' do
     let(:import_result) { ActiveAdminImport::ImportResult.new }
 
-    before do
-      Author.create(name: 'John', last_name: 'Doe')
-      Author.create(name: 'Jane', last_name: 'Roe')
 
+    let(:failed_instances) do
+     [
+         Author.new(last_name: 'Doe').tap {|r| r.errors.add(:last_name,  :taken) },
+         Author.new(name: "", last_name: 'Doe').tap {|r| r.errors.add(:name,  :blank); r.errors.add(:last_name,  :taken)  },
+         Author.new.tap {|r| r.errors.add(:base,  'custom') }
+     ]
+    end
+
+    before do
       @result = double \
-        failed_instances: [
-          # {:last_name=>["has already been taken"]}
-          Author.create(name: 'Jim', last_name: 'Doe'),
-          # {:name=>["can't be blank"], :last_name=>["has already been taken"]}
-          Author.create(name: nil,   last_name: 'Doe')
-        ]
+        failed_instances: failed_instances
     end
 
     it 'should work without any failed instances' do
@@ -26,7 +27,7 @@ describe ActiveAdminImport::ImportResult do
       import_result.add(@result, 4)
       expect(import_result.failed_message)
         .to eq(
-          "Last name has already been taken - Doe ; Name can't be blank - , Last name has already been taken - Doe"
+          "Last name has already been taken - Doe ; Name can't be blank - , Last name has already been taken - Doe ; custom"
         )
     end
 

data/spec/import_spec.rb

@@ -371,6 +371,20 @@ describe 'import', type: :feature do
             end
           end
         end
+
+        context 'when zipped with Win1251 file' do
+          let(:options) do
+            attributes = { force_encoding: :auto }
+            { template_object: ActiveAdminImport::Model.new(attributes) }
+          end
+          it 'should import file' do
+            with_zipped_csv(:authors_win1251_win_endline) do
+              upload_file!(:authors_win1251_win_endline, :zip)
+              expect(page).to have_content 'Successfully imported 2 authors'
+              expect(Author.count).to eq(2)
+            end
+          end
+        end
       end
 
       context 'with different header attribute names' do
@@ -430,15 +444,40 @@ describe 'import', type: :feature do
         upload_file!(:authors)
         expect(Author.count).to eq(2)
       end
+
+      context 'when the option before_import raises a ActiveAdminImport::Exception' do
+        let(:options) { { before_import: ->(_) { raise ActiveAdminImport::Exception, 'error message' } } }
+
+        before { upload_file!(:authors) }
+
+        it 'should show error' do
+          expect(page).to have_content I18n.t('active_admin_import.file_error', message: 'error message')
+          expect(Author.count).to eq(0)
+        end
+      end
+
+      context 'when the option before_batch_import raises a ActiveAdminImport::Exception' do
+        let(:options) { { before_batch_import: ->(_) { raise ActiveAdminImport::Exception, 'error message' } } }
+
+        before { upload_file!(:authors) }
+
+        it 'should show error' do
+          expect(page).to have_content I18n.t('active_admin_import.file_error', message: 'error message')
+          expect(Author.count).to eq(0)
+        end
+      end
     end
   end
 
   context "with slice_columns option" do
+    let(:batch_size) { 2 }
+
     before do
       add_author_resource template_object: ActiveAdminImport::Model.new,
                           before_batch_import: lambda { |importer|
                             importer.batch_slice_columns(slice_columns)
-                          }
+                          },
+                          batch_size: batch_size
       visit "/admin/authors/import"
       upload_file!(:authors)
     end
@@ -446,13 +485,23 @@ describe 'import', type: :feature do
     context "slice last column and superfluous column" do
       let(:slice_columns) { %w(name last_name not_existing_column) }
 
-      it "should not fill `birthday` column" do
-        expect(Author.pluck(:name, :last_name, :birthday)).to match_array(
-          [
-            ["Jane", "Roe", nil],
-            ["John", "Doe", nil]
-          ]
-        )
+      shared_examples_for "birthday column removed" do
+        it "should not fill `birthday` column" do
+          expect(Author.pluck(:name, :last_name, :birthday)).to match_array(
+            [
+              ["Jane", "Roe", nil],
+              ["John", "Doe", nil]
+            ]
+          )
+        end
+      end
+
+      it_behaves_like "birthday column removed"
+
+      context "when doing more than one batch" do
+        let(:batch_size) { 1 }
+
+        it_behaves_like "birthday column removed"
       end
     end
 

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ 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'

data/tasks/test.rake

@@ -3,5 +3,5 @@ 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"
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template.rb --skip-spring  --skip-turbolinks  --skip-bootsnap"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_import
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Igor Fedoronchuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-import
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.27'
 - !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'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre2
+        version: 1.0.0
 description: The most efficient way to import for Active Admin
 email:
 - fedoronchuk@gmail.com
@@ -99,6 +99,7 @@ files:
 - lib/active_admin_import/authorization.rb
 - lib/active_admin_import/dsl.rb
 - lib/active_admin_import/engine.rb
+- lib/active_admin_import/exception.rb
 - lib/active_admin_import/import_result.rb
 - lib/active_admin_import/importer.rb
 - lib/active_admin_import/model.rb
@@ -133,7 +134,7 @@ homepage: http://github.com/Fivell/active_admin_import
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,9 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: ActiveAdmin import based on activerecord-import gem.
 test_files: