rails_multitenant 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa50760b463e1f9b31abc6a19d13e863dc5604a
-  data.tar.gz: 7af84280e893555c5c40a4e55cfad57bba8d4252
+  metadata.gz: 316a055e8cc0d31080584671093b6dc56f022699
+  data.tar.gz: 50c5641c12bd0d5b8e2c80b74a8c4a2b9aa10dc7
 SHA512:
-  metadata.gz: b7aca78e340f93da77d625dae54d1c372053fe732032ec7f4acf2b651a436d75fa502895ef212df9a37318a080bf683fa0d4ed785301138bc79ff70d20d06be3
-  data.tar.gz: 91f20b900cd76a6e8afae4ebd8d239b456c74ea1cc0170d660e05109156ac2b28c459fd330c54d56169de7efda6ee935489f1b64fc8697d3e69ed86c33181558
+  metadata.gz: 7008b9aeae0c543d437198f5e14037183e79a871579d966e0b8ca7b60c037697cdfa698f92666e9d4ba216ee5abb492156b5a9cf86675d6d975cb9f2e1cee5a9
+  data.tar.gz: d98d65403a5f4bb5eaffbf20d265fd9755734567eff9df23d9cbcfde833fc981199011da8ef9dbbacaa6564f0b640c59452537b21874508998064dfdd0e44919

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-### 0.2.0 (unreleased)
+### 0.3.0
+* Modify `RailsMultitenant::GlobalContextRegistry#new_registry` to accept an arg
+  specifying the new registry to set. The previous registry is still returned.
+
+### 0.2.0
 * Merged [PR 2](https://github.com/salsify/rails-multitenant/pull/2) which adds support for 
   multi-tenancy based on a foreign key to an external model. As part of this the `multitenant_model_on`
   method was renamed to `multitenant_on_model`.

data/README.md

@@ -1,8 +1,7 @@
 # RailsMultitenant
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_multitenant`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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
 
@@ -22,7 +21,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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
+```
+
+### 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
+```
 
 ## Development
 
@@ -32,5 +97,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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.
+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/lib/rails_multitenant/global_context_registry.rb

@@ -164,8 +164,7 @@ module RailsMultitenant
 
     # Run a block of code with an the given registry
     def with_isolated_registry(registry = {})
-      prior_globals = globals
-      self.globals = registry
+      prior_globals = new_registry(registry)
       yield
     ensure
       self.globals = prior_globals
@@ -175,10 +174,10 @@ module RailsMultitenant
     # Note: these methods are intended for use in a manner like .with_isolated_registry,
     # but in contexts where around semantics are not allowed.
 
-    # Set a new, empty registry, returning the previous one.
-    def new_registry
+    # Set a new, by default empty registry, returning the previous one.
+    def new_registry(registry = {})
       priors = globals
-      self.globals = {}
+      self.globals = registry
       priors
     end
 

data/lib/rails_multitenant/version.rb

@@ -1,3 +1,3 @@
 module RailsMultitenant
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/global_context_registry_spec.rb

@@ -50,7 +50,7 @@ describe GlobalContextRegistry do
     let!(:old_registry) { GlobalContextRegistry.new_registry }
 
     specify do
-      expect(old_registry).to eq ({ foo: 'bar' })
+      expect(old_registry).to eq({ foo: 'bar' })
     end
     specify do
       expect(GlobalContextRegistry.get(:foo)).to be_nil
@@ -59,6 +59,20 @@ describe GlobalContextRegistry do
       GlobalContextRegistry.replace_registry(old_registry)
       expect(GlobalContextRegistry.get(:foo)).to eq 'bar'
     end
+
+    context 'when a new registry is specified' do
+      let!(:old_registry) { GlobalContextRegistry.new_registry(bar: 'foo') }
+
+      specify do
+        expect(old_registry).to eq({ foo: 'bar' })
+      end
+      specify do
+        expect(GlobalContextRegistry.get(:foo)).to be_nil
+      end
+      specify do
+        expect(GlobalContextRegistry.get(:bar)).to eq 'foo'
+      end
+    end
   end
 
   describe '.duplicate_registry' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multitenant
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pat Breault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Automatically configures multiple tenants in a Rails environment