innkeeper 0.1.0

data/lib/innkeeper/resolvers/schema.rb

@@ -0,0 +1,14 @@
+require 'innkeeper/resolvers/abstract'
+
+module Innkeeper
+  module Resolvers
+    class Schema < Abstract
+      def resolve(tenant)
+        schemas = [tenant, Innkeeper.persistent_schemas].flatten
+        search_path = schemas.map(&:inspect).join(", ")
+
+        init_config.dup.tap{ |c| c[:schema_search_path] = search_path }
+      end
+    end
+  end
+end

data/lib/innkeeper/tasks/enhancements.rb

@@ -0,0 +1,36 @@
+# Require this file to append Innkeeper rake tasks to ActiveRecord db rake tasks
+# Enabled by default in the initializer
+
+module Innkeeper
+  class RakeTaskEnhancer
+    
+    TASKS = %w(db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo db:seed)
+    
+    # This is a bit convoluted, but helps solve problems when using Innkeeper within an engine
+    # See spec/integration/use_within_an_engine.rb
+    
+    class << self
+      def enhance!
+        TASKS.each do |name|
+          task = Rake::Task[name]
+          task.enhance do
+            if should_enhance?
+              enhance_task(task)
+            end
+          end
+        end
+      end
+    
+      def should_enhance?
+        Innkeeper.db_migrate_tenants
+      end
+    
+      def enhance_task(task)
+        Rake::Task[task.name.sub(/db:/, 'innkeeper:')].invoke
+      end
+    end
+    
+  end
+end
+
+Innkeeper::RakeTaskEnhancer.enhance!

data/lib/innkeeper/tenant.rb

@@ -0,0 +1,47 @@
+require 'forwardable'
+
+module Innkeeper
+  #   The main entry point to Innkeeper functions
+  #
+  module Tenant
+
+    extend self
+    extend Forwardable
+
+    def_delegators :adapter, :create, :drop, :drop_schema, :switch, :switch!,
+      :current, :each, :reset, :set_callback, :seed, :current_tenant,
+      :default_tenant, :config_for
+
+    #   Initialize Innkeeper config options such as excluded_models
+    #
+    def init
+      adapter.setup_connection_specification_name
+      adapter.process_excluded_models
+    end
+
+    #   Fetch the proper multi-tenant adapter based on Rails config
+    #
+    #   @return {subclass of Innkeeper::AbstractAdapter}
+    #
+    def adapter
+      Thread.current[:innkeeper_adapter] ||= begin
+        config = Innkeeper.default_tenant
+
+        adapter_name = "#{config[:adapter]}_adapter"
+
+        begin
+          require "innkeeper/adapters/#{adapter_name}"
+          adapter_class = Adapters.const_get(adapter_name.classify)
+        rescue LoadError, NameError
+          raise AdapterNotFound, "The adapter `#{adapter_name}` is not yet supported"
+        end
+
+        adapter_class.new
+      end
+    end
+
+    def reload!
+      Thread.current[:innkeeper_adapter] = nil
+    end
+  end
+end

data/lib/innkeeper/version.rb

@@ -0,0 +1,3 @@
+module Innkeeper
+  VERSION = "0.1.0"
+end

data/lib/tasks/innkeeper.rake

