foreigner-matcher 0.0.3 → 0.1.0

data/README.md

@@ -6,16 +6,22 @@ RSpec matcher for the [Foreigner gem](https://github.com/matthuhiggins/foreigner
 
 For installation with bundler, add the following to the approrpriate group in your Gemfile:
 
-    gem "foreigner-matcher"
+    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"
+    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 <tt>require</tt> 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.
@@ -36,7 +42,7 @@ The spec would look like this:
       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:
+In addition to the table name, you can include any options that <tt>add\_foreign\_key</tt> (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") }
@@ -44,7 +50,7 @@ In addition to the table name, you can include any options that add_foreign_key
 
 **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!
+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 &quot;it should have foreign key for user&quot;. This is just my taste; use what makes sense to you!
 
 ## My Testing Environment
 

data/lib/foreigner-matcher/version.rb

@@ -1,5 +1,5 @@
 module Foreigner
   module Matcher
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

data/lib/foreigner-matcher.rb

@@ -52,24 +52,34 @@ module ForeignerMatcher # :nodoc:
     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) }
 
-# 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
 
-def have_foreign_key_for(parent, options={})
-  ForeignerMatcher::HaveForeignKeyFor.new(parent, options)
+end
+
+if defined?(RSpec)
+  RSpec::Matchers.send :include, ForeignerMatcher
+elsif defined?(Spec)
+  Spec::Runner.configure do |config|
+    config.include(ForeignerMatcher)
+  end
+else
+  raise LoadError, 'RSpec/Spec must be loaded so I can be mixed in'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreigner-matcher
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-17 00:00:00.000000000 -05:00
+date: 2011-06-18 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreigner
-  requirement: &14843940 !ruby/object:Gem::Requirement
+  requirement: &9035980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +22,7 @@ dependencies:
         version: 0.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *14843940
+  version_requirements: *9035980
 description: Adds rspec matcher to verify the presence of foreign keys generated by
   Foreigner in a table schema
 email: