penthouse 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0632eea067e1cf85d45c912212bfa613d7c34566
-  data.tar.gz: 60a49d25ab6339cb567a4815b53df28fc6b30127
+  metadata.gz: 5c2f7032744a162f8d7841fb997536f71ed30c74
+  data.tar.gz: 74dc6c8881eaa3b869f0ad078217632a8037bed6
 SHA512:
-  metadata.gz: 6e60e2fe6d903e61317ed5e4930d793dded2bbdb93c7762516a477ec18a9de783dfb1690cf22952ffab141acae16b54357a616a51754e79d117b36d75a268c80
-  data.tar.gz: 7d53645c0a228a3cd62c6854e7ede31d3a56b40e5d12f04d18758358c9e38fcec3a7716a2e6637f9ba6908c8f93220e02f4a2077a6f030e901d2ca98bec7abde
+  metadata.gz: 776a192ee3c89480cd2fe9124aa65bba125d3d97c716dffcd0300b462d42cf400cc5f014836007608f8fa8ec0f7b32daf2aabba84d67ffb1e2250ce705f83bfd
+  data.tar.gz: 8e2ce6d50bdb1cac77fdec1bd97a9135344fd98d3a83acedc5148a0bd9f8ce8f8dae19f8a2784bb77420849f39914781cc8863fcc91b9624edf178c80e9eae26

data/lib/penthouse/migrator.rb

@@ -1,56 +1,120 @@
-# shamelessly copied & adjusted from Apartment
-# @see https://github.com/influitive/apartment/blob/master/lib/apartment/migrator.rb
-# overrides Octopus's auto-switching to shards
-# @see https://github.com/thiagopradi/octopus/blob/master/lib/octopus/migration.rb
+require 'active_record'
+require 'set'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/array/wrap'
 
 module Penthouse
-  module Migrator
+  module Migration
+    def self.included(base)
+      base.alias_method_chain :announce, :penthouse
+    end
+
+    def announce_with_penthouse(message)
+      announce_without_penthouse("#{message} - #{current_tenant}")
+    end
 
-    extend self
+    def current_tenant
+      "Tenant: #{Penthouse.tenant || '*** global ***'}"
+    end
+  end
+end
 
-    # Migrate to latest version
-    # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
-    # @return [void]
-    def migrate(tenant_identifier, version)
-      Penthouse.switch(tenant_identifier) do
-        if migrator.respond_to?(:migrate_without_octopus)
-          migrator.migrate_without_octopus(migrator.migrations_paths, version)
-        else
-          migrator.migrate(migrator.migrations_paths, version)
+module Penthouse
+  module Migrator
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.class_eval do
+        class << self
+          alias_method_chain :migrate, :penthouse
+          alias_method_chain :up,      :penthouse
+          alias_method_chain :down,    :penthouse
+          alias_method_chain :run,     :penthouse
         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
-    # @return [void]
-    def run(direction, tenant_identifier, version)
-      Penthouse.switch(tenant_identifier) do
-        if migrator.respond_to?(:run_without_octopus)
-          migrator.run_without_octopus(direction, migrator.migrations_paths, version)
-        else
-          migrator.run(direction, migrator.migrations_paths, version)
+    module ClassMethods
+      def migrate_with_penthouse(migrations_paths, target_version = nil, &block)
+        unless Penthouse.configuration.migrate_tenants?
+          if defined?(:migrate_without_octopus)
+            return migrate_without_octopus(migrations_paths, target_version, &block)
+          else
+            return migrate_without_penthouse(migrations_paths, target_version, &block)
+          end
+        end
+
+        Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do
+          if defined?(:migrate_without_octopus)
+            migrate_without_octopus(migrations_paths, target_version, &block)
+          else
+            migrate_without_penthouse(migrations_paths, target_version, &block)
+          end
         end
       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
