Sign upLogin

gosuri/roomer

View on GitHub
Star
doc/Roomer.html

Summary

Maintainability
Test Coverage
<!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: Roomer
  
    &mdash; Documentation by YARD 0.7.2
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />

<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/app.js"></script>


  </head>
  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>
    
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index (R)</a> &raquo; 
    
    
    <span class="title">Roomer</span>
  
  
  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a id="class_list_link" href="#">Class List</a>
  
    <a id="method_list_link" href="#">Method List</a>
  
    <a id="file_list_link" href="#">File List</a>
  
</div>
      <div class="clear"></div>
    </div>
    
    <iframe id="search_frame"></iframe>
    
    <div id="content"><h1>Module: Roomer
  
  
  
</h1>

<dl class="box">
  
  
    
  
    
  
  
  
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">lib/roomer.rb<span class="defines">,<br />
  lib/roomer/tools.rb,<br /> lib/roomer/rails.rb,<br /> lib/roomer/version.rb,<br /> lib/generators/setup/setup_generator.rb,<br /> lib/generators/install/install_generator.rb</span>
</dd>
  
</dl>
<div class="clear"></div>

<h2>Defined Under Namespace</h2>
<p class="children">
   
    
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Roomer/Generators.html" title="Roomer::Generators (module)">Generators</a></span>, <span class='object_link'><a href="Roomer/VERSION.html" title="Roomer::VERSION (module)">VERSION</a></span>
    
   
    
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Roomer/Engine.html" title="Roomer::Engine (class)">Engine</a></span>, <span class='object_link'><a href="Roomer/Tools.html" title="Roomer::Tools (class)">Tools</a></span>
    
  
</p>

  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="url_routing_strategy-classvariable" class="">@@url_routing_strategy =
          
        </dt>
        <dd><pre class="code"><span class='symbol val'>:domain</span>
</pre></dd>
      
        <dt id="shared_schema_name-classvariable" class="">@@shared_schema_name =
          
        </dt>
        <dd><pre class="code"><span class='symbol val'>:global</span>
</pre></dd>
      
        <dt id="tenants_table-classvariable" class="">@@tenants_table =
          
        </dt>
        <dd><pre class="code"><span class='symbol val'>:tenant</span>
</pre></dd>
      
        <dt id="tenant_url_identifier_column-classvariable" class="">@@tenant_url_identifier_column =
          
        </dt>
        <dd><pre class="code"><span class='symbol val'>:url_identifier</span>
</pre></dd>
      
        <dt id="tenant_schema_name_column-classvariable" class="">@@tenant_schema_name_column =
          
        </dt>
        <dd><pre class="code"><span class='symbol val'>:schema_name</span>
</pre></dd>
      
        <dt id="schema_seperator-classvariable" class="">@@schema_seperator =
          
        </dt>
        <dd><pre class="code"><span class='string val'>'.'</span>
</pre></dd>
      
        <dt id="shared_migrations_directory-classvariable" class="">@@shared_migrations_directory =
          
        </dt>
        <dd><pre class="code"><span class='File constant id'>File</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='migrations_directory identifier id'>migrations_directory</span><span class='comma token'>,</span><span class='shared_schema_name identifier id'>shared_schema_name</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rparen token'>)</span>
</pre></dd>
      
        <dt id="tenanted_migrations_directory-classvariable" class="">@@tenanted_migrations_directory =
          
        </dt>
        <dd><pre class="code"><span class='File constant id'>File</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='migrations_directory identifier id'>migrations_directory</span><span class='comma token'>,</span><span class='tenants_table identifier id'>tenants_table</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rparen token'>)</span>
</pre></dd>
      
    </dl>
  





  
    <h2>
      Class Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#full_shared_shema_migration_path-class_method" title="full_shared_shema_migration_path (class method)">+ (String) <strong>full_shared_shema_migration_path</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Constructs the full path to the shared schema directory Example:
/Users/Greg/Projects/roomer/db/migrate/global.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#full_tenants_table_name-class_method" title="full_tenants_table_name (class method)">+ (String) <strong>full_tenants_table_name</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Consutructs the full name for the tenants table with schema  Example:
‘global.tenant’.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#migrations_directory-class_method" title="migrations_directory (class method)">+ (String) <strong>migrations_directory</strong> </a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Rails DB Migrations Directory.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#setup-class_method" title="setup (class method)">+ (Object) <strong>setup</strong> {|_self| ... }</a>
    

    
  </span>
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>Default way to setup Roomer.</p>
</div></span>
  
</li>

      
    </ul>
  



  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>
    
    
      <div class="method_details first">
  <p class="signature first" id="full_shared_shema_migration_path-class_method">
  
    + (<tt>String</tt>) <strong>full_shared_shema_migration_path</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Constructs the full path to the shared schema directory Example:
/Users/Greg/Projects/roomer/db/migrate/global</p>


  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>
<p>full path to the shared schema directory</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


74
75
76</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/roomer.rb', line 74</span>

<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='full_shared_shema_migration_path identifier id'>full_shared_shema_migration_path</span>
  <span class='dstring node'>&quot;#{Rails.root}/#{shared_migrations_directory}&quot;</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="full_tenants_table_name-class_method">
  
    + (<tt>String</tt>) <strong>full_tenants_table_name</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Consutructs the full name for the tenants table with schema  Example:
‘global.tenant’</p>


  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>
<p>full name of the tenant table</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


67
68
69</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/roomer.rb', line 67</span>

<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='full_tenants_table_name identifier id'>full_tenants_table_name</span>
  <span class='dstring node'>&quot;#{shared_schema_name}#{schema_seperator}#{tenants_table}&quot;</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="migrations_directory-class_method">
  
    + (<tt>String</tt>) <strong>migrations_directory</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Rails DB Migrations Directory</p>


  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>
<p>full path to the migrations directory</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/roomer.rb', line 52</span>

<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='migrations_directory identifier id'>migrations_directory</span>
  <span class='File constant id'>File</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>&quot;db&quot;</span><span class='comma token'>,</span><span class='string val'>&quot;migrate&quot;</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="setup-class_method">
  
    + (<tt>Object</tt>) <strong>setup</strong> {|_self| ... }
  

  
</p><div class="docstring">
  <div class="discussion">
    
<p>Default way to setup Roomer. Run rails generate roomer:install to create a
fresh initializer with all configuration values.</p>


  </div>
</div>
<div class="tags">
  
  <div class="examples">
    <h3>Examples:</h3>
    
      <h4><div class='inline'></div></h4>
      <pre class="example code"><span class='Roomer constant id'>Roomer</span><span class='dot token'>.</span><span class='setup identifier id'>setup</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='config identifier id'>config</span><span class='bitor op'>|</span>
  <span class='config identifier id'>config</span><span class='dot token'>.</span><span class='url_routing_strategy identifier id'>url_routing_strategy</span> <span class='assign token'>=</span> <span class='symbol val'>:domain</span>
<span class='end end kw'>end</span>
</pre>
    
  </div>
<h3>Yields:</h3>
<ul class="yield">
  
    <li>
      
      
        <span class='type'>(<tt>_self</tt>)</span>
      
      
      
    </li>
  
</ul>
<h3>Yield Parameters:</h3>
<ul class="yieldparam">
  
    <li>
      
        <span class='name'>_self</span>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="" title="Roomer (module)">Roomer</a></span></tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>
<p>the object that the method was called on</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


86
87
88</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/roomer.rb', line 86</span>

<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='setup identifier id'>setup</span>
  <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span>
<span class='end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>
    
    <div id="footer">
  Generated on Fri Aug 12 10:39:12 2011 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.2 (ruby-1.8.7).
</div>

  </body>
</html>