apartment 1.2.0 → 2.0.0

data/apartment.gemspec

@@ -18,25 +18,10 @@ Gem::Specification.new do |s|
   s.homepage = %q{https://github.com/influitive/apartment}
   s.licenses = ["MIT"]
 
-  s.post_install_message = <<-MSG
-  ********************************
-
-  Apartment Deprecation Warning
-
-  `Apartment::Tenant.process` has been deprecated in favour of `Apartment::Tenant.switch`.
-  You must now always pass a block to `switch`.
-
-  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
-
   # must be >= 3.1.2 due to bug in prepared_statements
   s.add_dependency 'activerecord',    '>= 3.1.2', '< 6.0'
   s.add_dependency 'rack',            '>= 1.3.6'
+  s.add_dependency 'public_suffix',   '~> 2.0.5'
 
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rake',         '~> 0.9'
@@ -56,4 +41,9 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'pg',     '>= 0.11.0'
     s.add_development_dependency 'sqlite3'
   end
+
+  if RUBY_VERSION < '2.1.0'
+    # capybara depends on xpath depends on nokogiri
+    s.add_development_dependency 'nokogiri', '< 1.7.0'
+  end
 end

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '2'
+services:
+  postgresql:
+    image: postgres:9.2
+    environment:
+      POSTGRES_PASSWORD: ""
+    ports:
+      - "5432:5432"
+  mysql:
+    image: mysql:5.7
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+    ports:
+      - "3306:3306"

data/gemfiles/rails_4_0.gemfile

@@ -9,4 +9,4 @@ group :local do
   gem "guard-rspec", "~> 4.2"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_4_1.gemfile

@@ -9,4 +9,4 @@ group :local do
   gem "guard-rspec", "~> 4.2"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_4_2.gemfile

@@ -9,4 +9,4 @@ group :local do
   gem "guard-rspec", "~> 4.2"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -9,4 +9,4 @@ group :local do
   gem "guard-rspec", "~> 4.2"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/{rails_3_2.gemfile → rails_5_1.gemfile}

@@ -2,12 +2,11 @@
 
 source "http://rubygems.org"
 
-gem "rails", "~> 3.2.0"
-gem "test-unit", "~> 3.0"
+gem "rails", "5.1.1"
 
 group :local do
   gem "pry"
   gem "guard-rspec", "~> 4.2"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_master.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", git: "https://github.com/rails/rails.git"
+
+group :local do
+  gem "pry"
+  gem "guard-rspec", "~> 4.2"
+end
+
+gemspec path: "../"

data/lib/apartment.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext/object/blank'
 require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
-require 'apartment/deprecation'
 
 module Apartment
 
@@ -75,35 +74,11 @@ module Apartment
       @seed_data_file = "#{Rails.root}/db/seeds.rb"
     end
 
-    def tld_length
-      @tld_length || 1
-    end
-
     # Reset all the config for Apartment
     def reset
       (ACCESSOR_METHODS + WRITER_METHODS).each{|method| remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}") }
     end
 
-    def database_names
-      Apartment::Deprecation.warn "[Deprecation Warning] `database_names` is now deprecated, please use `tenant_names`"
-      tenant_names
-    end
-
-    def database_names=(names)
-      Apartment::Deprecation.warn "[Deprecation Warning] `database_names=` is now deprecated, please use `tenant_names=`"
-      self.tenant_names=(names)
-    end
-
-    def use_postgres_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)
-      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
-
     def extract_tenant_config
       return {} unless @tenant_names
       values = @tenant_names.respond_to?(:call) ? @tenant_names.call : @tenant_names
@@ -124,6 +99,9 @@ module Apartment
   # Raised when apartment cannot find the adapter specified in <tt>config/database.yml</tt>
   AdapterNotFound = Class.new(ApartmentError)
 
+  # Raised when apartment cannot find the file to be loaded
+  FileNotFound = Class.new(ApartmentError)
+
   # Tenant specified is unknown
   TenantNotFound = Class.new(ApartmentError)
 

data/lib/apartment/adapters/abstract_adapter.rb

@@ -1,5 +1,3 @@
-require 'apartment/deprecation'
-
 module Apartment
   module Adapters
     class AbstractAdapter
@@ -34,24 +32,6 @@ module Apartment
         end
       end
 
-      #   Get the current tenant name
-      #
-      #   @return {String} current tenant name
-      #
-      def current_database
-        Apartment::Deprecation.warn "[Deprecation Warning] `current_database` is now deprecated, please use `current`"
-        current
-      end
-
-      #   Get the current tenant name
-      #
-      #   @return {String} current tenant name
-      #
-      def current_tenant
-        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
@@ -99,25 +79,14 @@ module Apartment
       #   @param {String?} tenant to connect to
       #
       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")
+        begin
+          previous_tenant = current
           switch!(tenant)
-        end
-      end
+          yield
 
-      #   [Deprecated]
-      def process(tenant = nil, &block)
-        Apartment::Deprecation.warn("[Deprecation Warning] `process` is now deprecated. Please use `switch`")
-        switch(tenant, &block)
+        ensure
+          switch!(previous_tenant) rescue reset
+        end
       end
 
       #   Iterate over all tenants, switch to tenant and yield tenant name
@@ -147,7 +116,7 @@ module Apartment
       #
       def seed_data
         # Don't log the output of seeding the db
-        silence_warnings{ load_or_abort(Apartment.seed_data_file) } if Apartment.seed_data_file
+        silence_warnings{ load_or_raise(Apartment.seed_data_file) } if Apartment.seed_data_file
       end
       alias_method :seed, :seed_data
 
@@ -159,7 +128,7 @@ module Apartment
 
       def drop_command(conn, tenant)
         # connection.drop_database   note that drop_database will not throw an exception, so manually execute
-        conn.execute("DROP DATABASE #{environmentify(tenant)}")
+        conn.execute("DROP DATABASE #{conn.quote_table_name(environmentify(tenant))}")
       end
 
       #   Create the tenant
@@ -175,7 +144,7 @@ module Apartment
       end
 
       def create_tenant_command(conn, tenant)
-        conn.create_database(environmentify(tenant))
+        conn.create_database(environmentify(tenant), @config)
       end
 
       #   Connect to new tenant
@@ -183,8 +152,12 @@ module Apartment
       #   @param {String} tenant Database name
       #
       def connect_to_new(tenant)
+        query_cache_enabled = ActiveRecord::Base.connection.query_cache_enabled
+
         Apartment.establish_connection multi_tenantify(tenant)
         Apartment.connection.active?   # call active? to manually check if this connection is valid
+
+        Apartment.connection.enable_query_cache! if query_cache_enabled
       rescue *rescuable_exceptions => exception
         Apartment::Tenant.reset if reset_on_connection_exception?
         raise_connect_error!(tenant, exception)
@@ -214,7 +187,7 @@ module Apartment
       def import_database_schema
         ActiveRecord::Schema.verbose = false    # do not log schema load output.
 
-        load_or_abort(Apartment.database_schema_file) if Apartment.database_schema_file
+        load_or_raise(Apartment.database_schema_file) if Apartment.database_schema_file
       end
 
       #   Return a new config that is multi-tenanted
@@ -233,15 +206,17 @@ module Apartment
         config[:database] = environmentify(tenant)
       end
 
-      #   Load a file or abort if it doesn't exists
+      #   Load a file or raise error if it doesn't exists
       #
-      def load_or_abort(file)
+      def load_or_raise(file)
         if File.exists?(file)
           load(file)
         else
-          abort %{#{file} doesn't exist yet}
+          raise FileNotFound, "#{file} doesn't exist yet"
         end
       end
+      # Backward compatibility
+      alias_method :load_or_abort, :load_or_raise
 
       #   Exceptions to rescue from on db operations
       #

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -18,7 +18,7 @@ module Apartment
     private
 
       def rescue_from
-        PGError
+        PG::Error
       end
     end
 
@@ -63,11 +63,18 @@ module Apartment
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists? tenant
+        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists?(tenant.to_s)
 
         @current = tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
 
+        # When the PostgreSQL version is < 9.3,
+        # there is a issue for prepared statement with changing search_path.
+        # https://www.postgresql.org/docs/9.3/static/sql-prepare.html
+        if postgresql_version < 90300
+          Apartment.connection.clear_cache!
+        end
+
       rescue *rescuable_exceptions
         raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
       end
@@ -87,6 +94,12 @@ module Apartment
       def persistent_schemas
         [@current, Apartment.persistent_schemas].flatten
       end
+
+      def postgresql_version
+        # ActiveRecord::ConnectionAdapters::PostgreSQLAdapter#postgresql_version is
+        # public from Rails 5.0.
+        Apartment.connection.send(:postgresql_version)
+      end
     end
 
     # Another Adapter for Postgresql when using schemas and SQL
@@ -94,7 +107,8 @@ module Apartment
 
       PSQL_DUMP_BLACKLISTED_STATEMENTS= [
         /SET search_path/i,   # overridden later
-        /SET lock_timeout/i   # new in postgresql 9.3
+        /SET lock_timeout/i,   # new in postgresql 9.3
+        /SET idle_in_transaction_session_timeout/i,   # new in postgresql 9.6
       ]
 
       def import_database_schema

data/lib/apartment/elevators/generic.rb

@@ -1,6 +1,5 @@
 require 'rack/request'
 require 'apartment/tenant'
-require 'apartment/deprecation'
 
 module Apartment
   module Elevators
@@ -10,7 +9,7 @@ module Apartment
 
       def initialize(app, processor = nil)
         @app = app
-        @processor = processor || parse_method
+        @processor = processor || method(:parse_tenant_name)
       end
 
       def call(env)
@@ -25,27 +24,9 @@ module Apartment
         end
       end
 
-      def parse_database_name(request)
-        deprecation_warning
-        parse_tenant_name(request)
-      end
-
       def parse_tenant_name(request)
         raise "Override"
       end
-
-      def parse_method
-        if self.class.instance_methods(false).include? :parse_database_name
-          deprecation_warning
-          method(:parse_database_name)
-        else
-          method(:parse_tenant_name)
-        end
-      end
-
-      def deprecation_warning
-        Apartment::Deprecation.warn "[DEPRECATED::Apartment] Use #parse_tenant_name instead of #parse_database_name -> #{self.class.name}"
-      end
     end
   end
 end

data/lib/apartment/elevators/subdomain.rb

@@ -1,4 +1,5 @@
 require 'apartment/elevators/generic'
+require 'public_suffix'
 
 module Apartment
   module Elevators
@@ -38,13 +39,23 @@ module Apartment
       end
 
       def subdomains(host)
-        return [] unless named_host?(host)
+        host_valid?(host) ? parse_host(host) : []
+      end
+
+      def host_valid?(host)
+        !ip_host?(host) && domain_valid?(host)
+      end
+
+      def ip_host?(host)
+        !/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/.match(host).nil?
+      end
 
-        host.split('.')[0..-(Apartment.tld_length + 2)]
+      def domain_valid?(host)
+        PublicSuffix.valid?(host, ignore_private: true)
       end
 
-      def named_host?(host)
-        !(host.nil? || /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.match(host))
+      def parse_host(host)
+        (PublicSuffix.parse(host).trd || '').split('.')
       end
     end
   end

data/lib/apartment/railtie.rb

@@ -17,7 +17,6 @@ module Apartment
         config.seed_after_create = false
         config.prepend_environment = false
         config.append_environment = false
-        config.tld_length = 1
       end
 
       ActiveRecord::Migrator.migrations_paths = Rails.application.paths['db/migrate'].to_a
@@ -28,7 +27,11 @@ module Apartment
     #   See the middleware/console declarations below to help with this. Hope to fix that soon.
     #
     config.to_prepare do
-      Apartment::Tenant.init unless ARGV.include? 'assets:precompile'
+      unless ARGV.any? { |arg| arg =~ /\Aassets:(?:precompile|clean)\z/ }
+        Apartment.connection_class.connection_pool.with_connection do
+          Apartment::Tenant.init
+        end
+      end
     end
 
     #

data/lib/apartment/tenant.rb

@@ -1,5 +1,4 @@
 require 'forwardable'
-require 'apartment/deprecation'
 
 module Apartment
   #   The main entry point to Apartment functions
@@ -64,13 +63,4 @@ module Apartment
       @config ||= Apartment.connection_config
     end
   end
-
-  def self.const_missing(const_name)
-    if const_name == :Database
-      Apartment::Deprecation.warn "`Apartment::Database` has been deprecated. Use `Apartment::Tenant` instead."
-      Tenant
-    else
-      super
-    end
-  end
 end