apartment 0.17.3 → 0.18.0

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 0.18.0
+  * Nov 27, 2012
+
+  - Added `append_environment` config option [virtualstaticvoid]
+  - Cleaned up the readme and generator documentation
+  - Added `connection_class` config option [smashtank]
+  - Fixed a [bug](https://github.com/influitive/apartment/issues/17#issuecomment-10758327) in pg adapter when missing schema
+
 # 0.17.1
   * Oct 30, 2012
 

data/README.md

@@ -33,8 +33,8 @@ you need to create a new database, you can run the following command:
 
     Apartment::Database.create('database_name')
 
-Apartment will create a new database in the following format: "_environment_\_database_name".
-In the case of a sqlite database, this will be created in your 'db/migrate' folder. With
+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
 other databases, the database will be created as a new DB within the system.
 
 When you create a new database, all migrations will be run against that database, so it will be

data/apartment.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors = ["Ryan Brunner", "Brad Robertson"]
   s.summary = %q{A Ruby gem for managing database multitenancy}
   s.description = %q{Apartment allows Rack applications to deal with database multitenancy through ActiveRecord}
-  s.email = %w{ryan@ryanbrunner.com bradleyrobertson@gmail.com}
+  s.email = %w{ryan@influitive.com brad@influitive.com}
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
 

data/lib/apartment.rb

@@ -3,12 +3,14 @@ require 'apartment/railtie' if defined?(Rails)
 module Apartment
 
   class << self
-    ACCESSOR_METHODS  = [:use_postgres_schemas, :seed_after_create, :prepend_environment]
-    WRITER_METHODS    = [:database_names, :excluded_models, :default_schema, :persistent_schemas]
+    ACCESSOR_METHODS  = [:use_postgres_schemas, :seed_after_create, :prepend_environment, :append_environment]
+    WRITER_METHODS    = [:database_names, :excluded_models, :default_schema, :persistent_schemas, :connection_class]
 
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
+    delegate :connection, :establish_connection, to: :connection_class
+
     # configure apartment with available options
     def configure
       yield self if block_given?
@@ -37,6 +39,10 @@ module Apartment
       @persistent_schemas || []
     end
 
+    def connection_class
+      @connection_class || ActiveRecord::Base
+    end
+
     # Reset all the config for Apartment
     def reset
       (ACCESSOR_METHODS + WRITER_METHODS).each{|method| instance_variable_set(:"@#{method}", nil) }

data/lib/apartment/adapters/abstract_adapter.rb

@@ -37,7 +37,7 @@ module Apartment
       #   @return {String} current database name
       #
       def current_database
-        ActiveRecord::Base.connection.current_database
+        Apartment.connection.current_database
       end
       alias_method :current, :current_database
 
@@ -46,8 +46,8 @@ module Apartment
       #   @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)}" )
+        # Apartment.connection.drop_database   note that drop_database will not throw an exception, so manually execute
+        Apartment.connection.execute("DROP DATABASE #{environmentify(database)}" )
 
       rescue ActiveRecord::StatementInvalid
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found"
@@ -69,7 +69,7 @@ module Apartment
       #   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
+        # All other models will shared a connection (at Apartment.connection_class) and we can modify at will
         Apartment.excluded_models.each do |excluded_model|
           # Note that due to rails reloading, we now take string references to classes rather than
           # actual object references.  This way when we contantize, we always get the proper class reference
@@ -85,7 +85,7 @@ module Apartment
       #   Reset the database connection to the default
       #
       def reset
-        ActiveRecord::Base.establish_connection @config
+        Apartment.establish_connection @config
       end
 
       #   Switch to new connection (or schema if appopriate)
@@ -113,7 +113,7 @@ module Apartment
       #   @param {String} database Database name
       #
       def create_database(database)
-        ActiveRecord::Base.connection.create_database( environmentify(database) )
+        Apartment.connection.create_database( environmentify(database) )
 
       rescue ActiveRecord::StatementInvalid
         raise DatabaseExists, "The database #{environmentify(database)} already exists."
@@ -124,8 +124,8 @@ module Apartment
       #   @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
+        Apartment.establish_connection multi_tenantify(database)
+        Apartment.connection.active?   # call active? to manually check if this connection is valid
 
       rescue ActiveRecord::StatementInvalid
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
@@ -137,7 +137,17 @@ module Apartment
       #   @return {String} database name with Rails environment *optionally* prepended
       #
       def environmentify(database)
-        Apartment.prepend_environment && !database.include?(Rails.env) ? "#{Rails.env}_#{database}" : database
+        unless database.include?(Rails.env)
+          if Apartment.prepend_environment
+            "#{Rails.env}_#{database}"
+          elsif Apartment.append_environment
+            "#{database}_#{Rails.env}"
+          else
+            database
+          end
+        else
+          database
+        end
       end
 
       #   Import the database schema

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -40,7 +40,7 @@ module Apartment
       #   @param {String} database Database (schema) to drop
       #
       def drop(database)
-        ActiveRecord::Base.connection.execute(%{DROP SCHEMA "#{database}" CASCADE})
+        Apartment.connection.execute(%{DROP SCHEMA "#{database}" CASCADE})
 
       rescue ActiveRecord::StatementInvalid
         raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
@@ -78,7 +78,7 @@ module Apartment
       #
       def reset
         @current_database = Apartment.default_schema
-        ActiveRecord::Base.connection.schema_search_path = full_search_path
+        Apartment.connection.schema_search_path = full_search_path
       end
 
     protected
@@ -89,16 +89,16 @@ module Apartment
         return reset if database.nil?
 
         @current_database = database.to_s
-        ActiveRecord::Base.connection.schema_search_path = full_search_path
+        Apartment.connection.schema_search_path = full_search_path
 
       rescue ActiveRecord::StatementInvalid
-        raise SchemaNotFound, "One of the following schema(s) is invalid: #{new_search_path}"
+        raise SchemaNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
       end
 
       #   Create the new schema
       #
       def create_database(database)
-        ActiveRecord::Base.connection.execute(%{CREATE SCHEMA "#{database}"})
+        Apartment.connection.execute(%{CREATE SCHEMA "#{database}"})
 
       rescue ActiveRecord::StatementInvalid
         raise SchemaExists, "The schema #{database} already exists."

data/lib/apartment/railtie.rb

@@ -14,6 +14,7 @@ module Apartment
         config.database_names = []
         config.seed_after_create = false
         config.prepend_environment = false
+        config.append_environment = false
       end
     end
 

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.17.3"
+  VERSION = "0.18.0"
 end

data/lib/generators/apartment/install/templates/apartment.rb

@@ -1,5 +1,6 @@
-##
+#
 # Apartment Configuration
+#
 Apartment.configure do |config|
 
   # these models will not be multi-tenanted,
@@ -18,18 +19,18 @@ Apartment.configure do |config|
   # config.prepend_environment = true
   # config.append_environment = true
 
-  # supply list of database names
-  config.database_names = lambda{ ToDo_Tenant_Or_User_Model.scoped.collect(&:database) }
+  # supply list of database names for migrations to run on
+  config.database_names = lambda{ ToDo_Tenant_Or_User_Model.pluck :database }
 
 end
 
 ##
 # Elevator Configuration
 
-# Rails.application.config.middleware.use 'Apartment::Elevators::Domain'
+# Rails.application.config.middleware.use 'Apartment::Elevators::Generic', lambda { |request|
+#   # TODO: supply generic implementation
+# }
 
-# Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'
+# Rails.application.config.middleware.use 'Apartment::Elevators::Domain'
 
-Rails.application.config.middleware.use 'Apartment::Elevators::Generic', Proc.new { |request|
-  # TODO: supply generic implementation
-}
+Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'

data/spec/examples/generic_adapter_examples.rb

@@ -3,7 +3,10 @@ require 'spec_helper'
 shared_examples_for "a generic apartment adapter" do
   include Apartment::Spec::AdapterRequirements
 
-  before{ Apartment.prepend_environment = false }
+  before {
+    Apartment.prepend_environment = false
+    Apartment.append_environment = false
+  }
 
   #
   #   Creates happen already in our before_filter

data/spec/examples/schema_adapter_examples.rb

@@ -148,50 +148,7 @@ shared_examples_for "a schema based apartment adapter" do
 
     it "should reset connection if database is nil" do
       subject.switch
-      connection.schema_search_path.should include public_schema
-    end
-
-    describe "other schemas in search path" do
-      let(:other_schema) { "other_schema" }
-      before do
-        subject.create(other_schema)
-        @old_schema = subject.instance_variable_get(:@defaults)[:schema_search_path]
-        subject.instance_variable_get(:@defaults)[:schema_search_path] += "," + other_schema
-      end
-
-      it "should maintain other schemas on switch" do
-        subject.switch(schema1)
-        connection.schema_search_path.should include other_schema
-      end
-
-      after do
-        subject.instance_variable_get(:@defaults)[:schema_search_path] = @old_schema
-        subject.drop(other_schema)
-      end
-
-      describe "with schema_to_switch specified" do
-        before do
-          Apartment.schema_to_switch = other_schema
-          subject.switch(schema1)
-        end
-
-        after do
-          # Reset the switch schema.
-          Apartment.schema_to_switch = nil
-        end
-
-        it "should switch out the schema to switch rather than public" do
-          connection.schema_search_path.should_not include other_schema
-        end
-
-        it "should retain the public schema" do
-          connection.schema_search_path.should include "public"
-        end
-
-        it "should still switch to the switched schema" do
-          connection.schema_search_path.should include schema1
-        end
-      end
+      connection.schema_search_path.should == public_schema
     end
 
     it "should raise an error if schema is invalid" do
@@ -256,7 +213,4 @@ shared_examples_for "a schema based apartment adapter" do
       end
     end
   end
-
-
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apartment
 version: !ruby/object:Gem::Version
-  version: 0.17.3
+  version: 0.18.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -223,8 +223,8 @@ dependencies:
 description: Apartment allows Rack applications to deal with database multitenancy
   through ActiveRecord
 email:
-- ryan@ryanbrunner.com
-- bradleyrobertson@gmail.com
+- ryan@influitive.com
+- brad@influitive.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -342,7 +342,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -682928631525156949
+      hash: -2510818630049995736
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -351,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -682928631525156949
+      hash: -2510818630049995736
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24