-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathControllerExampleGroup.html
271 lines (271 loc) · 14.1 KB
/
ControllerExampleGroup.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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::ControllerExampleGroup
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::ControllerExampleGroup";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/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 (C)</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="../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span>
»
<span class="title">ControllerExampleGroup</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>Module: RSpec::Rails::ControllerExampleGroup
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>ActionController::TestCase::Behavior, AssertionDelegator.new(
ActionDispatch::Assertions::RoutingAssertions
), <span class='object_link'><a href="Matchers/RedirectTo.html" title="RSpec::Rails::Matchers::RedirectTo (module)">Matchers::RedirectTo</a></span>, <span class='object_link'><a href="Matchers/RenderTemplate.html" title="RSpec::Rails::Matchers::RenderTemplate (module)">Matchers::RenderTemplate</a></span>, <span class='object_link'><a href="Matchers/RoutingMatchers.html" title="RSpec::Rails::Matchers::RoutingMatchers (module)">Matchers::RoutingMatchers</a></span>, <span class='object_link'><a href="RailsExampleGroup.html" title="RSpec::Rails::RailsExampleGroup (module)">RailsExampleGroup</a></span>, <span class='object_link'><a href="ViewRendering.html" title="RSpec::Rails::ViewRendering (module)">ViewRendering</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/example/controller_example_group.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Container module for controller spec functionality.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="ControllerExampleGroup/ClassMethods.html" title="RSpec::Rails::ControllerExampleGroup::ClassMethods (module)">ClassMethods</a></span>
</p>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#controller-instance_method" title="#controller (instance method)">#<strong>controller</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the controller object instance under test.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#routes-instance_method" title="#routes (instance method)">#<strong>routes</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the Rails routes used for the spec.</p>
</div></span>
</li>
</ul>
<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="#bypass_rescue-instance_method" title="#bypass_rescue (instance method)">#<strong>bypass_rescue</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Extends the controller with a module that overrides <code>rescue_with_handler</code> to raise the exception passed to it.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#method_missing-instance_method" title="#method_missing (instance method)">#<strong>method_missing</strong>(method, *args, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>If method is a named_route, delegates to the RouteSet associated with this controller.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Matchers/RoutingMatchers.html" title="RSpec::Rails::Matchers::RoutingMatchers (module)">Matchers::RoutingMatchers</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Matchers/RoutingMatchers.html#be_routable-instance_method" title="RSpec::Rails::Matchers::RoutingMatchers#be_routable (method)">#be_routable</a></span>, <span class='object_link'><a href="Matchers/RoutingMatchers.html#route_to-instance_method" title="RSpec::Rails::Matchers::RoutingMatchers#route_to (method)">#route_to</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Matchers/RenderTemplate.html" title="RSpec::Rails::Matchers::RenderTemplate (module)">Matchers::RenderTemplate</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Matchers/RenderTemplate.html#have_rendered-instance_method" title="RSpec::Rails::Matchers::RenderTemplate#have_rendered (method)">#have_rendered</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Matchers/RedirectTo.html" title="RSpec::Rails::Matchers::RedirectTo (module)">Matchers::RedirectTo</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Matchers/RedirectTo.html#redirect_to-instance_method" title="RSpec::Rails::Matchers::RedirectTo#redirect_to (method)">#redirect_to</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ViewRendering.html" title="RSpec::Rails::ViewRendering (module)">ViewRendering</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ViewRendering.html#render_views%3F-instance_method" title="RSpec::Rails::ViewRendering#render_views? (method)">#render_views?</a></span></p>
<div id="method_missing_details" class="method_details_list">
<h2>Dynamic Method Handling</h2>
<p class="notice this">
This class handles dynamic methods through the <tt>method_missing</tt> method
</p>
<div class="method_details first">
<h3 class="signature first" id="method_missing-instance_method">
#<strong>method_missing</strong>(method, *args, &block) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>If method is a named_route, delegates to the RouteSet associated with
this controller.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
172
173
174
175
176
177
178</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/controller_example_group.rb', line 172</span>
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_route_available?'>route_available?</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
<span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='kw'>super</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="controller-instance_method">
#<strong>controller</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the controller object instance under test.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
128
129
130</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/controller_example_group.rb', line 128</span>
<span class='kw'>def</span> <span class='id identifier rubyid_controller'>controller</span>
<span class='ivar'>@controller</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="routes=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="routes-instance_method">
#<strong>routes</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the Rails routes used for the spec.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
132
133
134</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/controller_example_group.rb', line 132</span>
<span class='kw'>def</span> <span class='id identifier rubyid_routes'>routes</span>
<span class='ivar'>@routes</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="bypass_rescue-instance_method">
#<strong>bypass_rescue</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Extends the controller with a module that overrides
<code>rescue_with_handler</code> to raise the exception passed to it. Use this to
specify that an action <em>should</em> raise an exception given appropriate
conditions.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_describe'>describe</span> <span class='const'>ProfilesController</span> <span class='kw'>do</span>
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>raises a 403 when a non-admin user tries to view another user's profile</span><span class='tstring_end'>"</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='id identifier rubyid_create_profile'>create_profile</span>
<span class='id identifier rubyid_login_as'>login_as</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='kw'>do</span>
<span class='id identifier rubyid_bypass_rescue'>bypass_rescue</span>
<span class='id identifier rubyid_get'>get</span> <span class='symbol'>:show</span><span class='comma'>,</span> <span class='label'>id:</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>+</span> <span class='int'>1</span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>403 Forbidden</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
166
167
168</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/controller_example_group.rb', line 166</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bypass_rescue'>bypass_rescue</span>
<span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span><span class='lparen'>(</span><span class='const'>BypassRescue</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Oct 9 21:42:10 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
</html>