active_record_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43724c0cedd35917d14e3439f96482c8f2357943
+  data.tar.gz: 7db97349cd0eafa87a2296906f56e6543c58395f
+SHA512:
+  metadata.gz: 22f7c0e2eb463b49e0a717d1ee4da685c111424681f20cbc2f578ebe5bbbab57277384f05715aca3abf22ffb25fe957efe8820ee916d6add08cc8ba82fa82e84
+  data.tar.gz: e90f8ab8ce49228e47441a3df8adcd214547fec041583912760e0792b1b6eff631f8378723d9cc73af23fbcc4605b8c58ee59578ca433a1c8a6070f413026502

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_importer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,172 @@
+# ActiveRecordImporter
+
+Supports only Rails 4... (I'll release soon an update to support Rails 5)
+
+This gem helps you insert/update records easily. For now, it only accepts CSV file.
+This also helps you monitor how many rows are imported, and how many rows failed.
+I'll release an update to enable this on background job.
+This gem allows you to easily import to any model with few configurations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_importer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_importer
+
+## Usage
+
+Simple usage for now:
+
+### Create Import table/model
+I'll add a generator on my next release
+#### DB Migration:
+```ruby
+class ActiveRecordImporterMigration < ActiveRecord::Migration
+  def change
+    create_table :imports do |t|
+      t.attachment  :file
+      t.attachment  :failed_file
+      t.text        :properties
+      t.string      :resource,           null: false
+      t.integer     :imported_rows,      default: 0
+      t.integer     :failed_rows,        default: 0
+      t.timestamps
+    end
+  end
+end
+```
+
+#### Import Model:
+```ruby
+class Import < ActiveRecord::Base
+  extend Enumerize
+  store :properties, accessors: %i(insert_method find_options batch_size)
+
+  enumerize :insert_method,
+            in: %w(insert upsert error_duplicate),
+            default: :upsert
+
+  has_attached_file :file
+
+  attr_accessor :execute_on_create
+
+  validates :resource, presence: true
+  validate :check_presence_of_find_options
+  validates_attachment :file,
+                       content_type: {
+                           content_type: %w(text/plain text/csv)
+                       }
+
+  after_create :execute, if: :execute_on_create
+
+  # I'll add import options in the next release
+  # accepts_nested_attributes_for :import_options, allow_destroy: true
+
+  def execute
+    resource_class.import!(self, execute_on_create)
+  end
+
+  def resource_class
+    resource.safe_constantize
+  end
+
+  def batch_size
+    super.to_i
+  end
+
+  ##
+  # Override this if you prefer have
+  # a private permissions or you have
+  # private methods for reading files
+  ##
+  def import_file
+    local_path? ? file.path : file.url
+  end
+
+  private
+
+  def check_presence_of_find_options
+    return if insert_method.insert?
+    errors.add(:find_options, "can't be blank") if find_options.blank?
+  end
+
+  def local_path?
+    File.exist? import_file.file.path
+  end
+end
+```
+
+Add `acts_as_importable` to a model to make it importable
+```ruby
+class User < ActiveRecord::Base
+  acts_as_importable
+end
+```
+
+You may also add import options:
+```ruby
+class User < ActiveRecord::Base
+  acts_as_importable default_attributes: { first_name: 'Juan',
+                                           last_name: 'dela Cruz' },
+                     find_options: %i(email),
+                     before_save: Proc.new { |user| user.password = 'temporarypassword123' }
+end
+```
+
+You may also add some options from the SmarterCSV gem:
+
+    | Option                         |  Default
+    --------------------------------------------------------------
+    | :convert_values_to_metric      |  nil
+    | :value_converters              |  nil
+    | :remove_empty_values           |  false
+    | :comment_regexp                |  Regexp.new(/^#=>/)
+    | :force_utf8                    |  true
+    | :chunk_size                    |  500
+    | :col_sep                       |  ","
+
+#### I'll add more options SOON!
+
+#### Imports Controller:
+```ruby
+class ImportsController < ApplicationController
+
+  def create
+    @import = Import.create!(import_params)
+    @import.execute_on_create = true
+    @import.execute
+  end
+
+end
+```
+
+You may include execute_on_create as a checkbox field in your Import form so you don't have to
+include `@import.execute_on_create = true` in your controller.
+
+
+
+## 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/michaelnera/active_record_importer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_record_importer.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_importer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_importer'
+  spec.version       = ActiveRecordImporter::VERSION
+  spec.authors       = ['Michael Nera']
+  spec.email         = ['kapitan_03@yahoo.com']
+
+  spec.summary       = 'Active Record Importer'
+  spec.description   = 'Smart gem for importing rails models'
+  spec.homepage      = 'https://github.com/michaelnera/active_record_importer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '~> 2.99'
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.0'
+  spec.add_runtime_dependency 'enumerize', '>= 2.0', '~> 2.0.1'
+  spec.add_runtime_dependency 'virtus', '>= 1.0', '~> 1.0'
+  spec.add_runtime_dependency 'smarter_csv', '>= 1.0', '~> 1.0'
+  spec.add_runtime_dependency 'paperclip', '>= 4.0', '~> 4.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_importer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db/migrate/1_active_record_importer_migration.rb

@@ -0,0 +1,13 @@
+class ActiveRecordImporterMigration < ActiveRecord::Migration
+  def change
+    create_table :imports do |t|
+      t.attachment  :file
+      t.attachment  :failed_file
+      t.text        :properties
+      t.string      :resource,           null: false
+      t.integer     :imported_rows,      default: 0
+      t.integer     :failed_rows,        default: 0
+      t.timestamps
+    end
+  end
+end

data/lib/active_record_importer.rb

@@ -0,0 +1,27 @@
+require 'active_record_importer/version'
+require 'active_support/core_ext/module'
+require 'virtus'
+require 'enumerize'
+require 'smarter_csv'
+require 'paperclip'
+
+module ActiveRecordImporter
+  extend ActiveSupport::Autoload
+
+  ::IMPORTABLES = []
+
+  autoload :BatchImporter,        'active_record_importer/batch_importer'
+  autoload :DataProcessor,        'active_record_importer/data_processor'
+  autoload :Dispatcher,           'active_record_importer/dispatcher'
+  autoload :Errors,               'active_record_importer/errors'
+  autoload :Importable,           'active_record_importer/importable'
+  autoload :InstanceBuilder,      'active_record_importer/instance_builder'
+  autoload :OptionsBuilder,       'active_record_importer/options_builder'
+  autoload :AttributesBuilder,    'active_record_importer/attributes_builder'
+  autoload :FindOptionsBuilder,   'active_record_importer/find_options_builder'
+  autoload :TransitionProcessor,  'active_record_importer/transition_processor'
+  autoload :ImportCallbacker,     'active_record_importer/import_callbacker'
+  autoload :Helpers,              'active_record_importer/helpers'
+
+  require 'active_record_importer/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+end

data/lib/active_record_importer/attributes_builder.rb

@@ -0,0 +1,67 @@
+module ActiveRecordImporter
+  class AttributesBuilder
+    include Helpers
+
+    attr_reader :importable, :row_attrs, :processed_attrs
+
+    delegate :importer_options, to: :importable
+    delegate :importable_columns,
+             :default_attributes,
+             :find_assoc_opts,
+             to: :importer_options
+
+    def initialize(importable, row_attrs)
+      @importable = importable
+      @row_attrs = row_attrs
+      @processed_attrs = {}
+    end
+
+    def build
+      force_encode_attributes
+      fetch_time_attributes
+      processed_attrs
+    end
+
+    private
+
+    def default_attrs
+      def_attrs = { importing: true }
+      default_attributes.each do |key, value|
+        def_attrs[key] = fetch_value(value)
+      end
+    end
+
+    def force_encode_attributes
+      @processed_attrs = force_utf8_encode(merged_attributes)
+    end
+
+    def fetch_time_attributes
+      @processed_attrs.merge!(time_attributes(processed_attrs))
+    end
+
+    def fetch_value(value)
+      case value
+        when Proc
+          value.call(row_attrs)
+        when Symbol
+          importable.send(value, row_attrs)
+        else
+          value
+      end
+    end
+
+    def merged_attributes
+      attributes = row_attrs.slice(*importable_columns)
+      row_attrs = attributes.inject({}) do |row_attrs, key_value|
+        row_attrs[key_value.first] = key_value.last if key_value.last.present?
+        row_attrs
+      end
+      default_attrs.merge(row_attrs)
+    end
+
+    def has_column?(column)
+      return if column.blank?
+      importable_columns.include?(column.to_sym)
+    end
+  end
+end

data/lib/active_record_importer/batch_importer.rb

@@ -0,0 +1,40 @@
+module ActiveRecordImporter
+  class BatchImporter
+
+    attr_reader :data, :import
+
+    def initialize(import, data)
+      @import = import
+      @data = data
+    end
+
+    def process!
+      @imported_count, @failed_count = 0, 0
+
+      data.each do |row|
+        next if row.blank?
+        processor = DataProcessor.new(import, row.symbolize_keys!)
+        processor.process ? @imported_count += 1 : @failed_count += 1
+      end
+
+      set_import_count
+    end
+
+    private
+
+    def set_import_count
+      Import.update_counters(import.id, imported_rows: @imported_count)
+      Import.update_counters(import.id, failed_rows: @failed_count)
+    end
+
+    def importable
+      import.resource.safe_constantize
+    end
+
+    delegate :importer_options, to: :importable
+
+    def csv_options
+      importer_options.csv_opts.to_hash
+    end
+  end
+end

data/lib/active_record_importer/data_processor.rb

@@ -0,0 +1,101 @@
+module ActiveRecordImporter
+  class DataProcessor
+    attr_reader :importable, :import, :instance, :attributes,
+                :row_errors, :row_attrs, :find_attributes
+
+    delegate :importer_options,
+             to: :importable
+
+    def initialize(import, row_attrs)
+      @import = import
+      @importable = import.resource.safe_constantize
+      @row_attrs = row_attrs
+    end
+
+    def process
+      fetch_instance_attributes
+      fetch_find_attributes
+      create_instance
+    end
+
+    private
+
+    def create_instance
+      ActiveRecord::Base.transaction do
+        begin
+          @instance =
+              InstanceBuilder.new(
+                import, find_attributes,
+                attributes_without_state_machine_attrs
+              ).build
+
+          methods_after_upsert
+          true
+        rescue => exception
+          append_errors(exception, true)
+        end
+      end
+    end
+
+    def fetch_instance_attributes
+      @attributes = AttributesBuilder.new(
+                      importable, row_attrs
+                    ).build
+    rescue => exception
+      append_errors(exception)
+    end
+
+    def fetch_find_attributes
+      @find_attributes = FindOptionsBuilder.new(
+        resource: import.resource,
+        find_options: import.find_options,
+        attrs: attributes
+      ).build
+    rescue => exception
+      append_errors(exception)
+    end
+
+    def methods_after_upsert
+      return if instance.blank? || !instance.persisted?
+
+      state_transitions
+      run_after_save_callbacks
+    end
+
+    delegate :after_save,
+             :state_machine_attr,
+             to: :importer_options
+
+    def state_transitions
+      return if state_machine_attr.blank?
+
+      state_machine_attr.each do |attr|
+        state = row_attrs[attr.to_sym]
+        next if state.blank? || state == instance.send(attr)
+        TransitionProcessor.new(instance, state, attr).transit
+      end
+    end
+
+    def attributes_without_state_machine_attrs
+      attributes.except(*state_machine_attr)
+    end
+
+    def skip_callbacks?
+      after_save.blank? || instance.blank? || instance.new_record?
+    end
+
+    def run_after_save_callbacks
+      return if skip_callbacks?
+
+      ImportCallbacker.new(instance, after_save).call
+    end
+
+    def append_errors(error, rollback = false)
+      return if error.blank?
+
+      message = error.is_a?(Exception) ? error.message : error
+      @row_errors = message
+      fail ActiveRecord::Rollback if rollback
+    end
+  end
+end

data/lib/active_record_importer/dispatcher.rb

@@ -0,0 +1,48 @@
+module ActiveRecordImporter
+  class Dispatcher
+    attr_reader :import, :execute
+
+    def initialize(import_id, execute = true)
+      @import = Import.find(import_id)
+      @execute = execute
+    end
+
+    def call
+      divide_and_conquer
+    end
+
+    private
+
+    def divide_and_conquer
+      File.open(import.import_file, 'r:bom|utf-8') do |file|
+        SmarterCSV.process(file, csv_options) do |collection|
+          queue_or_execute(collection)
+        end
+      end
+    end
+
+    def csv_options
+      klass = import.resource.safe_constantize
+      opts = klass_csv_opts(klass)
+      return opts if import.batch_size.blank? || import.batch_size < 1
+      opts.merge(chunk_size: import.batch_size)
+    end
+
+    def klass_csv_opts(klass)
+      klass.importer_options.csv_opts.to_hash
+    end
+
+    def queue_or_execute(collection)
+      process_import(collection) if execute
+      queue(collection)
+    end
+
+    def process_import(collection)
+      BatchImporter.new(import, collection).process!
+    end
+
+    def queue(collection)
+      # To follow
+    end
+  end
+end

data/lib/active_record_importer/engine.rb

@@ -0,0 +1,4 @@
+module ActiveRecordImporter
+  class Engine < Rails::Engine
+  end
+end

data/lib/active_record_importer/errors.rb

@@ -0,0 +1,17 @@
+module ActiveRecordImporter
+  module Errors
+    class InvalidTransition < StandardError
+      def initialize
+        super 'Transition is invalid'
+      end
+    end
+
+    class MissingFindByOption < StandardError
+      def initialize
+        super 'Find by option for your csv is missing or incorrect.'
+      end
+    end
+
+    class DuplicateRecord < StandardError; end
+  end
+end

data/lib/active_record_importer/find_options_builder.rb

@@ -0,0 +1,52 @@
+module ActiveRecordImporter
+  class FindOptionsBuilder
+    include Virtus.model
+    include Helpers
+
+    attribute :resource, String
+    attribute :attrs, Hash, default: {}
+    attribute :find_options, String
+    attribute :prefix, String
+
+    def build
+      get_find_opts
+      slice_attributes
+    end
+
+    private
+
+    def klass
+      resource.safe_constantize
+    end
+
+    delegate :importer_options, to: :klass
+
+    delegate :required_attributes, to: :importer_options
+
+    def get_find_opts
+      @options = strip_and_symbolize
+      @options ||= importer_options.find_options || required_attributes
+      @options
+    end
+
+    def slice_attributes
+      return attrs.slice(*@options).compact if prefix.blank?
+
+      @options.inject({}) do |attr, key|
+        attr[key] = attrs[prefixed_key(key)].presence
+        attr
+      end.compact
+    end
+
+    def prefixed_key(key)
+      "#{prefix}#{key}".to_sym
+    end
+
+    def strip_and_symbolize
+      return if find_options.blank?
+      find_options.split(',').map do |key|
+        key.strip.to_sym
+      end
+    end
+  end
+end

data/lib/active_record_importer/helpers.rb

@@ -0,0 +1,26 @@
+module ActiveRecordImporter
+  module Helpers
+
+    def parse_datetime(datetime = nil)
+      return if datetime.blank?
+      Time.parse(datetime)
+    end
+
+    def force_utf8_encode(data = {})
+      return data if data.blank?
+
+      data.keys.each do |key|
+        data[key] = data[key].force_encoding('UTF-8') if data[key].is_a?(String)
+      end
+
+      data
+    end
+
+    def time_attributes(data = {})
+      attrs = {}
+      attrs[:created_at] = parse_datetime(data[:created_at]) || Time.now
+      attrs[:updated_at] = parse_datetime(data[:updated_at]) || attrs[:created_at]
+      attrs
+    end
+  end
+end

data/lib/active_record_importer/import_callbacker.rb

@@ -0,0 +1,30 @@
+module ActiveRecordImporter
+  class ImportCallbacker
+    attr_reader :object, :callback_methods
+
+    def initialize(object, callback_methods)
+      @object = object
+      @callback_methods = callback_methods
+    end
+
+    def call
+      case callback_methods
+        when Array
+          run_each_callbacks
+        when Symbol
+          object.send(callback)
+        when Proc
+          callback.call(object)
+      end
+    end
+
+    private
+
+    def run_each_callbacks
+      callback_methods.each do |callback|
+        object.send(callback) if callback.is_a?(Symbol)
+        callback.call(object) if callback.is_a?(Proc)
+      end
+    end
+  end
+end

data/lib/active_record_importer/importable.rb

@@ -0,0 +1,76 @@
+module ActiveRecordImporter
+  module Importable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      ##
+      # Make a model importable
+      # This will allow a model to use the importer
+      #
+      #   class User < ActiveRecord::Base
+      #     acts_as_importable
+      #   end
+      #
+      # You may also add options:
+      #   class User < ActiveRecord::Base
+      #     acts_as_importable default_attributes: {first_name: 'Michael', surname: 'Nera'}
+      #   end
+      ##
+      def acts_as_importable(options = {})
+        @@importer_options = OptionsBuilder.build(options.merge(allowed_columns_hash(options)))
+        ::IMPORTABLES << self.name unless ::IMPORTABLES.include?(self.name)
+
+        include ActiveRecordImporter::Importable::InstanceMethods
+      end
+
+      def importer_options
+        @@importer_options
+      end
+
+      def import!(import_object, execute = true)
+        ActiveRecordImporter::Dispatcher.new(
+          import_object.id, execute).call
+      end
+
+      private
+
+      def allowed_columns_hash(options = {})
+        {
+          importable_columns: allowed_columns(options)
+        }
+      end
+
+      def allowed_columns(options = {})
+        all_columns + store_accessors(options) - excluded_columns(options)
+      end
+
+      def all_columns
+        return [] unless (self.respond_to?(:table_exists?) && self.table_exists?)
+        self.columns.map { |column| column.name.to_sym }
+      end
+
+      def store_accessors(options = {})
+        options.fetch(:store_accessors, [])
+      end
+
+      def importable_columns
+        importer_options.importable_columns
+      end
+
+      def excluded_columns(options = {})
+        columns = [:id]
+        columns + options.fetch(:exclude_columns, [])
+      end
+    end
+
+    module InstanceMethods
+      attr_accessor :importing
+
+      def importing?
+        @importing ||= false
+      end
+    end
+  end
+end

data/lib/active_record_importer/instance_builder.rb

@@ -0,0 +1,56 @@
+module ActiveRecordImporter
+  class InstanceBuilder
+    attr_reader :attributes, :find_attributes, :import
+
+    def initialize(import, find_attributes, attributes)
+      @import = import
+      @find_attributes = find_attributes
+      @attributes = attributes
+    end
+
+    def build
+      instance = initialize_instance
+      process_data(instance)
+    end
+
+    private
+
+    delegate :insert_method, to: :import
+
+    def initialize_instance
+      return klass.new if insert_method.insert?
+
+      fail Errors::MissingFindByOption if find_attributes.blank?
+      klass.find_or_initialize_by(find_attributes)
+    end
+
+    def klass
+      import.resource.safe_constantize
+    end
+
+    delegate :importer_options, to: :klass
+    delegate :before_save, to: :importer_options
+
+    def process_data(instance)
+      fail Errors::DuplicateRecord if error_duplicate?(instance)
+
+      before_save_callback(instance)
+      assign_attrs_and_save!(instance)
+    end
+
+    def before_save_callback(instance)
+      return if before_save.blank?
+      ImportCallbacker.new(instance, before_save).call
+    end
+
+    def assign_attrs_and_save!(instance)
+      instance.attributes = attributes
+      instance.save!
+      instance
+    end
+
+    def error_duplicate?(instance)
+      instance.persisted? && insert_method.error_duplicate?
+    end
+  end
+end

data/lib/active_record_importer/options_builder.rb

@@ -0,0 +1,45 @@
+module ActiveRecordImporter
+  class OptionsBuilder
+    def self.build(options = {})
+      ImporterOptions.new(options)
+    end
+  end
+
+  #
+  # SmarterCSV is used to process the csv file
+  # https://github.com/tilo/smarter_csv
+  # I used some of it's options
+  # Please refer to it's documentation
+  #
+  class CsvOptions
+    include Virtus.value_object
+
+    values do
+      attribute :convert_values_to_numeric
+      attribute :value_converters, Hash, default: nil
+      attribute :remove_empty_values, Boolean, default: false
+      attribute :comment_regexp, Regexp, default: Regexp.new(/^#=>/)
+      attribute :force_utf8, Boolean, default: true
+      attribute :chunk_size, Integer, default: 500
+      attribute :col_sep, String, default: ','
+    end
+  end
+
+  #
+  # Import Option for every IMPORTABLE model
+  #
+  class ImporterOptions
+    include Virtus.model
+
+    attribute :find_options, Array
+    attribute :exclude_from_find_options, Array
+    attribute :scope, Symbol
+    attribute :importable_columns, Array
+    attribute :default_attributes, Hash
+    attribute :csv_opts, CsvOptions, default: CsvOptions.new
+    attribute :find_assoc_opts, Hash
+    attribute :before_save
+    attribute :after_save
+    attribute :state_machine_attr, Array
+  end
+end

data/lib/active_record_importer/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+module ActiveRecordImporter
+  class Railtie < Rails::Railtie
+
+    initializer "active_record_importer.active_record" do |_app|
+      ActiveSupport.on_load :active_record do
+        include ActiveRecordImporter::Importable
+      end
+    end
+
+  end
+end

data/lib/active_record_importer/transition_processor.rb

@@ -0,0 +1,39 @@
+module ActiveRecordImporter
+  class TransitionProcessor
+
+    attr_reader :object, :column, :new_state
+
+    def initialize(object, new_state, column = :state)
+      @object = object
+      @new_state = new_state
+      @column = column
+    end
+
+    def transit
+      fire_event!(transit_event)
+      true
+    end
+
+    private
+
+    def fire_event!(event)
+      fail Errors::InvalidTransition if event.blank?
+      object.send(event)
+    end
+
+    def transit_event
+      state_transitions.each do |trans|
+        return trans.event if trans.from == state_was && trans.to == new_state
+      end
+      nil
+    end
+
+    def state_transitions
+      object.send("#{column}_transitions")
+    end
+
+    def state_was
+      object.send("#{column}_was")
+    end
+  end
+end

data/lib/active_record_importer/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordImporter
+  VERSION = '0.1.0'
+end

data/lib/app/models/import.rb

@@ -0,0 +1,58 @@
+module ActiveRecordImporter
+  class Import < ActiveRecord::Base
+    extend Enumerize
+    store :properties, accessors: %i(insert_method find_options batch_size)
+
+    enumerize :insert_method,
+              in: %w(insert upsert error_duplicate),
+              default: :upsert
+
+    has_attached_file :file
+
+    attr_accessor :execute_on_create
+
+    validates :resource, presence: true
+    validate :check_presence_of_find_options
+    validates_attachment :file,
+                         content_type: {
+                             content_type: %w(text/plain text/csv)
+                         }
+
+    after_create :execute, if: :execute_on_create
+
+    # I'll add import options in the next release
+    # accepts_nested_attributes_for :import_options, allow_destroy: true
+
+    def execute
+      resource_class.import!(self, execute_on_create)
+    end
+
+    def resource_class
+      resource.safe_constantize
+    end
+
+    def batch_size
+      super.to_i
+    end
+
+    ##
+    # Override this if you prefer have
+    # a private permissions or you have
+    # private methods for reading files
+    ##
+    def import_file
+      local_path? ? file.path : file.url
+    end
+
+    private
+
+    def check_presence_of_find_options
+      return if insert_method.insert?
+      errors.add(:find_options, "can't be blank") if find_options.blank?
+    end
+
+    def local_path?
+      File.exist? import_file.file.path
+    end
+  end
+end

data/spec/active_record_importer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ActiveRecordImporter do
+  it 'has a version number' do
+    expect(ActiveRecordImporter::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_record_importer'

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: active_record_importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Nera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: enumerize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "~>"
+      - !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::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: smarter_csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "~>"
+      - !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::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Smart gem for importing rails models
+email:
+- kapitan_03@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_importer.gemspec
+- bin/console
+- bin/setup
+- db/migrate/1_active_record_importer_migration.rb
+- lib/active_record_importer.rb
+- lib/active_record_importer/attributes_builder.rb
+- lib/active_record_importer/batch_importer.rb
+- lib/active_record_importer/data_processor.rb
+- lib/active_record_importer/dispatcher.rb
+- lib/active_record_importer/engine.rb
+- lib/active_record_importer/errors.rb
+- lib/active_record_importer/find_options_builder.rb
+- lib/active_record_importer/helpers.rb
+- lib/active_record_importer/import_callbacker.rb
+- lib/active_record_importer/importable.rb
+- lib/active_record_importer/instance_builder.rb
+- lib/active_record_importer/options_builder.rb
+- lib/active_record_importer/railtie.rb
+- lib/active_record_importer/transition_processor.rb
+- lib/active_record_importer/version.rb
+- lib/app/models/import.rb
+- spec/active_record_importer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/michaelnera/active_record_importer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Active Record Importer
+test_files: []