multi_tenant_subdomain 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0dbab0670afbd0e9ec60de68b40fb3021a6f23c489e7065d64200194d5051e
-  data.tar.gz: e1aa495aabba98159e312e16364398627b199bb8197a5e734e62e867c92dfce7
+  metadata.gz: 17f95fbb6c386d5bcb5e6f3d0f118edede54214733aba63b8846e863aaeea99a
+  data.tar.gz: 5058ee214f80b0af3c21b036f86a1d990b8b1292400703ade74625766d961a6a
 SHA512:
-  metadata.gz: 431d99f799cc6870052617bb287a58f8c1c935bfb46c846bda3398b32971e4fb6990fb7feb3bedc9f1cc1ed576cb58da143fd0050d2f22101242fb1d92c6718e
-  data.tar.gz: e8eabe2cb7de0ea0e4cdd609027fbcca5acac8f3416367cabbfb0683e5a5b253ffd0c2f48d5b5509cf1397eb02fd15445e15d188220a5f3aa1b55955d74e1b78
+  metadata.gz: 03ddf93849556da343a19662e80dd124dc0919fae3b6ff6a3bd9b0c248e1c45a8bec754cb698924e5561ea22c592e7598ebb9c082d77aec6172ac188f2ed9693
+  data.tar.gz: 17a6c92634f5e3a40a87f1d3c435692de0837ba0dcfa8423994732af3716028a4885220f38e9e746eee12c13c96366002828372b507b656d196bea548542b444

data/generators/multi_tenant_subdomain/multi_tenant_subdomain_generator.rb

@@ -0,0 +1,73 @@
+require "rails/generators"
+require "active_record"
+require "fileutils"
+
+module MultiTenantSubdomain
+  class MultiTenantSubdomainGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+    argument :model_name, type: :string
+
+    def create_model
+      return if behavior != :invoke
+
+      if model_exists?
+        add_subdomain_field if migration_needed?
+      else
+        generate "model", "#{model_name} subdomain:string:index"
+      end
+
+      create_initializer
+    end
+
+    def destroy
+      return if behavior != :revoke
+
+      remove_initializer
+      remove_model if model_exists?
+      remove_migrations
+    end
+
+    private
+
+    def model_exists?
+      File.exist?(Rails.root.join("app", "models", "#{model_name.underscore}.rb"))
+    end
+
+    def table_exists?
+      ActiveRecord::Base.connection.data_source_exists?(model_name.tableize)
+    end
+
+    def column_exists?(column)
+      return false unless table_exists?
+
+      ActiveRecord::Base.connection.column_exists?(model_name.tableize, column)
+    end
+
+    def migration_needed?
+      table_exists? && !column_exists?(:subdomain)
+    end
+
+    def add_subdomain_field
+      timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+      migration_file = "db/migrate/#{timestamp}_add_subdomain_to_#{model_name.tableize}.rb"
+
+      create_file migration_file, <<~RUBY
+        class AddSubdomainTo#{model_name.camelize} < ActiveRecord::Migration[#{Rails.version.to_f}]
+          def change
+            add_column :#{model_name.tableize}, :subdomain, :string, index: true
+          end
+        end
+      RUBY
+    end
+
+    def create_initializer
+      initializer_file = "config/initializers/multi_tenant_subdomain.rb"
+
+      create_file initializer_file, <<~RUBY
+        MultiTenantSubdomain.configure do |config|
+          config.tenant_model = "#{model_name}"
+        end
+      RUBY
+    end
+  end
+end

data/lib/generators/multi_tenant_subdomain/multi_tenant_subdomain_generator.rb

@@ -10,10 +10,10 @@ module MultiTenantSubdomain
     def create_model
       return if behavior != :invoke
 
-      unless model_exists?
-        generate "model", "#{model_name} subdomain:string:index"
-      else
+      if model_exists?
         add_subdomain_field if migration_needed?
+      else
+        generate "model", "#{model_name} subdomain:string:index"
       end
 
       create_initializer
@@ -21,6 +21,7 @@ module MultiTenantSubdomain
 
     def destroy
       return if behavior != :revoke
+
       remove_initializer
       remove_model if model_exists?
       remove_migrations
@@ -62,23 +63,19 @@ module MultiTenantSubdomain
     def create_initializer
       initializer_path = Rails.root.join("config", "initializers", "multi_tenant_subdomain.rb")
 
-      unless File.exist?(initializer_path)
-        create_file initializer_path, <<~RUBY
-          MultiTenantSubdomain.configure do |config|
-            config.tenant_model = #{model_name.to_s.camelize}
-          end
-        RUBY
-      else
+      if File.exist?(initializer_path)
         puts "X Initializer already exists. Skipping..."
+      else
+        template "multi_tenant_subdomain.rb", initializer_path
       end
     end
 
     def remove_initializer
       initializer_path = Rails.root.join("config", "initializers", "multi_tenant_subdomain.rb")
