simply_the_tenant 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '052989680f273776dd26e7decbe5928bbb5c8062b683ca12683f6842ec0d1eb7'
+  data.tar.gz: cda1b3f3b4985dad3a0c1b74cbadb8ae161702575fd28ec1db32ff1a1357c2c1
+SHA512:
+  metadata.gz: 19840f4d70c359dedd629047bfa7da3b9f79b81c0fc794925782dc8a509b19afd94b3330e0b9718b7a536220ae072b8f45a1f581c68dc10045f61169ff5f4982
+  data.tar.gz: af1aee722e97ee874a5e69b93bb299d06713e6f92ba9c184836b991f6c01f64730736ccef6bc441a7fa8b6e9e2977b8a0cc45250390bc5ea8e0be76fbd1c82a0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Ethan Kircher
+
+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,76 @@
+# SimplyTheTenant
+Short description and motivation.
+
+A simpler alternative to [`acts_as_tenant`](https://github.com/ErwinM/acts_as_tenant). For most applications [`acts_as_tenant`](https://github.com/ErwinM/acts_as_tenant) is probably what you should reach for, it's battletested, and more feature rich.
+
+So, that begs the question, what is the point of this gem at all?
+
+1. I just kinda wanted to write a multitenancy gem. For basically any applications, prefer `acts_as_tenant`, since it's battletested.
+2. `acts_as_tenant` uses `ActiveSupport::CurrentAttributes` under the hood, but that isn't exposed to the user. While that isn't exactly hard to add with `acts_as_tenant`, `simply_the_tenant` does this out of the box.
+3. `simply_the_tenant` adheres to your domain model. `Current.account` vs `current_tenant`, making things marginally easier to reason about.
+4. `simply_the_tenant` uses Rails 7 `query_constraints`, so certain queries will use compound indices, which is nice for anyone who wants to use composite primary keys or sharding.
+5. `simply_the_tenant` requires _explicit_ scoping to access the data of a tenant or global data.
+
+Overall, `acts_as_tenant` does do all of the things this gem does. `simply_the_tenant` just presents them in a different way and provides less configuration options. If that pleases you, feel free to use `simply_the_tenant` instead!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "simply_the_tenant"
+```
+
+# Getting started
+Setting up `simply_the_tenant` is essentially identical to `acts_as_tenant`. But, a thing to keep in mind is that `simply_the_tenatn` is strict about naming. There is currently no way to tell `simply_the_tenant` what foreign key to use.
+
+## Model Setup
+```ruby
+class MyTenant < ApplicationRecord
+  simply_the_tenant
+end
+```
+
+Anything that belongs to the `MyTenant` _must_ have a `my_tenant_id` column.
+```ruby
+class User < ApplicationRecord
+  belongs_to_tenant :my_tenant
+end
+```
+
+This will set up a default scope, query constraints, automatic setting of `my_tenant_id` and validations for the tenant.
+
+You'll also need to setup a `Current` model if you don't already have one.
+```ruby
+class Current < ActiveSupport::CurrentAttributes
+  attribute :my_tenant
+end
+```
+
+## Controller Setup
+`simply_the_tenant` uses the last subdomain from a request to determine the tenant to scope a given request to. There is currently no way to change this in `simple_tenant`
+
+```ruby
+class ApplicationController < ActionController::Base
+  sets_current_tenant :my_tenant
+
+  def some_cool_action
+    # Current.my_tenant is accessible here automatically
+  end
+end
+```
+
+## Background Processing
+`simply_the_tenant` currently doesn't support automatically setting the tenant for any background processing libraries out of the box. This will change shortly.
+
+## Testing
+`simply_the_tenant` also doesn't support automatically setting the tenant for any testing libraries out of the box. This will change shortly.
+
+## Contributing
+1. Fork the repo
+2. Make changes
+3. Run the tests `bundle exec appraisals bin/test`
+4. Run the linter `bundle exec rubocop`
+5. Submit a PR
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/simply_the_tenant/controller_ext.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SimplyTheTenant
+  module ControllerExt
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def sets_current_tenant(name)
+        SimplyTheTenant.tenant_class = name.to_s.classify.constantize
+
+        around_action(:with_current_tenant)
+      end
+    end
+
+    included do
+      def with_current_tenant(&block)
+        SimplyTheTenant.tenant = find_tenant_by_subdomain
+
+        SimplyTheTenant.with_tenant(SimplyTheTenant.tenant, &block)
+      end
+
+      def with_global_access(&block)
+        SimplyTheTenant.with_global_access(&block)
+      end
+
+      private
+
+      def find_tenant_by_subdomain
+        SimplyTheTenant.tenant_class.find_by!(subdomain: tenant_subdomain)
+      end
+
+      def tenant_subdomain
+        subdomain = request.subdomains.last
+
+        raise SimplyTheTenant::NoSubdomainError if subdomain.blank?
+
+        subdomain
+      end
+    end
+  end
+end

data/lib/simply_the_tenant/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SimplyTheTenant
+  class Engine < ::Rails::Engine
+    engine_name :simply_the_tenant
+    isolate_namespace SimplyTheTenant
+  end
+end

data/lib/simply_the_tenant/model_ext.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SimplyTheTenant
+  module ModelExt
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def simply_the_tenant
+        SimplyTheTenant.tenant_class = self if SimplyTheTenant.tenant_class.blank?
+      end
+
+      def belongs_to_tenant(tenant_name)
+        SimplyTheTenant.tenant_class = tenant_name.to_s.classify.constantize if SimplyTheTenant.tenant_class.blank?
+
+        belongs_to(tenant_name)
+
+        validates(tenant_name, presence: true)
+
+        before_validation(:set_tenant, on: :create)
+
+        query_constraints(SimplyTheTenant.tenant_id, :id)
+
+        default_scope do
+          if SimplyTheTenant.global_access?
+            all
+          else
+            tenant_id = SimplyTheTenant.tenant_id
+            tenant = SimplyTheTenant.tenant
+
+            raise SimplyTheTenant::NoTenantSetError if tenant.blank?
+
+            where(tenant_id => tenant.id)
+          end
+        end
+      end
+    end
+
+    included do
+      private
+
+      define_method("set_tenant") do
+        tenant_name = SimplyTheTenant.tenant_name
+        tenant_id = SimplyTheTenant.tenant_id
+
+        return if send(tenant_id).present?
+
+        send("#{tenant_name}=", SimplyTheTenant.tenant)
+      end
+    end
+  end
+end

data/lib/simply_the_tenant/version.rb

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

data/lib/simply_the_tenant.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "simply_the_tenant/version"
+require "simply_the_tenant/engine"
+
+module SimplyTheTenant
+  autoload :ModelExt, "simply_the_tenant/model_ext"
+  autoload :ControllerExt, "simply_the_tenant/controller_ext"
+
+  @@tenant_class = nil
+  @@global_access = false
+
+  class << self
+  end
+  def self.tenant_class
+    @@tenant_class
+  end
+
+  def self.tenant_class=(klass)
+    @@tenant_class = klass
+  end
+
+  def self.tenant_name
+    @@tenant_class.name.underscore.to_sym
+  end
+
+  def self.tenant_id
+    "#{tenant_name}_id"
+  end
+
+  def self.tenant
+    raise CurrentNeedsTenantError unless Current.respond_to?(tenant_name)
+
+    Current.public_send(tenant_name)
+  end
+
+  def self.tenant=(tenant)
+    raise CurrentNeedsTenantError unless Current.respond_to?("#{tenant_name}=")
+
+    Current.public_send("#{tenant_name}=", tenant)
+  end
+
+  def self.with_global_access
+    @@global_access = true
+
+    yield
+  ensure
+    @@global_access = false
+  end
+
+  def self.global_access?
+    @@global_access
+  end
+
+
+  def self.with_tenant(tenant)
+    raise NilTenantError if tenant.nil?
+
+    previous_tenant = self.tenant
+    self.tenant = tenant
+
+    yield
+  ensure
+    self.tenant = previous_tenant
+  end
+
+  class NilTenantError < StandardError
+    def initialize
+      super("Cannot set a nil tenant.")
+    end
+  end
+
+  class MultipleTenantError < StandardError
+    def initialize
+      super("Multiple tenant classes are not supported.")
+    end
+  end
+
+  class NoTenantSetError < StandardError
+    def initialize
+      super("No tenant class has been set. Use `SimplyTheTenant.with_tenant` to set a tenant, " \
+        "or `SimplyTheTenant.with_global_access` to bypass tenant scoping.")
+    end
+  end
+
+  class CurrentNeedsTenantError < StandardError
+    def initialize
+      super("Current needs to respond to the tenant class name. Use `attribute :{tenant_name}` to define the method.")
+    end
+  end
+
+  class NoSubdomainError < StandardError
+    def initialize
+      super("No subdomain found in request. Ensure that the request has a subdomain, " \
+        "or override `tenant_subdomain` to provide a custom subdomain.")
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include SimplyTheTenant::ModelExt
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include SimplyTheTenant::ControllerExt
+end

data/lib/tasks/simply_the_tenant_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :simply_the_tenant do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: simply_the_tenant
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ethan Kircher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: A simple multi-tenant solution for Rails.
+email:
+- ethanmichaelk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/simply_the_tenant.rb
+- lib/simply_the_tenant/controller_ext.rb
+- lib/simply_the_tenant/engine.rb
+- lib/simply_the_tenant/model_ext.rb
+- lib/simply_the_tenant/version.rb
+- lib/tasks/simply_the_tenant_tasks.rake
+homepage: https://github.com/MSILycanthropy/simply_the_tenant
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MSILycanthropy/simply_the_tenant
+  source_code_uri: https://github.com/MSILycanthropy/simply_the_tenant
+  changelog_uri: https://github.com/MSILycanthropy/simply_the_tenant/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: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key: 
+specification_version: 4
+summary: A simple multi-tenant solution for Rails.
+test_files: []