-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathChannelExampleGroup.html
246 lines (246 loc) · 13.8 KB
/
ChannelExampleGroup.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::ChannelExampleGroup
— 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::ChannelExampleGroup";
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">ChannelExampleGroup</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::ChannelExampleGroup
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>ActionCable::Channel::TestCase::Behavior, ActionCable::Connection::TestCase::Behavior, <span class='object_link'><a href="RailsExampleGroup.html" title="RSpec::Rails::RailsExampleGroup (module)">RailsExampleGroup</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/example/channel_example_group.rb<span class="defines">,<br />
lib/rspec/rails/example/channel_example_group.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Container module for channel spec functionality.</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="ChannelExampleGroup/ClassMethods.html" title="RSpec::Rails::ChannelExampleGroup::ClassMethods (module)">ClassMethods</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="#have_rejected_connection-instance_method" title="#have_rejected_connection (instance method)">#<strong>have_rejected_connection</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks that the connection attempt has been rejected.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_stream_for-instance_method" title="#have_stream_for (instance method)">#<strong>have_stream_for</strong>(object) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks that the channel has been subscribed to a stream for the given model.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_stream_from-instance_method" title="#have_stream_from (instance method)">#<strong>have_stream_from</strong>(stream) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks that the channel has been subscribed to the given stream.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_streams-instance_method" title="#have_streams (instance method)">#<strong>have_streams</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks that the subscription is subscribed to at least one stream.</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="have_rejected_connection-instance_method">
#<strong>have_rejected_connection</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks that the connection attempt has been rejected.</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='lbrace'>{</span> <span class='id identifier rubyid_connect'>connect</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_rejected_connection'>have_rejected_connection</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/channel_example_group.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_rejected_connection'>have_rejected_connection</span>
<span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>ActionCable</span><span class='op'>::</span><span class='const'>Connection</span><span class='op'>::</span><span class='const'>Authorization</span><span class='op'>::</span><span class='const'>UnauthorizedError</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_stream_for-instance_method">
#<strong>have_stream_for</strong>(object) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks that the channel has been subscribed to a stream for the given model</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='id identifier rubyid_subscription'>subscription</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_stream_for'>have_stream_for</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/channel_example_group.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_stream_for'>have_stream_for</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
<span class='id identifier rubyid_check_subscribed!'>check_subscribed!</span>
<span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers/ActionCable/HaveStream.html" title="RSpec::Rails::Matchers::ActionCable::HaveStream (class)">HaveStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_broadcasting_for'>broadcasting_for</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_stream_from-instance_method">
#<strong>have_stream_from</strong>(stream) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks that the channel has been subscribed to the given stream</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='id identifier rubyid_subscription'>subscription</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_stream_from'>have_stream_from</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>chat_1</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
76
77
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/channel_example_group.rb', line 76</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_stream_from'>have_stream_from</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span>
<span class='id identifier rubyid_check_subscribed!'>check_subscribed!</span>
<span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers/ActionCable/HaveStream.html" title="RSpec::Rails::Matchers::ActionCable::HaveStream (class)">HaveStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_streams-instance_method">
#<strong>have_streams</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks that the subscription is subscribed to at least one stream.</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='id identifier rubyid_subscription'>subscription</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_streams'>have_streams</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/channel_example_group.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_streams'>have_streams</span>
<span class='id identifier rubyid_check_subscribed!'>check_subscribed!</span>
<span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Matchers/ActionCable/HaveStream.html" title="RSpec::Rails::Matchers::ActionCable::HaveStream (class)">HaveStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</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>