RubyGems - structured_warnings - Versions diffs - 0.2.0 → 0.3.0 - Mend

structured_warnings 0.2.0 → 0.3.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.

Files changed (87) hide show

checksums.yaml +4 -4
data/README.md +200 -0
data/lib/{structured_warnings/dynamic.rb → dynamic.rb} +0 -0
data/lib/structured_warnings.rb +19 -9
data/lib/structured_warnings/base.rb +132 -0
data/lib/structured_warnings/kernel.rb +5 -65
data/lib/structured_warnings/minitest.rb +5 -0
data/lib/structured_warnings/test.rb +3 -5
data/lib/structured_warnings/test/assertions.rb +93 -98
data/lib/structured_warnings/test/warner.rb +32 -35
data/lib/structured_warnings/test_unit.rb +5 -0
data/lib/structured_warnings/version.rb +3 -0
data/lib/structured_warnings/warner.rb +13 -11
data/lib/structured_warnings/warning.rb +61 -119
data/lib/warning.rb +9 -0
metadata +53 -92
data/Gemfile +0 -3
data/Gemfile.lock +0 -21
data/History.txt +0 -36
data/License.txt +0 -20
data/README.rdoc +0 -137
data/Rakefile +0 -55
data/doc/DeprecatedMethodWarning.html +0 -105
data/doc/DeprecatedSignatureWarning.html +0 -106
data/doc/DeprecationWarning.html +0 -106
data/doc/Dynamic.html +0 -125
data/doc/Object.html +0 -117
data/doc/README_rdoc.html +0 -283
data/doc/StandardWarning.html +0 -104
data/doc/StructuredWarnings.html +0 -125
data/doc/StructuredWarnings/ClassMethods.html +0 -192
data/doc/StructuredWarnings/Kernel.html +0 -222
data/doc/StructuredWarnings/Test.html +0 -97
data/doc/StructuredWarnings/Test/Assertions.html +0 -272
data/doc/StructuredWarnings/Test/Warner.html +0 -208
data/doc/StructuredWarnings/Warner.html +0 -162
data/doc/Test.html +0 -95
data/doc/Test/Unit.html +0 -95
data/doc/Warning.html +0 -398
data/doc/Warning/ClassMethods.html +0 -278
data/doc/created.rid +0 -10
data/doc/css/fonts.css +0 -167
data/doc/css/rdoc.css +0 -590
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/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +0 -121
data/doc/js/darkfish.js +0 -161
data/doc/js/jquery.js +0 -4
data/doc/js/navigation.js +0 -142
data/doc/js/navigation.js.gz +0 -0
data/doc/js/search.js +0 -109
data/doc/js/search_index.js +0 -1
data/doc/js/search_index.js.gz +0 -0
data/doc/js/searcher.js +0 -228
data/doc/js/searcher.js.gz +0 -0
data/doc/table_of_contents.html +0 -200
data/structured_warnings.gemspec +0 -24
data/test/structured_warnings_test.rb +0 -187

data/doc/README_rdoc.html DELETED

