penthouse 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89e508c4ecb8d4e9aaebf054202f87e0ef171578
-  data.tar.gz: d89449c14673b9a0764c82a4711018dc8db85fce
+  metadata.gz: 190533a0da2c8d16b425d2ffa4bde288e19a97da
+  data.tar.gz: 69a6e1b680e9525c513e386d427de26f5b6667fd
 SHA512:
-  metadata.gz: 3c6cebc9a8e4d0d12331d4d801cbe87866c998c52695c17d5400b8102217f98c117b89bd52dff1eb23be7f09ef8e23827e38f56af4051f28904680d8500e3be0
-  data.tar.gz: 09bacbedcbbe99b6af2165e6501661267a0e6b7735a3234f9ef3c8c00b92385749c2b2ba9971dbe5a0e7a0c2460f46e4890c3352ff22f8fce0a743d6d9e59ee0
+  metadata.gz: 46a2dce89a0a2577808f9bc325766a010b19f58f0fa566c414a9aaa5ba16352e08ae84f25ad0b5d8b55f689b2119ed15156654fa22203527ab5c0f58e2da130f
+  data.tar.gz: 0a502681b521e29b05fbdb96b78b5b86821ea35924a05693557566b95ae127ede976bd866efa8e2c7df977b47ff99823aca7720a9de0eaf915c256eb92d6fb6e

data/.gitignore

@@ -8,4 +8,5 @@
 /pkg/
 /spec/reports/
 /spec/support/database.yml
+/spec/support/octopus.yml
 /tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -1,3 +1,5 @@
