activerecord-pg-extensions 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c73159dc2062391844fc7309dd066720684b43a7d81c4c19c8bc5acaeacb36d
+  data.tar.gz: bff7754ec2e0a7817b7806f0e37c80ec91675a2e745841d60421da9192438840
+SHA512:
+  metadata.gz: a8ed2044c44c79a5d6f0412ebb95de80e9a43361d22866950605a14c2a59bcf9566a6cd73febe06743d5e4f8c445a76b3c25c9ed7395733ba9159a386e1bbd2b
+  data.tar.gz: 3c2b19dccfa6b809f5e9de4a0c94c5bb26000537175957a2782bf8e94daf7f568dd311c45c36261f843128b53f8f9ff038c59a9141a952104316c7cb5b91f4d2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.1] - 2021-06-07
+
+- Add PostgreSQLAdapter#defer_constraints
+
+## [0.1.0] - 2021-06-02
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Instructure, Inc.
+
+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,34 @@
+# ActiveRecord PG Extensions
+
+This gem includes a number of extensions to Rails' regular PostgreSQLAdapter to enable access to
+more Postgres specific features.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pg-extensions'
+```
+## Usage
+
+See individual classes for available methods.
+
+## Development
+
+You will need Postgres locally to test. As long as `psql` can connect with no arguments, you're fine. Otherwise use environment variables
+as described at https://www.postgresql.org/docs/current/libpq-envars.html to configure it. The database will be created automatically.
+
+`rake` will run both tests and Rubocop.
+
+After checking out the repo, run `bundle install` 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 the created tag, 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/instructure/activerecord-pg-extensions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: postgresql
+  database: arpgextensions

data/lib/active_record/pg_extensions.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "active_record/pg_extensions/version"
+
+require "active_record/pg_extensions/railtie"

data/lib/active_record/pg_extensions/postgresql_adapter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PGExtensions
+    # Contains general additions to the PostgreSQLAdapter
+    module PostgreSQLAdapter
+      # set constraint check timing for the current transaction
+      # see https://www.postgresql.org/docs/current/sql-set-constraints.html
+      def set_constraints(deferred, *constraints)
+        raise ArgumentError, "deferred must be :deferred or :immediate" unless %w[deferred
+                                                                                  immediate].include?(deferred.to_s)
+
+        constraints = constraints.map { |c| quote_table_name(c) }.join(", ")
+        constraints = "ALL" if constraints.empty?
+        execute("SET CONSTRAINTS #{constraints} #{deferred.to_s.upcase}")
+      end
+
+      # defers constraints, yields to the caller, and then resets back to immediate
+      # note that the reset back to immediate is _not_ in an ensure block, since any
+      # error thrown would likely mean the transaction is rolled back, and setting
+      # constraint checking back to immediate would also fail
+      def defer_constraints(*constraints)
+        set_constraints(:deferred, *constraints)
+        yield
+        set_constraints(:immediate, *constraints)
+      end
+    end
+  end
+end

data/lib/active_record/pg_extensions/railtie.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module ActiveRecord
+  module PGExtensions
+    # :nodoc:
+    class Railtie < Rails::Railtie
+      initializer "pg_extensions.extend_ar", after: "active_record.initialize_database" do
+        ActiveSupport.on_load(:active_record) do
+          require "active_record/pg_extensions/postgresql_adapter"
+
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgreSQLAdapter)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/pg_extensions/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PGExtensions
+    VERSION = "0.1.1"
+  end
+end

data/lib/activerecord-pg-extensions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "active_record/pg_extensions"

data/spec/postgresql_adapter_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
+  describe "#set_constraints" do
+    around do |example|
+      connection.dont_execute(&example)
+    end
+
+    it "requires :deferred or :immediate" do
+      expect { connection.set_constraints("garbage") }.to raise_error(ArgumentError)
+    end
+
+    it "defaults to all" do
+      connection.set_constraints(:deferred)
+      expect(connection.executed_statements).to eq ["SET CONSTRAINTS ALL DEFERRED"]
+    end
+
+    it "quotes constraints" do
+      connection.set_constraints(:deferred, :my_fk)
+      expect(connection.executed_statements).to eq ['SET CONSTRAINTS "my_fk" DEFERRED']
+    end
+
+    it "quotes multiple constraints" do
+      connection.set_constraints(:deferred, :my_fk1, :my_fk2)
+      expect(connection.executed_statements).to eq ['SET CONSTRAINTS "my_fk1", "my_fk2" DEFERRED']
+    end
+  end
+
+  describe "#defer_constraints" do
+    around do |example|
+      connection.dont_execute(&example)
+    end
+
+    it "defers and resets" do
+      block_called = false
+      connection.defer_constraints do
+        block_called = true
+      end
+      expect(block_called).to eq true
+      expect(connection.executed_statements).to eq ["SET CONSTRAINTS ALL DEFERRED", "SET CONSTRAINTS ALL IMMEDIATE"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "activerecord-pg-extensions"
+require "byebug"
+require "active_record/railtie"
+
+ActiveRecord::Base # rubocop:disable Lint/Void
+Rails.env = "test"
+
+class Application < Rails::Application
+  config.eager_load = false
+end
+Application.initialize!
+
+ActiveRecord::Tasks::DatabaseTasks.create_all
+
+module StatementCaptureConnection
+  def dont_execute
+    @dont_execute = true
+    yield
+  ensure
+    @dont_execute = false
+  end
+
+  def executed_statements
+    @executed_statements ||= []
+  end
+
+  def execute(statement, *)
+    executed_statements << statement
+    super unless @dont_execute
+  end
+end
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(StatementCaptureConnection)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  config.before do
+    connection.executed_statements.clear
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pg-extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Several extensions to ActiveRecord's PostgreSQLAdapter.
+email:
+- cody@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- config/database.yml
+- lib/active_record/pg_extensions.rb
+- lib/active_record/pg_extensions/postgresql_adapter.rb
+- lib/active_record/pg_extensions/railtie.rb
+- lib/active_record/pg_extensions/version.rb
+- lib/activerecord-pg-extensions.rb
+- spec/postgresql_adapter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/instructure/activerecord-pg-extensions
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/instructure/activerecord-pg-extensions/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Several extensions to ActiveRecord's PostgreSQLAdapter.
+test_files:
+- spec/spec_helper.rb
+- spec/postgresql_adapter_spec.rb
+- config/database.yml