roomer 0.0.8

data/.autotest

@@ -0,0 +1,17 @@
+require 'autotest/growl'
+
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+
+  at.add_mapping(/.*_test.rb/) do |f, _|
+    f
+  end
+
+  %w{.git .svn .hg .DS_Store ._* vendor tmp log doc}.each do |exception|
+    at.add_exception(exception)
+  end
+end
+
+Autotest::Growl::show_modified_files      = true
+Autotest::Growl::one_notification_per_run = true
+Autotest::Growl::clear_terminal           = false

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.yardoc*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test/tmp*
+tmp*
+test/rails_app/log*

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm ruby-1.8.7-p334@roomer --create
+echo "commencing countdown, engines on!"

data/.travis.yml

@@ -0,0 +1,2 @@
+before_script:
+  - "psql -c 'create database roomer_test;' -U postgres >/dev/null"

data/Gemfile

@@ -0,0 +1,31 @@
+source "http://rubygems.org"
+gemspec
+
+gem "rails", "3.0.9"
+
+group :doc do
+  gem "yard"
+end
+
+group :test do
+  gem "webrat",         "~> 0.7.2",   :require => false
+  gem "mocha",          "~> 0.9.12",  :require => false
+  gem "ZenTest",        "~> 4.6.2",   :require => false
+  gem "autotest-growl", "~> 0.2.9",   :require => false
+end
+
+platforms :ruby do
+  group :db do
+    gem "pg", ">= 0.11.0"
+  end
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter"
+end
+
+platforms :mri_18 do
+  group :test do
+    gem "ruby-debug", ">= 0.10.3"
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Marketron Broadcast Solutions 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), 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 "AS IS", 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.

data/README.md

@@ -0,0 +1,116 @@
+# Roomer
+
+Roomer is a multitenant framework for Rails using PostgreSQL
+
+## Multitenant Data Strategy
+
+While there are several strategies for multi-tenancy, Roomer uses PostgreSQL's schemas (namespaces) to achieve its goal. You can use Roomer if your application has the below characteristics:
+
+* Each Tenant's data has be to be private to the Tenant.
+* No (or minimal) requirement to run cross-tenant queries.
+
+Each Tenant's data is stored in separate schema and shared data is stored in a "global" schema accessible to all the Tenants.
+
+### PostgreSQL "Schemas"
+
+A database in PostgreSQL contains one or more named schemas, which in turn contain tables. Schemas also contain other kinds of named objects, including data types, functions, and operators. The same object name can be used in different schemas without conflict; for example, both schema1 and myschema may contain tables named mytable. Unlike databases, schemas are not rigidly separated: a user may access objects in any of the schemas in the database he is connected to, if he has privileges to do so.
+
+More information at http://www.postgresql.org/docs/8.2/static/ddl-schemas.html
+
+## Usage
+
+### Installation
+
+Roomer currently in pre-release and only supports Rails 3. In your Gemfile insert the below and run "bundle install"
+
+    gem 'roomer', :git => "git://github.com/gosuri/roomer.git"
+
+After you install Roomer and add it to your Gemfile, you need to run the generator. Roomer will use default values "tenant" for Tenant scoped models and "global" for shared models. If you'd like to override the defaults use the optional parameters
+
+```bash
+rails generate roomer:install
+```
+
+The generator will install an initializer under config/initializers/roomer.rb which describes ALL Roomer’s configuration options and you MUST take a look at it.
+
+### Setup
+
+After you've done the necessary config changes to the initializer, run the setup:
+
+```bash
+rails generate roomer:setup
+```
+
+### Running Migrations
+
+#### Shared
+
+The setup will generate migrations under db/migrate/[shared_shema_name], by default it should be db/migrate/global. You need to run the shared migrations to setup the tenant tables
+
+```bash
+rake roomer:shared:migrate
+```
+
+#### Tenanted
+
+This will run migrations under db/migrate. If you set the "config.use_tenanted_migrations_directory" parameter to true, it should run the migrations under db/migrate/[tenant_table_name]/*
+
+```bash
+rake roomer:tenanted:migrate
+```
+#### Both
+
+To run both shared and tenanted use:
+
+```bash
+rake roomer:migrate
+```
+
+## Models
+
+To enable Roomer on your models, simply call the roomer method and specify the type in your Model Class definition:
+
+```ruby
+class Orders < ActiveRecord::Base
+  roomer :tenanted
+end
+```
+
+Roomer supports types of scoped models
+
+* shared: shared by all tenants
+* tenanted: scoped to a tenant
+
+Roomer also provides generators
+
+```bash
+rails generate roomer:model user name:string email:string
+```
+
+Optionally, you can specify --shared flag to generate a shared model
+
+```bash
+rails generate roomer:model organizations name:string desc:string --shared
+```
+
+Migrations are similar, defaulting to the global schema, 
+or optionally --shared for tenanted migration
+
+```bash
+rails generate roomer:migration AddPhoneToPerson phone:string
+```
+
+```bash
+rails generate roomer:migration AddPhoneToPerson phone:string --shared
+```
+
+## Contributors
+
+https://github.com/gosuri/roomer/contributors
+
+## Build Status
+
+* stable ([![Build Status](http://travis-ci.org/gosuri/roomer.png?branch=master)](http://travis-ci.org/gosuri/roomer?branch=master))
+* unstable ([![Build Status](http://travis-ci.org/gosuri/roomer.png?branch=develop)](http://travis-ci.org/gosuri/roomer?branch=develop))
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Run Roomer unit tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs    << 'lib'
+  t.libs    << 'test'
+  t.pattern =  'test/**/*_test.rb'
+  t.verbose =  true
+end
+
+desc 'Run tests by default'
+task :default => %w(test)

data/TODO.md

@@ -0,0 +1,10 @@
+# Features
++ Scoped routes for tenants
++ Generators for Tenanted and Shared Migrators - DONE
+    rails generate roomer:migration [migration_name] [attribute:type]
+    rails generate roomer:migration [migration_name] [attribute:type] --shared
++ Option to disable standard rails migration "rake db:migrate"
+
+# Enhancements
++ Show warnings if unrun migrations exists under db/migrate/global while running rake roomer:shared:migrate
+

data/doc/ActiveRecord/Base.html

@@ -0,0 +1,328 @@
+<!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>
+  Class: ActiveRecord::Base
+  
+    &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 (B)</a> &raquo; 
+    <span class='title'>ActiveRecord</span>
+     &raquo; 
+    <span class="title">Base</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>Class: ActiveRecord::Base
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ActiveRecord::Base</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/roomer/extensions/active_record.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+  
+    <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="#roomer-class_method" title="roomer (class method)">+ (Symbol) <strong>roomer</strong>(scope) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Sets the roomer scope for the model and changes the model’s
+table_name_prefix If :shared is passed, the global schema will be used as
+the table name prefix if :tenanted is pased, the current tenant’s schema
+will be used as the table name prefix.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#table_name_prefix-class_method" title="table_name_prefix (class method)">+ (String) <strong>table_name_prefix</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Overrides ActiveRecord::Base.table_name_prefix Defaults to blank if roomer
+class method is not set in model Returns the shared schema name prefix if
+roomer method is set to :shared Returns the current tenants schema name if
+roomer class method is set to :tenanted.</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="roomer-class_method">
+  
+    + (<tt>Symbol</tt>) <strong>roomer</strong>(scope) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Sets the roomer scope for the model and changes the model’s
+table_name_prefix If :shared is passed, the global schema will be used as
+the table name prefix if :tenanted is pased, the current tenant’s schema
+will be used as the table name prefix</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>:shared or :tenanted</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/roomer/extensions/active_record.rb', line 24</span>
+
+<span class='def def kw'>def</span> <span class='roomer identifier id'>roomer</span><span class='lparen token'>(</span><span class='scope identifier id'>scope</span><span class='rparen token'>)</span>
+  <span class='case case kw'>case</span> <span class='scope identifier id'>scope</span>
+    <span class='when when kw'>when</span> <span class='symbol val'>:shared</span>
+      <span class='@roomer_scope ivar id'>@roomer_scope</span> <span class='assign token'>=</span> <span class='symbol val'>:shared</span>
+    <span class='when when kw'>when</span> <span class='symbol val'>:tenanted</span>
+      <span class='@roomer_scope ivar id'>@roomer_scope</span> <span class='assign token'>=</span> <span class='symbol val'>:tenanted</span>
+    <span class='else else kw'>else</span>
+      <span class='raise identifier id'>raise</span> <span class='string val'>&quot;Invalid roomer model scope.  Choose :shared or :tenanted&quot;</span>
+  <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="table_name_prefix-class_method">
+  
+    + (<tt>String</tt>) <strong>table_name_prefix</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Overrides ActiveRecord::Base.table_name_prefix Defaults to blank if roomer
+class method is not set in model Returns the shared schema name prefix if
+roomer method is set to :shared Returns the current tenants schema name if
+roomer class method is set to :tenanted</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>shared schema name prefix or current tenants schema name</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/roomer/extensions/active_record.rb', line 9</span>
+
+<span class='def def kw'>def</span> <span class='table_name_prefix identifier id'>table_name_prefix</span>
+  <span class='return return kw'>return</span> <span class='@table_name_prefix ivar id'>@table_name_prefix</span> <span class='unless unless_mod kw'>unless</span> <span class='@table_name_prefix ivar id'>@table_name_prefix</span><span class='dot token'>.</span><span class='blank? fid id'>blank?</span>
+  <span class='if if kw'>if</span> <span class='shared? fid id'>shared?</span>
+    <span class='Roomer constant id'>Roomer</span><span class='dot 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='elsif elsif kw'>elsif</span> <span class='tenanted? fid id'>tenanted?</span>
+    <span class='self self kw'>self</span><span class='dot token'>.</span><span class='current_tenant identifier id'>current_tenant</span><span class='lbrack token'>[</span><span class='Roomer constant id'>Roomer</span><span class='dot token'>.</span><span class='tenant_schema_name_column identifier id'>tenant_schema_name_column</span><span class='rbrack token'>]</span>
+  <span class='else else kw'>else</span>
+    <span class='string val'>&quot;&quot;</span>
+  <span class='end end kw'>end</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>

data/doc/ApplicationController.html

@@ -0,0 +1,116 @@
+<!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>
+  Class: ApplicationController
+  
+    &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 (A)</a> &raquo; 
+    
+    
+    <span class="title">ApplicationController</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>Class: ApplicationController
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">ActionController::Base</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ActionController::Base</li>
+          
+            <li class="next">ApplicationController</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/roomer/extensions/application_controller.rb</dd>
+  
+</dl>
+<div class="clear"></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>