mongoid-audit_log 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c64fb48b393df395b00f96fd8f804df26a8c361
-  data.tar.gz: 63e4405ba7cd83a09bb306fd569ec1beec6d6e10
+  metadata.gz: dd2a9b75ea8803b8c62a52e358adf073ca20cc92
+  data.tar.gz: '08ee1ca6dd2855610ac0f9e41da2a71f9072b5d5'
 SHA512:
-  metadata.gz: 8a3d0d35183456d3d385340d9343be542293dd280f4c7e8e7fea8c3e0b738df4799144a7bb032edc7afd78b01dd1a2528a2df4b2bde6f9594b24d379b1a57f62
-  data.tar.gz: ba9e4830088d3e14add3950bd29ea7f4f182136752db49235599aa76862d69ec5b7d075529e63b4e499ccbeebffc5a20b9ea92f642b253d35375bb054649b17a
+  metadata.gz: ca3fb108c8e8c6fcc11bc0cf2c9c3580ace95971c010b58fdba043035b08a754f583882562b720a89193c5f2cc7d4b93f37df578e913cfc569a7e56bc74f236b
+  data.tar.gz: 4fac09d329077517f1d6277d69929d3feb35410e712c9a119b9d42ff612755b0717ca1ef6a02c624937c3ebad5cfc474a6e91f62925f1bfde47e22473f698b31

data/README.md

@@ -44,6 +44,11 @@ If you want to log the user who made the change, pass that user to the record me
 Mongoid::AuditLog.record(current_user) do
   Model.create!
 end
+
+# or
+
+Mongoid::AuditLog.current_modifier = current_user
+Mongoid::AuditLog.enable
 ```
 
 A basic implementation in a Rails app might look something like:

data/lib/mongoid/audit_log.rb

@@ -24,20 +24,30 @@ module Mongoid
     end
 
     def self.record(modifier = nil)
-      Thread.current[:mongoid_audit_log_recording] = true
-      Thread.current[:mongoid_audit_log_modifier] = modifier
+      already_recording = recording?
+      enable unless already_recording
+      self.current_modifier = modifier
       yield
     ensure
-      Thread.current[:mongoid_audit_log_recording] = nil
-      Thread.current[:mongoid_audit_log_modifier] = nil
+      disable unless already_recording
+      self.current_modifier = nil
+    end
+
+    def self.enable
+      Thread.current[:mongoid_audit_log_recording] = true
     end
 
     def self.disable
-      tmp = Thread.current[:mongoid_audit_log_recording]
+      already_recording = recording?
       Thread.current[:mongoid_audit_log_recording] = false
-      yield
-    ensure
-      Thread.current[:mongoid_audit_log_recording] = tmp
+
+      if block_given?
+        begin
+          yield
+        ensure
+          Thread.current[:mongoid_audit_log_recording] = already_recording
+        end
+      end
     end
 
     def self.recording?
@@ -47,6 +57,10 @@ module Mongoid
     def self.current_modifier
       Thread.current[:mongoid_audit_log_modifier]
     end
+    
+    def self.current_modifier=(modifier)
+      Thread.current[:mongoid_audit_log_modifier] = modifier
+    end
 
     private
 
@@ -61,7 +75,7 @@ module Mongoid
           :audited_type => self.class,
           :audited_id => id,
           :tracked_changes => @_audit_log_changes.all,
-          :model_attributes => attributes.dup,
+          :model_attributes => attributes.deep_dup,
           :document_path => traverse_association_chain
         )
       end

data/lib/mongoid/audit_log/entry.rb

@@ -10,7 +10,11 @@ module Mongoid
       field :model_attributes, :type => Hash
       field :document_path, :type => Array
 
-      belongs_to :audited, :polymorphic => true
+      if Gem::Version.new(Mongoid::VERSION) < Gem::Version.new('6.0.0.beta')
+        belongs_to :audited, :polymorphic => true
+      else
+        belongs_to :audited, :polymorphic => true, :optional => true
+      end
 
       index({ :audited_id => 1, :audited_type => 1 })
       index({ :modifier_id => 1 })
@@ -28,7 +32,9 @@ module Mongoid
 
       def valid?(*)
         result = super
-        self.modifier = Mongoid::AuditLog.current_modifier if result
+        if result && modifier.blank?
+          self.modifier = Mongoid::AuditLog.current_modifier
+        end
         result
       end
 
@@ -56,6 +62,8 @@ module Mongoid
       end
 
       def audited
+        return nil if audited_type.blank? || audited_id.blank?
+
         if for_embedded_doc?
           lookup_from_document_path
         else

data/lib/mongoid/audit_log/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module AuditLog
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/mongoid/audit_log/entry_spec.rb

@@ -68,6 +68,14 @@ module Mongoid
         end
       end
 
+      describe '#valid?' do
+        it 'does not override a manually set modifier' do
+          entry = Entry.new(:modifier_id => user.id)
+          entry.valid?
+          entry.modifier.should == user
+        end
+      end
+
       describe '#modifier' do
         it 'finds the modifier based on the configured class' do
           entry = Entry.new(:modifier_id => user.id)
@@ -84,6 +92,10 @@ module Mongoid
           entry = Entry.desc(:created_at).first
           entry.audited.should == option
         end
+
+        it 'returns nil if the audited info is blank' do
+          Entry.new.audited.should be_nil
+        end
       end
 
       describe '#modifier_id=' do

data/spec/mongoid/audit_log_spec.rb

@@ -16,6 +16,8 @@ module Mongoid
         field :sku, :type => String
         embedded_in :product
       end
+
+      AuditLog.disable
     end
 
     after(:all) do
@@ -95,8 +97,31 @@ module Mongoid
       end
     end
 
+    describe '.enable' do
+      after(:each) do
+        AuditLog.disable
+      end
+
+      it 'starts recording' do
+        AuditLog.enable
+
+        product = Product.create!(:name => 'Foo bar')
+        product.audit_log_entries.count.should == 1
+      end
+    end
+
     describe '.disable' do
-      it 'can disable recording' do
+      it 'stops recording' do
+        AuditLog.enable
+        AuditLog.disable
+
+        product = Product.create!(:name => 'Foo bar')
+        product.audit_log_entries.should be_empty
+      end
+
+      it 'can disable recording for a block' do
+        AuditLog.disable
+
         AuditLog.record do
           product = Product.create!(:name => 'Foo bar')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-audit_log
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Crouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2017-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: No fancy versioning, undo, redo, etc. Just saves changes to Mongoid models