ros-apartment 2.3.0 → 2.7.0

data/lib/apartment/adapters/postgis_adapter.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 # handle postgis adapter as if it were postgresql,
 # only override the adapter_method used for initialization
-require "apartment/adapters/postgresql_adapter"
+require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
   module Tenant
-
     def self.postgis_adapter(config)
       postgresql_adapter(config)
     end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Tenant
-
     def self.postgresql_adapter(config)
       adapter = Adapters::PostgresqlAdapter
       adapter = Adapters::PostgresqlSchemaAdapter if Apartment.use_schemas
@@ -14,8 +15,7 @@ module Apartment
   module Adapters
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < AbstractAdapter
-
-    private
+      private
 
       def rescue_from
         PG::Error
@@ -24,13 +24,16 @@ module Apartment
 
     # Separate Adapter for Postgresql when using schemas
     class PostgresqlSchemaAdapter < AbstractAdapter
-
       def initialize(config)
         super
 
         reset
       end
 
+      def default_tenant
+        @default_tenant = Apartment.default_tenant || 'public'
+      end
+
       #   Reset schema search path to the default schema_search_path
       #
       #   @return {String} default schema search path
@@ -38,13 +41,19 @@ module Apartment
       def reset
         @current = default_tenant
         Apartment.connection.schema_search_path = full_search_path
+        reset_sequence_names
+      end
+
+      def init
+        super
+        Apartment.connection.schema_search_path = full_search_path
       end
 
       def current
         @current || default_tenant
       end
 
-    protected
+      protected
 
       def process_excluded_model(excluded_model)
         excluded_model.constantize.tap do |klass|
@@ -56,39 +65,45 @@ module Apartment
       end
 
       def drop_command(conn, tenant)
-        conn.execute(%{DROP SCHEMA "#{tenant}" CASCADE})
+        conn.execute(%(DROP SCHEMA "#{tenant}" CASCADE))
       end
 
       #   Set schema search path to new schema
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists?(tenant.to_s)
 
-        @current = tenant.to_s
+        tenant = tenant.to_s
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless tenant_exists?(tenant)
+
+        @current = tenant
         Apartment.connection.schema_search_path = full_search_path
 
         # When the PostgreSQL version is < 9.3,
         # there is a issue for prepared statement with changing search_path.
         # https://www.postgresql.org/docs/9.3/static/sql-prepare.html
-        if postgresql_version < 90300
-          Apartment.connection.clear_cache!
-        end
-
+        Apartment.connection.clear_cache! if postgresql_version < 90_300
+        reset_sequence_names
       rescue *rescuable_exceptions
         raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
       end
 
-    private
+      private
+
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+
+        Apartment.connection.schema_exists?(tenant)
+      end
 
       def create_tenant_command(conn, tenant)
-        conn.execute(%{CREATE SCHEMA "#{tenant}"})
+        conn.execute(%(CREATE SCHEMA "#{tenant}"))
       end
 
       #   Generate the final search path to set including persistent_schemas
       #
       def full_search_path
-        persistent_schemas.map(&:inspect).join(", ")
+        persistent_schemas.map(&:inspect).join(', ')
       end
 
       def persistent_schemas
@@ -100,20 +115,32 @@ module Apartment
         # public from Rails 5.0.
         Apartment.connection.send(:postgresql_version)
       end
+
+      def reset_sequence_names
+        # sequence_name contains the schema, so it must be reset after switch
+        # There is `reset_sequence_name`, but that method actually goes to the database
+        # to find out the new name. Therefore, we do this hack to only unset the name,
+        # and it will be dynamically found the next time it is needed
+        ActiveRecord::Base.descendants
+                          .select { |c| c.instance_variable_defined?(:@sequence_name) }
+                          .reject { |c| c.instance_variable_defined?(:@explicit_sequence_name) && c.instance_variable_get(:@explicit_sequence_name) }
+                          .each do |c|
+                            c.remove_instance_variable :@sequence_name
+                          end
+      end
     end
 
     # Another Adapter for Postgresql when using schemas and SQL
     class PostgresqlSchemaFromSqlAdapter < PostgresqlSchemaAdapter
-
-      PSQL_DUMP_BLACKLISTED_STATEMENTS= [
+      PSQL_DUMP_BLACKLISTED_STATEMENTS = [
         /SET search_path/i,                           # overridden later
         /SET lock_timeout/i,                          # new in postgresql 9.3
         /SET row_security/i,                          # new in postgresql 9.5
         /SET idle_in_transaction_session_timeout/i,   # new in postgresql 9.6
         /CREATE SCHEMA public/i,
-        /COMMENT ON SCHEMA public/i,
+        /COMMENT ON SCHEMA public/i
 
-      ]
+      ].freeze
 
       def import_database_schema
         preserving_search_path do
