structured_warnings 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +200 -0
  3. data/lib/{structured_warnings/dynamic.rb → dynamic.rb} +0 -0
  4. data/lib/structured_warnings.rb +19 -9
  5. data/lib/structured_warnings/base.rb +132 -0
  6. data/lib/structured_warnings/kernel.rb +5 -65
  7. data/lib/structured_warnings/minitest.rb +5 -0
  8. data/lib/structured_warnings/test.rb +3 -5
  9. data/lib/structured_warnings/test/assertions.rb +93 -98
  10. data/lib/structured_warnings/test/warner.rb +32 -35
  11. data/lib/structured_warnings/test_unit.rb +5 -0
  12. data/lib/structured_warnings/version.rb +3 -0
  13. data/lib/structured_warnings/warner.rb +13 -11
  14. data/lib/structured_warnings/warning.rb +61 -119
  15. data/lib/warning.rb +9 -0
  16. metadata +53 -92
  17. data/Gemfile +0 -3
  18. data/Gemfile.lock +0 -21
  19. data/History.txt +0 -36
  20. data/License.txt +0 -20
  21. data/README.rdoc +0 -137
  22. data/Rakefile +0 -55
  23. data/doc/DeprecatedMethodWarning.html +0 -105
  24. data/doc/DeprecatedSignatureWarning.html +0 -106
  25. data/doc/DeprecationWarning.html +0 -106
  26. data/doc/Dynamic.html +0 -125
  27. data/doc/Object.html +0 -117
  28. data/doc/README_rdoc.html +0 -283
  29. data/doc/StandardWarning.html +0 -104
  30. data/doc/StructuredWarnings.html +0 -125
  31. data/doc/StructuredWarnings/ClassMethods.html +0 -192
  32. data/doc/StructuredWarnings/Kernel.html +0 -222
  33. data/doc/StructuredWarnings/Test.html +0 -97
  34. data/doc/StructuredWarnings/Test/Assertions.html +0 -272
  35. data/doc/StructuredWarnings/Test/Warner.html +0 -208
  36. data/doc/StructuredWarnings/Warner.html +0 -162
  37. data/doc/Test.html +0 -95
  38. data/doc/Test/Unit.html +0 -95
  39. data/doc/Warning.html +0 -398
  40. data/doc/Warning/ClassMethods.html +0 -278
  41. data/doc/created.rid +0 -10
  42. data/doc/css/fonts.css +0 -167
  43. data/doc/css/rdoc.css +0 -590
  44. data/doc/fonts/Lato-Light.ttf +0 -0
  45. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  46. data/doc/fonts/Lato-Regular.ttf +0 -0
  47. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  48. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  49. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  50. data/doc/images/add.png +0 -0
  51. data/doc/images/arrow_up.png +0 -0
  52. data/doc/images/brick.png +0 -0
  53. data/doc/images/brick_link.png +0 -0
  54. data/doc/images/bug.png +0 -0
  55. data/doc/images/bullet_black.png +0 -0
  56. data/doc/images/bullet_toggle_minus.png +0 -0
  57. data/doc/images/bullet_toggle_plus.png +0 -0
  58. data/doc/images/date.png +0 -0
  59. data/doc/images/delete.png +0 -0
  60. data/doc/images/find.png +0 -0
  61. data/doc/images/loadingAnimation.gif +0 -0
  62. data/doc/images/macFFBgHack.png +0 -0
  63. data/doc/images/package.png +0 -0
  64. data/doc/images/page_green.png +0 -0
  65. data/doc/images/page_white_text.png +0 -0
  66. data/doc/images/page_white_width.png +0 -0
  67. data/doc/images/plugin.png +0 -0
  68. data/doc/images/ruby.png +0 -0
  69. data/doc/images/tag_blue.png +0 -0
  70. data/doc/images/tag_green.png +0 -0
  71. data/doc/images/transparent.png +0 -0
  72. data/doc/images/wrench.png +0 -0
  73. data/doc/images/wrench_orange.png +0 -0
  74. data/doc/images/zoom.png +0 -0
  75. data/doc/index.html +0 -121
  76. data/doc/js/darkfish.js +0 -161
  77. data/doc/js/jquery.js +0 -4
  78. data/doc/js/navigation.js +0 -142
  79. data/doc/js/navigation.js.gz +0 -0
  80. data/doc/js/search.js +0 -109
  81. data/doc/js/search_index.js +0 -1
  82. data/doc/js/search_index.js.gz +0 -0
  83. data/doc/js/searcher.js +0 -228
  84. data/doc/js/searcher.js.gz +0 -0
  85. data/doc/table_of_contents.html +0 -200
  86. data/structured_warnings.gemspec +0 -24
  87. data/test/structured_warnings_test.rb +0 -187
