penthouse 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fdce337d0e5a5c6662f7d2fbfd2a3f14877fc7a
-  data.tar.gz: ca32b3019f2bdf8b105f962c8f1f40767a86cf95
+  metadata.gz: d0c9927dc0600cac735628cb2a5eab354fe2594b
+  data.tar.gz: 70140e22124a0f0a69d98e3f1503ae242a9b65c5
 SHA512:
-  metadata.gz: fbc0c2e3951d8acd63ffe18c6a2dd2d3ea4a32b508001767ce64cfbff1c30e8d63e913f0401688c157bf88b95f0c69a977a735c4cc6f1c8c3d2433283bf644f5
-  data.tar.gz: 2eab6ab62ea17238ab22999b6c7a0f6f8bc7228583ee06f29bef91e9e3a2676a42fc25b681d649f5b737c4b141826ca75562e07a40b2575331151be4e76d97b1
+  metadata.gz: b7230bf2af1ca86e70ae88dab90ebf07dbd75d34ef0b8350d865cf95957788028232d93760d472aa827ff2a9588d4d5543d8101dbec6a32f0d05637496cbd262
+  data.tar.gz: 6160b12b68e6380f2ecfd408e803ee242ae35cae61f26da3fab4e9a0864f91a8a7b425de923114abd582fc3b97a51082b3c8dc8d0ef0fed77581fc65f7363610

data/README.md

