public
Rubygem
Description: Makes tests easy on the fingers and the eyes
Homepage: http://www.thoughtbot.com/projects/shoulda
Clone URL: git://github.com/thoughtbot/shoulda.git
tsaleh (author)
Sat Apr 26 14:42:14 -0700 2008
commit  28d9140a7ea45f9a305b251a544ead425fcd58e4
tree    f2dd24073247c9ccd8572e4d778c39247bcdad55
parent  102fe37adc9a9b2c23132791bf16c0ff13553b3b
shoulda / README
100644 124 lines (86 sloc) 3.876 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
= Shoulda - Making tests easy on the fingers and eyes
 
Shoulda makes it easy to write elegant, understandable, and maintainable tests. Shoulda consists of test macros, assertions, and helpers added on to the Test::Unit framework. It's fully compatible with your existing tests, and requires no retooling to use.
 
Helpers:: #context and #should give you rSpec like test blocks.
          In addition, you get nested contexts and a much more readable syntax.
Macros:: Generate hundreds of lines of Controller and ActiveRecord tests with these powerful macros.
         They get you started quickly, and can help you ensure that your application is conforming to best practices.
Assertions:: Many common rails testing idioms have been distilled into a set of useful assertions.
 
= Usage
 
=== Context Helpers (ThoughtBot::Shoulda::Context)
 
Stop killing your fingers with all of those underscores... Name your tests with plain sentences!
 
  class UserTest << Test::Unit::TestCase
    context "A User instance" do
      setup do
        @user = User.find(:first)
      end
    
      should "return its full name" do
        assert_equal 'John Doe', @user.full_name
      end
    
      context "with a profile" do
        setup do
          @user.profile = Profile.find(:first)
        end
      
        should "return true when sent #has_profile?" do
          assert @user.has_profile?
        end
      end
    end
  end
 
Produces the following test methods:
 
  "test: A User instance should return its full name."
  "test: A User instance with a profile should return true when sent #has_profile?."
 
So readable!
 
=== ActiveRecord Tests (ThoughtBot::Shoulda::ActiveRecord)
 
Quick macro tests for your ActiveRecord associations and validations:
 
  class PostTest < Test::Unit::TestCase
    load_all_fixtures
 
    should_belong_to :user
    should_have_many :tags, :through => :taggings
 
    should_require_unique_attributes :title
    should_require_attributes :body, :message => /wtf/
    should_require_attributes :title
    should_only_allow_numeric_values_for :user_id
  end
 
  class UserTest < Test::Unit::TestCase
    load_all_fixtures
 
    should_have_many :posts
 
    should_not_allow_values_for :email, "blah", "b lah"
    should_allow_values_for :email, "a@b.com", "asdf@asdf.com"
    should_ensure_length_in_range :email, 1..100
    should_ensure_value_in_range :age, 1..100
    should_protect_attributes :password
  end
 
Makes TDD so much easier.
 
=== Controller Tests (ThoughtBot::Shoulda::Controller::ClassMethods)
 
Macros to test the most common controller patterns...
 
  context "on GET to :show for first record" do
    setup do
      get :show, :id => 1
    end
  
    should_assign_to :user
    should_respond_with :success
    should_render_template :show
    should_not_set_the_flash
 
    should "do something else really cool" do
      assert_equal 1, assigns(:user).id
    end
  end
 
Test entire controllers in a few lines...
 
  class PostsControllerTest < Test::Unit::TestCase
    should_be_restful do |resource|
      resource.parent = :user
 
      resource.create.params = { :title => "first post", :body => 'blah blah blah'}
      resource.update.params = { :title => "changed" }
    end
  end
 
should_be_restful generates 40 tests on the fly, for both html and xml requests.
 
=== Helpful Assertions (ThoughtBot::Shoulda::General)
 
More to come here, but have fun with what's there.
 
  load_all_fixtures
  assert_same_elements([:a, :b, :c], [:c, :a, :b])
  assert_contains(['a', '1'], /\d/)
  assert_contains(['a', '1'], 'a')
 
= Credits
 
Shoulda is maintained by {Tammer Saleh}[mailto:tsaleh@thoughtbot.com], and is funded by Thoughtbot[http://www.thoughtbot.com], inc.
 
= License
 
Shoulda is Copyright © 2006-2007 Tammer Saleh, Thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.