activerecord_mass_insert 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b955518970b523bd4db4c1a1ff0f456bbbd2215d
+  data.tar.gz: d190a9b6825700bf95fced9b9b55bd372b63eabd
+SHA512:
+  metadata.gz: 7cb4a29703ad023518508d7a0b6f7db0811a2d49fc6ad4bb9c99f0f05d2fbda163b2210785b7a610f181903e179782974c7a9a72ae768dced4b9e3e08698b0de
+  data.tar.gz: aa6e97573a3635b817082f80ec13e225c7df46c42704dddbbeb120aec2b6bc0e7fabc9fd61a8eef4f93e2e8807f8f4ed176aa6a232687669bd17c54a3765149d

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*.DS_Store
+
+Gemfile.lock
+/gemfiles/*.gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/Appraisals

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+appraise 'activerecord-4.2' do
+  gem 'pg', '~> 0.20.0'
+  gem 'activerecord', '~> 4.2.0', require: 'active_record'
+end
+
+appraise 'activerecord-5.0' do
+  gem 'pg', '~> 0.21'
+  gem 'activerecord', '~> 5.0.0', require: 'active_record'
+end
+
+appraise 'activerecord-5.1' do
+  gem 'pg', '~> 0.21'
+  gem 'activerecord', '~> 5.1.0', require: 'active_record'
+end
+
+appraise 'activerecord-5.2' do
+  gem 'pg'
+  gem 'activerecord', '~> 5.2.0', require: 'active_record'
+end

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord_mass_insert.gemspec
+gemspec
+gem 'activerecord', require: 'active_record'
+gem 'pg'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrew Rove
+
+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,52 @@
+## Installation
+
+Requires Postgresql 9.5+
+
+ActiveRecord >= 4.2 supported and tested.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_mass_insert'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activerecord_mass_insert
+
+## Usage
+```ruby
+payload = '[{"name":"Madison","breed":"Golden","meta":{"rescue":false,"age":null}},{"name":"Daisy","meta":{"rescue":true,"age":18}},{"name":"Gracey","meta":{"rescue":false,"nickname":"Scoogie","age":11}},{"name":"Sadie","meta":{"rescue":true,"dingo_blood":true,"age":11}},{"name":"Raymond","meta":{"rescue":null,"nickname":"Radar","tail":false,"age":11}},{"name":"Nemo","meta":{"rescue":true,"number_of_ears":1,"age":2}}]'
+
+dog_ids = Dog.mass_insert(payload, :name, created_at: 'NOW()', updated_at: 'NOW()')
+
+dogs = Dog.find(dog_ids)
+
+puts dogs.count # => 6
+puts dogs.first.name # => Madison
+```
+
+For a payload you can pass a JSON objects by itself, in a JSON array, or a ruby array. You can also
+pass a ruby object that responds to to_json by itself or in an array. JSON will never be parsed to ruby.
+This done to ensure no time is wasted parsing json twice.
+
+## Development
+
+Requires Postgresql 9.5+
+
+After checking out the repo, run `gem install bundle`, then `bundle install`, and run `bin/setup` to install dependencies. Then, run `bundle exec appraisal rspec` to run the tests, this includes the lints. 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/rovermicrover/activerecord_mass_insert.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/activerecord_mass_insert.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/mass_insert/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'activerecord_mass_insert'
+  spec.version     = ActiveRecord::MassInsert::VERSION.join('.')
+  spec.date        = '2019-05-01'
+  spec.summary     = 'Mass Insert For ActiveRecord'
+  spec.description = 'Mass Insert For ActiveRecord via Postgresql json_to_recordset'
+  spec.authors     = ['Andrew Rove']
+  spec.email       = 'andrew.m.rove@gmail.com'
+  spec.homepage    = 'https://rubygemspec.org/gems/activerecord_mass_insert'
+  spec.license     = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|gemfiles)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.2.0'
+  spec.add_runtime_dependency 'pg', '>= 0.20.0'
+
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.69'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'brakeman', '~> 4.5'
+end

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+load 'spec/spec_helper.rb'
+require 'activerecord/mass_insert'
+
+# 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 exec appraisal install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord/mass_insert/helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module MassInsert
+    # Helper for adding mass_insert to ActiveRecord::Base
+    module Helper
+      def mass_insert(payload, *matching_columns, **mapped_columns)
+        Inserter.insert(
+          self, payload, *matching_columns, **mapped_columns
+        ).to_a.map { |result| result['id'] }
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend(ActiveRecord::MassInsert::Helper)

data/lib/activerecord/mass_insert/inserter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module ActiveRecord
+  module MassInsert
+    # Handles the building of the mass insert statement
+    class Inserter < Statement
+      extend Forwardable
+
+      def_delegators :model, :primary_key, :arel_table, :connection
+
+      def self.insert(*args)
+        new(*args).insert
+      end
+
+      def insert
+        connection.execute(sql)
+      end
+
+      def sql
+        [
+          model.send(:sanitize_sql_array, [statement.to_sql, payload]),
+          'RETURNING',
+          primary_key
+        ].join(' ')
+      end
+
+      def statement
+        Arel::Nodes::InsertStatement.new.tap do |new_statement|
+          new_statement.relation = arel_table
+          new_statement.values = projection.statement
+          new_statement.columns = columns
+        end
+      end
+
+      def columns
+        matching_columns.concat(mapped_columns.keys).map do |column|
+          arel_table[column]
+        end
+      end
+
+      def projection
+        Projection.new(model, payload, *matching_columns, **mapped_columns)
+      end
+    end
+  end
+end

data/lib/activerecord/mass_insert/projection.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'securerandom'
+
+module ActiveRecord
+  module MassInsert
+    # Handles the building of the select statement that projects the JSON array
+    class Projection < Statement
+      extend Forwardable
+
+      def_delegators :model, :column_for_attribute
+
+      def statement
+        init_args = []
+        init_args << arel_table.engine if arel_table.respond_to?(:engine)
+
+        Arel::SelectManager.new(*init_args).tap do |select_manager|
+          select_manager.project(select)
+          select_manager.from(table)
+        end
+      end
+
+      def select
+        [
+          *matching_columns.map { |column| arel_table[column] },
+          *select_mapped_columns
+        ]
+      end
+
+      def select_mapped_columns
+        mapped_columns.map do |column, mapping|
+          mapping = mapping.call(arel_table, column) if mapping.is_a?(Proc)
+          case mapping
+          when Arel::Nodes::Node
+            mapping
+          else
+            Arel::Nodes::SqlLiteral.new(mapping.to_s)
+          end
+        end
+      end
+
+      def column_sql_definitions
+        matching_columns.map do |column|
+          column_for_attribute(column)
+        end.map do |column_objects|
+          [column_objects.name, column_objects.sql_type].join(' ')
+        end
+      end
+
+      def table_name
+        @table_name ||= ['json_projection', SecureRandom.hex].join('_')
+      end
+
+      def arel_table
+        @arel_table ||= Arel::Table.new(table_name)
+      end
+
+      def table
+        Arel::Nodes::NamedFunction.new(
+          'json_to_recordset', [Arel::Nodes::SqlLiteral.new('?')]
+        ).as(
+          [table_name, '(', column_sql_definitions.join(', '), ')'].join
+        )
+      end
+    end
+  end
+end

data/lib/activerecord/mass_insert/statement.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module MassInsert
+    # Common structure for all SQL statement builders
+    class Statement
+      attr_reader :model, :payload, :matching_columns, :mapped_columns
+
+      def initialize(model, payload, *matching_columns, **mapped_columns)
+        @model = model
+        @payload = payload_to_json_array(payload)
+        @matching_columns = matching_columns
+        @mapped_columns = mapped_columns
+      end
+
+      private
+
+      def payload_to_json_array(new_payload)
+        if new_payload.is_a?(Array) && new_payload.all? { |p| p.is_a?(String) }
+          # If payload is an array of strings, assume its an array
+          # of json objects. contact them togther to form the
+          # inner part of a json array.
+          new_payload = new_payload.join(',')
+        elsif !new_payload.is_a?(String)
+          # Otherwise transform to JSON
+          new_payload = new_payload.to_json
+        end
+        # If payload is not a json array wrap it in brackets to make it so.
+        new_payload.start_with?('[') ? new_payload : "[#{new_payload}]"
+      end
+    end
+  end
+end

data/lib/activerecord/mass_insert/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module MassInsert
+    VERSION = [0, 0, 1].freeze
+  end
+end

data/lib/activerecord/mass_insert.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'activerecord/mass_insert/version'
+require 'activerecord/mass_insert/statement'
+require 'activerecord/mass_insert/inserter'
+require 'activerecord/mass_insert/projection'
+require 'activerecord/mass_insert/helper'

data/lib/activerecord_mass_insert.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'activerecord/mass_insert'

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_mass_insert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Rove
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+description: Mass Insert For ActiveRecord via Postgresql json_to_recordset
+email: andrew.m.rove@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- activerecord_mass_insert.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/mass_insert.rb
+- lib/activerecord/mass_insert/helper.rb
+- lib/activerecord/mass_insert/inserter.rb
+- lib/activerecord/mass_insert/projection.rb
+- lib/activerecord/mass_insert/statement.rb
+- lib/activerecord/mass_insert/version.rb
+- lib/activerecord_mass_insert.rb
+homepage: https://rubygemspec.org/gems/activerecord_mass_insert
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Mass Insert For ActiveRecord
+test_files: []