db_leftovers 0.9.2 → 1.0.0

data/spec/mysql_spec.rb

@@ -0,0 +1,32 @@
+require 'rails'
+require 'active_record'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+def drop_all_mysql_tables(conn, database_name)
+  table_names = conn.select_values("SELECT table_name FROM information_schema.tables WHERE table_schema = '#{database_name}'")
+  # puts "MySQL drop_all_tables #{table_names.join(',')}"
+  conn.execute("SET FOREIGN_KEY_CHECKS = 0")
+  table_names.each do |t|
+    conn.execute("DROP TABLE IF EXISTS #{t}")   # In MySQL, CASCADE does nothing here.
+  end
+  conn.execute("SET FOREIGN_KEY_CHECKS = 1")
+end
+
+describe DBLeftovers::MysqlDatabaseInterface do
+
+  if not test_database_yml('mysql')
+    it "WARN: Skipping MySQL tests because no database found. Use spec/config/database.yml to configure one."
+  else
+    before do
+       y = test_database_yml('mysql')
+      @conn = test_db_connection(nil, y)
+      @db = DBLeftovers::MysqlDatabaseInterface.new(@conn)
+      drop_all_mysql_tables(@conn, y['database'])
+      fresh_tables(@conn, y['database'])
+    end
+
+    it_behaves_like "DatabaseInterface"
+
+  end
+end
+

data/spec/postgres_spec.rb

@@ -0,0 +1,103 @@
+require 'rails'
+require 'active_record'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+def drop_all_postgres_tables(conn, database_name)
+  table_names = conn.select_values("SELECT table_name FROM information_schema.tables WHERE table_catalog = '#{database_name}' AND table_schema NOT IN ('pg_catalog', 'information_schema')")
+  # puts "Postgres drop_all_tables #{table_names.join(',')}"
+  if table_names.size > 0
+    conn.execute("DROP TABLE #{table_names.join(",")} CASCADE")
+  end
+end
+
+describe DBLeftovers::PostgresDatabaseInterface do
+
+  if not test_database_yml('postgres')
+    it "WARN: Skipping Postgres tests because no database found. Use spec/config/database.yml to configure one."
+  else
+    before do
+       y = test_database_yml('postgres')
+      @conn = test_db_connection(nil, y)
+      @db = DBLeftovers::PostgresDatabaseInterface.new(@conn)
+      drop_all_postgres_tables(@conn, y['database'])
+      fresh_tables(@conn, y['database'])
+    end
+
+    it_behaves_like "DatabaseInterface"
+
+    it "should create indexes with a WHERE clause" do
+      DBLeftovers::Definition.define :db_interface => @db do
+        index :books, :publisher_id, :where => 'publication_year IS NOT NULL'
+      end
+      @db.lookup_all_indexes.size.should == 1
+      @db.lookup_all_indexes.keys.sort.should == ['index_books_on_publisher_id']
+    end
+
+    it "should not create indexes with a WHERE clause when they already exist" do
+      starts_with(@db, [
+        DBLeftovers::Index.new(:books, :shelf_id),
+        DBLeftovers::Index.new(:books, :publisher_id, :where => 'publication_year IS NOT NULL')
+      ])
+      DBLeftovers::Definition.define :db_interface => @db do
+        index :books, :shelf_id
+        index :books, :publisher_id, :where => 'publication_year IS NOT NULL'
+      end
+      @db.lookup_all_indexes.size.should == 2
+    end
+
+
+
+    it "should redefine indexes when they have a new WHERE clause" do
+      starts_with(@db, [
+        DBLeftovers::Index.new(:books, :shelf_id),
+        DBLeftovers::Index.new(:books, :publisher_id, :where => 'publication_year IS NOT NULL'),
+        DBLeftovers::Index.new(:books, :isbn)
+      ])
+      DBLeftovers::Definition.define :db_interface => @db do
+        index :books, :shelf_id, :where => 'name IS NOT NULL'
+        index :books, :publisher_id, :where => 'publication_year > 1900'
+        index :books, :isbn
+      end
+      @db.lookup_all_indexes.size.should == 3
+      @db.lookup_all_indexes['index_books_on_shelf_id'].where_clause.should == 'name IS NOT NULL'
+      @db.lookup_all_indexes['index_books_on_publisher_id'].where_clause.should == 'publication_year > 1900'
+    end
+
+
+
+    it "should create CHECK constraints on an empty database" do
+      starts_with(@db, [], [], [])
+      DBLeftovers::Definition.define :db_interface => @db do
+        check :books, :books_have_positive_pages, 'pages_count > 0'
+      end
+      @db.lookup_all_constraints.size.should == 1
+      @db.lookup_all_constraints['books_have_positive_pages'].check.should == 'pages_count > 0'
+    end
+
+
+
+    it "should remove obsolete CHECK constraints" do
+      starts_with(@db, [], [], [
+        DBLeftovers::Constraint.new(:books_have_positive_pages, :books, 'pages_count > 0')
+      ])
+      DBLeftovers::Definition.define :db_interface => @db do
+      end
+      @db.lookup_all_constraints.size.should == 0
+    end
+
+
+
+    it "should drop and re-create changed CHECK constraints" do
+      starts_with(@db, [], [], [
+        DBLeftovers::Constraint.new(:books_have_positive_pages, :books, 'pages_count > 0')
+      ])
+      DBLeftovers::Definition.define :db_interface => @db do
+        check :books, :books_have_positive_pages, 'pages_count > 12'
+      end
+      @db.lookup_all_constraints.size.should == 1
+      @db.lookup_all_constraints['books_have_positive_pages'].check.should == 'pages_count > 12'
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -11,3 +11,24 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
 
 end
