careful-import 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 830a8aae59544ebd1a22cfde29b89da7b3c64a439e062a257c2902a6f5249d46
+  data.tar.gz: bb72d20146dad6f836f954e2b0619aececaa85e74291a8cce6e168d60288111e
+SHA512:
+  metadata.gz: 98ceebebff4ec7aaff3e64dc394b7621561d930ec508c2d63e1b7dc8e902f8abfc2360977d73deb2dded09e00ce1d43e03d0ce03f65c3ac71b73dbb7f8dbc1e3
+  data.tar.gz: '02742850059c308dd9d94f48d8ab2354e4e704f841042ea3eab275a372838136b676f28514c4e726f02a21e17210a47ca807ede761296d73c64e6d23109ea825'

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in careful-import.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+# Support
+gem "factory_bot", "~> 4.11"
+gem "pry-byebug", "~> 3.3"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    careful-import (0.1.0)
+      activerecord-import (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord-import (0.20.2)
+      activerecord (>= 3.2)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  careful-import!
+  factory_bot (~> 4.11)
+  pry-byebug (~> 3.3)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Clive Ivins
+
+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,40 @@
+# Careful::Import
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/careful/import`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'careful-import'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install careful-import
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/careful-import.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "careful_import"
+
+# 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(__FILE__)

data/bin/setup

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

data/careful-import.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/careful_import/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "careful-import"
+  spec.version       = CarefulImport::Version::VERSION
+  spec.authors       = ["Clive Ivins"]
+  spec.email         = ["civins@itglue.com"]
+
+  spec.summary       = %q{Validates and updates args prior to ActiveRecord::Import import}
+  spec.description   = %q{If a primary_key value is passed in when importing an error is raised}
+  spec.homepage      = "https://bitbucket.org/itglue/careful-import/src/master/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.2.8")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'activerecord-import', '~> 0'
+end

data/lib/careful_import.rb

@@ -0,0 +1,2 @@
+require 'careful_import/railtie' if defined? ::Rails::Railtie
+require 'careful_import/importer'

data/lib/careful_import/importer.rb

@@ -0,0 +1,77 @@
+require "careful_import/version"
+
+module CarefulImport
+  class Importer
+    class ImportArgumentError < ArgumentError; end
+
+    INVALID_ARGUMENT_MESSAGE = "Record cannot contain a primary key value as this will not use our Postgres 53-bit "\
+    "generated id upon insertion.Supply instead an array of hashes without primary keys or an array of ActiveRecord "\
+    "objects with nil primary keys."
+
+    def initialize(resource_class)
+      @resource_class = resource_class
+      @primary_key = resource_class.primary_key
+    end
+
+    # https://github.com/zdennis/activerecord-import/blob/v0.20.2/lib/activerecord-import/import.rb#L174
+    # Potential Args:
+    #  Model.import array_of_models
+    #  Model.import column_names, array_of_models
+    #  Model.import array_of_hash_objects
+    #  Model.import column_names, array_of_hash_objects
+    #  Model.import column_names, array_of_values
+    #  Model.import column_names, array_of_values, options
+
+    def import(*args)
+      options = args.extract_options!
+      validated_args = build_validated_args(*args)
+
+      @resource_class.__private_import_helper__(*validated_args, options)
+    end
+
+    private
+
+    def raise_usage_error(arg)
+      raise ImportArgumentError.new("#{INVALID_ARGUMENT_MESSAGE} Invalid argument: #{arg.inspect}")
+    end
+
+    def build_validated_args(*args)
+      return args if args.first.is_a?(Array) && args.first.empty?
+
+      if args.first.is_a?(Array) && (args.first.first.is_a?(ActiveRecord::Base) || args.first.first.is_a?(Hash))
+        records = validate_and_remove_primary_key(args.first)
+        [records]
+      elsif args.first.is_a?(Array) && args.second.is_a?(Array)
+        # the first arg will be a list of column names and the second arg will be the values. Check for column name 'id'
+        check_columns_for_primary_key(args.first)
+        args
+      else
+        # if the above conditions aren't met then the args are not correct so we will raise an error here.
+        raise ImportArgumentError.new("Invalid arguments!")
+      end
+    end
+
+    def validate_and_remove_primary_key(records)
+      return records if records.empty?
+
+      records.map do |record|
+        if record.is_a?(ActiveRecord::Base)
+          # if the record id is nil it is a new record and we will instead convert this record to a hash without id key
+          raise_usage_error(record) unless record.public_send(@primary_key).nil?
+
+          record.attributes.except(@primary_key)
+        elsif record.is_a?(Hash)
+          raise_usage_error(record) if record[@primary_key].present?
+
+          record.except(@primary_key)
+        else
+          raise ImportArgumentError.new("Invalid argument: #{record}")
+        end
+      end
+    end
+
+    def check_columns_for_primary_key(columns)
+      raise_usage_error(columns) if columns.include?(@primary_key.to_sym) || columns.include?(@primary_key)
+    end
+  end
+end

data/lib/careful_import/initializer.rb

@@ -0,0 +1,29 @@
+module CarefulImport
+  module Initializer
+    module_function
+
+    # This wraps the activerecord-import gem's import_helper method so that we can validate the args passed to
+    # it to ensure no id keys are being used. This will ensure that we are using the generated 53-bit id
+    # instead of nextval.
+    def initialize
+      ActiveRecord::Base.class_eval do
+        class << self
+          unless ActiveRecord::Base.respond_to?(:__private_import_helper__)
+            # `activerecord-import` opens up ActiveRecord::Base and adds the import methods to it directly
+            # so we have to add the alias_method to it directly as well.
+            # We don't want the original `import_helper` to be called without having its args validated
+            # so we rename the original method which allows us to call it after validating.
+            alias_method :__private_import_helper__, :import_helper
+          end
+
+          # Under the hood import_helper is what is called by import and import! and it is a public method
+          # so you could directly call Configuration.import_helper(records, {}) and it would basically do what
+          # import does. So instead of overriding each of the methods we are overriding the one that they all use.
+          def import_helper(*args)
+            ::CarefulImport::Importer.new(self).import(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/careful_import/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+require_relative 'careful_import/initializer'
+
+module CarefulImport
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      # initialize our custom activerecord-import validator to ensure only 53-bit id's are used and not nextval
+      CarefulImport::Initializer.initialize
+    end
+  end
+end

data/lib/careful_import/version.rb

@@ -0,0 +1,5 @@
+module CarefulImport
+  module Version
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: careful-import
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clive Ivins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-30 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: If a primary_key value is passed in when importing an error is raised
+email:
+- civins@itglue.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- careful-import.gemspec
+- lib/careful_import.rb
+- lib/careful_import/importer.rb
+- lib/careful_import/initializer.rb
+- lib/careful_import/railtie.rb
+- lib/careful_import/version.rb
+homepage: https://bitbucket.org/itglue/careful-import/src/master/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/itglue/careful-import/src/master/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Validates and updates args prior to ActiveRecord::Import import
+test_files: []