-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathArgumentListMatcher.html
241 lines (241 loc) · 16.6 KB
/
ArgumentListMatcher.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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Mocks::ArgumentListMatcher
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-mocks/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-mocks/css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Mocks::ArgumentListMatcher";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/3.13/rspec-mocks/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/3.13/rspec-mocks/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 (A)</a> »
<span class='title'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span> » <span class='title'><span class='object_link'><a href="../Mocks.html" title="RSpec::Mocks (module)">Mocks</a></span></span>
»
<span class="title">ArgumentListMatcher</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: RSpec::Mocks::ArgumentListMatcher
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RSpec::Mocks::ArgumentListMatcher</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/mocks/argument_list_matcher.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Wrapper for matching arguments against a list of expected values. Used by
the <code>with</code> method on a <code>MessageExpectation</code>:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_expect'><span class='object_link'><a href="ExampleMethods.html#expect-instance_method" title="RSpec::Mocks::ExampleMethods#expect (method)">expect</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_receive'><span class='object_link'><a href="ExampleMethods.html#receive-instance_method" title="RSpec::Mocks::ExampleMethods#receive (method)">receive</a></span></span><span class='lparen'>(</span><span class='symbol'>:message</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='symbol'>:a</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>b</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</span>
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='lparen'>(</span><span class='symbol'>:a</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>b</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</span>
</code></pre>
<p>Values passed to <code>with</code> can be literal values or argument matchers that
match against the real objects .e.g.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_expect'><span class='object_link'><a href="ExampleMethods.html#expect-instance_method" title="RSpec::Mocks::ExampleMethods#expect (method)">expect</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_receive'><span class='object_link'><a href="ExampleMethods.html#receive-instance_method" title="RSpec::Mocks::ExampleMethods#receive (method)">receive</a></span></span><span class='lparen'>(</span><span class='symbol'>:message</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='id identifier rubyid_hash_including'><span class='object_link'><a href="ArgumentMatchers.html#hash_including-instance_method" title="RSpec::Mocks::ArgumentMatchers#hash_including (method)">hash_including</a></span></span><span class='lparen'>(</span><span class='symbol'>:a</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>b</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
</code></pre>
<p>Can also be used directly to match the contents of any <code>Array</code>. This
enables 3rd party mocking libs to take advantage of rspec's argument
matching without using the rest of rspec-mocks.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rspec/mocks/argument_list_matcher</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Mocks.html" title="RSpec::Mocks (module)">Mocks</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ArgumentMatchers.html" title="RSpec::Mocks::ArgumentMatchers (module)">ArgumentMatchers</a></span></span>
<span class='id identifier rubyid_arg_list_matcher'>arg_list_matcher</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Mocks.html" title="RSpec::Mocks (module)">Mocks</a></span></span><span class='op'>::</span><span class='const'>ArgumentListMatcher</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RSpec::Mocks::ArgumentListMatcher#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='int'>123</span><span class='comma'>,</span> <span class='id identifier rubyid_hash_including'><span class='object_link'><a href="ArgumentMatchers.html#hash_including-instance_method" title="RSpec::Mocks::ArgumentMatchers#hash_including (method)">hash_including</a></span></span><span class='lparen'>(</span><span class='symbol'>:a</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>b</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_arg_list_matcher'>arg_list_matcher</span><span class='period'>.</span><span class='id identifier rubyid_args_match?'>args_match?</span><span class='lparen'>(</span><span class='int'>123</span><span class='comma'>,</span> <span class='symbol'>:a</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>b</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
</code></pre>
<p>This class is immutable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="ArgumentMatchers.html" title="RSpec::Mocks::ArgumentMatchers (module)">ArgumentMatchers</a></span></li>
</ul>
</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="#args_match%3F-instance_method" title="#args_match? (instance method)">#<strong>args_match?</strong>(*actual_args) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Matches each element in the <code>expected_args</code> against the element in the same position of the arguments passed to <code>new</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(*expected_args) ⇒ ArgumentListMatcher </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initializes an <code>ArgumentListMatcher</code> with a collection of literal values and/or argument matchers.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(*expected_args) ⇒ <tt><span class='object_link'><a href="" title="RSpec::Mocks::ArgumentListMatcher (class)">ArgumentListMatcher</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes an <code>ArgumentListMatcher</code> with a collection of literal
values and/or argument matchers.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>expected_args</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>a list of expected literals and/or argument matchers</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="ArgumentMatchers.html" title="RSpec::Mocks::ArgumentMatchers (module)">RSpec::Mocks::ArgumentMatchers</a></span></li>
<li><span class='object_link'><a href="#args_match%3F-instance_method" title="RSpec::Mocks::ArgumentListMatcher#args_match? (method)">#args_match?</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/mocks/argument_list_matcher.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_expected_args'>expected_args</span><span class='rparen'>)</span>
<span class='ivar'>@expected_args</span> <span class='op'>=</span> <span class='id identifier rubyid_expected_args'>expected_args</span>
<span class='id identifier rubyid_ensure_expected_args_valid!'>ensure_expected_args_valid!</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="args_match?-instance_method">
#<strong>args_match?</strong>(*actual_args) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Matches each element in the <code>expected_args</code> against the element in the same
position of the arguments passed to <code>new</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>actual_args</span>
<span class='type'>(<tt>Array</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#initialize-instance_method" title="RSpec::Mocks::ArgumentListMatcher#initialize (method)">#initialize</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/mocks/argument_list_matcher.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_args_match?'>args_match?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_actual_args'>actual_args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expected_args'>expected_args</span> <span class='op'>=</span> <span class='id identifier rubyid_resolve_expected_args_based_on'>resolve_expected_args_based_on</span><span class='lparen'>(</span><span class='id identifier rubyid_actual_args'>actual_args</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_expected_args'>expected_args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>!=</span> <span class='id identifier rubyid_actual_args'>actual_args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
<span class='kw'>if</span> <span class='const'>RUBY_VERSION</span> <span class='op'>>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>3</span><span class='tstring_end'>"</span></span>
<span class='comment'># If the expectation was set with keywords, while the actual method was called with a positional hash argument, they don't match.
</span> <span class='comment'># If the expectation was set without keywords, e.g., with({a: 1}), then it fine to call it with either foo(a: 1) or foo({a: 1}).
</span> <span class='comment'># This corresponds to Ruby semantics, as if the method was def foo(options).
</span> <span class='kw'>if</span> <span class='const'>Hash</span> <span class='op'>===</span> <span class='id identifier rubyid_expected_args'>expected_args</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span> <span class='op'>&&</span> <span class='const'>Hash</span> <span class='op'>===</span> <span class='id identifier rubyid_actual_args'>actual_args</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_ruby2_keywords_hash?'>ruby2_keywords_hash?</span><span class='lparen'>(</span><span class='id identifier rubyid_actual_args'>actual_args</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_ruby2_keywords_hash?'>ruby2_keywords_hash?</span><span class='lparen'>(</span><span class='id identifier rubyid_expected_args'>expected_args</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='const'>Support</span><span class='op'>::</span><span class='const'>FuzzyMatcher</span><span class='period'>.</span><span class='id identifier rubyid_values_match?'>values_match?</span><span class='lparen'>(</span><span class='id identifier rubyid_expected_args'>expected_args</span><span class='comma'>,</span> <span class='id identifier rubyid_actual_args'>actual_args</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Sep 4 15:23:12 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.2.2).
</div>
</div>
</body>
</html>