jeremytregunna/ruby-trello

View on GitHub
doc/Object.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class Object - RDoc Documentation</title>

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
  var index_rel_prefix = "./";
</script>

<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></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">BasicObject
  
</div>

    <div id="includes-section" class="nav-section">
  <h3>Included Modules</h3>

  <ul class="link-list">
  
  
    <li><a class="include" href="Helpers.html">Helpers</a>
  
  
  
    <li><a class="include" href="Trello.html">Trello</a>
  
  
  
    <li><a class="include" href="Trello/Authorization.html">Trello::Authorization</a>
  
  
  
    <li><a class="include" href="IntegrationHelpers.html">IntegrationHelpers</a>
  
  
  
    <li><a class="include" href="IntegrationTest.html">IntegrationTest</a>
  
  
  
    <li><a class="include" href="Trello/JsonUtils.html">Trello::JsonUtils</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-example_class">#example_class</a>
    
    <li ><a href="#method-i-mock_client_and_association">#mock_client_and_association</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-Object">
  <h1 id="class-Object" class="class">
    class Object
  </h1>

  <section class="description">
    
  </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">(options = {})</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File spec/string_spec.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = {})
  <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">&#39;name&#39;</span>]
  <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">&#39;description&#39;</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-example_class" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">example_class</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="example_class-source">
            <pre><span class="ruby-comment"># File spec/string_spec.rb, line 7</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">example_class</span>
  <span class="ruby-ivar">@example_class</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Class</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
    <span class="ruby-identifier">include</span> <span class="ruby-constant">Trello</span><span class="ruby-operator">::</span><span class="ruby-constant">JsonUtils</span>

    <span class="ruby-identifier">attr_accessor</span> <span class="ruby-value">:name</span>, <span class="ruby-value">:description</span>

    <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = {})
      <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">&#39;name&#39;</span>]
      <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">&#39;description&#39;</span>]
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-mock_client_and_association" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">mock_client_and_association</span><span
            class="method-args">(klass: Trello::FakeOrganization, id: 1, path: nil, id_field: :id)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="mock_client_and_association-source">
            <pre><span class="ruby-comment"># File spec/integration/basic_data/one_spec.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mock_client_and_association</span>(<span class="ruby-value">klass:</span> <span class="ruby-constant">Trello</span><span class="ruby-operator">::</span><span class="ruby-constant">FakeOrganization</span>, <span class="ruby-value">id:</span> <span class="ruby-value">1</span>, <span class="ruby-value">path:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">id_field:</span> <span class="ruby-value">:id</span>)
  <span class="ruby-identifier">association_restful_name</span> = <span class="ruby-identifier">path</span>
  <span class="ruby-identifier">allow</span>(<span class="ruby-constant">Trello</span><span class="ruby-operator">::</span><span class="ruby-constant">FakeBoard</span>).<span class="ruby-identifier">to</span> <span class="ruby-identifier">receive</span>(<span class="ruby-value">:client</span>).<span class="ruby-identifier">and_return</span>(<span class="ruby-identifier">client_double</span>)
  <span class="ruby-identifier">allow_any_instance_of</span>(<span class="ruby-constant">Trello</span><span class="ruby-operator">::</span><span class="ruby-constant">FakeBoard</span>).<span class="ruby-identifier">to</span> <span class="ruby-identifier">receive</span>(<span class="ruby-value">:client</span>).<span class="ruby-identifier">and_return</span>(<span class="ruby-identifier">client_double</span>)
  <span class="ruby-identifier">allow_any_instance_of</span>(<span class="ruby-constant">Trello</span><span class="ruby-operator">::</span><span class="ruby-constant">FakeBoard</span>).<span class="ruby-identifier">to</span> <span class="ruby-identifier">receive</span>(<span class="ruby-identifier">id_field</span>).<span class="ruby-identifier">and_return</span>(<span class="ruby-identifier">id</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">association_restful_name</span>
    <span class="ruby-identifier">allow</span>(<span class="ruby-identifier">client_double</span>).<span class="ruby-identifier">to</span> <span class="ruby-identifier">receive</span>(<span class="ruby-value">:find</span>).<span class="ruby-identifier">with</span>(<span class="ruby-identifier">association_restful_name</span>, <span class="ruby-identifier">id</span>).<span class="ruby-identifier">and_return</span>(<span class="ruby-identifier">organization</span>)
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">allow</span>(<span class="ruby-identifier">klass</span>).<span class="ruby-identifier">to</span> <span class="ruby-identifier">receive</span>(<span class="ruby-value">:find</span>).<span class="ruby-identifier">with</span>(<span class="ruby-identifier">id</span>).<span class="ruby-identifier">and_return</span>(<span class="ruby-identifier">organization</span>)
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>

</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>