apartment 0.26.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d6e788468ee9bf06e6609665cc72fc7f7dcc4f8
-  data.tar.gz: 219fad7766c4fecbbe3317a4567de5fc0df1c9e8
+  metadata.gz: 50bc04fb2abdbb0df0af4569c5452b9afeff250f
+  data.tar.gz: 3ba7ad62f8a6bc517e75d42e752a87786df87822
 SHA512:
-  metadata.gz: d89e61072548c8231dfe3e55bc824fa9ba484a8bbfb8146c2ba0b00d77d9254b485b4f3d67df21d1601570f0ac3885645a38793fac8de157dfdbe30d500927e9
-  data.tar.gz: f896417457f7c0c5ae40fcf61e5737f2d983cf2b40ba09e66163ada7379dbc9fbc633037e48e83abbac81b98306f8dfa002c2f6475a96c1394d2a4af62ec42c3
+  metadata.gz: 02bd472cb4382a949ce4058359bfff9c6320b5f65d2d3d86a4bc0b34a25c81b9750d8a950a28df4d1ae32e691dd7441340b7136ae9d6bd48f8cf80f11d29a390
+  data.tar.gz: 29a933a4e09c7e681d99bbd7bf44c0cd590a9c8b80dc9ed20b7bcafa11b61ce4dfd837896036e14ca31c5c4c8ef83b27dfb134ea9e09518855845d8c26970c6e

data/.rspec

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

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0
+ruby-2.1

data/.travis.yml

@@ -3,7 +3,9 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - jruby-19mode
+  - jruby-head
 gemfile:
   - gemfiles/rails_3_2.gemfile
   - gemfiles/rails_4_0.gemfile
@@ -15,3 +17,10 @@ before_install:
 env:
   RUBY_GC_MALLOC_LIMIT: 90000000
   RUBY_FREE_MIN: 200000
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+  exclude:
+    - rvm: 2.2.0
+      gemfile: gemfiles/rails_3_2.gemfile
+  fast_finish: true

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 1.0.0
+  * Feb 3, 2015
+
+  - [BREAKING CHANGE] `Apartment::Tenant.process` is deprecated in favour of `Apartment::Tenant.switch`
+  - [BREAKING CHANGE] `Apartment::Tenant.switch` without a block is deprecated in favour of `Apartment::Tenant.switch!`
+  - Raise proper `TenantNotFound`, `TenantExists` exceptions
+  - Deprecate old `SchemaNotFound`, `DatabaseNotFound` exceptions
+
 # 0.26.1
   * Jan 13, 2015
 

data/README.md

@@ -31,7 +31,7 @@ Configure as needed using the docs below.
 That's all you need to set up the Apartment libraries. If you want to switch tenants
 on a per-user basis, look under "Usage - Switching tenants per request", below.
 
-> NOTE: If using [postgresl schemas](http://www.postgresql.org/docs/9.0/static/ddl-schemas.html) you must use:
+> NOTE: If using [postgresql schemas](http://www.postgresql.org/docs/9.0/static/ddl-schemas.html) you must use:
 >
 > * for Rails 3.1.x: _Rails ~> 3.1.2_, it contains a [patch](https://github.com/rails/rails/pull/3232) that makes prepared statements work with multiple schemas
 
@@ -67,7 +67,7 @@ One can optionally use the full database creation instead if they want, though t
 To switch tenants using Apartment, use the following command:
 
 ```ruby
-Apartment::Tenant.switch('tenant_name')
+Apartment::Tenant.switch!('tenant_name')
 ```
 
 When switch is called, all requests coming to ActiveRecord will be routed to the tenant
@@ -148,6 +148,29 @@ module MyApplication
 end
 ```
 
+Your other option is to subclass the Generic elevator and implement your own
+switching mechanism. This is exactly how the other elevators work. Look at
+the `subdomain.rb` elevator to get an idea of how this should work. Basically
+all you need to do is subclass the generic elevator and implement your own
+`parse_tenant_name` method that will ultimately return the name of the tenant
+based on the request being made. It *could* look something like this:
+
+```ruby
+# app/middleware/my_custom_elevator.rb
+class MyCustomElevator < Apartment::Elevators::Generic
+
+  # @return {String} - The tenant to switch to
+  def parse_tenant_name(request)
+    # request is an instance of Rack::Request
+
+    # example: look up some tenant from the db based on this request
+    tenant_name = SomeModel.from_request(request)
+
+    return tenant_name
+  end
+end
+```
+
 ## Config
 
 The following config options should be set up in a Rails initializer such as:
@@ -196,12 +219,12 @@ config.persistent_schemas = ['some', 'other', 'schemas']
 ```
 
 ### Installing Extensions into Persistent Schemas
-Persistent Schemas have 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 extensions such as Hstore, you have to install it to a specific schema and have that always in the `schema_search_path`.  
+Persistent Schemas have 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 extensions such as Hstore, you have to install it to a specific schema and have that always in the `schema_search_path`.
 
 When using extensions, keep in mind:
 * Extensions can only be installed into one schema per database, so we will want to install it into a schema that is always available in the `schema_search_path`
-* The schema and extension need to be created in the database *before* they are referenced in migrations, database.yml or apartment. 
-* There does not seem to be a way to create the schema and extension using standard rails migrations. 
+* The schema and extension need to be created in the database *before* they are referenced in migrations, database.yml or apartment.
+* There does not seem to be a way to create the schema and extension using standard rails migrations.
 * Rails db:test:prepare deletes and recreates the database, so it needs to be easy for the extension schema to be recreated here.
 
 #### 1. Ensure the extensions schema is created when the database is created
@@ -243,7 +266,7 @@ end
 
 #### 2. Ensure the schema is in Rails' default connection
 
-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 extensions 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` or `uuid-ossp` during migrations.  To do so, add the following to your `database.yml` for all environments
+Next, your `database.yml` file must mimic what you've set for your default and persistent schemas in Apartment.  When you run migrations with Rails, it won't know about the extensions 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` or `uuid-ossp` during migrations.  To do so, add the following to your `database.yml` for all environments
 
 ```yaml
 # database.yml
@@ -253,7 +276,7 @@ schema_search_path: "public,shared_extensions"
 ...
 ```
 
-This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/427). For apps that use older Rails versions hosted on Heroku, the only way to properly setup is to start with a fresh PostgreSQL instance:
+This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/426). For apps that use older Rails versions hosted on Heroku, the only way to properly setup is to start with a fresh PostgreSQL instance:
 
 1. Append `?schema_search_path=public,hstore` to your `DATABASE_URL` environment variable, by this you don't have to revise the `database.yml` file (which is impossible since Heroku regenerates a completely different and immutable `database.yml` of its own on each deploy)
 2. Run `heroku pg:psql` from your command line

data/TODO.md

@@ -40,3 +40,12 @@
 
 9.  This one is pretty lofty, but I'd also like to abstract out the fact that Apartment uses ActiveRecord. With the new DataMapper coming out soon and other popular
     DBMS's (ie. mongo, couch etc...), it'd be nice if Apartment could be the de-facto interface for multi-tenancy on these systems.
+
+
+===================
+
+Quick TODOs
+
+1. `default_tenant` should be up to the adapter, not the Apartment class, deprecate `default_schema`
+2. deprecation.rb rescues everything, we have a hard dependency on ActiveSupport so this is unnecessary
+3.

data/apartment.gemspec

@@ -23,25 +23,26 @@ Gem::Specification.new do |s|
 
   Apartment Deprecation Warning
 
-  `Apartment::Database` has been deprecated in favour of `Apartment::Tenant`.
-  Please update your application to use the new constant as it is a more
-  appropriate abstraction.
+  `Apartment::Tenant.process` has been deprecated in favour of `Apartment::Tenant.switch`.
+  You must now always pass a block to `switch`.
 
-  To further this, DatabaseNotFound, SchemaNotFound, DatabaseExists and
-  SchemaExists exceptions will all be removed, you should instead use
-  TenantNotFound and TenantExists to catch any exceptions.
+  To get the previous `switch` behaviour where you can switch to a tenant
+  without a block, use `Apartment::Tenant.switch!`.
+  This is to indicate that your call actually has a side affect of changing
+  the scope of your queries to that tenant.
 
   ********************************
   MSG
 
-  s.add_dependency 'activerecord',    '>= 3.1.2', '< 5.0'   # must be >= 3.1.2 due to bug in prepared_statements
+  # must be >= 3.1.2 due to bug in prepared_statements
+  s.add_dependency 'activerecord',    '>= 3.1.2', '< 5.0'
   s.add_dependency 'rack',            '>= 1.3.6'
 
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rake',         '~> 0.9'
   s.add_development_dependency 'rspec-rails',  '~> 2.14'
   s.add_development_dependency 'guard-rspec',  '~> 4.2'
-  s.add_development_dependency 'capybara',     '~> 1.0.0'
+  s.add_development_dependency 'capybara',     '~> 2.0'
 
   if defined?(JRUBY_VERSION)
     s.add_development_dependency 'activerecord-jdbc-adapter'

data/lib/apartment.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/object/blank'
 require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
+require 'apartment/deprecation'
 
 module Apartment
 
@@ -16,7 +17,7 @@ module Apartment
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    def_delegators :connection_class, :connection, :establish_connection
+    def_delegators :connection_class, :connection, :connection_config, :establish_connection
 
     # configure apartment with available options
     def configure
@@ -42,8 +43,10 @@ module Apartment
     end
 
     def default_schema
-      @default_schema || "public"
+      @default_schema || "public" # TODO 'public' is postgres specific
     end
+    alias :default_tenant :default_schema
+    alias :default_tenant= :default_schema=
 
     def persistent_schemas
       @persistent_schemas || []
@@ -69,22 +72,22 @@ module Apartment
     end
 
     def database_names
-      warn "[Deprecation Warning] `database_names` is now deprecated, please use `tenant_names`"
+      Apartment::Deprecation.warn "[Deprecation Warning] `database_names` is now deprecated, please use `tenant_names`"
       tenant_names
     end
 
     def database_names=(names)
-      warn "[Deprecation Warning] `database_names=` is now deprecated, please use `tenant_names=`"
+      Apartment::Deprecation.warn "[Deprecation Warning] `database_names=` is now deprecated, please use `tenant_names=`"
       self.tenant_names=(names)
     end
 
     def use_postgres_schemas
-      warn "[Deprecation Warning] `use_postgresql_schemas` is now deprecated, please use `use_schemas`"
+      Apartment::Deprecation.warn "[Deprecation Warning] `use_postgresql_schemas` is now deprecated, please use `use_schemas`"
       use_schemas
     end
 
     def use_postgres_schemas=(to_use_or_not_to_use)
-      warn "[Deprecation Warning] `use_postgresql_schemas=` is now deprecated, please use `use_schemas=`"
+      Apartment::Deprecation.warn "[Deprecation Warning] `use_postgresql_schemas=` is now deprecated, please use `use_schemas=`"
       self.use_schemas = to_use_or_not_to_use
     end
   end
@@ -98,18 +101,6 @@ module Apartment
   # Tenant specified is unknown
   TenantNotFound = Class.new(ApartmentError)
 
-  # Raised when database cannot find the specified database
-  DatabaseNotFound = Class.new(TenantNotFound)
-
-  # Raised when database cannot find the specified schema
-  SchemaNotFound = Class.new(TenantNotFound)
-
   # The Tenant attempting to be created already exists
   TenantExists = Class.new(ApartmentError)
-
-  # Raised when trying to create a database that already exists
-  DatabaseExists = Class.new(TenantExists)
-
-  # Raised when trying to create a schema that already exists
-  SchemaExists = Class.new(TenantExists)
 end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -1,6 +1,9 @@
+require 'apartment/deprecation'
+
 module Apartment
   module Adapters
     class AbstractAdapter
+      attr_writer :default_tenant
 
       #   @constructor
       #   @param {Hash} config Database config
@@ -16,7 +19,7 @@ module Apartment
       def create(tenant)
         create_tenant(tenant)
 
-        process(tenant) do
+        switch(tenant) do
           import_database_schema
 
           # Seed data if appropriate
@@ -31,8 +34,8 @@ module Apartment
       #   @return {String} current tenant name
       #
       def current_database
-        warn "[Deprecation Warning] `current_database` is now deprecated, please use `current_tenant`"
-        current_tenant
+        Apartment::Deprecation.warn "[Deprecation Warning] `current_database` is now deprecated, please use `current`"
+        current
       end
 
       #   Get the current tenant name
@@ -40,38 +43,81 @@ module Apartment
       #   @return {String} current tenant name
       #
       def current_tenant
-        Apartment.connection.current_database
+        Apartment::Deprecation.warn "[Deprecation Warning] `current_tenant` is now deprecated, please use `current`"
+        current
       end
 
       #   Note alias_method here doesn't work with inheritence apparently ??
       #
       def current
-        current_tenant
+        Apartment.connection.current_database
       end
 
+      #   Return the original public tenant
+      #
+      #   @return {String} default tenant name
+      #
+      def default_tenant
+        @default_tenant || Apartment.default_tenant
+      end
+      alias :default_schema :default_tenant # TODO deprecate default_schema
+
       #   Drop the tenant
       #
-      #   @param {String} tenant Database name
+      #   @param {String} tenant name
       #
       def drop(tenant)
         # Apartment.connection.drop_database   note that drop_database will not throw an exception, so manually execute
         Apartment.connection.execute("DROP DATABASE #{environmentify(tenant)}" )
 
       rescue *rescuable_exceptions
-        raise DatabaseNotFound, "The tenant #{environmentify(tenant)} cannot be found"
+        raise TenantNotFound, "The tenant #{environmentify(tenant)} cannot be found"
+      end
+
+      #   Switch to a new tenant
+      #
+      #   @param {String} tenant name
+      #
+      def switch!(tenant = nil)
+        return reset if tenant.nil?
+
+        connect_to_new(tenant).tap do
+          Apartment.connection.clear_query_cache
+        end
       end
 
       #   Connect to tenant, do your biz, switch back to previous tenant
       #
-      #   @param {String?} tenant Database or schema to connect to
+      #   @param {String?} tenant to connect to
       #
-      def process(tenant = nil)
-        previous_tenant = current_tenant
-        switch(tenant)
-        yield if block_given?
+      def switch(tenant = nil)
+        if block_given?
+          begin
+            previous_tenant = current
+            switch!(tenant)
+            yield
+
+          ensure
+            switch!(previous_tenant) rescue reset
+          end
+        else
+          Apartment::Deprecation.warn("[Deprecation Warning] `switch` now requires a block reset to the default tenant after the block. Please use `switch!` instead if you don't want this")
+          switch!(tenant)
+        end
+      end
 
-      ensure
-        switch(previous_tenant) rescue reset
+      #   [Deprecated]
+      def process(tenant = nil, &block)
+        Apartment::Deprecation.warn("[Deprecation Warning] `process` is now deprecated. Please use `switch`")
+        switch(tenant, &block)
+      end
+
+      #   Iterate over all tenants, switch to tenant and yield tenant name
+      #
+      def each(tenants = Apartment.tenant_names)
+        tenants.each do |tenant|
+          switch(tenant){ yield tenant }
+        end
       end
 
       #   Establish a new connection for each specific excluded model
@@ -89,19 +135,6 @@ module Apartment
         Apartment.establish_connection @config
       end
 
-      #   Switch to new connection (or schema if appopriate)
-      #
-      #   @param {String} tenant Database name
-      #
-      def switch(tenant = nil)
-        # Just connect to default db and return
-        return reset if tenant.nil?
-
-        connect_to_new(tenant).tap do
-          ActiveRecord::Base.connection.clear_query_cache
-        end
-      end
-
       #   Load the rails seed file into the db
       #
       def seed_data
@@ -119,7 +152,7 @@ module Apartment
         Apartment.connection.create_database( environmentify(tenant) )
 
       rescue *rescuable_exceptions
-        raise DatabaseExists, "The tenant #{environmentify(tenant)} already exists."
+        raise TenantExists, "The tenant #{environmentify(tenant)} already exists."
       end
 
       #   Connect to new tenant
@@ -131,7 +164,7 @@ module Apartment
         Apartment.connection.active?   # call active? to manually check if this connection is valid
 
       rescue *rescuable_exceptions
-        raise DatabaseNotFound, "The tenant #{environmentify(tenant)} cannot be found."
+        raise TenantNotFound, "The tenant #{environmentify(tenant)} cannot be found."
       end
 
       #   Prepend the environment if configured and the environment isn't already there
@@ -182,7 +215,7 @@ module Apartment
       #   Exceptions to rescue from on db operations
       #
       def rescuable_exceptions
-        [ActiveRecord::ActiveRecordError] + [rescue_from].flatten
+        [ActiveRecord::ActiveRecordError] + Array(rescue_from)
       end
 
       #   Extra exceptions to rescue from

data/lib/apartment/adapters/jdbc_mysql_adapter.rb

@@ -21,9 +21,9 @@ module Apartment
       #
       def connect_to_new(database)
         super
-      rescue DatabaseNotFound
+      rescue TenantNotFound
         Apartment::Tenant.reset
-        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+        raise TenantNotFound, "Cannot find database #{environmentify(database)}"
       end
     end
   end

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -23,7 +23,7 @@ module Apartment
         Apartment.connection.create_database(environmentify(tenant), { :thisisahack => '' })
 
       rescue *rescuable_exceptions
-        raise DatabaseExists, "The tenant #{environmentify(tenant)} already exists."
+        raise TenantExists, "The tenant #{environmentify(tenant)} already exists."
       end
 
       #   Return a new config that is multi-tenanted
@@ -50,11 +50,11 @@ module Apartment
         return reset if tenant.nil?
         raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.all_schemas.include? tenant.to_s
 
-        @current_tenant = tenant.to_s
+        @current = tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
 
       rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise SchemaNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
+        raise TenantNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
       end
 
     private