doc/Safubot/Test.html in safubot-0.0.1 vs doc/Safubot/Test.html in safubot-0.0.2

- old
+ new

@@ -1,244 +1,223 @@ -<!DOCTYPE html> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Module: Safubot::Test + + &mdash; Documentation by YARD 0.7.3 + +</title> -<html> -<head> -<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> -<title>Module: Safubot::Test</title> + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> -<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> - -<script type="text/javascript"> - var rdoc_rel_prefix = "../"; +<script type="text/javascript" charset="utf-8"> + relpath = '..'; + if (relpath != '') relpath += '/'; </script> -<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> -<body id="top" class="module"> -<nav id="metadata"> - <nav id="home-section" class="section"> - <h3 class="section-header"> - <a href="../index.html">Home</a> - <a href="../table_of_contents.html#classes">Classes</a> - <a href="../table_of_contents.html#methods">Methods</a> - </h3> -</nav> - - <nav id="search-section" class="section project-section" class="initially-hidden"> - <form action="#" method="get" accept-charset="utf-8"> - <h3 class="section-header"> - <input type="text" name="search" placeholder="Search" id="search-field" - title="Type to search, Up and Down to navigate, Enter to load"> - </h3> - </form> - - <ul id="search-results" class="initially-hidden"></ul> -</nav> - - - <div id="file-metadata"> - <nav id="file-list-section" class="section"> - <h3 class="section-header">Defined In</h3> - <ul> - <li>lib/safubot/test_helper.rb - </ul> -</nav> - + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> - </div> - - <div id="class-metadata"> - - - - <!-- Method Quickref --> -<nav id="method-list-section" class="section"> - <h3 class="section-header">Methods</h3> - - <ul class="link-list"> - - <li><a href="#method-c-clean_environment">::clean_environment</a> - - <li><a href="#method-c-request">::request</a> - - </ul> -</nav> - - </div> - - <div id="project-metadata"> - <nav id="fileindex-section" class="section project-section"> - <h3 class="section-header">Pages</h3> - - <ul> + <div id="header"> + <div id="menu"> - <li class="file"><a href="../Gemfile.html">Gemfile</a> + <a href="../_index.html">Index (T)</a> &raquo; + <span class='title'><span class='object_link'><a href="../Safubot.html" title="Safubot (module)">Safubot</a></span></span> + &raquo; + <span class="title">Test</span> - <li class="file"><a href="../Rakefile.html">Rakefile</a> - </ul> -</nav> + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> - <nav id="classindex-section" class="section project-section"> - <h3 class="section-header">Class and Module Index</h3> - - <ul class="link-list"> + <div id="search"> - <li><a href="../Safubot.html">Safubot</a> + <a id="class_list_link" href="#">Class List</a> - <li><a href="../Safubot/Bot.html">Safubot::Bot</a> + <a id="method_list_link" href="#">Method List</a> - <li><a href="../Safubot/Evented.html">Safubot::Evented</a> + <a id="file_list_link" href="#">File List</a> - <li><a href="../Safubot/KnownUser.html">Safubot::KnownUser</a> +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Module: Safubot::Test - <li><a href="../Safubot/Log.html">Safubot::Log</a> - <li><a href="../Safubot/Query.html">Safubot::Query</a> - <li><a href="../Safubot/Request.html">Safubot::Request</a> +</h1> + +<dl class="box"> - <li><a href="../Safubot/Response.html">Safubot::Response</a> - <li><a href="../Safubot/Test.html">Safubot::Test</a> + - <li><a href="../Safubot/Twitter.html">Safubot::Twitter</a> + - <li><a href="../Safubot/Twitter/Bot.html">Safubot::Twitter::Bot</a> - <li><a href="../Safubot/Twitter/DirectMessage.html">Safubot::Twitter::DirectMessage</a> - <li><a href="../Safubot/Twitter/Tweet.html">Safubot::Twitter::Tweet</a> + <dt class="r1 last">Defined in:</dt> + <dd class="r1 last">lib/safubot/test_helper.rb</dd> - <li><a href="../Safubot/XMPP.html">Safubot::XMPP</a> - - <li><a href="../Safubot/XMPP/Bot.html">Safubot::XMPP::Bot</a> - - <li><a href="../Safubot/XMPP/Message.html">Safubot::XMPP::Message</a> - - <li><a href="../Object.html">Object</a> - - </ul> -</nav> +</dl> +<div class="clear"></div> - </div> -</nav> -<div id="documentation"> - <h1 class="module">module Safubot::Test</h1> - <div id="description" class="description"> + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> - </div><!-- description --> + <a href="#clean_environment-class_method" title="clean_environment (class method)">+ (Object) <strong>clean_environment</strong> </a> + + + </span> - <section id="5Buntitled-5D" class="documentation-section"> - + + + - + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + <li class="public "> + <span class="summary_signature"> - + <a href="#request-class_method" title="request (class method)">+ (Object) <strong>request</strong>(text) </a> - <!-- Methods --> - <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> - <h3 class="section-header">Public Class Methods</h3> + </span> + + + + + + - - <div id="method-c-clean_environment" class="method-detail "> - - <div class="method-heading"> - <span class="method-name">clean_environment</span><span - class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - + + <span class="summary_desc"><div class='inline'></div></span> + +</li> - <div class="method-description"> - - - + + </ul> + - - <div class="method-source-code" id="clean_environment-source"> - <pre><span class="ruby-comment"># File lib/safubot/test_helper.rb, line 6</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">clean_environment</span> - <span class="ruby-constant">MongoMapper</span>.<span class="ruby-identifier">database</span> = <span class="ruby-string">&quot;safubot_testing&quot;</span> - <span class="ruby-constant">Request</span>.<span class="ruby-identifier">destroy_all</span> - <span class="ruby-constant">Query</span>.<span class="ruby-identifier">destroy_all</span> - <span class="ruby-constant">Response</span>.<span class="ruby-identifier">destroy_all</span> - <span class="ruby-identifier">$bot</span> = <span class="ruby-constant">Safubot</span>.<span class="ruby-identifier">new</span>({ - <span class="ruby-value">:database</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;safubot_testing&quot;</span>, - <span class="ruby-value">:twitter_opts</span> =<span class="ruby-operator">&gt;</span> { - <span class="ruby-value">:username</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;safubot&quot;</span>, - <span class="ruby-value">:consumer_key</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;JgUdmeA1Q8GNm6o7iM6A&quot;</span>, - <span class="ruby-value">:consumer_secret</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;wo7VKq4AGohHc4RgQEuWs1unjy7dtnKJn3Ojd4jPaA&quot;</span>, - <span class="ruby-value">:oauth_token</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;391202224-jrdXljH8LxXdU1uz7QbSyRAU8VQId4p4soVJ3NWG&quot;</span>, - <span class="ruby-value">:oauth_token_secret</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;j44x8UgMZfooPXrhm9XiuCDkWwqO0zHOsWgn8NoXw0&quot;</span> - }, - }) -<span class="ruby-keyword">end</span></pre> - </div><!-- clean_environment-source --> - - </div> - - - </div><!-- clean_environment-method --> - + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> - <div id="method-c-request" class="method-detail "> - - <div class="method-heading"> - <span class="method-name">request</span><span - class="method-args">(text)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - + + <div class="method_details first"> + <p class="signature first" id="clean_environment-class_method"> + + + (<tt>Object</tt>) <strong>clean_environment</strong> + - <div class="method-description"> - - - + +</p><table class="source_code"> + <tr> + <td> + <pre class="lines"> - - <div class="method-source-code" id="request-source"> - <pre><span class="ruby-comment"># File lib/safubot/test_helper.rb, line 23</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">text</span>) - <span class="ruby-constant">Query</span>.<span class="ruby-identifier">create</span>(<span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">KnownUser</span>.<span class="ruby-identifier">by_name</span>(<span class="ruby-string">'testing'</span>), <span class="ruby-value">:text</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">text</span>).<span class="ruby-identifier">make_request</span> -<span class="ruby-keyword">end</span></pre> - </div><!-- request-source --> - - </div> - +20 +21 +22 +23 +24 +25 +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/safubot/test_helper.rb', line 20</span> - - </div><!-- request-method --> - +<span class='kw'>def</span> <span class='id clean_environment'>clean_environment</span> + <span class='const'>MongoMapper</span><span class='period'>.</span><span class='id database'>database</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>safubot_testing</span><span class='tstring_end'>&quot;</span></span> + <span class='const'>Request</span><span class='period'>.</span><span class='id destroy_all'>destroy_all</span> + <span class='const'>Query</span><span class='period'>.</span><span class='id destroy_all'>destroy_all</span> + <span class='const'>Response</span><span class='period'>.</span><span class='id destroy_all'>destroy_all</span> + <span class='const'>KnownUser</span><span class='period'>.</span><span class='id destroy_all'>destroy_all</span> + <span class='const'>Safubot</span><span class='op'>::</span><span class='id mode'>mode</span> <span class='op'>=</span> <span class='symbol'>:testing</span> + <span class='gvar'>$bot</span> <span class='op'>=</span> <span class='const'>Safubot</span><span class='op'>::</span><span class='const'>Bot</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:database</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>safubot_testing</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> - </section><!-- public-class-method-details --> + <div class="method_details "> + <p class="signature " id="request-class_method"> - </section><!-- 5Buntitled-5D --> + + (<tt>Object</tt>) <strong>request</strong>(text) + -</div><!-- documentation --> + +</p><table class="source_code"> + <tr> + <td> + <pre class="lines"> -<footer id="validator-badges"> - <p><a href="http://validator.w3.org/check/referer">[Validate]</a> - <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11. - <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. -</footer> +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/safubot/test_helper.rb', line 30</span> +<span class='kw'>def</span> <span class='id request'>request</span><span class='lparen'>(</span><span class='id text'>text</span><span class='rparen'>)</span> + <span class='const'>Query</span><span class='period'>.</span><span class='id create'>create</span><span class='lparen'>(</span><span class='symbol'>:user</span> <span class='op'>=&gt;</span> <span class='const'>KnownUser</span><span class='period'>.</span><span class='id by_name'>by_name</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>testing</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:text</span> <span class='op'>=&gt;</span> <span class='id text'>text</span><span class='rparen'>)</span><span class='period'>.</span><span class='id make_request'>make_request</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Mon Nov 28 20:20:04 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.9.2). +</div> + + </body> +</html> \ No newline at end of file