@@ -0,0 +1,128 @@
+require 'innkeeper/migrator'
+require 'parallel'
+
+innkeeper_namespace = namespace :innkeeper do
+
+  desc "Create all tenants"
+  task create: 'db:migrate' do
+    tenants.each do |tenant|
+      begin
+        quietly { Innkeeper::Tenant.create(tenant) }
+      rescue Innkeeper::TenantExists => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Migrate all tenants"
+  task :migrate do
+    warn_if_tenants_empty
+
+    each_tenant do |tenant|
+      begin
+        Innkeeper::Migrator.migrate tenant
+      rescue Innkeeper::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Seed all tenants"
+  task :seed do
+    warn_if_tenants_empty
+
+    each_tenant do |tenant|
+      begin
+        Innkeeper::Tenant.switch(tenant) do
+          Innkeeper::Tenant.seed
+        end
+      rescue Innkeeper::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants."
+  task :rollback do
+    warn_if_tenants_empty
+
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+
+    each_tenant do |tenant|
+      begin
+        Innkeeper::Migrator.rollback tenant, step
+      rescue Innkeeper::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  namespace :migrate do
+    desc 'Runs the "up" for a given migration VERSION across all tenants.'
+    task :up do
+      warn_if_tenants_empty
+
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      each_tenant do |tenant|
+        begin
+          Innkeeper::Migrator.run :up, tenant, version
+        rescue Innkeeper::TenantNotFound => e
+          puts e.message
+        end
+      end
+    end
+
+    desc 'Runs the "down" for a given migration VERSION across all tenants.'
+    task :down do
+      warn_if_tenants_empty
+
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      each_tenant do |tenant|
+        begin
+          Innkeeper::Migrator.run :down, tenant, version
+        rescue Innkeeper::TenantNotFound => e
+          puts e.message
+        end
+      end
+    end
+
+    desc  'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
+    task :redo do
+      if ENV['VERSION']
+        innkeeper_namespace['migrate:down'].invoke
+        innkeeper_namespace['migrate:up'].invoke
+      else
+        innkeeper_namespace['rollback'].invoke
+        innkeeper_namespace['migrate'].invoke
+      end
+    end
+  end
+
+  def each_tenant(&block)
+    Parallel.each(tenants, in_threads: Innkeeper.parallel_migration_threads) do |tenant|
+      block.call(tenant)
+    end
+  end
+
+  def tenants
+    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Innkeeper.tenant_names || []
+  end
+
+  def warn_if_tenants_empty
+    if tenants.empty?
+      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 `innkeeper:migrate` directly without loading the Rails environment
+            * `innkeeper: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/notes.md

@@ -0,0 +1,31 @@
+# Notes
+
+- API:
+
+    Innkeeper::Tenant.switch("blah") do ...
+      -> - pass "blah" into `config_for`
+         - `config_for` uses the configured resolver to return a config hash
+            (either database or schema by default)
+         - connect_to_new determines what's different in the config with the
+           current
+         - if a 'local' switch is possible (e.g. host is unchanged), do that,
+           otherwise reconnect
+    Innkeeper::Tenant.switch({ host: etc }) do ...
+      -> - pass straight through to connection_handler
+
+
+    Innkeeper.configure do |config|
+      config.tenants = proc{ Customer.map(&:subdomain) }
+      config.tenant_decorator = ->(tenant){ "#{Rails.env}_#{tenant}" }
+      config.tenant_resolver = Resolvers::Database
+    end
+
+## Todo
+
+- rewrite generator
+- finish config tests (tenant resolver specifically)
+- write multi-threading tests
+- remove deprecated silencers?
+- rewrite readme
+
+- what happens when host is switched in pg without a database specified?

data/test/config_test.rb

@@ -0,0 +1,52 @@
+require_relative 'test_helper'
+
+class ConfigTest < Minitest::Test
+  def teardown
+    Innkeeper.reset
+  end
+
+  def test_configure_yields_innkeeper
+    Innkeeper.configure{ |config| assert_equal Innkeeper, config }
+  end
+
+  def test_setting_excluded_models
+    Innkeeper.configure{ |c| c.excluded_models = ["Company"] }
+
+    assert_equal ["Company"], Innkeeper.excluded_models
+  end
+
+  def test_setting_force_reconnect_on_switch
+    Innkeeper.configure{ |c| c.force_reconnect_on_switch = true }
+
+    assert_equal true, Innkeeper.force_reconnect_on_switch
+  end
+
+  def test_setting_seed_data_file
+    Innkeeper.configure{ |c| c.seed_data_file = "#{Rails.root}/db/seeds/import.rb" }
+
+    assert_equal "#{Rails.root}/db/seeds/import.rb", Innkeeper.seed_data_file
+  end
+
+  def test_setting_seed_after_create
+    Innkeeper.configure{ |c| c.seed_after_create = true }
+
+    assert_equal true, Innkeeper.seed_after_create
+  end
+
+  def test_setting_tenant_names_to_array
+    Innkeeper.configure{ |c| c.tenant_names = ['tenant_a', 'tenant_b'] }
+
+    assert_equal ['tenant_a', 'tenant_b'], Innkeeper.tenant_names
+  end
+
+  def test_setting_tenant_names_to_proc
+    tenant_names = ["foo", "bar"]
+    tenant_names.each{ |db| Company.create!(database: db) }
+
+    Innkeeper.configure{ |c| c.tenant_names = ->{ Company.pluck(:database) } }
+
+    assert_equal tenant_names, Innkeeper.tenant_names
+  ensure
+    Company.delete_all
+  end
+end

data/test/databases.yml.sample

@@ -0,0 +1,37 @@
+<% if defined?(JRUBY_VERSION) %>
+connections:
+  postgresql:
+    adapter: postgresql
+    database: innkeeper_postgresql_test
+    username: postgres
+    min_messages: WARNING
+    driver: org.postgresql.Driver
+    url: jdbc:postgresql://localhost:5432/innkeeper_postgresql_test
+    timeout: 5000
+    pool: 5
+
+  mysql:
+    adapter: mysql
+    database: innkeeper_mysql_test
+    username: root
+    min_messages: WARNING
+    driver: com.mysql.jdbc.Driver
+    url: jdbc:mysql://localhost:3306/innkeeper_mysql_test
+    timeout: 5000
+    pool: 5
+<% else %>
+connections:
+  postgresql:
+    adapter: postgresql
+    database: innkeeper_postgresql_test
+    min_messages: WARNING
+    username: postgres
+    schema_search_path: public
+    password:
+
+  mysql:
+    adapter: mysql2
+    database: innkeeper_mysql_test
+    username: root
+    password:
+<% end %>

data/test/decorator_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/database'
+
+class DecoratorTest < Innkeeper::Test
+  def setup
+    setup_connection("mysql")
+
+    Innkeeper.configure do |config|
+      config.tenant_resolver = Innkeeper::Resolvers::Database
+      config.tenant_decorator = ->(tenant){ "#{Rails.env}_#{tenant}" }
+    end
+
+    super
+  end
+
+  def test_decorator_proc
+    decorated = Innkeeper::Tenant.adapter.decorate("foobar")
+
+    assert_equal "test_foobar", decorated
+  end
+end

data/test/domain_elevator_test.rb

@@ -0,0 +1,38 @@
+require_relative 'test_helper'
+require_relative 'mocks/adapter_mock'
+require 'innkeeper/elevators/domain'
+
+class DomainElevatorTest < Minitest::Test
+  include AdapterMock
+
+  def setup
+    @elevator = Innkeeper::Elevators::Domain.new(Proc.new{})
+
+    super
+  end
+
+  def test_parsing_host_for_domain_name
+    request = ActionDispatch::Request.new('HTTP_HOST' => 'example.com')
+    assert_equal 'example', @elevator.parse_tenant_name(request)
+  end
+
+  def test_www_prefix_and_domain_suffix_ignored
+    request = ActionDispatch::Request.new('HTTP_HOST' => 'www.example.bc.ca')
+    assert_equal 'example', @elevator.parse_tenant_name(request)
+  end
+
+  def test_no_host_returns_nil
+    request = ActionDispatch::Request.new('HTTP_HOST' => '')
+    assert_nil @elevator.parse_tenant_name(request)
+  end
+
+  def test_call_switches_tenant
+    with_adapter_mocked do |adapter|
+      adapter.expect :switch, true, ['example']
+
+      @elevator.call('HTTP_HOST' => 'www.example.com')
+
+      assert adapter.verify
+    end
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,6 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/company.rb

@@ -0,0 +1,3 @@
+class Company < ActiveRecord::Base
+  # Dummy models
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  # Dummy models
+end