apartment 0.13.0 → 0.13.0.1

data/HISTORY.md

@@ -1,13 +1,20 @@
+# 0.13.0.1
+  * Feb 9, 2012
+
+  - Versioning has become a bit of a mess.  Will maintain this line for Rails 3.0.x
+  - Removing Rails dependency, now just depends on ActiveRecord :)
+  - `drop` was somehow missed from the methods proxied through to the adapter, added that in.
+
 # 0.13.0
   * Oct 25, 2011
-  
+
   - `process` will now rescue with reset if the previous schema/db is no longer available
   - `create` now takes an optional block which allows you to process within the newly created db
   - Fixed Rails version >= 3.0.10 and < 3.1 because there have been significant testing problems with 3.1, next version will hopefully fix this
-  
+
 # 0.12.0
   * Oct 4, 2011
-  
+
   - Added a `drop` method for removing databases/schemas
   - Refactored abstract adapter to further remove duplication in concrete implementations
   - Excluded models now take string references so they are properly reloaded in development
@@ -15,7 +22,7 @@
 
 # 0.11.1
   * Sep 22, 2011
-  
+
   - Better use of Railties for initializing apartment
   - The following changes were necessary as I haven't figured out how to properly hook into Rails reloading
     - Added reloader middleware in development to init Apartment on each request
@@ -23,88 +30,88 @@
 
 # 0.11.0
   * Sep 20, 2011
-  
+
   - Excluded models no longer use a different connection when using postgresql schemas.  Instead their table_name is prefixed with `public.`
 
 # 0.10.3
   * Sep 20, 2011
-  
+
   - Fix improper raising of exceptions on create and reset
 
 # 0.10.2
   * Sep 15, 2011
-  
+
   - Remove all the annoying logging for loading db schema and seeding on create
 
 # 0.10.1
   * Aug 11, 2011