-    # @return [void]
-    def rollback(tenant_identifier, step = 1)
-      Penthouse.switch(tenant_identifier) do
-        if migrator.respond_to?(:rollback_without_octopus)
-          migrator.rollback_without_octopus(migrator.migrations_paths, step)
-        else
-          migrator.rollback(migrator.migrations_paths, step)
+      def up_with_penthouse(migrations_paths, target_version = nil, &block)
+        unless Penthouse.configuration.migrate_tenants?
+          if defined?(:up_without_octopus)
+            return up_without_octopus(migrations_paths, target_version, &block)
+          else
+            return up_without_penthouse(migrations_paths, target_version, &block)
+          end
+        end
+
+        Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do
+          if defined?(:up_without_octopus)
+            up_without_octopus(migrations_paths, target_version, &block)
+          else
+            up_without_penthouse(migrations_paths, target_version, &block)
+          end
+        end
+      end
+
+      def down_with_penthouse(migrations_paths, target_version = nil, &block)
+        unless Penthouse.configuration.migrate_tenants?
+          if defined?(:down_without_octopus)
+            return down_without_octopus(migrations_paths, target_version, &block)
+          else
+            return down_without_penthouse(migrations_paths, target_version, &block)
+          end
+        end
+
+        Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do
+          if defined?(:down_without_octopus)
+            down_without_octopus(migrations_paths, target_version, &block)
+          else
+            down_without_penthouse(migrations_paths, target_version, &block)
+          end
+        end
+      end
+
+      def run_with_penthouse(direction, migrations_paths, target_version)
+        unless Penthouse.configuration.migrate_tenants?
+          if defined?(:run_without_octopus)
+            return run_without_octopus(direction, migrations_paths, target_version)
+          else
+            return run_without_penthouse(direction, migrations_paths, target_version)
+          end
+        end
+
+        Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do
+          if defined?(:run_without_octopus)
+            run_without_octopus(direction, migrations_paths, target_version)
+          else
+            run_without_penthouse(direction, migrations_paths, target_version)
+          end
         end
       end
-    end
 
-    def migrator
-      ActiveRecord::Migrator
+      def tenants_to_migrate
+        if (t = ENV["tenant"] || ENV["tenants"])
+          t.split(",").map(&:strip)
+        end
+      end
     end
   end
 end
+
+ActiveRecord::Migration.send(:include, Penthouse::Migration)
+ActiveRecord::Migrator.send(:include, Penthouse::Migrator)

data/lib/penthouse/tenants/schema_tenant.rb

@@ -7,6 +7,7 @@
 
 require_relative './base_tenant'
 require_relative './migratable'
+require 'active_record'
 
 module Penthouse
   module Tenants

data/lib/penthouse/version.rb

@@ -1,3 +1,3 @@
 module Penthouse
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/penthouse.rb

@@ -1,4 +1,4 @@
-require "penthouse/railtie" if defined?(Rails)
+require "penthouse/migrator"
 require "penthouse/version"
 require "penthouse/configuration"
 require "penthouse/routers/base_router"
@@ -37,12 +37,13 @@ module Penthouse
 
     # Wraps Penthouse.switch and simply executes the block of code for each
     # tenant within Penthouse.tenant_identifiers
+    # @param tenant_identifiers [Array<String, Symbol>, nil] the array of tenants to loop through
     # @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
     # @return [void]
-    def each_tenant(default_tenant: tenant, runner: configuration.runner, &block)
-      tenant_identifiers.each do |tenant_identifier|
+    def each_tenant(tenant_identifiers: nil, default_tenant: tenant, runner: configuration.runner, &block)
+      (tenant_identifiers || self.tenant_identifiers).each do |tenant_identifier|
         switch(tenant_identifier, runner: runner, &block)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: penthouse
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ryan Townsend
@@ -170,7 +170,6 @@ files:
 - lib/penthouse/app.rb
 - lib/penthouse/configuration.rb
 - lib/penthouse/migrator.rb
-- lib/penthouse/railtie.rb
 - lib/penthouse/routers/base_router.rb
 - lib/penthouse/routers/subdomain_router.rb
 - lib/penthouse/runners/base_runner.rb
@@ -186,7 +185,6 @@ files:
 - 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: []

data/lib/penthouse/railtie.rb

@@ -1,11 +0,0 @@
-require 'rails'
-
-module Penthouse
-  class Railtie < Rails::Railtie
-    # Ensure rake tasks are loaded
-    rake_tasks do
-      load 'tasks/penthouse.rake'
-      require 'penthouse/tasks/enhancements'
-    end
-  end
-end

data/lib/tasks/penthouse.rake

@@ -1,96 +0,0 @@
-require 'penthouse/migrator'
-
-penthouse_namespace = namespace :penthouse do
-
-  desc "Migrate all tenants to latest version"
-  task :migrate do
-    warn_if_tenants_empty
-
-    version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
-
-    tenant_identifiers.each do |tenant_identifier|
-      begin
-        puts("Migrating #{tenant_identifier || '***global***'} tenant")
-        Penthouse::Migrator.migrate(tenant_identifier, version)
-      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 || '***global***'} 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 || '***global***'} 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 || '***global***'} 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