mongoid_relations_dirty_tracking 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9837bae013e0fe89a8bb531757c816d1dc38b7e31403f9643586118b5521aaa
-  data.tar.gz: 9647a270f2a5f0ffd21de9ea56fcc731c9dc2a6a82fd926480f4501dd63757fa
+  metadata.gz: 44359853dbe1f4805290ec30672bcf1c77fa3a8b375a68d498e357da29ba4ecb
+  data.tar.gz: 28b569c12cee5b59c80ae45357ee7163f2f31cc2cb38c2ab1ca381537b721ce1
 SHA512:
-  metadata.gz: 8ec976a88682181f89c9530a5b52e58a0a35458353251d6fc696d15c05130c416a56683345511b81d6d7f34f69c4f76f7451ffec5dd5e83eb0f61118bcbc4ecc
-  data.tar.gz: 106958a9cebef15a89312a5aab3d580f7f0131145b9968507dfa3471eb8d52fa50b191af03609b78e0c6c3d6b23da80e8bb21c32385b915f60ed22abf2785915
+  metadata.gz: c82ea278398bbce4402d08e8c87c2dc9f8afe5e253427a09afaa6604fc3888ac9ae2ab309f329d61c58bdb1931f91430abe2bc3b72ca62cd204901dcd7732fc3
+  data.tar.gz: 79dbc5a60ddcf8223b8623b1953483695cfef6920d6cb5c03042590e92a93aceb8fc792955f472904537650c38748d59467ca01ec72cb1131e7ced408fc1bbec

data/README.md

@@ -47,11 +47,34 @@ doc.changed_with_relations? # => false
 doc.changes_with_relations  # => {}
 ```
 
-### Global Disable
+## Disablement
 
-Relations dirty tracking can be resource intensive.
-You may disable it for a block scope. This is thread-safe
-and will use the [RequestStore gem](https://github.com/steveklabnik/request_store)
+Relations dirty tracking can be resource intensive,
+hence you may wish to disable it dynamically.
+
+#### When using .only?
+
+If you query objects with the `.only?(*fields)` modifier, Mongoid
+itself marks the objects as `readonly` and attempts to save them will fail.
+In this case, relations dirty tracking is automatically disabled.
+
+```ruby
+Mongoid::RelationsDirtyTracking.disable do
+  doc = SampleDocument.all.only(:title).first
+  doc.foo = Foo.new(title: 'foo')
+  doc.bars << Bar.new(title: 'bar')
+
+  doc.relations_changed? # => false
+  doc.relation_changes   # => {}
+ 
+  doc.save! #=> raises Mongoid::Errors::ReadonlyDocument
+end
+```
+
+#### Within a block scope
+
+You may disable relations dirty tracking for a given block.
+This is thread-safe and will use the [RequestStore gem](https://github.com/steveklabnik/request_store)
 if it is included in your project.
 
 ```ruby
@@ -60,8 +83,8 @@ Mongoid::RelationsDirtyTracking.disable do
   doc.foo = Foo.new(title: 'foo')
   doc.bars << Bar.new(title: 'bar')
 
-  doc.relations_changed?      # => false
-  doc.relation_changes        # => {}
+  doc.relations_changed? # => false
+  doc.relation_changes   # => {}
 end
 ```
 

data/lib/mongoid/relations_dirty_tracking.rb

@@ -49,6 +49,7 @@ module Mongoid
                       Mongoid::Association::Referenced::HasMany::Proxy,
                       Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy,
                       Mongoid::Association::Referenced::BelongsTo::Proxy]
+
         to_track && trackables.include?(relations[rel_name].try(:relation))
       end
 
@@ -66,14 +67,14 @@ module Mongoid
 
       def store_relations_shadow
         @relations_shadow = {}
-        return unless Mongoid::RelationsDirtyTracking.enabled?
+        return if readonly? || !Mongoid::RelationsDirtyTracking.enabled?
         self.class.tracked_relations.each do |rel_name|
           @relations_shadow[rel_name] = tracked_relation_attributes(rel_name)
         end
       end
 
       def relation_changes
-        return {} unless Mongoid::RelationsDirtyTracking.enabled?
+        return {} if readonly? || !Mongoid::RelationsDirtyTracking.enabled?
         changes = {}
         @relations_shadow.each_pair do |rel_name, shadow_values|
           current_values = tracked_relation_attributes(rel_name)

data/lib/mongoid/relations_dirty_tracking/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid
   module RelationsDirtyTracking
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/spec/lib/mongoid/relations_dirty_tracking_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Mongoid::RelationsDirtyTracking do
-  subject { TestDocument.create }
+  subject(:doc) { TestDocument.create }
 
   its(:changed?)                { is_expected.to eq false }
   its(:children_changed?)       { is_expected.to eq false }
@@ -372,26 +372,49 @@ describe Mongoid::RelationsDirtyTracking do
     end
   end
 
+  describe 'disable if readonly?' do
+    subject do
+      doc
+      TestDocument.all.only(:one_related_id).first
+    end
+
+    before :each do
+      @embedded_doc = TestEmbeddedDocument.new
+
+      subject.many_documents << @embedded_doc
+    end
+
+    its(:changed?)                { is_expected.to eq false }
+    its(:children_changed?)       { is_expected.to eq false }
+    its(:relations_changed?)      { is_expected.to eq false }
+    its(:changed_with_relations?) { is_expected.to eq false }
+    its(:changes_with_relations)  { is_expected.to_not include(subject.relation_changes) }
+
+    describe '#relation_changes' do
+      it 'returns array with differences' do
+        expect(subject.relation_changes['many_documents']).to eq(nil)
+      end
+    end
+  end
+
   describe 'global disablement' do
-    context 'when adding document' do
-      before :each do
-        @embedded_doc = TestEmbeddedDocument.new
+    before :each do
+      @embedded_doc = TestEmbeddedDocument.new
 
-        described_class.disable do
-          subject.many_documents << @embedded_doc
-        end
+      described_class.disable do
+        subject.many_documents << @embedded_doc
       end
+    end
 
-      its(:changed?)                { is_expected.to eq false }
-      its(:children_changed?)       { is_expected.to eq false }
-      its(:relations_changed?)      { is_expected.to eq false }
-      its(:changed_with_relations?) { is_expected.to eq false }
-      its(:changes_with_relations)  { is_expected.to_not include(subject.relation_changes) }
+    its(:changed?)                { is_expected.to eq false }
+    its(:children_changed?)       { is_expected.to eq false }
+    its(:relations_changed?)      { is_expected.to eq false }
+    its(:changed_with_relations?) { is_expected.to eq false }
+    its(:changes_with_relations)  { is_expected.to_not include(subject.relation_changes) }
 
-      describe '#relation_changes' do
-        it 'returns array with differences' do
-          expect(subject.relation_changes['many_documents']).to eq(nil)
-        end
+    describe '#relation_changes' do
+      it 'returns array with differences' do
+        expect(subject.relation_changes['many_documents']).to eq(nil)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_relations_dirty_tracking
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - David Sevcik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport