db_leftovers 0.8.0 → 0.9.1

data/README.html

@@ -31,11 +31,11 @@ index :books, [:publisher_id, :published_at]
 index :books, :isbn, :unique => true
 </code></pre>
 
-<h3>foreign_key(from_table, from_column, to_table, [to_column, [opts]])</h3>
+<h3>foreign_key(from_table, [from_column], to_table, [to_column], [opts])</h3>
 
 <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>.
+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 <code>:on_delete</code>, which may have any of these values:</p>
 
 <ul>
@@ -47,10 +47,17 @@ The only option that is supported is <code>:on_delete</code>, which may have any
 <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, :on_delete =&gt; :cascade
 </code></pre>
 
+<p>With implicit column names:</p>
+
+<pre><code>foreign_key :books, :authors
+foreign_key :books, :authors, :on_delete =&gt; :cascade
+foreign_key :books, :co_author_id, :authors
+foreign_key :books, :co_author_id, :authors, :on_delete =&gt; :cascade
+</code></pre>
+
 <h3>check(constraint_name, on_table, expression)</h3>
 
 <p>This ensures that you have a CHECK constraint on the given table with the given name and expression.
@@ -63,7 +70,7 @@ All parameters are strings or symbols.</p>
 
 <h3>table(table_name, &amp;block)</h3>
 
-<p>The <code>table</code> call is just a convenience so you can group all a table's indexes and foreign keys together and not keep repeating the table name. You use it like this:</p>
+<p>The <code>table</code> call is just a convenience so you can group all a table's indexes etcetera together and not keep repeating the table name. You use it like this:</p>
 
 <pre><code>table :books do
   index :author_id

data/README.md

@@ -32,11 +32,11 @@ This ensures that you have an index on the given table and column(s). The `colum
     index :books, [:publisher_id, :published_at]
     index :books, :isbn, :unique => true
 
-### foreign\_key(from\_table, from\_column, to\_table, [to\_column, [opts]])
+### foreign\_key(from\_table, [from\_column], to\_table, [to\_column], [opts])
 
 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`.
+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:
 
 * `nil` Indicates that attempting to delete the referenced row should fail (the default).
@@ -46,9 +46,15 @@ The only option that is supported is `:on_delete`, which may have any of these v
 #### Examples
 
     foreign_key :books, :author_id, :authors, :id
-    foreign_key :books, :publisher_id, :publishers
     foreign_key :pages, :book_id, :books, :id, :on_delete => :cascade
 
+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
+
 ### check(constraint\_name, on\_table, expression)
 
 This ensures that you have a CHECK constraint on the given table with the given name and expression.
@@ -60,7 +66,7 @@ All parameters are strings or symbols.
 
 ### table(table\_name, &block)
 
-The `table` call is just a convenience so you can group all a table's indexes and foreign keys together and not keep repeating the table name. You use it like this:
+The `table` call is just a convenience so you can group all a table's indexes etcetera together and not keep repeating the table name. You use it like this:
 
     table :books do
       index :author_id

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.1

data/db_leftovers.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "db_leftovers"
-  s.version = "0.8.0"
+  s.version = "0.9.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

@@ -101,7 +101,8 @@ module DBLeftovers
       ret = {}
       sql = <<-EOQ
           SELECT  c.conname,
-                  t.relname
+                  t.relname,
+                  pg_get_expr(c.conbin, c.conrelid)
           FROM    pg_catalog.pg_constraint c,
                   pg_catalog.pg_class t,
                   pg_catalog.pg_namespace n
@@ -182,7 +183,7 @@ module DBLeftovers
     end
 
     def remove_outer_parens(str)
-      str.gsub(/^\((.*)\)$/, '\1')
+      str ? str.gsub(/^\((.*)\)$/, '\1') : nil
     end
 
 

data/lib/db_leftovers/dsl.rb

@@ -38,7 +38,30 @@ module DBLeftovers
       add_index(Index.new(table_name, column_names, opts))
     end
 
-    def foreign_key(from_table, from_column, to_table, to_column='id', opts={})
+    # foreign_key(from_table, [from_column], to_table, [to_column], [opts]):
+    #   foreign_key(:books, :publishers)                   -> foreign_key(:books, nil, :publishers, nil)
+    #   foreign_key(:books, :co_author_id, :authors)       -> foreign_key(:books, :co_author_id, :authors, nil)
+    #   foreign_key(:books, :publishers, opts)             -> foreign_key(:books, nil, :publishers, nil, opts)
+    #   foreign_key(:books, :co_author_id, :authors, opts) -> foreign_key(:books, :co_author_id, :authors, nil, opts)
+    def foreign_key(from_table, from_column=nil, to_table=nil, to_column=nil, opts={})
+      # First get the options hash into the right place:
+      if to_column.class == Hash
+        opts = to_column
+        to_column = nil
+      elsif to_table.class == Hash
+        opts = to_table
+        to_table = to_column = nil
+      end
+
+      # Sort out implicit arguments:
+      if from_column and not to_table and not to_column
+        to_table = from_column
+        from_column = "#{to_table.to_s.singularize}_id"
+        to_column = :id
+      elsif from_column and to_table and not to_column
+        to_column = :id
+      end
+
       add_foreign_key(ForeignKey.new(name_constraint(from_table, from_column), from_table, from_column, to_table, to_column, opts))
     end
 
@@ -57,10 +80,22 @@ module DBLeftovers
           when STATUS_CHANGED
             @db.execute_drop_index(idx.table_name, idx.index_name)
             @db.execute_add_index(idx)
-            puts "Dropped & re-created index: #{idx.index_name} on #{idx.table_name}"
+            if idx.where_clause
+              # NB: This is O(n*m) where n is your indexes and m is your indexes with WHERE clauses.
+              #     But it's hard to believe it matters:
+              new_idx = @db.lookup_all_indexes[truncate_index_name(idx.index_name)]
+              puts "Dropped & re-created index: #{idx.index_name} on #{idx.table_name} WHERE #{new_idx.where_clause}"
+            else
+              puts "Dropped & re-created index: #{idx.index_name} on #{idx.table_name}"
+            end
           when STATUS_NEW
             @db.execute_add_index(idx)
-            puts "Created index: #{idx.index_name} on #{idx.table_name}"
+            if idx.where_clause
+              new_idx = @db.lookup_all_indexes[truncate_index_name(idx.index_name)]
+              puts "Created index: #{idx.index_name} on #{idx.table_name} WHERE #{new_idx.where_clause}"
+            else
+              puts "Created index: #{idx.index_name} on #{idx.table_name}"
+            end
           end
           @new_indexes[truncate_index_name(idx.index_name)] = table_name
         end
@@ -114,10 +149,14 @@ module DBLeftovers
           when STATUS_CHANGED
             @db.execute_drop_constraint(chk.constraint_name, chk.on_table)
             @db.execute_add_constraint(chk)
-            puts "Dropped & re-created CHECK constraint: #{chk.constraint_name} on #{chk.on_table} as #{chk.check}"
+            # NB: This is O(n^2) where n is your check constraints.
+            #     But it's hard to believe it matters:
+            new_chk = @db.lookup_all_constraints[chk.constraint_name]
+            puts "Dropped & re-created CHECK constraint: #{chk.constraint_name} on #{chk.on_table} as #{new_chk.check}"
           when STATUS_NEW
             @db.execute_add_constraint(chk)
-            puts "Created CHECK constraint: #{chk.constraint_name} on #{chk.on_table}"
+            new_chk = @db.lookup_all_constraints[chk.constraint_name]
+            puts "Created CHECK constraint: #{chk.constraint_name} on #{chk.on_table} as #{new_chk.check}"
           end
           @new_constraints[chk.constraint_name] = chk
         end

data/lib/db_leftovers/table_dsl.rb

@@ -14,7 +14,7 @@ module DBLeftovers
       @dsl.index(@table_name, column_names, opts)
     end
 
-    def foreign_key(from_column, to_table, to_column='id', opts={})
+    def foreign_key(from_column=nil, to_table=nil, to_column=nil, opts={})
       @dsl.foreign_key(@table_name, from_column, to_table, to_column, opts)
     end
 

data/spec/db_leftovers_spec.rb

@@ -187,7 +187,43 @@ describe DBLeftovers do
     EOQ
   end
 
+  it "should create foreign keys with optional params inferred" do
+    DBLeftovers::DatabaseInterface.starts_with
+    DBLeftovers::Definition.define do
+      foreign_key :books, :shelves
+      foreign_key :books, :publishers, :on_delete => :set_null
+      foreign_key :books, :publication_country_id, :countries
+      foreign_key :books, :co_author_id, :authors, :on_delete => :cascade
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(4).items
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        ALTER TABLE books ADD CONSTRAINT fk_books_shelf_id FOREIGN KEY (shelf_id) REFERENCES shelves (id)
+    EOQ
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        ALTER TABLE books ADD CONSTRAINT fk_books_publisher_id FOREIGN KEY (publisher_id) REFERENCES publishers (id) ON DELETE SET NULL
+    EOQ
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        ALTER TABLE books ADD CONSTRAINT fk_books_publication_country_id
+            FOREIGN KEY (publication_country_id) REFERENCES countries (id)
+    EOQ
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        ALTER TABLE books ADD CONSTRAINT fk_books_co_author_id
+            FOREIGN KEY (co_author_id) REFERENCES authors (id) ON DELETE CASCADE
+    EOQ
+  end
 
+  it "should create foreign keys with optional params inferred and table block" do
+    DBLeftovers::DatabaseInterface.starts_with
+    DBLeftovers::Definition.define do
+      table :books do
+        foreign_key :shelves
+        foreign_key :publishers
+        foreign_key :publication_country_id, :countries
+        foreign_key :co_author_id, :authors, :on_delete => :cascade
+      end
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(4).items
+  end
 
   it "should not create indexes when they already exist" do
     DBLeftovers::DatabaseInterface.starts_with([

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_leftovers
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -139,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 856836431
+      hash: 712708189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: