pg_multitenant_schemas 0.1.3

data/lib/pg_multitenant_schemas/tasks/pg_multitenant_schemas.rake

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+namespace :pg_multitenant_schemas do
+  desc "List all tenant schemas"
+  task :list_schemas => :environment do
+    puts "Available tenant schemas:"
+    
+    connection = ActiveRecord::Base.connection
+    schemas = connection.execute(
+      "SELECT schema_name FROM information_schema.schemata WHERE schema_name NOT IN ('information_schema', 'pg_catalog', 'pg_toast_temp_1', 'pg_temp_1', 'public') AND schema_name NOT LIKE 'pg_toast%'"
+    ).map { |row| row['schema_name'] }
+    
+    if schemas.any?
+      schemas.each { |schema| puts "  - #{schema}" }
+    else
+      puts "  No tenant schemas found"
+    end
+  end
+
+  desc "Create schema for a tenant"
+  task :create_schema, [:schema_name] => :environment do |task, args|
+    schema_name = args[:schema_name]
+    
+    if schema_name.blank?
+      puts "Usage: rails pg_multitenant_schemas:create_schema[schema_name]"
+      exit 1
+    end
+    
+    begin
+      connection = ActiveRecord::Base.connection
+      PgMultitenantSchemas::SchemaSwitcher.create_schema(connection, schema_name)
+      puts "Created schema: #{schema_name}"
+    rescue => e
+      puts "Error creating schema #{schema_name}: #{e.message}"
+      exit 1
+    end
+  end
+
+  desc "Drop schema for a tenant"
+  task :drop_schema, [:schema_name] => :environment do |task, args|
+    schema_name = args[:schema_name]
+    
+    if schema_name.blank?
+      puts "Usage: rails pg_multitenant_schemas:drop_schema[schema_name]"
+      exit 1
+    end
+    
+    if schema_name == 'public'
+      puts "Cannot drop public schema"
+      exit 1
+    end
+    
+    begin
+      connection = ActiveRecord::Base.connection
+      PgMultitenantSchemas::SchemaSwitcher.drop_schema(connection, schema_name)
+      puts "Dropped schema: #{schema_name}"
+    rescue => e
+      puts "Error dropping schema #{schema_name}: #{e.message}"
+      exit 1
+    end
+  end
+
+  desc "Run migrations for all tenant schemas"
+  task :migrate_all => :environment do
+    puts "Running migrations for all tenant schemas..."
+    
+    connection = ActiveRecord::Base.connection
+    schemas = connection.execute(
+      "SELECT schema_name FROM information_schema.schemata WHERE schema_name NOT IN ('information_schema', 'pg_catalog', 'pg_toast_temp_1', 'pg_temp_1', 'public') AND schema_name NOT LIKE 'pg_toast%'"
+    ).map { |row| row['schema_name'] }
+    
+    original_schema = PgMultitenantSchemas.current_schema rescue 'public'
+    
+    schemas.each do |schema|
+      puts "Migrating schema: #{schema}"
+      begin
+        PgMultitenantSchemas.with_tenant(schema) do
+          # Rails 8 compatible migration execution
+          if Rails.version >= "8.0"
+            # Use Rails 8 migration API
+            ActiveRecord::Tasks::DatabaseTasks.migrate
+          else
+            # Fallback for older Rails versions
+            ActiveRecord::Migrator.migrate(Rails.application.paths["db/migrate"])
+          end
+        end
+        puts "  ✓ Completed migration for #{schema}"
+      rescue => e
+        puts "  ✗ Error migrating #{schema}: #{e.message}"
+      end
+    end
+    
+    # Restore original schema
+    PgMultitenantSchemas.current_schema = original_schema if defined?(PgMultitenantSchemas)
+    
+    puts "Completed migrations for #{schemas.count} schemas"
+  end
+
+  desc "Setup multitenancy - create tenant schemas for existing tenants"
+  task :setup => :environment do
+    puts "Setting up multitenancy schemas..."
+    
+    if defined?(Tenant)
+      tenants = Tenant.all
+      
+      tenants.each do |tenant|
+        begin
+          puts "Creating schema for tenant: #{tenant.subdomain}"
+          PgMultitenantSchemas::SchemaSwitcher.create_schema(
+            ActiveRecord::Base.connection, 
+            tenant.subdomain
+          )
+          puts "  ✓ Schema created for #{tenant.subdomain}"
+        rescue => e
+          if e.message.include?("already exists")
+            puts "  - Schema #{tenant.subdomain} already exists"
+          else
+            puts "  ✗ Could not create schema for #{tenant.subdomain}: #{e.message}"
+          end
+        end
+      end
+      
+      puts "Setup completed for #{tenants.count} tenants"
+    else
+      puts "Tenant model not found. Make sure your Tenant model is defined."
+    end
+  end
+
+  desc "Run migrations for a specific tenant schema"
+  task :migrate_tenant, [:schema_name] => :environment do |task, args|
+    schema_name = args[:schema_name]
+    
+    if schema_name.blank?
+      puts "Usage: rails pg_multitenant_schemas:migrate_tenant[schema_name]"
+      exit 1
+    end
+    
+    puts "Running migrations for tenant: #{schema_name}"
+    
+    begin
+      PgMultitenantSchemas.with_tenant(schema_name) do
+        # Rails 8 compatible migration execution
+        if Rails.version >= "8.0"
+          ActiveRecord::Tasks::DatabaseTasks.migrate
+        else
+          ActiveRecord::Migrator.migrate(Rails.application.paths["db/migrate"])
+        end
+      end
+      puts "✓ Completed migration for #{schema_name}"
+    rescue => e
+      puts "✗ Error migrating #{schema_name}: #{e.message}"
+      exit 1
+    end
+  end
+end

data/lib/pg_multitenant_schemas/tenant_resolver.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module PgMultitenantSchemas
+  # Tenant resolution from HTTP requests
+  class TenantResolver
+    class << self
+      # Extract subdomain from host
+      def extract_subdomain(host)
+        return nil if invalid_host?(host)
+
+        host = clean_host(host)
+        parts = host.split(".")
+        return nil if parts.length < 2
+
+        subdomain = parts.first.downcase
+        return nil if excluded_subdomain?(subdomain, parts)
+
+        subdomain
+      end
+
+      private
+
+      # Check if host is invalid for subdomain extraction
+      def invalid_host?(host)
+        host.blank? || host == "localhost" || host.match?(/\A\d+\.\d+\.\d+\.\d+/)
+      end
+
+      # Clean host by removing port
+      def clean_host(host)
+        host.split(":").first
+      end
+
+      # Check if subdomain should be excluded
+      def excluded_subdomain?(subdomain, parts)
+        # Exclude common subdomains for standard domains (3 parts or fewer)
+        # Allow them for complex subdomains (4+ parts like api.company.example.com)
+        if parts.length <= 3
+          excluded_subdomains = PgMultitenantSchemas.configuration.excluded_subdomains
+          return true if excluded_subdomains.include?(subdomain)
+        end
+
+        # For exactly 2 parts, also check if second part is a common TLD
+        if parts.length == 2
+          common_tlds = PgMultitenantSchemas.configuration.common_tlds
+          return true if common_tlds.include?(parts.last.downcase)
+        end
+
+        false
+      end
+
+      public
+
+      # Find tenant by subdomain (only active tenants)
+      def find_tenant_by_subdomain(subdomain)
+        return nil if subdomain.blank?
+
+        tenant_model = PgMultitenantSchemas.configuration.tenant_model
+
+        # Attempt to find active tenant
+        if tenant_model.respond_to?(:active)
+          tenant_model.active.find_by(subdomain: subdomain)
+        else
+          tenant_model.find_by(subdomain: subdomain, status: "active")
+        end
+      rescue StandardError => e
+        Rails.logger.error "PgMultitenantSchemas: Error finding tenant '#{subdomain}': #{e.message}"
+        nil
+      end
+
+      # Resolve tenant from request
+      def resolve_tenant_from_request(request)
+        subdomain = extract_subdomain(request.host)
+        return nil if subdomain.blank?
+
+        find_tenant_by_subdomain(subdomain)
+      end
+
+      # Resolve tenant with fallback options
+      def resolve_tenant_with_fallback(request)
+        tenant = resolve_tenant_from_request(request)
+
+        # If no tenant found and development fallback is enabled
+        if tenant.nil? && PgMultitenantSchemas.configuration.development_fallback && Rails.env.development?
+          Rails.logger.info "PgMultitenantSchemas: No tenant found, using development fallback"
+          return nil # This will cause switch to default schema
+        end
+
+        tenant
+      end
+    end
+  end
+end

data/lib/pg_multitenant_schemas/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PgMultitenantSchemas
+  VERSION = "0.1.3"
+end

data/lib/pg_multitenant_schemas.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object/blank"
+require_relative "pg_multitenant_schemas/version"
+require_relative "pg_multitenant_schemas/errors"
+require_relative "pg_multitenant_schemas/configuration"
+require_relative "pg_multitenant_schemas/schema_switcher"
+require_relative "pg_multitenant_schemas/context"
+require_relative "pg_multitenant_schemas/tenant_resolver"
+
+# Rails integration (only load if Rails is available)
+if defined?(Rails)
+  require_relative "pg_multitenant_schemas/rails/controller_concern"
+  require_relative "pg_multitenant_schemas/rails/model_concern"
+  require_relative "pg_multitenant_schemas/rails/railtie"
+end
+
+# PgMultitenantSchemas provides PostgreSQL schema-based multitenancy functionality.
+# It allows switching between different PostgreSQL schemas to achieve tenant isolation
+# while sharing the same database connection. Includes Rails integration support.
+module PgMultitenantSchemas
+  class << self
+    # Delegate common methods to Context for convenience
+    delegate :current_tenant, :current_tenant=, :current_schema, :current_schema=,
+             :reset!, :switch_to_schema, :switch_to_tenant, :with_tenant,
+             :create_tenant_schema, :drop_tenant_schema, to: :"PgMultitenantSchemas::Context"
+
+    # Delegate tenant resolution to TenantResolver
+    delegate :extract_subdomain, :find_tenant_by_subdomain, :resolve_tenant_from_request,
+             to: :"PgMultitenantSchemas::TenantResolver"
+  end
+end

data/pg_multitenant_schemas.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/pg_multitenant_schemas/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pg_multitenant_schemas"
+  spec.version = PgMultitenantSchemas::VERSION
+  spec.authors = ["Ruben Paz"]
+  spec.email = ["rubenpazchuspe@outlook.com"]
+
+  spec.summary = "PostgreSQL schema-based multitenancy for Rails applications"
+  spec.description = "A Ruby gem that provides PostgreSQL schema-based multitenancy with automatic tenant " \
+                     "resolution, schema switching, Rails 8 compatibility, and comprehensive Rails integration. " \
+                     "Perfect for SaaS applications requiring secure tenant isolation."
+  spec.homepage = "https://github.com/rubenpazch/pg_multitenant_schemas"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile]) ||
+        f.end_with?(".gem")
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies - Rails 8 compatible
+  spec.add_dependency "activerecord", ">= 7.0", "< 9.0"
+  spec.add_dependency "activesupport", ">= 7.0", "< 9.0"
+  spec.add_dependency "pg", "~> 1.0"
+end

data/sig/pg_multitenant_schemas.rbs

@@ -0,0 +1,4 @@
+module PgMultitenantSchemas
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: pg_multitenant_schemas
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Ruben Paz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby gem that provides PostgreSQL schema-based multitenancy with automatic
+  tenant resolution, schema switching, Rails 8 compatibility, and comprehensive Rails
+  integration. Perfect for SaaS applications requiring secure tenant isolation.
+email:
+- rubenpazchuspe@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_simple.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_multitenant_schemas.rb
+- lib/pg_multitenant_schemas/configuration.rb
+- lib/pg_multitenant_schemas/context.rb
+- lib/pg_multitenant_schemas/errors.rb
+- lib/pg_multitenant_schemas/rails/controller_concern.rb
+- lib/pg_multitenant_schemas/rails/model_concern.rb
+- lib/pg_multitenant_schemas/rails/railtie.rb
+- lib/pg_multitenant_schemas/schema_switcher.rb
+- lib/pg_multitenant_schemas/tasks/pg_multitenant_schemas.rake
+- lib/pg_multitenant_schemas/tenant_resolver.rb
+- lib/pg_multitenant_schemas/version.rb
+- pg_multitenant_schemas.gemspec
+- rails_integration/app/controllers/application_controller.rb
+- rails_integration/app/models/tenant.rb
+- sig/pg_multitenant_schemas.rbs
+homepage: https://github.com/rubenpazch/pg_multitenant_schemas
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubenpazch/pg_multitenant_schemas
+  source_code_uri: https://github.com/rubenpazch/pg_multitenant_schemas
+  changelog_uri: https://github.com/rubenpazch/pg_multitenant_schemas/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: PostgreSQL schema-based multitenancy for Rails applications
+test_files: []