apartment 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d86514c4d6c5f8dce97d40d42fb15b0728c1899
-  data.tar.gz: 896a629874de7e38e011439aecedc8a9d1e421e3
+  metadata.gz: 7048e41db332f308d96362525ecd55389c7b6ad2
+  data.tar.gz: c303cac42eca0c9d5a22263fb8d2b3abb239b07e
 SHA512:
-  metadata.gz: 1748af36194e004026605133a90b994668b0abff22a2d0daeeef284cdf331491befc373aa6a498a20467ba7e97bf1644572b91d7183965ca550369f590801ddb
-  data.tar.gz: c746e001bce3d931773a929134162fc5c80ec915623cdc04371beeef19ce26b12bc079e3ed27013d0ddbca32f09469dfd5774ea439648ee1865996f3b50d981b
+  metadata.gz: ab730aab830bf546295ecd75dabc017dd1fe01a55bbf82b625ff0f9e70cd7a58034417afe25344c7c36ff9f9e1f75eec7a73a4d07432fc1f6acc4e03291548ab
+  data.tar.gz: 0d7041eaea15f04e43ab772adfbbebb51f35451215a619882162d337d9bb25bbffbf3c9bbfb0e73ece50935681a45adc8d1ecb55e9d1ceeae38823a2dbd73134

data/.gitignore

@@ -1,6 +1,6 @@
 *.gem
 .bundle
-Gemfile.lock
+*.lock
 pkg/*
 *.log
 .idea
@@ -9,4 +9,4 @@ spec/config/database.yml
 spec/dummy/config/database.yml
 cookbooks
 tmp
-spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3

data/.rspec

@@ -1,3 +1,4 @@
 --colour
 --format documentation
---tty
+--tty
+--order random

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - jruby-19mode-1.7.4
+gemfile:
+  - gemfiles/rails3.2.gemfile
+  - gemfiles/rails4.0.gemfile
 bundler_args: --without local --verbose

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails3.2" do
+  gem "rails", "~> 3.2"
+end
+
+appraise "rails4.0" do
+  gem "rails", "~> 4.0"
+end

data/Gemfile

@@ -3,27 +3,6 @@ source 'http://rubygems.org'
 gemspec
 
 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'
-  gem 'sqlite3'
-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'

data/HISTORY.md

@@ -1,3 +1,9 @@
+# 0.23.0
+  * August 21, 2013
+
+  - Subdomain Elevator now allows for exclusions
+  - Delayed::Job has been completely removed
+
 # 0.22.1
   * August 21, 2013
 

data/README.md

@@ -75,19 +75,28 @@ In house, we use the subdomain elevator, which analyzes the subdomain of the req
 
 ```ruby
 # application.rb
-module My Application
+module MyApplication
   class Application < Rails::Application
     config.middleware.use 'Apartment::Elevators::Subdomain'
   end
 end
 ```
 
+If you want to exclude a domain, for example if you don't want your application to treate www like a subdomain, in an initializer in your application, you can set the following:
+
+```ruby
+# config/initializers/apartment/subdomain_exclusions.rb
+Apartment::Elevators::Subdomain.excluded_subdomains = ['www']
+```
+
+This functions much in the same way as Apartment.excluded_models. This example will prevent switching your database when the subdomain is www. Handy for subdomains like: "public", "www", and "admin" :)
+
 **Switch on domain**
 To switch based on full domain (excluding subdomains *ie 'www'* and top level domains *ie '.com'* ) use the following:
 
 ```ruby
 # application.rb
-module My Application
+module MyApplication
   class Application < Rails::Application
     config.middleware.use 'Apartment::Elevators::Domain'
   end
@@ -99,7 +108,7 @@ To switch based on full host with a hash to find corresponding database name use
 
 ```ruby
 # application.rb
-module My Application
+module MyApplication
   class Application < Rails::Application
     config.middleware.use 'Apartment::Elevators::HostHash', {'example.com' => 'example_database'}
   end
@@ -238,74 +247,7 @@ 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
-
-### 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:
-
-```ruby
-require 'rubygems'
-require 'yaml'
-YAML::ENGINE.yamler = 'syck'
-
-# 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:
-
-```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
-
-```ruby
-class SomeDJ
-  include Apartment::Delayed::Job::Hooks
-
-  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
-```
-
-All jobs *must* stored in the global (public) namespace, so add it to the list of excluded models:
-
-```ruby
-config.excluded_models = ["Delayed::Job"]
-```
+### Has been removed... See apartment-sidekiq for a better backgrounding experience
 
 ## Contributing
 

data/Rakefile

@@ -2,6 +2,8 @@ require 'bundler' rescue 'You must `gem install bundler` and `bundle install` to
 Bundler.setup
 Bundler::GemHelper.install_tasks
 
+require 'appraisal'
+
 require "rspec"
 require "rspec/core/rake_task"
 
@@ -63,7 +65,7 @@ namespace :mysql do
 
   desc 'Build the MySQL test databases'
   task :build_db do
-    %x{ mysqladmin -u #{my_config['username']} create #{my_config['database']} } rescue "test db already exists"
+    %x{ mysqladmin -u #{my_config['username']} --password=#{my_config['password']} create #{my_config['database']} } rescue "test db already exists"
     ActiveRecord::Base.establish_connection my_config
     ActiveRecord::Migrator.migrate('spec/dummy/db/migrate')
   end
@@ -71,7 +73,7 @@ namespace :mysql do
   desc "drop the MySQL test database"
   task :drop_db do
     puts "dropping database #{my_config['database']}"
-    %x{ mysqladmin -u #{my_config['username']} drop #{my_config['database']} --force}
+    %x{ mysqladmin -u #{my_config['username']} --password=#{my_config['password']} drop #{my_config['database']} --force}
   end
 
 end

data/TODO.md

@@ -24,11 +24,6 @@
     think about Tenants. I proprose that we deprecate the `Apartment::Database` constant in favour of `Apartment::Tenant` for a nicer abstraction. See
     http://myronmars.to/n/dev-blog/2011/09/deprecating-constants-and-classes-in-ruby for ideas on how to achieve this.
 
-3.  `Delayed::Job` has proven to be an absolute P.I.T.A. It's YAML hacks are beyond reproach and require further hacks in order to work properly.
-    I want to completely remove the Delayed::Job dependency from Apartment and make an `apartment-delayed-job` gem that can be worked on independently
-    (and hopefully eventually deprecated). To this end, I've started an `apartment-sidekiq` gem and would love to see an `apartment-resque` gem to deal
-    with those background workers from a multi-tenant perspective also.
-
 4.  Apartment::Database.process should be deprecated in favour of just passing an optional block to `switch`
 
 5.  Migrations right now can be a bit of a pain. Apartment currently migrates a single tenant completely up to date, then goes onto the next. If one of these

data/apartment.gemspec

@@ -20,4 +20,23 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activerecord',    '>= 3.1.2'   # must be >= 3.1.2 due to bug in prepared_statements
   s.add_dependency 'rack',            '>= 1.3.6'
+
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'rake',         '~> 0.9'
+  s.add_development_dependency 'rspec',        '~> 2.11'
+  s.add_development_dependency 'rspec-rails',  '~> 2.11'
+  s.add_development_dependency 'capybara',     '~> 1.0.0'
+
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbc-adapter'
+    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
+    s.add_development_dependency 'activerecord-jdbcmysql-adapter'
+    s.add_development_dependency 'jdbc-postgres', '9.2.1002'
+    s.add_development_dependency 'jdbc-mysql'
+    s.add_development_dependency 'jruby-openssl'
+  else
+    s.add_development_dependency 'mysql2', '~> 0.3.10'
+    s.add_development_dependency 'pg',     '>= 0.11.0'
+    s.add_development_dependency 'sqlite3'
+  end
 end

data/gemfiles/rails3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2"
+
+gemspec :path=>"../"

data/gemfiles/rails4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.0"
+
+gemspec :path=>"../"

data/lib/apartment.rb

@@ -1,6 +1,8 @@
 require 'apartment/railtie' if defined?(Rails)
 require 'active_support/core_ext/object/blank'
 require 'forwardable'
+require 'active_record'
+require 'apartment/database'
 
 module Apartment
 
@@ -63,33 +65,6 @@ module Apartment
       warn "[Deprecation Warning] `use_postgresql_schemas=` is now deprecated, please use `use_schemas=`"
       self.use_schemas = to_use_or_not_to_use
     end
-
-  end
-
-  autoload :Database, 'apartment/database'
-  autoload :Migrator, 'apartment/migrator'
-  autoload :Reloader, 'apartment/reloader'
-
-  module Adapters
-    autoload :AbstractAdapter, 'apartment/adapters/abstract_adapter'
-    # Specific adapters will be loaded dynamically based on adapter in config
-  end
-
-  module Elevators
-    autoload :Generic,    'apartment/elevators/generic'
-    autoload :Subdomain,      'apartment/elevators/subdomain'
-    autoload :FirstSubdomain, 'apartment/elevators/first_subdomain'
-    autoload :Domain,     'apartment/elevators/domain'
-    autoload :HostHash,     'apartment/elevators/host_hash'
-  end
-
-  module Delayed
-
-    autoload :Requirements, 'apartment/delayed_job/requirements'
-
-    module Job
-      autoload :Hooks, 'apartment/delayed_job/hooks'
-    end
   end
 
   # Exceptions
@@ -112,5 +87,4 @@ module Apartment
 
   # Raised when an ActiveRecord object does not have the required database field on it
   class DJSerializationError < ApartmentError; end
-
 end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -1,5 +1,3 @@
-require 'active_record'
-
 module Apartment
   module Adapters
     class AbstractAdapter

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -1,3 +1,5 @@
+require 'apartment/adapters/abstract_adapter'
+
 module Apartment
   module Adapters
     class AbstractJDBCAdapter < AbstractAdapter

data/lib/apartment/adapters/jdbc_mysql_adapter.rb

@@ -1,3 +1,5 @@
+require "apartment/adapters/abstract_jdbc_adapter"
+
 module Apartment
 
   module Database

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -48,7 +48,7 @@ module Apartment
       #
       def connect_to_new(database = nil)
         return reset if database.nil?
-        raise ActiveRecord::StatementInvalid.new unless Apartment.connection.all_schemas.include? database.to_s
+        raise ActiveRecord::StatementInvalid.new("Could not find schema #{database}") unless Apartment.connection.all_schemas.include? database.to_s
 
         @current_database = database.to_s
         Apartment.connection.schema_search_path = full_search_path

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -1,5 +1,6 @@
-module Apartment
+require 'apartment/adapters/abstract_adapter'
 
+module Apartment
   module Database
 
     def self.mysql2_adapter(config)
@@ -10,7 +11,6 @@ module Apartment
   end
 
   module Adapters
-
     class Mysql2Adapter < AbstractAdapter
 
     protected
@@ -73,7 +73,6 @@ module Apartment
           # Ensure that if a schema *was* set, we override
           table_name = klass.table_name.split('.', 2).last
 
-          # Not sure why, but Delayed::Job somehow ignores table_name_prefix...  so we'll just manually set table name instead
           klass.table_name = "#{default_database}.#{table_name}"
         end
       end

data/lib/apartment/adapters/postgis_adapter.rb

@@ -3,7 +3,6 @@
 require "apartment/adapters/postgresql_adapter"
 
 module Apartment
-
   module Database
 
     def self.postgis_adapter(config)

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -1,5 +1,6 @@
-module Apartment
+require 'apartment/adapters/abstract_adapter'
 
+module Apartment
   module Database
 
     def self.postgresql_adapter(config)
@@ -10,7 +11,6 @@ module Apartment
   end
 
   module Adapters
-
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < AbstractAdapter
 
@@ -48,7 +48,6 @@ module Apartment
             # Ensure that if a schema *was* set, we override
             table_name = klass.table_name.split('.', 2).last
 
-            # Not sure why, but Delayed::Job somehow ignores table_name_prefix...  so we'll just manually set table name instead
             klass.table_name = "#{Apartment.default_schema}.#{table_name}"
           end
         end

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -1,3 +1,5 @@
+require 'apartment/adapters/abstract_adapter'
+
 module Apartment
   module Database
     def self.sqlite3_adapter(config)

data/lib/apartment/database.rb

@@ -1,7 +1,6 @@
 require 'forwardable'
 
 module Apartment
-
   #   The main entry point to Apartment functions
   #
   module Database
@@ -36,7 +35,6 @@ module Apartment
         end
 
         begin
-          require "apartment/adapters/abstract_jdbc_adapter" if defined?(JRUBY_VERSION)
           require "apartment/adapters/#{adapter_method}"
         rescue LoadError
           raise "The adapter `#{adapter_method}` is not yet supported"
@@ -64,7 +62,5 @@ module Apartment
     def config
       @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
     end
-
   end
-
 end