foreigner-matcher

RSpec matcher for the Foreigner gem, inspired by Remarkable ActiveRecord matchers.

Installation

For installation with bundler, add the following to the approrpriate group in your Gemfile:

gem "foreigner-matcher", :require => nil

For installation without bundler in Rails 2.3, add the following to your config/environments/test.rb:

config.gem "foreigner-matcher", :require => nil

To install the gem the old fashioned way:

gem install foreigner-matcher

In spec_helper.rb:

require 'foreigner-matcher'

Note that the entry in spec_helper.rb must follow any require for RSpec libraries.

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) 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 :user as the table name. Why? The example has a belongs_to 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!

My Testing Environment

Specs have been run with Ruby 1.9.2p180 and Ruby Enterprise Edition 2011.03 with the following combinations:

ActiveRecord ~> 3.0.0, Rspec ~> 2.6.0
ActiveRecord ~> 2.3.11, Rsepc ~> 1.3.2

foreigner-matcher

Installation

Usage

My Testing Environment

Copyright