mongoid-audit_log 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 718afad5f797fe8acf640b0541086f99033e4457707a5fb5daa3b4505adf8d8d
-  data.tar.gz: 92ba729bc96163933fa532d5d66b35ceeef4b3b85f43a76cd47c0e83518af6b1
+  metadata.gz: 61de8364fc9a0e8554f5c421560717892f0031b3034fc6978df71de6f106d87d
+  data.tar.gz: '053874e715158f7623cf52121bce0aad06696517c9abaffe1c9891ecc67011c0'
 SHA512:
-  metadata.gz: 346b36e40c17a2bb6836c304f868eaadf92db5574cc13fd3aaaa2dd9243a4f689e582e6ed4941346ddb35406ca28351afd2e4fee928764a7d224cb180fbd7fc0
-  data.tar.gz: 0c88dbb79f64014e8f62439d48df1fadb16e1742f01573fc132b989012b14185c32b6f8f2a9302c2e4f5a5b2b7ca05d20258bc934ee25858427c4e5aeff34d6d
+  metadata.gz: 32c4792b0a76084ad7c3c6f493be3caf796000facb5b82fc0fe4b7948fc85a10c062b85f7dfc5f503fd051d890b50bb6b4d008ec44adb651e0e43431671b6b7c
+  data.tar.gz: 04ed8d08325d4a606764a39e5ac9134381883324ced95b70f3cd4915a8cba28dce0a517694f59110a33837f8a8e680011de25d2d5b610b287210551c6d9c3c86

data/README.md

@@ -146,6 +146,29 @@ model == Model.find_by(name: 'foo bar') # => true
 
 It's possible to end up in a situation where a destroy entry cannot be restored, e.g. an entry deleting an embedded document for a root document that's already been deleted. In these scenarios, `Mongoid::AuditLog::Restore::InvalidRestore` will be raised.
 
+### Disabling
+
+The `AuditLog` module provides methods to included classes to allow explicit disabling or enabling of logging. This can be useful if a model includes the mixin indirectly through another mixin or inheritance.
+
+```ruby
+class Parent
+  include Mongoid::Document
+  include Mongoid::AuditLog
+end
+
+class Child < Parent
+  disable_audit_log
+end
+
+class Grandchild < Child
+  enable_audit_log
+end
+
+Parent.audit_log_enabled? # => true
+Child.audit_log_enabled? # => false
+Grandchild.audit_log_enabled? # => true
+```
+
 ## Contributing
 
 1. Fork it

data/lib/mongoid/audit_log.rb

@@ -14,15 +14,29 @@ module Mongoid
 
       AuditLog.actions.each do |action|
         send("before_#{action}") do
-          set_audit_log_changes if AuditLog.recording?
+          set_audit_log_changes if record_audit_log?
         end
 
         send("after_#{action}") do
-          save_audit_log_entry(action) if AuditLog.recording?
+          save_audit_log_entry(action) if record_audit_log?
         end
       end
     end
 
+    class_methods do
+      def enable_audit_log
+        @audit_log_enabled = true
+      end
+
+      def disable_audit_log
+        @audit_log_enabled = false
+      end
+
+      def audit_log_enabled?
+        !defined?(@audit_log_enabled) || @audit_log_enabled
+      end
+    end
+
     def self.record(modifier = nil)
       already_recording = recording?
       enable unless already_recording
@@ -62,6 +76,10 @@ module Mongoid
       Thread.current[:mongoid_audit_log_modifier] = modifier
     end
 
+    def record_audit_log?
+      AuditLog.recording? && self.class.audit_log_enabled?
+    end
+
     private
 
     def set_audit_log_changes

data/lib/mongoid/audit_log/entry.rb

@@ -44,7 +44,7 @@ module Mongoid
                         nil
                       else
                         klass = Mongoid::AuditLog.modifier_class_name.constantize
-                        klass.find(modifier_id)
+                        klass.find(modifier_id) rescue nil
                       end
       end
 

data/lib/mongoid/audit_log/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module AuditLog
-    VERSION = "0.6.0"
+    VERSION = "0.6.1"
   end
 end

data/spec/mongoid/audit_log/entry_spec.rb

@@ -81,6 +81,11 @@ module Mongoid
           entry = Entry.new(:modifier_id => user.id)
           entry.modifier.should == user
         end
+
+        it 'can handle a missing modifier' do
+          entry = Entry.new(:modifier_id => 'foo')
+          entry.modifier.should be_nil
+        end
       end
 
       describe '#audited' do

data/spec/mongoid/audit_log_spec.rb

@@ -25,6 +25,10 @@ module Mongoid
       Object.send(:remove_const, :Variant)
     end
 
+    after(:each) do
+      Product.enable_audit_log
+    end
+
     describe '.record' do
       it 'does not save an entry if not recording' do
         product = Product.create!
@@ -198,6 +202,15 @@ module Mongoid
           entry.document_path.second['id'].should == variant.id
           entry.document_path.second['relation'].should == nil
         end
+
+        it 'does not record if model disables logging' do
+          product = Product.create!(:name => 'Foo bar')
+          product.audit_log_entries.count.should eq(1)
+
+          Product.disable_audit_log
+          product.update!(name: 'Foo bar baz')
+          product.audit_log_entries.count.should eq(1)
+        end
       end
 
       context 'update' do
@@ -281,5 +294,56 @@ module Mongoid
         end
       end
     end
+
+    describe '.disable_audit_log' do
+      it 'disables recording for model' do
+        AuditLog.record do
+          product = Product.create!(name: 'Foo bar')
+          product.audit_log_entries.count.should eq(1)
+
+          Product.disable_audit_log
+          product.record_audit_log?.should be_false
+
+          product.update!(name: 'Bar foo')
+          product.audit_log_entries.count.should eq(1)
+        end
+      end
+    end
+
+    describe '.enable_audit_log' do
+      it 'enables recording for model' do
+        AuditLog.record do
+          Product.disable_audit_log
+
+          product = Product.create!(name: 'Foo bar')
+          product.audit_log_entries.count.should eq(0)
+
+          Product.enable_audit_log
+          product.record_audit_log?.should be_true
+
+          product.update!(name: 'Bar foo')
+          product.audit_log_entries.count.should eq(1)
+        end
+      end
+    end
+
+    describe '#record_audit_log?' do
+      it 'returns true while recording' do
+        Product.new.record_audit_log?.should be_false
+
+        AuditLog.record do
+          Product.new.record_audit_log?.should be_true
+        end
+      end
+
+      it 'returns false when audit log is disabled' do
+        Product.disable_audit_log
+        Product.new.record_audit_log?.should be_false
+
+        AuditLog.record do
+          Product.new.record_audit_log?.should be_false
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-audit_log
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ben Crouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: No fancy versioning, undo, redo, etc. Just saves changes to Mongoid models