apartment 0.20.0 → 0.21.0

data/.gitignore

@@ -3,6 +3,9 @@
 Gemfile.lock
 pkg/*
 *.log
+.idea
 *.sw[pno]
 spec/config/database.yml
 spec/dummy/config/database.yml
+cookbooks
+tmp

data/.rspec

@@ -1,2 +1,3 @@
 --colour
 --format documentation
+--tty

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-bundler_args: --verbose
+  - jruby-19mode
+bundler_args: --without local --verbose

data/.vagrant

@@ -0,0 +1 @@
+{"active":{"default":"c780c5fa-2739-4d9a-be05-2f4f6c1dcea6"}}

data/Cheffile

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#^syntax detection
+
+site 'http://community.opscode.com/api/v1'
+
+# cookbook 'chef-client'
+
+# cookbook 'apache2', '>= 1.0.0'
+
+cookbook 'apt'
+cookbook 'build-essential'
+cookbook 'openssl'
+
+cookbook 'postgresql'
+cookbook 'mysql'
+
+cookbook 'git'
+
+cookbook 'rvm',
+  :git => 'https://github.com/fnichol/chef-rvm'
+
+# cookbook 'postgresql',
+#   :git => 'https://github.com/findsyou/cookbooks',
+#   :ref => 'postgresql-improvements'

data/Cheffile.lock

@@ -0,0 +1,43 @@
+SITE
+  remote: http://community.opscode.com/api/v1
+  specs:
+    apt (1.9.0)
+    build-essential (1.3.4)
+    chef_gem (0.0.5)
+    chef_handler (1.1.4)
+    dmg (1.1.0)
+    git (2.3.0)
+      build-essential (>= 0.0.0)
+      dmg (>= 0.0.0)
+      runit (~> 1.0)
+      windows (>= 0.0.0)
+      yum (>= 0.0.0)
+    mysql (2.1.2)
+      build-essential (>= 0.0.0)
+      openssl (>= 0.0.0)
+    openssl (1.0.2)
+    postgresql (2.2.2)
+      openssl (>= 0.0.0)
+    runit (1.1.0)
+      build-essential (>= 0.0.0)
+    windows (1.8.4)
+      chef_handler (>= 0.0.0)
+    yum (2.1.0)
+
+GIT
+  remote: https://github.com/fnichol/chef-rvm
+  ref: master
+  sha: 37ae6f0d6540ebc95d22004d68dd45fe304d7255
+  specs:
+    rvm (0.9.1)
+      chef_gem (>= 0.0.0)
+
+DEPENDENCIES
+  apt (>= 0)
+  build-essential (>= 0)
+  git (>= 0)
+  mysql (>= 0)
+  openssl (>= 0)
+  postgresql (>= 0)
+  rvm (>= 0)
+

data/Gemfile

@@ -2,14 +2,28 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'pry'
-gem 'rails',                    '>= 3.1.2'
-gem 'rake',                     '~> 0.9.2'
-gem 'sqlite3'
-gem 'rspec',                    '~> 2.11'
-gem 'rspec-rails',              '~> 2.11'
-gem 'capybara',                 '~> 1.0'
-gem 'pg',                       '>= 0.11.0'
-gem 'mysql2',                   '~> 0.3.10'
-gem 'delayed_job',              '~> 3.0'
+gem 'rails',        '>= 3.1.2'
+gem 'rake',         '~> 0.9'
+gem 'rspec',        '~> 2.11'
+gem 'rspec-rails',  '~> 2.11'
+gem 'capybara',     '~> 1.0.0'
+gem 'delayed_job',  '~> 3.0'
 gem 'delayed_job_active_record'
+
+platform :ruby do
+  gem 'mysql2', '~> 0.3.10'
+  gem 'pg',     '>= 0.11.0'
+end
+
+platform :jruby do
+  gem 'activerecord-jdbc-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'jdbc-postgres', '9.2.1002'
+  gem 'jdbc-mysql'
+  gem 'jruby-openssl'
+end
+
+group :local do
+  gem 'pry'
+end

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 0.21.0
+  * April 24, 2013
+
+  - JDBC support!! [PetrolMan]
+
 # 0.20.0
   * Feb 6, 2013
 

data/README.md

@@ -15,7 +15,9 @@ but still allow some data to exist in a common database, Apartment can help.
 
 Add the following to your Gemfile:
 
-    gem 'apartment'
+```ruby
+gem 'apartment'
+```
 
 That's all you need to set up the Apartment libraries. If you want to switch databases
 on a per-user basis, look under "Usage - Switching databases per request", below.
@@ -31,7 +33,9 @@ on a per-user basis, look under "Usage - Switching databases per request", below
 Before you can switch to a new apartment database, you will need to create it. Whenever
 you need to create a new database, you can run the following command:
 
-    Apartment::Database.create('database_name')
+```ruby
+Apartment::Database.create('database_name')
+```
 
 If you're using the [prepend environment](https://github.com/influitive/apartment#handling-environments) config option or you AREN'T using Postgresql Schemas, this will create a database in the following format: "#{environment}\_database_name".
 In the case of a sqlite database, this will be created in your 'db/' folder. With
@@ -53,7 +57,9 @@ One can optionally use the full database creation instead if they want, though t
 
 To switch databases using Apartment, use the following command:
 
-    Apartment::Database.switch('database_name')
+```ruby
+Apartment::Database.switch('database_name')
+```
 
 When switch is called, all requests coming to ActiveRecord will be routed to the database
 you specify (with the exception of excluded models, see below). To return to the 'root'
@@ -67,36 +73,39 @@ Apartment can support many different "Elevators" that can take care of this rout
 **Switch on subdomain**
 In house, we use the subdomain elevator, which analyzes the subdomain of the request and switches to a database schema of the same name. It can be used like so:
 
-    # application.rb
-    module My Application
-      class Application < Rails::Application
-
-        config.middleware.use 'Apartment::Elevators::Subdomain'
-      end
-    end
+```ruby
+# application.rb
+module My Application
+  class Application < Rails::Application
+    config.middleware.use 'Apartment::Elevators::Subdomain'
+  end
+end
+```
 
 **Switch on domain**
 To switch based on full domain (excluding subdomains *ie 'www'* and top level domains *ie '.com'* ) use the following:
 
-    # application.rb
-    module My Application
-      class Application < Rails::Application
-
-        config.middleware.use 'Apartment::Elevators::Domain'
-      end
-    end
+```ruby
+# application.rb
+module My Application
+  class Application < Rails::Application
+    config.middleware.use 'Apartment::Elevators::Domain'
+  end
+end
+```
 
 **Custom Elevator**
 A Generic Elevator exists that allows you to pass a `Proc` (or anything that responds to `call`) to the middleware. This Object will be passed in an `ActionDispatch::Request` object when called for you to do your magic. Apartment will use the return value of this proc to switch to the appropriate database.  Use like so:
 
-    # application.rb
-    module My Application
-      class Application < Rails::Application
-        # Obviously not a contrived example
-        config.middleware.use 'Apartment::Elevators::Generic', Proc.new { |request| request.host.reverse }
-      end
-    end
-
+```ruby
+# application.rb
+module MyApplication
+  class Application < Rails::Application
+    # Obviously not a contrived example
+    config.middleware.use 'Apartment::Elevators::Generic', Proc.new { |request| request.host.reverse }
+  end
+end
+```
 
 ## Config
 
@@ -106,41 +115,53 @@ The following config options should be set up in a Rails initializer such as:
 
 To set config options, add this to your initializer:
 
-    Apartment.configure do |config|
-      # set your options (described below) here
-    end
+```ruby
+Apartment.configure do |config|
+  # set your options (described below) here
+end
+```
 
 ### Excluding models
 
 If you have some models that should always access the 'root' database, you can specify this by configuring Apartment using `Apartment.configure`.  This will yield a config object for you.  You can set excluded models like so:
 
-    config.excluded_models = ["User", "Company"]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+```ruby
+config.excluded_models = ["User", "Company"]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+```
 
 Note that a string representation of the model name is now the standard so that models are properly constantized when reloaded in development
 
+Rails will always access the 'root' database when accessing these models,  but note that tables will be created in all schemas.  This may not be ideal, but its done this way because otherwise rails wouldn't be able to properly generate the schema.rb file.
+
 ### Postgresql Schemas
 
 **Providing a Different default_schema**
 By default, ActiveRecord will use `"$user", public` as the default `schema_search_path`. This can be modified if you wish to use a different default schema be setting:
 
-    config.default_schema = "some_other_schema"
+```ruby
+config.default_schema = "some_other_schema"
+```
 
 With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Database` will return to this schema also
 
 **Persistent Schemas**
 Apartment will normally just switch the `schema_search_path` whole hog to the one passed in.  This can lead to problems if you want other schemas to always be searched as well.  Enter `persistent_schemas`.  You can configure a list of other schemas that will always remain in the search path, while the default gets swapped out:
 
-    config.persistent_schemas = ['some', 'other', 'schemas']
+```ruby
+config.persistent_schemas = ['some', 'other', 'schemas']
+```
 
 This has numerous useful applications.  [Hstore](http://www.postgresql.org/docs/9.1/static/hstore.html), for instance, is a popular storage engine for Postgresql.  In order to use Hstore, you have to install it to a specific schema and have that always in the `schema_search_path`.  This could be achieved like so:
 
-    # NOTE do not do this in a migration, must be done
-    # manually before you configure apartment with hstore
-    # In a rake task, or on the console...
-    ActiveRecord::Base.connection.execute("CREATE SCHEMA hstore; CREATE EXTENSION HSTORE SCHEMA hstore")
+```ruby
+# NOTE do not do this in a migration, must be done
+# manually before you configure apartment with hstore
+# In a rake task, or on the console...
+ActiveRecord::Base.connection.execute("CREATE SCHEMA hstore; CREATE EXTENSION HSTORE SCHEMA hstore")
 
-    # configure Apartment to maintain the `hstore` schema in the `schema_search_path`
-    config.persistent_schemas = ['hstore']
+# configure Apartment to maintain the `hstore` schema in the `schema_search_path`
+config.persistent_schemas = ['hstore']
+```
 
 There are a few caveats to be aware of when using `hstore`.  First off, the hstore schema and extension creation need to be done manually *before* you reference it in any way in your migrations, database.yml or apartment.  This is an unfortunate manual step, but I haven't found a way around it.  You can achieve this from the command line using something like:
 
@@ -148,11 +169,13 @@ There are a few caveats to be aware of when using `hstore`.  First off, the hsto
 
 Next, your `database.yml` file must mimic what you've set for your default and persistent schemas in Apartment.  When you run migrataions with Rails, it won't know about the hstore schema because Apartment isn't injected into the default connection, it's done on a per-request basis, therefore Rails doesn't know about `hstore` during migrations.  To do so, add the following to your `database.yml` for all environments
 
-    # database.yml
-    ...
-    adapter: postgresql
-    schema_search_path: "public,hstore"
-    ...
+```yaml
+# database.yml
+...
+adapter: postgresql
+schema_search_path: "public,hstore"
+...
+```
 
 This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['hstore']`
 
@@ -163,13 +186,15 @@ In order to migrate all of your databases (or posgresql schemas) you need to pro
 of dbs to Apartment.  You can make this dynamic by providing a Proc object to be called on migrations.
 This object should yield an array of string representing each database name.  Example:
 
-    # Dynamically get database names to migrate
-    config.database_names = lambda{ Customer.pluck(:database_name) }
+```ruby
+# Dynamically get database names to migrate
+config.database_names = lambda{ Customer.pluck(:database_name) }
 
-    # Use a static list of database names for migrate
-    config.database_names = ['db1', 'db2']
+# Use a static list of database names for migrate
+config.database_names = ['db1', 'db2']
+```
 
-You can then migration your databases using the rake task:
+You can then migrate your databases using the rake task:
 
     rake apartment:migrate
 
@@ -182,10 +207,33 @@ By default, when not using postgresql schemas, Apartment will prepend the enviro
 to ensure there is no conflict between your environments.  This is mainly for the benefit of your development
 and test environments.  If you wish to turn this option off in production, you could do something like:
 
-    config.prepend_environment = !Rails.env.production?
+```ruby
+config.prepend_environment = !Rails.env.production?
+```
 
 ## Delayed::Job
 
+### Read me before using Delayed::Job!!!
+>   It should be noted that we now consider Delayed::Job usage with Apartment effectively deprecated
+>   It will be stripped out into it's own gem for backwards compatibility, but we've had far too
+>   many problems with it to continue supporting it.
+>
+>   The main problem is that Delayed::Job [monkey](https://github.com/collectiveidea/delayed_job/blob/master/lib/delayed/psych_ext.rb) [patches](https://github.com/collectiveidea/delayed_job/blob/master/lib/delayed/syck_ext.rb) YAML quite a bit, which
+>   forces us to in tern [monkey](https://github.com/influitive/apartment/blob/development/lib/apartment/delayed_job/psych_ext.rb) [patch](https://github.com/influitive/apartment/blob/development/lib/apartment/delayed_job/syck_ext.rb) their monkey patches, which provides
+>   no end of frustrations whenever upgrades are made.
+>
+>   To this end, we recommend you look into other solutions such as Resque or Sidekiq and write
+>   your own hooks to switch db per job. Our aim is to have separate gems for each of these
+>   worker libs and would love it if anyone would like to contribute something to achieve this
+>
+>   If you are hell bent on using `Delayed::Job`, this is what has worked for us in Production
+>
+>  ```ruby
+>  gem 'delayed_job', '= 3.0.1' # change at own risk!
+>  gem 'delayed_job_active_record', '= 0.3.2' # change at own risk!
+>  ```
+>
+
 If using Rails ~> 3.2, you *must* use `delayed_job ~> 3.0`.  It has better Rails 3 support plus has some major changes that affect the serialization of models.
 
 ### If using Ruby 1.9.3-p362 you MUST use psych as your parser. YAML seems to fall down using syck
@@ -193,38 +241,45 @@ If using Rails ~> 3.2, you *must* use `delayed_job ~> 3.0`.  It has better Rails
 ### If you're using syck on an earlier version of ruby, here's what you must do (in a rails app for instance)
 This can be done in the `boot.rb` of your rails config *just above* where Bundler requires the gems from the Gemfile.  It will look something like:
 
-    require 'rubygems'
-    require 'yaml'
-    YAML::ENGINE.yamler = 'syck'
+```ruby
+require 'rubygems'
+require 'yaml'
+YAML::ENGINE.yamler = 'syck'
 
-    # Set up gems listed in the Gemfile.
-    gemfile = File.expand_path('../../Gemfile', __FILE__)
-    ...
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+# ...
+```
 
 In order to make ActiveRecord models play nice with DJ and Apartment, include `Apartment::Delayed::Requirements` in any model that is being serialized by DJ.  Also ensure that the `database` attribute (provided by Apartment::Delayed::Requirements) is set on this model *before* it is serialized, to ensure that when it is fetched again, it is done so in the proper Apartment db context.  For example:
 
-    class SomeModel < ActiveRecord::Base
-      include Apartment::Delayed::Requirements
-    end
+```ruby
+class SomeModel < ActiveRecord::Base
+  include Apartment::Delayed::Requirements
+end
+```
 
 Any classes that are being used as a Delayed::Job Job need to include the `Apartment::Delayed::Job::Hooks` module into the class.  This ensures that when a job runs, it switches to the appropriate tenant before performing its task.  It is also required (manually at the moment) that you set a `@database` attribute on your job so the hooks know what tennant to switch to
 
-    class SomeDJ
-
-      include Apartment::Delayed::Job::Hooks
+```ruby
+class SomeDJ
+  include Apartment::Delayed::Job::Hooks
 
-      def initialize
-        @database = Apartment::Database.current_database
-      end
+  def initialize
+    @database = Apartment::Database.current_database
+  end
 
-      def perform
-        # do some stuff (will automatically switch to @database before performing and switch back after)
-      end
-    end
+  def perform
+    # do some stuff (will automatically switch to @database before performing and switch back after)
+  end
+end
+```
 
 All jobs *must* stored in the global (public) namespace, so add it to the list of excluded models:
 
-    config.excluded_models = ["Delayed::Job"]
+```ruby
+config.excluded_models = ["Delayed::Job"]
+```
 
 ## Development
 

data/Vagrantfile

@@ -0,0 +1,112 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant::Config.run do |config|
+  # All Vagrant configuration is done here. The most common configuration
+  # options are documented and commented below. For a complete reference,
+  # please see the online documentation at vagrantup.com.
+
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "precise32-12.04"
+
+  # The url from where the 'config.vm.box' box will be fetched if it
+  # doesn't already exist on the user's system.
+  config.vm.box_url = "http://files.vagrantup.com/precise32.box"
+
+  # Boot with a GUI so you can see the screen. (Default is headless)
+  # config.vm.boot_mode = :gui
+
+  # Assign this VM to a host-only network IP, allowing you to access it
+  # via the IP. Host-only networks can talk to the host machine as well as
+  # any other machines on the same network, but cannot be accessed (through this
+  # network interface) by any external networks.
+  # config.vm.network :hostonly, "192.168.33.10"
+
+  # Assign this VM to a bridged network, allowing you to connect directly to a
+  # network using the host's network device. This makes the VM appear as another
+  # physical device on your network.
+  # config.vm.network :bridged
+
+  # Forward a port from the guest to the host, which allows for outside
+  # computers to access the VM, whereas host only networking does not.
+  # config.vm.forward_port 80, 8080
+
+  # Share an additional folder to the guest VM. The first argument is
+  # an identifier, the second is the path on the guest to mount the
+  # folder, and the third is the path on the host to the actual folder.
+  # config.vm.share_folder "v-data", "/vagrant_data", "../data"
+
+  # Enable provisioning with chef solo, specifying a cookbooks path, roles
+  # path, and data_bags path (all relative to this Vagrantfile), and adding
+  # some recipes and/or roles.
+  #
+  config.vm.provision :chef_solo do |chef|
+    chef.cookbooks_path = "cookbooks"
+
+    # chef.roles_path     = "recipes/roles"
+  #   chef.data_bags_path = "../my-recipes/data_bags"
+    chef.add_recipe "apt"
+
+    chef.add_recipe "mysql"
+    chef.add_recipe "mysql::server"
+    chef.add_recipe "postgresql"
+    chef.add_recipe "postgresql::server"
+
+    chef.add_recipe "rvm::vagrant"
+    chef.add_recipe "rvm::user"
+    chef.add_recipe "git"
+    # chef.add_role "web"
+  #
+  #   # You may also specify custom JSON attributes:
+    chef.json = {
+      mysql: {
+        version: '5.5',
+        server_root_password: "",
+        server_repl_password: "",
+        server_debian_password: ""
+      },
+      postgresql: {
+        version: '9.1',
+        password: {
+          postgres: ''
+        },
+        pg_hba: [
+          {type: 'local', db: 'all', user: 'all', addr: nil, method: 'trust'},
+          {type: 'host', db: 'all', user: 'all', addr: '127.0.0.1/32', method: 'trust'},
+          {type: 'host', db: 'all', user: 'all', addr: '::1/128', method: 'trust'}
+        ]
+      },
+      rvm: {
+        user_default_ruby: 'ruby-1.9.3-p392',
+        user_installs: [{
+          user: 'vagrant',
+          default_ruby: 'ruby-1.9.3-p392@apartment',
+          versions: %w{1.9.3-p392}
+        }]
+      }
+    }
+  end
+
+  # Enable provisioning with chef server, specifying the chef server URL,
+  # and the path to the validation key (relative to this Vagrantfile).
+  #
+  # The Opscode Platform uses HTTPS. Substitute your organization for
+  # ORGNAME in the URL and validation key.
+  #
+  # If you have your own Chef Server, use the appropriate URL, which may be
+  # HTTP instead of HTTPS depending on your configuration. Also change the
+  # validation key to validation.pem.
+  #
+  # config.vm.provision :chef_client do |chef|
+  #   chef.chef_server_url = "https://api.opscode.com/organizations/ORGNAME"
+  #   chef.validation_key_path = "ORGNAME-validator.pem"
+  # end
+  #
+  # If you're using the Opscode platform, your validator client is
+  # ORGNAME-validator, replacing ORGNAME with your organization name.
+  #
+  # IF you have your own Chef Server, the default validation client name is
+  # chef-validator, unless you changed the configuration.
+  #
+  #   chef.validation_client_name = "ORGNAME-validator"
+end