@@ -122,14 +149,14 @@ module Apartment
         end
       end
 
-    private
+      private
 
       # Re-set search path after the schema is imported.
       # Postgres now sets search path to empty before dumping the schema
       # and it mut be reset
       #
       def preserving_search_path
-        search_path = Apartment.connection.execute("show search_path").first["search_path"]
+        search_path = Apartment.connection.execute('show search_path').first['search_path']
         yield
         Apartment.connection.execute("set search_path = #{search_path}")
       end
@@ -153,7 +180,6 @@ module Apartment
       #   @return {String} raw SQL contaning only postgres schema dump
       #
       def pg_dump_schema
-
         # Skip excluded tables? :/
         # excluded_tables =
         #   collect_table_names(Apartment.excluded_models)
@@ -176,7 +202,10 @@ module Apartment
       # Temporary set Postgresql related environment variables if there are in @config
       #
       def with_pg_env(&block)
-        pghost, pgport, pguser, pgpassword =  ENV['PGHOST'], ENV['PGPORT'], ENV['PGUSER'], ENV['PGPASSWORD']
+        pghost = ENV['PGHOST']
+        pgport = ENV['PGPORT']
+        pguser = ENV['PGUSER']
+        pgpassword = ENV['PGPASSWORD']
 
         ENV['PGHOST'] = @config[:host] if @config[:host]
         ENV['PGPORT'] = @config[:port].to_s if @config[:port]
@@ -185,7 +214,10 @@ module Apartment
 
         block.call
       ensure
-        ENV['PGHOST'], ENV['PGPORT'], ENV['PGUSER'], ENV['PGPASSWORD'] = pghost, pgport, pguser, pgpassword
+        ENV['PGHOST'] = pghost
+        ENV['PGPORT'] = pgport
+        ENV['PGUSER'] = pguser
+        ENV['PGPASSWORD'] = pgpassword
       end
 
       #   Remove "SET search_path ..." line from SQL dump and prepend search_path set to current tenant
@@ -197,7 +229,7 @@ module Apartment
 
         swap_schema_qualifier(sql)
           .split("\n")
-          .select {|line| check_input_against_regexps(line, PSQL_DUMP_BLACKLISTED_STATEMENTS).empty?}
+          .select { |line| check_input_against_regexps(line, PSQL_DUMP_BLACKLISTED_STATEMENTS).empty? }
           .prepend(search_path)
           .join("\n")
       end
@@ -207,7 +239,7 @@ module Apartment
           if Apartment.pg_excluded_names.any? { |name| match.include? name }
             match
           else
-            match.gsub("#{default_tenant}.", %{"#{current}".})
+            match.gsub("#{default_tenant}.", %("#{current}".))
           end
         end
       end
@@ -215,7 +247,7 @@ module Apartment
       #   Checks if any of regexps matches against input
       #
       def check_input_against_regexps(input, regexps)
-        regexps.select {|c| input.match c}
+        regexps.select { |c| input.match c }
       end
 
       #   Collect table names from AR Models

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
@@ -16,8 +18,10 @@ module Apartment
       end
 
       def drop(tenant)
-        raise TenantNotFound,
-          "The tenant #{environmentify(tenant)} cannot be found." unless File.exists?(database_file(tenant))
+        unless File.exist?(database_file(tenant))
+          raise TenantNotFound,
+                "The tenant #{environmentify(tenant)} cannot be found."
+        end
 
         File.delete(database_file(tenant))
       end
@@ -26,18 +30,24 @@ module Apartment
         File.basename(Apartment.connection.instance_variable_get(:@config)[:database], '.sqlite3')
       end
 
-    protected
+      protected
 
       def connect_to_new(tenant)
-        raise TenantNotFound,
-          "The tenant #{environmentify(tenant)} cannot be found." unless File.exists?(database_file(tenant))
+        return reset if tenant.nil?
+
+        unless File.exist?(database_file(tenant))
+          raise TenantNotFound,
+                "The tenant #{environmentify(tenant)} cannot be found."
+        end
 
         super database_file(tenant)
       end
 
       def create_tenant(tenant)
-        raise TenantExists,
-          "The tenant #{environmentify(tenant)} already exists." if File.exists?(database_file(tenant))
+        if File.exist?(database_file(tenant))
+          raise TenantExists,
+                "The tenant #{environmentify(tenant)} already exists."
+        end
 
         begin
           f = File.new(database_file(tenant), File::CREAT)
@@ -46,7 +56,7 @@ module Apartment
         end
       end
 
-    private
+      private
 
       def database_file(tenant)
         "#{@default_dir}/#{environmentify(tenant)}.sqlite3"

data/lib/apartment/console.rb

@@ -1,12 +1,44 @@
+# frozen_string_literal: true
+
 # A workaraound to get `reload!` to also call Apartment::Tenant.init
 # This is unfortunate, but I haven't figured out how to hook into the reload process *after* files are reloaded
 
 # reloads the environment
-def reload!(print=true)
-  puts "Reloading..." if print
+def reload!(print = true)
+  # rubocop:disable Rails/Output
+  puts 'Reloading...' if print
+  # rubocop:enable Rails/Output
+
   # This triggers the to_prepare callbacks
-  ActionDispatch::Callbacks.new(Proc.new {}).call({})
+  ActionDispatch::Callbacks.new(proc {}).call({})
   # Manually init Apartment again once classes are reloaded
   Apartment::Tenant.init
   true
 end
+
+def st(schema_name = nil)
+  if schema_name.nil?
+    # rubocop:disable Rails/Output
+    tenant_list.each { |t| puts t }
+    # rubocop:enable Rails/Output
+  elsif tenant_list.include? schema_name
+    Apartment::Tenant.switch!(schema_name)
+  else
+    # rubocop:disable Rails/Output
+    puts "Tenant #{schema_name} is not part of the tenant list"
+    # rubocop:enable Rails/Output
+  end
+end
+
+def tenant_list
+  tenant_list = [Apartment.default_tenant]
+  tenant_list += Apartment.tenant_names
+  tenant_list.uniq
+end
+
+def tenant_info_msg
+  # rubocop:disable Rails/Output
+  puts "Available Tenants: #{tenant_list}\n"
+  puts "Use `st 'tenant'` to switch tenants & `tenant_list` to see list\n"
+  # rubocop:enable Rails/Output
+end

data/lib/apartment/custom_console.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'console'
+
+module Apartment
+  module CustomConsole
+    begin
+      require 'pry-rails'
+    rescue LoadError
+      # rubocop:disable Rails/Output
+      puts '[Failed to load pry-rails] If you want to use Apartment custom prompt you need to add pry-rails to your gemfile'
+      # rubocop:enable Rails/Output
+    end
+
+    desc = "Includes the current Rails environment and project folder name.\n" \
+          '[1] [project_name][Rails.env][Apartment::Tenant.current] pry(main)>'
+
+    prompt_procs = [
+      proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '>') },
+      proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '*') }
+    ]
+
+    if Gem::Version.new(Pry::VERSION) >= Gem::Version.new('0.13')
+      Pry.config.prompt = Pry::Prompt.new 'ros', desc, prompt_procs
+    else
+      Pry::Prompt.add 'ros', desc, %w[> *] do |target_self, nest_level, pry, sep|
+        prompt_contents(pry, target_self, nest_level, sep)
+      end
+      Pry.config.prompt = Pry::Prompt[:ros][:value]
+    end
+
+    Pry.config.hooks.add_hook(:when_started, 'startup message') do
+      tenant_info_msg
+    end
+
+    def self.prompt_contents(pry, target_self, nest_level, sep)
+      "[#{pry.input_ring.size}] [#{PryRails::Prompt.formatted_env}][#{Apartment::Tenant.current}] " \
+      "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})" \
+      "#{":#{nest_level}" unless nest_level.zero?}#{sep} "
+    end
+  end
+end

data/lib/apartment/deprecation.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'active_support/deprecation'
 
 module Apartment
   module Deprecation
-
     def self.warn(message)
       ActiveSupport::Deprecation.warn message
     end

data/lib/apartment/elevators/domain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/generic'
 
 module Apartment
@@ -8,14 +10,13 @@ module Apartment
     #   eg. example.com       => example
     #       www.example.bc.ca => example
     #       a.example.bc.ca   => a
-    #       
+    #
     #
     class Domain < Generic
-
       def parse_tenant_name(request)
         return nil if request.host.blank?
 
-        request.host.match(/(www\.)?(?<sld>[^.]*)/)["sld"]
+        request.host.match(/(www\.)?(?<sld>[^.]*)/)['sld']
       end
     end
   end

data/lib/apartment/elevators/first_subdomain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/subdomain'
 
 module Apartment
@@ -8,10 +10,9 @@ module Apartment
     #     - example1.domain.com               => example1
     #     - example2.something.domain.com     => example2
     class FirstSubdomain < Subdomain
-
       def parse_tenant_name(request)
         super.split('.')[0] unless super.nil?
       end
     end
   end
-end
+end

data/lib/apartment/elevators/generic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/request'
 require 'apartment/tenant'
 
@@ -6,7 +8,6 @@ module Apartment
     #   Provides a rack based tenant switching solution based on request
     #
     class Generic
-
       def initialize(app, processor = nil)
         @app = app
         @processor = processor || method(:parse_tenant_name)
@@ -24,8 +25,8 @@ module Apartment
         end
       end
 
-      def parse_tenant_name(request)
-        raise "Override"
+      def parse_tenant_name(_request)
+        raise 'Override'
       end
     end
   end