penthouse 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1b6d19ee617c554c080a828dbce840a3431879a
-  data.tar.gz: b4c6b6ae7398e7b0bb78e5b17539865a3479e1ee
+  metadata.gz: 9901a76e3311f855d6ee6ca8d654c71f85e83ed8
+  data.tar.gz: 48832ed750877f9368e9d27541bf4b93cabb21c5
 SHA512:
-  metadata.gz: 51ef4839e0ffcfcc637b82732e167f49e90e96e077d319d55ed483247ae2176e284770c6a05a4a214704adea35f41d004929cecff799e9431869fc3a4a6fa5fb
-  data.tar.gz: 8cef1801324324d687794256e80f5622505f0f8ce74715a5508c923b546519fc80895f1f746b69e7a71be1384a769d37d969f595871787cdc3a731157c39c9a3
+  metadata.gz: eeabfea803c0467bc39ec9a629c650b2a2d25061e8effa341a7efb1e90ec8632c0da07c8788ec6fff5a726a35adf2ff06c4c9935c8588514987a818fcc0e519a
+  data.tar.gz: a35faf59909bd4e05ecf4e772ccddaa31fe10519968e38d2508d1ed7e62893e6fd6556dc0d71d33a215c8079eb4760c688aba2864dc519a9197f41536715e2a5

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec", failed_mode: :focus do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -18,10 +18,6 @@ If you're using Rails, you just need to configure an initializer at `config/init
 require 'penthouse'
 # include the standard Rack app
 require 'penthouse/app'
-# include the automated Sidekiq integration, should you need it
-require 'penthouse/sidekiq' if defined?(Sidekiq)
-# include the automated ActiveJob integration, should you need it
-require 'penthouse/active_job' if defined?(ActiveJob)
 # require the relevant router/runner you wish to use
 require 'penthouse/routers/subdomain_router'
 require 'penthouse/runners/schema_runner'
