rails_multitenant 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff528a38b03db9f83d9665fc802a577fa10cc0cb
-  data.tar.gz: d75fb03a0907977a6f18cf1fdc8a32a183179e88
+  metadata.gz: b26ac97762bed39380b26b1f08db3198f3d7d91f
+  data.tar.gz: ef72bdd22908dfc9e150c168655db4f42ae26738
 SHA512:
-  metadata.gz: a3fd2430828d14280bd19414b20079814babd2ae01d67eb783b2130e2ddb029bde5521ee3dd6cec73ed2e7150637be99ab83c4d635db0d450f072ec28a3a8688
-  data.tar.gz: dd556073c42ef36665285a03018e2042375b815195a879687ddbe8c65d79f643a612c359425d88d6f006e0f16813b34c3e95e4d519af82cf79409b8b4c5ce43a
+  metadata.gz: 046aaf25a46bd08c344718ec700344b441f3b8131667f4295e0b7c6cdd7a5d2de17320356f6a94b43a8ae68907b4071a59352b6bbf0f04edcf9e693093d25ad6
+  data.tar.gz: 2d1d346080098b3989eae5a089aa4a1d426081a1ce7413c718d81e60c2425076c9c2fc75387f7067414d873d55cbd29922ed94eb28206b871e241bc52b05d163

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 0.5.0
+* Add `required` option to `multitenant_on` and `multitenant_on_model`.
+
 ### 0.4.0
 * Fix be_multitenant_on matcher to handle models that don't include the `RailsMultitenant::MultitenantModel` module.
 * Fix `context_entity_id_field` to work with inheritance.

data/README.md

@@ -58,6 +58,9 @@ RailsMultitenant::GlobalContextRegistry.with_isolated_registry(organization_id:
 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:
@@ -89,6 +92,9 @@ Organization.as_current_id(1) do
 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`.
+
 ## 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.

data/lib/rails_multitenant/multitenant_model.rb

@@ -8,9 +8,9 @@ module RailsMultitenant
 
     module ClassMethods
 
-      def multitenant_on(context_entity_id_field)
+      def multitenant_on(context_entity_id_field, required: true)
         self.context_entity_id_field = context_entity_id_field
-        validates_presence_of context_entity_id_field
+        validates_presence_of(context_entity_id_field) if required
 
         context_entity = context_entity_id_field.to_s.gsub(/_id$/, '')
         scope_sym = "from_current_#{context_entity}".to_sym
@@ -26,9 +26,17 @@ module RailsMultitenant
         end
       end
 
-      def multitenant_on_model(context_entity)
-        multitenant_on("#{context_entity}_id".to_sym)
-        belongs_to context_entity
+      def multitenant_on_model(context_entity, required: true)
+        multitenant_on("#{context_entity}_id".to_sym, required: required)
+
+        if ActiveRecord::VERSION::MAJOR < 5
+          belongs_to(context_entity)
+        else
+          # Rails 5 added required validation to belongs_to associations and
+          # an `optional` setting to disable it. We already do validation on
+          # the foreign key so we always disable the native Rails validation.
+          belongs_to(context_entity, optional: true)
+        end
       end
 
       def validates_multitenant_uniqueness_of(*attr_names)

data/lib/rails_multitenant/version.rb

@@ -1,3 +1,3 @@
 module RailsMultitenant
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/db/schema.rb

@@ -9,9 +9,18 @@ ActiveRecord::Schema.define(version: 0) do
     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
@@ -23,6 +32,11 @@ class Item < ActiveRecord::Base
   multitenant_on_model :organization
 end
 
+class ItemWithOptionalOrg < ActiveRecord::Base
+  include RailsMultitenant::MultitenantModel
+  multitenant_on_model :organization, required: false
+end
+
 class ItemSubtype < Item
 
 end
@@ -32,3 +46,8 @@ class ExternalItem < ActiveRecord::Base
   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_with_optional_org_spec.rb

@@ -0,0 +1,25 @@
+include RailsMultitenant
+
+describe ExternalItemWithOptionalOrg do
+
+  let!(:external_item_without_org) { as_external_org(nil) { described_class.create! } }
+
+  let!(:external_item_with_org) { as_external_org(1) { described_class.create! } }
+  let!(:external_item_with_other_org) { as_external_org(2) { described_class.create! } }
+
+  specify 'the nil org has the correct external items' do
+    as_external_org(nil) do
+      expect(described_class.all).to eq([external_item_without_org])
+    end
+  end
+
+  specify 'org1 has the correct external items' do
+    as_external_org(1) do
+      expect(described_class.all).to eq([external_item_with_org])
+    end
+  end
+
+  def as_external_org(id, &block)
+    GlobalContextRegistry.with_isolated_registry(external_organization_id: id, &block)
+  end
+end

data/spec/item_with_optional_org_spec.rb

@@ -0,0 +1,26 @@
+describe ItemWithOptionalOrg do
+
+  let!(:item_without_org) { without_org { described_class.create! } }
+
+  let!(:org) { Organization.create! }
+  let!(:item_with_org) { org.as_current { described_class.create! } }
+
+  let!(:other_org) { Organization.create! }
+  let!(:item_with_other_org) { other_org.as_current { described_class.create! } }
+
+  it "returns the correct items when no org is set" do
+    without_org do
+      expect(described_class.all).to eq([item_without_org])
+    end
+  end
+
+  it "returns the correct items when an org is set" do
+    org.as_current do
+      expect(described_class.all).to eq([item_with_org])
+    end
+  end
+
+  def without_org(&block)
+    GlobalContextRegistry.with_isolated_registry(&block)
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,11 @@ SimpleCov.start do
  add_filter 'spec'
 end
 
+require 'active_record'
+if ActiveRecord::VERSION::MAJOR >= 5
+  ActiveRecord::Base.belongs_to_required_by_default = true
+end
+
 require 'logger'
 require 'database_cleaner'
 require 'rails_multitenant'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multitenant
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Pat Breault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,42 +28,30 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -176,9 +164,11 @@ files:
 - spec/db/database.yml
 - spec/db/schema.rb
 - spec/external_item_spec.rb
+- spec/external_item_with_optional_org_spec.rb
 - spec/global_context_registry_spec.rb
 - spec/item_spec.rb
 - spec/item_subtype_spec.rb
+- spec/item_with_optional_org_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/salsify/rails_multitenant
 licenses:
@@ -209,7 +199,9 @@ test_files:
 - spec/db/database.yml
 - spec/db/schema.rb
 - spec/external_item_spec.rb
+- spec/external_item_with_optional_org_spec.rb
 - spec/global_context_registry_spec.rb
 - spec/item_spec.rb
 - spec/item_subtype_spec.rb
+- spec/item_with_optional_org_spec.rb
 - spec/spec_helper.rb