+[ ![Codeship Status](https://codeship.com/projects/c6513ab0-cc05-0133-94c6-0666c337ff82/status?branch=master)](https://codeship.com/projects/140114) [![Code Climate](https://codeclimate.com/github/ryantownsend/penthouse/badges/gpa.svg)](https://codeclimate.com/github/ryantownsend/penthouse)
+
 Penthouse is an alternative to the excellent [Apartment gem](https://github.com/influitive/apartment) – however Penthouse is more of a framework for multi-tenancy than a library, in that it provides less out-of-the-box functionality, but should make for easier customisation.
 
 ## Installation
@@ -8,7 +10,7 @@ Add this line to your application's Gemfile:
 gem 'penthouse'
 ```
 
-## Usage
+## Basic Usage
 
 If you're using Rails, you just need to configure an initializer at `config/initializers/penthouse.rb`
 
@@ -25,6 +27,10 @@ require 'penthouse/runners/schema_runner'
 Penthouse.configure do |config|
   config.router = Penthouse::Routers::SubdomainRouter
   config.runner = Penthouse::Runners::SchemaRunner
+  # enhance migrations to migrate all tenants
+  config.migrate_tenants = true
+  # setup a proc which will return the tenants
+  config.tenant_identifiers = Proc.new { Account.pluck(:tenant_name) }
 end
 
 Rails.application.config.middleware.use Penthouse::App
@@ -32,6 +38,18 @@ Rails.application.config.middleware.use Penthouse::App
 
 It's advised that if you want to customise these classes, you do so by sub-classing `Penthouse::App`, `Penthouse::Routers::BaseRouter` and/or `Penthouse::Runners::BaseRunner` within this initializer.
 
+## Octopus (shard) Usage
+
+If you want to have multiple databases on isolated hardware, you'll need to use the Octopus tenant types. In addition to the above initializer you'll need to configure Octopus:
+
+```ruby
+require 'octopus'
+
+Octopus.setup do |config|
+  config.environments = [Rails.env]
+end
+```
+
 ## Dictionary
 
 * **Router** – this class receives a Rack request object and returns an identifier (just a string or symbol) for the tenant.

data/lib/penthouse.rb

@@ -32,6 +32,17 @@ module Penthouse
       self.tenant = default_tenant
     end
 
+    # Wraps Penthouse.switch and simply executes the block of code for each
+    # tenant within Penthouse.tenant_identifiers
+    # @param default_tenant [String, Symbol] the identifier for the tenant to return to
+    # @param block [Block] the code to execute
+    # @yield [String, Symbol] the identifier for the tenant
+    def each_tenant(default_tenant: tenant, runner: configuration.runner, &block)
+      tenant_identifiers.each do |tenant_identifier|
+        switch(tenant_identifier, runner: runner, &block)
+      end
+    end
+
     # Executes the given block of code within a given tenant
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @param runner [Penthouse::Runners::BaseRunner] an optional runner to use, defaults to the one configured
@@ -57,5 +68,11 @@ module Penthouse
         runner: Runners::BaseRunner
       )
     end
+
+    # Returns a array of tenant identifiers based on the configured setting
+    # @return [Array<String, Symbol>] the list of tenant identifiers
+    def tenant_identifiers
+      configuration.tenant_identifiers.call
+    end
   end
 end

data/lib/penthouse/configuration.rb

@@ -6,16 +6,28 @@
 #   Penthouse.configure do |config|
 #     config.router = Penthouse::Routers::BaseRouter
 #     config.runner = Penthouse::Runners::BaseRunner
+#     config
 #   end
 #
 
 module Penthouse
   class Configuration
-    attr_accessor :router, :runner
+    attr_accessor :router, :runner, :migrate_tenants, :tenant_identifiers
 
-    def initialize(router: nil, runner: nil)
+    # @param router [Penthouse::Routers::BaseRouter] the default router for your application to use
+    # @param runner [Penthouse::Runners::BaseRunner] the default runner for your application to use
+    # @param migrate_tenants [Boolean] whether you want Penthouse to automatically migrate all tenants
+    # @param tenant_identifiers [Proc] some code which must return an array of tenant identifiers (strings/symbols)
+    def initialize(router: nil, runner: nil, migrate_tenants: false, tenant_identifiers: -> { raise NotImplementedError })
       self.router = router
       self.runner = runner
+      self.migrate_tenants = migrate_tenants
+      self.tenant_identifiers = tenant_identifiers
+    end
+
+    # @return [Boolean] whether or not Penthouse should automatically migrate all tenants
+    def migrate_tenants?
+      !!migrate_tenants
     end
   end
 end

data/lib/penthouse/migrator.rb

@@ -0,0 +1,39 @@
+# shamelessly copied & adjusted from Apartment
+# @see https://github.com/influitive/apartment/blob/development/lib/apartment/migrator.rb
+
+module Penthouse
+  module Migrator
+
+    extend self
+
+    # Migrate to latest version
+    # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
+    def migrate(tenant_identifier)
+      Penthouse.switch(tenant_identifier) do
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+
+        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version) do |migration|
+          ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope)
+        end
+      end
+    end
+
+    # Migrate up/down to a specific version
+    # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
+    # @param version [Integer] the version number to migrate up or down to
+    def run(direction, tenant_identifier, version)
+      Penthouse.switch(tenant_identifier) do
+        ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
+      end
+    end
+
+    # rollback latest migration `step` number of times
+    # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
+    # @param step [Integer] how many migrations to rollback by
+    def rollback(tenant_identifier, step = 1)
+      Penthouse.switch(tenant_identifier) do
+        ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
+      end
+    end
+  end
+end

data/lib/penthouse/tasks/enhancements.rb

@@ -0,0 +1,35 @@
+# Require this file to append Penthouse rake tasks to ActiveRecord db rake tasks
+# Enabled by default in the initializer
+
+# shamelessly copied & adjusted from Apartment
+# @see https://github.com/influitive/apartment/blob/development/lib/apartment/tasks/enhancements.rb
+
+module Penthouse
+  class RakeTaskEnhancer
+    TASKS = %w(db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo db:seed)
+
+    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?
+        Penthouse.configuration.migrate_tenants?
+      end
+
+      def enhance_task(task)
+        Rake::Task[task.name.sub(/db:/, 'penthouse:')].invoke
+      end
+    end
+
+  end
+end
+
+Penthouse::RakeTaskEnhancer.enhance!

data/lib/penthouse/version.rb

@@ -1,3 +1,3 @@
 module Penthouse
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tasks/penthouse.rake

@@ -0,0 +1,94 @@
+require 'penthouse/migrator'
+
+penthouse_namespace = namespace :penthouse do
+
+  desc "Migrate all tenants to latest version"
+  task :migrate do
+    warn_if_tenants_empty
+
+    tenant_identifiers.each do |tenant_identifier|
+      begin
+        puts("Migrating #{tenant_identifier} tenant")
+        Penthouse::Migrator.migrate(tenant_identifier)
+      rescue Penthouse::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
+
+    tenant_identifiers.each do |tenant_identifier|
+      begin
+        puts("Rolling back #{tenant_identifier} tenant")
+        Penthouse::Migrator.rollback(tenant_identifier, step)
+      rescue Penthouse::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
+
+      tenant_identifiers.each do |tenant_identifier|
+        begin
+          puts("Migrating #{tenant_identifier} tenant up")
+          Penthouse::Migrator.run(:up, tenant_identifier, version)
+        rescue Penthouse::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
+
+      tenant_identifiers.each do |tenant_identifier|
+        begin
+          puts("Migrating #{tenant_identifier} tenant down")
+          Penthouse::Migrator.run(:down, tenant_identifier, version)
+        rescue Penthouse::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']
+        penthouse_namespace['migrate:down'].invoke
+        penthouse_namespace['migrate:up'].invoke
+      else
+        penthouse_namespace['rollback'].invoke
+        penthouse_namespace['migrate'].invoke
+      end
+    end
+  end
+
+  def tenant_identifiers
+    Penthouse.tenant_identifiers
+  end
+
+  def warn_if_tenants_empty
+    if tenant_identifiers.empty?
+      puts <<-WARNING
+        [WARNING] - The list of tenants to migrate appears to be empty. This could mean you've not created any.
+        Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
+      WARNING
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: penthouse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Townsend
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
@@ -168,6 +169,7 @@ files:
 - lib/penthouse.rb
 - lib/penthouse/app.rb
 - lib/penthouse/configuration.rb
+- lib/penthouse/migrator.rb
 - lib/penthouse/routers/base_router.rb
 - lib/penthouse/routers/subdomain_router.rb
 - lib/penthouse/runners/base_runner.rb
@@ -176,11 +178,13 @@ files:
 - lib/penthouse/sidekiq/middleware/client.rb
 - lib/penthouse/sidekiq/middleware/server.rb
 - lib/penthouse/sidekiq/railtie.rb
+- lib/penthouse/tasks/enhancements.rb
 - lib/penthouse/tenants/base_tenant.rb
 - lib/penthouse/tenants/octopus_schema_tenant.rb
 - lib/penthouse/tenants/octopus_shard_tenant.rb
 - lib/penthouse/tenants/schema_tenant.rb
 - lib/penthouse/version.rb
+- lib/tasks/penthouse.rake
 - penthouse.gemspec
 homepage: https://github.com/ryantownsend/penthouse
 licenses: []