forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathViewPathBuilder.html
173 lines (173 loc) · 9.66 KB
/
ViewPathBuilder.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Rails::ViewPathBuilder
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="/documentation/6.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/6.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/6.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::ViewPathBuilder";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/6.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/6.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">ViewPathBuilder</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::Rails::ViewPathBuilder
</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::Rails::ViewPathBuilder</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/view_path_builder.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Builds paths for view specs using a particular route set.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(route_set) ⇒ ViewPathBuilder </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of ViewPathBuilder.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#path_for-instance_method" title="#path_for (instance method)">#<strong>path_for</strong>(path_params) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Given a hash of parameters, build a view path, if possible.</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>(route_set) ⇒ <tt><span class='object_link'><a href="" title="RSpec::Rails::ViewPathBuilder (class)">ViewPathBuilder</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ViewPathBuilder.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/view_path_builder.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_route_set'>route_set</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:include</span><span class='comma'>,</span> <span class='id identifier rubyid_route_set'>route_set</span><span class='period'>.</span><span class='id identifier rubyid_url_helpers'>url_helpers</span><span class='rparen'>)</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="path_for-instance_method">
#<strong>path_for</strong>(path_params) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Given a hash of parameters, build a view path, if possible.
Returns nil if no path can be built from the given params.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='comment'># path can be built because all required params are present in the hash
</span><span class='id identifier rubyid_view_path_builder'>view_path_builder</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" 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="#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='id identifier rubyid_view_path_builder'>view_path_builder</span><span class='period'>.</span><span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='symbol'>:controller</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>posts</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:action</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>show</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>54</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='comment'># => "/post/54"</span></code></pre>
<pre class="example code"><code><span class='comment'># path cannot be built because the params are missing a required element (:id)
</span><span class='id identifier rubyid_view_path_builder'>view_path_builder</span><span class='period'>.</span><span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='symbol'>:controller</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>posts</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:action</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>delete</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='comment'># => ActionController::UrlGenerationError: No route matches {:action=>"delete", :controller=>"posts"}</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/view_path_builder.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_path_for'>path_for</span><span class='lparen'>(</span><span class='id identifier rubyid_path_params'>path_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_url_for'>url_for</span><span class='lparen'>(</span><span class='id identifier rubyid_path_params'>path_params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>only_path:</span> <span class='kw'>true</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Mar 17 10:26:36 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
</div>
</body>
</html>