db_leftovers 0.1.0 → 0.2.0

data/Gemfile

@@ -11,7 +11,7 @@ gem 'rails', '>= 3.0.0'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
+  gem "rspec", "~> 2.3.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"

data/Gemfile.lock

@@ -31,6 +31,7 @@ GEM
       multi_json (~> 1.0)
     arel (2.2.1)
     builder (3.0.0)
+    diff-lcs (1.1.3)
     erubis (2.7.0)
     git (1.2.5)
     hike (1.2.1)
@@ -75,7 +76,14 @@ GEM
     rcov (0.9.11)
     rdoc (3.12)
       json (~> 1.4)
-    shoulda (2.11.3)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
     sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -95,4 +103,4 @@ DEPENDENCIES
   jeweler (~> 1.6.4)
   rails (>= 3.0.0)
   rcov
-  shoulda
+  rspec (~> 2.3.0)

data/Rakefile

@@ -29,24 +29,20 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/db_leftovers.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "db_leftovers"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul A. Jungwirth"]
@@ -28,8 +28,8 @@ Gem::Specification.new do |s|
     "lib/db_leftovers.rb",
     "lib/db_leftovers/dsl.rb",
     "lib/tasks/leftovers.rake",
-    "test/helper.rb",
-    "test/test_db_leftovers.rb"
+    "spec/db_leftovers_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/pjungwir/db_leftovers"
   s.licenses = ["MIT"]
@@ -42,20 +42,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 3.0.0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/lib/db_leftovers/dsl.rb

@@ -29,11 +29,11 @@ module DBLeftovers
       opts.keys.each do |k|
         raise "Unknown option: #{k}" unless [:where, :unique, :name].include?(k)
       end
-      @table_name = table_name
-      @column_names = column_names
+      @table_name = table_name.to_s
+      @column_names = [column_names].flatten.map{|x| x.to_s}
       @where_clause = opts[:where]
       @unique = opts[:unique]
-      @index_name = opts[:name] || choose_name(table_name, column_names)
+      @index_name = opts[:name] || choose_name(@table_name, @column_names)
     end
 
     def unique?
@@ -94,12 +94,13 @@ module DBLeftovers
 
   class DSL
     def initialize
+      @db = DatabaseInterface.new
       @indexes_by_table = {}      # Set from the DSL
-      @old_indexes = lookup_all_indexes
+      @old_indexes = @db.lookup_all_indexes
       @new_indexes = {}
       
       @foreign_keys_by_table = {}   # Set from the DSL
-      @old_foreign_keys = lookup_all_foreign_keys
+      @old_foreign_keys = @db.lookup_all_foreign_keys
       @new_foreign_keys = {}
     end
 
@@ -130,7 +131,7 @@ module DBLeftovers
           if index_exists?(idx)
             puts "Index already exists: #{idx.index_name} on #{idx.table_name}"
           else
-            execute_add_index(idx)
+            @db.execute_add_index(idx)
             puts "Created index: #{idx.index_name} on #{idx.table_name}"
           end
           @new_indexes[truncate_index_name(idx.index_name)] = table_name
@@ -141,7 +142,7 @@ module DBLeftovers
       @old_indexes.each do |index_name, table_name|
         if not @new_indexes[index_name]
           # puts "#{index_name} #{table_name}"
-          execute_drop_index(table_name, index_name)
+          @db.execute_drop_index(table_name, index_name)
           puts "Dropped index: #{index_name} on #{table_name}"
         end
       end
@@ -154,7 +155,7 @@ module DBLeftovers
           if foreign_key_exists?(fk)
             puts "Foreign Key already exists: #{fk.constraint_name} on #{fk.from_table}"
           else
-            execute_add_foreign_key(fk)
+            @db.execute_add_foreign_key(fk)
             puts "Created foreign key: #{fk.constraint_name} on #{fk.from_table}"
           end
           @new_foreign_keys[fk.constraint_name] = fk
@@ -164,7 +165,7 @@ module DBLeftovers
       # Now drop any old foreign keys that are no longer in the definition file:
       @old_foreign_keys.each do |constraint_name, fk|
         if not @new_foreign_keys[constraint_name]
-          execute_drop_foreign_key(fk.from_table, fk.from_column)
+          @db.execute_drop_foreign_key(constraint_name, fk.from_table, fk.from_column)
           puts "Dropped foreign key: #{constraint_name} on #{fk.from_table}"
         end
       end
