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
125
126
127
128
129
130
131
132
|
require 'spec/runner/formatter'
require 'spec/runner/context'
require 'spec/runner/context_eval'
require 'spec/runner/specification'
require 'spec/runner/execution_context'
require 'spec/runner/context_runner'
require 'spec/runner/option_parser'
require 'spec/runner/command_line'
require 'spec/runner/drb_command_line'
require 'spec/runner/backtrace_tweaker'
require 'spec/runner/reporter'
require 'spec/runner/spec_matcher'
require 'spec/runner/extensions/object'
require 'spec/runner/extensions/kernel'
require 'spec/runner/spec_should_raise_handler'
require 'spec/runner/spec_parser'
module Spec
# == Contexts and Specifications
#
# Rather than expressing examples in classes, RSpec uses a custom domain specific language to express
# examples using contexts and specifications.
#
# A context is the equivalent of a fixture in xUnit-speak. It is a metaphor for the context
# in which you will run your executable example - a set of known objects in a known starting state.
#
# context "A new account" do
#
# setup do
# @account = Account.new
# end
#
# specify "should have a balance of $0" do
# @account.balance.should_eql Money.new(0, :dollars)
# end
#
# end
#
# We use the setup block to set up the context (given), and then the specify method to
# hold the example code that expresses the event (when) and the expected outcome (then).
#
# == Helper Methods
#
# A primary goal of RSpec is to keep the examples clear. We therefore prefer
# less indirection than you might see in xUnit examples and in well factored, DRY production code. We feel
# that duplication is OK if removing it makes it harder to understand an example without
# having to look elsewhere to understand its context.
#
# That said, RSpec does support some level of encapsulating common code in helper
# methods that can exist within a context or within an included module.
#
# == Setup and Teardown
#
# You can use setup, teardown, context_setup and context_teardown within a context:
#
# context "..." do
# context_setup do
# ...
# end
#
# setup do
# ...
# end
#
# specify "number one" do
# ...
# end
#
# specify "number two" do
# ...
# end
#
# teardown do
# ...
# end
#
# context_teardown do
# ...
# end
#
# end
#
# The <tt>setup</tt> block will run before each of the specs, once for each spec. Likewise,
# the <tt>teardown</tt> block will run after each of the specs.
#
# It is also possible to specify a <tt>context_setup</tt> and <tt>context_teardown</tt>
# block that will run only once for each context, respectively before the first <code>setup</code>
# and after the last <code>teardown</code>. The use of these is generally discouraged, because it
# introduces dependencies between the specs. Still, it might prove useful for very expensive operations
# if you know what you are doing.
#
# == Local helper methods
#
# You can include local helper methods by simply expressing them within a context:
#
# context "..." do
#
# specify "..." do
# helper_method
# end
#
# def helper_method
# ...
# end
#
# end
#
# == Included helper methods
#
# You can include helper methods in multiple contexts by expressing them within
# a module, and then including that module in your context:
#
# module AccountExampleHelperMethods
# def helper_method
# ...
# end
# end
#
# context "A new account" do
# include AccountExampleHelperMethods
# setup do
# @account = Account.new
# end
#
# specify "should have a balance of $0" do
# helper_method
# @account.balance.should eql(Money.new(0, :dollars))
# end
# end
module Runner
end
end
|
