db_leftovers 0.5.0 → 0.5.1

data/README.html

@@ -36,20 +36,19 @@ index :books, :isbn, :unique => true
 <p>This ensures that you have a foreign key relating the given tables and columns.
 All parameters are strings/symbols except <code>opts</code>, which is a hash.
 If you don't pass anything for <code>opts</code>, you can leave off the <code>to_column</code> parameter, and it will default to <code>:id</code>.
-These options are supported:</p>
+The only option that is supported is <code>:on_delete</code>, which may have any of these values:</p>
 
 <ul>
+<li><code>nil</code> Indicates that attempting to delete the referenced row should fail (the default).</li>
 <li><code>:set_null</code> Indicates that the foreign key should be set to null if the referenced row is deleted.</li>
 <li><code>:cascade</code> Indicates that the referencing row should be deleted if the referenced row is deleted.</li>
 </ul>
 
-<p>These options are mutually exclusive. They should probably be consolidated into a single option like <code>:on_delete</code>.</p>
-
 <h4>Examples</h4>
 
 <pre><code>foreign_key :books, :author_id, :authors, :id
 foreign_key :books, :publisher_id, :publishers
-foreign_key :pages, :book_id, :books, :id, :cascade =&gt; true
+foreign_key :pages, :book_id, :books, :id, :on_delete =&gt; :cascade
 </code></pre>
 
 <h3>check(constraint_name, on_table, expression)</h3>

data/README.md

@@ -37,18 +37,17 @@ This ensures that you have an index on the given table and column(s). The `colum
 This ensures that you have a foreign key relating the given tables and columns.
 All parameters are strings/symbols except `opts`, which is a hash.
 If you don't pass anything for `opts`, you can leave off the `to_column` parameter, and it will default to `:id`.
-These options are supported:
+The only option that is supported is `:on_delete`, which may have any of these values:
 
+* `nil` Indicates that attempting to delete the referenced row should fail (the default).
 * `: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.
 
-These options are mutually exclusive. They should probably be consolidated into a single option like `:on_delete`.
-
 #### Examples
 
     foreign_key :books, :author_id, :authors, :id
     foreign_key :books, :publisher_id, :publishers
-    foreign_key :pages, :book_id, :books, :id, :cascade => true
+    foreign_key :pages, :book_id, :books, :id, :on_delete => :cascade
 
 ### check(constraint\_name, on\_table, expression)
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/db_leftovers.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "db_leftovers"
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul A. Jungwirth"]

data/lib/db_leftovers/database_interface.rb

@@ -4,26 +4,6 @@ module DBLeftovers
 
     def lookup_all_indexes
       ret = {}
-=begin
-      sql = <<-EOQ
-          SELECT  n.nspname as "Schema", c.relname as "Name",
-                  CASE c.relkind WHEN 'r' THEN 'table' WHEN 'v' THEN 'view' WHEN 'i' THEN 'index' WHEN 'S' THEN 'sequence' WHEN 's' THEN 'special' END as "Type",
-                  u.usename as "Owner",
-                  c2.relname as "Table"
-          FROM    pg_catalog.pg_class c
-                  JOIN pg_catalog.pg_index i ON i.indexrelid = c.oid
-                  JOIN pg_catalog.pg_class c2 ON i.indrelid = c2.oid
-                  LEFT JOIN pg_catalog.pg_user u ON u.usesysid = c.relowner
-                  LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
-          WHERE   c.relkind IN ('i','')
-          AND     n.nspname NOT IN ('pg_catalog', 'pg_toast')
-          AND     pg_catalog.pg_table_is_visible(c.oid)
-          AND     c.relname NOT LIKE '%_pkey'
-          AND     c2.relname NOT IN ('delayed_jobs', 'schema_migrations')
-          ORDER BY 1,2;
-      EOQ
-      ActiveRecord::Base.connection.select_rows(sql).each do |schema, index_name, object_type, owner, table_name|
-=end
       sql = <<-EOQ
           SELECT  ix.indexrelid,
                   ix.indrelid,
@@ -48,7 +28,7 @@ module DBLeftovers
                     i.relname,
                     ix.indisunique,
                     ix.indexrelid,
-                    ix.indrelid
+                    ix.indrelid,
                     ix.indkey,
                     ix.indpred,
           ORDER BY t.relname, i.relname
@@ -67,20 +47,6 @@ module DBLeftovers
 
 
 
-    def column_names_for_index(table_id, column_numbers)
-      column_numbers.map do |c|
-        sql = <<-EOQ
-            SELECT  attname
-            FROM    pg_attribute
-            WHERE   attrelid = #{table_id}
-            AND     attnum = #{c}
-        EOQ
-        ActiveRecord::Base.connection.select_value(sql)
-      end
-    end
-
-
-
     def lookup_all_foreign_keys
       ret = {}
       sql = <<-EOQ
@@ -165,5 +131,19 @@ module DBLeftovers
 
     private
 
