mongoid-simple-userstamps 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb3debfc6e1e3ff58dc489d52e8e39d1d103766f1aae5f22518d4921f59071d1
-  data.tar.gz: 6c9ae82db5763d527e98017773877ca4fb89e6755f4f8e305ee7a5c8b4850465
+  metadata.gz: aab39d23775b21fb081e9ba7da53188179a0c61c4dc134d4fa048a8bc2cbd03a
+  data.tar.gz: e0c17a42b7ba147cdc12506c8b5f611c1acf17b0305bfbd6f1f1125c3575db14
 SHA512:
-  metadata.gz: 2efcc441865a2a86443adc6a83daeeafde70a20c8ca9a6d4bfb7807b2807b5fe3883733757a6b8f00eac36fb79d4a67d9f40c06813815d5afd3f21863e13107b
-  data.tar.gz: 0d9c86ec9d0933bd334051b75f4b820344f9250780cb4fa0010d9562c86caef635c161a24a4bf68415f17fd3c813ee15ba48d2000a3926aedb81f1974936ff16
+  metadata.gz: e3c83b0bd230dccb46428a0623f324806f94045e2427948750c06083e106eb443b8c2e02b62ce37a110a9c1086f22e6c77f87d724a71bee2aa9be96bbae1cdf5
+  data.tar.gz: e6e954d1a673270fa9dcfffc319d7da666d8c7eb85a8474678c50cc8d49286378652e33610ff058d170aec18b8c0af1425f0033761a5c60ae28f28c5fd6c0ca9

data/README.md

@@ -40,15 +40,35 @@ Or install it yourself as:
   user = User.create
   Mongoid::Userstamps::User.current = user
 
-  pòst = Post.create
-  post.created_by # <User _id: 57305c268675c32e1c70a17e >
+  post = Post.create
+  post.created_by # <User _id: 1 >
   post.updated_by # nil
 
-  post.title = 'title'
-  post.save
-  post.updated_by # <User _id: 57305c268675c32e1c70a17e >
+  post.update(title: 'title')
+  post.updated_by # <User _id: 1 >
+
+  # set manually
+  other_user = User.create
+  post.update(updated_by: other_user)
+  post.updated_by # <User _id: 2 >
+
+  # skip userstamps
+  post.skip_userstamps.update(title: 'new_title')
+  post.updated_by # <User _id: 2 >
 ```
 
+## Preservation of Manually-set Values
+
+* The `creator` is only set during the creation of new models (`before_create` callback).
+Mongoid::Userstamps will not overwrite the `creator` field if it already contains a value
+(i.e. was manually set.)
+
+* The `updater` is set each time the model is updated (`before_update` callback).
+Mongoid::Userstamps will not overwrite the `updater` field if it been modified since the last save,
+as per Mongoid's built-in "dirty tracking" feature.
+
+  > When the `updater` is the same and we need to preserve, we need to use `skip_userstamps` method.
+
 ### Rails
 
 -   Define current user in your `application_controller.rb`

data/lib/mongoid-simple-userstamps/model.rb

@@ -6,6 +6,8 @@ module Mongoid
     module Model
       def self.included(base)
         base.class_eval do
+          attr_reader :skip_userstamps_flag
+
           if Mongoid::VERSION.to_f < 6
             belongs_to :created_by, polymorphic: true
             belongs_to :updated_by, polymorphic: true
@@ -15,11 +17,24 @@ module Mongoid
           end
 
           before_create do
-            self.created_by = Mongoid::Userstamps::User.current unless created_by
+            unless @skip_userstamps_flag || created_by
+              self.created_by = Mongoid::Userstamps::User.current
+            end
           end
 
           before_update do
-            self.updated_by = Mongoid::Userstamps::User.current unless updated_by_id_changed?
+            unless @skip_userstamps_flag || updated_by_id_changed?
+              self.updated_by = Mongoid::Userstamps::User.current
+            end
+          end
+
+          after_save do
+            @skip_userstamps_flag = false
+          end
+
+          def skip_userstamps
+            @skip_userstamps_flag = true
+            self
           end
         end
       end

data/lib/mongoid-simple-userstamps/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Userstamps
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/spec/userstamps_spec.rb

@@ -42,19 +42,27 @@ describe 'Mongoid::Userstamp' do
     context 'when update Post' do
       it 'should save user stamps relations' do
         post = Post.create
-        post.title = "title"
-        post.save
+        post.update(title: 'title')
         expect(post.updated_by).to eq(@user)
       end
 
-      it 'should not overwrite updated_by' do
+      it 'should not overwrite updated_by when it changes' do
         user = User.create
         post = Post.create
-        post.title = "title"
-        post.updated_by = user
-        post.save
+        post.update(title: 'title', updated_by: user)
         expect(post.updated_by).to eq(user)
       end
+
+      it 'should not overwrite updated_by when use skip_userstamps' do
+        user = User.create
+        post = Post.create(updated_by: user)
+        post.skip_userstamps.update(title: 'title')
+        expect(post.updated_by).to eq(user)
+
+        # after saved skip is removed
+        post.update(title: 'new_title')
+        expect(post.updated_by).to eq(@user)
+      end
     end
 
     context 'when check thread safe' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-simple-userstamps
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rafael Jurado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler