ros-apartment 2.3.0.alpha1

data/Rakefile

@@ -0,0 +1,128 @@
+require 'bundler' rescue 'You must `gem install bundler` and `bundle install` to run rake tasks'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'appraisal'
+
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec => %w{ db:copy_credentials db:test:prepare }) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  # spec.rspec_opts = '--order rand:47078'
+end
+
+namespace :spec do
+  [:tasks, :unit, :adapters, :integration].each do |type|
+    RSpec::Core::RakeTask.new(type => :spec) do |spec|
+      spec.pattern = "spec/#{type}/**/*_spec.rb"
+    end
+  end
+end
+
+task :console do
+  require 'pry'
+  require 'apartment'
+  ARGV.clear
+  Pry.start
+end
+
+task :default => :spec
+
+namespace :db do
+  namespace :test do
+    task :prepare => %w{postgres:drop_db postgres:build_db mysql:drop_db mysql:build_db}
+  end
+
+  desc "copy sample database credential files over if real files don't exist"
+  task :copy_credentials do
+    require 'fileutils'
+    apartment_db_file = 'spec/config/database.yml'
+    rails_db_file = 'spec/dummy/config/database.yml'
+
+    FileUtils.copy(apartment_db_file + '.sample', apartment_db_file, :verbose => true) unless File.exists?(apartment_db_file)
+    FileUtils.copy(rails_db_file + '.sample', rails_db_file, :verbose => true)         unless File.exists?(rails_db_file)
+  end
+end
+
+namespace :postgres do
+  require 'active_record'
+  require "#{File.join(File.dirname(__FILE__), 'spec', 'support', 'config')}"
+
+  desc 'Build the PostgreSQL test databases'
+  task :build_db do
+    params = []
+    params << "-E UTF8"
+    params << pg_config['database']
+    params << "-U#{pg_config['username']}"
+    params << "-h#{pg_config['host']}" if pg_config['host']
+    params << "-p#{pg_config['port']}" if pg_config['port']
+    %x{ createdb #{params.join(' ')} } rescue "test db already exists"
+    ActiveRecord::Base.establish_connection pg_config
+    migrate
+  end
+
+  desc "drop the PostgreSQL test database"
+  task :drop_db do
+    puts "dropping database #{pg_config['database']}"
+    params = []
+    params << pg_config['database']
+    params << "-U#{pg_config['username']}"
+    params << "-h#{pg_config['host']}" if pg_config['host']
+    params << "-p#{pg_config['port']}" if pg_config['port']
+    %x{ dropdb #{params.join(' ')} }
+  end
+
+end
+
+namespace :mysql do
+  require 'active_record'
+  require "#{File.join(File.dirname(__FILE__), 'spec', 'support', 'config')}"
+
+  desc 'Build the MySQL test databases'
+  task :build_db do
+    params = []
+    params << "-h #{my_config['host']}" if my_config['host']
+    params << "-u #{my_config['username']}" if my_config['username']
+    params << "-p#{my_config['password']}" if my_config['password']
+    %x{ mysqladmin #{params.join(' ')} create #{my_config['database']} } rescue "test db already exists"
+    ActiveRecord::Base.establish_connection my_config
+    migrate
+  end
+
+  desc "drop the MySQL test database"
+  task :drop_db do
+    puts "dropping database #{my_config['database']}"
+    params = []
+    params << "-h #{my_config['host']}" if my_config['host']
+    params << "-u #{my_config['username']}" if my_config['username']
+    params << "-p#{my_config['password']}" if my_config['password']
+    %x{ mysqladmin #{params.join(' ')} drop #{my_config['database']} --force}
+  end
+
+end
+
+# TODO clean this up
+def config
+  Apartment::Test.config['connections']
+end
+
+def pg_config
+  config['postgresql']
+end
+
+def my_config
+  config['mysql']
+end
+
+def activerecord_below_5_2?
+  ActiveRecord.version.release < Gem::Version.new('5.2.0')
+end
+
+def migrate
+  if activerecord_below_5_2?
+    ActiveRecord::Migrator.migrate('spec/dummy/db/migrate')
+  else
+    ActiveRecord::MigrationContext.new('spec/dummy/db/migrate').migrate
+  end
+end

data/TODO.md

@@ -0,0 +1,51 @@
+# Apartment TODOs
+
+### Below is a list of tasks in the approximate order to be completed of for Apartment
+### Any help along the way is greatly appreciated (on any items, not particularly in order)
+
+1.  Apartment was originally written (and TDD'd) with just Postgresql in mind. Different adapters were added at a later date.
+    As such, the test suite is a bit of a mess. There's no formal structure for fully integration testing all adapters to ensure
+    proper quality and prevent regressions.
+
+    There's also a test order dependency as some tests run assuming a db connection and if that test randomly ran before a previous
+    one that makes the connection, it would fail.
+
+    I'm proposing the first thing to be done is to write up a standard, high livel integration test case that can be applied to all adapters
+    and makes no assumptions about implementation. It should ensure that each adapter conforms to the Apartment Interface and CRUD's properly.
+    It would be nice if a user can 'register' an adapter such that it would automatically be tested (nice to have). Otherwise one could just use
+    a shared behaviour to run through all of this.
+
+    Then, I'd like to see all of the implementation specific tests just in their own test file for each adapter (ie the postgresql schema adapter checks a lot of things with `schema_search_path`)
+
+    This should ensure that going forward nothing breaks, and we should *ideally* be able to randomize the test order
+
+2.  <del>`Apartment::Database` is the wrong abstraction. When dealing with a multi-tenanted system, users shouldn't thing about 'Databases', they should
+    think about Tenants. I proprose that we deprecate the `Apartment::Database` constant in favour of `Apartment::Tenant` for a nicer abstraction. See
+    http://myronmars.to/n/dev-blog/2011/09/deprecating-constants-and-classes-in-ruby for ideas on how to achieve this.</del>
+
+4.  Apartment::Database.process should be deprecated in favour of just passing a block to `switch`
+5.  Apartment::Database.switch should be renamed to switch! to indicate that using it on its own has side effects
+
+6.  Migrations right now can be a bit of a pain. Apartment currently migrates a single tenant completely up to date, then goes onto the next. If one of these
+    migrations fails on a tenant, the previous one does NOT get reverted and leaves you in an awkward state. Ideally we'd want to wrap all of the migrations in
+    a transaction so if one fails, the whole thing reverts. Once we can ensure an all-or-nothing approach to migrations, we can optimize the migration strategy
+    to not even iterate over the tenants if there are no migrations to run on public.
+
+7.  Apartment has be come one of the most popular/robust Multi-tenant gems for Rails, but it still doesn't work for everyone's use case. It's fairly limited in implementation to either schema based (ie postgresql schemas) or connection based. I'd like to abstract out these implementation details such that one could write a pluggable strategy for Apartment and choose it based on a config selection (something like `config.strategy = :schema`). The next implementation I'd like to see is a scoped based approach that uses a `tenant_id` scoping on all records for multi-tenancy. This is probably the most popular multi-tenant approach and is db independent and really the simplest mechanism for a type of multi-tenancy.
+
+8.  Right now excluded tables still live in all tenanted environments. This is basically because it doesn't matter if they're there, we always query from the public.
+    It's a bit of an annoyance though and confuses lots of people. I'd love to see only tenanted tables in the tenants and only excluded tables in the public tenant.
+    This will be hard because Rails uses public to generate schema.rb. One idea is to have an `excluded` schema that holds all the excluded models and the public can
+    maintain everything.
+
+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

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+$: << File.expand_path("../lib", __FILE__)
+require "apartment/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{ros-apartment}
+  s.version = Apartment::VERSION
+
+  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         = ["ryan@influitive.com", "brad@influitive.com"]
+  s.files         = `git ls-files`.split($/)
+  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 = %q{https://github.com/rails-on-services/apartment}
+  s.licenses = ["MIT"]
+
+  # must be >= 3.1.2 due to bug in prepared_statements
+  s.add_dependency 'activerecord',    '>= 3.1.2', '< 6.1'
+  s.add_dependency 'rack',            '>= 1.3.6'
+  s.add_dependency 'public_suffix',   '>= 2'
+  s.add_dependency 'parallel',        '>= 0.7.1'
+
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'rake',         '~> 0.9'
+  s.add_development_dependency 'rspec',        '~> 3.4'
+  s.add_development_dependency 'rspec-rails',  '~> 3.4'
+  s.add_development_dependency 'capybara',     '~> 2.0'
+  s.add_development_dependency 'bundler',      '>= 1.3', '< 2.0'
+
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbc-adapter'
+    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
+    s.add_development_dependency 'activerecord-jdbcmysql-adapter'
+    s.add_development_dependency 'jdbc-postgres'
+    s.add_development_dependency 'jdbc-mysql'
+    s.add_development_dependency 'jruby-openssl'
+  else
+    s.add_development_dependency 'mysql2'
+    s.add_development_dependency 'pg'
+    s.add_development_dependency 'sqlite3', '~> 1.3.6'
+  end
+end

data/docker-compose.yml

@@ -0,0 +1,33 @@
+version: '2.3'
+services:
+  postgresql:
+    image: postgres:9.5.12
+    environment:
+      POSTGRES_PASSWORD: ""
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: pg_isready -U postgres
+      start_period: 10s
+      interval: 10s
+      timeout: 30s
+      retries: 3
+  mysql:
+    image: mysql:5.7
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+    ports:
+      - "3306:3306"
+    healthcheck:
+      test: mysqladmin -h 127.0.0.1 -uroot ping
+      start_period: 15s
+      interval: 10s
+      timeout: 30s
+      retries: 3
+  healthcheck:
+    image: busybox
+    depends_on:
+      postgresql:
+        condition: service_healthy
+      mysql:
+        condition: service_healthy

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,23 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+group :local do
+  gem "pry"
+  gem "guard-rspec", "~> 4.2"
+end
+
+platforms :ruby do
+  gem "pg", "< 1.0.0"
+  gem "mysql2", "~> 0.4.0"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 1.3"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 1.3"
+  gem "activerecord-jdbcmysql-adapter", "~> 1.3"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+
+group :local do
+  gem "pry"
+  gem "guard-rspec", "~> 4.2"
+end
+
+platforms :ruby do
+  gem "pg", "< 1.0.0"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 50.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 50.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 50.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+
+group :local do
+  gem "pry"
+  gem "guard-rspec", "~> 4.2"
+end
+
+platforms :ruby do
+  gem "pg", "< 1.0.0"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 51.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 51.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 51.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+group :local do
+  gem "pry"
+  gem "guard-rspec", "~> 4.2"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 52.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 52.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 6.0.0.rc1"
+
+group :local do
+  gem "pry"
+  gem "guard-rspec", "~> 4.2"
+end
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.4"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 60.0.rc1"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 60.0.rc1"
+  gem "activerecord-jdbcmysql-adapter", "~> 60.0.rc1"
+end
+
+gemspec path: "../"

data/gemfiles/rails_master.gemfile

@@ -0,0 +1,22 @@
+# 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
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.4"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 52.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 52.0"
+end
+
+gemspec path: "../"

data/lib/apartment.rb

@@ -0,0 +1,118 @@
+require 'apartment/railtie' if defined?(Rails)
+require 'active_support/core_ext/object/blank'
+require 'forwardable'
+require 'active_record'
+require 'apartment/tenant'
+
+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]
+
+    attr_accessor(*ACCESSOR_METHODS)
+    attr_writer(*WRITER_METHODS)
+
+    def_delegators :connection_class, :connection, :connection_config, :establish_connection
+
+    # configure apartment with available options
+    def configure
+      yield self if block_given?
+    end
+
+    def tenant_names
+      extract_tenant_config.keys.map(&:to_s)
+    end
+
+    def tenants_with_config
+      extract_tenant_config
+    end
+
+    def db_config_for(tenant)
+      (tenants_with_config[tenant] || connection_config).with_indifferent_access
+    end
+
+    # Whether or not db:migrate should also migrate tenants
+    # defaults to true
+    def db_migrate_tenants
+      return @db_migrate_tenants if defined?(@db_migrate_tenants)
+
+      @db_migrate_tenants = true
+    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 || []
+    end
+
+    def connection_class
+      @connection_class || ActiveRecord::Base
+    end
+
+    def database_schema_file
+      return @database_schema_file if defined?(@database_schema_file)
+
+      @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"
+    end
+
+    def pg_excluded_names
+      @pg_excluded_names || []
+    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 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|
+          hash[tenant] = connection_config
+        end
+      end
+      values.with_indifferent_access
+    rescue ActiveRecord::StatementInvalid
+      {}
+    end
+  end
+
+  # Exceptions
+  ApartmentError = Class.new(StandardError)
+
+  # 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)
+
+  # The Tenant attempting to be created already exists
+  TenantExists = Class.new(ApartmentError)
+end