-      if File.exist?(initializer_path)
-        FileUtils.rm_f(initializer_path)
-        puts "X Removed initializer: config/initializers/multi_tenant_subdomain.rb"
-      end
+      return unless File.exist?(initializer_path)
+
+      FileUtils.rm_f(initializer_path)
+      puts "X Removed initializer: config/initializers/multi_tenant_subdomain.rb"
     end
 
     def remove_model

data/lib/generators/multi_tenant_subdomain/templates/multi_tenant_subdomain.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+MultiTenantSubdomain.configure do |config|
+  config.tenant_model_class = "<%= model_name.to_s.camelize %>"
+  config.tenant_model_table = "<%= model_name.tableize %>"
+  config.tenant_model_pk = "id"
+  config.tenant_model_fk = "<%= model_name.underscore %>_id"
+end

data/lib/multi_tenant_subdomain/active_record_extension.rb

@@ -1,18 +1,79 @@
+# frozen_string_literal: true
+
 module MultiTenantSubdomain
+  # This module is used to extend ActiveRecord models to support multi-tenant
+  # subdomains.
+  #
+  # It adds a default scope to the model to ensure that all records are
+  # scoped to the current tenant.
+  #
+  # It also adds a before_validation callback to set the tenant_id on the
+  # model.
   module ActiveRecordExtension
     extend ActiveSupport::Concern
 
     included do
-      default_scope { where(tenant_id: MultiTenantSubdomain::TenantManager.current_tenant&.id) }
-      before_validation :set_tenant_id
+      # Don't try to access the database during class loading
+      # Instead, set up a hook that will be called when the model is used
+      after_initialize :ensure_tenant_configured, if: :tenant_configured?
+
+      # Class method to temporarily disable tenant scoping
+      define_singleton_method(
+        "without_#{MultiTenantSubdomain.config.tenant_model_class.to_s.underscore}_scope".to_sym
+      ) do |&block|
+        unscoped(&block)
+      end
+    end
+
+    class_methods do
+      def tenant_configured?
+        # Safely check if we can access table information without raising errors
+        begin
+          connected? && table_exists? &&
+            column_names.include?(MultiTenantSubdomain.config.tenant_model_fk)
+        rescue => e
+          false
+        end
+      end
+
+      # Apply tenant scoping when the model is used
+      def apply_tenant_scoping
+        # Only apply if not already applied
+        return if instance_variable_defined?(:@tenant_scoping_applied)
+
+        before_validation :set_tenant_id
+        default_scope do
+            where(
+              MultiTenantSubdomain.config.tenant_model_fk =>
+                MultiTenantSubdomain::TenantManager.current_tenant.send(
+                  MultiTenantSubdomain.config.tenant_model_pk.to_sym
+                )
+            )
+        end
+        @tenant_scoping_applied = true
+      end
     end
 
     private
 
+    def tenant_configured?
+      self.class.tenant_configured?
+    end
+
+    def ensure_tenant_configured
+      self.class.apply_tenant_scoping
+    end
+
     def set_tenant_id
-      self.tenant_id = MultiTenantSubdomain::TenantManager.current_tenant&.id
+      self[MultiTenantSubdomain.config.tenant_model_fk.to_sym] = MultiTenantSubdomain::TenantManager.current_tenant.send(
+        MultiTenantSubdomain.config.tenant_model_pk.to_sym
+      )
     end
   end
 end
 
-ActiveRecord::Base.include MultiTenantSubdomain::ActiveRecordExtension
+# Use ActiveSupport.on_load to include the module in ActiveRecord::Base
+# This ensures that the module is loaded at the right time in the Rails initialization process
+ActiveSupport.on_load(:active_record) do
+  include MultiTenantSubdomain::ActiveRecordExtension
+end

data/lib/multi_tenant_subdomain/middleware.rb

@@ -1,11 +1,28 @@
+# frozen_string_literal: true
+
 module MultiTenantSubdomain
+  # This middleware is used to set the current tenant based on the subdomain
+  # of the request.
+  #
+  # It is used to ensure that all requests are scoped to a single tenant.
   class Middleware
     def initialize(app)
       @app = app
     end
 
     def call(env)
-      tenant = extract_subdomain(env)
+      subdomain = extract_subdomain(env)
+      tenant = MultiTenantSubdomain.config.tenant_model_table.classify.constantize.find_by(subdomain: subdomain)
+
+      if tenant.nil? && subdomain.present?
+        # Option 1: Return a 404 Not Found response
+        return [404, {'Content-Type' => 'text/html'}, ['Tenant not found']]
+
+        # Option 2: Redirect to main domain (uncomment to use)
+        # main_domain = env['HTTP_HOST'].split('.').drop(1).join('.')
+        # return [302, {'Location' => "https://#{main_domain}"}, []]
+      end
+
       MultiTenantSubdomain::TenantManager.current_tenant = tenant
       @app.call(env)
     ensure
@@ -18,13 +35,13 @@ module MultiTenantSubdomain
 
     def extract_subdomain(env)
       request = Rack::Request.new(env)
