forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBasicObject.html
208 lines (208 loc) · 7.45 KB
/
BasicObject.html
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: BasicObject
— Documentation by YARD 0.9.27
</title>
<link rel="stylesheet" href="/documentation/3.11/rspec-expectations/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.11/rspec-expectations/css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "BasicObject";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/3.11/rspec-expectations/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/3.11/rspec-expectations/js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (B)</a> »
<span class="title">BasicObject</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: BasicObject
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/expectations/syntax.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The legacy <code>:should</code> syntax adds the following methods directly to
<code>BasicObject</code> so that they are available off of any object. Note, however,
that this syntax does not always play nice with delegate/proxy objects.
We recommend you use the non-monkeypatching <code>:expect</code> syntax instead.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#should-instance_method" title="#should (instance method)">#<strong>should</strong>(matcher, message) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if <code>matcher</code> returns true.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#should_not-instance_method" title="#should_not (instance method)">#<strong>should_not</strong>(matcher, message) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if <code>matcher</code> returns false.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="should-instance_method">
#<strong>should</strong>(matcher, message) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is only available when you have enabled the <code>:should</code> syntax.</p>
</div>
</div>
<p>Passes if <code>matcher</code> returns true. Available on every <code>Object</code>.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='id identifier rubyid_actual'>actual</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_eq'>eq</span> <span class='id identifier rubyid_expected'>expected</span>
<span class='id identifier rubyid_actual'>actual</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_match'>match</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>expression</span><span class='regexp_end'>/</span></span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>matcher</span>
<span class='type'>(<tt>Matcher</tt>)</span>
</li>
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>optional message to display when the expectation fails</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if the expectation succeeds (else raises)</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="RSpec/Matchers.html" title="RSpec::Matchers (module)">RSpec::Matchers</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/expectations/syntax.rb', line 109</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="should_not-instance_method">
#<strong>should_not</strong>(matcher, message) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is only available when you have enabled the <code>:should</code> syntax.</p>
</div>
</div>
<p>Passes if <code>matcher</code> returns false. Available on every <code>Object</code>.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='id identifier rubyid_actual'>actual</span><span class='period'>.</span><span class='id identifier rubyid_should_not'>should_not</span> <span class='id identifier rubyid_eq'>eq</span> <span class='id identifier rubyid_expected'>expected</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>matcher</span>
<span class='type'>(<tt>Matcher</tt>)</span>
</li>
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>optional message to display when the expectation fails</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>false if the negative expectation succeeds (else raises)</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="RSpec/Matchers.html" title="RSpec::Matchers (module)">RSpec::Matchers</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/expectations/syntax.rb', line 121</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon May 9 21:01:12 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-2.7.5).
</div>
</div>
</body>
</html>