-  
+
   - Fixed bug in DJ where new objects (that hadn't been pulled from the db) didn't have the proper database assigned
 
 # 0.10.0
   * July 29, 2011
-  
+
   - Added better support for Delayed Job
   - New config option that enables Delayed Job wrappers
   - Note that DJ support uses a work-around in order to get queues stored in the public schema, not sure why it doesn't work out of the box, will look into it, until then, see documentation on queue'ng jobs
-  
+
 # 0.9.2
   * July 4, 2011
-  
+
   - Migrations now run associated rails migration fully, fixes schema.rb not being reloaded after migrations
 
 # 0.9.1
   * June 24, 2011
-  
+
   - Hooks now take the payload object as an argument to fetch the proper db for DJ hooks
 
 # 0.9.0
   * June 23, 2011
-  
+
   - Added module to provide delayed job hooks
 
 # 0.8.0
   * June 23, 2011
-  
+
   - Added #current_database which will return the current database (or schema) name
 
 # 0.7.0
   * June 22, 2011
-  
+
   - Added apartment:seed rake task for seeding all dbs
 
 # 0.6.0
   * June 21, 2011
-  
+
   - Added #process to connect to new db, perform operations, then ensure a reset
 
 # 0.5.1
   * June 21, 2011
-  
+
   - Fixed db migrate up/down/rollback
   - added db:redo
 
 # 0.5.0
   * June 20, 2011
-  
+
   - Added the concept of an "Elevator", a rack based strategy for db switching
   - Added the Subdomain Elevator middleware to enabled db switching based on subdomain
 
 # 0.4.0
   * June 14, 2011
-  
+
   - Added `configure` method on Apartment instead of using yml file, allows for dynamic setting of db names to migrate for rake task
   - Added `seed_after_create` config option to import seed data to new db on create
-  
+
 # 0.3.0
   * June 10, 2011
-  
+
   - Added full support for database migration
   - Added in method to establish new connection for excluded models on startup rather than on each switch
-    
+
 # 0.2.0
   * June 6, 2011 *
-  
+
   - Refactor to use more rails/active_support functionality
   - Refactor config to lazily load apartment.yml if exists
   - Remove OStruct and just use hashes for fetching methods

data/apartment.gemspec

@@ -7,25 +7,28 @@ Gem::Specification.new do |s|
   s.version = Apartment::VERSION
 
   s.authors = ["Ryan Brunner", "Brad Robertson"]
-  s.summary = %q{A Ruby gem for managing database multitenancy in Rails applications}
-  s.description = %q{Apartment allows Rails applications to deal with database multitenancy}
+  s.summary = %q{A Ruby gem for managing database multitenancy in Rack applications using ActiveRecord}
+  s.description = %q{Apartment allows applications using ActiveRecord to deal with database multitenancy}
   s.email = %w{ryan@ryanbrunner.com bradleyrobertson@gmail.com}
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  
+
   s.homepage = %q{http://github.com/bradrobertson/apartment}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  
-  s.add_dependency 'rails', '~> 3.0.10'   # must be >= 3.0.10 due to poor schema support pre 3.0.10, but < 3.1 because it hasn't been fully tested yet
-  s.add_development_dependency 'rake', '~> 0.8.7'
+
+  s.add_dependency 'activerecord',    '~> 3.0.10'   # must be >= 3.0.10 due to poor schema support pre 3.0.10
+  s.add_dependency 'rack',            '~> 1.2.5'
+
+  s.add_development_dependency 'rake',            '~> 0.8.7'
+  s.add_development_dependency 'rails',           '~> 3.0.10'
   s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
-  s.add_development_dependency 'rspec-rails', '~> 2.6.1'
-  s.add_development_dependency 'capybara', '1.0.0'
-  s.add_development_dependency 'pg', '~> 0.11.0'
-  s.add_development_dependency 'mysql2', '0.2.7'
+  s.add_development_dependency 'rspec',           '~> 2.6.0'
+  s.add_development_dependency 'rspec-rails',     '~> 2.6.1'
+  s.add_development_dependency 'capybara',        '1.0.0'
+  s.add_development_dependency 'pg',              '~> 0.11.0'
+  s.add_development_dependency 'mysql2',          '0.2.7'
   s.add_development_dependency "silent-postgres", "~> 0.1.1"
-  s.add_development_dependency 'delayed_job', '~> 2.1.4'
+  s.add_development_dependency 'delayed_job',     '~> 2.1.4'
 end

data/lib/apartment.rb

@@ -1,16 +1,19 @@
 require 'apartment/railtie' if defined?(Rails)
 
 module Apartment
-  
+
   class << self
-    attr_accessor :use_postgres_schemas, :seed_after_create, :prepend_environment
-    attr_writer :database_names, :excluded_models
-    
+    ACCESSOR_METHODS = [:use_postgres_schemas, :seed_after_create, :prepend_environment]
+    WRITER_METHODS = [:database_names, :excluded_models, :load_schema]
+
+    attr_accessor(*ACCESSOR_METHODS)
+    attr_writer(*WRITER_METHODS)
+
     # configure apartment with available options
     def configure
       yield self if block_given?
     end
-    
+
     # Be careful not to use `return` here so both Proc and lambda can be used without breaking
     def database_names
       if @database_names.respond_to?(:call)
@@ -19,55 +22,65 @@ module Apartment
         @database_names
       end
     end
-    
+
     # Default to none
     def excluded_models
       @excluded_models || []
     end
-    
+
+    # Defaults to true if not set
+    def load_schema
+      @load_schema != false
+    end
+
+    # Reset all the config for Apartment
+    def reset
+      (ACCESSOR_METHODS + WRITER_METHODS).each{|method| instance_variable_set(:"@#{method}", nil) }
+    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 :Subdomain, 'apartment/elevators/subdomain'
   end
-  
+
   module Delayed
-    
+
     autoload :Requirements, 'apartment/delayed_job/requirements'
-    
+
     module Job
       autoload :Hooks, 'apartment/delayed_job/hooks'
     end
   end
-  
+
   # Exceptions
   class ApartmentError < StandardError; end
-  
+
   # Raised when apartment cannot find the adapter specified in <tt>config/database.yml</tt>
   class AdapterNotFound < ApartmentError; end
-  
+
   # Raised when database cannot find the specified database
   class DatabaseNotFound < ApartmentError; end
-  
+
   # Raised when trying to create a database that already exists
   class DatabaseExists < ApartmentError; end
-  
+
   # Raised when database cannot find the specified schema
   class SchemaNotFound < ApartmentError; end
-  
+
   # Raised when trying to create a schema that already exists
   class SchemaExists < ApartmentError; end
-  
+
   # 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,81 +1,81 @@
 require 'active_record'
 
 module Apartment
-  
+
   module Adapters
-  
+
     class AbstractAdapter
-      
+
       #   @constructor
       #   @param {Hash} config Database config
       #   @param {Hash} defaults Some default options
-      # 
+      #
       def initialize(config, defaults = {})
         @config = config
         @defaults = defaults
       end
-      
+
       #   Create a new database, import schema, seed if appropriate
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
   		def create(database)
   		  create_database(database)
 
   			process(database) do
-    			import_database_schema
+    			import_database_schema if Apartment.load_schema
 
           # Seed data if appropriate
           seed_data if Apartment.seed_after_create
-          
+
           yield if block_given?
   			end
   		end
-      
+
       #   Get the current database name
-      #   
+      #
       #   @return {String} current database name
-      # 
+      #
       def current_database
         ActiveRecord::Base.connection.current_database
       end
-      
+
       #   Drop the database
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def drop(database)
         # ActiveRecord::Base.connection.drop_database   note that drop_database will not throw an exception, so manually execute
         ActiveRecord::Base.connection.execute("DROP DATABASE #{environmentify(database)}" )
-        
-      rescue ActiveRecord::StatementInvalid => e
+
+      rescue ActiveRecord::StatementInvalid
   		  raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found"
       end
-      
+
       #   Prepend the environment if configured and the environment isn't already there
-      # 
+      #
       #   @param {String} database Database name
       #   @return {String} database name with Rails environment *optionally* prepended
-      # 
+      #
       def environmentify(database)
         Apartment.prepend_environment && !database.include?(Rails.env) ? "#{Rails.env}_#{database}" : database
-  		end
-  		
+      end
+
       #   Connect to db, do your biz, switch back to previous db
-      # 
+      #
       #   @param {String?} database Database or schema to connect to
-      # 
+      #
       def process(database = nil)
         current_db = current_database
 		    switch(database)
 		    yield if block_given?
-		    
-		  ensure
+
+      ensure
   		  switch(current_db) rescue reset
-	    end
-	    
+      end
+
 	    #   Establish a new connection for each specific excluded model
-      # 
+      #
       def process_excluded_models
         # All other models will shared a connection (at ActiveRecord::Base) and we can modify at will
   	    Apartment.excluded_models.each do |excluded_model|
@@ -85,77 +85,77 @@ module Apartment
             warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
             excluded_model = excluded_model.name
           end
-          
+
   				excluded_model.constantize.establish_connection @config
   			end
       end
-      
+
       #   Reset the database connection to the default
-      # 
+      #
       def reset
         ActiveRecord::Base.establish_connection @config
       end
-      
+
       #   Switch to new connection (or schema if appopriate)
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def switch(database = nil)
         # Just connect to default db and return
   			return reset if database.nil?
 
         connect_to_new(database)
-  		end
+      end
 
       #   Load the rails seed file into the db
-      #   
-  		def seed_data
+      #
+      def seed_data
   		  silence_stream(STDOUT){ load_or_abort("#{Rails.root}/db/seeds.rb") } # Don't log the output of seeding the db
       end
 	    alias_method :seed, :seed_data
-      
+
     protected
-    
+
       #   Create the database
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def create_database(database)
         ActiveRecord::Base.connection.create_database( environmentify(database) )
 
-      rescue ActiveRecord::StatementInvalid => e
+      rescue ActiveRecord::StatementInvalid
         raise DatabaseExists, "The database #{environmentify(database)} already exists."
       end
-  
+
       #   Connect to new database
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def connect_to_new(database)
         ActiveRecord::Base.establish_connection multi_tenantify(database)
         ActiveRecord::Base.connection.active?   # call active? to manually check if this connection is valid
 
-      rescue ActiveRecord::StatementInvalid => e
+      rescue ActiveRecord::StatementInvalid
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
-  	  end
-      
+      end
+
       #   Import the database schema
-      # 
+      #
 	    def import_database_schema
 	      ActiveRecord::Schema.verbose = false    # do not log schema load output.
 	      load_or_abort("#{Rails.root}/db/schema.rb")
 	    end
-	    
+
 	    #   Return a new config that is multi-tenanted
-      # 
+      #
       def multi_tenantify(database)
   			@config.clone.tap do |config|
   			  config[:database] = environmentify(database)
 			  end
-  		end
-      
+      end
+
       #   Load a file or abort if it doesn't exists
-      # 
+      #
       def load_or_abort(file)
         if File.exists?(file)
           load(file)
@@ -163,14 +163,14 @@ module Apartment
           abort %{#{file} doesn't exist yet}
         end
       end
-      
+
       #   Remove all non-alphanumeric characters
-      # 
-	    def sanitize(database)
+      #
+      def sanitize(database)
 	      warn "[Deprecation Warning] Sanitize is no longer used, client should ensure proper database names"
 	      database.gsub(/[\W]/,'')
       end
-      
+
     end
   end
 end