+
+
+def test_db_connection(adapter, conf)
+  # DBI.connect(dbi_uri(adapter, conf), conf['username'], conf['password'])
+  # RDBI.connect(adapter, conf)
+  ActiveRecord::Base.establish_connection(conf)
+  ActiveRecord::Base.connection
+end
+
+# def dbi_uri(adapter, conf)
+#   "DBI:#{adapter}:#{conf.select{|k,v| k != 'username' and k != 'password'}.map{|k,v| "#{k}=#{v}"}.join(";")}"
+# end
+
+def test_database_yml(database)
+  y = YAML.load(File.open(File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'database.yml')))
+  y[database]
+rescue Errno::ENOENT
+  return nil
+end
+
+

data/spec/support/mock_database_interface.rb

@@ -0,0 +1,59 @@
+class DBLeftovers::MockDatabaseInterface < DBLeftovers::GenericDatabaseInterface
+
+  def initialize
+    @sqls = []
+  end
+
+  def sqls
+    @sqls
+  end
+
+  def execute_sql(sql)
+    @sqls << normal_whitespace(sql)
+  end
+
+  alias :old_execute_add_index :execute_add_index
+  def execute_add_index(idx)
+    old_execute_add_index(idx)
+    @indexes[idx.index_name] = idx
+  end
+
+  alias :old_execute_add_constraint :execute_add_constraint
+  def execute_add_constraint(chk)
+    old_execute_add_constraint(chk)
+    @constraints[chk.constraint_name] = chk
+  end
+
+  def saw_sql(sql)
+    # puts sqls.join("\n\n\n")
+    # Don't fail if only the whitespace is different:
+    sqls.include?(normal_whitespace(sql))
+  end
+
+  def starts_with(indexes=[], foreign_keys=[], constraints=[])
+    # Convert symbols to strings:
+    @indexes = Hash[indexes.map{|idx| [idx.index_name, idx]}]
+    @foreign_keys = Hash[foreign_keys.map{|fk| [fk.constraint_name, fk]}]
+    @constraints = Hash[constraints.map{|chk| [chk.constraint_name, chk]}]
+  end
+
+  def lookup_all_indexes
+    @indexes
+  end
+
+  def lookup_all_foreign_keys
+    @foreign_keys
+  end
+
+  def lookup_all_constraints
+    @constraints
+  end
+
+  private
+
+  def normal_whitespace(sql)
+    sql.gsub(/\s/m, ' ').gsub(/  +/, ' ').strip
+  end
+
+end
+

data/spec/support/shared_db_tests.rb

