structured_warnings 0.1.4 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +21 -0
- data/History.txt +7 -0
- data/README.rdoc +5 -5
- data/doc/DeprecatedMethodWarning.html +76 -141
- data/doc/DeprecatedSignatureWarning.html +76 -141
- data/doc/DeprecationWarning.html +76 -141
- data/doc/Dynamic.html +89 -136
- data/doc/Object.html +92 -161
- data/doc/README_rdoc.html +144 -157
- data/doc/StandardWarning.html +76 -141
- data/doc/StructuredWarnings.html +95 -157
- data/doc/StructuredWarnings/ClassMethods.html +131 -193
- data/doc/StructuredWarnings/Kernel.html +146 -198
- data/doc/StructuredWarnings/Test.html +71 -150
- data/doc/StructuredWarnings/Test/Assertions.html +194 -244
- data/doc/StructuredWarnings/Test/Warner.html +138 -201
- data/doc/StructuredWarnings/Warner.html +113 -177
- data/doc/Test.html +95 -0
- data/doc/Test/Unit.html +95 -0
- data/doc/Warning.html +276 -338
- data/doc/Warning/ClassMethods.html +182 -238
- data/doc/created.rid +10 -10
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +590 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/index.html +104 -103
- data/doc/js/darkfish.js +112 -67
- data/doc/js/jquery.js +4 -32
- data/doc/js/navigation.js +142 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +109 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +228 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +200 -0
- data/lib/structured_warnings/dynamic.rb +12 -6
- data/lib/structured_warnings/kernel.rb +4 -4
- data/structured_warnings.gemspec +5 -1
- data/test/structured_warnings_test.rb +63 -9
- metadata +84 -43
- data/doc/js/quicksearch.js +0 -114
- data/doc/js/thickbox-compressed.js +0 -10
- data/doc/lib/structured_warnings/dynamic_rb.html +0 -65
- data/doc/lib/structured_warnings/kernel_rb.html +0 -52
- data/doc/lib/structured_warnings/test/assertions_rb.html +0 -52
- data/doc/lib/structured_warnings/test/warner_rb.html +0 -52
- data/doc/lib/structured_warnings/test_rb.html +0 -56
- data/doc/lib/structured_warnings/warner_rb.html +0 -52
- data/doc/lib/structured_warnings/warning_rb.html +0 -64
- data/doc/lib/structured_warnings_rb.html +0 -62
- data/doc/rdoc.css +0 -763
@@ -1,236 +1,177 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
5
4
|
<head>
|
6
|
-
|
5
|
+
<meta charset="UTF-8">
|
7
6
|
|
8
|
-
|
7
|
+
<title>class StructuredWarnings::Test::Warner - structured_warnings</title>
|
9
8
|
|
10
|
-
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../../";
|
11
|
+
</script>
|
11
12
|
|
12
|
-
|
13
|
-
|
14
|
-
<script src="../../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
15
|
-
<script src="../../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
13
|
+
<script src="../../js/jquery.js"></script>
|
14
|
+
<script src="../../js/darkfish.js"></script>
|
16
15
|
|
17
|
-
|
18
|
-
<
|
16
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
17
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
19
18
|
|
20
|
-
<div id="metadata">
|
21
|
-
<div id="home-metadata">
|
22
|
-
<div id="home-section" class="section">
|
23
|
-
<h3 class="section-header">
|
24
|
-
<a href="../../index.html">Home</a>
|
25
|
-
<a href="../../index.html#classes">Classes</a>
|
26
|
-
<a href="../../index.html#methods">Methods</a>
|
27
|
-
</h3>
|
28
|
-
</div>
|
29
|
-
</div>
|
30
19
|
|
31
|
-
<div id="file-metadata">
|
32
|
-
<div id="file-list-section" class="section">
|
33
|
-
<h3 class="section-header">In Files</h3>
|
34
|
-
<div class="section-body">
|
35
|
-
<ul>
|
36
|
-
|
37
|
-
<li><a href="../../lib/structured_warnings/test/warner_rb.html?TB_iframe=true&height=550&width=785"
|
38
|
-
class="thickbox" title="lib/structured_warnings/test/warner.rb">lib/structured_warnings/test/warner.rb</a></li>
|
39
|
-
|
40
|
-
</ul>
|
41
|
-
</div>
|
42
|
-
</div>
|
43
20
|
|
44
|
-
|
21
|
+
<body id="top" role="document" class="class">
|
22
|
+
<nav role="navigation">
|
23
|
+
<div id="project-navigation">
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
25
|
+
<h2>
|
26
|
+
<a href="../../index.html" rel="home">Home</a>
|
27
|
+
</h2>
|
28
|
+
|
29
|
+
<div id="table-of-contents-navigation">
|
30
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
31
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
32
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
33
|
+
</div>
|
34
|
+
</div>
|
35
|
+
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
38
|
+
<div id="search-field-wrapper">
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
45
43
|
</div>
|
46
44
|
|
47
|
-
<
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
<p class="link"><a href="../Warner.html">StructuredWarnings::Warner</a></p>
|
54
|
-
|
55
|
-
</div>
|
56
|
-
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
46
|
+
aria-busy="false" aria-expanded="false"
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
48
|
+
</form>
|
49
|
+
</div>
|
57
50
|
|
58
|
-
|
51
|
+
</div>
|
59
52
|
|
60
|
-
|
53
|
+
|
61
54
|
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
<ul class="link-list">
|
67
|
-
|
68
|
-
<li><a href="#method-i-format">#format</a></li>
|
69
|
-
|
70
|
-
<li><a href="#method-i-warned-3F">#warned?</a></li>
|
71
|
-
|
72
|
-
</ul>
|
73
|
-
</div>
|
74
|
-
|
55
|
+
<div id="class-metadata">
|
56
|
+
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
58
|
+
<h3>Parent</h3>
|
75
59
|
|
76
|
-
|
77
|
-
|
60
|
+
|
61
|
+
<p class="link"><a href="../Warner.html">StructuredWarnings::Warner</a>
|
62
|
+
|
63
|
+
</div>
|
78
64
|
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
<h3 class="section-header">Class/Module Index
|
94
|
-
<span class="search-toggle"><img src="../../images/find.png"
|
95
|
-
height="16" width="16" alt="[+]"
|
96
|
-
title="show/hide quicksearch" /></span></h3>
|
97
|
-
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
98
|
-
<fieldset>
|
99
|
-
<legend>Quicksearch</legend>
|
100
|
-
<input type="text" name="quicksearch" value=""
|
101
|
-
class="quicksearch-field" />
|
102
|
-
</fieldset>
|
103
|
-
</form>
|
104
|
-
|
105
|
-
<ul class="link-list">
|
106
|
-
|
107
|
-
<li><a href="../../StructuredWarnings.html">StructuredWarnings</a></li>
|
108
|
-
|
109
|
-
<li><a href="../../StructuredWarnings/ClassMethods.html">StructuredWarnings::ClassMethods</a></li>
|
110
|
-
|
111
|
-
<li><a href="../../StructuredWarnings/Kernel.html">StructuredWarnings::Kernel</a></li>
|
112
|
-
|
113
|
-
<li><a href="../../StructuredWarnings/Test.html">StructuredWarnings::Test</a></li>
|
114
|
-
|
115
|
-
<li><a href="../../StructuredWarnings/Test/Assertions.html">StructuredWarnings::Test::Assertions</a></li>
|
116
|
-
|
117
|
-
<li><a href="../../StructuredWarnings/Test/Warner.html">StructuredWarnings::Test::Warner</a></li>
|
118
|
-
|
119
|
-
<li><a href="../../StructuredWarnings/Warner.html">StructuredWarnings::Warner</a></li>
|
120
|
-
|
121
|
-
<li><a href="../../Warning.html">Warning</a></li>
|
122
|
-
|
123
|
-
<li><a href="../../Warning/ClassMethods.html">Warning::ClassMethods</a></li>
|
124
|
-
|
125
|
-
<li><a href="../../DeprecatedMethodWarning.html">DeprecatedMethodWarning</a></li>
|
126
|
-
|
127
|
-
<li><a href="../../DeprecatedSignatureWarning.html">DeprecatedSignatureWarning</a></li>
|
128
|
-
|
129
|
-
<li><a href="../../DeprecationWarning.html">DeprecationWarning</a></li>
|
130
|
-
|
131
|
-
<li><a href="../../Dynamic.html">Dynamic</a></li>
|
132
|
-
|
133
|
-
<li><a href="../../Object.html">Object</a></li>
|
134
|
-
|
135
|
-
<li><a href="../../StandardWarning.html">StandardWarning</a></li>
|
136
|
-
|
137
|
-
</ul>
|
138
|
-
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
139
|
-
</div>
|
65
|
+
|
66
|
+
|
67
|
+
<!-- Method Quickref -->
|
68
|
+
<div id="method-list-section" class="nav-section">
|
69
|
+
<h3>Methods</h3>
|
70
|
+
|
71
|
+
<ul class="link-list" role="directory">
|
72
|
+
|
73
|
+
<li ><a href="#method-i-format">#format</a>
|
74
|
+
|
75
|
+
<li ><a href="#method-i-warned-3F">#warned?</a>
|
76
|
+
|
77
|
+
</ul>
|
78
|
+
</div>
|
140
79
|
|
141
|
-
|
142
|
-
</div>
|
143
80
|
</div>
|
81
|
+
</nav>
|
144
82
|
|
145
|
-
|
146
|
-
|
83
|
+
<main role="main" aria-labelledby="class-StructuredWarnings::Test::Warner">
|
84
|
+
<h1 id="class-StructuredWarnings::Test::Warner" class="class">
|
85
|
+
class StructuredWarnings::Test::Warner
|
86
|
+
</h1>
|
147
87
|
|
148
|
-
|
149
|
-
|
88
|
+
<section class="description">
|
89
|
+
|
150
90
|
<p>This warner is used in <a
|
151
|
-
href="Assertions.html#method-i-assert_warn">Assertions#assert_warn</a>
|
152
|
-
<a
|
153
|
-
href="Assertions.html#method-i-assert_no_warn">Assertions#assert_no_warn</a>
|
91
|
+
href="Assertions.html#method-i-assert_warn">StructuredWarnings::Test::Assertions#assert_warn</a>
|
92
|
+
and <a
|
93
|
+
href="Assertions.html#method-i-assert_no_warn">StructuredWarnings::Test::Assertions#assert_no_warn</a>
|
154
94
|
blocks. It captures all warnings in format and provides access to them
|
155
95
|
using the warned? method.</p>
|
156
96
|
|
157
|
-
|
97
|
+
</section>
|
158
98
|
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
159
103
|
|
160
|
-
|
161
|
-
|
162
|
-
<div id="5Buntitled-5D" class="documentation-section">
|
163
|
-
|
164
|
-
|
165
|
-
|
166
104
|
|
167
|
-
|
105
|
+
|
168
106
|
|
169
|
-
|
107
|
+
|
170
108
|
|
171
|
-
|
172
|
-
|
173
|
-
<div id="public-instance-method-details" class="method-section section">
|
174
|
-
<h3 class="section-header">Public Instance Methods</h3>
|
109
|
+
|
175
110
|
|
176
|
-
|
177
|
-
|
178
|
-
|
111
|
+
|
112
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
113
|
+
<header>
|
114
|
+
<h3>Public Instance Methods</h3>
|
115
|
+
</header>
|
179
116
|
|
117
|
+
|
118
|
+
<div id="method-i-format" class="method-detail ">
|
119
|
+
|
120
|
+
<div class="method-heading">
|
121
|
+
<span class="method-name">format</span><span
|
122
|
+
class="method-args">(warning, message, call_stack)</span>
|
180
123
|
|
181
|
-
<
|
182
|
-
<span class="method-name">format</span><span
|
183
|
-
class="method-args">(warning, message, call_stack)</span>
|
184
|
-
<span class="method-click-advice">click to toggle source</span>
|
185
|
-
</div>
|
124
|
+
<span class="method-click-advice">click to toggle source</span>
|
186
125
|
|
126
|
+
</div>
|
127
|
+
|
187
128
|
|
188
|
-
|
189
|
-
|
190
|
-
|
129
|
+
<div class="method-description">
|
130
|
+
|
131
|
+
<p>Overrides the public interface of <a
|
191
132
|
href="../Warner.html">StructuredWarnings::Warner</a>. This method always
|
192
133
|
returns nil to avoid warnings on stdout during assert_warn and
|
193
134
|
assert_no_warn blocks.</p>
|
194
|
-
|
135
|
+
|
136
|
+
|
195
137
|
|
196
|
-
|
197
|
-
|
198
|
-
<pre>
|
199
|
-
<span class="ruby-comment"># File lib/structured_warnings/test/warner.rb, line 10</span>
|
138
|
+
|
139
|
+
<div class="method-source-code" id="format-source">
|
140
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/test/warner.rb, line 10</span>
|
200
141
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">warning</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">call_stack</span>)
|
201
142
|
<span class="ruby-identifier">given_warnings</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">warning</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>)
|
202
143
|
<span class="ruby-keyword">nil</span>
|
203
144
|
<span class="ruby-keyword">end</span></pre>
|
204
|
-
</div><!-- format-source -->
|
205
|
-
|
206
145
|
</div>
|
207
|
-
|
208
146
|
|
147
|
+
</div>
|
209
148
|
|
210
|
-
|
211
|
-
</div><!-- format-method -->
|
149
|
+
|
212
150
|
|
213
|
-
|
214
|
-
|
215
|
-
<a name="method-i-warned-3F"></a>
|
151
|
+
|
152
|
+
</div>
|
216
153
|
|
154
|
+
|
155
|
+
<div id="method-i-warned-3F" class="method-detail ">
|
156
|
+
|
157
|
+
<div class="method-heading">
|
158
|
+
<span class="method-name">warned?</span><span
|
159
|
+
class="method-args">(warning, message = nil)</span>
|
217
160
|
|
218
|
-
<
|
219
|
-
<span class="method-name">warned?</span><span
|
220
|
-
class="method-args">(warning, message = nil)</span>
|
221
|
-
<span class="method-click-advice">click to toggle source</span>
|
222
|
-
</div>
|
161
|
+
<span class="method-click-advice">click to toggle source</span>
|
223
162
|
|
163
|
+
</div>
|
164
|
+
|
224
165
|
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
166
|
+
<div class="method-description">
|
167
|
+
|
168
|
+
<p>Returns true if any warning or a subclass of warning was emitted.</p>
|
169
|
+
|
170
|
+
|
229
171
|
|
230
|
-
|
231
|
-
|
232
|
-
<pre>
|
233
|
-
<span class="ruby-comment"># File lib/structured_warnings/test/warner.rb, line 16</span>
|
172
|
+
|
173
|
+
<div class="method-source-code" id="warned-3F-source">
|
174
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/test/warner.rb, line 16</span>
|
234
175
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">warned?</span>(<span class="ruby-identifier">warning</span>, <span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>)
|
235
176
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">message</span>
|
236
177
|
<span class="ruby-keyword">when</span> <span class="ruby-constant">Regexp</span>
|
@@ -240,32 +181,28 @@ assert_no_warn blocks.</p>
|
|
240
181
|
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span>
|
241
182
|
<span class="ruby-identifier">given_warnings</span>.<span class="ruby-identifier">any?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">w</span><span class="ruby-operator">|</span> <span class="ruby-identifier">w</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-identifier">warning</span>)}
|
242
183
|
<span class="ruby-keyword">else</span>
|
243
|
-
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Unkown argument for
|
184
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Unkown argument for 'message'"</span>
|
244
185
|
<span class="ruby-keyword">end</span>
|
245
186
|
<span class="ruby-keyword">end</span></pre>
|
246
|
-
</div><!-- warned-3F-source -->
|
247
|
-
|
248
187
|
</div>
|
249
|
-
|
250
188
|
|
189
|
+
</div>
|
251
190
|
|
252
|
-
|
253
|
-
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
</div>
|
254
195
|
|
255
|
-
|
256
|
-
</div><!-- public-instance-method-details -->
|
257
196
|
|
258
|
-
</
|
197
|
+
</section>
|
259
198
|
|
199
|
+
</section>
|
200
|
+
</main>
|
260
201
|
|
261
|
-
</div><!-- documentation -->
|
262
|
-
|
263
|
-
<div id="validator-badges">
|
264
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
265
|
-
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
266
|
-
Rdoc Generator</a> 2</small>.</p>
|
267
|
-
</div>
|
268
202
|
|
269
|
-
|
270
|
-
</
|
203
|
+
<footer id="validator-badges" role="contentinfo">
|
204
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
205
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
206
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
207
|
+
</footer>
|
271
208
|
|
@@ -1,226 +1,162 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
5
4
|
<head>
|
6
|
-
|
5
|
+
<meta charset="UTF-8">
|
7
6
|
|
8
|
-
|
7
|
+
<title>class StructuredWarnings::Warner - structured_warnings</title>
|
9
8
|
|
10
|
-
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../";
|
11
|
+
</script>
|
11
12
|
|
12
|
-
|
13
|
-
|
14
|
-
<script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
15
|
-
<script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
13
|
+
<script src="../js/jquery.js"></script>
|
14
|
+
<script src="../js/darkfish.js"></script>
|
16
15
|
|
17
|
-
|
18
|
-
<
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
19
18
|
|
20
|
-
<div id="metadata">
|
21
|
-
<div id="home-metadata">
|
22
|
-
<div id="home-section" class="section">
|
23
|
-
<h3 class="section-header">
|
24
|
-
<a href="../index.html">Home</a>
|
25
|
-
<a href="../index.html#classes">Classes</a>
|
26
|
-
<a href="../index.html#methods">Methods</a>
|
27
|
-
</h3>
|
28
|
-
</div>
|
29
|
-
</div>
|
30
19
|
|
31
|
-
<div id="file-metadata">
|
32
|
-
<div id="file-list-section" class="section">
|
33
|
-
<h3 class="section-header">In Files</h3>
|
34
|
-
<div class="section-body">
|
35
|
-
<ul>
|
36
|
-
|
37
|
-
<li><a href="../lib/structured_warnings/warner_rb.html?TB_iframe=true&height=550&width=785"
|
38
|
-
class="thickbox" title="lib/structured_warnings/warner.rb">lib/structured_warnings/warner.rb</a></li>
|
39
|
-
|
40
|
-
</ul>
|
41
|
-
</div>
|
42
|
-
</div>
|
43
20
|
|
44
|
-
|
21
|
+
<body id="top" role="document" class="class">
|
22
|
+
<nav role="navigation">
|
23
|
+
<div id="project-navigation">
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
25
|
+
<h2>
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
27
|
+
</h2>
|
28
|
+
|
29
|
+
<div id="table-of-contents-navigation">
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
33
|
+
</div>
|
34
|
+
</div>
|
35
|
+
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
38
|
+
<div id="search-field-wrapper">
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
45
43
|
</div>
|
46
44
|
|
47
|
-
<
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
<p class="link"><a href="../Object.html">Object</a></p>
|
54
|
-
|
55
|
-
</div>
|
56
|
-
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
46
|
+
aria-busy="false" aria-expanded="false"
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
48
|
+
</form>
|
49
|
+
</div>
|
57
50
|
|
58
|
-
|
51
|
+
</div>
|
59
52
|
|
60
|
-
|
53
|
+
|
61
54
|
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
<ul class="link-list">
|
67
|
-
|
68
|
-
<li><a href="#method-i-format">#format</a></li>
|
69
|
-
|
70
|
-
</ul>
|
71
|
-
</div>
|
72
|
-
|
55
|
+
<div id="class-metadata">
|
56
|
+
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
58
|
+
<h3>Parent</h3>
|
73
59
|
|
74
|
-
|
75
|
-
|
60
|
+
|
61
|
+
<p class="link"><a href="../Object.html">Object</a>
|
62
|
+
|
63
|
+
</div>
|
76
64
|
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
<div id="classindex-section" class="section project-section">
|
91
|
-
<h3 class="section-header">Class/Module Index
|
92
|
-
<span class="search-toggle"><img src="../images/find.png"
|
93
|
-
height="16" width="16" alt="[+]"
|
94
|
-
title="show/hide quicksearch" /></span></h3>
|
95
|
-
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
96
|
-
<fieldset>
|
97
|
-
<legend>Quicksearch</legend>
|
98
|
-
<input type="text" name="quicksearch" value=""
|
99
|
-
class="quicksearch-field" />
|
100
|
-
</fieldset>
|
101
|
-
</form>
|
102
|
-
|
103
|
-
<ul class="link-list">
|
104
|
-
|
105
|
-
<li><a href="../StructuredWarnings.html">StructuredWarnings</a></li>
|
106
|
-
|
107
|
-
<li><a href="../StructuredWarnings/ClassMethods.html">StructuredWarnings::ClassMethods</a></li>
|
108
|
-
|
109
|
-
<li><a href="../StructuredWarnings/Kernel.html">StructuredWarnings::Kernel</a></li>
|
110
|
-
|
111
|
-
<li><a href="../StructuredWarnings/Test.html">StructuredWarnings::Test</a></li>
|
112
|
-
|
113
|
-
<li><a href="../StructuredWarnings/Test/Assertions.html">StructuredWarnings::Test::Assertions</a></li>
|
114
|
-
|
115
|
-
<li><a href="../StructuredWarnings/Test/Warner.html">StructuredWarnings::Test::Warner</a></li>
|
116
|
-
|
117
|
-
<li><a href="../StructuredWarnings/Warner.html">StructuredWarnings::Warner</a></li>
|
118
|
-
|
119
|
-
<li><a href="../Warning.html">Warning</a></li>
|
120
|
-
|
121
|
-
<li><a href="../Warning/ClassMethods.html">Warning::ClassMethods</a></li>
|
122
|
-
|
123
|
-
<li><a href="../DeprecatedMethodWarning.html">DeprecatedMethodWarning</a></li>
|
124
|
-
|
125
|
-
<li><a href="../DeprecatedSignatureWarning.html">DeprecatedSignatureWarning</a></li>
|
126
|
-
|
127
|
-
<li><a href="../DeprecationWarning.html">DeprecationWarning</a></li>
|
128
|
-
|
129
|
-
<li><a href="../Dynamic.html">Dynamic</a></li>
|
130
|
-
|
131
|
-
<li><a href="../Object.html">Object</a></li>
|
132
|
-
|
133
|
-
<li><a href="../StandardWarning.html">StandardWarning</a></li>
|
134
|
-
|
135
|
-
</ul>
|
136
|
-
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
137
|
-
</div>
|
65
|
+
|
66
|
+
|
67
|
+
<!-- Method Quickref -->
|
68
|
+
<div id="method-list-section" class="nav-section">
|
69
|
+
<h3>Methods</h3>
|
70
|
+
|
71
|
+
<ul class="link-list" role="directory">
|
72
|
+
|
73
|
+
<li ><a href="#method-i-format">#format</a>
|
74
|
+
|
75
|
+
</ul>
|
76
|
+
</div>
|
138
77
|
|
139
|
-
|
140
|
-
</div>
|
141
78
|
</div>
|
79
|
+
</nav>
|
142
80
|
|
143
|
-
|
144
|
-
|
81
|
+
<main role="main" aria-labelledby="class-StructuredWarnings::Warner">
|
82
|
+
<h1 id="class-StructuredWarnings::Warner" class="class">
|
83
|
+
class StructuredWarnings::Warner
|
84
|
+
</h1>
|
145
85
|
|
146
|
-
|
147
|
-
|
86
|
+
<section class="description">
|
87
|
+
|
148
88
|
<p>The <a href="Warner.html">Warner</a> class implements a very simple
|
149
89
|
interface. It simply formats a warning, so it is more than just the message
|
150
90
|
itself. This default warner uses a format comparable to warnings emitted by
|
151
91
|
rb_warn including the place where the “thing that caused the warning”
|
152
92
|
resides.</p>
|
153
93
|
|
154
|
-
|
94
|
+
</section>
|
155
95
|
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
156
100
|
|
157
|
-
|
158
|
-
|
159
|
-
<div id="5Buntitled-5D" class="documentation-section">
|
160
|
-
|
161
101
|
|
162
|
-
|
163
|
-
|
164
|
-
|
102
|
+
|
165
103
|
|
166
|
-
|
104
|
+
|
167
105
|
|
168
|
-
|
169
|
-
|
170
|
-
<div id="public-instance-method-details" class="method-section section">
|
171
|
-
<h3 class="section-header">Public Instance Methods</h3>
|
106
|
+
|
172
107
|
|
173
|
-
|
174
|
-
|
175
|
-
|
108
|
+
|
109
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
110
|
+
<header>
|
111
|
+
<h3>Public Instance Methods</h3>
|
112
|
+
</header>
|
176
113
|
|
114
|
+
|
115
|
+
<div id="method-i-format" class="method-detail ">
|
116
|
+
|
117
|
+
<div class="method-heading">
|
118
|
+
<span class="method-name">format</span><span
|
119
|
+
class="method-args">(warning, message, stack)</span>
|
177
120
|
|
178
|
-
<
|
179
|
-
<span class="method-name">format</span><span
|
180
|
-
class="method-args">(warning, message, stack)</span>
|
181
|
-
<span class="method-click-advice">click to toggle source</span>
|
182
|
-
</div>
|
121
|
+
<span class="method-click-advice">click to toggle source</span>
|
183
122
|
|
123
|
+
</div>
|
124
|
+
|
184
125
|
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
href="../DeprecationWarning.html">DeprecationWarning</a>, “more info..”,
|
189
|
-
caller)</p>
|
126
|
+
<div class="method-description">
|
127
|
+
|
128
|
+
<p>Warner.new.format(DeprecationWarning, “more info..”, caller)</p>
|
190
129
|
|
191
|
-
<pre># => "demo.rb:5 : more info.. (DeprecationWarning)"</
|
192
|
-
|
130
|
+
<pre class="ruby"><span class="ruby-comment"># => "demo.rb:5 : more info.. (DeprecationWarning)"</span>
|
131
|
+
</pre>
|
132
|
+
|
133
|
+
|
193
134
|
|
194
|
-
|
195
|
-
|
196
|
-
<pre>
|
197
|
-
<span class="ruby-comment"># File lib/structured_warnings/warner.rb, line 9</span>
|
135
|
+
|
136
|
+
<div class="method-source-code" id="format-source">
|
137
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/warner.rb, line 9</span>
|
198
138
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">warning</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">stack</span>)
|
199
139
|
<span class="ruby-node">"#{stack.shift} : #{message} (#{warning})"</span>
|
200
140
|
<span class="ruby-keyword">end</span></pre>
|
201
|
-
</div><!-- format-source -->
|
202
|
-
|
203
141
|
</div>
|
204
|
-
|
205
142
|
|
143
|
+
</div>
|
206
144
|
|
207
|
-
|
208
|
-
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
</div>
|
209
149
|
|
210
|
-
|
211
|
-
</div><!-- public-instance-method-details -->
|
212
150
|
|
213
|
-
</
|
151
|
+
</section>
|
214
152
|
|
153
|
+
</section>
|
154
|
+
</main>
|
215
155
|
|
216
|
-
</div><!-- documentation -->
|
217
|
-
|
218
|
-
<div id="validator-badges">
|
219
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
220
|
-
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
221
|
-
Rdoc Generator</a> 2</small>.</p>
|
222
|
-
</div>
|
223
156
|
|
224
|
-
|
225
|
-
</
|
157
|
+
<footer id="validator-badges" role="contentinfo">
|
158
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
159
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
160
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
161
|
+
</footer>
|
226
162
|
|