@@ -1,4 +1,4 @@
-[ ![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)
+[![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) [![RubyDocs](https://img.shields.io/badge/rubydocs-click_here-blue.svg)](http://www.rubydoc.info/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.
 

data/lib/penthouse/app.rb

@@ -27,6 +27,7 @@ module Penthouse
 
     # @param env [Hash] the environment passed from Rack
     # @raise [Penthouse::TenantNotFound] if the tenant cannot be found/switched to
+    # @return [void]
     def call(env)
       request = Rack::Request.new(env)
       runner.call(router.call(request)) do

data/lib/penthouse/migrator.rb

@@ -8,6 +8,7 @@ module Penthouse
 
     # Migrate to latest version
     # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
+    # @return [void]
     def migrate(tenant_identifier)
       Penthouse.switch(tenant_identifier) do
         version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
@@ -21,6 +22,7 @@ module Penthouse
     # 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
         ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
@@ -30,6 +32,7 @@ module Penthouse
     # 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
         ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)

data/lib/penthouse/railtie.rb

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

data/lib/penthouse/runners/base_runner.rb

@@ -13,6 +13,7 @@ module Penthouse
 
       # @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|

data/lib/penthouse/tenants/base_tenant.rb

@@ -21,16 +21,19 @@ module Penthouse
       # @abstract placeholder for the relevant tenant-switching code
       # @param block [Block] The code to execute within the tenant
       # @yield [BaseTenant] The current tenant instance
+      # @return [void]
       def call(&block)
         raise NotImplementedError
       end
 
       # @abstract creates the tenant data store
+      # @return [void]
       def create(*)
         raise NotImplementedError
       end
 
       # @abstract deletes the tenant data store
+      # @return [void]
       def delete(*)
         raise NotImplementedError
       end

data/lib/penthouse/tenants/migratable.rb

@@ -12,15 +12,11 @@ module Penthouse
     module Migratable
 
       # @param db_schema_file [String] a path to the DB schema file to load, defaults to Penthouse.configuration.db_schema_file
+      # @return [void]
       def migrate(db_schema_file: Penthouse.configuration.db_schema_file)
         if File.exist?(db_schema_file)
-          # turn off logging schemas
-          ActiveRecord::Schema.verbose = false
           # run the migrations within this schema
-          call do
-            puts ActiveRecord::Base.connection.schema_search_path
-            load(db_schema_file)
-          end
+          call { load(db_schema_file) }
         else
           raise ArgumentError, "#{db_schema_file} does not exist"
         end

data/lib/penthouse/tenants/octopus_schema_tenant.rb

@@ -18,6 +18,7 @@ module Penthouse
       # with the tenant name
       # @param block [Block] The code to execute within the schema
       # @yield [SchemaTenant] The current tenant instance
+      # @return [void]
       def call(&block)
         Octopus.using(:master) do
           super
@@ -26,18 +27,21 @@ module Penthouse
 
       # creates the tenant schema within the master shard
       # @see Penthouse::Tenants::SchemaTenant#create
+      # @return [void]
       def create(*)
         call { super }
       end
 
       # drops the tenant schema within the master shard
       # @see Penthouse::Tenants::SchemaTenant#delete
+      # @return [void]
       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?(*)
         call { super }
       end

data/lib/penthouse/tenants/octopus_shard_tenant.rb

@@ -29,6 +29,7 @@ module Penthouse
       # switches to the relevant Octopus shard, and processes the block
       # @param block [Block] The code to execute within the connection to the shard
       # @yield [ShardTenant] The current tenant instance
+      # @return [void]
       def call(&block)
         Octopus.using(shard) do
           block.yield(self)

data/lib/penthouse/tenants/schema_tenant.rb

@@ -32,6 +32,7 @@ module Penthouse
       # afterwards, regardless of whether an exception occurs
       # @param block [Block] The code to execute within the schema
       # @yield [SchemaTenant] The current tenant instance
+      # @return [void]
       def call(&block)
         begin
           # set the search path to include the tenant
@@ -46,6 +47,7 @@ module Penthouse
       # creates the tenant schema
       # @param run_migrations [Boolean] whether or not to run migrations, defaults to Penthouse.configuration.migrate_tenants?
       # @param db_schema_file [String] a path to the DB schema file to load, defaults to Penthouse.configuration.db_schema_file
+      # @return [void]
       def create(run_migrations: Penthouse.configuration.migrate_tenants?, db_schema_file: Penthouse.configuration.db_schema_file)
         sql = ActiveRecord::Base.send(:sanitize_sql_array, ["create schema if not exists %s", tenant_schema])
         ActiveRecord::Base.connection.exec_query(sql, 'Create Schema')
@@ -56,6 +58,7 @@ module Penthouse
 
       # drops the tenant schema
       # @param force [Boolean] whether or not to drop the schema if not empty, defaults to true
+      # @return [void]
       def delete(force: true)
         sql = ActiveRecord::Base.send(:sanitize_sql_array, ["drop schema if exists %s %s", tenant_schema, force ? 'cascade' : 'restrict'])
         ActiveRecord::Base.connection.exec_query(sql, 'Delete Schema')

data/lib/penthouse/version.rb

@@ -1,3 +1,3 @@
 module Penthouse
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/penthouse.rb

@@ -1,3 +1,4 @@
+require "penthouse/railtie" if defined?(Rails)
 require "penthouse/version"
 require "penthouse/configuration"
 require "penthouse/routers/base_router"
@@ -15,6 +16,7 @@ module Penthouse
 
     # 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
     end
@@ -25,6 +27,7 @@ module Penthouse
     # @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 with_tenant(tenant_identifier, default_tenant: tenant, &block)
       self.tenant = tenant_identifier
       block.yield(tenant_identifier)
@@ -37,6 +40,7 @@ module Penthouse
     # @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|
         switch(tenant_identifier, runner: runner, &block)
@@ -48,6 +52,7 @@ module Penthouse
     # @param runner [Penthouse::Runners::BaseRunner] an optional runner to use, defaults to the one configured
     # @param block [Block] the code to execute
     # @yield [Penthouse::Tenants::BaseTenant] the tenant instance
+    # @return [void]
     def switch(tenant_identifier, runner: configuration.runner, &block)
       runner.call(tenant_identifier, &block)
     end
@@ -55,6 +60,7 @@ module Penthouse
     # 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: configuration.runner, **options)
       switch(tenant_identifier, runner: runner) do |tenant|
         tenant.create(**options)
@@ -64,6 +70,7 @@ module Penthouse
     # Loads the tenant and deletes their data store
     # @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)
       switch(tenant_identifier, runner: runner) do |tenant|
         tenant.delete(**options)
@@ -72,6 +79,7 @@ module Penthouse
 
     # Allows you to configure the router of Penthouse
     # @yield [Penthouse::Configuration]
+    # @return [void]
     def configure(&block)
       # allow the configuration by the block
       block.yield(self.configuration)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: penthouse
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan Townsend
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,7 @@ 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