structured_warnings 0.1.4 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
data/doc/Test.html
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>module Test - structured_warnings</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "./";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="./js/jquery.js"></script>
|
|
14
|
+
<script src="./js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="module">
|
|
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">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
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>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
</div>
|
|
62
|
+
</nav>
|
|
63
|
+
|
|
64
|
+
<main role="main" aria-labelledby="module-Test">
|
|
65
|
+
<h1 id="module-Test" class="module">
|
|
66
|
+
module Test
|
|
67
|
+
</h1>
|
|
68
|
+
|
|
69
|
+
<section class="description">
|
|
70
|
+
|
|
71
|
+
</section>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
</section>
|
|
87
|
+
</main>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
<footer id="validator-badges" role="contentinfo">
|
|
91
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
92
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
|
93
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
94
|
+
</footer>
|
|
95
|
+
|
data/doc/Test/Unit.html
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>module Test::Unit - structured_warnings</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="module">
|
|
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">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
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>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
</div>
|
|
62
|
+
</nav>
|
|
63
|
+
|
|
64
|
+
<main role="main" aria-labelledby="module-Test::Unit">
|
|
65
|
+
<h1 id="module-Test::Unit" class="module">
|
|
66
|
+
module Test::Unit
|
|
67
|
+
</h1>
|
|
68
|
+
|
|
69
|
+
<section class="description">
|
|
70
|
+
|
|
71
|
+
</section>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
</section>
|
|
87
|
+
</main>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
<footer id="validator-badges" role="contentinfo">
|
|
91
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
92
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
|
93
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
94
|
+
</footer>
|
|
95
|
+
|
data/doc/Warning.html
CHANGED
|
@@ -1,460 +1,398 @@
|
|
|
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 Warning - 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/warning_rb.html?TB_iframe=true&height=550&width=785"
|
|
38
|
-
class="thickbox" title="lib/structured_warnings/warning.rb">lib/structured_warnings/warning.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
|
-
|
|
61
|
-
<!-- Namespace Contents -->
|
|
62
|
-
<div id="namespace-list-section" class="section">
|
|
63
|
-
<h3 class="section-header">Namespace</h3>
|
|
64
|
-
<ul class="link-list">
|
|
65
|
-
|
|
66
|
-
<li><span class="type">MODULE</span> <a href="Warning/ClassMethods.html">Warning::ClassMethods</a></li>
|
|
67
|
-
|
|
68
|
-
</ul>
|
|
69
|
-
</div>
|
|
70
|
-
|
|
53
|
+
|
|
71
54
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
<ul class="link-list">
|
|
77
|
-
|
|
78
|
-
<li><a href="#method-c-new">::new</a></li>
|
|
79
|
-
|
|
80
|
-
<li><a href="#method-i-backtrace">#backtrace</a></li>
|
|
81
|
-
|
|
82
|
-
<li><a href="#method-i-inspect">#inspect</a></li>
|
|
83
|
-
|
|
84
|
-
<li><a href="#method-i-message">#message</a></li>
|
|
85
|
-
|
|
86
|
-
<li><a href="#method-i-set_backtrace">#set_backtrace</a></li>
|
|
87
|
-
|
|
88
|
-
<li><a href="#method-i-to_s">#to_s</a></li>
|
|
89
|
-
|
|
90
|
-
<li><a href="#method-i-to_str">#to_str</a></li>
|
|
91
|
-
|
|
92
|
-
</ul>
|
|
93
|
-
</div>
|
|
94
|
-
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
95
59
|
|
|
96
|
-
|
|
97
|
-
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="Object.html">Object</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
98
64
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
<div id="fileindex-section" class="section project-section">
|
|
103
|
-
<h3 class="section-header">Files</h3>
|
|
104
|
-
<ul>
|
|
105
|
-
|
|
106
|
-
<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
|
|
107
|
-
|
|
108
|
-
</ul>
|
|
109
|
-
</div>
|
|
110
|
-
|
|
65
|
+
|
|
66
|
+
<div id="extends-section" class="nav-section">
|
|
67
|
+
<h3>Extended With Modules</h3>
|
|
111
68
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
<input type="text" name="quicksearch" value=""
|
|
121
|
-
class="quicksearch-field" />
|
|
122
|
-
</fieldset>
|
|
123
|
-
</form>
|
|
69
|
+
<ul class="link-list">
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<li><a class="extend" href="Warning/ClassMethods.html">Warning::ClassMethods</a>
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
</ul>
|
|
76
|
+
</div>
|
|
124
77
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
<li><a href="./DeprecatedSignatureWarning.html">DeprecatedSignatureWarning</a></li>
|
|
148
|
-
|
|
149
|
-
<li><a href="./DeprecationWarning.html">DeprecationWarning</a></li>
|
|
150
|
-
|
|
151
|
-
<li><a href="./Dynamic.html">Dynamic</a></li>
|
|
152
|
-
|
|
153
|
-
<li><a href="./Object.html">Object</a></li>
|
|
154
|
-
|
|
155
|
-
<li><a href="./StandardWarning.html">StandardWarning</a></li>
|
|
156
|
-
|
|
157
|
-
</ul>
|
|
158
|
-
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
159
|
-
</div>
|
|
78
|
+
<!-- Method Quickref -->
|
|
79
|
+
<div id="method-list-section" class="nav-section">
|
|
80
|
+
<h3>Methods</h3>
|
|
81
|
+
|
|
82
|
+
<ul class="link-list" role="directory">
|
|
83
|
+
|
|
84
|
+
<li ><a href="#method-c-new">::new</a>
|
|
85
|
+
|
|
86
|
+
<li ><a href="#method-i-backtrace">#backtrace</a>
|
|
87
|
+
|
|
88
|
+
<li ><a href="#method-i-inspect">#inspect</a>
|
|
89
|
+
|
|
90
|
+
<li ><a href="#method-i-message">#message</a>
|
|
91
|
+
|
|
92
|
+
<li ><a href="#method-i-set_backtrace">#set_backtrace</a>
|
|
93
|
+
|
|
94
|
+
<li ><a href="#method-i-to_s">#to_s</a>
|
|
95
|
+
|
|
96
|
+
<li ><a href="#method-i-to_str">#to_str</a>
|
|
97
|
+
|
|
98
|
+
</ul>
|
|
99
|
+
</div>
|
|
160
100
|
|
|
161
|
-
|
|
162
|
-
</div>
|
|
163
101
|
</div>
|
|
102
|
+
</nav>
|
|
164
103
|
|
|
165
|
-
|
|
166
|
-
|
|
104
|
+
<main role="main" aria-labelledby="class-Warning">
|
|
105
|
+
<h1 id="class-Warning" class="class">
|
|
106
|
+
class Warning
|
|
107
|
+
</h1>
|
|
167
108
|
|
|
168
|
-
|
|
169
|
-
|
|
109
|
+
<section class="description">
|
|
110
|
+
|
|
170
111
|
<p>Descendents of class <a href="Warning.html">Warning</a> are used to raise
|
|
171
112
|
structured warnings. They programmers to explicitly supress certain kinds
|
|
172
113
|
of warnings and provide additional information in contrast to the plain
|
|
173
114
|
warn method. They implement an Exception-like interface and carry
|
|
174
|
-
information about the warning – its type (the warning
|
|
115
|
+
information about the warning – its type (the warning's class name), an
|
|
175
116
|
optional descriptive string, and optional traceback information. Programs
|
|
176
117
|
may subclass <a href="Warning.html">Warning</a> to add additional
|
|
177
118
|
information.</p>
|
|
178
119
|
|
|
179
|
-
<p>Large portions of this class
|
|
180
|
-
RDoc.</p>
|
|
120
|
+
<p>Large portions of this class's documentation are taken from the
|
|
121
|
+
Exception RDoc.</p>
|
|
181
122
|
|
|
182
|
-
|
|
123
|
+
</section>
|
|
183
124
|
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
184
129
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
<div id="5Buntitled-5D" class="documentation-section">
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
130
|
|
|
192
|
-
|
|
131
|
+
|
|
193
132
|
|
|
194
|
-
|
|
133
|
+
|
|
195
134
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
<div id="public-class-method-details" class="method-section section">
|
|
199
|
-
<h3 class="section-header">Public Class Methods</h3>
|
|
135
|
+
|
|
200
136
|
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
137
|
+
|
|
138
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
139
|
+
<header>
|
|
140
|
+
<h3>Public Class Methods</h3>
|
|
141
|
+
</header>
|
|
204
142
|
|
|
143
|
+
|
|
144
|
+
<div id="method-c-new" class="method-detail ">
|
|
145
|
+
|
|
146
|
+
<div class="method-heading">
|
|
147
|
+
<span class="method-name">new</span><span
|
|
148
|
+
class="method-args">(message = nil)</span>
|
|
205
149
|
|
|
206
|
-
<
|
|
207
|
-
<span class="method-name">new</span><span
|
|
208
|
-
class="method-args">(message = nil)</span>
|
|
209
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
210
|
-
</div>
|
|
150
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
211
151
|
|
|
152
|
+
</div>
|
|
153
|
+
|
|
212
154
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
155
|
+
<div class="method-description">
|
|
156
|
+
|
|
157
|
+
<p>Construct a new <a href="Warning.html">Warning</a> object, optionally
|
|
216
158
|
passing in a message.</p>
|
|
217
|
-
|
|
159
|
+
|
|
160
|
+
|
|
218
161
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
<pre>
|
|
222
|
-
<span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 13</span>
|
|
162
|
+
|
|
163
|
+
<div class="method-source-code" id="new-source">
|
|
164
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 13</span>
|
|
223
165
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>)
|
|
224
166
|
<span class="ruby-ivar">@message</span> = <span class="ruby-identifier">message</span>
|
|
225
167
|
<span class="ruby-ivar">@backtrace</span> = <span class="ruby-identifier">caller</span>(<span class="ruby-value">1</span>)
|
|
226
168
|
<span class="ruby-keyword">end</span></pre>
|
|
227
|
-
</div><!-- new-source -->
|
|
228
|
-
|
|
229
169
|
</div>
|
|
230
|
-
|
|
231
170
|
|
|
171
|
+
</div>
|
|
232
172
|
|
|
233
|
-
|
|
234
|
-
</div><!-- new-method -->
|
|
173
|
+
|
|
235
174
|
|
|
236
|
-
|
|
237
|
-
</div
|
|
238
|
-
|
|
239
|
-
<div id="public-instance-method-details" class="method-section section">
|
|
240
|
-
<h3 class="section-header">Public Instance Methods</h3>
|
|
175
|
+
|
|
176
|
+
</div>
|
|
241
177
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
178
|
+
|
|
179
|
+
</section>
|
|
180
|
+
|
|
181
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
182
|
+
<header>
|
|
183
|
+
<h3>Public Instance Methods</h3>
|
|
184
|
+
</header>
|
|
245
185
|
|
|
186
|
+
|
|
187
|
+
<div id="method-i-backtrace" class="method-detail ">
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<div class="method-heading">
|
|
191
|
+
<span class="method-callseq">
|
|
192
|
+
backtrace → array
|
|
193
|
+
</span>
|
|
246
194
|
|
|
195
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
247
196
|
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
197
|
+
</div>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<div class="method-description">
|
|
202
|
+
|
|
203
|
+
<p>Returns any backtrace associated with the warning. The backtrace is an
|
|
204
|
+
array of strings, each containing either “filename:lineNo: in
|
|
205
|
+
`method''' or “filename:lineNo.''</p>
|
|
254
206
|
|
|
255
207
|
|
|
256
208
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
<
|
|
260
|
-
array of strings, each containing either “filename:lineNo: in `method”‘ or
|
|
261
|
-
“filename:lineNo.”</p>
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
<div class="method-source-code" id="backtrace-source">
|
|
266
|
-
<pre>
|
|
267
|
-
<span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 25</span>
|
|
209
|
+
|
|
210
|
+
<div class="method-source-code" id="backtrace-source">
|
|
211
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 25</span>
|
|
268
212
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">backtrace</span>
|
|
269
213
|
<span class="ruby-ivar">@backtrace</span>
|
|
270
214
|
<span class="ruby-keyword">end</span></pre>
|
|
271
|
-
</div><!-- backtrace-source -->
|
|
272
|
-
|
|
273
215
|
</div>
|
|
274
|
-
|
|
275
216
|
|
|
217
|
+
</div>
|
|
276
218
|
|
|
277
|
-
|
|
278
|
-
</div><!-- backtrace-method -->
|
|
219
|
+
|
|
279
220
|
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
<a name="method-i-inspect"></a>
|
|
221
|
+
|
|
222
|
+
</div>
|
|
283
223
|
|
|
224
|
+
|
|
225
|
+
<div id="method-i-inspect" class="method-detail ">
|
|
226
|
+
|
|
227
|
+
<div class="method-heading">
|
|
228
|
+
<span class="method-name">inspect</span><span
|
|
229
|
+
class="method-args">()</span>
|
|
284
230
|
|
|
285
|
-
<
|
|
286
|
-
<span class="method-name">inspect</span><span
|
|
287
|
-
class="method-args">()</span>
|
|
288
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
289
|
-
</div>
|
|
231
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
290
232
|
|
|
233
|
+
</div>
|
|
234
|
+
|
|
291
235
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
236
|
+
<div class="method-description">
|
|
237
|
+
|
|
238
|
+
<p>Return this warning's class name and message</p>
|
|
239
|
+
|
|
240
|
+
|
|
296
241
|
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
<pre>
|
|
300
|
-
<span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 44</span>
|
|
242
|
+
|
|
243
|
+
<div class="method-source-code" id="inspect-source">
|
|
244
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 44</span>
|
|
301
245
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
|
|
302
246
|
<span class="ruby-node">"#<#{self.class}: #{self}>"</span>
|
|
303
247
|
<span class="ruby-keyword">end</span></pre>
|
|
304
|
-
</div><!-- inspect-source -->
|
|
305
|
-
|
|
306
248
|
</div>
|
|
307
|
-
|
|
308
249
|
|
|
250
|
+
</div>
|
|
309
251
|
|
|
310
|
-
|
|
311
|
-
</div><!-- inspect-method -->
|
|
252
|
+
|
|
312
253
|
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
<a name="method-i-message"></a>
|
|
254
|
+
|
|
255
|
+
</div>
|
|
316
256
|
|
|
257
|
+
|
|
258
|
+
<div id="method-i-message" class="method-detail method-alias">
|
|
259
|
+
|
|
260
|
+
<div class="method-heading">
|
|
261
|
+
<span class="method-name">message</span><span
|
|
262
|
+
class="method-args">()</span>
|
|
317
263
|
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
class="method-args">()</span>
|
|
321
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
322
|
-
</div>
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
<div class="method-description">
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
</div>
|
|
264
|
+
</div>
|
|
265
|
+
|
|
332
266
|
|
|
267
|
+
<div class="method-description">
|
|
333
268
|
|
|
334
|
-
|
|
335
269
|
|
|
336
|
-
<div class="aliases">
|
|
337
|
-
Alias for: <a href="Warning.html#method-i-to_s">to_s</a>
|
|
338
|
-
</div>
|
|
339
270
|
|
|
340
|
-
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</div>
|
|
341
275
|
|
|
342
|
-
|
|
343
|
-
<div id="set_backtrace-method" class="method-detail ">
|
|
344
|
-
<a name="method-i-set_backtrace"></a>
|
|
276
|
+
|
|
345
277
|
|
|
278
|
+
|
|
279
|
+
<div class="aliases">
|
|
280
|
+
Alias for: <a href="Warning.html#method-i-to_s">to_s</a>
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
</div>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<div id="method-i-set_backtrace" class="method-detail ">
|
|
287
|
+
|
|
288
|
+
<div class="method-heading">
|
|
289
|
+
<span class="method-name">set_backtrace</span><span
|
|
290
|
+
class="method-args">(backtrace)</span>
|
|
346
291
|
|
|
347
|
-
<
|
|
348
|
-
<span class="method-name">set_backtrace</span><span
|
|
349
|
-
class="method-args">(backtrace)</span>
|
|
350
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
351
|
-
</div>
|
|
292
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
352
293
|
|
|
294
|
+
</div>
|
|
295
|
+
|
|
353
296
|
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
297
|
+
<div class="method-description">
|
|
298
|
+
|
|
299
|
+
<p>Sets the backtrace information associated with warning. The argument must
|
|
357
300
|
be an array of String objects in the format described in
|
|
358
301
|
Exception#backtrace.</p>
|
|
359
|
-
|
|
302
|
+
|
|
303
|
+
|
|
360
304
|
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
<pre>
|
|
364
|
-
<span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 32</span>
|
|
305
|
+
|
|
306
|
+
<div class="method-source-code" id="set_backtrace-source">
|
|
307
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 32</span>
|
|
365
308
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">backtrace</span>)
|
|
366
309
|
<span class="ruby-ivar">@backtrace</span> = <span class="ruby-identifier">backtrace</span>
|
|
367
310
|
<span class="ruby-keyword">end</span></pre>
|
|
368
|
-
</div><!-- set_backtrace-source -->
|
|
369
|
-
|
|
370
311
|
</div>
|
|
371
|
-
|
|
372
312
|
|
|
313
|
+
</div>
|
|
373
314
|
|
|
374
|
-
|
|
375
|
-
</div><!-- set_backtrace-method -->
|
|
315
|
+
|
|
376
316
|
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
<a name="method-i-to_s"></a>
|
|
317
|
+
|
|
318
|
+
</div>
|
|
380
319
|
|
|
320
|
+
|
|
321
|
+
<div id="method-i-to_s" class="method-detail ">
|
|
322
|
+
|
|
323
|
+
<div class="method-heading">
|
|
324
|
+
<span class="method-name">to_s</span><span
|
|
325
|
+
class="method-args">()</span>
|
|
381
326
|
|
|
382
|
-
<
|
|
383
|
-
<span class="method-name">to_s</span><span
|
|
384
|
-
class="method-args">()</span>
|
|
385
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
386
|
-
</div>
|
|
327
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
387
328
|
|
|
329
|
+
</div>
|
|
330
|
+
|
|
388
331
|
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
332
|
+
<div class="method-description">
|
|
333
|
+
|
|
334
|
+
<p>Returns warning's message (or the name of the warning if no message is
|
|
392
335
|
set).</p>
|
|
393
|
-
|
|
336
|
+
|
|
337
|
+
|
|
394
338
|
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
<pre>
|
|
398
|
-
<span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 37</span>
|
|
339
|
+
|
|
340
|
+
<div class="method-source-code" id="to_s-source">
|
|
341
|
+
<pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 37</span>
|
|
399
342
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
|
|
400
343
|
<span class="ruby-ivar">@message</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>
|
|
401
344
|
<span class="ruby-keyword">end</span></pre>
|
|
402
|
-
</div><!-- to_s-source -->
|
|
403
|
-
|
|
404
|
-
</div>
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
<div class="aliases">
|
|
408
|
-
Also aliased as: <a href="Warning.html#method-i-to_str">to_str</a>, <a href="Warning.html#method-i-message">message</a>
|
|
409
345
|
</div>
|
|
410
346
|
|
|
347
|
+
</div>
|
|
411
348
|
|
|
412
|
-
|
|
413
|
-
|
|
349
|
+
|
|
350
|
+
<div class="aliases">
|
|
351
|
+
Also aliased as: <a href="Warning.html#method-i-to_str">to_str</a>, <a href="Warning.html#method-i-message">message</a>
|
|
352
|
+
</div>
|
|
353
|
+
|
|
414
354
|
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
<a name="method-i-to_str"></a>
|
|
355
|
+
|
|
356
|
+
</div>
|
|
418
357
|
|
|
358
|
+
|
|
359
|
+
<div id="method-i-to_str" class="method-detail method-alias">
|
|
360
|
+
|
|
361
|
+
<div class="method-heading">
|
|
362
|
+
<span class="method-name">to_str</span><span
|
|
363
|
+
class="method-args">()</span>
|
|
419
364
|
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
class="method-args">()</span>
|
|
423
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
424
|
-
</div>
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
<div class="method-description">
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
</div>
|
|
365
|
+
</div>
|
|
366
|
+
|
|
434
367
|
|
|
368
|
+
<div class="method-description">
|
|
369
|
+
|
|
435
370
|
|
|
436
|
-
|
|
437
371
|
|
|
438
|
-
<div class="aliases">
|
|
439
|
-
Alias for: <a href="Warning.html#method-i-to_s">to_s</a>
|
|
440
|
-
</div>
|
|
441
372
|
|
|
442
|
-
</div><!-- to_str-method -->
|
|
443
373
|
|
|
444
|
-
|
|
445
|
-
|
|
374
|
+
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<div class="aliases">
|
|
381
|
+
Alias for: <a href="Warning.html#method-i-to_s">to_s</a>
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
</div>
|
|
385
|
+
|
|
446
386
|
|
|
447
|
-
</
|
|
387
|
+
</section>
|
|
448
388
|
|
|
389
|
+
</section>
|
|
390
|
+
</main>
|
|
449
391
|
|
|
450
|
-
</div><!-- documentation -->
|
|
451
|
-
|
|
452
|
-
<div id="validator-badges">
|
|
453
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
454
|
-
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
455
|
-
Rdoc Generator</a> 2</small>.</p>
|
|
456
|
-
</div>
|
|
457
392
|
|
|
458
|
-
|
|
459
|
-
</
|
|
393
|
+
<footer id="validator-badges" role="contentinfo">
|
|
394
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
395
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
|
396
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
397
|
+
</footer>
|
|
460
398
|
|