@@ -182,6 +183,26 @@ module DBLeftovers
       t << fk
     end
 
+    def truncate_index_name(index_name)
+      index_name[0,63]
+    end
+
+    def index_exists?(idx)
+      @old_indexes[truncate_index_name(idx.index_name)]
+    end
+
+    def foreign_key_exists?(fk)
+      @old_foreign_keys[fk.constraint_name]
+    end
+
+    def name_constraint(from_table, from_column)
+      "fk_#{from_table}_#{from_column}"
+    end
+
+  end
+
+  class DatabaseInterface
+
     def lookup_all_indexes
       ret = {}
       sql = <<-EOQ
@@ -224,18 +245,6 @@ module DBLeftovers
       return ret
     end
 
-    def truncate_index_name(index_name)
-      index_name[0,63]
-    end
-
-    def index_exists?(idx)
-      @old_indexes[truncate_index_name(idx.index_name)]
-    end
-
-    def foreign_key_exists?(fk)
-      @old_foreign_keys[fk.constraint_name]
-    end
-
     def execute_add_index(idx)
       unique = idx.unique? ? 'UNIQUE' : ''
       where = idx.where_clause.present? ? "WHERE #{idx.where_clause}" : ''
@@ -246,34 +255,33 @@ module DBLeftovers
         (#{idx.column_names.join(', ')})
         #{where}
       EOQ
-      ActiveRecord::Base.connection.execute(sql)
+      execute_sql(sql)
     end
 
     def execute_drop_index(table_name, index_name)
       sql = <<-EOQ
           DROP INDEX #{index_name}
       EOQ
-      ActiveRecord::Base.connection.execute(sql)
+      execute_sql(sql)
     end
 
     def execute_add_foreign_key(fk)
       on_delete = "ON DELETE CASCADE" if fk.cascade
       on_delete = "ON DELETE SET NULL" if fk.set_null
-      ActiveRecord::Base.connection.execute %{ALTER TABLE #{fk.from_table}
+      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}}
     end
 