@@ -1,283 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>README - structured_warnings</title>
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-<script src="./js/jquery.js"></script>
-<script src="./js/darkfish.js"></script>
-<link href="./css/fonts.css" rel="stylesheet">
-<link href="./css/rdoc.css" rel="stylesheet">
-<body id="top" role="document" class="file">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-<div class="nav-section">
-  <h3>Table of Contents</h3>
-  <ul class="link-list" role="directory">
-    <li><a href="#label-Structured+Warnings">Structured Warnings</a>
-    <li><a href="#label-Installation+-26+Compatibility">Installation &amp; Compatibility</a>
-    <li><a href="#label-Example+Usage">Example Usage</a>
-    <li><a href="#label-Detailed+Documentation">Detailed Documentation</a>
-    <li><a href="#label-Resources">Resources</a>
-    <li><a href="#label-How+to+submit+patches">How to submit patches</a>
-    <li><a href="#label-Known+Issues">Known Issues</a>
-    <li><a href="#label-License">License</a>
-  </ul>
-</div>
-  <div id="project-metadata">
-    <div id="fileindex-section" class="nav-section">
-  <h3>Pages</h3>
-  <ul class="link-list">
-    <li><a href="./README_rdoc.html">README</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-label="Page README.rdoc">
-<h1 id="label-Structured+Warnings">Structured Warnings<span><a href="#label-Structured+Warnings">&para;</a> <a href="#top">&uarr;</a></span></h1>
-<p>This is an implementation of Daniel Berger&#39;s <a
-href="http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html">proposal
-of structured warnings for Ruby</a>. They provide dynamic suppression and
-activation, as well as, an inheritance hierarchy to model their relations.
-This library preserves the old <code>warn</code> signature, but
-additionally allows a <code>raise</code>-like use.</p>
-<p>For more information on the usage and benefits of this library have a look
-at the inspiring article at O&#39;Reilly.</p>
-<p><a
-href="http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html">www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html</a></p>
-<h2 id="label-Installation+-26+Compatibility">Installation &amp; Compatibility<span><a href="#label-Installation+-26+Compatibility">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">structured_warnings</span>
-</pre>
-<p>structured_warnings works with all interpreters, it was tested with.</p>
-<ul><li>
-<p>Ruby 1.8-2.2</p>
-</li><li>
-<p>Rubinius 2.4</p>
-</li><li>
-<p>JRuby 1.7</p>
-</li></ul>
-<p>Please let me know, of any other compatibilities or file a bug for any
-incompatibilities.</p>
-<h2 id="label-Example+Usage">Example Usage<span><a href="#label-Example+Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>To get you started - here is a short example</p>
-<p>In order to use structured_warnings in library code, use the following
-code.</p>
-<pre class="ruby"><span class="ruby-comment"># in lib/...</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;structured_warnings&#39;</span>
-<span class="ruby-keyword">class</span> <span class="ruby-constant">Foo</span>
-  <span class="ruby-keyword">def</span> <span class="ruby-identifier">old_method</span>
-    <span class="ruby-identifier">warn</span> <span class="ruby-constant">DeprecatedMethodWarning</span>, <span class="ruby-string">&#39;This method is deprecated. Use new_method instead&#39;</span>
-    <span class="ruby-comment"># Do stuff</span>
-  <span class="ruby-keyword">end</span>
-<span class="ruby-keyword">end</span>
-<span class="ruby-comment"># in test/...</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;test/unit&#39;</span>
-<span class="ruby-identifier">require</span> <span class="ruby-string">&#39;structured_warnings&#39;</span>
-<span class="ruby-keyword">class</span> <span class="ruby-constant">FooTests</span> <span class="ruby-operator">&lt;</span> <span class="ruby-constant">Test</span><span class="ruby-operator">::</span><span class="ruby-constant">Unit</span><span class="ruby-operator">::</span><span class="ruby-constant">TestCase</span>
-  <span class="ruby-keyword">def</span> <span class="ruby-identifier">setup</span>
-    <span class="ruby-ivar">@foo</span> = <span class="ruby-constant">Foo</span>.<span class="ruby-identifier">new</span>
-  <span class="ruby-keyword">end</span>
-  <span class="ruby-keyword">def</span> <span class="ruby-identifier">test_old_method_emits_deprecation_warning</span>
-    <span class="ruby-identifier">assert_warn</span>(<span class="ruby-constant">DeprecatedMethodWarning</span>){ <span class="ruby-ivar">@foo</span>.<span class="ruby-identifier">old_method</span> }
-  <span class="ruby-keyword">end</span>
-<span class="ruby-keyword">end</span>
-</pre>
-<p><a href="DeprecatedMethodWarning.html">DeprecatedMethodWarning</a> is only
-one of multiple predefined warning types. You may add your own types by
-subclassing <a href="Warning.html">Warning</a> if you like.</p>
-<p>Client code of your library will look as follows:</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&quot;foo&quot;</span>
-<span class="ruby-identifier">foo</span> = <span class="ruby-constant">Foo</span>.<span class="ruby-identifier">new</span>
-<span class="ruby-identifier">foo</span>.<span class="ruby-identifier">old_method</span> <span class="ruby-comment"># =&gt; will print</span>
-               <span class="ruby-comment"># ... `old_method&#39; : This method is deprecated. Use new_method instead (DeprecatedMethodWarning)</span>
-</pre>
-<p>But the main difference to the standard warning concept shipped with ruby,
-is that the client is able to selectively disable certain warnings s/he is
-aware of and not willing to fix.</p>
-<pre class="ruby"><span class="ruby-constant">DeprecatedMethodWarning</span>.<span class="ruby-identifier">disable</span> <span class="ruby-comment"># Globally disable warnings about deprecated methods!</span>
-<span class="ruby-identifier">foo</span>.<span class="ruby-identifier">old_method</span> <span class="ruby-comment"># =&gt; will print nothing</span>
-<span class="ruby-constant">DeprecatedMethodWarning</span>.<span class="ruby-identifier">enable</span> <span class="ruby-comment"># Reenable warnings again.</span>
-</pre>
-<p>And there is an even more powerful option for your clients, the can
-selectively disable warnings in a dynamic block scope.</p>
-<pre class="ruby"><span class="ruby-comment"># Don&#39;t bug me about deprecated method warnings within this block, I know</span>
-<span class="ruby-comment"># what I&#39;m doing.</span>
-<span class="ruby-comment">#</span>
-<span class="ruby-constant">DeprecatedMethodWarning</span>.<span class="ruby-identifier">disable</span> <span class="ruby-keyword">do</span>
-  <span class="ruby-identifier">foo</span>.<span class="ruby-identifier">old_method</span>
-<span class="ruby-keyword">end</span>
-</pre>
-<p>These settings are scoped to the local thread (and all threads spawned in
-the block scope) and automatically reset after the block.</p>
-<h2 id="label-Detailed+Documentation">Detailed Documentation<span><a href="#label-Detailed+Documentation">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>Have closer look at the RDoc of <a
-href="StructuredWarnings/Kernel.html">StructuredWarnings::Kernel</a>, <a
-href="Warning.html">Warning</a> and <a
-href="Warning/ClassMethods.html">Warning::ClassMethods</a>.</p>
-<p>Part of this library is a set of different warnings:</p>
-<ul><li>
-<p><a href="Warning.html">Warning</a></p>
-<ul><li>
-<p><a href="StandardWarning.html">StandardWarning</a></p>
-</li><li>
-<p><a href="DeprecationWarning.html">DeprecationWarning</a></p>
-<ul><li>
-<p><a href="DeprecatedMethodWarning.html">DeprecatedMethodWarning</a></p>
-</li><li>
-<p><a href="DeprecatedSignatureWarning.html">DeprecatedSignatureWarning</a></p>
-</li></ul>
-</li></ul>
-</li></ul>
-<p>You are encourage to use your own subclasses of <a
-href="Warning.html">Warning</a> to give as much feedback to your users as
-possible.</p>
-<h2 id="label-Resources">Resources<span><a href="#label-Resources">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<ul><li>
-<p><a
-href="http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html">Inspiring
-article</a></p>
-</li><li>
-<p><a
-href="http://www.nach-vorne.de/2008/2/22/structured_warnings-highlights">Implementation
-Highlights</a></p>
-</li><li>
-<p><a href="http://github.com/schmidt/structured_warnings/">Project’s
-website</a></p>
-</li><li>
-<p><a href="http://rdoc.info/projects/schmidt/structured_warnings">API doc</a></p>
-</li><li>
-<p><a href="http://runcoderun.com/schmidt/structured_warnings">Build Status on
-RunCodeRun</a></p>
-</li></ul>
-<h2 id="label-How+to+submit+patches">How to submit patches<span><a href="#label-How+to+submit+patches">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>In order to submit patches, please fork the repository on GitHub, add your
-patches to your own copy and send a “Pull Request” afterwards. I will then
-try to add your submissions as soon as possible. Patches containing
-corresponding tests are always welcome.</p>
-<p>Bug reports or general feature requests should be added using GitHub
-Issues.</p>
-<h2 id="label-Known+Issues">Known Issues<span><a href="#label-Known+Issues">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>Although the library transparently coorperates with Ruby&#39;s built-in
-<code>Kernel#warn</code>, it may not override <code>rb_warn</code> which is
-used internally to emit “method redefined”, “void context”, and
-“parenthesis” warnings. They may not be manipulated by structured_warnings.</p>
-<h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>This code is free to use under the terms of the MIT license.</p>
-<pre>Copyright (c) 2008 Gregor Schmidt
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-&quot;Software&quot;), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</pre>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>

