activerecord-import_with_callbacks 0.3.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bb8752cb77453895d342343f18ab91bc5059053
+  data.tar.gz: e1c5199c1c0bc578c6b0b619c365c528aeab7e8f
+SHA512:
+  metadata.gz: ee4770efa79ac7c4b46e294c173c3790c884b5532f8759a9761895353473d77f2bcb09bbbc1a569593fa44bd1ed74cb718e80197b865798cb8386e8233e359ac
+  data.tar.gz: 7bcb41a8e7cea51d70b2c65620b8608c50d91640884efe85536bcd44db00b04fb5b27bc16d2177375d4a9649b0df3504c0ebc252e1d2fa21423d1b496b783f70

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+---
+AllCops:
+  Exclude:
+    - lib/active_record/import.rb
+Rails:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/FileName:
+  Exclude:
+    - lib/activerecord-import_with_callbacks.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+before_script: createdb activerecord-import_with_callbacks
+cache: bundler
+language: ruby
+rvm:
+- 2.2
+sudo: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at erik@instacart.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pg'
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'rake', '~> 11.2'
+  gem 'rubocop', '~> 0.41.1'
+end
+
+group :test do
+  gem 'database_cleaner'
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Instacart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# ActiveRecord::ImportWithCallbacks
+
+A library for bulk inserting data using ActiveRecord with callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-import_with_callbacks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-import_with_callbacks
+
+## Usage
+
+```ruby
+users = Array.new(200) { |i| User.new(name: "User #{i}") }
+# Default batch size is 100 but can be overridden
+result = User.import_with_callbacks(users, batch_size: 50)
+result.num_inserts       #=> 4
+result.ids.size          #=> 200
+result.failed_instances  #=> []
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/instacart/activerecord-import_with_callbacks. This project
+is intended to be a safe, welcoming space for collaboration, and contributors
+are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/activerecord-import_with_callbacks.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/import_with_callbacks/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'activerecord-import_with_callbacks'
+  spec.version = ActiveRecord::ImportWithCallbacks::VERSION
+  spec.authors = ['Emmanuel Turlay', 'Erik Michaels-Ober']
+  spec.email = ['emmanuel@instacart.com', 'erik@instacart.com']
+
+  spec.summary = 'A library for bulk importing data using ActiveRecord'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/instacart/activerecord-import_with_callbacks'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split("\n").reject { |f| f.start_with?('spec/') }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.2'
+
+  spec.add_dependency 'activerecord', '>= 4.1', '< 5.1'
+  spec.add_dependency 'activerecord-import', '~> 0.19.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+end

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_record'
+
+spec_dir = Pathname.new(File.dirname(__FILE__)).join('../spec')
+database = spec_dir.join('database.yml')
+
+ActiveRecord::Base.configurations['test'] = YAML.load_file(database)['test']
+ActiveRecord::Base.default_timezone = :utc
+ActiveRecord::Base.establish_connection(:test)
+ActiveRecord::Base.raise_in_transactional_callbacks = true
+
+require_relative '../spec/schema'
+
+Dir[spec_dir.join('models/*.rb')].each { |file| require_relative "../#{file}" }
+
+require 'active_record/import_with_callbacks'
+
+ActiveRecord::Import.require_adapter('postgresql')
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+createdb activerecord-import_with_callbacks

data/lib/active_record/import_with_callbacks.rb

@@ -0,0 +1,119 @@
+require 'active_record'
+require 'activerecord-import/base'
+require 'fiber'
+
+module ActiveRecord
+  module ImportWithCallbacks
+    Result = Class.new(ActiveRecord::Import::Result)
+    DEFAULT_BATCH_SIZE = 100
+    DEFAULT_RECURSIVE = true
+    extend ActiveSupport::Concern
+
+    # Insert multiple records in batches with callbacks
+    #
+    # @param [Array<ActiveRecord::Base>] records
+    # @param [Hash] options
+    # @option options [Boolean] :validate Default: true
+    # @option options [Array, Hash] :on_duplicate_key_update
+    # @option options [Array<ActiveRecord::Base>] :synchronize Synchronize
+    #   existing records in memory with updates from the import
+    # @option options [Boolan] :timestamps
+    # @option options [Boolan] :recursive Import all autosave associations
+    # @option options [Integer] :batch_size Default: 100
+    # @return [ActiveRecord::Import::Result]
+    def import_with_callbacks(*args)
+      options = args.extract_options!
+      records = args.pop
+      options[:batch_size] = DEFAULT_BATCH_SIZE unless options.key?(:batch_size)
+      options[:recursive] = DEFAULT_RECURSIVE unless options.key?(:recursive)
+      import_in_transaction(records, options)
+    end
+
+    private
+
+    def import_in_transaction(records, options)
+      self.transaction do
+        import_in_batches(records, options)
+      end
+    end
+
+    def import_in_batches(records, options)
+      results = records.each_slice(options.fetch(:batch_size)).map do |slice|
+        slice.each { |record| record.send(:remember_transaction_record_state) }
+        with_callbacks(slice) do
+          import(slice, options)
+        end
+      end
+      merge_results(results)
+    end
+
+    def with_callbacks(records)
+      run_callbacks(records, :before, :save)
+      around_save_fibers = split_callbacks(records, :save)
+      run_callbacks(records, :before, :create)
+      around_create_fibers = split_callbacks(records, :create)
+      result = yield
+      # Execute the "after" part of around_create callbacks
+      around_create_fibers.select(&:alive?).each(&:resume)
+      run_callbacks(records, :after, :create)
+      # Execute the "after" part of around_save callbacks
+      around_save_fibers.select(&:alive?).each(&:resume)
+      run_callbacks(records, :after, :save, :commit)
+      result
+    end
+
+    def run_callbacks(records, before_or_after, *callbacks)
+      callbacks.each do |callback|
+        records.each do |record|
+          chain = build_callback_chain(record, before_or_after, callback)
+          run_chain(record, chain)
+        end
+      end
+    end
+
+    def split_callbacks(records, callback)
+      fibers = records.map do |record|
+        chain = build_callback_chain(record, :around, callback)
+        split_chain(record, chain)
+      end
+      # Execute the before part of around_* callbacks and pause at the yield
+      fibers.each(&:resume)
+    end
+
+    def build_callback_chain(record, before_after_or_around, callback)
+      chain = ActiveSupport::Callbacks::CallbackChain.new(callback, {})
+      callbacks = record.public_send(:"_#{callback}_callbacks")
+      append_callbacks_to_chain(callbacks, chain, before_after_or_around)
+      chain
+    end
+
+    def append_callbacks_to_chain(callbacks, chain, kind)
+      callbacks.select { |cb| cb.kind.equal?(kind) }.each do |callback|
+        next if callback.filter.to_s.start_with?('autosave_')
+        chain.append(callback)
+      end
+    end
+
+    def run_chain(m, chain)
+      runner = chain.compile
+      e = ActiveSupport::Callbacks::Filters::Environment.new(m, false)
+      runner.call(e)
+    end
+
+    def split_chain(m, chain)
+      runner = chain.compile
+      p = proc { Fiber.yield }
+      e = ActiveSupport::Callbacks::Filters::Environment.new(m, false, nil, p)
+      Fiber.new { runner.call(e) }
+    end
+
+    def merge_results(results)
+      failed_instances = results.inject([]) { |a, e| a + e.failed_instances }
+      num_inserts = results.inject(0) { |a, e| a + e.num_inserts }
+      ids = results.inject([]) { |a, e| a + e.ids }
+      Result.new(failed_instances, num_inserts, ids)
+    end
+  end
+
+  Base.extend(ActiveRecord::ImportWithCallbacks)
+end

data/lib/active_record/import_with_callbacks/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module ImportWithCallbacks
+    VERSION = '0.3.7'.freeze
+  end
+end

data/lib/activerecord-import_with_callbacks.rb

@@ -0,0 +1,2 @@
+require 'active_record/import_with_callbacks'
+require 'active_record/import_with_callbacks/version'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-import_with_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.3.7
+platform: ruby
+authors:
+- Emmanuel Turlay
+- Erik Michaels-Ober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: A library for bulk importing data using ActiveRecord
+email:
+- emmanuel@instacart.com
+- erik@instacart.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-import_with_callbacks.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/import_with_callbacks.rb
+- lib/active_record/import_with_callbacks/version.rb
+- lib/activerecord-import_with_callbacks.rb
+homepage: https://github.com/instacart/activerecord-import_with_callbacks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A library for bulk importing data using ActiveRecord
+test_files: []