-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathClassMethods.html
277 lines (277 loc) · 18 KB
/
ClassMethods.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
272
273
274
275
276
277
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::ControllerExampleGroup::ClassMethods
— 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::ClassMethods";
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'><span class='object_link'><a href="../ControllerExampleGroup.html" title="RSpec::Rails::ControllerExampleGroup (module)">ControllerExampleGroup</a></span></span>
»
<span class="title">ClassMethods</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::ClassMethods
</h1>
<div class="box_info">
<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>Class-level DSL for controller specs.</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="#controller-instance_method" title="#controller (instance method)">#<strong>controller</strong>(base_class = nil, &body) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Supports a simple DSL for specifying behavior of ApplicationController.</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="summary_desc"><div class='inline'><p>Specifies the routeset that will be used for the example group.</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="controller-instance_method">
#<strong>controller</strong>(base_class = nil, &body) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>Due to Ruby 1.8 scoping rules in anonymous subclasses, constants
defined in <code>ApplicationController</code> must be fully qualified (e.g.
<code>ApplicationController::AccessDenied</code>) in the block passed to the
<code>controller</code> method. Any instance methods, filters, etc, that are
defined in <code>ApplicationController</code>, however, are accessible from
within the block.</p>
</div>
</div>
<p>Supports a simple DSL for specifying behavior of ApplicationController.
Creates an anonymous subclass of ApplicationController and evals the
<code>body</code> in that context. Also sets up implicit routes for this
controller, that are separate from those defined in "config/routes.rb".</p>
<p>If you would like to spec a subclass of ApplicationController, call
controller like so:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_controller'>controller</span><span class='lparen'>(</span><span class='const'>ApplicationControllerSubclass</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='comment'># ....
</span><span class='kw'>end</span>
</code></pre>
</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'>ApplicationController</span> <span class='kw'>do</span>
<span class='id identifier rubyid_controller'>controller</span> <span class='kw'>do</span>
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ApplicationController</span><span class='op'>::</span><span class='const'>AccessDenied</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_describe'>describe</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>handling AccessDenied exceptions</span><span class='tstring_end'>"</span></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'>redirects to the /401.html page</span><span class='tstring_end'>"</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='symbol'>:index</span>
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_redirect_to'>redirect_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/401.html</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/controller_example_group.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_controller'>controller</span><span class='lparen'>(</span><span class='id identifier rubyid_base_class'>base_class</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_infer_base_class_for_anonymous_controllers?'>infer_base_class_for_anonymous_controllers?</span>
<span class='id identifier rubyid_base_class'>base_class</span> <span class='op'>||=</span> <span class='id identifier rubyid_controller_class'>controller_class</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_base_class'>base_class</span> <span class='op'>||=</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>ApplicationController</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>ApplicationController</span> <span class='op'>:</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>Base</span>
<span class='id identifier rubyid_new_controller_class'>new_controller_class</span> <span class='op'>=</span> <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_base_class'>base_class</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_root_controller'>root_controller</span> <span class='op'>=</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>ApplicationController</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>ApplicationController</span> <span class='op'>:</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>Base</span>
<span class='kw'>if</span> <span class='id identifier rubyid_superclass'>superclass</span> <span class='op'>==</span> <span class='id identifier rubyid_root_controller'>root_controller</span> <span class='op'>||</span> <span class='id identifier rubyid_superclass'>superclass</span><span class='period'>.</span><span class='id identifier rubyid_abstract?'>abstract?</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>AnonymousController</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_superclass'>superclass</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_new_controller_class'>new_controller_class</span><span class='period'>.</span><span class='id identifier rubyid_class_exec'>class_exec</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='lparen'>(</span><span class='kw'>class</span> <span class='op'><<</span> <span class='kw'>self</span><span class='semicolon'>;</span> <span class='kw'>self</span><span class='semicolon'>;</span> <span class='kw'>end</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid___send__'>__send__</span><span class='lparen'>(</span><span class='symbol'>:define_method</span><span class='comma'>,</span> <span class='symbol'>:controller_class</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_new_controller_class'>new_controller_class</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
<span class='ivar'>@orig_routes</span> <span class='op'>=</span> <span class='id identifier rubyid_routes'>routes</span>
<span class='id identifier rubyid_resource_name'>resource_name</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='ivar'>@controller</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:controller_name</span><span class='rparen'>)</span>
<span class='ivar'>@controller</span><span class='period'>.</span><span class='id identifier rubyid_controller_name'>controller_name</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>else</span>
<span class='symbol'>:anonymous</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_resource_path'>resource_path</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='ivar'>@controller</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:controller_path</span><span class='rparen'>)</span>
<span class='ivar'>@controller</span><span class='period'>.</span><span class='id identifier rubyid_controller_path'>controller_path</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_resource_name'>resource_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_resource_module'>resource_module</span> <span class='op'>=</span> <span class='id identifier rubyid_resource_path'>resource_path</span><span class='period'>.</span><span class='id identifier rubyid_rpartition'>rpartition</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span>
<span class='id identifier rubyid_resource_as'>resource_as</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>anonymous_</span><span class='tstring_end'>'</span></span> <span class='op'>+</span> <span class='id identifier rubyid_resource_path'>resource_path</span><span class='period'>.</span><span class='id identifier rubyid_tr'>tr</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span> <span class='op'>=</span> <span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>Routing</span><span class='op'>::</span><span class='const'>RouteSet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span>
<span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_draw'>draw</span> <span class='kw'>do</span>
<span class='id identifier rubyid_resources'>resources</span> <span class='id identifier rubyid_resource_name'>resource_name</span><span class='comma'>,</span>
<span class='label'>as:</span> <span class='id identifier rubyid_resource_as'>resource_as</span><span class='comma'>,</span>
<span class='label'>module:</span> <span class='id identifier rubyid_resource_module'>resource_module</span><span class='comma'>,</span>
<span class='label'>path:</span> <span class='id identifier rubyid_resource_path'>resource_path</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_after'>after</span> <span class='kw'>do</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span> <span class='op'>=</span> <span class='ivar'>@orig_routes</span>
<span class='ivar'>@orig_routes</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<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>Specifies the routeset that will be used for the example group. This
is most useful when testing Rails engines.</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'>MyEngine</span><span class='op'>::</span><span class='const'>PostsController</span> <span class='kw'>do</span>
<span class='id identifier rubyid_routes'>routes</span> <span class='lbrace'>{</span> <span class='const'>MyEngine</span><span class='op'>::</span><span class='const'>Engine</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span> <span class='rbrace'>}</span>
<span class='comment'># ...
</span><span class='kw'>end</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
119
120
121
122
123</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/controller_example_group.rb', line 119</span>
<span class='kw'>def</span> <span class='id identifier rubyid_routes'>routes</span>
<span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span> <span class='op'>=</span> <span class='kw'>yield</span>
<span class='kw'>end</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>