-      host_parts = request.host.split('.')
-      
+      host_parts = request.host.split(".")
+
       # Avoid affecting primary domain
       return nil if host_parts.length < 3
 
       # Avoid affecting www subdomain
-      return nil if host_parts.first == 'www'
+      return nil if host_parts.first == "www"
 
       host_parts.first
     end

data/lib/multi_tenant_subdomain/tenant_manager.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 module MultiTenantSubdomain
+  # This class is used to manage the current tenant.
+  #
+  # It is used to ensure that all requests are scoped to a single tenant.
   class TenantManager
     MTS_KEY = :current_tenant
 

data/lib/multi_tenant_subdomain/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MultiTenantSubdomain
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/multi_tenant_subdomain.rb

@@ -7,21 +7,89 @@ require_relative "multi_tenant_subdomain/middleware"
 require_relative "multi_tenant_subdomain/active_record_extension"
 require_relative "generators/multi_tenant_subdomain/multi_tenant_subdomain_generator"
 
+##
+# This module provides multi-tenant subdomain functionality for Rails applications.
+#
+# It allows you to easily scope your application's data and functionality
+# to different tenants based on the subdomain in the request URL.
+#
+# To use this module, you need to:
+#
+#   1. Generate the necessary migrations and configurations using the provided generator:
+#
+#      `rails generate multi_tenant_subdomain YourTenantModelName`
+#
+#   2. Configure the module with your tenant model class and primary/foreign keys:
+#
+#      ```ruby
+#      MultiTenantSubdomain.configure do |config|
+#        config.tenant_model_class = "Account" # Default: "Tenant"
+#        config.tenant_model_table = "accounts" # Default: "tenants"
+#        config.tenant_model_pk = "id" # Default: "id"
+#        config.tenant_model_fk = "account_id" # Default: "tenant_id"
+#      end
+#      ```
+#
+#   3. Use the `MultiTenantSubdomain::TenantManager.current_tenant` method to access the
+#      current tenant in your controllers and views.
 module MultiTenantSubdomain
+  ##
+  # Error class for any errors raised by the module.
   class Error < StandardError; end
+
+  ##
+  # Configuration class for the module.
+  class Configuration
+    ##
+    # @!attribute tenant_model_class
+    #   @return [String] The name of the tenant model class. Default: "Tenant".
+    attr_accessor :tenant_model_class
+
+    ##
+    # @!attribute tenant_model_table
+    #   @return [String] The name of the tenant model table. Default: "tenants".
+    attr_accessor :tenant_model_table
+
+    ##
+    # @!attribute tenant_model_pk
+    #   @return [String] The name of the primary key column on the tenant model. Default: "id".
+    attr_accessor :tenant_model_pk
+
+    ##
+    # @!attribute tenant_model_fk
+    #   @return [String] The name of the foreign key column on the models that should be scoped to a tenant. Default: "tenant_id".
+    attr_accessor :tenant_model_fk
+
+    # Initializes a new Configuration object with default values.
+    def initialize
+      @tenant_model_class = "Tenant"
+      @tenant_model_table = "tenants"
+      @tenant_model_pk = "id"
+      @tenant_model_fk = "tenant_id"
+    end
+  end
+
   class << self
+    ##
+    # @!attribute config
+    #   @return [Configuration] The configuration object for the module.
     attr_accessor :config
 
+    ##
+    # Configures the module.
+    #
+    # @yield [config] The configuration object.
+    # @yieldparam config [Configuration] The configuration object.
+    #
+    # @example
+    #   MultiTenantSubdomain.configure do |config|
+    #     config.tenant_model_class = "Account"
+    #     config.tenant_model_pk = "account_id"
+    #     config.tenant_model_fk = "account_id"
+    #   end
     def configure
       self.config ||= Configuration.new
       yield(config) if block_given?
     end
   end
-  class Configuration
-    attr_accessor :tenant_model
-
-    def initialize
-      @tenant_model = "Tenant"
-    end
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: multi_tenant_subdomain
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sharvy Ahmed
 bindir: exe
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,13 +80,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- generators/multi_tenant_subdomain/multi_tenant_subdomain_generator.rb
 - lib/generators/multi_tenant_subdomain/multi_tenant_subdomain_generator.rb
+- lib/generators/multi_tenant_subdomain/templates/multi_tenant_subdomain.rb
 - lib/multi_tenant_subdomain.rb
 - lib/multi_tenant_subdomain/active_record_extension.rb
 - lib/multi_tenant_subdomain/middleware.rb
 - lib/multi_tenant_subdomain/railtie.rb
 - lib/multi_tenant_subdomain/tenant_manager.rb
 - lib/multi_tenant_subdomain/version.rb
+- multi_tenant_subdomain-0.1.0.gem
 - sig/multi_tenant_subdomain.rbs
 homepage: https://github.com/sharvy/multi_tenant_subdomain
 licenses: