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

structured_warnings 0.2.0 → 0.3.0

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/StructuredWarnings/Warner.html DELETED

@@ -1,162 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class StructuredWarnings::Warner - 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="../Object.html">Object</a>
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-i-format">#format</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-StructuredWarnings::Warner">
-  <h1 id="class-StructuredWarnings::Warner" class="class">
-    class StructuredWarnings::Warner
-  </h1>
-  <section class="description">
-<p>The <a href="Warner.html">Warner</a> class implements a very simple
-interface. It simply formats a warning, so it is more than just the message
-itself. This default warner uses a format comparable to warnings emitted by
-rb_warn including the place where the “thing that caused the warning”
-resides.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-format" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">format</span><span
-            class="method-args">(warning, message, stack)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Warner.new.format(DeprecationWarning, “more info..”, caller)</p>
-<pre class="ruby"><span class="ruby-comment"># =&gt; &quot;demo.rb:5 : more info.. (DeprecationWarning)&quot;</span>
-</pre>
-          <div class="method-source-code" id="format-source">
-            <pre><span class="ruby-comment"># File lib/structured_warnings/warner.rb, line 9</span>
-<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>)
-  <span class="ruby-node">&quot;#{stack.shift} : #{message} (#{warning})&quot;</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </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/Test.html DELETED

@@ -1,95 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>module Test - 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>
-</nav>
-<main role="main" aria-labelledby="module-Test">
-  <h1 id="module-Test" class="module">
-    module Test
-  </h1>
-  <section class="description">
-  </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/Test/Unit.html DELETED

@@ -1,95 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>module Test::Unit - 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>
-</nav>
-<main role="main" aria-labelledby="module-Test::Unit">
-  <h1 id="module-Test::Unit" class="module">
-    module Test::Unit
-  </h1>
-  <section class="description">
-  </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/Warning.html DELETED

@@ -1,398 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class Warning - 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="Object.html">Object</a>
-</div>
-    <div id="extends-section" class="nav-section">
-  <h3>Extended With Modules</h3>
-  <ul class="link-list">
-    <li><a class="extend" href="Warning/ClassMethods.html">Warning::ClassMethods</a>
-  </ul>
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-backtrace">#backtrace</a>
-    <li ><a href="#method-i-inspect">#inspect</a>
-    <li ><a href="#method-i-message">#message</a>
-    <li ><a href="#method-i-set_backtrace">#set_backtrace</a>
-    <li ><a href="#method-i-to_s">#to_s</a>
-    <li ><a href="#method-i-to_str">#to_str</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-Warning">
-  <h1 id="class-Warning" class="class">
-    class Warning
-  </h1>
-  <section class="description">
-<p>Descendents of class <a href="Warning.html">Warning</a> are used to  raise
-structured warnings. They programmers to explicitly supress certain kinds
-of warnings and provide additional information in contrast to the plain
-warn method. They implement an Exception-like interface and carry
-information about the warning – its type (the warning&#39;s class name), an
-optional descriptive string, and optional traceback information. Programs
-may subclass <a href="Warning.html">Warning</a> to add additional
-information.</p>
-<p>Large portions of this class&#39;s documentation are taken from the
-Exception RDoc.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(message = nil)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Construct a new <a href="Warning.html">Warning</a> object, optionally
-passing in a message.</p>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 13</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>)
-  <span class="ruby-ivar">@message</span> = <span class="ruby-identifier">message</span>
-  <span class="ruby-ivar">@backtrace</span> = <span class="ruby-identifier">caller</span>(<span class="ruby-value">1</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-backtrace" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-callseq">
-            backtrace    &rarr; array
-          </span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns any backtrace associated with the warning. The backtrace is an
-array of strings, each containing either “filename:lineNo: in
-`method&#39;&#39;&#39; or “filename:lineNo.&#39;&#39;</p>
-          <div class="method-source-code" id="backtrace-source">
-            <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 25</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">backtrace</span>
-  <span class="ruby-ivar">@backtrace</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-inspect" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">inspect</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Return this warning&#39;s class name and message</p>
-          <div class="method-source-code" id="inspect-source">
-            <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 44</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
-  <span class="ruby-node">&quot;#&lt;#{self.class}: #{self}&gt;&quot;</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-message" class="method-detail method-alias">
-        <div class="method-heading">
-          <span class="method-name">message</span><span
-            class="method-args">()</span>
-        </div>
-        <div class="method-description">
-        </div>
-        <div class="aliases">
-          Alias for: <a href="Warning.html#method-i-to_s">to_s</a>
-        </div>
-      </div>
-      <div id="method-i-set_backtrace" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">set_backtrace</span><span
-            class="method-args">(backtrace)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Sets the backtrace information associated with warning. The argument must
-be an array of String objects in the format described in
-Exception#backtrace.</p>
-          <div class="method-source-code" id="set_backtrace-source">
-            <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 32</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">backtrace</span>)
-  <span class="ruby-ivar">@backtrace</span> = <span class="ruby-identifier">backtrace</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-to_s" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">to_s</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns warning&#39;s message (or the name of the warning if no message is
-set).</p>
-          <div class="method-source-code" id="to_s-source">
-            <pre><span class="ruby-comment"># File lib/structured_warnings/warning.rb, line 37</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
-  <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>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-        <div class="aliases">
-          Also aliased as: <a href="Warning.html#method-i-to_str">to_str</a>, <a href="Warning.html#method-i-message">message</a>
-        </div>
-      </div>
-      <div id="method-i-to_str" class="method-detail method-alias">
-        <div class="method-heading">
-          <span class="method-name">to_str</span><span
-            class="method-args">()</span>
-        </div>
-        <div class="method-description">
-        </div>
-        <div class="aliases">
-          Alias for: <a href="Warning.html#method-i-to_s">to_s</a>
-        </div>
-      </div>
-    </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>