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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::StubbedEnv::HideHelpers
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::StubbedEnv::HideHelpers";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../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 (H)</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="../StubbedEnv.html" title="RSpec::StubbedEnv (module)">StubbedEnv</a></span></span>
»
<span class="title">HideHelpers</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::StubbedEnv::HideHelpers
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="StubHelpers.html" title="RSpec::StubbedEnv::StubHelpers (module)">StubHelpers</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/stubbed_env/hide_helpers.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Helpers to unobtrusively stub ENV</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="#hide_env-instance_method" title="#hide_env (instance method)">#<strong>hide_env</strong>(*keys) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Can be called with an array of ENV keys to hide:.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="StubHelpers.html" title="RSpec::StubbedEnv::StubHelpers (module)">StubHelpers</a></span></h3>
<p class="inherited"><span class='object_link'><a href="StubHelpers.html#stub_env-instance_method" title="RSpec::StubbedEnv::StubHelpers#stub_env (method)">#stub_env</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="hide_env-instance_method">
#<strong>hide_env</strong>(*keys) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Can be called with an array of ENV keys to hide:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_hide_env'>hide_env</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>FOO</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BAR</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BAZ</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># Preferred
</span></code></pre>
<p>Alternatively can be called once per ENV key to hide:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_stub_env'>stub_env</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># NOT
</span><span class='id identifier rubyid_stub_env'>stub_env</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>C</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># AS
</span><span class='id identifier rubyid_stub_env'>stub_env</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>E</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># GOOD (creates redundant stubs on values_at)
</span></code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/stubbed_env/hide_helpers.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hide_env'>hide_env</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span>
<span class='id identifier rubyid_init_stub'>init_stub</span> <span class='kw'>unless</span> <span class='id identifier rubyid_env_stubbed?'>env_stubbed?</span>
<span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
<span class='id identifier rubyid_add_hidden_key'>add_hidden_key</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Aug 4 22:57:10 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.4.5).
</div>
</div>
</body>
</html>
|
