db_leftovers 1.4.2 → 1.5.0

data/README.md

@@ -5,7 +5,7 @@ Db\_leftovers lets you define indexes, foreign keys, and CHECK constraints for y
 in one place using an easy-to-read DSL,
 then run a rake task to bring your database up-to-date.
 Whenever you edit the DSL, you can re-run the rake task and db\_leftovers will alter your database accordingly.
-This is useful because of the following limitations in vanilla Rails:
+This is useful because of the following limitations in vanilla Rails (note that very recently Rails has started to add some of these, e.g. `add_foreign_key`):
 
   * There are no built-in migration methods to create foreign keys or CHECK constraints.
   * Even if created, foreign keys and CHECK constraints won't appear in your schema.rb.
@@ -69,11 +69,15 @@ 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 omit the column names, db\_leftovers will infer them based on Rails conventions. (See examples below.)
-The only option that is supported is `:on_delete`, which may have any of these values:
+Opts is a hash with the following possible keys:
 
-* `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.
+* `:name` The name of the foreign key. Defaults to `fk_`*from\_table*`_`*from\_column*`.
+
+* `:on_delete` Sets the behavior when a row is deleted and other rows reference it. It 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.
 
 #### Examples
 

data/lib/db_leftovers/dsl.rb

@@ -68,7 +68,7 @@ module DBLeftovers
         to_column = :id
       end
 
-      add_foreign_key(ForeignKey.new(name_constraint(from_table, from_column), from_table, from_column, to_table, to_column, opts))
+      add_foreign_key(ForeignKey.new(from_table, from_column, to_table, to_column, opts))
     end
 
     def check(table_name, constraint_name, check_expression)
@@ -237,10 +237,6 @@ module DBLeftovers
       end
     end
 
-    def name_constraint(from_table, from_column)
-      "fk_#{from_table}_#{from_column}"
-    end
-
     def get_database_interface
       db = ActiveRecord::Base.configurations[Rails.env]['adapter']
       case db

data/lib/db_leftovers/foreign_key.rb

@@ -3,17 +3,18 @@ module DBLeftovers
   class ForeignKey
     attr_accessor :constraint_name, :from_table, :from_column, :to_table, :to_column, :set_null, :cascade
 
-    def initialize(constraint_name, from_table, from_column, to_table, to_column, opts={})
+    def initialize(from_table, from_column, to_table, to_column, opts={})
       opts = {
-        :on_delete => 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].include?(k)
+        raise "Unknown option: #{k}" unless [:on_delete, :name].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
+      @constraint_name = opts[:name].to_s
       @from_table = from_table.to_s
       @from_column = from_column.to_s
       @to_table = to_table.to_s
@@ -39,6 +40,10 @@ module DBLeftovers
       "<#{@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}>"
     end
 
+    def name_constraint(from_table, from_column)
+      "fk_#{from_table}_#{from_column}"
+    end
+
   end
 
 end

data/lib/db_leftovers/mysql_database_interface.rb

@@ -57,7 +57,7 @@ module DBLeftovers
                    when 'SET NULL'; :set_null
                    else; raise "Unknown del type: #{del_type}"
                    end
-        ret[constr_name] = ForeignKey.new(constr_name, from_table, from_column, to_table, to_column, :on_delete => del_type)
+        ret[constr_name] = ForeignKey.new(from_table, from_column, to_table, to_column, :name => constr_name, :on_delete => del_type)
       end
       return ret
     end

data/lib/db_leftovers/postgres_database_interface.rb

@@ -101,7 +101,7 @@ module DBLeftovers
                    when 'n'; :set_null
                    else; raise "Unknown del type: #{del_type}"
                    end
-        ret[constr_name] = ForeignKey.new(constr_name, from_table, from_column, to_table, to_column, :on_delete => del_type)
+        ret[constr_name] = ForeignKey.new(from_table, from_column, to_table, to_column, :name => constr_name, :on_delete => del_type)
       end
       return ret
     end

data/lib/db_leftovers/version.rb

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

data/spec/db_leftovers_spec.rb

@@ -222,7 +222,7 @@ describe DBLeftovers do
 
   it "should not create foreign keys when they already exist" do
     @db.starts_with([], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id')
     ])
     DBLeftovers::Definition.define :db_interface => @db do
       foreign_key :books, :shelf_id, :shelves