@@ -0,0 +1,152 @@
+
+=begin
+def drop_all_tables(conn, database_name)
+  table_names = conn.select_values("SELECT table_name FROM information_schema.tables WHERE table_catalog = '#{database_name}' AND table_schema NOT IN ('pg_catalog', 'information_schema')")
+  table_names.each do |t|
+    conn.execute("DROP TABLE IF EXISTS #{t} CASCADE")
+  end
+end
+=end
+
+def fresh_tables(conn, database_name)
+  conn.execute <<-EOQ
+      CREATE TABLE publishers (
+          id integer PRIMARY KEY,
+          name varchar(255)
+      )
+  EOQ
+  conn.execute <<-EOQ
+      CREATE TABLE authors (
+          id integer PRIMARY KEY,
+          name varchar(255)
+      )
+  EOQ
+  conn.execute <<-EOQ
+      CREATE TABLE shelves (
+          id integer PRIMARY KEY,
+          name varchar(255)
+      )
+  EOQ
+  conn.execute <<-EOQ
+      CREATE TABLE books (
+          id integer PRIMARY KEY,
+          name varchar(255),
+          author_id integer,
+          coauthor_id integer,
+          publisher_id integer,
+          isbn  varchar(255),
+          publication_year integer,
+          shelf_id integer,
+          pages_count integer
+      )
+  EOQ
+end
+
+def starts_with(db, indexes=[], foreign_keys=[], constraints=[])
+  indexes.each { |idx| db.execute_add_index(idx) }
+  foreign_keys.each { |fk| db.execute_add_foreign_key(fk) }
+  constraints.each { |chk| db.execute_add_constraint(chk) }
+end
+
+shared_examples_for "DatabaseInterface" do
+
+  it "should create indexes on a fresh database" do
+    DBLeftovers::Definition.define :db_interface => @db do
+      index :books, :shelf_id
+      index :books, :isbn, :unique => true
+      # Not supported by MYSQL:
+      # index :books, :publisher_id, :where => 'publication_year IS NOT NULL'
+    end
+    @db.lookup_all_indexes.size.should == 2
+    @db.lookup_all_indexes.keys.sort.should == ['index_books_on_isbn', 'index_books_on_shelf_id']
+  end
+
+  it "should create foreign keys on a fresh database" do
+    DBLeftovers::Definition.define :db_interface => @db do
+      foreign_key :books, :shelf_id, :shelves
+      foreign_key :books, :publisher_id, :publishers, :id, :on_delete => :set_null
+      foreign_key :books, :author_id, :authors, :id, :on_delete => :cascade
+    end
+    @db.lookup_all_foreign_keys.size.should == 3
+    @db.lookup_all_foreign_keys.keys.sort.should == ['fk_books_author_id', 'fk_books_publisher_id', 'fk_books_shelf_id']
+  end
+
+  it "should not create indexes when they already exist" do
+    starts_with(@db, [
+      DBLeftovers::Index.new(:books, :shelf_id),
+      DBLeftovers::Index.new(:books, :publisher_id, :unique => true)
+    ])
+    DBLeftovers::Definition.define :db_interface => @db do
+      index :books, :shelf_id
+      index :books, :publisher_id, :unique => true
+    end
+    @db.lookup_all_indexes.size.should == 2
+  end
+
+
+
+  it "should create indexes when they have been redefined" do
+    starts_with(@db, [
+      DBLeftovers::Index.new(:books, :shelf_id),
+      # DBLeftovers::Index.new(:books, :publisher_id, :where => 'published'),
+      DBLeftovers::Index.new(:books, :isbn, :unique => true)
+    ])
+    DBLeftovers::Definition.define :db_interface => @db do
+      index :books, :shelf_id, :unique => true
+      # index :books, :publisher_id
+      index :books, :isbn
+    end
+    @db.lookup_all_indexes.size.should == 2
+    @db.lookup_all_indexes['index_books_on_shelf_id'].unique.should == true
+    @db.lookup_all_indexes['index_books_on_isbn'].unique.should == false
+  end
+
+
+  it "should drop indexes when they are removed from the definition" do
+    starts_with(@db, [
+       DBLeftovers::Index.new(:books, :shelf_id),
+       DBLeftovers::Index.new(:books, :isbn, :unique => true)
+    ])
+    DBLeftovers::Definition.define :db_interface => @db do
+      index :books, :shelf_id
+    end
+    @db.lookup_all_indexes.size.should == 1
+  end
+
+
+
+  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::Definition.define :db_interface => @db do
+      foreign_key :books, :shelf_id, :shelves
+    end
+    @db.lookup_all_foreign_keys.size.should == 1
+  end
+
+
+  it "should support creating multi-column indexes" do
+    starts_with(@db)
+    DBLeftovers::Definition.define :db_interface => @db do
+      index :books, [:publication_year, :name]
+    end
+    @db.lookup_all_indexes.size.should == 1
+    puts @db.lookup_all_indexes.keys
+    @db.lookup_all_indexes.should have_key('index_books_on_publication_year_and_name')
+  end
+
+  
+
+  it "should support dropping multi-column indexes" do
+    starts_with(@db, [
+      DBLeftovers::Index.new(:books, [:publication_year, :name])
+    ])
+    DBLeftovers::Definition.define :db_interface => @db do
+    end
+    @db.lookup_all_indexes.size.should == 0
+  end
+
+
+end

data/spec/support/sql_matcher.rb

@@ -0,0 +1,11 @@
+
+RSpec::Matchers.define :have_seen_sql do |sql|
+  match do |db|
+    db.saw_sql(sql)
+  end
+
+  failure_message_for_should do |db|
+    "Should have seen...\n#{sql}\n...but instead saw...\n#{db.sqls.join("\n.....\n")}"
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_leftovers
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-30 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,15 +114,23 @@ files:
 - db_leftovers.gemspec
 - lib/db_leftovers.rb
 - lib/db_leftovers/constraint.rb
-- lib/db_leftovers/database_interface.rb
 - lib/db_leftovers/definition.rb
 - lib/db_leftovers/dsl.rb
 - lib/db_leftovers/foreign_key.rb
+- lib/db_leftovers/generic_database_interface.rb
 - lib/db_leftovers/index.rb
+- lib/db_leftovers/mysql_database_interface.rb
+- lib/db_leftovers/postgres_database_interface.rb
 - lib/db_leftovers/table_dsl.rb
 - lib/tasks/leftovers.rake
+- spec/config/database.yml.sample
 - spec/db_leftovers_spec.rb
+- spec/mysql_spec.rb
+- spec/postgres_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_database_interface.rb
+- spec/support/shared_db_tests.rb
+- spec/support/sql_matcher.rb
 - README.html
 homepage: http://github.com/pjungwir/db_leftovers
 licenses:
@@ -139,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 269207025
+      hash: 3241801701891816563
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: