ros-apartment 2.3.0 → 2.11.0

data/lib/apartment.rb

@@ -1,22 +1,47 @@
+# frozen_string_literal: true
+
 require 'apartment/railtie' if defined?(Rails)
 require 'active_support/core_ext/object/blank'
 require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
-module Apartment
+require_relative 'apartment/log_subscriber'
 
-  class << self
+if ActiveRecord.version.release >= Gem::Version.new('6.0')
+  require_relative 'apartment/active_record/connection_handling'
+end
+
+if ActiveRecord.version.release >= Gem::Version.new('6.1')
+  require_relative 'apartment/active_record/schema_migration'
+  require_relative 'apartment/active_record/internal_metadata'
+end
 
+# Apartment main definitions
+module Apartment
+  class << self
     extend Forwardable
 
-    ACCESSOR_METHODS  = [:use_schemas, :use_sql, :seed_after_create, :prepend_environment, :append_environment, :with_multi_server_setup]
-    WRITER_METHODS    = [:tenant_names, :database_schema_file, :excluded_models, :default_schema, :persistent_schemas, :connection_class, :tld_length, :db_migrate_tenants, :seed_data_file, :parallel_migration_threads, :pg_excluded_names]
+    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment default_tenant
+                          append_environment with_multi_server_setup tenant_presence_check active_record_log].freeze
+
+    WRITER_METHODS = %i[tenant_names database_schema_file excluded_models
+                        persistent_schemas connection_class
+                        db_migrate_tenants db_migrate_tenant_missing_strategy seed_data_file
+                        parallel_migration_threads pg_excluded_names].freeze
 
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    if ActiveRecord.version.release >= Gem::Version.new('6.1')
+      def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
+
+      def connection_config
+        connection_db_config.configuration_hash
+      end
+    else
+      def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    end
 
     # configure apartment with available options
     def configure
@@ -31,8 +56,12 @@ module Apartment
       extract_tenant_config
     end
 
+    def tld_length=(_)
+      Apartment::Deprecation.warn('`config.tld_length` have no effect because it was removed in https://github.com/influitive/apartment/pull/309')
+    end
+
     def db_config_for(tenant)
-      (tenants_with_config[tenant] || connection_config).with_indifferent_access
+      (tenants_with_config[tenant] || connection_config)
     end
 
     # Whether or not db:migrate should also migrate tenants
@@ -43,20 +72,29 @@ module Apartment
       @db_migrate_tenants = true
     end
 
+    # How to handle tenant missing on db:migrate
+    # defaults to :rescue_exception
+    # available options: rescue_exception, raise_exception, create_tenant
+    def db_migrate_tenant_missing_strategy
+      valid = %i[rescue_exception raise_exception create_tenant]
+      value = @db_migrate_tenant_missing_strategy || :rescue_exception
+
+      return value if valid.include?(value)
+
+      key_name  = 'config.db_migrate_tenant_missing_strategy'
+      opt_names = valid.join(', ')
+
+      raise ApartmentError, "Option #{value} not valid for `#{key_name}`. Use one of #{opt_names}"
+    end
+
     # Default to empty array
     def excluded_models
       @excluded_models || []
     end
 
-    def default_schema
-      @default_schema || "public" # TODO 'public' is postgres specific
-    end
-
     def parallel_migration_threads
       @parallel_migration_threads || 0
     end
-    alias :default_tenant :default_schema
-    alias :default_tenant= :default_schema=
 
     def persistent_schemas
       @persistent_schemas || []
@@ -69,13 +107,13 @@ module Apartment
     def database_schema_file
       return @database_schema_file if defined?(@database_schema_file)
 
-      @database_schema_file = Rails.root.join('db', 'schema.rb')
+      @database_schema_file = Rails.root.join('db/schema.rb')
     end
 
     def seed_data_file
       return @seed_data_file if defined?(@seed_data_file)
 
-      @seed_data_file = "#{Rails.root}/db/seeds.rb"
+      @seed_data_file = Rails.root.join('db/seeds.rb')
     end
 
     def pg_excluded_names
@@ -84,11 +122,14 @@ module Apartment
 
     # Reset all the config for Apartment
     def reset
-      (ACCESSOR_METHODS + WRITER_METHODS).each{|method| remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}") }
+      (ACCESSOR_METHODS + WRITER_METHODS).each do |method|
+        remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}")
+      end
     end
 
     def extract_tenant_config
       return {} unless @tenant_names
+
       values = @tenant_names.respond_to?(:call) ? @tenant_names.call : @tenant_names
       unless values.is_a? Hash
         values = values.each_with_object({}) do |tenant, hash|

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Apartment
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     def copy_files
-      template "apartment.rb", File.join("config", "initializers", "apartment.rb")
+      template 'apartment.rb', File.join('config', 'initializers', 'apartment.rb')
     end
-
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # You can have Apartment route to the appropriate Tenant by adding some Rack middleware.
 # Apartment can support many different "Elevators" that can take care of this routing to your data.
 # Require whichever Elevator you're using below or none if you have a custom one.
@@ -12,7 +14,6 @@ require 'apartment/elevators/subdomain'
 # Apartment Configuration
 #
 Apartment.configure do |config|
-
   # Add any models that you do not want to be multi-tenanted, but remain in the global (public) namespace.
   # A typical example would be a Customer or Tenant model that stores each Tenant's information.
   #
@@ -22,7 +23,8 @@ Apartment.configure do |config|
   # You can make this dynamic by providing a Proc object to be called on migrations.
   # This object should yield either:
   # - an array of strings representing each Tenant name.
-  # - a hash which keys are tenant names, and values custom db config (must contain all key/values required in database.yml)
+  # - a hash which keys are tenant names, and values custom db config
+  # (must contain all key/values required in database.yml)
   #
   # config.tenant_names = lambda{ Customer.pluck(:tenant_name) }
   # config.tenant_names = ['tenant1', 'tenant2']
@@ -48,7 +50,7 @@ Apartment.configure do |config|
   #   end
   # end
   #
-  config.tenant_names = lambda { ToDo_Tenant_Or_User_Model.pluck :database }
+  config.tenant_names = -> { ToDo_Tenant_Or_User_Model.pluck :database }
 
   # PostgreSQL:
   #   Specifies whether to use PostgreSQL schemas or create a new database per Tenant.
@@ -95,6 +97,11 @@ Apartment.configure do |config|
   # the new tenant
   #
   # config.pg_excluded_names = ["uuid_generate_v4"]
+
+  # Specifies whether the database and schema (when using PostgreSQL schemas) will prepend in ActiveRecord log.
+  # Uncomment the line below if you want to enable this behavior.
+  #
+  # config.active_record_log = true
 end
 
 # Setup a custom Tenant switching middleware. The Proc should return the name of the Tenant that

data/lib/tasks/apartment.rake

@@ -1,113 +1,98 @@
+# frozen_string_literal: true
+
 require 'apartment/migrator'
+require 'apartment/tasks/task_helper'
 require 'parallel'
 
 apartment_namespace = namespace :apartment do
-
-  desc "Create all tenants"
+  desc 'Create all tenants'
   task :create do
-    tenants.each do |tenant|
-      begin
-        puts("Creating #{tenant} tenant")
-        Apartment::Tenant.create(tenant)
-      rescue Apartment::TenantExists => e
-        puts e.message
-      end
+    Apartment::TaskHelper.warn_if_tenants_empty
+
+    Apartment::TaskHelper.tenants.each do |tenant|
+      Apartment::TaskHelper.create_tenant(tenant)
     end
   end
 
-  desc "Drop all tenants"
+  desc 'Drop all tenants'
   task :drop do
-    tenants.each do |tenant|
-      begin
-        puts("Dropping #{tenant} tenant")
-        Apartment::Tenant.drop(tenant)
-      rescue Apartment::TenantNotFound => e
-        puts e.message
-      end
+    Apartment::TaskHelper.tenants.each do |tenant|
+      puts("Dropping #{tenant} tenant")
+      Apartment::Tenant.drop(tenant)
+    rescue Apartment::TenantNotFound, ActiveRecord::NoDatabaseError => e
+      puts e.message
     end
   end
 
-  desc "Migrate all tenants"
+  desc 'Migrate all tenants'
   task :migrate do
-    warn_if_tenants_empty
-    each_tenant do |tenant|
-      begin
-        puts("Migrating #{tenant} tenant")
-        Apartment::Migrator.migrate tenant
-      rescue Apartment::TenantNotFound => e
-        puts e.message
-      end
+    Apartment::TaskHelper.warn_if_tenants_empty
+    Apartment::TaskHelper.each_tenant do |tenant|
+      Apartment::TaskHelper.migrate_tenant(tenant)
     end
   end
 
-  desc "Seed all tenants"
+  desc 'Seed all tenants'
   task :seed do
-    warn_if_tenants_empty
-
-    each_tenant do |tenant|
-      begin
-        puts("Seeding #{tenant} tenant")
-        Apartment::Tenant.switch(tenant) do
-          Apartment::Tenant.seed
-        end
-      rescue Apartment::TenantNotFound => e
-        puts e.message
+    Apartment::TaskHelper.warn_if_tenants_empty
+
+    Apartment::TaskHelper.each_tenant do |tenant|
+      Apartment::TaskHelper.create_tenant(tenant)
+      puts("Seeding #{tenant} tenant")
+      Apartment::Tenant.switch(tenant) do
+        Apartment::Tenant.seed
       end
+    rescue Apartment::TenantNotFound => e
+      puts e.message
     end
   end
 
-  desc "Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants."
+  desc 'Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants.'
   task :rollback do
-    warn_if_tenants_empty
+    Apartment::TaskHelper.warn_if_tenants_empty
 
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
 
-    each_tenant do |tenant|
-      begin
-        puts("Rolling back #{tenant} tenant")
-        Apartment::Migrator.rollback tenant, step
-      rescue Apartment::TenantNotFound => e
-        puts e.message
-      end
+    Apartment::TaskHelper.each_tenant do |tenant|
+      puts("Rolling back #{tenant} tenant")
+      Apartment::Migrator.rollback tenant, step
+    rescue Apartment::TenantNotFound => e
+      puts e.message
     end
   end
 
   namespace :migrate do
     desc 'Runs the "up" for a given migration VERSION across all tenants.'
     task :up do
-      warn_if_tenants_empty
+      Apartment::TaskHelper.warn_if_tenants_empty
 
       version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
       raise 'VERSION is required' unless version
 
-      each_tenant do |tenant|
-        begin
-          puts("Migrating #{tenant} tenant up")
-          Apartment::Migrator.run :up, tenant, version
-        rescue Apartment::TenantNotFound => e
-          puts e.message
-        end
+      Apartment::TaskHelper.each_tenant do |tenant|
+        puts("Migrating #{tenant} tenant up")
+        Apartment::Migrator.run :up, tenant, version
+      rescue Apartment::TenantNotFound => e
+        puts e.message
       end
     end
 
     desc 'Runs the "down" for a given migration VERSION across all tenants.'
     task :down do
-      warn_if_tenants_empty
+      Apartment::TaskHelper.warn_if_tenants_empty
 
       version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
       raise 'VERSION is required' unless version
 
-      each_tenant do |tenant|
-        begin
-          puts("Migrating #{tenant} tenant down")
-          Apartment::Migrator.run :down, tenant, version
-        rescue Apartment::TenantNotFound => e
-          puts e.message
-        end
+      Apartment::TaskHelper.each_tenant do |tenant|
+        puts("Migrating #{tenant} tenant down")
+        Apartment::Migrator.run :down, tenant, version
+      rescue Apartment::TenantNotFound => e
+        puts e.message
       end
     end
 
-    desc  'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
+    desc 'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
     task :redo do
       if ENV['VERSION']
         apartment_namespace['migrate:down'].invoke
@@ -118,28 +103,4 @@ apartment_namespace = namespace :apartment do
       end
     end
   end
-
-  def each_tenant(&block)
-    Parallel.each(tenants, in_threads: Apartment.parallel_migration_threads) do |tenant|
-      block.call(tenant)
-    end
-  end
-
-  def tenants
-    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Apartment.tenant_names || []
-  end
-
-  def warn_if_tenants_empty
-    if tenants.empty? && ENV['IGNORE_EMPTY_TENANTS'] != "true"
-      puts <<-WARNING
-        [WARNING] - The list of tenants to migrate appears to be empty. This could mean a few things:
-
-          1. You may not have created any, in which case you can ignore this message
-          2. You've run `apartment:migrate` directly without loading the Rails environment
-            * `apartment:migrate` is now deprecated. Tenants will automatically be migrated with `db:migrate`
-
-        Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
-      WARNING
-    end
-  end
 end

data/ros-apartment.gemspec

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('lib', __dir__)
+require 'apartment/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ros-apartment'
+  s.version = Apartment::VERSION
+
+  s.authors       = ['Ryan Brunner', 'Brad Robertson', 'Rui Baltazar']
+  s.summary       = 'A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement'
+  s.description   = 'Apartment allows Rack applications to deal with database multitenancy through ActiveRecord'
+  s.email         = ['ryan@influitive.com', 'brad@influitive.com', 'rui.p.baltazar@gmail.com']
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been
+  # added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      # NOTE: ignore all test related
+      f.match(%r{^(test|spec|features|documentation)/})
+    end
+  end
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.homepage = 'https://github.com/rails-on-services/apartment'
+  s.licenses = ['MIT']
+
+  s.add_dependency 'activerecord', '>= 5.0.0', '< 7.1'
+  s.add_dependency 'parallel', '< 2.0'
+  s.add_dependency 'public_suffix', '>= 2.0.5', '< 5.0'
+  s.add_dependency 'rack', '>= 1.3.6', '< 3.0'
+
+  s.add_development_dependency 'appraisal', '~> 2.2'
+  s.add_development_dependency 'bundler', '>= 1.3', '< 3.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.2'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'rspec_junit_formatter'
+  s.add_development_dependency 'rspec-rails', '~> 3.4'
+  s.add_development_dependency 'rubocop', '~> 0.93'
+  s.add_development_dependency 'rubocop-performance', '~> 1.10'
+  s.add_development_dependency 'rubocop-rails', '~> 2.1'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.44'
+
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbc-adapter'
+    s.add_development_dependency 'activerecord-jdbcmysql-adapter'
+    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
+    s.add_development_dependency 'jdbc-mysql'
+    s.add_development_dependency 'jdbc-postgres'
+  else
+    s.add_development_dependency 'mysql2',  '~> 0.5'
+    s.add_development_dependency 'pg',      '~> 1.2'
+    s.add_development_dependency 'sqlite3', '~> 1.3.6'
+  end
+end