active_record-postgres-constraints 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a19e03721ddaa7c12b76748d4fa59fe093e3c6a
+  data.tar.gz: dd98645605fe1088cd41c333f46479487edfb261
+SHA512:
+  metadata.gz: 056b2a22a6b4eac0db4449b041f448b53133c47d0deecab89b70e6036fc3326089f14128f1f091df9760d131056c50eac8e284fcaced43e6a9a1a048dbb79cc0
+  data.tar.gz: 6f4b979cd7ed8f4065381fb854bf15c82af512692a798be132c2d8a6fb656901fc93330897c84b00b26b692ac4a78dc712e88babdc46bee11a9faa9e95f888be

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Isaac Betesh
+
+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,67 @@
+# ActiveRecord::Postgres::Constraints
+
+From http://edgeguides.rubyonrails.org/active_record_migrations.html#types-of-schema-dumps:
+
+> There is however a trade-off: db/schema.rb cannot express database
+specific items such as triggers, stored procedures or check constraints.
+While in a migration you can execute custom SQL statements, the schema
+dumper cannot reconstitute those statements from the database. If you are
+using features like this, then you should set the schema format to :sql.
+
+No longer is this the case.  You can now use the default schema format
+(:ruby) and still preserve your check constraints.
+
+At this time, this only supports check constraints for the postgresql ActiveRecord database adapter.
+
+## Usage
+
+#### Add a check constraint
+Add check constraints to a table in a migration:
+
+```ruby
+create_table :people do |t|
+  t.string :title
+  t.check_constraint title: ['Mr.', 'Mrs.', 'Dr.']
+end
+```
+
+OR
+
+```ruby
+add_check_constraint :people, title: ['Mr.', 'Mrs.', 'Dr.']
+```
+
+#### Remove a check constraint
+
+```ruby
+# If you don't need it to be reversible:
+remove_check_constraint :people
+
+# If you need it to be reversible (Recommended):
+remove_check_constraint :people, title: ['Mr.', 'Mrs.', 'Dr.']
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-postgres-constraints'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Testing
+```bash
+$ (cd spec/dummy && bin/rake db:create RAILS_ENV=test) # One time before running tests
+$ bundle exec rspec # To run tests as often as you'd like
+```
+
+## Contributing
+If you're interested in building support for other database adapters, we welcome your contribution!
+
+## 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,9 @@
+# frozen_string_literal: true
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+task default: :spec

data/lib/active_record/postgres/constraints.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require_relative 'constraints/command_recorder'
+require_relative 'constraints/postgresql_adapter'
+require_relative 'constraints/railtie'
+require_relative 'constraints/schema_creation'
+require_relative 'constraints/schema_dumper'
+require_relative 'constraints/table_definition'
+require_relative 'constraints/version'
+
+module ActiveRecord
+  module Postgres
+    module Constraints
+      class << self
+        def normalize_conditions(conditions)
+          conditions = [conditions] unless conditions.is_a?(Array)
+          conditions = conditions.map do |condition|
+            if condition.is_a?(Hash)
+              normalize_conditions_hash(condition)
+            else
+              condition
+            end
+          end
+
+          return conditions.first if 1 == conditions.length
+          "(#{conditions.join(') AND (')})"
+        end
+
+        def normalize_conditions_hash(hash)
+          hash = hash.reduce([]) do |array, (column, predicate)|
+            predicate = predicate.join("', '") if predicate.is_a?(Array)
+            array << "#{column} IN ('#{predicate}')"
+          end
+          "(#{hash.join(') AND (')})"
+        end
+
+        def to_sql(table, name_or_conditions, conditions = nil)
+          if conditions
+            name = name_or_conditions
+          else
+            name = "#{table}_#{Time.zone.now.nsec}"
+            conditions = name_or_conditions
+          end
+
+          "CONSTRAINT #{name} CHECK (#{normalize_conditions(conditions)})"
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/command_recorder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      module CommandRecorder
+        def add_check_constraint(*args, &block)
+          record(:add_check_constraint, args, &block)
+        end
+
+        def invert_add_check_constraint(args, &block)
+          [:remove_check_constraint, args, block]
+        end
+
+        def remove_check_constraint(*args, &block)
+          if args.length < 3
+            raise ActiveRecord::IrreversibleMigration,
+              'To make this migration reversible, pass the constraint to '\
+              'remove_check_constraint, i.e. `remove_check_constraint, '\
+              "#{args[0].inspect}, #{args[1].inspect}, 'price > 999'`"
+          end
+          record(:remove_check_constraint, args, &block)
+        end
+
+        def invert_remove_check_constraint(args, &block)
+          [:add_check_constraint, args, block]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/postgresql_adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      module PostgreSQLAdapter
+        def add_check_constraint(table, name_or_conditions, conditions = nil)
+          constraint = Constraints.to_sql(table, name_or_conditions, conditions)
+          execute("ALTER TABLE #{table} ADD #{constraint}")
+        end
+
+        def remove_check_constraint(table, name, _conditions = nil)
+          execute("ALTER TABLE #{table} DROP CONSTRAINT #{name}")
+        end
+
+        def constraints(table)
+          sql = "SELECT conname, consrc FROM pg_constraint
+            JOIN pg_class ON pg_constraint.conrelid = pg_class.oid
+            WHERE
+              pg_constraint.contype = 'c'
+              AND
+              pg_class.relname = '#{table}'".tr("\n", ' ').squeeze(' ')
+          execute sql
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/railtie.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      class Railtie < Rails::Railtie
+        initializer 'active_record.postgres.constraints.patch_active_record' do
+          ActiveSupport.on_load(:active_record) do
+            AR_CAS = ::ActiveRecord::ConnectionAdapters
+
+            connection = ActiveRecord::Base.connection
+            using_pg = connection.class.to_s == "#{AR_CAS}::PostgreSQLAdapter"
+            if using_pg
+              Rails.logger.info do
+                'Applying Postgres Constraints patches to ActiveRecord'
+              end
+              AR_CAS::TableDefinition.include TableDefinition
+              AR_CAS::PostgreSQLAdapter.include PostgreSQLAdapter
+              AR_CAS::AbstractAdapter::SchemaCreation.prepend SchemaCreation
+
+              ::ActiveRecord::Migration::CommandRecorder.include CommandRecorder
+              ::ActiveRecord::SchemaDumper.prepend SchemaDumper
+            else
+              Rails.logger.warn do
+                'Not applying Postgres Constraints patches to ActiveRecord ' \
+                  'since the database is not postgres'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/schema_creation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      module SchemaCreation
+        # rubocop:disable Style/MethodName
+        def visit_TableDefinition(o)
+          # rubocop:enable Style/MethodName
+          result = super
+          return result unless o.check_constraints
+          nesting = 0
+          # Find the closing paren of the "CREATE TABLE ( ... )" clause
+          index = result.length.times do |i|
+            token = result[i]
+            nesting, should_break = adjust_nesting(nesting, token)
+            break i if should_break
+          end
+          result[index] = ", #{o.check_constraints.join(', ')})"
+          result
+        end
+
+        def adjust_nesting(nesting, token)
+          nesting_was = nesting
+          nesting += 1 if '(' == token
+          nesting -= 1 if ')' == token
+          [nesting, (1 == nesting_was && nesting.zero?)]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/schema_dumper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      module SchemaDumper
+        def indexes_in_create(table, stream)
+          super
+          constraints = @connection.constraints(table)
+          return unless constraints.any?
+          constraint_statements = constraints.map do |constraint|
+            name = constraint['conname']
+            conditions = constraint['consrc']
+            "    t.check_constraint :#{name}, #{conditions.inspect}"
+          end
+          stream.puts constraint_statements.sort.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/table_definition.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      module TableDefinition
+        attr_reader :check_constraints
+
+        def check_constraint(name_or_conditions, conditions = nil)
+          @check_constraints ||= []
+          constraint = Constraints.to_sql(name, name_or_conditions, conditions)
+          check_constraints << constraint
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres/constraints/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module Postgres
+    module Constraints
+      VERSION = '0.1.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: active_record-postgres-constraints
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Isaac Betesh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    From http://edgeguides.rubyonrails.org/active_record_migrations.html#types-of-schema-dumps:\n\n
+  \     There is however a trade-off: db/schema.rb cannot express database\n      specific
+  items such as triggers, stored procedures or check constraints.\n      While in
+  a migration you can execute custom SQL statements, the schema\n      dumper cannot
+  reconstitute those statements from the database. If you are\n      using features
+  like this, then you should set the schema format to :sql.\n\n    No longer is this
+  the case.  You can now use the default schema format\n    (:ruby) and still preserve
+  your check constraints.\n  "
+email:
+- ibetesh@on-site.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_record/postgres/constraints.rb
+- lib/active_record/postgres/constraints/command_recorder.rb
+- lib/active_record/postgres/constraints/postgresql_adapter.rb
+- lib/active_record/postgres/constraints/railtie.rb
+- lib/active_record/postgres/constraints/schema_creation.rb
+- lib/active_record/postgres/constraints/schema_dumper.rb
+- lib/active_record/postgres/constraints/table_definition.rb
+- lib/active_record/postgres/constraints/version.rb
+homepage: https://github.com/on-site/active_record-postgres-constraints
+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.10
+signing_key: 
+specification_version: 4
+summary: Store your constraints in db/schema.rb
+test_files: []