foreigner-matcher 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.rvmrc
+.rspec
+Gemfile.lock
+pkg/*
+doc/*
+spec/config/database.yml

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in foreigner-matcher.gemspec
+gemspec
+
+group :development do
+  gem "kramdown",     "~> 0.13.2"
+end
+
+group :test do
+  gem "rspec",        "~> 2.5"
+  gem "ruby-debug",   "~> 0.10.4"
+  gem "activerecord", ">= 2.3.11"
+  gem "mysql2",       "~> 0.2.7"
+  gem "mysql",        "~> 2.8.1"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Cameron Dykes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,41 @@
+# foreigner-matcher
+
+RSpec matcher for the [Foreigner gem](https://github.com/matthuhiggins/foreigner).
+
+## Installation
+
+    gem install foreigner-matcher
+
+## Usage
+
+The matcher can be used in RSpec to ensure an ActiveRecord model has the desired foreign key. The minimum argument is the table name that the subject model should have a foreign key to.
+
+For example. Given these two models:
+
+    class User < ActiveRecord::Base
+      has_many user_logins
+    end
+
+    class UserLogin < ActiveRecord::Base
+      belongs_to user
+    end
+
+The spec would look like this:
+
+    describe UserLogin do
+      it { should have_foreign_key_for(:users) }
+    end
+
+In addition to the table name, you can include any options that add_foreign_key (see [Foreigner](https://github.com/matthuhiggins/foreigner)) accepts. Some more examples using the same models:
+
+    it { should have_foreign_key_for(:users, :dependent => :delete) }
+    it { should have_foreign_key_for(:users, :column => "unique_user_id", :name => "user_logins_unique_user_id_fk") }
+    it { should_not have_foreign_key_for(:users, :dependent => :nullify) }
+
+**A Note on Table Names**
+
+These examples will also work passing <tt>:user</tt> as the table name. Why? The example has a <tt>belongs_to</tt> relationship, and my feeling is that it reads better to say "it should have foreign key for user". This is just my taste; use what makes sense to you!
+
+## Copyright
+
+Copyright (c) 2011 Cameron Dykes. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+namespace :db do
+  namespace :test do
+    desc "Reset the test database"
+    task :reset do
+      require 'yaml'
+      require 'active_record'
+
+      def print_table_creation(new_table)
+        print "\tCreating #{new_table}..."
+        yield
+        print "done\n"
+      end
+
+      def print_foreign_key_creation(fk_table)
+        print "\tCreating key on #{fk_table}..."
+        yield
+        print "done\n"
+      end
+
+      puts "Establishing connection to test db..."
+      db_config = YAML::load(File.open("#{File.dirname(__FILE__)}/spec/config/database.yml"))
+      ActiveRecord::Base.establish_connection(db_config)
+      conn = ActiveRecord::Base.connection
+      puts "Connected to #{db_config['database']} via a #{db_config['adapter']} connector"
+
+      puts "\nDropping test tables, if they exist"
+      %w( user_logins user_types comments searches special_user_records table_without_foreign_keys users ).each do |test_table|
+        print "\tDropping #{test_table}..."
+        conn.execute("drop table if exists #{test_table}")
+        print "done\n"
+      end
+
+      puts "\nCreating test tables"
+      print_table_creation('users') do
+        conn.create_table(:users) do |t|
+          t.string :username
+          t.string :email, :default => 'nobody@localhost'
+        end
+      end
+      print_table_creation('special_user_records') do
+        conn.create_table(:special_user_records) do |t|
+          t.integer :special_user_id
+        end
+      end
+      [ :user_logins, :user_types, :comments, :searches, :table_without_foreign_keys ].each do |user_table|
+        print_table_creation(user_table) do
+          conn.create_table(user_table) do |t|
+            t.integer :user_id
+          end
+        end
+      end
+
+      require 'foreigner'
+      puts "\nCreating foreign keys"
+      print_foreign_key_creation('user_logins') { conn.add_foreign_key(:user_logins, :users, :dependent => :nullify) }
+      print_foreign_key_creation('user_types') { conn.add_foreign_key(:user_types, :users, :dependent => :restrict) }
+      print_foreign_key_creation('comments') { conn.add_foreign_key(:comments, :users, :dependent => :delete) }
+      print_foreign_key_creation('searches') { conn.add_foreign_key(:searches, :users, :name => "user_search_special_fk", :dependent => :delete) }
+      print_foreign_key_creation('special_user_records') { conn.add_foreign_key(:special_user_records, :users, :column => "special_user_id", :dependent => :delete) }
+    end
+  end
+end

data/foreigner-matcher.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "foreigner-matcher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "foreigner-matcher"
+  s.version     = Foreigner::Matcher::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cameron Dykes"]
+  s.email       = ["yellow5c@gmail.com"]
+  s.homepage    = "https://github.com/yellow5/foreigner-matcher"
+  s.summary     = %q{Rspec matcher for testing the presence of foreign keys generated by Foreigner}
+  s.description = %q{Adds rspec matcher to verify the presence of foreign keys generated by Foreigner in a table schema}
+
+  s.add_dependency "foreigner", "0.9.1"
+
+  s.rubyforge_project = "foreigner-matcher"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/foreigner-matcher.rb

@@ -0,0 +1,62 @@
+module ForeignerMatcher # :nodoc:
+
+  class HaveForeignKeyFor # :nodoc:
+    def initialize(parent, options={})
+      @parent  = parent.to_s
+      @options = options
+    end
+
+    def matches?(child)
+      @child = child
+      child_foreign_keys.include? foreign_key_definition
+    end
+
+    def description
+      desc  = "have a foreign key for #{@parent}"
+      desc += " with #{@options.inspect}" unless @options.empty?
+      desc
+    end
+
+    def failure_message_for_should
+      "expected #{child_foreign_keys} to include #{foreign_key_definition}"
+    end
+
+    def failure_message_for_should_not
+      "expected #{child_foreign_keys} to exclude #{foreign_key_definition}"
+    end
+
+    private
+
+    def foreign_key_definition
+      defaults        = { :primary_key => "id", :column => "#{@parent.singularize}_id" }
+      defaults[:name] = "#{@child.class.table_name}_#{defaults[:column]}_fk"
+      full_options    = defaults.merge(@options)
+      Foreigner::ConnectionAdapters::ForeignKeyDefinition.new(@child.class.table_name, @parent.pluralize, full_options)
+    end
+
+    def child_foreign_keys
+      @child.connection.foreign_keys(@child.class.table_name)
+    end
+  end
+
+end
+
+# Ensures that parent table has foreign key
+#
+# * <b>parent</b> - The table to check for foreign key
+# * <b>options</b> - Accepts any option that works with add_foreign_key in Foreigner
+#
+# <em>Defaults</em>
+#     :primary_key Column referenced on parent table (default: id)
+#     :column Foreign key column (default: #{@parent.singluarize}_id)
+#     :name Foreign key index name (default: #{@child.class.table_name}_#{@parent.singularize}_id)
+#
+# <b>Examples</b>
+#   it { should have_foreign_key_for(:users) }
+#   it { should have_foreign_key_for(:users, :dependent => :delete) }
+#   it { should have_foreign_key_for(:users, :column => "some_column_name", :name => "users_some_column_name_fk") }
+#   it { should_not have_foreign_key_for(:users, :dependent => :nullify) }
+
+def have_foreign_key_for(parent, options={})
+  ForeignerMatcher::HaveForeignKeyFor.new(parent, options)
+end

data/lib/foreigner-matcher/version.rb

@@ -0,0 +1,5 @@
+module Foreigner
+  module Matcher
+    VERSION = "0.0.1"
+  end
+end

data/spec/config/database.yml.example

@@ -0,0 +1,6 @@
+# This example shows what should be included in your database.yml.
+database: foreigner-matcher_test
+adapter:  mysql2
+username: user
+password: password
+host:     localhost

data/spec/foreigner_matcher_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ForeignerMatcher::HaveForeignKeyFor do
+  describe 'methods' do
+    subject { ForeignerMatcher::HaveForeignKeyFor.new(mock) }
+
+    [ :matches?, :description, :failure_message_for_should, :failure_message_for_should_not ].each do |klass_method|
+      it "should respond to #{klass_method}" do
+        subject.should respond_to(klass_method)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'ruby-debug'
+require 'yaml'
+require 'active_record'
+require 'foreigner-matcher'
+
+# Open a database connection
+db_config = YAML::load(File.open("#{File.dirname(__FILE__)}/config/database.yml"))
+ActiveRecord::Base.establish_connection(db_config)
+
+# Require foreigner after ActiveRecord connection is establisehd.
+require 'foreigner'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/test_models.rb

@@ -0,0 +1,7 @@
+class User < ActiveRecord::Base ; end
+class UserLogin < ActiveRecord::Base ; end
+class UserType < ActiveRecord::Base ; end
+class Comment < ActiveRecord::Base ; end
+class Search < ActiveRecord::Base ; end
+class SpecialUserRecord < ActiveRecord::Base ; end
+class TableWithoutForeignKey < ActiveRecord::Base ; end

data/spec/test_models/comment_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Comment do
+  describe 'messages' do
+    it "should contain a description" do
+      matcher = have_foreign_key_for(:users, :dependent => :delete)
+      matcher.description.should == "have a foreign key for users with {:dependent=>:delete}"
+    end
+
+    it "should set failure_message_for_should message" do
+      matcher = have_foreign_key_for(:comments)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should.should == "expected #{subject.connection.foreign_keys('comments')} to include #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('comments', 'comments', :primary_key => 'id', :column => 'comment_id', :name => 'comments_comment_id_fk')}"
+    end
+
+    it "should set failure_message_for_should_not message" do
+      matcher = have_foreign_key_for(:users, :dependent => :delete)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should_not.should == "expected #{subject.connection.foreign_keys('comments')} to exclude #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('comments', 'users', :primary_key => 'id', :column => 'user_id', :name => 'comments_user_id_fk', :dependent => :delete)}"
+    end
+  end
+
+  describe 'matcher' do
+    it { should have_foreign_key_for(:user, :dependent => :delete) }
+    it { should have_foreign_key_for(:users, :dependent => :delete) }
+  end
+end

data/spec/test_models/search_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Search do
+  describe 'messages' do
+    it "should contain a description" do
+      matcher = have_foreign_key_for(:users, :name => "user_search_special_fk", :dependent => :delete)
+      matcher.description.should == "have a foreign key for users with {:dependent=>:delete, :name=>\"user_search_special_fk\"}"
+    end
+
+    it "should set failure_message_for_should message" do
+      matcher = have_foreign_key_for(:searches)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should.should == "expected #{subject.connection.foreign_keys('searches')} to include #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('searches', 'searches', :primary_key => 'id', :column => 'search_id', :name => 'searches_search_id_fk')}"
+    end
+
+    it "should set failure_message_for_should_not message" do
+      matcher = have_foreign_key_for(:users, :name => "user_search_special_fk", :dependent => :delete)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should_not.should == "expected #{subject.connection.foreign_keys('searches')} to exclude #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('searches', 'users', :primary_key => 'id', :column => 'user_id', :name => 'user_search_special_fk', :dependent => :delete)}"
+    end
+  end
+
+  describe 'matcher' do
+    it { should have_foreign_key_for(:user, :name => "user_search_special_fk", :dependent => :delete) }
+    it { should have_foreign_key_for(:users, :name => "user_search_special_fk", :dependent => :delete) }
+  end
+end

data/spec/test_models/special_user_record_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SpecialUserRecord do
+  describe 'messages' do
+    it "should contain a description" do
+      matcher = have_foreign_key_for(:users, :column => "special_user_id", :name => "special_user_records_special_user_id_fk", :dependent => :delete)
+      matcher.description.should == "have a foreign key for users with {:column=>\"special_user_id\", :dependent=>:delete, :name=>\"special_user_records_special_user_id_fk\"}"
+    end
+
+    it "should set failure_message_for_should message" do
+      matcher = have_foreign_key_for(:special_user_records)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should.should == "expected #{subject.connection.foreign_keys('special_user_records')} to include #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('special_user_records', 'special_user_records', :primary_key => 'id', :column => 'special_user_record_id', :name => 'special_user_records_special_user_record_id_fk')}"
+    end
+
+    it "should set failure_message_for_should_not message" do
+      matcher = have_foreign_key_for(:users, :column => "special_user_id", :name => "special_user_records_special_user_id_fk", :dependent => :delete)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should_not.should == "expected #{subject.connection.foreign_keys('special_user_records')} to exclude #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('special_user_records', 'users', :primary_key => 'id', :column => 'special_user_id', :name => 'special_user_records_special_user_id_fk', :dependent => :delete)}"
+    end
+  end
+
+  describe 'matcher' do
+    it { should have_foreign_key_for(:user, :column => "special_user_id", :name => "special_user_records_special_user_id_fk", :dependent => :delete) }
+    it { should have_foreign_key_for(:users, :column => "special_user_id", :name => "special_user_records_special_user_id_fk", :dependent => :delete) }
+  end
+end

data/spec/test_models/table_without_foreign_key_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe TableWithoutForeignKey do
+  describe 'matcher' do
+    it { should_not have_foreign_key_for(:user) }
+    it { should_not have_foreign_key_for(:users) }
+  end
+end

data/spec/test_models/user_login_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe UserLogin do
+  describe 'messages' do
+    it "should contain a description" do
+      matcher = have_foreign_key_for(:users, :dependent => :nullify)
+      matcher.description.should == "have a foreign key for users with {:dependent=>:nullify}"
+    end
+
+    it "should set failure_message_for_should message" do
+      matcher = have_foreign_key_for(:user_logins)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should.should == "expected #{subject.connection.foreign_keys('user_logins')} to include #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('user_logins', 'user_logins', :primary_key => 'id', :column => 'user_login_id', :name => 'user_logins_user_login_id_fk')}"
+    end
+
+    it "should set failure_message_for_should_not message" do
+      matcher = have_foreign_key_for(:users, :dependent => :nullify)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should_not.should == "expected #{subject.connection.foreign_keys('user_logins')} to exclude #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('user_logins', 'users', :primary_key => 'id', :column => 'user_id', :name => 'user_logins_user_id_fk', :dependent => :nullify)}"
+    end
+  end
+
+  describe 'matcher' do
+    it { should have_foreign_key_for(:user, :dependent => :nullify) }
+    it { should have_foreign_key_for(:users, :dependent => :nullify) }
+  end
+end

data/spec/test_models/user_type_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe UserType do
+  describe 'messages' do
+    it "should contain a description" do
+      matcher = have_foreign_key_for(:users)
+      matcher.description.should == "have a foreign key for users"
+    end
+
+    it "should set failure_message_for_should message" do
+      matcher = have_foreign_key_for(:user_types)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should.should == "expected #{subject.connection.foreign_keys('user_types')} to include #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('user_types', 'user_types', :primary_key => 'id', :column => 'user_type_id', :name => 'user_types_user_type_id_fk')}"
+    end
+
+    it "should set failure_message_for_should_not message" do
+      matcher = have_foreign_key_for(:users)
+      matcher.matches?(subject)
+      matcher.failure_message_for_should_not.should == "expected #{subject.connection.foreign_keys('user_types')} to exclude #{Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('user_types', 'users', :primary_key => 'id', :column => 'user_id', :name => 'user_types_user_id_fk')}"
+    end
+  end
+
+  describe 'matcher' do
+    it { should have_foreign_key_for(:user) }
+    it { should have_foreign_key_for(:users) }
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: foreigner-matcher
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cameron Dykes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: foreigner
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+description: Adds rspec matcher to verify the presence of foreign keys generated by Foreigner in a table schema
+email: 
+- yellow5c@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- foreigner-matcher.gemspec
+- lib/foreigner-matcher.rb
+- lib/foreigner-matcher/version.rb
+- spec/config/database.yml.example
+- spec/foreigner_matcher_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_models.rb
+- spec/test_models/comment_spec.rb
+- spec/test_models/search_spec.rb
+- spec/test_models/special_user_record_spec.rb
+- spec/test_models/table_without_foreign_key_spec.rb
+- spec/test_models/user_login_spec.rb
+- spec/test_models/user_type_spec.rb
+has_rdoc: true
+homepage: https://github.com/yellow5/foreigner-matcher
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: foreigner-matcher
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Rspec matcher for testing the presence of foreign keys generated by Foreigner
+test_files: 
+- spec/config/database.yml.example
+- spec/foreigner_matcher_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_models.rb
+- spec/test_models/comment_spec.rb
+- spec/test_models/search_spec.rb
+- spec/test_models/special_user_record_spec.rb
+- spec/test_models/table_without_foreign_key_spec.rb
+- spec/test_models/user_login_spec.rb
+- spec/test_models/user_type_spec.rb