penthouse 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a49b8e9cb0526dc97db28adae4d815d6e7159d0f
-  data.tar.gz: 2e4a8a76a90e3c4ef3cc61fd791cde94cd37b5b3
+  metadata.gz: 92248bef6760f1ed6455c27c851fce79e267b8e7
+  data.tar.gz: cc5a1f2bfdda094227a8449123dd8178a09305a0
 SHA512:
-  metadata.gz: fb84d69706713d17af8970d5f7c5b201cd9ff836543b164d3df2ed744e5014b295001b4926348ea15780c45abecb569093be4c4a47866f6834cbe2c7f381ae34
-  data.tar.gz: c9fe8a286abdf9f2fbd42d656a33c9bfecb17ca8eb467b9cdc2816fed0aa8cbd960b4269a4f414fbcc23f2c3f49d207f8efdd84c262caeaa3d73720b264acec6
+  metadata.gz: 41bcde8417c7e7c4ee517682c47230a91dcf72fa918b8834a7ad21032daf3c661ea5c38374c129a9cbdc7b5754faf65eaf85d783f72aceca938996fc20301e85
+  data.tar.gz: 2c1fe638a8a09aabce3a3c80813f4f4f4ed5106b794688f6b083b8c35413dd7e94d1387370feeeb7a2bc26acd777d592991e4804e056278d619cbe784c8d1278

data/README.md

@@ -30,7 +30,11 @@ Penthouse.configure do |config|
   # 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) }
+  config.tenants = Proc.new do
+    Account.each_with_object({}) do |account, result|
+      result.merge!(account.slug => account)
+    end
+  end
 end
 
 Rails.application.config.middleware.use Penthouse::App

data/lib/penthouse/configuration.rb

@@ -12,19 +12,21 @@
 
 module Penthouse
   class Configuration
-    attr_accessor :router, :runner, :migrate_tenants, :db_schema_file, :tenant_identifiers
+    attr_accessor :router, :runner, :migrate_tenants, :db_schema_file, :tenants
 
     # @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 db_schema_file [String] a path to your schema file (typically `db/schema.rb` or `db/structure.sql` in Rails)
-    # @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, db_schema_file: nil, tenant_identifiers: -> { raise NotImplementedError })
+    # @param db_schema_file [String] a path to your schema file
+    #   (typically `db/schema.rb` or `db/structure.sql` in Rails)
+    # @param tenants [Proc] some code which must return an hash of tenant identifiers (strings/symbols)
+    #   mapped to tenant objects, which can be anything your runner needs
+    def initialize(router: nil, runner: nil, migrate_tenants: false, db_schema_file: nil, tenants: -> { raise NotImplementedError })
       self.router = router
       self.runner = runner
       self.migrate_tenants = migrate_tenants
       self.db_schema_file = db_schema_file
-      self.tenant_identifiers = tenant_identifiers
+      self.tenants = tenants
 
       if migrate_tenants? && !db_schema_file
         raise ArgumentError, "If you want to migrate tenants, we need a path to a DB schema file"

data/lib/penthouse/migrator.rb

@@ -42,76 +42,56 @@ module Penthouse
 
     module ClassMethods
       def migrate_with_penthouse(migrations_paths, target_version = nil, &block)
-        puts "#migrate_with_penthouse called"
-
         unless Penthouse.configuration.migrate_tenants?
-          puts "Skipping penthouse integration"
           return migrate_without_penthouse(migrations_paths, target_version, &block)
         end
 
         Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do |tenant|
-          puts "Migrating #{tenant.identifier}"
-          puts "calling #migrate_without_penthouse"
           migrate_without_penthouse(migrations_paths, target_version, &block)
         end
       end
 
       def up_with_penthouse(migrations_paths, target_version = nil, &block)
-        puts "#up_with_penthouse called"
-
         unless Penthouse.configuration.migrate_tenants?
-          puts "Skipping penthouse integration"
           return up_without_penthouse(migrations_paths, target_version, &block)
         end
 
         Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do |tenant|
-          puts "Migrating #{tenant.identifier}"
-          puts "calling #up_without_penthouse"
           up_without_penthouse(migrations_paths, target_version, &block)
         end
       end
 
       def down_with_penthouse(migrations_paths, target_version = nil, &block)
-        puts "#down_with_penthouse called"
-
         unless Penthouse.configuration.migrate_tenants?
-          puts "Skipping penthouse integration"
           return down_without_penthouse(migrations_paths, target_version, &block)
         end
 
         Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do |tenant|
-          puts "Migrating #{tenant.identifier}"
-          puts "calling #down_without_penthouse"
           down_without_penthouse(migrations_paths, target_version, &block)
         end
       end
 
       def run_with_penthouse(direction, migrations_paths, target_version)
-        puts "#run_with_penthouse called"
-
         unless Penthouse.configuration.migrate_tenants?
-          puts "Skipping penthouse integration"
           return run_without_penthouse(direction, migrations_paths, target_version)
         end
 
         Penthouse.each_tenant(tenant_identifiers: tenants_to_migrate) do |tenant|
-          puts "Migrating #{tenant.identifier}"
-          puts "calling #run_without_penthouse"
           run_without_penthouse(direction, migrations_paths, target_version)
         end
       end
 