@@ -234,7 +234,7 @@ describe DBLeftovers do
 
   it "should not create table-prefixed foreign keys when they already exist" do
     @db.starts_with([], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id')
     ])
     DBLeftovers::Definition.define :db_interface => @db do
       table :books do
@@ -264,8 +264,8 @@ describe DBLeftovers do
 
   it "should drop foreign keys when they are removed from the definition" do
     @db.starts_with([], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id'),
-      DBLeftovers::ForeignKey.new('fk_books_author_id', 'books', 'author_id', 'authors', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id'),
+      DBLeftovers::ForeignKey.new('books', 'author_id', 'authors', 'id')
     ])
     DBLeftovers::Definition.define :db_interface => @db do
       foreign_key :books, :shelf_id, :shelves
@@ -280,8 +280,8 @@ describe DBLeftovers do
 
   it "should create foreign keys when they have been redefined" do
     @db.starts_with([], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id'),
-      DBLeftovers::ForeignKey.new('fk_books_author_id', 'books', 'author_id', 'authors', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id'),
+      DBLeftovers::ForeignKey.new('books', 'author_id', 'authors', 'id')
     ])
     DBLeftovers::Definition.define :db_interface => @db do
       table :books do
@@ -463,8 +463,8 @@ describe DBLeftovers do
     @db.starts_with([
       DBLeftovers::Index.new(:books, :shelf_id),
     ], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id'),
-      DBLeftovers::ForeignKey.new('fk_books_author_id', 'books', 'author_id', 'authors', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id'),
+      DBLeftovers::ForeignKey.new('books', 'author_id', 'authors', 'id')
     ], [
       DBLeftovers::Constraint.new(:books_have_positive_pages, :books, 'pages_count > 0')
     ])
@@ -479,8 +479,8 @@ describe DBLeftovers do
       DBLeftovers::Index.new(:books, :shelf_id),
       DBLeftovers::Index.new(:authors, :last_name),
     ], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id'),
-      DBLeftovers::ForeignKey.new('fk_books_author_id', 'books', 'author_id', 'authors', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id'),
+      DBLeftovers::ForeignKey.new('books', 'author_id', 'authors', 'id')
     ], [
       DBLeftovers::Constraint.new(:books_have_positive_pages, :books, 'pages_count > 0')
     ])

data/spec/support/shared_db_tests.rb

@@ -117,8 +117,8 @@ shared_examples_for "DatabaseInterface" do
 
   it "should drop foreign keys when they are removed from the definition" do
     starts_with(@db, [], [
-      DBLeftovers::ForeignKey.new('fk_books_shelf_id', 'books', 'shelf_id', 'shelves', 'id'),
-      DBLeftovers::ForeignKey.new('fk_books_author_id', 'books', 'author_id', 'authors', 'id')
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id'),
+      DBLeftovers::ForeignKey.new('books', 'author_id', 'authors', 'id')
     ])
     DBLeftovers::Definition.define :db_interface => @db do
       foreign_key :books, :shelf_id, :shelves
@@ -148,5 +148,28 @@ shared_examples_for "DatabaseInterface" do
     @db.lookup_all_indexes.size.should == 0
   end
 
+  
+  it "should create foreign keys with a custom name" do
+    DBLeftovers::Definition.define :db_interface => @db do
+      foreign_key :books, :shelf_id, :shelves, :name => "fk_where_it_is"
+      foreign_key :books, :publisher_id, :publishers, :id, :on_delete => :set_null, :name => "fk_who_published_it"
+      foreign_key :books, :author_id, :authors, :id, :on_delete => :cascade, :name => "fk_who_wrote_it"
+    end
+    @db.lookup_all_foreign_keys.size.should == 3
+    @db.lookup_all_foreign_keys.keys.sort.should == ['fk_where_it_is', 'fk_who_published_it', 'fk_who_wrote_it']
+  end
+
+
+  it "should drop foreign keys when they are removed from the definition" do
+    starts_with(@db, [], [
+      DBLeftovers::ForeignKey.new('books', 'shelf_id', 'shelves', 'id', :name => "fk_where_it_is"),
+      DBLeftovers::ForeignKey.new('books', 'author_id', 'authors', 'id', :name => "fk_who_wrote_it")
+    ])
+    DBLeftovers::Definition.define :db_interface => @db do
+      foreign_key :books, :shelf_id, :shelves, :name => "fk_where_it_is"
+    end
+    @db.lookup_all_foreign_keys.size.should == 1
+  end
+
 
 end

metadata

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