multi_tenant_subdomain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e0dbab0670afbd0e9ec60de68b40fb3021a6f23c489e7065d64200194d5051e
+  data.tar.gz: e1aa495aabba98159e312e16364398627b199bb8197a5e734e62e867c92dfce7
+SHA512:
+  metadata.gz: 431d99f799cc6870052617bb287a58f8c1c935bfb46c846bda3398b32971e4fb6990fb7feb3bedc9f1cc1ed576cb58da143fd0050d2f22101242fb1d92c6718e
+  data.tar.gz: e8eabe2cb7de0ea0e4cdd609027fbcca5acac8f3416367cabbfb0683e5a5b253ffd0c2f48d5b5509cf1397eb02fd15445e15d188220a5f3aa1b55955d74e1b78

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sharvy Ahmed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# MultiTenantSubdomain
+
+A gem that provides subdomain-based multi-tenancy support for Rails applications, using a single database while ensuring tenant isolation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "multi_tenant_subdomain"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+1.  **Generate the tenant model:**
+
+    ```bash
+    rails generate multi_tenant_subdomain YourTenantModel
+    ```
+
+    Replace `YourTenantModel` with the actual name of your tenant model (e.g., `Account`, `Organization`). This generator will:
+
+    - Create a model (if it doesn't exist) with a `subdomain` attribute.
+    - Add a migration to add the `subdomain` column to the model's table (if the table exists and the column is missing).
+    - Create an initializer to configure the `tenant_model`.
+
+2.  **Configure the tenant model:**
+
+    The generator creates an initializer file `config/initializers/multi_tenant_subdomain.rb` with the following content:
+
+    ```ruby
+    MultiTenantSubdomain.configure do |config|
+      config.tenant_model = "YourTenantModel"
+    end
+    ```
+
+    Ensure `YourTenantModel` matches the name of your tenant model.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/sharvy/multi_tenant_subdomain).
+
+## License
+
+The gem is available as open source under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/generators/multi_tenant_subdomain/multi_tenant_subdomain_generator.rb

@@ -0,0 +1,105 @@
+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
+
+      unless model_exists?
+        generate "model", "#{model_name} subdomain:string:index"
+      else
+        add_subdomain_field if migration_needed?
+      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_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
+        puts "X Initializer already exists. Skipping..."
+      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
+    end
+
+    def remove_model
+      model_path = Rails.root.join("app", "models", "#{model_name.underscore}.rb")
+      test_path = Rails.root.join("test", "models", "#{model_name.underscore}_test.rb")
+      spec_path = Rails.root.join("spec", "models", "#{model_name.underscore}_spec.rb")
+
+      [model_path, test_path, spec_path].each do |path|
+        FileUtils.rm_f(path) if File.exist?(path)
+      end
+
+      puts "X Removed model: #{model_name}"
+    end
+
+    def remove_migrations
+      migration_files = Dir.glob(Rails.root.join("db", "migrate", "*_#{model_name.tableize}.rb"))
+      migration_files.each do |file|
+        FileUtils.rm_f(file) if File.exist?(file)
+      end
+
+      puts "X Removed migrations related to #{model_name}"
+    end
+  end
+end

data/lib/multi_tenant_subdomain/active_record_extension.rb

@@ -0,0 +1,18 @@
+module MultiTenantSubdomain
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    included do
+      default_scope { where(tenant_id: MultiTenantSubdomain::TenantManager.current_tenant&.id) }
+      before_validation :set_tenant_id
+    end
+
+    private
+
+    def set_tenant_id
+      self.tenant_id = MultiTenantSubdomain::TenantManager.current_tenant&.id
+    end
+  end
+end
+
+ActiveRecord::Base.include MultiTenantSubdomain::ActiveRecordExtension

data/lib/multi_tenant_subdomain/middleware.rb

@@ -0,0 +1,32 @@
+module MultiTenantSubdomain
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      tenant = extract_subdomain(env)
+      MultiTenantSubdomain::TenantManager.current_tenant = tenant
+      @app.call(env)
+    ensure
+      # IMPORTANT: Reset the tenant after the request is processed
+      # This ensures that the tenant is not shared between requests
+      MultiTenantSubdomain::TenantManager.reset_tenant
+    end
+
+    private
+
+    def extract_subdomain(env)
+      request = Rack::Request.new(env)
+      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'
+
+      host_parts.first
+    end
+  end
+end

data/lib/multi_tenant_subdomain/railtie.rb

@@ -0,0 +1,7 @@
+module MultiTenantSubdomain
+  class Railtie < Rails::Railtie
+    initializer "multi_tenant_subdomain.configure_rails_initialization" do |app|
+      app.middleware.use MultiTenantSubdomain::Middleware
+    end
+  end
+end

data/lib/multi_tenant_subdomain/tenant_manager.rb

@@ -0,0 +1,19 @@
+module MultiTenantSubdomain
+  class TenantManager
+    MTS_KEY = :current_tenant
+
+    class << self
+      def current_tenant
+        Thread.current[MTS_KEY]
+      end
+
+      def current_tenant=(tenant)
+        Thread.current[MTS_KEY] = tenant
+      end
+
+      def reset_tenant
+        Thread.current[MTS_KEY] = nil
+      end
+    end
+  end
+end

data/lib/multi_tenant_subdomain/version.rb

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

data/lib/multi_tenant_subdomain.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "multi_tenant_subdomain/version"
+require_relative "multi_tenant_subdomain/railtie"
+require_relative "multi_tenant_subdomain/tenant_manager"
+require_relative "multi_tenant_subdomain/middleware"
+require_relative "multi_tenant_subdomain/active_record_extension"
+require_relative "generators/multi_tenant_subdomain/multi_tenant_subdomain_generator"
+
+module MultiTenantSubdomain
+  class Error < StandardError; end
+  class << self
+    attr_accessor :config
+
+    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

data/sig/multi_tenant_subdomain.rbs

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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: multi_tenant_subdomain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sharvy Ahmed
+bindir: exe
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: rubocop
+  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: bundler
+  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: rake
+  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: This gem provides subdomain-based multi-tenancy support for Rails applications,
+  using a single database while ensuring tenant isolation.
+email:
+- sharvy2008@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/multi_tenant_subdomain/multi_tenant_subdomain_generator.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
+- sig/multi_tenant_subdomain.rbs
+homepage: https://github.com/sharvy/multi_tenant_subdomain
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sharvy/multi_tenant_subdomain
+  source_code_uri: https://github.com/sharvy/multi_tenant_subdomain
+  changelog_uri: https://github.com/sharvy/multi_tenant_subdomain/blob/main/CHANGELOG.md
+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.6.3
+specification_version: 4
+summary: Multi-tenancy support with subdomain-based tenant isolation using a single
+  database.
+test_files: []