sexy_pg_constraints 0.1.2

data/test/sexy_pg_constraints_test.rb

@@ -0,0 +1,572 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+# Database spc_test should be created manually.
+ActiveRecord::Base.establish_connection(:adapter => "postgresql", :database => "spc_test")
+
+# Setting up sample migrations
+class CreateBooks < ActiveRecord::Migration
+  def self.up
+    create_table :books do |t|
+      t.string  :title
+      t.string  :author
+      t.integer :author_id
+      t.integer :quantity
+      t.string  :isbn
+    end
+  end
+  
+  def self.down
+    drop_table :books
+  end
+end
+
+class CreateAuthors < ActiveRecord::Migration
+  def self.up
+    create_table :authors do |t|
+      t.string :name
+      t.string :bio
+    end
+  end
+  
+  def self.down
+    drop_table :authors
+  end
+end
+
+class Book < ActiveRecord::Base; end
+class Author < ActiveRecord::Base; end
+
+class SexyPgConstraintsTest < Test::Unit::TestCase
+  def setup
+    CreateBooks.up
+    CreateAuthors.up
+  end
+  
+  def teardown
+    CreateBooks.down
+    CreateAuthors.down
+  end
+  
+  def test_should_create_book
+    Book.create
+    assert_equal 1, Book.count
+  end
+  
+  def test_whitelist
+    ActiveRecord::Migration.constrain :books, :author, :whitelist => %w(whitelisted1 whitelisted2 whitelisted3)
+    
+    assert_prohibits :author, :whitelist do |book|
+      book.author = 'not_whitelisted'
+    end
+    
+    assert_allows do |book|
+      book.author = 'whitelisted2'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :author, :whitelist
+    
+    assert_allows do |book|
+      book.author = 'not_whitelisted'
+    end
+  end
+  
+  def test_blacklist
+    ActiveRecord::Migration.constrain :books, :author, :blacklist => %w(blacklisted1 blacklisted2 blacklisted3)
+    
+    assert_prohibits :author, :blacklist do |book|
+      book.author = 'blacklisted2'
+    end
+    
+    assert_allows do |book|
+      book.author = 'not_blacklisted'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :author, :blacklist
+    
+    assert_allows do |book|
+      book.author = 'blacklisted2'
+    end
+  end
+  
+  def test_not_blank
+    ActiveRecord::Migration.constrain :books, :author, :not_blank => true
+    
+    assert_prohibits :author, :not_blank do |book|
+      book.author = ' '
+    end
+    
+    assert_allows do |book|
+      book.author = 'foo'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :author, :not_blank
+    
+    assert_allows do |book|
+      book.author = ' '
+    end
+  end
+  
+  def test_within_inclusive
+    ActiveRecord::Migration.constrain :books, :quantity, :within => 5..11
+    
+    assert_prohibits :quantity, :within do |book|
+      book.quantity = 12
+    end
+    
+    assert_prohibits :quantity, :within do |book|
+      book.quantity = 4
+    end
+    
+    assert_allows do |book|
+      book.quantity = 7
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :quantity, :within
+    
+    assert_allows do |book|
+      book.quantity = 12
+    end
+  end
+  
+  def test_within_non_inclusive
+    ActiveRecord::Migration.constrain :books, :quantity, :within => 5...11
+    
+    assert_prohibits :quantity, :within do |book|
+      book.quantity = 11
+    end
+    
+    assert_prohibits :quantity, :within do |book|
+      book.quantity = 4
+    end
+    
+    assert_allows do |book|
+      book.quantity = 10
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :quantity, :within
+    
+    assert_allows do |book|
+      book.quantity = 11
+    end
+  end
+  
+  def test_length_within_inclusive
+    ActiveRecord::Migration.constrain :books, :title, :length_within => 5..11
+    
+    assert_prohibits :title, :length_within do |book|
+      book.title = 'abcdefghijkl'
+    end
+    
+    assert_prohibits :title, :length_within do |book|
+      book.title = 'abcd'
+    end
+    
+    assert_allows do |book|
+      book.title = 'abcdefg'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :title, :length_within
+    
+    assert_allows do |book|
+      book.title = 'abcdefghijkl'
+    end
+  end
+  
+  def test_length_within_non_inclusive
+    ActiveRecord::Migration.constrain :books, :title, :length_within => 5...11
+    
+    assert_prohibits :title, :length_within do |book|
+      book.title = 'abcdefghijk'
+    end
+    
+    assert_prohibits :title, :length_within do |book|
+      book.title = 'abcd'
+    end
+    
+    assert_allows do |book|
+      book.title = 'abcdefg'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :title, :length_within
+    
+    assert_allows do |book|
+      book.title = 'abcdefghijk'
+    end
+  end
+  
+  def test_email
+    ActiveRecord::Migration.constrain :books, :author, :email => true
+    
+    assert_prohibits :author, :email do |book|
+      book.author = 'blah@example'
+    end
+    
+    assert_allows do |book|
+      book.author = 'blah@example.com'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :author, :email
+    
+    assert_allows do |book|
+      book.author = 'blah@example'
+    end
+  end 
+  
+  def test_alphanumeric
+    ActiveRecord::Migration.constrain :books, :title, :alphanumeric => true
+    
+    assert_prohibits :title, :alphanumeric do |book|
+      book.title = 'asdf@asdf'
+    end
+    
+    assert_allows do |book|
+      book.title = 'asdf'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :title, :alphanumeric
+    
+    assert_allows do |book|
+      book.title = 'asdf@asdf'
+    end
+  end
+  
+  def test_positive
+    ActiveRecord::Migration.constrain :books, :quantity, :positive => true
+    
+    assert_prohibits :quantity, :positive do |book|
+      book.quantity = -1
+    end
+    
+    assert_allows do |book|
+      book.quantity = 0
+    end
+    
+    assert_allows do |book|
+      book.quantity = 1
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :quantity, :positive
+    
+    assert_allows do |book|
+      book.quantity = -1
+    end
+  end
+  
+  def test_odd
+    ActiveRecord::Migration.constrain :books, :quantity, :odd => true
+    
+    assert_prohibits :quantity, :odd do |book|
+      book.quantity = 2
+    end
+    
+    assert_allows do |book|
+      book.quantity = 1
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :quantity, :odd
+    
+    assert_allows do |book|
+      book.quantity = 2
+    end
+  end
+  
+  def test_even
+    ActiveRecord::Migration.constrain :books, :quantity, :even => true
+    
+    assert_prohibits :quantity, :even do |book|
+      book.quantity = 1
+    end
+    
+    assert_allows do |book|
+      book.quantity = 2
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :quantity, :even
+    
+    assert_allows do |book|
+      book.quantity = 1
+    end
+  end
+  
+  def test_unique
+    ActiveRecord::Migration.constrain :books, :isbn, :unique => true
+    
+    assert_allows do |book|
+      book.isbn = 'foo'
+    end
+    
+    assert_prohibits :isbn, :unique, 'unique' do |book|
+      book.isbn = 'foo'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :isbn, :unique
+    
+    assert_allows do |book|
+      book.isbn = 'foo'
+    end
+  end
+  
+  def test_exact_length
+    ActiveRecord::Migration.constrain :books, :isbn, :exact_length => 5
+    
+    assert_prohibits :isbn, :exact_length do |book|
+      book.isbn = '123456'
+    end
+    
+    assert_prohibits :isbn, :exact_length do |book|
+      book.isbn = '1234'
+    end
+    
+    assert_allows do |book|
+      book.isbn = '12345'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :isbn, :exact_length
+    
+    assert_allows do |book|
+      book.isbn = '123456'
+    end
+  end
+  
+  def test_format_case_insensitive
+    ActiveRecord::Migration.constrain :books, :title, :format => /^[a-z]+$/i
+    
+    assert_prohibits :title, :format do |book|
+      book.title = 'abc3'
+    end
+    
+    assert_prohibits :title, :format do |book|
+      book.title = ''
+    end
+    
+    assert_allows do |book|
+      book.title = 'abc'
+    end
+    
+    assert_allows do |book|
+      book.title = 'ABc'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :title, :format
+    
+    assert_allows do |book|
+      book.title = 'abc3'
+    end
+  end
+  
+  def test_format_case_sensitive
+    ActiveRecord::Migration.constrain :books, :title, :format => /^[a-z]+$/
+    
+    assert_prohibits :title, :format do |book|
+      book.title = 'aBc'
+    end
+    
+    assert_allows do |book|
+      book.title = 'abc'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :title, :format
+    
+    assert_allows do |book|
+      book.title = 'aBc'
+    end
+  end
+  
+  def test_reference
+    ActiveRecord::Migration.constrain :books, :author_id, :reference => {:authors => :id}
+    
+    assert_prohibits :author_id, :reference, 'foreign key' do |book|
+      book.author_id = 1
+    end
+    
+    author = Author.new
+    author.name = "Mark Twain"
+    author.bio = "American writer"
+    assert author.save
+    
+    assert_equal 1, author.id
+    
+    assert_allows do |book|
+      book.author_id = 1
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, :author_id, :reference
+    
+    assert_allows do |book|
+      book.author_id = 2
+    end
+  end
+  
+  def test_reference_with_on_delete
+    ActiveRecord::Migration.constrain :books, :author_id, :reference => {:authors => :id, :on_delete => :cascade}
+    
+    author = Author.new
+    author.name = "Mark Twain"
+    author.bio = "American writer"
+    assert author.save
+    
+    assert_equal 1, Author.count
+    
+    assert_allows do |book|
+      book.title = "The Adventures of Tom Sawyer"
+      book.author_id = 1
+    end
+    
+    assert_allows do |book|
+      book.title = "The Adventures of Huckleberry Finn"
+      book.author_id = 1
+    end
+    
+    author.destroy
+    
+    assert_equal 0, Author.count
+    assert_equal 0, Book.count
+  end
+  
+  def test_block_syntax
+    ActiveRecord::Migration.constrain :books do |t|
+      t.title :not_blank => true
+      t.isbn :exact_length => 15
+      t.author :alphanumeric => true
+    end
+    
+    assert_prohibits :title, :not_blank do |book|
+      book.title = '  '
+    end
+    
+    assert_prohibits :isbn, :exact_length do |book|
+      book.isbn = 'asdf'
+    end
+    
+    assert_prohibits :author, :alphanumeric do |book|
+      book.author = 'foo#bar'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books do |t|
+      t.title :not_blank
+      t.isbn :exact_length
+      t.author :alphanumeric
+    end
+    
+    assert_allows do |book|
+      book.title  = '  '
+      book.isbn   = 'asdf'
+      book.author = 'foo#bar'
+    end
+  end
+  
+  def test_multiple_constraints_per_line
+    ActiveRecord::Migration.constrain :books do |t|
+      t.title :not_blank => true, :alphanumeric => true, :blacklist => %w(foo bar)
+    end
+    
+    assert_prohibits :title, :not_blank do |book|
+      book.title = ' '
+    end
+    
+    assert_prohibits :title, :alphanumeric do |book|
+      book.title = 'asdf@asdf'
+    end
+    
+    assert_prohibits :title, :blacklist do |book|
+      book.title = 'foo'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books do |t|
+      t.title :not_blank, :alphanumeric, :blacklist
+    end
+    
+    assert_allows do |book|
+      book.title = ' '
+    end
+    
+    assert_allows do |book|
+      book.title = 'asdf@asdf'
+    end
+    
+    assert_allows do |book|
+      book.title = 'foo'
+    end
+  end
+  
+  def test_multicolumn_constraint
+    ActiveRecord::Migration.constrain :books, [:title, :isbn], :unique => true
+    
+    assert_allows do |book|
+      book.title = 'foo'
+      book.isbn = 'bar'
+    end
+    
+    assert_allows do |book|
+      book.title = 'foo'
+      book.isbn = 'foo'
+    end
+    
+    assert_prohibits [:title, :isbn], :unique, 'unique' do |book|
+      book.title = 'foo'
+      book.isbn = 'bar'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books, [:title, :isbn], :unique
+    
+    assert_allows do |book|
+      book.title = 'foo'
+      book.isbn = 'bar'
+    end
+  end
+  
+  def test_multicolumn_constraint_block_syntax
+    ActiveRecord::Migration.constrain :books do |t|
+      t[:title, :isbn].all :unique => true
+    end
+    
+    assert_allows do |book|
+      book.title = 'foo'
+      book.isbn = 'bar'
+    end
+    
+    assert_allows do |book|
+      book.title = 'foo'
+      book.isbn = 'foo'
+    end
+    
+    assert_prohibits [:title, :isbn], :unique, 'unique' do |book|
+      book.title = 'foo'
+      book.isbn = 'bar'
+    end
+    
+    ActiveRecord::Migration.deconstrain :books do |t|
+      t[:title, :isbn].all :unique
+    end
+    
+    assert_allows do |book|
+      book.title = 'foo'
+      book.isbn = 'bar'
+    end
+  end
+  
+  private
+  def assert_prohibits(column, constraint, constraint_type = 'check')
+    column = column.join('_') if column.respond_to?(:join)
+    
+    book = Book.new
+    yield(book)
+    assert book.valid?
+    error = assert_raise ActiveRecord::StatementInvalid do 
+      book.save 
+    end
+    assert_match /PGError/, error.message
+    assert_match /violates #{constraint_type} constraint "books_#{column}_#{constraint}"/, error.message
+  end
+  
+  def assert_allows
+    first_count = Book.count
+    book = Book.new
+    yield(book)
+    assert book.valid?
+    assert_nothing_raised do 
+      book.save
+    end
+    assert_equal first_count + 1, Book.count
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'postgresql_adapter'
+require "sexy_pg_constraints"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: sexy_pg_constraints
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Maxim Chernyak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-04 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Use migrations and simple syntax to manage constraints in PostgreSQL DB.
+email: max@bitsonnet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.rdoc
+- lib/constrainer.rb
+- lib/constraints.rb
+- lib/deconstrainer.rb
+- lib/helpers.rb
+- lib/sexy_pg_constraints.rb
+files: 
+- CHANGELOG.rdoc
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/constrainer.rb
+- lib/constraints.rb
+- lib/deconstrainer.rb
+- lib/helpers.rb
+- lib/sexy_pg_constraints.rb
+- sexy_pg_constraints.gemspec
+- test/postgresql_adapter.rb
+- test/sexy_pg_constraints_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/maxim/sexy_pg_constraints
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sexy_pg_constraints
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: sexy_pg_constraints
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: If you're on PostgreSQL and see the importance of data-layer constraints - this gem/plugin is for you. It integrates constraints into PostgreSQL adapter so you can add/remove them in your migrations. You get two simple methods for adding/removing constraints, as well as a pack of pre-made constraints.
+test_files: 
+- test/sexy_pg_constraints_test.rb
+- test/test_helper.rb