active_record_importer 0.3.0 → 1.0.0

data/spec/support/database.rb

@@ -0,0 +1,100 @@
+##
+# Database used by the spec suite.
+#
+#   DB=postgresql bundle exec rspec   (default)
+#   DB=mysql      bundle exec rspec
+#
+# Connection settings can be overridden with the usual environment
+# variables (see .configuration below).
+##
+module Database
+  DATABASE = ENV.fetch('DB_NAME', 'active_record_importer_test')
+
+  module_function
+
+  def adapter
+    ENV.fetch('DB', 'postgresql').to_s
+  end
+
+  def mysql?
+    adapter == 'mysql'
+  end
+
+  def postgresql?
+    adapter == 'postgresql'
+  end
+
+  def configuration
+    if mysql?
+      {
+        adapter: ENV.fetch('MYSQL_ADAPTER', 'trilogy'),
+        host: ENV.fetch('MYSQL_HOST', '127.0.0.1'),
+        port: ENV.fetch('MYSQL_PORT', '3306').to_i,
+        username: ENV.fetch('MYSQL_USER', 'root'),
+        password: ENV.fetch('MYSQL_PASSWORD', ''),
+        database: DATABASE
+      }
+    elsif postgresql?
+      {
+        adapter: 'postgresql',
+        host: ENV['PG_HOST'],
+        port: ENV['PG_PORT'],
+        username: ENV['PG_USER'],
+        password: ENV['PG_PASSWORD'],
+        database: DATABASE
+      }.compact
+    else
+      fail "Unsupported DB=#{adapter.inspect}, use postgresql or mysql"
+    end
+  end
+
+  def connect!
+    ActiveRecord::Base.establish_connection(configuration)
+    ActiveRecord::Base.connection.execute('SELECT 1')
+  rescue ActiveRecord::NoDatabaseError
+    create_database!
+    ActiveRecord::Base.establish_connection(configuration)
+  end
+
+  def create_database!
+    admin_config = configuration.merge(database: postgresql? ? 'postgres' : nil).compact
+    ActiveRecord::Base.establish_connection(admin_config)
+    ActiveRecord::Base.connection.create_database(DATABASE)
+  end
+
+  def load_schema!
+    ActiveRecord::Schema.verbose = false
+    ActiveRecord::Schema.define do
+      create_table :users, force: true do |t|
+        t.string   :first_name
+        t.string   :last_name
+        t.string   :email
+        t.string   :employee_no
+        t.integer  :age
+        t.string   :role
+        t.string   :state
+        t.string   :password
+        t.text     :properties
+        t.integer  :imports_count, default: 0
+        t.timestamps null: true
+      end
+      add_index :users, :employee_no, unique: true
+
+      create_table :imports, force: true do |t|
+        t.text    :properties
+        t.string  :resource, null: false
+        t.integer :imported_rows, default: 0
+        t.integer :failed_rows, default: 0
+        t.text    :failed_file_content
+        t.string  :failed_file_content_type
+        t.timestamps null: true
+      end
+    end
+  end
+
+  def clean!
+    %w(users imports).each do |table|
+      ActiveRecord::Base.connection.execute("DELETE FROM #{table}")
+    end
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,112 @@
+##
+# Minimal stand-in for the host application's Import model
+# (the one described in the README), without Paperclip.
+##
+class Import < ActiveRecord::Base
+  store :properties, accessors: %i(insert_method find_options batch_size)
+
+  attr_accessor :execute_on_create
+
+  validates :resource, presence: true
+
+  def execute!
+    resource_class.import!(object: self, execute: true)
+  end
+
+  def resource_class
+    resource.safe_constantize
+  end
+
+  def import_file
+    file.path
+  end
+
+  attr_accessor :file
+
+  # Mimics Paperclip: receives the generated failed csv and keeps its content
+  def failed_file=(io)
+    self.failed_file_content = io.read
+  end
+
+  def failed_csv
+    CSV.parse(failed_file_content.to_s, headers: true)
+  end
+end
+
+##
+# Importable model with validations, a unique DB index that is NOT
+# backed by a model validation (employee_no), and ActiveRecord callbacks.
+##
+class User < ActiveRecord::Base
+  include ActiveRecordImporter::Importable
+
+  store :properties, accessors: %i(nickname department)
+
+  validates :first_name, presence: true
+  validates :email, presence: true, format: { with: /\A[^@\s]+@[^@\s]+\z/ }
+  validates :age, numericality: { greater_than: 0 }, allow_nil: true
+
+  after_save :bump_imports_count
+
+  class << self
+    attr_accessor :after_save_log, :state_log
+
+    def reset_logs!
+      self.after_save_log = []
+      self.state_log = []
+    end
+  end
+  reset_logs!
+
+  # Fake state machine API, enough for TransitionProcessor
+  Transition = Struct.new(:from, :to, :event)
+
+  def state_transitions
+    [
+      Transition.new('pending', 'active', :activate),
+      Transition.new('active', 'archived', :archive)
+    ]
+  end
+
+  def state_was
+    attribute_was('state')
+  end
+
+  def activate
+    update_column(:state, 'active')
+    self.class.state_log << [id, 'active']
+  end
+
+  def archive
+    update_column(:state, 'archived')
+    self.class.state_log << [id, 'archived']
+  end
+
+  def self.member_role(_row)
+    'member'
+  end
+
+  private
+
+  def bump_imports_count
+    update_column(:imports_count, imports_count.to_i + 1)
+  end
+end
+
+##
+# Second importable model: makes sure options are not shared between models
+##
+class Account < ActiveRecord::Base
+  include ActiveRecordImporter::Importable
+  self.table_name = 'users'
+
+  acts_as_importable insert_method: 'upsert', find_options: %i(email)
+end
+
+##
+# Model that never called acts_as_importable
+##
+class Plain < ActiveRecord::Base
+  include ActiveRecordImporter::Importable
+  self.table_name = 'users'
+end

data/spec/support/query_counter.rb

@@ -0,0 +1,22 @@
+##
+# Counts the SQL statements issued inside a block, grouped by verb,
+# so specs can assert that a chunk is persisted in bulk.
+##
+module QueryCounter
+  IGNORED = /\A\s*(BEGIN|COMMIT|ROLLBACK|SAVEPOINT|RELEASE|ROLLBACK TO)/i
+  # Statements on the Import record itself are bookkeeping, not row persistence
+  IMPORTS_TABLE = /["`]imports["`]/
+
+  def count_queries
+    counts = Hash.new(0)
+    subscriber = ActiveSupport::Notifications.subscribe('sql.active_record') do |*, payload|
+      sql = payload[:sql].to_s
+      next if payload[:name] == 'SCHEMA' || sql =~ IGNORED || sql =~ IMPORTS_TABLE
+      counts[sql[/\A\s*(\w+)/, 1].to_s.upcase] += 1
+    end
+    yield
+    counts
+  ensure
+    ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
+  end
+end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: active_record_importer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Nera
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2026-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: enumerize
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +160,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Smart gem for importing rails models
+description: Smart gem for importing CSV files to ActiveRecord models
 email:
 - kapitan_03@yahoo.com
 executables: []
@@ -142,6 +170,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -156,6 +185,7 @@ files:
 - lib/active_record_importer/attribute/find_options_builder.rb
 - lib/active_record_importer/attribute/helpers.rb
 - lib/active_record_importer/batch_importer.rb
+- lib/active_record_importer/batch_persister.rb
 - lib/active_record_importer/data_processor.rb
 - lib/active_record_importer/dispatcher.rb
 - lib/active_record_importer/engine.rb
@@ -166,16 +196,30 @@ files:
 - lib/active_record_importer/instance_builder.rb
 - lib/active_record_importer/options_builder.rb
 - lib/active_record_importer/railtie.rb
+- lib/active_record_importer/record_preloader.rb
 - lib/active_record_importer/transition_processor.rb
 - lib/active_record_importer/version.rb
 - lib/app/models/import.rb
+- spec/active_record_importer/attribute/builders_spec.rb
+- spec/active_record_importer/batch_persister_spec.rb
+- spec/active_record_importer/data_processor_spec.rb
+- spec/active_record_importer/failed_file_builder_spec.rb
+- spec/active_record_importer/import_callbacker_spec.rb
+- spec/active_record_importer/instance_builder_spec.rb
+- spec/active_record_importer/options_builder_spec.rb
+- spec/active_record_importer/record_preloader_spec.rb
 - spec/active_record_importer_spec.rb
+- spec/integration/import_spec.rb
 - spec/spec_helper.rb
+- spec/support/csv_helper.rb
+- spec/support/database.rb
+- spec/support/models.rb
+- spec/support/query_counter.rb
 homepage: https://github.com/michaelnera/active_record_importer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,16 +227,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Active Record Importer
 test_files: []