forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathViewAssigns.html
164 lines (164 loc) · 7.06 KB
/
ViewAssigns.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: RSpec::Rails::ViewAssigns
— Documentation by YARD 0.8.7.3
</title>
<link rel="stylesheet" href="/stylesheets/docs/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/stylesheets/docs/common.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/stylesheets/docs/rspec.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="/javascripts/docs/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/javascripts/docs/app.js"></script>
</head>
<body>
<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">ViewAssigns</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: RSpec::Rails::ViewAssigns
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="HelperExampleGroup.html" title="RSpec::Rails::HelperExampleGroup (module)">HelperExampleGroup</a></span>, <span class='object_link'><a href="ViewExampleGroup.html" title="RSpec::Rails::ViewExampleGroup (module)">ViewExampleGroup</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/rspec/rails/view_assigns.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Helpers for making instance variables available to views.</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="#assign-instance_method" title="#assign (instance method)">- (Object) <strong>assign</strong>(key, value) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Assigns a value to an instance variable in the scope of the view being rendered.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#view_assigns-instance_method" title="#view_assigns (instance method)">- (Object) <strong>view_assigns</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Compat-shim for AbstractController::Rendering#view_assigns.</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="assign-instance_method">
- (<tt>Object</tt>) <strong>assign</strong>(key, value)
</h3><div class="docstring">
<div class="discussion">
<p>Assigns a value to an instance variable in the scope of the
view being rendered.</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_assign'>assign</span><span class='lparen'>(</span><span class='symbol'>:widget</span><span class='comma'>,</span> <span class='id identifier rubyid_stub_model'>stub_model</span><span class='lparen'>(</span><span class='const'>Widget</span><span class='rparen'>)</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/view_assigns.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid__encapsulated_assigns'>_encapsulated_assigns</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="view_assigns-instance_method">
- (<tt>Object</tt>) <strong>view_assigns</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Compat-shim for AbstractController::Rendering#view_assigns</p>
<p>_assigns was deprecated in favor of view_assigns after
Rails-3.0.0 was released. Since we are not able to predict when
the _assigns/view_assigns patch will be released (I thought it
would have been in 3.0.1, but 3.0.1 bypassed this change for a
security fix), this bit ensures that we do the right thing without
knowing anything about the Rails version we are dealing with.</p>
<p>Once that change <em>is</em> released, this can be changed to something
that checks for the Rails version when the module is being
interpreted, as it was before commit dd0095.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/view_assigns.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_view_assigns'>view_assigns</span>
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid__encapsulated_assigns'>_encapsulated_assigns</span><span class='rparen'>)</span>
<span class='kw'>rescue</span>
<span class='id identifier rubyid__assigns'>_assigns</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jan 29 13:56:23 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.3 (ruby-2.1.5).
</div>
</body>
</html>