rails_multitenant 0.12.0 → 0.13.0.rc1

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rails_multitenant.gemspec
-gemspec

data/README.md

@@ -1,120 +0,0 @@
-# RailsMultitenant
-
-rails_multitenant is a gem for isolating ActiveRecord models from different tenants. The gem assumes tables storing
-multi-tenant models include an appropriate tenant id column.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rails_multitenant'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rails_multitenant
-
-If you're using Rails, there's nothing else you need to do.
-
-Otherwise, you need to insert `RailsMultitenant::Middleware::IsolatedContextRegistry` into your middleware stack
-
-## Usage
-
-The gem supports two multi-tenancy strategies:
-
-1. Based on a model attribute, typically a foreign key to an entity owned by another service
-2. Based on a model association
-
-The gem uses ActiveRecord default scopes to make isolating tenants fairly transparent.
-
-### Multi-tenancy Based on Model Attributes
-
-The following model is multi-tenant based on an `organization_id` attribute:
-
-```ruby
-class Product < ActiveRecord::Base
-  include RailsMultitenant::MultitenantModel
-
-  multitenant_on :organization_id
-end
-```
-
-The model can then be used as follows:
-
-```ruby
-RailsMultitenant::GlobalContextRegistry[:organization_id] = 'my-org'
-
-# Only returns products from 'my-org'
-Product.all
-
-# Returns products across all orgs
-Product.strip_organization_scope.all
-
-# Or set the current organization in block form
-RailsMultitenant::GlobalContextRegistry.with_isolated_registry(organization_id: 'my-org') do
-  # Only returns products from 'my-org'
-  Product.all
-end
-```
-
-By default this adds an ActiveRecord validation to ensure the multi-tenant attribute is present but this can be disabled
-by passing `required: false` to `multitenant_on`.
-
-### Multi-tenancy Based on Associated Models
-
-The following model is multi-tenant based on an `Organization` model:
-
-```ruby
-class Product < ActiveRecord::Base
-  include RailsMultitenant::MultitenantModel
-
-  multitenant_on_model :organization
-end
-```
-
-The model can then be used as follows:
-
-```ruby
-Organization.current_id = 1
-
-# Only returns products from organization 1
-Product.all
-
-# Use the automatically generated belongs_to association to get
-# a product's organization
-Product.first.organization
-
-# Or set the current organization in block form
-Organization.as_current_id(1) do
-  # Only returns products from organization 1
-  Product.all
-end
-```
-
-By default this adds an ActiveRecord validation to ensure the tenant model is present but this can be disabled
-by passing `required: false` to `multitenant_on_model`.
-
-### Shorthand
-
-When using `rails-multitenant` in a project, it is common to need to set values in `RailsMultitenant::GlobalContextRegistry` at the rails console.
-
-This is difficult to type. Alternatively you can shorten it to `RailsMultitenant`. For example you might type `RailsMultitenant[:organization_id] = 'some value'` and it will have the same effect as the long version.
-
-This is mainly intended as a console convenience. Using the long form in source code is fine, and more explicit.
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/salsify/rails-multitenant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-

data/Rakefile

@@ -1,8 +0,0 @@
-require 'bundler/gem_tasks'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.verbose = false
-end
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rails_multitenant"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/gemfiles/rails_4.2.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sqlite3", "~> 1.3.6"
-gem "activerecord", "4.2.11.1"
-gem "activesupport", "4.2.11.1"
-
-gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sqlite3", "~> 1.3.6"
-gem "activerecord", "5.0.7.2"
-gem "activesupport", "5.0.7.2"
-
-gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.1.7"
-gem "activesupport", "5.1.7"
-
-gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.2.3"
-gem "activesupport", "5.2.3"
-
-gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "6.0.0.rc2"
-gem "activesupport", "6.0.0.rc2"
-
-gemspec path: "../"

data/rails_multitenant.gemspec

@@ -1,32 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rails_multitenant/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "rails_multitenant"
-  spec.version       = RailsMultitenant::VERSION
-  spec.authors       = ["Pat Breault"]
-  spec.email         = ["pbreault@salsify.com"]
-  spec.summary       = %q{Automatically configures multiple tenants in a Rails environment}
-  spec.description   = %q{Handles multiple tenants in a Rails environment}
-  spec.homepage      = "https://github.com/salsify/rails-multitenant"
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.test_files    = Dir.glob('spec/**/*')
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 2.4.0'
-
-  spec.add_dependency 'activerecord', '>= 4.2', '< 6.1'
-  spec.add_dependency 'activesupport', '>= 4.2', '< 6.1'
-
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'database_cleaner', '>= 1.2'
-  spec.add_development_dependency 'rake', '>= 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
-  spec.add_development_dependency 'simplecov', '~> 0.15.1'
-  spec.add_development_dependency 'sqlite3', '~> 1.4.0'
-end

data/spec/be_multitenant_on_matcher_spec.rb

@@ -1,15 +0,0 @@
-require 'rails_multitenant/rspec'
-
-describe "be_multitenant_on matcher" do
-  it "accepts a valid context field id" do
-    expect(ExternalItem).to be_multitenant_on(:external_organization_id)
-  end
-
-  it "rejects an invalid context field id" do
-    expect(ExternalItem).not_to be_multitenant_on(:other_field)
-  end
-
-  it "rejects classes that don't have a context field id" do
-    expect(String).not_to be_multitenant_on(:other_field)
-  end
-end

data/spec/current_spec.rb

@@ -1,118 +0,0 @@
-describe RailsMultitenant::GlobalContextRegistry::Current do
-
-  class TestClass
-    include RailsMultitenant::GlobalContextRegistry::Current
-    provide_default :new
-
-    attr_accessor :id
-
-    def initialize(id: :default)
-      @id = id
-    end
-  end
-
-  class SubClass < TestClass
-  end
-
-  class DependentClass
-    include RailsMultitenant::GlobalContextRegistry::Current
-    provide_default { new }
-    global_context_dependent_on TestClass
-  end
-
-  class NoDefaultTestClass
-    include RailsMultitenant::GlobalContextRegistry::Current
-  end
-
-  describe 'current' do
-    it 'returns default value when supplied' do
-      expect(TestClass.current.id).to eq(:default)
-      expect(SubClass.current.id).to eq(:default)
-    end
-
-    it 'returns nil when no default supplied' do
-      expect(NoDefaultTestClass.current).to be_nil
-    end
-  end
-
-  describe 'current!' do
-    it 'returns current value when set' do
-      expect(TestClass.current.id).to eq(:default)
-    end
-
-    it 'raises an error when current not set' do
-      NoDefaultTestClass.clear_current!
-      expect { NoDefaultTestClass.current! }.to raise_error('No current NoDefaultTestClass set')
-    end
-  end
-
-  describe 'current=' do
-    it 'stores the provided object' do
-      provided = TestClass.new(id: :provided)
-      TestClass.current = provided
-      expect(TestClass.current).to equal(provided)
-    end
-
-    it 'clears dependencies' do
-      dependent = DependentClass.current
-      TestClass.current = TestClass.new
-      expect(DependentClass.current).not_to equal(dependent)
-    end
-  end
-
-  describe 'current?' do
-    it 'returns false when uninitialized' do
-      TestClass.clear_current!
-      expect(TestClass.current?).to be false
-    end
-
-    it 'returns true when initialized' do
-      TestClass.current = TestClass.new
-      expect(TestClass.current?).to be true
-    end
-  end
-
-  describe 'as_current' do
-    let(:test_class1) { TestClass.new }
-    let(:test_class2) { TestClass.new }
-
-    it 'sets and restores current' do
-      TestClass.current = test_class1
-      TestClass.as_current(test_class2) do
-        expect(TestClass.current).to equal(test_class2)
-      end
-      expect(TestClass.current).to equal(test_class1)
-    end
-  end
-
-  context 'instance methods' do
-    describe 'current?' do
-      it 'returns false when not the current instance' do
-        TestClass.clear_current!
-        expect(TestClass.new.current?).to be false
-
-        TestClass.current = TestClass.new
-        expect(TestClass.new.current?).to be false
-      end
-
-      it 'returns true when it is the current instance' do
-        test_class = TestClass.new
-        TestClass.current = test_class
-        expect(test_class.current?).to be true
-      end
-    end
-
-    describe 'as_current' do
-      let(:test_class1) { TestClass.new }
-      let(:test_class2) { TestClass.new }
-
-      it 'sets and restores current' do
-        TestClass.current = test_class1
-        test_class2.as_current do
-          expect(TestClass.current).to equal(test_class2)
-        end
-        expect(TestClass.current).to equal(test_class1)
-      end
-    end
-  end
-end

data/spec/db/database.yml

@@ -1,3 +0,0 @@
-sqlite3:
-  adapter: sqlite3
-  database: ":memory:"

data/spec/db/schema.rb

@@ -1,60 +0,0 @@
-# encoding: UTF-8
-
-ActiveRecord::Schema.define(version: 0) do
-
-  create_table(:organizations, force: true)
-
-  create_table(:dependent_models, force: true)
-
-  create_table(:items, force: true) do |t|
-    t.integer :organization_id
-    t.string :type
-  end
-
-  create_table(:item_with_optional_orgs, force: true) do |t|
-    t.integer :organization_id
-    t.string :type
-  end
-
-  create_table(:external_items, force: true) do |t|
-    t.integer :external_organization_id
-  end
-
-  create_table(:external_item_with_optional_orgs, force: true) do |t|
-    t.integer :external_organization_id
-  end
-end
-
-class Organization < ActiveRecord::Base
-  include RailsMultitenant::GlobalContextRegistry::CurrentInstance
-end
-
-class DependentModel < ActiveRecord::Base
-  include RailsMultitenant::GlobalContextRegistry::CurrentInstance
-  global_context_dependent_on Organization
-end
-
-class Item < ActiveRecord::Base
-  include RailsMultitenant::MultitenantModel
-  multitenant_on_model :organization
-end
-
-class ItemWithOptionalOrg < ActiveRecord::Base
-  include RailsMultitenant::MultitenantModel
-  multitenant_on_model :organization, required: false
-end
-
-class ItemSubtype < Item
-
-end
-
-class ExternalItem < ActiveRecord::Base
-  include RailsMultitenant::MultitenantModel
-  multitenant_on :external_organization_id
-end
-
-class ExternalItemWithOptionalOrg < ActiveRecord::Base
-  include RailsMultitenant::MultitenantModel
-  multitenant_on :external_organization_id, required: false
-end
-

data/spec/external_item_spec.rb

@@ -1,36 +0,0 @@
-include RailsMultitenant
-
-describe ExternalItem do
-
-  let!(:external_item1) { as_external_org(1) { ExternalItem.create! } }
-
-  let!(:external_item2) { as_external_org(2) { ExternalItem.create! } }
-  let!(:external_item3) { as_external_org(2) { ExternalItem.create! } }
-
-  specify 'org1 has the correct external items' do
-    as_external_org(1) do
-      expect(ExternalItem.all).to eq [external_item1]
-    end
-  end
-
-  specify 'org2 has the correct external items' do
-    as_external_org(2) do
-      expect(ExternalItem.all).to match_array [external_item2, external_item3]
-    end
-  end
-
-  it 'does not return external items from other orgs' do
-    as_external_org(2) do
-      expect(ExternalItem.where(id: external_item1.id)).to eq []
-    end
-  end
-
-  it 'allows the organization scope to be removed' do
-    expect(ExternalItem.strip_external_organization_scope.count).to eq 3
-  end
-
-  def as_external_org(id, &block)
-    GlobalContextRegistry.with_isolated_registry(external_organization_id: id, &block)
-  end
-
-end