@@ -56,6 +52,26 @@ Octopus.setup do |config|
 end
 ```
 
+## ActiveJob
+
+If you are using ActiveJob, you'll need to create an `active_job.rb` initializer:
+
+```ruby
+require 'penthouse/active_job'
+
+class ActiveJob::Base
+  include Penthouse::ActiveJob
+end
+```
+
+## Sidekiq
+
+If you are using Sidekiq, you simply need to include the Penthouse module, this can be done in the `penthouse.rb` initializer:
+
+```ruby
+require 'penthouse/sidekiq'
+```
+
 ## Dictionary
 
 * **Router** – this class receives a Rack request object and returns an identifier (just a string or symbol) for the tenant.

data/lib/penthouse/app.rb

@@ -30,7 +30,7 @@ module Penthouse
     # @return [void]
     def call(env)
       request = Rack::Request.new(env)
-      runner.call(router.call(request)) do
+      runner.call(tenant_identifier: router.call(request)) do
         app.call(env)
       end
     end

data/lib/penthouse/runners/base_runner.rb

@@ -11,25 +11,44 @@ module Penthouse
   module Runners
     class BaseRunner
 
+      PENTHOUSE_RUNNER_CALL_STACK = :current_penthouse_runner_call_stack
+
       # @param tenant_identifier [String, Symbol] The identifier for the tenant
       # @param block [Block] The code to execute within the tenant
       # @return [void]
       # @raise [Penthouse::TenantNotFound] if the tenant cannot be switched to
-      def self.call(tenant_identifier, &block)
-        load_tenant(tenant_identifier).call do |tenant|
-          Penthouse.with_tenant(tenant.identifier) do
-            block.yield(tenant)
+      def call(tenant_identifier:, &block)
+        previous_tenant_identifier = call_stack.last || 'public'
+        call_stack.push(tenant_identifier)
+
+        result = nil
+
+        begin
+          load_tenant(tenant_identifier: tenant_identifier, previous_tenant_identifier: previous_tenant_identifier).call do |tenant|
+            Penthouse.with_tenant(tenant_identifier: tenant.identifier) do
+              result = block.yield(tenant)
+            end
           end
+        ensure
+          call_stack.pop
         end
+        result
       end
 
       # @abstract returns the tenant object
       # @param tenant_identifier [String, Symbol] The identifier for the tenant
       # @return [Penthouse::Tenants::BaseTenant] An instance of a tenant
       # @raise [Penthouse::TenantNotFound] if the tenant cannot be switched to
-      def self.load_tenant(tenant_identifier)
+      def load_tenant(tenant_identifier:, previous_tenant_identifier: 'public')
         raise NotImplementedError
       end
+      
+      private
+      
+      def call_stack
+        Thread.current[PENTHOUSE_RUNNER_CALL_STACK] ||= []
+      end
+      
     end
   end
 end

data/lib/penthouse/runners/schema_runner.rb

@@ -11,8 +11,8 @@ module Penthouse
 
       # @param tenant_identifier [String, Symbol] The identifier for the tenant
       # @return [Penthouse::Tenants::BaseTenant] An instance of a tenant
-      def self.load_tenant(tenant_identifier)
-        Tenants::SchemaTenant.new(tenant_identifier, tenant_schema: tenant_identifier)
+      def load_tenant(tenant_identifier:, previous_tenant_identifier: 'public')
+        Tenants::SchemaTenant.new(identifier: tenant_identifier, tenant_schema: tenant_identifier, previous_schema: previous_tenant_identifier)
       end
 
     end

data/lib/penthouse/sidekiq/middleware/server.rb

@@ -3,7 +3,7 @@ module Penthouse
     module Middleware
       class Server
         def call(worker_class, item, queue)
-          Penthouse.switch(item['tenant']) do
+          Penthouse.switch(tenant_identifier: item['tenant']) do
             yield
           end
         end

data/lib/penthouse/tenants/base_tenant.rb

@@ -14,7 +14,7 @@ module Penthouse
       private :identifier=
 
       # @param identifier [String, Symbol] An identifier for the tenant
-      def initialize(identifier)
+      def initialize(identifier:, **args)
         self.identifier = identifier
       end
 

data/lib/penthouse/tenants/octopus_schema_tenant.rb

@@ -29,21 +29,21 @@ module Penthouse
       # creates the tenant schema within the master shard
       # @see Penthouse::Tenants::SchemaTenant#create
       # @return [void]
-      def create(*)
+      def create(**)
         call { super }
       end
 
       # drops the tenant schema within the master shard
       # @see Penthouse::Tenants::SchemaTenant#delete
       # @return [void]
-      def delete(*)
+      def delete(**)
         call { super }
       end
 
       # returns whether or not the schema exists
       # @see Penthouse::Tenants::SchemaTenant#exists?
       # @return [Boolean] whether or not the schema exists in the master shard
-      def exists?(*)
+      def exists?(**)
         call { super }
       end
     end

data/lib/penthouse/tenants/octopus_shard_tenant.rb

@@ -18,9 +18,9 @@ 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(identifier, shard:, tenant_schema: "public", **options)
+      def initialize(identifier:, shard:, tenant_schema: "public", **options)
         self.shard = shard
-        super(identifier, tenant_schema: tenant_schema, **options)
+        super(identifier: identifier, tenant_schema: tenant_schema, **options)
       end
 
       # switches to the relevant Octopus shard, and processes the block

data/lib/penthouse/tenants/schema_tenant.rb

@@ -14,18 +14,20 @@ module Penthouse
     class SchemaTenant < BaseTenant
       include Migratable
 
-      attr_accessor :tenant_schema, :persistent_schemas, :default_schema
+      attr_accessor :tenant_schema, :persistent_schemas, :default_schema, :previous_schema
       private :tenant_schema=, :persistent_schemas=, :default_schema=
 
       # @param identifier [String, Symbol] An identifier for the tenant
       # @param tenant_schema [String] your tenant's schema name in Postgres
       # @param persistent_schemas [Array<String>] The schemas you always want in the search path
       # @param default_schema [String] The global schema name, usually 'public'
-      def initialize(identifier, tenant_schema:, persistent_schemas: ["shared_extensions"], default_schema: "public")
-        super(identifier)
+      # @param previous_schema [String] The previous schema name, usually 'public' unless dealing with nested calls.
+      def initialize(identifier:, tenant_schema:, persistent_schemas: ["shared_extensions"], default_schema: "public", previous_schema: default_schema)
+        super
         self.tenant_schema = tenant_schema.freeze
         self.persistent_schemas = Array(persistent_schemas).flatten.freeze
         self.default_schema = default_schema.freeze
+        self.previous_schema = previous_schema.freeze
         freeze
       end
 
@@ -41,7 +43,7 @@ module Penthouse
           block.yield(self)
         ensure
           # reset the search path back to the default
-          ActiveRecord::Base.connection.schema_search_path = persistent_schemas.dup.unshift(default_schema).join(", ")
+          ActiveRecord::Base.connection.schema_search_path = persistent_schemas.dup.unshift(previous_schema).join(", ")
         end
       end
 
@@ -67,7 +69,7 @@ module Penthouse
 
       # returns whether or not this tenant's schema exists
       # @return [Boolean] whether or not the tenant exists
-      def exists?
+      def exists?(**)
         sql = ActiveRecord::Base.send(:sanitize_sql_array, ["select 1 from pg_namespace where nspname = '%s'", tenant_schema])
         result = ActiveRecord::Base.connection.exec_query(sql, "Schema Exists")
         !result.rows.empty?

data/lib/penthouse/version.rb

@@ -1,3 +1,3 @@
 module Penthouse
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/lib/penthouse.rb

@@ -29,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: self.tenant, &block)
+    def with_tenant(tenant_identifier:, default_tenant: self.tenant, &block)
       self.tenant = tenant_identifier
       block.yield(tenant_identifier)
     ensure
@@ -45,7 +45,7 @@ module Penthouse
     # @return [void]
     def each_tenant(tenant_identifiers: self.tenant_identifiers, runner: self.configuration.runner, &block)
       tenant_identifiers.each do |tenant_identifier|
-        switch(tenant_identifier, runner: runner, &block)
+        switch(tenant_identifier: tenant_identifier, runner: runner, &block)
       end
     end
 
@@ -55,16 +55,16 @@ module Penthouse
     # @param block [Block] the code to execute
     # @yield [Penthouse::Tenants::BaseTenant] the tenant instance
     # @return [void]
-    def switch(tenant_identifier, runner: self.configuration.runner, &block)
-      runner.call(tenant_identifier, &block)
+    def switch(tenant_identifier:, runner: self.configuration.runner, &block)
+      runner.call(tenant_identifier: tenant_identifier, &block)
     end
 
     # Loads the tenant and creates their data store
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @see Penthouse::Tenants::BaseTenant#delete
     # @return [void]
-    def create(tenant_identifier, runner: self.configuration.runner, **options)
-      switch(tenant_identifier, runner: runner) do |tenant|
+    def create(tenant_identifier:, runner: self.configuration.runner, **options)
+      switch(tenant_identifier: tenant_identifier, runner: runner) do |tenant|
         tenant.create(**options)
       end
     end
@@ -73,8 +73,8 @@ module Penthouse
     # @param tenant_identifier [String, Symbol] the identifier for the tenant
     # @see Penthouse::Tenants::BaseTenant#delete
     # @return [void]
-    def delete(tenant_identifier, runner: self.configuration.runner, **options)
-      switch(tenant_identifier, runner: runner) do |tenant|
+    def delete(tenant_identifier:, runner: self.configuration.runner, **options)
+      switch(tenant_identifier: tenant_identifier, runner: runner) do |tenant|
         tenant.delete(**options)
       end
     end

data/penthouse.gemspec

@@ -33,4 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'activesupport', '~> 4.2.6'
   spec.add_development_dependency 'activerecord', '~> 4.2.6'
   spec.add_development_dependency 'pg'
+  
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: penthouse
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ryan Townsend
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,6 +178,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - ryan@ryantownsend.co.uk
@@ -191,6 +219,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - bin/console