data/doc/Warning/ClassMethods.html DELETED
@@ -1,278 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>module Warning::ClassMethods - 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
- <!-- Method Quickref -->
61
- <div id="method-list-section" class="nav-section">
62
- <h3>Methods</h3>
63
-
64
- <ul class="link-list" role="directory">
65
-
66
- <li ><a href="#method-i-active-3F">#active?</a>
67
-
68
- <li ><a href="#method-i-disable">#disable</a>
69
-
70
- <li ><a href="#method-i-enable">#enable</a>
71
-
72
- </ul>
73
- </div>
74
-
75
- </div>
76
- </nav>
77
-
78
- <main role="main" aria-labelledby="module-Warning::ClassMethods">
79
- <h1 id="module-Warning::ClassMethods" class="module">
80
- module Warning::ClassMethods
81
- </h1>
82
-
83
- <section class="description">
84
-
85
- <p>This module extends <a href="../Warning.html">Warning</a> and each
86
- subclass. It may be used to activate or deactivate a set of warnings.</p>
87
-
88
- </section>
89
-
90
-
91
-
92
-
93
- <section id="5Buntitled-5D" class="documentation-section">
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
104
- <header>
105
- <h3>Public Instance Methods</h3>
106
- </header>
107
-
108
-
109
- <div id="method-i-active-3F" class="method-detail ">
110
-
111
- <div class="method-heading">
112
- <span class="method-name">active?</span><span
113
- class="method-args">()</span>
114
-
115
- <span class="method-click-advice">click to toggle source</span>
116
-
117
- </div>
118
-
119
-
120
- <div class="method-description">
121
-
122
- <p>returns a Boolean, stating whether a warning of this type would be emmitted
123
- or not.</p>
124
-
125
-
126
-
127
-
128
- <div class="method-source-code" id="active-3F-source">
129
- <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 53</span>
130
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">active?</span>
131
- <span class="ruby-constant">StructuredWarnings</span><span class="ruby-operator">::</span><span class="ruby-identifier">disabled_warnings</span>.<span class="ruby-identifier">all?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">w</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">w</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-keyword">self</span>)}
132
- <span class="ruby-keyword">end</span></pre>
133
- </div>
134
-
135
- </div>
136
-
137
-
138
-
139
-
140
- </div>
141
-
142
-
143
- <div id="method-i-disable" class="method-detail ">
144
-
145
-
146
- <div class="method-heading">
147
- <span class="method-callseq">
148
- disable()
149
- </span>
150
-
151
- <span class="method-click-advice">click to toggle source</span>
152
-
153
- </div>
154
-
155
- <div class="method-heading">
156
- <span class="method-callseq">
157
- disable() {...}
158
- </span>
159
-
160
- </div>
161
-
162
-
163
-
164
- <div class="method-description">
165
-
166
- <p>If called without a block, Warnings of this type will be disabled in the
167
- current thread and all new child threads.</p>
168
-
169
- <pre class="ruby"><span class="ruby-identifier">warn</span>(<span class="ruby-string">&quot;this will be printed&quot;</span>) <span class="ruby-comment"># creates a StandardWarning which is</span>
170
- <span class="ruby-comment"># enabled by default</span>
171
-
172
- <span class="ruby-constant">Warning</span>.<span class="ruby-identifier">disable</span>
173
-
174
- <span class="ruby-identifier">warn</span>(<span class="ruby-string">&quot;this will not be printed&quot;</span>) <span class="ruby-comment"># creates a StandardWarning which is</span>
175
- <span class="ruby-comment"># currently disabled</span>
176
- </pre>
177
-
178
- <p>If called with a block, warnings of this type will be disabled in the
179
- dynamic scope of the given block.</p>
180
-
181
- <pre class="ruby"><span class="ruby-constant">Warning</span>.<span class="ruby-identifier">disable</span> <span class="ruby-keyword">do</span>
182
- <span class="ruby-identifier">warn</span>(<span class="ruby-string">&quot;this will not be printed&quot;</span>) <span class="ruby-comment"># creates a StandardWarning which is</span>
183
- <span class="ruby-comment"># currently disabled</span>
184
- <span class="ruby-keyword">end</span>
185
-
186
- <span class="ruby-identifier">warn</span>(<span class="ruby-string">&quot;this will be printed&quot;</span>) <span class="ruby-comment"># creates a StandardWarning which is</span>
187
- <span class="ruby-comment"># currently enabled</span>
188
- </pre>
189
-
190
-
191
-
192
-
193
- <div class="method-source-code" id="disable-source">
194
- <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 82</span>
195
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">disable</span>
196
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
197
- <span class="ruby-constant">StructuredWarnings</span><span class="ruby-operator">::</span><span class="ruby-identifier">with_disabled_warnings</span>(
198
- <span class="ruby-constant">StructuredWarnings</span>.<span class="ruby-identifier">disabled_warnings</span> <span class="ruby-operator">|</span> [<span class="ruby-keyword">self</span>]) <span class="ruby-keyword">do</span>
199
- <span class="ruby-keyword">yield</span>
200
- <span class="ruby-keyword">end</span>
201
- <span class="ruby-keyword">else</span>
202
- <span class="ruby-constant">StructuredWarnings</span><span class="ruby-operator">::</span><span class="ruby-identifier">disabled_warnings</span> <span class="ruby-operator">|=</span> [<span class="ruby-keyword">self</span>]
203
- <span class="ruby-keyword">end</span>
204
- <span class="ruby-keyword">end</span></pre>
205
- </div>
206
-
207
- </div>
208
-
209
-
210
-
211
-
212
- </div>
213
-
214
-
215
- <div id="method-i-enable" class="method-detail ">
216
-
217
-
218
- <div class="method-heading">
219
- <span class="method-callseq">
220
- enable()
221
- </span>
222
-
223
- <span class="method-click-advice">click to toggle source</span>
224
-
225
- </div>
226
-
227
- <div class="method-heading">
228
- <span class="method-callseq">
229
- enable() {...}
230
- </span>
231
-
232
- </div>
233
-
234
-
235
-
236
- <div class="method-description">
237
-
238
- <p>This method has the same semantics as disable, only with the opposite
239
- outcome. In general the last assignment wins, so that disabled warnings may
240
- be enabled again and so on.</p>
241
-
242
-
243
-
244
-
245
- <div class="method-source-code" id="enable-source">
246
- <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 100</span>
247
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">enable</span>
248
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
249
- <span class="ruby-constant">StructuredWarnings</span><span class="ruby-operator">::</span><span class="ruby-identifier">with_disabled_warnings</span>(
250
- <span class="ruby-constant">StructuredWarnings</span>.<span class="ruby-identifier">disabled_warnings</span> <span class="ruby-operator">-</span> [<span class="ruby-keyword">self</span>]) <span class="ruby-keyword">do</span>
251
- <span class="ruby-keyword">yield</span>
252
- <span class="ruby-keyword">end</span>
253
- <span class="ruby-keyword">else</span>
254
- <span class="ruby-constant">StructuredWarnings</span><span class="ruby-operator">::</span><span class="ruby-identifier">disabled_warnings</span> <span class="ruby-operator">-=</span> [<span class="ruby-keyword">self</span>]
255
- <span class="ruby-keyword">end</span>
256
- <span class="ruby-keyword">end</span></pre>
257
- </div>
258
-
259
- </div>
260
-
261
-
262
-
263
-
264
- </div>
265
-
266
-
267
- </section>
268
-
269
- </section>
270
- </main>
271
-
272
-
273
- <footer id="validator-badges" role="contentinfo">
274
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
275
- <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
276
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
277
- </footer>
278
-
data/doc/created.rid DELETED
@@ -1,10 +0,0 @@
1
- Thu, 15 Jan 2015 22:07:37 +0100
2
- README.rdoc Thu, 15 Jan 2015 22:01:40 +0100
3
- lib/structured_warnings.rb Thu, 15 Jan 2015 20:46:48 +0100
4
- lib/structured_warnings/dynamic.rb Thu, 15 Jan 2015 20:46:48 +0100
5
- lib/structured_warnings/kernel.rb Thu, 15 Jan 2015 21:22:47 +0100
6
- lib/structured_warnings/test.rb Thu, 15 Jan 2015 20:46:48 +0100
7
- lib/structured_warnings/test/assertions.rb Thu, 15 Jan 2015 20:46:48 +0100
8
- lib/structured_warnings/test/warner.rb Thu, 15 Jan 2015 20:46:48 +0100
9
- lib/structured_warnings/warner.rb Thu, 15 Jan 2015 20:46:48 +0100
10
- lib/structured_warnings/warning.rb Thu, 15 Jan 2015 20:46:48 +0100
data/doc/css/fonts.css DELETED
@@ -1,167 +0,0 @@
1
- /*
2
- * Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
3
- * with Reserved Font Name "Source". All Rights Reserved. Source is a
4
- * trademark of Adobe Systems Incorporated in the United States and/or other
5
- * countries.
6
- *
7
- * This Font Software is licensed under the SIL Open Font License, Version
8
- * 1.1.
9
- *
10
- * This license is copied below, and is also available with a FAQ at:
11
- * http://scripts.sil.org/OFL
12
- */
13
-
14
- @font-face {
15
- font-family: "Source Code Pro";
16
- font-style: normal;
17
- font-weight: 400;
18
- src: local("Source Code Pro"),
19
- local("SourceCodePro-Regular"),
20
- url("fonts/SourceCodePro-Regular.ttf") format("truetype");
21
- }
22
-
23
- @font-face {
24
- font-family: "Source Code Pro";
25
- font-style: normal;
26
- font-weight: 700;
27
- src: local("Source Code Pro Bold"),
28
- local("SourceCodePro-Bold"),
29
- url("fonts/SourceCodePro-Bold.ttf") format("truetype");
30
- }
31
-
32
- /*
33
- * Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com),
34
- * with Reserved Font Name Lato.
35
- *
36
- * This Font Software is licensed under the SIL Open Font License, Version
37
- * 1.1.
38
- *
39
- * This license is copied below, and is also available with a FAQ at:
40
- * http://scripts.sil.org/OFL
41
- */
42
-
43
- @font-face {
44
- font-family: "Lato";
45
- font-style: normal;
46
- font-weight: 300;
47
- src: local("Lato Light"),
48
- local("Lato-Light"),
49
- url("fonts/Lato-Light.ttf") format("truetype");
50
- }
51
-
52
- @font-face {
53
- font-family: "Lato";
54
- font-style: italic;
55
- font-weight: 300;
56
- src: local("Lato Light Italic"),
57
- local("Lato-LightItalic"),
58
- url("fonts/Lato-LightItalic.ttf") format("truetype");
59
- }
60
-
61
- @font-face {
62
- font-family: "Lato";
63
- font-style: normal;
64
- font-weight: 700;
65
- src: local("Lato Regular"),
66
- local("Lato-Regular"),
67
- url("fonts/Lato-Regular.ttf") format("truetype");
68
- }
69
-
70
- @font-face {
71
- font-family: "Lato";
72
- font-style: italic;
73
- font-weight: 700;
74
- src: local("Lato Italic"),
75
- local("Lato-Italic"),
76
- url("fonts/Lato-RegularItalic.ttf") format("truetype");
77
- }
78
-
79
- /*
80
- * -----------------------------------------------------------
81
- * SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
82
- * -----------------------------------------------------------
83
- *
84
- * PREAMBLE
85
- * The goals of the Open Font License (OFL) are to stimulate worldwide
86
- * development of collaborative font projects, to support the font creation
87
- * efforts of academic and linguistic communities, and to provide a free and
88
- * open framework in which fonts may be shared and improved in partnership
89
- * with others.
90
- *
91
- * The OFL allows the licensed fonts to be used, studied, modified and
92
- * redistributed freely as long as they are not sold by themselves. The
93
- * fonts, including any derivative works, can be bundled, embedded,
94
- * redistributed and/or sold with any software provided that any reserved
95
- * names are not used by derivative works. The fonts and derivatives,
96
- * however, cannot be released under any other type of license. The
97
- * requirement for fonts to remain under this license does not apply
98
- * to any document created using the fonts or their derivatives.
99
- *
100
- * DEFINITIONS
101
- * "Font Software" refers to the set of files released by the Copyright
102
- * Holder(s) under this license and clearly marked as such. This may
103
- * include source files, build scripts and documentation.
104
- *
105
- * "Reserved Font Name" refers to any names specified as such after the
106
- * copyright statement(s).
107
- *
108
- * "Original Version" refers to the collection of Font Software components as
109
- * distributed by the Copyright Holder(s).
110
- *
111
- * "Modified Version" refers to any derivative made by adding to, deleting,
112
- * or substituting -- in part or in whole -- any of the components of the
113
- * Original Version, by changing formats or by porting the Font Software to a
114
- * new environment.
115
- *
116
- * "Author" refers to any designer, engineer, programmer, technical
117
- * writer or other person who contributed to the Font Software.
118
- *
119
- * PERMISSION & CONDITIONS
120
- * Permission is hereby granted, free of charge, to any person obtaining
121
- * a copy of the Font Software, to use, study, copy, merge, embed, modify,
122
- * redistribute, and sell modified and unmodified copies of the Font
123
- * Software, subject to the following conditions:
124
- *
125
- * 1) Neither the Font Software nor any of its individual components,
126
- * in Original or Modified Versions, may be sold by itself.
127
- *
128
- * 2) Original or Modified Versions of the Font Software may be bundled,
129
- * redistributed and/or sold with any software, provided that each copy
130
- * contains the above copyright notice and this license. These can be
131
- * included either as stand-alone text files, human-readable headers or
132
- * in the appropriate machine-readable metadata fields within text or
133
- * binary files as long as those fields can be easily viewed by the user.
134
- *
135
- * 3) No Modified Version of the Font Software may use the Reserved Font
136
- * Name(s) unless explicit written permission is granted by the corresponding
137
- * Copyright Holder. This restriction only applies to the primary font name as
138
- * presented to the users.
139
- *
140
- * 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
141
- * Software shall not be used to promote, endorse or advertise any
142
- * Modified Version, except to acknowledge the contribution(s) of the
143
- * Copyright Holder(s) and the Author(s) or with their explicit written
144
- * permission.
145
- *
146
- * 5) The Font Software, modified or unmodified, in part or in whole,
147
- * must be distributed entirely under this license, and must not be
148
- * distributed under any other license. The requirement for fonts to
149
- * remain under this license does not apply to any document created
150
- * using the Font Software.
151
- *
152
- * TERMINATION
153
- * This license becomes null and void if any of the above conditions are
154
- * not met.
155
- *
156
- * DISCLAIMER
157
- * THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
158
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
159
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
160
- * OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
161
- * COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
162
- * INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
163
- * DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
164
- * FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
165
- * OTHER DEALINGS IN THE FONT SOFTWARE.
166
- */
167
-