forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathViewSpecMethods.html
214 lines (214 loc) · 10.5 KB
/
ViewSpecMethods.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::ViewSpecMethods
— Documentation by YARD 0.9.24
</title>
<link rel="stylesheet" href="/documentation/4.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/4.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/4.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::ViewSpecMethods";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/4.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/4.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 (V)</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">ViewSpecMethods</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::ViewSpecMethods
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/view_spec_methods.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Adds methods (generally to ActionView::TestCase::TestController).
Intended for use in view specs.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#add_to-class_method" title="add_to (class method)">.<strong>add_to</strong>(klass) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Adds methods <code>extra_params=</code> and <code>extra_params</code> to the indicated class.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_from-class_method" title="remove_from (class method)">.<strong>remove_from</strong>(klass) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Removes methods <code>extra_params=</code> and <code>extra_params</code> from the indicated class.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="add_to-class_method">
.<strong>add_to</strong>(klass) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Adds methods <code>extra_params=</code> and <code>extra_params</code> to the indicated class.
When class is <code>::ActionView::TestCase::TestController</code>, these methods
are exposed in view specs on the <code>controller</code> object.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
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</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/view_spec_methods.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_add_to'>add_to</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_method_defined?'>method_defined?</span><span class='lparen'>(</span><span class='symbol'>:extra_params</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_method_defined?'>method_defined?</span><span class='lparen'>(</span><span class='symbol'>:extra_params=</span><span class='rparen'>)</span>
<span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_module_exec'>module_exec</span> <span class='kw'>do</span>
<span class='comment'># Set any extra parameters that rendering a URL for this view
</span> <span class='comment'># would require.
</span> <span class='comment'>#
</span> <span class='comment'># @example
</span> <span class='comment'>#
</span> <span class='comment'># # In "spec/views/widgets/show.html.erb_spec.rb":
</span> <span class='comment'># before do
</span> <span class='comment'># widget = Widget.create!(:name => "slicer")
</span> <span class='comment'># controller.extra_params = { :id => widget.id }
</span> <span class='comment'># end
</span> <span class='kw'>def</span> <span class='id identifier rubyid_extra_params='>extra_params=</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='ivar'>@extra_params</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span>
<span class='const'><span class='object_link'><a href="ViewPathBuilder.html" title="RSpec::Rails::ViewPathBuilder (class)">ViewPathBuilder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ViewPathBuilder.html#initialize-instance_method" title="RSpec::Rails::ViewPathBuilder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_path_for'><span class='object_link'><a href="ViewPathBuilder.html#path_for-instance_method" title="RSpec::Rails::ViewPathBuilder#path_for (method)">path_for</a></span></span><span class='lparen'>(</span>
<span class='id identifier rubyid_extra_params'>extra_params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path_parameters'>path_parameters</span><span class='rparen'>)</span>
<span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Use to read extra parameters that are set in the view spec.
</span> <span class='comment'>#
</span> <span class='comment'># @example
</span> <span class='comment'>#
</span> <span class='comment'># # After the before in the above example:
</span> <span class='comment'># controller.extra_params
</span> <span class='comment'># # => { :id => 4 }
</span> <span class='kw'>def</span> <span class='id identifier rubyid_extra_params'>extra_params</span>
<span class='ivar'>@extra_params</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@extra_params</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="remove_from-class_method">
.<strong>remove_from</strong>(klass) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Removes methods <code>extra_params=</code> and <code>extra_params</code> from the indicated class.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/view_spec_methods.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove_from'>remove_from</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
<span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_module_exec'>module_exec</span> <span class='kw'>do</span>
<span class='kw'>undef</span> <span class='id identifier rubyid_extra_params='>extra_params=</span> <span class='kw'>if</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_method_defined?'>method_defined?</span><span class='lparen'>(</span><span class='symbol'>:extra_params=</span><span class='rparen'>)</span>
<span class='kw'>undef</span> <span class='id identifier rubyid_extra_params'>extra_params</span> <span class='kw'>if</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_method_defined?'>method_defined?</span><span class='lparen'>(</span><span class='symbol'>:extra_params</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Apr 8 23:32:17 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.6.3).
</div>
</div>
</body>
</html>