postgresql-check 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6eb60da5a7a04b6f3ba274a4e32de726bc1a675
+  data.tar.gz: 6fb2dcf1dff2148952e0bbbbefb8d1d26887675d
+SHA512:
+  metadata.gz: 02e9e39c308790b9452afd8d362f00a5e31249587e408919cdcdce8f77dbf2798c507d866a9e482bc2aa082796f683bc24d11a142f2abc8c286168ce93621cf0
+  data.tar.gz: 8dd9938fe756ee6d7e4f76485014c4aa664af60da3f55c9127a72198a3b471be5ac52367d463beb37d3847620294907f83c511717708961d88b10cff69793507

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in postgresql-check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexei Mikhailov
+
+MIT License
+
+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,90 @@
+# Postgresql::Check
+
+[![Code Climate](https://codeclimate.com/github/take-five/postgresql-check/badges/gpa.svg)](https://codeclimate.com/github/take-five/postgresql-check)
+
+This gem introduces a few methods to your migrations for adding and removing
+[Check Constraints](http://www.postgresql.org/docs/9.3/static/ddl-constraints.html).
+It also dumps these constraints to `schema.rb`.
+
+## Requirements
+
+* PostgreSQL
+* active_record >= 3.2.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postgresql-check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postgresql-check
+
+## Usage
+
+Two new methods are introduced to migrations:
+
+* `add_check(table_name, condition, :name => constraint_name)`
+* `remove_check(table_name, :name => constraint_name)`
+
+Given the following model:
+
+```ruby
+class Product < ActiveRecord::Base
+  validates :price, :numericality => {:greater_than => 0}
+end
+```
+
+You can add a check constraint in your migration:
+
+```ruby
+add_check :products, 'price > 0', :name => 'products_price_check'
+```
+
+**NOTE**: `:name` option is mandatory now.
+
+To remove constraint use `remove_check` method:
+
+```ruby
+remove_check :products, :name => 'products_price_check'
+```
+
+## Change Table methods
+
+This gem adds extra methods to `create_table` and `change_table`:
+
+```ruby
+create_table :products do |t|
+  t.decimal :price, :null => false
+  t.check 'price > 0', :name => 'products_price_check'
+end
+```
+
+Remove a check constraint:
+
+```ruby
+change_table :products do |t|
+  t.remove_check :name => 'products_price_check'
+end
+```
+
+## Future plans
+
+* Write tests
+* Auto-generate constraint name
+* Make `remove_check` reversible
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/postgresql-check/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/postgresql/check/command_recorder.rb

@@ -0,0 +1,19 @@
+module Postgresql
+  module Check
+    module CommandRecorder
+      def add_check(*args)
+        record(:add_check, args)
+      end
+
+      def remove_check(*args)
+        record(:remove_check, args)
+      end
+
+      def invert_add_check(args)
+        table_name, condition, options = args
+
+        [:remove_check, [table_name, options]]
+      end
+    end
+  end
+end

data/lib/postgresql/check/constraint.rb

@@ -0,0 +1,6 @@
+module Postgresql
+  module Check
+    class Constraint < Struct.new(:table_name, :name, :condition)
+    end
+  end
+end

data/lib/postgresql/check/schema_definitions.rb

@@ -0,0 +1,15 @@
+module Postgresql
+  module Check
+    module SchemaDefinitions
+      def self.included(base)
+        base::Table.class_eval do
+          include Postgresql::Check::Table
+        end
+
+        base::TableDefinition.class_eval do
+          include Postgresql::Check::TableDefinition
+        end
+      end
+    end
+  end
+end

data/lib/postgresql/check/schema_dumper.rb

@@ -0,0 +1,34 @@
+module Postgresql
+  module Check
+    module SchemaDumper
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :table, :checks
+      end
+
+      def table_with_checks(table, stream)
+        table_without_checks(table, stream)
+        check_constraints(table, stream)
+      end
+
+      private
+      def check_constraints(table, stream)
+        if (checks = @connection.checks(table)).any?
+          definitions = checks.map do |check|
+            dump_check_constraint(check)
+          end
+
+          stream.puts
+          stream.puts definitions.join("\n")
+          stream.puts
+        end
+      end
+
+      def dump_check_constraint(check)
+        '  add_check ' + remove_prefix_and_suffix(check.table_name).inspect + ', '+
+            check.condition.inspect + ', name: ' + check.name.inspect
+      end
+    end
+  end
+end

data/lib/postgresql/check/schema_statements.rb

@@ -0,0 +1,87 @@
+module Postgresql
+  module Check
+    module SchemaStatements
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :create_table, :checks
+      end
+
+      # Add a new Check constraint to table with given +table_name+
+      # using given +conditions+. Constraint name should be specified
+      # by +:name+ options in +options+ argument.
+      #
+      # @example
+      #   add_check :products, 'price > 0', :name => 'products_price_chk'
+      #
+      #   # Generates:
+      #   # ALTER TABLE products ADD CONSTRAINT products_price_chk CHECK (price > 0)
+      #
+      # @note +:name+ option is mandatory.
+      #
+      # @param [String|Symbol] table_name Table name which constraint created on
+      # @param [String] condition Raw SQL string specifying constraint condition
+      # @param [Hash] options Hash with single mandatory key +:name+
+      # @option options [String|Symbol] :name Constraint name
+      def add_check(table_name, condition, options)
+        name = options.fetch(:name) { raise 'add_check, :name option required' }
+
+        sql = "ALTER TABLE #{quote_table_name(table_name)} " +
+            "ADD CONSTRAINT #{quote_column_name("#{table_name}_#{name}")} " +
+            "CHECK (#{condition})"
+
+        execute(sql)
+      end
+
+      # Remove constraint with given name from table. Constraint name
+      # is specified with +options+ hash.
+      #
+      # @example
+      #   remove_check :products, :name => 'products_price_chk'
+      #
+      #   # Generates:
+      #   # ALTER TABLE products DROP CONSTRAINT products_price_chk
+      #
+      # @param [String|Symbol] table_name Table name which constraint defined on
+      # @param [Hash] options Hash with single mandatory key +:name+
+      # @option options [String|Symbol] :name Constraint name
+      def remove_check(table_name, options)
+        name = options.fetch(:name) { raise 'remove_check, :name option required' }
+
+        sql = "ALTER TABLE #{quote_table_name(table_name)} " +
+            "DROP CONSTRAINT #{quote_column_name("#{table_name}_#{name}")}"
+
+        execute(sql)
+      end
+
+      # @api private
+      def create_table_with_checks(table_name, *args, &block)
+        definition = nil
+
+        create_table_without_checks(table_name, *args) do |td|
+          definition = td # trick to get the definition
+          block.call(td) unless block.nil?
+        end
+
+        definition.checks.each do |condition, options|
+          add_check(table_name, condition, options)
+        end
+      end
+
+      # @api private
+      def checks(table_name)
+        checks_info = select_all %{
+          SELECT c.conname, c.consrc
+          FROM pg_constraint c
+          JOIN pg_class t ON c.conrelid = t.oid
+          WHERE c.contype = 'c'
+            AND t.relname = '#{table_name}'
+        }
+
+        checks_info.map do |row|
+          Constraint.new(table_name, row['conname'], row['consrc'])
+        end
+      end
+    end
+  end
+end

data/lib/postgresql/check/table.rb

@@ -0,0 +1,13 @@
+module Postgresql
+  module Check
+    module Table
+      def check(condition, options)
+        @base.add_check(@table_name, condition, options)
+      end
+
+      def remove_check(options)
+        @base.remove_check(@table_name, options)
+      end
+    end
+  end
+end

data/lib/postgresql/check/table_definition.rb

@@ -0,0 +1,20 @@
+module Postgresql
+  module Check
+    module TableDefinition
+      # Add new check constraint to table
+      #
+      # Example:
+      #   create_table :goods do |t|
+      #     t.float :price
+      #     t.check 'price > 0', :name => 'price_gt_0'
+      #   end
+      def check(condition, options)
+        checks << [condition, options]
+      end
+
+      def checks
+        @checks ||= []
+      end
+    end
+  end
+end

data/lib/postgresql/check/version.rb

@@ -0,0 +1,5 @@
+module Postgresql
+  module Check
+    VERSION = '0.0.1'
+  end
+end

data/lib/postgresql/check.rb

@@ -0,0 +1,42 @@
+require 'postgresql/check/version'
+require 'active_support/dependencies/autoload'
+require 'active_support/lazy_load_hooks'
+
+module Postgresql
+  module Check
+    extend ActiveSupport::Autoload
+
+    autoload :Constraint
+    autoload :CommandRecorder
+    autoload :SchemaStatements
+    autoload :SchemaDefinitions
+    autoload :SchemaDumper
+    autoload :Table
+    autoload :TableDefinition
+
+    def self.setup
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
+        include Postgresql::Check::SchemaStatements
+        include Postgresql::Check::SchemaDefinitions
+      end
+
+      ActiveRecord::SchemaDumper.class_eval do
+        include Postgresql::Check::SchemaDumper
+      end
+
+      ActiveRecord::Migration::CommandRecorder.class_eval do
+        include Postgresql::Check::CommandRecorder
+      end
+    end
+
+    if defined?(Rails)
+      class Railtie < Rails::Railtie
+        initializer 'postgresql_check.setup' do
+          ActiveSupport.on_load :active_record do
+            Postgresql::Check.setup
+          end
+        end
+      end
+    end
+  end
+end

data/postgresql-check.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postgresql/check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postgresql-check'
+  spec.version       = Postgresql::Check::VERSION
+  spec.authors       = ['Alexei Mikhailov']
+  spec.email         = ['amikhailov83@gmail.com']
+  spec.summary       = %q{Adds helpers to migrations and dumps check constraints to schema.rb}
+  spec.homepage      = 'https://github.com/take-five/postgresql-check'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 3.2.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: postgresql-check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexei Mikhailov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+description: 
+email:
+- amikhailov83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/postgresql/check.rb
+- lib/postgresql/check/command_recorder.rb
+- lib/postgresql/check/constraint.rb
+- lib/postgresql/check/schema_definitions.rb
+- lib/postgresql/check/schema_dumper.rb
+- lib/postgresql/check/schema_statements.rb
+- lib/postgresql/check/table.rb
+- lib/postgresql/check/table_definition.rb
+- lib/postgresql/check/version.rb
+- postgresql-check.gemspec
+homepage: https://github.com/take-five/postgresql-check
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Adds helpers to migrations and dumps check constraints to schema.rb
+test_files: []
+has_rdoc: