db_leftovers 1.5.0 → 1.6.0

data/Changelog

@@ -1,3 +1,14 @@
+1.6.0
+-----
+
+- Support foreign keys that are `DEFERRABLE INITIALLY DEFERRED` and
+`DEFERRABLE INITIALLY IMMEDIATE`.
+
+1.5.0
+-----
+
+- Permit custom names for foreign keys.
+
 1.4.2
 -----
 

data/README.md

@@ -79,6 +79,12 @@ Opts is a hash with the following possible keys:
   * `:set_null` Indicates that the foreign key should be set to null if the referenced row is deleted.
   * `:cascade` Indicates that the referencing row should be deleted if the referenced row is deleted.
 
+* `:deferrable` Marks the constraint as deferrable. Accepts these values:
+
+  * `nil` Indicates the constraint is not deferrable (the default).
+  * `:immediate` Indicates the constraint is usually enforced immediately but can be deferred.
+  * `:deferred` Indicates the constraint is always enforced deferred.
+
 #### Examples
 
     foreign_key :books, :author_id, :authors, :id
@@ -89,7 +95,7 @@ With implicit column names:
     foreign_key :books, :authors
     foreign_key :books, :authors, :on_delete => :cascade
     foreign_key :books, :co_author_id, :authors
-    foreign_key :books, :co_author_id, :authors, :on_delete => :cascade
+    foreign_key :books, :co_author_id, :authors, :on_delete => :cascade, :deferred => :immediate
 
 ### check(on\_table, constraint\_name, expression)
 

data/lib/db_leftovers/foreign_key.rb

@@ -1,19 +1,21 @@
 module DBLeftovers
 
   class ForeignKey
-    attr_accessor :constraint_name, :from_table, :from_column, :to_table, :to_column, :set_null, :cascade
+    attr_accessor :constraint_name, :from_table, :from_column, :to_table, :to_column, :set_null, :cascade, :deferrable_initially_immediate, :deferrable_initially_deferred
 
     def initialize(from_table, from_column, to_table, to_column, opts={})
       opts = {
+        :deferrable => nil,
         :on_delete => nil,
         :name => name_constraint(from_table, from_column)
       }.merge(opts)
       opts.keys.each do |k|
         raise "`:set_null => true` should now be `:on_delete => :set_null`" if k.to_s == 'set_null'
         raise "`:cascade => true` should now be `:on_delete => :cascade`"   if k.to_s == 'cascade'
-        raise "Unknown option: #{k}" unless [:on_delete, :name].include?(k)
+        raise "Unknown option: #{k}" unless [:on_delete, :name, :deferrable].include?(k)
       end
       raise "Unknown on_delete option: #{opts[:on_delete]}" unless [nil, :set_null, :cascade].include?(opts[:on_delete])
+      raise "Unknown deferrable option: #{opts[:deferrable]}" unless [nil, :immediate, :deferred].include?(opts[:deferrable])
       @constraint_name = opts[:name].to_s
       @from_table = from_table.to_s
       @from_column = from_column.to_s
@@ -21,9 +23,12 @@ module DBLeftovers
       @to_column = to_column.to_s
 
       @set_null = opts[:on_delete] == :set_null
-      @cascade = opts[:on_delete] == :cascade
+      @cascade  = opts[:on_delete] == :cascade
+      @deferrable_initially_immediate = opts[:deferrable] == :immediate
+      @deferrable_initially_deferred  = opts[:deferrable] == :deferred
 
       raise "ON DELETE can't be both set_null and cascade" if @set_null and @cascade
+      raise "DEFERRABLE can't be both immediate and deferred" if @deferrable_initially_immediate and @deferrable_initially_deferred
     end
 
     def equals(other)
@@ -33,11 +38,24 @@ module DBLeftovers
       other.to_table == to_table and
       other.to_column == to_column and
       other.set_null == set_null and
-      other.cascade == cascade
+      other.cascade == cascade and
+      other.deferrable_initially_immediate == deferrable_initially_immediate and
+      other.deferrable_initially_deferred == deferrable_initially_deferred
     end
 
     def to_s
-      "<#{@constraint_name}: from #{@from_table}.#{@from_column} to #{@to_table}.#{@to_column} #{if @set_null; "ON DELETE SET NULL "; elsif @cascade; "ON DELETE CASCADE "; else ""; end}>"
+      [
+        "<#{@constraint_name}: from #{@from_table}.#{@from_column} to #{@to_table}.#{@to_column}",
+        if @set_null; "ON DELETE SET NULL"
+        elsif @cascade; "ON DELETE CASCADE"
+        else; nil
+        end,
+        if @deferrable_initially_immediate; "DEFERRABLE INITIALLY IMMEDIATE"
+        elsif @deferrable_initially_deferred; "DEFERRABLE INITIALLY DEFERRED"
+        else; nil
+        end,
+        ">"
+      ].compact.join(" ")
     end
 
     def name_constraint(from_table, from_column)

data/lib/db_leftovers/generic_database_interface.rb

@@ -37,13 +37,16 @@ module DBLeftovers
     end
 
     def execute_add_foreign_key(fk)
-      on_delete = "ON DELETE CASCADE" if fk.cascade
+      on_delete = "ON DELETE CASCADE"  if fk.cascade
       on_delete = "ON DELETE SET NULL" if fk.set_null
+      deferrable = "DEFERRABLE INITIALLY DEFERRED"  if fk.deferrable_initially_deferred
+      deferrable = "DEFERRABLE INITIALLY IMMEDIATE" if fk.deferrable_initially_immediate
       execute_sql %{ALTER TABLE #{fk.from_table}
                 ADD CONSTRAINT #{fk.constraint_name}
                 FOREIGN KEY (#{fk.from_column})
                 REFERENCES #{fk.to_table} (#{fk.to_column})
-                #{on_delete}}
+                #{on_delete}
+                #{deferrable}}
     end
 
     def execute_drop_foreign_key(constraint_name, from_table, from_column)

data/lib/db_leftovers/postgres_database_interface.rb

@@ -70,7 +70,9 @@ module DBLeftovers
                   a1.attname AS from_column,
                   t2.relname AS to_table,
                   a2.attname AS to_column,
-                  c.confdeltype
+                  c.confdeltype,
+                  c.condeferrable AS deferrable,
+                  c.condeferred AS deferred
           FROM    pg_catalog.pg_constraint c,
                   pg_catalog.pg_class t1,
                   pg_catalog.pg_class t2,
@@ -94,14 +96,20 @@ module DBLeftovers
           AND     pg_catalog.pg_table_is_visible(t1.oid)
           AND     pg_catalog.pg_table_is_visible(t2.oid)
       EOQ
-      @conn.select_rows(sql).each do |constr_name, from_table, from_column, to_table, to_column, del_type|
+      @conn.select_rows(sql).each do |constr_name, from_table, from_column, to_table, to_column, del_type, deferrable, deferred|
         del_type = case del_type
                    when 'a'; nil
                    when 'c'; :cascade
                    when 'n'; :set_null
                    else; raise "Unknown del type: #{del_type}"
                    end
-        ret[constr_name] = ForeignKey.new(from_table, from_column, to_table, to_column, :name => constr_name, :on_delete => del_type)
+        deferrable = deferrable == 't'
+        deferred   = deferred == 't'
+        defer_type = if deferrable and deferred; :deferred
+                     elsif deferrable; :immediate
+                     else; nil
+                     end
+        ret[constr_name] = ForeignKey.new(from_table, from_column, to_table, to_column, :name => constr_name, :on_delete => del_type, :deferrable => defer_type)
       end
       return ret
     end

data/lib/db_leftovers/version.rb

@@ -1,3 +1,3 @@
 module DbLeftovers
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/spec/db_leftovers_spec.rb

@@ -72,9 +72,9 @@ describe DBLeftovers do
   it "should create foreign keys on an empty database" do
     @db.starts_with
     DBLeftovers::Definition.define :db_interface => @db do
-      foreign_key :books, :shelf_id, :shelves
+      foreign_key :books, :shelf_id, :shelves, :deferrable => :deferred
       foreign_key :books, :publisher_id, :publishers, :id, :on_delete => :set_null
-      foreign_key :books, :author_id, :authors, :id, :on_delete => :cascade
+      foreign_key :books, :author_id, :authors, :id, :on_delete => :cascade, :deferrable => :immediate
     end
     @db.sqls.should have(3).items
     @db.should have_seen_sql <<-EOQ
@@ -82,6 +82,7 @@ describe DBLeftovers do
         ADD CONSTRAINT fk_books_shelf_id
         FOREIGN KEY (shelf_id)
         REFERENCES shelves (id)
+        DEFERRABLE INITIALLY DEFERRED
     EOQ
     @db.should have_seen_sql <<-EOQ
         ALTER TABLE books
@@ -96,6 +97,7 @@ describe DBLeftovers do
         FOREIGN KEY (author_id)
         REFERENCES authors (id)
         ON DELETE CASCADE
+        DEFERRABLE INITIALLY IMMEDIATE
     EOQ
   end
 
@@ -105,9 +107,9 @@ describe DBLeftovers do
     @db.starts_with
     DBLeftovers::Definition.define :db_interface => @db do
       table :books do
-        foreign_key :shelf_id, :shelves
+        foreign_key :shelf_id, :shelves, :deferrable => :deferred
         foreign_key :publisher_id, :publishers, :id, :on_delete => :set_null
-        foreign_key :author_id, :authors, :id, :on_delete => :cascade
+        foreign_key :author_id, :authors, :id, :on_delete => :cascade, :deferrable => :immediate
       end
     end
     @db.sqls.should have(3).items
@@ -116,6 +118,7 @@ describe DBLeftovers do
         ADD CONSTRAINT fk_books_shelf_id
         FOREIGN KEY (shelf_id)
         REFERENCES shelves (id)
+        DEFERRABLE INITIALLY DEFERRED
     EOQ
     @db.should have_seen_sql <<-EOQ
         ALTER TABLE books
@@ -130,6 +133,7 @@ describe DBLeftovers do
         FOREIGN KEY (author_id)
         REFERENCES authors (id)
         ON DELETE CASCADE
+        DEFERRABLE INITIALLY IMMEDIATE
     EOQ
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_leftovers
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -363906017218431327
+      hash: 3317985398985958458
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: