Initial commit

tbuehlmann · tbuehlmann · commit 3a6e0a68df2b · 2018-05-21T01:22:34.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+gemspec
+
+gem 'pry'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    active_record-returning_attributes (0.1.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-returning_attributes!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tobias Bühlmann
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# ActiveRecord::ReturningAttributes
+
+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/active_record/returning_attributes`. 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 'active_record-returning_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record-returning_attributes
+
+## 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/tbuehlmann/active_record-returning_attributes.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
diff --git a/activerecord-returning_attributes.gemspec b/activerecord-returning_attributes.gemspec
@@ -0,0 +1,28 @@
+require_relative 'lib/active_record/returning_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record-returning_attributes'
+  spec.version       = ActiveRecord::ReturningAttributes::VERSION
+  spec.authors       = ['Tobias Bühlmann']
+  spec.email         = ['tobias@xn--bhlmann-n2a.de']
+
+  spec.summary       = 'Summary'
+  spec.description   = 'Description'
+  spec.homepage      = 'https://github.com/tbuehlmann/active_record-returning_attributes'
+  spec.license       = 'MIT'
+
+  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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end
diff --git a/bin/console b/bin/console
@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_record/returning_attributes'
+
+require 'pry'
+Pry.start
diff --git a/bin/setup b/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
diff --git a/lib/active_record/returning_attributes.rb b/lib/active_record/returning_attributes.rb
@@ -0,0 +1,84 @@
+require_relative 'returning_attributes/accessor'
+require_relative 'returning_attributes/version'
+require_relative 'returning_attributes/with_returning'
+
+require 'active_support/lazy_load_hooks'
+
+module ActiveRecord
+  module ReturningAttributes
+    def self.monkey_patch_persistence!
+      Persistence.module_eval do
+        def _create_record(attribute_names = self.attribute_names)
+          attribute_names &= self.class.column_names
+          attributes_values = attributes_with_values_for_create(attribute_names)
+
+          new_id, result = self.class.connection.with_returning(returning) do
+            self.class._insert_record(attributes_values)
+          end
+
+          self.id ||= new_id if self.class.primary_key
+
+          self.class.returning.each do |column|
+            write_attribute(column, result.to_hash.first[column.to_s])
+          end
+
+          @new_record = false
+
+          yield(self) if block_given?
+
+          id
+        end
+      end
+    end
+
+    def self.monkey_patch_database_statements!
+      ConnectionAdapters::DatabaseStatements.module_eval do
+        def insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [])
+          sql, binds = to_sql_and_binds(arel, binds)
+          @_insert_result = exec_insert(sql, name, binds, pk, sequence_name)
+          id_value || last_inserted_id(@_insert_result)
+        end
+      end
+    end
+
+    def self.monkey_patch_postgresql_database_statements!
+      require 'active_record/connection_adapters/postgresql/database_statements'
+
+      ConnectionAdapters::PostgreSQL::DatabaseStatements.module_eval do
+        private
+
+        def sql_for_insert(sql, pk, id_value, sequence_name, binds)
+          if pk.nil?
+            # Extract the table from the insert sql. Yuck.
+            table_ref = extract_table_ref_from_insert_sql(sql)
+            pk = primary_key(table_ref) if table_ref
+          end
+
+          if pk = suppress_composite_primary_key(pk)
+            if @_returning
+              sql = "#{sql} RETURNING #{[pk, @_returning].flatten.map { |column| quote_column_name(column) }.join(', ')}"
+            else
+              raise 'This case shouldn’t happen.'
+            end
+          end
+
+          super
+        end
+      end
+    end
+
+    def self.extend_postgresql_adapter!
+      require 'active_record/connection_adapters/postgresql_adapter'
+      ConnectionAdapters::PostgreSQLAdapter.include(WithReturning)
+    end
+
+    ActiveSupport.on_load(:active_record) do
+      include Accessor
+
+      ReturningAttributes.monkey_patch_persistence!
+      ReturningAttributes.monkey_patch_database_statements!
+      ReturningAttributes.monkey_patch_postgresql_database_statements!
+      ReturningAttributes.extend_postgresql_adapter!
+    end
+  end
+end
diff --git a/lib/active_record/returning_attributes/accessor.rb b/lib/active_record/returning_attributes/accessor.rb
@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module ActiveRecord
+  module ReturningAttributes
+  	module Accessor
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :returning, default: []
+      end
+    end
+  end
+end
diff --git a/lib/active_record/returning_attributes/version.rb b/lib/active_record/returning_attributes/version.rb
@@ -0,0 +1,5 @@
+module ActiveRecord
+  module ReturningAttributes
+    VERSION = '0.1.0'
+  end
+end
diff --git a/lib/active_record/returning_attributes/with_returning.rb b/lib/active_record/returning_attributes/with_returning.rb
@@ -0,0 +1,15 @@
+module ActiveRecord
+  module ReturningAttributes
+  	module WithReturning
+      def with_returning(returning)
+        begin
+          @_returning = returning
+          [yield, @_insert_result]
+        ensure
+          @_returning = nil
+          @_insert_result = nil
+        end
+      end
+    end
+  end
+end
diff --git a/spec/active_record/returning_attributes_spec.rb b/spec/active_record/returning_attributes_spec.rb
@@ -0,0 +1,9 @@
+RSpec.describe ActiveRecord::ReturningAttributes do
+  it 'has a version number' do
+    expect(ActiveRecord::ReturningAttributes::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'active_record/returning_attributes'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+--format documentation`
	`2`	`+--color`
	`3`	`+--require spec_helper`