forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathConfiguration.html
212 lines (212 loc) · 7.52 KB
/
Configuration.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
<!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>
Class: RSpec::Rails::Configuration
— 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 (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">Configuration</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>Class: RSpec::Rails::Configuration
<span class="private note title">Private</span>
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RSpec::Rails::Configuration</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/rspec/rails/configuration.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This class is part of a private API.</strong>
You should avoid using this class if possible, as it may be removed or be changed in the future.
</p>
<p>Fake class to document RSpec Rails configuration options. In practice,
these are dynamically added to the normal RSpec configuration object.</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="#infer_spec_type_from_file_location%21-instance_method" title="#infer_spec_type_from_file_location! (instance method)">- (Object) <strong>infer_spec_type_from_file_location!</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Automatically tag specs in conventional directories with matching <code>type</code> metadata so that they have relevant helpers available to them.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#render_views-instance_method" title="#render_views (instance method)">- (Object) <strong>render_views</strong>(val) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Enables view rendering for controllers specs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#render_views%3D-instance_method" title="#render_views= (instance method)">- (Object) <strong>render_views=</strong>(val) </a>
</span>
<span class="summary_desc"><div class='inline'><p>When set to <code>true</code>, controller specs will render the relevant view as well.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#render_views%3F-instance_method" title="#render_views? (instance method)">- (Object) <strong>render_views?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Reader for currently value of <code>render_views</code> setting.</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="infer_spec_type_from_file_location!-instance_method">
- (<tt>Object</tt>) <strong>infer_spec_type_from_file_location!</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Automatically tag specs in conventional directories with matching <code>type</code>
metadata so that they have relevant helpers available to them. See
<code>RSpec::Rails::DIRECTORY_MAPPINGS</code> for details on which metadata is
applied to each directory.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/configuration.rb', line 6</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="render_views-instance_method">
- (<tt>Object</tt>) <strong>render_views</strong>(val)
</h3><div class="docstring">
<div class="discussion">
<p>Enables view rendering for controllers specs.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/configuration.rb', line 17</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="render_views=-instance_method">
- (<tt>Object</tt>) <strong>render_views=</strong>(val)
</h3><div class="docstring">
<div class="discussion">
<p>When set to <code>true</code>, controller specs will render the relevant view as
well. Defaults to <code>false</code>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/configuration.rb', line 12</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="render_views?-instance_method">
- (<tt>Object</tt>) <strong>render_views?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Reader for currently value of <code>render_views</code> setting.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/configuration.rb', line 22</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jan 29 13:55:22 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>