forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRails.html
173 lines (173 loc) · 15.3 KB
/
Rails.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 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
— Documentation by YARD 0.8.7.6
</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#!RSpec/Rails.html";
</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 (R)</a> »
<span class='title'><span class='object_link'><a href="../RSpec.html" title="RSpec (module)">RSpec</a></span></span>
»
<span class="title">Rails</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
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/rspec-rails.rb<span class="defines">,<br />
lib/rspec/rails/version.rb,<br /> lib/rspec/rails/matchers.rb,<br /> lib/rspec/rails/adapters.rb,<br /> lib/rspec/rails/view_assigns.rb,<br /> lib/rspec/rails/configuration.rb,<br /> lib/rspec/rails/feature_check.rb,<br /> lib/rspec/rails/active_record.rb,<br /> lib/rspec/rails/view_rendering.rb,<br /> lib/rspec/rails/fixture_support.rb,<br /> lib/rspec/rails/view_path_builder.rb,<br /> lib/rspec/rails/matchers/be_a_new.rb,<br /> lib/rspec/rails/view_spec_methods.rb,<br /> lib/rspec/rails/matchers/be_valid.rb,<br /> lib/rspec/rails/matchers/active_job.rb,<br /> lib/rspec/rails/file_fixture_support.rb,<br /> lib/rspec/rails/matchers/redirect_to.rb,<br /> lib/rspec/rails/matchers/be_new_record.rb,<br /> lib/rspec/rails/matchers/have_rendered.rb,<br /> lib/rspec/rails/example/job_example_group.rb,<br /> lib/rspec/rails/example/job_example_group.rb,<br /> lib/rspec/rails/matchers/have_http_status.rb,<br /> lib/rspec/rails/matchers/routing_matchers.rb,<br /> lib/rspec/rails/example/view_example_group.rb,<br /> lib/rspec/rails/example/rails_example_group.rb,<br /> lib/rspec/rails/example/model_example_group.rb,<br /> lib/rspec/rails/example/mailer_example_group.rb,<br /> lib/rspec/rails/example/mailer_example_group.rb,<br /> lib/rspec/rails/example/helper_example_group.rb,<br /> lib/rspec/rails/example/feature_example_group.rb,<br /> lib/rspec/rails/example/routing_example_group.rb,<br /> lib/rspec/rails/example/request_example_group.rb,<br /> lib/rspec/rails/example/controller_example_group.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Namespace for rspec-rails 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="Rails/ControllerExampleGroup.html" title="RSpec::Rails::ControllerExampleGroup (module)">ControllerExampleGroup</a></span>, <span class='object_link'><a href="Rails/FeatureExampleGroup.html" title="RSpec::Rails::FeatureExampleGroup (module)">FeatureExampleGroup</a></span>, <span class='object_link'><a href="Rails/HelperExampleGroup.html" title="RSpec::Rails::HelperExampleGroup (module)">HelperExampleGroup</a></span>, <span class='object_link'><a href="Rails/JobExampleGroup.html" title="RSpec::Rails::JobExampleGroup (module)">JobExampleGroup</a></span>, <span class='object_link'><a href="Rails/MailerExampleGroup.html" title="RSpec::Rails::MailerExampleGroup (module)">MailerExampleGroup</a></span>, <span class='object_link'><a href="Rails/Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span>, <span class='object_link'><a href="Rails/ModelExampleGroup.html" title="RSpec::Rails::ModelExampleGroup (module)">ModelExampleGroup</a></span>, <span class='object_link'><a href="Rails/RailsExampleGroup.html" title="RSpec::Rails::RailsExampleGroup (module)">RailsExampleGroup</a></span>, <span class='object_link'><a href="Rails/RequestExampleGroup.html" title="RSpec::Rails::RequestExampleGroup (module)">RequestExampleGroup</a></span>, <span class='object_link'><a href="Rails/RoutingExampleGroup.html" title="RSpec::Rails::RoutingExampleGroup (module)">RoutingExampleGroup</a></span>, <span class='object_link'><a href="Rails/Version.html" title="RSpec::Rails::Version (module)">Version</a></span>, <span class='object_link'><a href="Rails/ViewAssigns.html" title="RSpec::Rails::ViewAssigns (module)">ViewAssigns</a></span>, <span class='object_link'><a href="Rails/ViewExampleGroup.html" title="RSpec::Rails::ViewExampleGroup (module)">ViewExampleGroup</a></span>, <span class='object_link'><a href="Rails/ViewRendering.html" title="RSpec::Rails::ViewRendering (module)">ViewRendering</a></span>, <span class='object_link'><a href="Rails/ViewSpecMethods.html" title="RSpec::Rails::ViewSpecMethods (module)">ViewSpecMethods</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Rails/ActiveRecordConfiguration.html" title="RSpec::Rails::ActiveRecordConfiguration (class)">ActiveRecordConfiguration</a></span>, <span class='object_link'><a href="Rails/Configuration.html" title="RSpec::Rails::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Rails/Railtie.html" title="RSpec::Rails::Railtie (class)">Railtie</a></span>, <span class='object_link'><a href="Rails/ViewPathBuilder.html" title="RSpec::Rails::ViewPathBuilder (class)">ViewPathBuilder</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="DIRECTORY_MAPPINGS-constant" class="">DIRECTORY_MAPPINGS =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
You should avoid using this constant if possible, as it may be removed or be changed in the future.
</p>
<p>Mappings used by <code>infer_spec_type_from_file_location!</code>.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='symbol'>:controller</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>controllers</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:helper</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>helpers</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:job</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>jobs</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:mailer</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>mailers</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:model</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>models</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:request</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>(requests|integration|api)</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:routing</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>routing</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:view</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>views</span><span class='words_sep'>]</span><span class='comma'>,</span>
<span class='symbol'>:feature</span> <span class='op'>=></span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>spec</span><span class='words_sep'> </span><span class='tstring_content'>features</span><span class='words_sep'>]</span>
<span class='rbrace'>}</span></pre></dd>
<dt id="Assertions-constant" class="">Assertions =
<div class="docstring">
<div class="discussion">
<p>Constant aliased to either Minitest or TestUnit, depending on what is
loaded.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Test</span><span class='op'>::</span><span class='const'>Unit</span><span class='op'>::</span><span class='const'>Assertions</span></pre></dd>
</dl>
<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_test_type_configurations-class_method" title="add_test_type_configurations (class method)">+ (Object) <strong>add_test_type_configurations</strong>(config) </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Sets up the different example group modules for the different spec types.</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_test_type_configurations-class_method">
+ (<tt>Object</tt>) <strong>add_test_type_configurations</strong>(config)
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Sets up the different example group modules for the different spec types</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46
47
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/configuration.rb', line 42</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_add_test_type_configurations'>add_test_type_configurations</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>ControllerExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:controller</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>HelperExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:helper</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>ModelExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:model</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>RequestExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:request</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>RoutingExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:routing</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>ViewExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:view</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>FeatureExampleGroup</span><span class='comma'>,</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='symbol'>:feature</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'>RSpec</span><span class='op'>::</span><span class='const'>Rails</span><span class='op'>::</span><span class='const'>Matchers</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu May 4 20:28:20 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.6).
</div>
</body>
</html>