+    def column_names_for_index(table_id, column_numbers)
+      column_numbers.map do |c|
+        sql = <<-EOQ
+            SELECT  attname
+            FROM    pg_attribute
+            WHERE   attrelid = #{table_id}
+            AND     attnum = #{c}
+        EOQ
+        ActiveRecord::Base.connection.select_value(sql)
+      end
+    end
+
+
+
   end
 end

data/lib/db_leftovers/foreign_key.rb

@@ -5,23 +5,35 @@ module DBLeftovers
 
     def initialize(constraint_name, from_table, from_column, to_table, to_column, opts={})
       opts = {
-        :set_null => false,
-        :cascade => false
+        :on_delete => nil
       }.merge(opts)
       opts.keys.each do |k|
-        raise "Unknown option: #{k}" unless [:set_null, :cascade].include?(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].include?(k)
       end
+      raise "Unknown on_delete option: #{opts[:on_delete]}" unless [nil, :set_null, :cascade].include?(opts[:on_delete])
       @constraint_name = constraint_name.to_s
       @from_table = from_table.to_s
       @from_column = from_column.to_s
       @to_table = to_table.to_s
       @to_column = to_column.to_s
 
-      @set_null = opts[:set_null]
-      @cascade = opts[:cascade]
+      @set_null = opts[:on_delete] == :set_null
+      @cascade = opts[:on_delete] == :cascade
 
       raise "ON DELETE can't be both set_null and cascade" if @set_null and @cascade
     end
+
+    def equals(other)
+      other.constraint_name == constraint_name and
+      other.from_table == from_table and
+      other.from_column == from_column and
+      other.to_table == to_table and
+      other.to_column == to_column and
+      other.opts == opts
+    end
+
   end
 
 end

data/spec/db_leftovers_spec.rb

@@ -123,8 +123,8 @@ describe DBLeftovers do
     DBLeftovers::DatabaseInterface.starts_with
     DBLeftovers::Definition.define do
       foreign_key :books, :shelf_id, :shelves
-      foreign_key :books, :publisher_id, :publishers, :id, :set_null => true
-      foreign_key :books, :author_id, :authors, :id, :cascade => true
+      foreign_key :books, :publisher_id, :publishers, :id, :on_delete => :set_null
+      foreign_key :books, :author_id, :authors, :id, :on_delete => :cascade
     end
     DBLeftovers::DatabaseInterface.sqls.should have(3).items
     DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
@@ -156,8 +156,8 @@ describe DBLeftovers do
     DBLeftovers::Definition.define do
       table :books do
         foreign_key :shelf_id, :shelves
-        foreign_key :publisher_id, :publishers, :id, :set_null => true
-        foreign_key :author_id, :authors, :id, :cascade => true
+        foreign_key :publisher_id, :publishers, :id, :on_delete => :set_null
+        foreign_key :author_id, :authors, :id, :on_delete => :cascade
       end
     end
     DBLeftovers::DatabaseInterface.sqls.should have(3).items
@@ -346,6 +346,59 @@ describe DBLeftovers do
 
 
   it "should allow separating indexes and foreign keys from the same table" do
+    DBLeftovers::DatabaseInterface.starts_with
+    DBLeftovers::Definition.define do
+      table :books do
+        index :author_id
+      end
+      table :books do
+        foreign_key :author_id, :authors, :id
+      end
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(2).items
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        CREATE INDEX index_books_on_author_id
+        ON books
+        (author_id)
+    EOQ
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        ALTER TABLE books
+        ADD CONSTRAINT fk_books_author_id
+        FOREIGN KEY (author_id)
+        REFERENCES authors (id)
+    EOQ
+  end
+
+  it "should reject invalid foreign key options" do
+    lambda {
+      DBLeftovers::Definition.define do
+        foreign_key :books, :author_id, :authors, :id, :icky => :boo_boo
+      end
+    }.should raise_error(RuntimeError, "Unknown option: icky")
+  end
+
+  it "should reject invalid foreign key on_delete values" do
+    lambda {
+      DBLeftovers::Definition.define do
+        foreign_key :books, :author_id, :authors, :id, :on_delete => :panic
+      end
+    }.should raise_error(RuntimeError, "Unknown on_delete option: panic")
+  end
+
+  it "should give good a error message if you use the old :set_null option" do
+    lambda {
+      DBLeftovers::Definition.define do
+        foreign_key :books, :author_id, :authors, :id, :set_null => true
+      end
+    }.should raise_error(RuntimeError, "`:set_null => true` should now be `:on_delete => :set_null`")
+  end
+
+  it "should give good a error message if you use the old :cascade option" do
+    lambda {
+      DBLeftovers::Definition.define do
+        foreign_key :books, :author_id, :authors, :id, :cascade => true
+      end
+    }.should raise_error(RuntimeError, "`:cascade => true` should now be `:on_delete => :cascade`")
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_leftovers
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -139,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4584251961758391352
+      hash: 2547372809633410828
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: