multitenancy-rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94cb822ac6240e6f4f613e4493b71f1e6c11e1526d923dc15f0f86fd554840ba
+  data.tar.gz: f031e768ca8765548fb9caa703d2fa3b5c017c8ae82ed7e5178ec74224610832
+SHA512:
+  metadata.gz: 9065c1c25494966502f9b213be87048cf3ef8f5d19a6984db9f93c399768ffaa673f5e4091ae00bd3ed0237ae0b89a87a106869970126b57fc6d918746e618cb
+  data.tar.gz: 07d5a7e99984085c71160f714ff91cebb7008ff2d0e5e0e13dbddbb6344f0feaa1c944623480efe6f671d24ab4dc0e1d73b41757e086b0beb6de15acb20b6c39

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/AGENTS.md

@@ -0,0 +1,67 @@
+# AGENTS.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+# Run all tests and linting (default task)
+bundle exec rake
+
+# Run tests only
+bundle exec rspec
+
+# Run a single spec file
+bundle exec rspec spec/multitenancy/theme_spec.rb
+
+# Run a single example by line number
+bundle exec rspec spec/multitenancy/theme_spec.rb:42
+
+# Lint
+bundle exec standardrb
+
+# Auto-fix lint issues
+bundle exec standardrb --fix
+```
+
+## Architecture
+
+This is a Rails gem that implements multitenancy via **per-theme Rails Engines** created dynamically at boot time. Each theme under `themes/` in the host app gets its own isolated engine, namespace, autoload paths, views, assets, and routes.
+
+### Core flow
+
+1. **`Multitenancy::Railtie`** hooks into `before_configuration` and `after_initialize`.
+2. During `before_configuration`, `Integrations::Rails` calls `Theme#bootstrap(app)` for every directory under `themes/`.
+3. `Theme#bootstrap` creates a Ruby module (`Themes::MyStore`), then a `Rails::Engine` subclass (`Themes::MyStore::Engine`) by calling `Theme#create_engine`, which includes a `Stim` instance as a mixin.
+4. **`Stim`** (a `Module` subclass) is the engine configurator: it sets `called_from`, `isolate_namespace`, `config.root`, and registers `app/views`, `app/assets`, `config/locales`, `app/javascript` paths on the engine.
+5. `Theme#inject_paths` registers the theme's autoload directories (controllers, models, services, etc.) with Zeitwerk under the theme's namespace, and adds `app/javascript` to Propshaft's asset paths.
+
+### Key files
+
+| File | Role |
+|------|------|
+| `lib/multitenancy.rb` | Entry point; defines `Multitenancy.themes`, `config.paths`, and triggers Railtie load |
+| `lib/multitenancy/theme.rb` | Represents one theme; owns bootstrap, namespace/engine creation, path injection |
+| `lib/multitenancy/stim.rb` | `Module` subclass used as an `include`-able engine configurator |
+| `lib/multitenancy/controller.rb` | `ActiveSupport::Concern` included in theme application controllers; fixes view path and strips namespace from `_prefixes` |
+| `lib/multitenancy/railtie.rb` | Wires integrations into the Rails boot lifecycle |
+| `lib/multitenancy/integrations/` | Optional integrations (Importmap, TailwindCSS, RSpec, FactoryBot) — each uses a guard clause and is silently skipped if its gem is absent |
+
+### Test setup
+
+Specs run against a dummy Rails app at `spec/dummy/`. The `spec_helper.rb`:
+- Sets `Multitenancy.root` to the dummy app root before each example
+- Calls `Multitenancy.reset!` to clear the themes cache
+- Stubs `autoloaders.main.push_dir` to avoid real Zeitwerk side effects
+- Cleans up dynamically created `Themes::*` constants after each example
+
+The `FakeThemeHelpers` and `RailsStateCleanup` support modules in `spec/support/` provide helpers for creating temporary theme directory structures in tests and restoring Rails global state.
+
+### Integration pattern
+
+Each integration in `lib/multitenancy/integrations/` follows the same pattern: a class with a single `.call(app)` class method, guarded at the top against the optional gem not being present. New integrations should follow this convention.
+
+
+### Commits and Pull Requests
+
+Commits and pull requests should be brief and to the point. Do not include "Co-authored-by" or mention Claude, Codex, OpenCode, Crush in commit messages.

data/CLAUDE.md

@@ -0,0 +1,67 @@
+# AGENTS.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+# Run all tests and linting (default task)
+bundle exec rake
+
+# Run tests only
+bundle exec rspec
+
+# Run a single spec file
+bundle exec rspec spec/multitenancy/theme_spec.rb
+
+# Run a single example by line number
+bundle exec rspec spec/multitenancy/theme_spec.rb:42
+
+# Lint
+bundle exec standardrb
+
+# Auto-fix lint issues
+bundle exec standardrb --fix
+```
+
+## Architecture
+
+This is a Rails gem that implements multitenancy via **per-theme Rails Engines** created dynamically at boot time. Each theme under `themes/` in the host app gets its own isolated engine, namespace, autoload paths, views, assets, and routes.
+
+### Core flow
+
+1. **`Multitenancy::Railtie`** hooks into `before_configuration` and `after_initialize`.
+2. During `before_configuration`, `Integrations::Rails` calls `Theme#bootstrap(app)` for every directory under `themes/`.
+3. `Theme#bootstrap` creates a Ruby module (`Themes::MyStore`), then a `Rails::Engine` subclass (`Themes::MyStore::Engine`) by calling `Theme#create_engine`, which includes a `Stim` instance as a mixin.
+4. **`Stim`** (a `Module` subclass) is the engine configurator: it sets `called_from`, `isolate_namespace`, `config.root`, and registers `app/views`, `app/assets`, `config/locales`, `app/javascript` paths on the engine.
+5. `Theme#inject_paths` registers the theme's autoload directories (controllers, models, services, etc.) with Zeitwerk under the theme's namespace, and adds `app/javascript` to Propshaft's asset paths.
+
+### Key files
+
+| File | Role |
+|------|------|
+| `lib/multitenancy.rb` | Entry point; defines `Multitenancy.themes`, `config.paths`, and triggers Railtie load |
+| `lib/multitenancy/theme.rb` | Represents one theme; owns bootstrap, namespace/engine creation, path injection |
+| `lib/multitenancy/stim.rb` | `Module` subclass used as an `include`-able engine configurator |
+| `lib/multitenancy/controller.rb` | `ActiveSupport::Concern` included in theme application controllers; fixes view path and strips namespace from `_prefixes` |
+| `lib/multitenancy/railtie.rb` | Wires integrations into the Rails boot lifecycle |
+| `lib/multitenancy/integrations/` | Optional integrations (Importmap, TailwindCSS, RSpec, FactoryBot) — each uses a guard clause and is silently skipped if its gem is absent |
+
+### Test setup
+
+Specs run against a dummy Rails app at `spec/dummy/`. The `spec_helper.rb`:
+- Sets `Multitenancy.root` to the dummy app root before each example
+- Calls `Multitenancy.reset!` to clear the themes cache
+- Stubs `autoloaders.main.push_dir` to avoid real Zeitwerk side effects
+- Cleans up dynamically created `Themes::*` constants after each example
+
+The `FakeThemeHelpers` and `RailsStateCleanup` support modules in `spec/support/` provide helpers for creating temporary theme directory structures in tests and restoring Rails global state.
+
+### Integration pattern
+
+Each integration in `lib/multitenancy/integrations/` follows the same pattern: a class with a single `.call(app)` class method, guarded at the top against the optional gem not being present. New integrations should follow this convention.
+
+
+### Commits and Pull Requests
+
+Commits and pull requests should be brief and to the point. Do not include "Co-authored-by" or mention Claude, Codex, OpenCode, Crush in commit messages.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marcos G. Zimmermann
+
+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.