+      private
+
       def tenants_to_migrate
         return @tenants_to_migrate if defined?(@tenants_to_migrate)
         @tenants_to_migrate = begin
-          if (t = ENV["TENANT"] || ENV["TENANTS"])
+          if !!(t = (ENV["TENANT"] || ENV["TENANTS"]))
             t.split(",").map(&:strip)
           else
             Penthouse.tenant_identifiers
           end
         end
-        puts "#tenants_to_migrate = #{@tenants_to_migrate}"
-        @tenants_to_migrate
       end
     end
   end

data/lib/penthouse/tenants/octopus_schema_tenant.rb

@@ -20,7 +20,7 @@ module Penthouse
       # @param block [Block] The code to execute within the schema
       # @yield [SchemaTenant] The current tenant instance
       # @return [void]
-      def call(shard: :master, &block)
+      def call(shard: Octopus.master_shard, &block)
         Octopus.using(shard) do
           super(&block)
         end

data/lib/penthouse/tenants/octopus_shard_tenant.rb

@@ -18,7 +18,7 @@ module Penthouse
       # @param identifier [String, Symbol] An identifier for the tenant
       # @param shard [String, Symbol] the configured Octopus shard to use for this tenant
       # @param tenant_schema [String] your tenant's schema name within the Postgres shard, typically just 'public' as the shard should be dedicated
-      def initialize(identifer, shard:, tenant_schema: "public", **options)
+      def initialize(identifier, shard:, tenant_schema: "public", **options)
         self.shard = shard
         super(identifier, tenant_schema: tenant_schema, **options)
       end

data/lib/penthouse/version.rb

@@ -1,3 +1,3 @@
 module Penthouse
-  VERSION = "0.7.5"
+  VERSION = "0.8.0"
 end

data/lib/penthouse.rb

@@ -6,19 +6,20 @@ require "penthouse/runners/base_runner"
 
 module Penthouse
   class TenantNotFound < RuntimeError; end
+  CURRENT_TENANT_KEY = 'penthouse_tenant'.freeze
 
   class << self
     # Retrieves the currently active tenant identifier
     # @return [String, Symbol] the current tenant name
     def tenant
-      Thread.current[:tenant]
+      Thread.current[CURRENT_TENANT_KEY]
     end
 
     # Sets the currently active tenant identifier
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @return [void]
     def tenant=(tenant_identifier)
-      Thread.current[:tenant] = tenant_identifier
+      Thread.current[CURRENT_TENANT_KEY] = tenant_identifier
     end
 
     # Similar to Penthouse.tenant=, except this will switch back after the given
@@ -28,7 +29,7 @@ module Penthouse
     # @param block [Block] the code to execute
     # @yield [String, Symbol] the identifier for the tenant
     # @return [void]
-    def with_tenant(tenant_identifier, default_tenant: tenant, &block)
+    def with_tenant(tenant_identifier, default_tenant: self.tenant, &block)
       self.tenant = tenant_identifier
       block.yield(tenant_identifier)
     ensure
@@ -42,8 +43,8 @@ module Penthouse
     # @param block [Block] the code to execute
     # @yield [String, Symbol] the identifier for the tenant
     # @return [void]
-    def each_tenant(tenant_identifiers: nil, default_tenant: tenant, runner: configuration.runner, &block)
-      (tenant_identifiers || self.tenant_identifiers).each do |tenant_identifier|
+    def each_tenant(tenant_identifiers: self.tenant_identifiers, default_tenant: self.tenant, runner: self.configuration.runner, &block)
+      tenant_identifiers.each do |tenant_identifier|
         switch(tenant_identifier, runner: runner, &block)
       end
     end
@@ -54,7 +55,7 @@ module Penthouse
     # @param block [Block] the code to execute
     # @yield [Penthouse::Tenants::BaseTenant] the tenant instance
     # @return [void]
-    def switch(tenant_identifier, runner: configuration.runner, &block)
+    def switch(tenant_identifier, runner: self.configuration.runner, &block)
       runner.call(tenant_identifier, &block)
     end
 
@@ -62,7 +63,7 @@ module Penthouse
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @see Penthouse::Tenants::BaseTenant#delete
     # @return [void]
-    def create(tenant_identifier, runner: configuration.runner, **options)
+    def create(tenant_identifier, runner: self.configuration.runner, **options)
       switch(tenant_identifier, runner: runner) do |tenant|
         tenant.create(**options)
       end
@@ -72,7 +73,7 @@ module Penthouse
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @see Penthouse::Tenants::BaseTenant#delete
     # @return [void]
-    def delete(tenant_identifier, runner: configuration.runner, **options)
+    def delete(tenant_identifier, runner: self.configuration.runner, **options)
       switch(tenant_identifier, runner: runner) do |tenant|
         tenant.delete(**options)
       end
@@ -97,10 +98,16 @@ module Penthouse
       )
     end
 
+    # Returns a hash of tenant identifiers based on the configured setting
+    # @return [Hash<String, Symbol => Object>] the hash of tenants
+    def tenants
+      configuration.tenants.call
+    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
+      tenants.keys
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: penthouse
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryan Townsend