-    def execute_drop_foreign_key(from_table, from_column)
-      constraint_name = name_constraint(from_table, from_column)
-      ActiveRecord::Base.connection.execute %{ALTER TABLE #{from_table}
+    def execute_drop_foreign_key(constraint_name, from_table, from_column)
+      execute_sql %{ALTER TABLE #{from_table}
                 DROP CONSTRAINT #{constraint_name}}
     end
 
-    def name_constraint(from_table, from_column)
-      "fk_#{from_table}_#{from_column}"
+    def execute_sql(sql)
+      ActiveRecord::Base.connection.execute(sql)
     end
 
   end

data/spec/db_leftovers_spec.rb

@@ -0,0 +1,176 @@
+require 'rails'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+DBLeftovers::DatabaseInterface.class_eval do
+
+  def initialize
+    @@sqls = []
+  end
+
+  def self.sqls
+    @@sqls
+  end
+
+  def execute_sql(sql)
+    @@sqls << sql
+  end
+
+  def self.saw_sql(sql)
+    # puts sqls.join("\n\n\n")
+    # Don't fail if only the whitespace is different:
+    sqls.map{|x| x.gsub(/\s+/m, ' ').strip}.include?(
+      sql.gsub(/\s+/m, ' ').strip
+    )
+  end
+
+  def self.starts_with(indexes, foreign_keys)
+    # Convert symbols to strings:
+    @@indexes = indexes.inject({}) do |h, (k, v)| h[k.to_s] = v; h end
+    @@foreign_keys = foreign_keys.inject({}) do |h, (k, v)| h[k.to_s] = v; h end
+  end
+
+  def lookup_all_indexes
+    @@indexes
+  end
+
+  def lookup_all_foreign_keys
+    @@foreign_keys
+  end
+
+end
+
+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
+
+describe DBLeftovers do
+
+  it "should allow an empty definition" do
+    DBLeftovers::DatabaseInterface.starts_with({}, {})
+    DBLeftovers::Definition.define do
+    end
+    DBLeftovers::DatabaseInterface.sqls.should be_empty
+  end
+
+  it "should create indexes on an empty database" do
+    DBLeftovers::DatabaseInterface.starts_with({}, {})
+    DBLeftovers::Definition.define do
+      index :books, :shelf_id
+      index :books, :publisher_id, :where => 'published'
+    end
+    DBLeftovers::DatabaseInterface.sqls.size.should == 2
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        CREATE INDEX index_books_on_shelf_id
+        ON books
+        (shelf_id)
+    EOQ
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        CREATE INDEX index_books_on_publisher_id
+        ON books
+        (publisher_id)
+        WHERE published
+    EOQ
+  end
+
+  it "should create foreign keys on an empty database" 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
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(3).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_author_id
+        FOREIGN KEY (author_id)
+        REFERENCES authors (id)
+        ON DELETE CASCADE
+    EOQ
+  end
+
+
+
+  it "should not create indexes when they already exist" do
+    DBLeftovers::DatabaseInterface.starts_with({
+      :index_books_on_shelf_id => DBLeftovers::Index.new(:books, :index_id),
+      :index_books_on_publisher_id => DBLeftovers::Index.new(
+        :books, :publisher_id, :where => 'published')
+    }, {})
+    DBLeftovers::Definition.define do
+      index :books, :shelf_id
+      index :books, :publisher_id, :where => 'published'
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(0).items
+  end
+
+
+
+
+  it "should not create foreign keys when they already exist" do
+    DBLeftovers::DatabaseInterface.starts_with({}, {
+      :fk_books_shelf_id => DBLeftovers::ForeignKey.new('fk_books_shelf_id',
+                                                        'books', 'shelf_id', 'shelves', 'id')
+    })
+    DBLeftovers::Definition.define do
+      foreign_key :books, :shelf_id, :shelves
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(0).items
+  end
+
+
+
+  it "should drop indexes when they are removed from the definition" do
+    DBLeftovers::DatabaseInterface.starts_with({
+      :index_books_on_shelf_id => DBLeftovers::Index.new(:books, :index_id),
+      :index_books_on_publisher_id => DBLeftovers::Index.new(
+        :books, :publisher_id, :where => 'published')
+    }, {})
+    DBLeftovers::Definition.define do
+      index :books, :shelf_id
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(1).item
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        DROP INDEX index_books_on_publisher_id
+    EOQ
+  end
+
+
+
+  it "should drop foreign keys when they are removed from the definition" do
+    DBLeftovers::DatabaseInterface.starts_with({}, {
+      :fk_books_shelf_id => DBLeftovers::ForeignKey.new('fk_books_shelf_id',
+                                                        'books', 'shelf_id', 'shelves', 'id'),
+      :fk_books_author_id => DBLeftovers::ForeignKey.new('fk_books_author_id',
+                                                         'books', 'author_id', 'authors', 'id')
+    })
+    DBLeftovers::Definition.define do
+      foreign_key :books, :shelf_id, :shelves
+    end
+    DBLeftovers::DatabaseInterface.sqls.should have(1).item
+    DBLeftovers::DatabaseInterface.should have_seen_sql <<-EOQ
+        ALTER TABLE books DROP CONSTRAINT fk_books_author_id
+    EOQ
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rspec/matchers'
+require 'db_leftovers'
+
+# Requires supporting files with custom matchers and macros, etc.,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_leftovers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &76729710 !ruby/object:Gem::Requirement
+  requirement: &86541750 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *76729710
+  version_requirements: *86541750
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &76729080 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &86541450 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *76729080
+  version_requirements: *86541450
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &76615000 !ruby/object:Gem::Requirement
+  requirement: &86541140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *76615000
+  version_requirements: *86541140
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &76614690 !ruby/object:Gem::Requirement
+  requirement: &86540780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *76614690
+  version_requirements: *86540780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &76614430 !ruby/object:Gem::Requirement
+  requirement: &86540450 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76614430
+  version_requirements: *86540450
 description: ! "        Define indexes and foreign keys for your Rails app\n        in
   one place using an easy-to-read DSL,\n        then run a rake task to bring your
   database up-to-date.\n"
@@ -87,8 +87,8 @@ files:
 - lib/db_leftovers.rb
 - lib/db_leftovers/dsl.rb
 - lib/tasks/leftovers.rake
-- test/helper.rb
-- test/test_db_leftovers.rb
+- spec/db_leftovers_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/pjungwir/db_leftovers
 licenses:
 - MIT
@@ -104,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -340944739
+      hash: 347591153
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'db_leftovers'
-
-class Test::Unit::TestCase
-end

data/test/test_db_leftovers.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDbLeftovers < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end