-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathRoutingMatchers.html
178 lines (178 loc) · 10.2 KB
/
RoutingMatchers.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::Matchers::RoutingMatchers
— 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::Matchers::RoutingMatchers";
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 (R)</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="../Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span></span>
»
<span class="title">RoutingMatchers</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::Matchers::RoutingMatchers
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>Matchers::DSL</dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../ControllerExampleGroup.html" title="RSpec::Rails::ControllerExampleGroup (module)">ControllerExampleGroup</a></span>, <span class='object_link'><a href="../RoutingExampleGroup.html" title="RSpec::Rails::RoutingExampleGroup (module)">RoutingExampleGroup</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/matchers/routing_matchers.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Matchers to help with specs for routing code.</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="RoutingMatchers/RouteHelpers.html" title="RSpec::Rails::Matchers::RoutingMatchers::RouteHelpers (module)">RouteHelpers</a></span>
</p>
<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="#be_routable-instance_method" title="#be_routable (instance method)">#<strong>be_routable</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if the route expression is recognized by the Rails router based on the declarations in <code>config/routes.rb</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#route_to-instance_method" title="#route_to (instance method)">#<strong>route_to</strong>(*expected) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Delegates to <code>assert_recognizes</code>.</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="be_routable-instance_method">
#<strong>be_routable</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if the route expression is recognized by the Rails router based on
the declarations in <code>config/routes.rb</code>. Delegates to
<code>RouteSet#recognize_path</code>.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<h5 class="example_title"><div class='inline'><p>You can use route helpers provided by rspec-rails.</p>
</div></h5>
<pre class="example code"><code><span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='label'>get:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/a/path</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_routable'>be_routable</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='label'>post:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/another/path</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_routable'>be_routable</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='label'>put:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/yet/another/path</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_routable'>be_routable</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/routing_matchers.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_be_routable'>be_routable</span>
<span class='const'>BeRoutableMatcher</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="route_to-instance_method">
#<strong>route_to</strong>(*expected) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delegates to <code>assert_recognizes</code>. Supports short-hand controller/action
declarations (e.g. <code>"controller#action"</code>).</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_expect'>expect</span><span class='lparen'>(</span><span class='label'>get:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/things/special</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_route_to'>route_to</span><span class='lparen'>(</span>
<span class='label'>controller:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>things</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='label'>action:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>special</span><span class='tstring_end'>"</span></span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='label'>get:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/things/special</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_route_to'>route_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>things#special</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
</div>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes" target="_parent" title="https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes">https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/routing_matchers.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_route_to'>route_to</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_expected'>expected</span><span class='rparen'>)</span>
<span class='const'>RouteToMatcher</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_expected'>expected</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>