rspec-on-rails-matchers 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,10 @@
+Change Log
+==========
+
+Trunk
+-----
+
+* 2008/03/02 - Added have_form_putting_to(url_or_path) - Patch by unknown google code submitter
+* 2008/03/02 - Added should observe (Luke Melia)
+* 2008/03/02 - Patched validates_length_of to use within to be consistent with Rails (Matt Pelletier)
+* 2007/01/03 - Initial Public Release

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem 'rails', ">= 3.0.0"
+gem 'rspec-rails', ">=2.6.1"
+
+group :development do
+  gem 'sqlite3'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 The Plugin Development Team
+
+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

@@ -0,0 +1,197 @@
+rspec-on-rails-matchers
+=======================
+
+Setup
+------
+
+Add the following to your gemfile:
+
+gem 'rspec-on-rails-matchers'
+
+In your spec helper, after the require to 'rspec/rails':
+
+  require 'rspec_on_rails_matchers'
+
+Dependencies:
+-------------
+
+  * rspec >= 2
+  * rspec_on_rails
+
+Overview
+--------
+
+Adds the following RSpec matchers using the new Matcher syntax (http://github.com/dchelimsky/rspec/wiki/custom-matchers):
+
+  * Associations:
+    Verify that the association has been defined. (doesn't verify that the association works!)
+
+    object.should have_many(:association)
+    example: @post.should have_many(:comments)
+    TM snippet: [mshm + tab] (Model Should Have Many)
+
+    object.should belong_to(:association)
+    example: @comment.should belong_to(:post)
+    TM snippet: [msbt + tab]
+
+    object.should have_one(:association)
+    user.should have_one(:social_security_number)
+    TM snippet: [msho + tab]
+
+    object.should have_and_belong_to_many(:association)
+    project.should have_and_belong_to_many(:categories)
+    TM snippet: [mshabtm + tab]
+
+
+  * Validations:
+    Verify that a validation has been defined. (doesn't test the validation itself)
+
+    object.should validate_presence_of(:attribute)
+    TM snippet: [msvp + tab]
+
+    object.should validate_confirmation_of(:attribute)
+    TM snippet: [msvc + tab]
+
+    object.should validate_uniqueness_of(:attribute)
+    TM snippet: [msvu + tab]
+
+    object.should validate_length_of(:attribute, :within => 5..10)
+    object.should validate_length_of(:attribute, :is => 5)
+    TM snippet: [msvl + tab]
+
+  * Observers:
+    Verify that the observer is observing a class. (doesn't verify that the observation works)
+
+    object.should observe(:model)
+    example: GroupObserver.should observe(Group)
+
+  * Views:
+    Verifies that the views contains some tags.
+
+    response.should have_form_posting_to(url_or_path)
+    TM snippet: [hfpt + tab]
+
+    response.should have_form_putting_to(url_or_path)
+
+    response.should have_text_field_for(:attribute)
+    TM snippet: [htff + tab]
+
+    response.should have_label_for(:attribute)
+    TM snippet: [hlf + tab]
+
+    response.should have_password_field_for(:attribute)
+    TM snippet: [hpff + tab]
+
+    response.should have_checkbox_for(:attribute)
+    TM snippet: [hcf + tab]
+
+    response.should have_submit_button
+    TM snippet: [hsb + tab]
+
+    response.should have_link_to(url_or_path, "optional_text")
+    TM snippet: [hlt + tab]
+
+    * nested view tests:
+      for instance:
+
+      response.should have_form_posting_to(url_or_path) do
+        with_text_field_for(:attribute)
+      end
+
+      with_text_field_for(:attribute)
+      TM snippet: [wtff + tab]
+
+      with_label_for(:attribute)
+      TM snippet: [wlf + tab]
+
+      with_password_field_for(:attribute)
+      TM snippet: [wpff + tab]
+
+      with_checkbox_for(:attribute)
+      TM snippet: [wcf + tab]
+
+      with_submit_button
+      TM snippet: [wsb + tab]
+
+      with_link_to(url_or_path, "optional_text")
+      TM snippet: [wlt + tab]
+
+Usage:
+------
+
+In your view spec:
+
+    it "should render new form" do
+      render "/users/new.html.erb"
+
+      response.should have_form_posting_to(users_path) do
+        with_text_field_for(:user_name)
+        with_text_area_for(:user_address)
+        with_text_field_for(:user_login)
+        with_text_field_for(:user_email)
+        with_submit_button
+      end
+    end
+
+In your model spec:
+
+    describe User do
+      before(:each) do
+        @user = User.new
+      end
+
+      it "should have many posts" do
+        @user.should have_many(:posts)
+      end
+
+      it "should belong to a group" do
+        @user.should belong_to(:group)
+      end
+
+      it do
+        @user.should validate_presence_of(:email)
+      end
+
+      it do
+        @user.should validate_uniqueness_of(:email)
+      end
+
+      it do
+        @user.should validate_uniqueness_of(:login)
+      end
+
+      it do
+        @user.should validate_presence_of(:login)
+      end
+
+      it do
+        @user.should validate_presence_of(:name)
+      end
+
+      it do
+        @user.should validate_length_of(:password, :between => 4..40)
+      end
+
+      it do
+        @user.should validate_confirmation_of(:password)
+      end
+
+    end
+
+Core Contributors
+-----------------
+
+  * Josh Knowles <joshknowles@gmail.com>
+  * Bryan Helmkamp <bryan@brynary.com>
+  * Matt Aimonetti <mattaimonetti@gmail.com>
+  * Scott Taylor <scott@railsnewbie.com>
+  * Stephen Schor <stephen@eastmedia.com>
+
+Contributors
+-------------
+
+  * ckknight
+  * Matt Pelletier
+  * Luke Melia
+
+Copyright (c) 2008 The Plugin Development Team, released under the MIT license

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks :name => 'rspec-on-rails-matchers'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/TODO

@@ -0,0 +1,4 @@
+To Do
+=====
+
+* Update README to include instructions on installing from github

data/lib/rspec_on_rails_matchers.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), 'rspec_on_rails_matchers', 'version')
+
+if !defined?(Rails) || Rails.env.test?
+  require File.join(File.dirname(__FILE__), 'rspec_on_rails_matchers', 'observers')
+  require File.join(File.dirname(__FILE__), 'rspec_on_rails_matchers', 'associations')
+  require File.join(File.dirname(__FILE__), 'rspec_on_rails_matchers', 'validations')
+  require File.join(File.dirname(__FILE__), 'rspec_on_rails_matchers', 'views')
+end

data/lib/rspec_on_rails_matchers/associations.rb

@@ -0,0 +1,51 @@
+RSpec::Matchers.define :belong_to do |association|
+  match do |object|
+    object = object.class if object.is_a? ActiveRecord::Base
+    object.reflect_on_all_associations(:belongs_to).find { |a| a.name == association }
+  end
+end
+
+RSpec::Matchers.define :have_many do |association|
+  match do |object|
+    object = object.class if object.is_a? ActiveRecord::Base
+    object.reflect_on_all_associations(:has_many).find { |a| a.name == association }
+  end
+end
+
+RSpec::Matchers.define :have_one do |association|
+  match do |object|
+    object = object.class if object.is_a? ActiveRecord::Base
+    object.reflect_on_all_associations(:has_one).find { |a| a.name == association }
+  end
+end
+
+RSpec::Matchers.define :have_and_belong_to_many do |association|
+  match do |object|
+    object = object.class if object.is_a? ActiveRecord::Base
+    object.reflect_on_all_associations(:has_and_belongs_to_many).find { |a| a.name == association }
+  end
+end
+
+RSpec::Matchers.define :have_valid_associations do |association, *_|
+  failed_association = nil
+  model_class = nil
+
+  match do |object|
+    failed_association = nil
+    model_class = object.class
+
+    model_class.reflect_on_all_associations.each do |assoc|
+      begin
+        object.send(assoc.name)
+      rescue
+        failed_association = assoc.name
+      end
+    end
+
+    !failed_association
+  end
+
+  failure_message_for_should do |actual|
+    "invalid or nonexistent association \"#{failed_association}\" on #{model_class}"
+  end
+end

data/lib/rspec_on_rails_matchers/observers.rb

@@ -0,0 +1,6 @@
+RSpec::Matchers.define :observe do |observed_class|
+  match do |observing_class|
+    observed_classes = observing_class.observed_classes.flatten
+    observed_classes.include?(observed_classes)
+  end
+end

data/lib/rspec_on_rails_matchers/validations.rb

@@ -0,0 +1,96 @@
+RSpec::Matchers.define :validate_presence_of do |attribute|
+  match do |object|
+    if !object.respond_to?("#{attribute}=")
+      false
+    else
+      object.send("#{attribute}=", nil)
+      !object.valid? && object.errors[attribute].any?
+    end
+  end
+end
+
+RSpec::Matchers.define :validate_length_of do |attribute, options|
+  if options.has_key? :within
+    min = options[:within].first
+    max = options[:within].last
+  elsif options.has_key? :is
+    min = options[:is]
+    max = min
+  elsif options.has_key? :minimum
+    min = options[:minimum]
+  elsif options.has_key? :maximum
+    max = options[:maximum]
+  end
+
+  invalid = false
+  if !min.nil? && min >= 1
+    object.send("#{attribute}=", 'a' * (min - 1))
+    invalid = !object.valid? && object.errors[attribute].any?
+  end
+
+  if !max.nil?
+    object.send("#{attribute}=", 'a' * (max + 1))
+    invalid ||= !object.valid? && object.errors[attribute].any?
+  end
+
+  invalid
+end
+
+RSpec::Matchers.define :validate_uniqueness_of do |attribute|
+  match do |object|
+    object.class.stub!(:with_exclusive_scope).and_return([object])
+    !object.valid? && object.errors[attribute].any?
+  end
+end
+
+RSpec::Matchers.define :validate_confirmation_of do |attribute|
+  match do |object|
+    object.send("#{attribute}_confirmation=", 'asdf')
+    !object.valid? && object.errors[attribute].any?
+  end
+end
+
+RSpec::Matchers.define :validate_inclusion_of do |attribute, options|
+  match do |object|
+    values = options[:in]
+    booleans = assign_and_validate_values(object, attribute, values)
+    booleans.all?
+  end
+end
+
+RSpec::Matchers.define :validate_boolean_of do |attribute, options|
+  match do |object|
+    values = [true, false]
+
+    booleans = values.map do |value|
+      object.send("#{attribute}=", value)
+      object.valid?
+      object.errors[attribute].empty?
+    end
+
+    object.send("#{attribute}=", nil)
+    object.valid?
+    booleans << object.errors[attribute].any?
+
+    booleans.all?
+  end
+end
+
+
+module RSpec
+  module Matchers
+
+  private
+    def assign_and_validate_value(model, attribute, value)
+      model.send("#{attribute}=", value)
+      model.valid?
+      model.errors[attribute].empty?
+    end
+
+    def assign_and_validate_values(model, attribute, values)
+      values.map do |value|
+        assign_and_validate_value(model, attribute, value)
+      end
+    end
+  end
+end

data/lib/rspec_on_rails_matchers/version.rb

@@ -0,0 +1,3 @@
+module RspecOnRailsMatchers
+  VERSION = "1.0.0"
+end

data/lib/rspec_on_rails_matchers/views.rb

@@ -0,0 +1,96 @@
+RSpec::Matchers.define :have_form_posting_to do |url_or_path|
+ match do |response|
+   have_tag("form[method=post][action=#{url_or_path}]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :have_form_puting_to do |url_or_path|
+ match do |response|
+   have_tag("form[method=post][action=#{url_or_path}/#{id}]").matches?(response)
+   have_tag("input[name=_method][type=hidden][value=put]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :have_label_for do |attribute|
+ match do |response|
+   have_tag("label[for=#{attribute}]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :with_label_for do |attribute|
+ match do |response|
+   with_tag("label[for=#{attribute}]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :have_text_field_for do |attribute|
+ match do |response|
+   have_tag("input##{attribute}[type=text]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :with_text_field_for do |attribute|
+ match do |response|
+   with_tag("input##{attribute}[type=text]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :have_text_area_for do |attribute|
+ match do |response|
+   have_tag("textarea##{attribute}[type=text]").matches?(response)
+ end
+end
+
+RSpec::Matchers.define :with_text_area_for do |attribute|
+  match do |response|
+    with_tag("textarea##{attribute}[type=text]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :have_password_field_for do |attribute|
+  match do |response|
+    have_tag("input##{attribute}[type=password]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :with_password_field_for do |attribute|
+  match do |response|
+    with_tag("input##{attribute}[type=password]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :have_checkbox_for do |attribute|
+  match do |response|
+    have_tag("input##{attribute}[type=checkbox]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :with_checkbox_for do |attribute|
+  match do |response|
+    with_tag("input##{attribute}[type=checkbox]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :have_submit_button do |attribute|
+  match do |response|
+    have_tag("input[type=submit]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :with_submit_button do |attribute|
+  match do |response|
+    with_tag("input[type=submit]").matches?(response)
+  end
+end
+
+RSpec::Matchers.define :have_link_to do |url_or_path|
+  match do |response|
+    have_tag("a[href=#{url_or_path}]", text).matches?(response)
+  end
+end
+
+RSpec::Matchers.define :with_link_to do |url_or_path|
+  match do |response|
+    with_tag("a[href=#{url_or_path}]", text).matches?(response)
+  end
+end

data/rspec-on-rails-matchers.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rspec_on_rails_matchers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-on-rails-matchers"
+  s.version     = RspecOnRailsMatchers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Taylor", "Stephen Schor", "Josh Knowles"]
+  s.email       = ["scott@railsnewbie.com", "stephen@eastmedia.com"]
+  s.homepage    = "http://github.com/smtlaissezfaire/rspec-on-rails-matchers"
+  s.summary     = %q{Rspec on rails matchers}
+  s.description = %q{Josh Knowles rspec-on-rails-matchers, upgraded for Rails 3+.}
+
+  s.add_development_dependency "rspec"
+
+  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/spec/rspec-on-rails-matchers/associations_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe "RSpec::Matchers" do
+  describe "belongs_to" do
+    describe Comment do
+      it { should belong_to(:post) }
+      it { should_not belong_to(:foobar) }
+    end
+  end
+
+  describe "valid associations" do
+    describe Comment do
+      it { should have_valid_associations }
+    end
+
+    describe Image do
+      it { should have_valid_associations }
+    end
+
+    describe Post do
+      it { should have_valid_associations }
+    end
+
+    describe Boolean do
+      it { should have_valid_associations }
+    end
+
+    describe InvalidAssociationClass do
+      it { should_not have_valid_associations }
+
+      it "should use the failed association name in the failure message" do
+        lambda {
+          subject.should have_valid_associations
+        }.should raise_error(RSpec::Expectations::ExpectationNotMetError, 'invalid or nonexistent association "foos" on InvalidAssociationClass')
+      end
+    end
+  end
+end

data/spec/rspec-on-rails-matchers/validations_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe RSpec::Matchers, "validations" do
+  before do
+    @example = self
+  end
+
+  describe "validates_presence_of" do
+    before do
+      @comment = Comment.new
+    end
+
+    it "should match if the object has a validates_presence_of" do
+      @example.validate_presence_of(:post).matches?(@comment).should be_true
+    end
+
+    it "should not match if the object does not have the association" do
+      @example.validate_presence_of(:an_attr_accessor).matches?(@comment).should be_false
+    end
+
+    it "should not match if the object does not respond to the method" do
+      @example.validate_presence_of(:foobar).matches?(@comment).should be_false
+    end
+  end
+
+  describe "validate_inclusion_of" do
+    before do
+      @boolean = Boolean.new
+    end
+
+    it "should be true if it is the same list" do
+      matcher = @example.validate_inclusion_of(:null_not_allowable, :in => [true, false])
+      matcher.matches?(@boolean).should be_true
+    end
+
+    it "should not be true if one of the values is not true" do
+      @example.validate_inclusion_of(:null_not_allowable, :in => [nil]).matches?(@boolean).should be_false
+    end
+  end
+
+  describe "validate_boolean_of" do
+    before do
+      @boolean = Boolean.new
+    end
+
+    it "should be true if it is valid when [true, false]" do
+      matcher = @example.validate_boolean_of(:null_not_allowable)
+      matcher.matches?(@boolean).should be_true
+    end
+
+    it "should not be true if it allows a nil" do
+      matcher = @example.validate_boolean_of(:null_allowable)
+      matcher.matches?(@boolean).should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'active_record'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/rspec_on_rails_matchers")
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database  => ':memory:'
+ActiveRecord::Migration.verbose = true
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  belongs_to :commentable, :polymorphic => true
+
+  validates_presence_of :post
+
+  attr_accessor :an_attr_accessor
+end
+
+class Image < ActiveRecord::Base
+  has_one :comment, :as => :commentable
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Boolean < ActiveRecord::Base
+  validates_inclusion_of :null_not_allowable, :in => [true, false]
+end
+
+class InvalidAssociationClass < ActiveRecord::Base
+  set_table_name "invalid_association"
+
+  has_many :foos
+end
+
+ActiveRecord::Schema.define do
+  create_table :booleans do |t|
+    t.boolean :null_allowable
+    t.boolean :null_not_allowable
+  end
+
+  create_table :posts do |t|
+    t.string :name
+  end
+
+  create_table :comments do |t|
+    t.string  :text
+    t.integer :post_id
+    t.integer :commentable_id
+    t.string  :commentable_type
+  end
+
+  create_table :images do |t|
+    t.string :image_id
+  end
+
+  create_table :invalid_association, :force => true do |t|
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-on-rails-matchers
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Scott Taylor
+- Stephen Schor
+- Josh Knowles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Josh Knowles rspec-on-rails-matchers, upgraded for Rails 3+.
+email: 
+- scott@railsnewbie.com
+- stephen@eastmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- TODO
+- lib/rspec_on_rails_matchers.rb
+- lib/rspec_on_rails_matchers/associations.rb
+- lib/rspec_on_rails_matchers/observers.rb
+- lib/rspec_on_rails_matchers/validations.rb
+- lib/rspec_on_rails_matchers/version.rb
+- lib/rspec_on_rails_matchers/views.rb
+- rspec-on-rails-matchers.gemspec
+- spec/rspec-on-rails-matchers/associations_spec.rb
+- spec/rspec-on-rails-matchers/validations_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/smtlaissezfaire/rspec-on-rails-matchers
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rspec on rails matchers
+test_files: 
+- spec/rspec-on-rails-matchers/associations_spec.rb
+- spec/rspec-on-rails-matchers/validations_spec.rb
+- spec/spec_helper.rb