rein 0.3.0 → 0.4.0

data/README.md

@@ -1,21 +1,67 @@
 # Rein
 
-Database constraints made easy for ActiveRecord.
+Database constraints made easy for ActiveRecord. Rein currently supports PostgreSQL and MySQL (foreign keys only).
 
 
 ## Introduction
 
-Rein adds bunch of methods to your ActiveRecord migrations so you can easily tame your database.
+[Database integrity](http://en.wikipedia.org/wiki/Database_integrity) is a "good thing". Constraining the allowed values in your database at the database-level (rather than solely at the application-level) is a much more robust way of ensuring your data stays sane.
 
-ActiveRecord doesn't make it easy for you to weild the power of your database.
+Unfortunately, ActiveRecord doesn't encourage (or even allow) you to use database integrity without resorting to hand-crafted SQL. Rein adds a handful of methods to your ActiveRecord migrations so that you can easily tame your database.
 
 
 ## Quick Start
 
-First, install the gem:
+Install the gem:
 
     gem install rein
 
-Then slap some constraints in your migrations. For example:
+Add a foreign key constraint:
+
+    add_foreign_key_constraint :books, :authors
+
+Add a numericality constraint (PostgreSQL only):
 
     add_numericality_constraint :books, :publication_month, :greater_than_or_equal_to => 1, :less_than_or_equal_to => 12
+
+Add an inclusion constraint (PostgreSQL only):
+
+    add_inclusion_constraint :books, :state, :in => %w(available on_loan)
+
+
+## Example
+
+Let's look at constraining values for this simple library application.
+
+Here we have a table of authors:
+
+    create_table :authors do |t|
+      t.string :name, :null => false
+
+      t.timestamps
+    end
+
+And here we have a table of books:
+
+    create_table :books do |t|
+      t.belongs_to :author,          :null => false
+      t.string     :name,            :null => false
+      t.string     :state,           :null => false
+      t.integer    :published_year,  :null => false
+      t.integer    :published_month, :null => false
+
+      t.timestamps
+    end
+
+    # A book should always belong to an author.
+    # The database should prevent us from deleteing an author who has books.
+    add_foreign_key_constraint :books, :authors, :on_delete => :restrict
+
+    # Our library doesn't deal in classics.
+    add_numericality_constraint :books, :published_year, :greater_than => 1980
+
+    # Month is always between 1 and 12.
+    add_numericality_constraint :books, :published_month, :greater_than_or_equal_to => 1, :less_than_or_equal_to => 12
+
+    # State is always either "available" or "on_loan".
+    add_inclusion_constraint :books, :state, :in => %w(available on_loan)

data/lib/rein/constraint/inclusion.rb

@@ -1,10 +1,13 @@
+require 'active_record/connection_adapters/abstract/quoting'
+
 module RC
   module Inclusion
+    include ActiveRecord::ConnectionAdapters::Quoting
+
     def add_inclusion_constraint(table, attribute, options = {})
       name       = "#{table}_#{attribute}"
-      values     = options[:in].map {|x| "'#{x}'" }.join(", ")
+      values     = options[:in].map {|value| quote(value) }.join(", ")
       conditions = "#{attribute} IN (#{values})"
-
       execute("ALTER TABLE #{table} ADD CONSTRAINT #{name} CHECK (#{conditions})")
     end
   end

data/lib/rein/constraint/numericality.rb

@@ -3,7 +3,7 @@ module RC
     OPERATORS = {
       :greater_than             => :>,
       :greater_than_or_equal_to => :>=,
-      :equal_to                 => :==,
+      :equal_to                 => :"=",
       :less_than                => :<,
       :less_than_or_equal_to    => :<=
     }.freeze

data/lib/rein/version.rb

@@ -1,3 +1,3 @@
 module Rein
-  VERSION = "0.3.0" unless defined?(Rein::VERSION)
+  VERSION = "0.4.0" unless defined?(Rein::VERSION)
 end

data/lib/rein.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/hash'
-
 module Rein
   module Constraint
   end
@@ -7,16 +5,21 @@ end
 
 RC = Rein::Constraint
 
+require 'active_record'
+require 'active_support/core_ext/hash'
+
 require 'rein/constraint/foreign_key'
 require 'rein/constraint/inclusion'
 require 'rein/constraint/numericality'
-require 'rein/version'
 
-if defined?(ActiveRecord)
-  module ActiveRecord::ConnectionAdapters
-    class PostgreSQLAdapter < AbstractAdapter
-      include RC::ForeignKey
-      include RC::Numericality
-    end
+module ActiveRecord::ConnectionAdapters
+  class MysqlAdapter < AbstractAdapter
+    include RC::ForeignKey
+  end
+
+  class PostgreSQLAdapter < AbstractAdapter
+    include RC::ForeignKey
+    include RC::Inclusion
+    include RC::Numericality
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Josh Bassett
@@ -14,22 +14,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-28 00:00:00 +10:00
+date: 2010-08-29 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: activerecord
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 3
-        - 0
         - 0
-        - rc
-        version: 3.0.0.rc
+        version: "0"
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -169,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1515412698680743757
+      hash: 1339191596134317982
       segments: 
       - 0
       version: "0"