data/doc/StandardWarning.html DELETED

@@ -1,104 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class StandardWarning - structured_warnings</title>
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-<script src="./js/jquery.js"></script>
-<script src="./js/darkfish.js"></script>
-<link href="./css/fonts.css" rel="stylesheet">
-<link href="./css/rdoc.css" rel="stylesheet">
-<body id="top" role="document" class="class">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-  <div id="class-metadata">
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link"><a href="Warning.html">Warning</a>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-StandardWarning">
-  <h1 id="class-StandardWarning" class="class">
-    class StandardWarning
-  </h1>
-  <section class="description">
-<p>This warning is used when calling #Kernel.warn without arguments.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-  </section>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>

data/doc/StructuredWarnings.html DELETED

@@ -1,125 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>module StructuredWarnings - structured_warnings</title>
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-<script src="./js/jquery.js"></script>
-<script src="./js/darkfish.js"></script>
-<link href="./css/fonts.css" rel="stylesheet">
-<link href="./css/rdoc.css" rel="stylesheet">
-<body id="top" role="document" class="module">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-  <div id="class-metadata">
-    <div id="extends-section" class="nav-section">
-  <h3>Extended With Modules</h3>
-  <ul class="link-list">
-    <li><a class="extend" href="StructuredWarnings/ClassMethods.html">StructuredWarnings::ClassMethods</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="module-StructuredWarnings">
-  <h1 id="module-StructuredWarnings" class="module">
-    module StructuredWarnings
-  </h1>
-  <section class="description">
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-    <section class="constants-list">
-      <header>
-        <h3>Constants</h3>
-      </header>
-      <dl>
-        <dt id="disabled_warnings">disabled_warnings
-        <dd>
-        <dt id="warner">warner
-        <dd>
-      </dl>
-    </section>
-  </section>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>