rails_audit_log 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99754d2a1e8f4d7bba4cff5815b8bd6df8e8569f8817da525611e97a586d3114
-  data.tar.gz: 9fe8b370070705d1eb5685bceaa82474b63f981a51b22911db337793dabe38ff
+  metadata.gz: adf2bbd729f0c0a53c0016389d8b8af4ca66cedede3343bb3376cf880edc447c
+  data.tar.gz: 640764fdbe148a2f8d0309350ae74358256b7cc9b530f0c35d0bc045ef736b4c
 SHA512:
-  metadata.gz: d7122bfd0a99dd298a48597690267a050a8baac1c7d7152f16e2b5766b3e4fac60b1d334f1fdc897a35d6e5b9dd26019204497ec73386257c3eecbe02ea9e36a
-  data.tar.gz: fea300d386237a044f3f57eb3fe94ac0109b5d8ec4e5704bcacdf80137bfeff8bb3df2ae05ee67baaaeee72b9f6a05f86cd8da625603d87b2fd9f801e27dd1c5
+  metadata.gz: 938374f49a4385c038124abb6aeb95eaa8369dccc20d8eb125e96071954c3b8858cb22dc94781bdfa31e96d006645df5bb07f989c83d4ca35d1792451cb82f07
+  data.tar.gz: 82f6ca3524c11b954705d62b576d11c8ae5008f49b26c973789d43466a6d1ab3d4462fd012885a0b83177220c8ceda83c381af5db07e0b371deafca1db14badc

data/app/concerns/rails_audit_log/auditable.rb

@@ -3,6 +3,9 @@ module RailsAuditLog
     extend ActiveSupport::Concern
 
     included do
+      class_attribute :_audit_log_only,   default: nil
+      class_attribute :_audit_log_ignore, default: nil
+
       has_many :audit_log_entries,
                class_name: "RailsAuditLog::AuditLogEntry",
                as: :item,
@@ -13,6 +16,17 @@ module RailsAuditLog
       after_destroy :record_audit_destroy
     end
 
+    class_methods do
+      def audit_log(only: nil, ignore: nil)
+        self._audit_log_only   = only.map(&:to_s)   if only
+        self._audit_log_ignore = ignore.map(&:to_s) if ignore
+      end
+    end
+
+    def skip_audit_log
+      RailsAuditLog.disable { yield }
+    end
+
     private
 
     def record_audit_create
@@ -29,15 +43,33 @@ module RailsAuditLog
     end
 
     def record_audit_entry(event, changes)
+      return unless RailsAuditLog.enabled?
+
+      filtered = filter_changes(changes)
+      return if filtered.empty? && event == "update"
+
       actor = RailsAuditLog.actor
       RailsAuditLog::AuditLogEntry.create!(
         event:          event,
         item_type:      self.class.name,
         item_id:        id,
-        object_changes: changes,
+        object_changes: filtered,
         actor_type:     actor&.class&.name,
         actor_id:       actor.respond_to?(:id) ? actor.id : nil
       )
     end
+
+    def filter_changes(changes)
+      result = changes.dup
+
+      if self.class._audit_log_only
+        result.select! { |k, _| self.class._audit_log_only.include?(k) }
+      else
+        ignored = self.class._audit_log_ignore || RailsAuditLog.ignored_attributes
+        result.reject! { |k, _| ignored.include?(k) }
+      end
+
+      result
+    end
   end
 end

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/rails_audit_log.rb

@@ -2,6 +2,10 @@ require "rails_audit_log/version"
 require "rails_audit_log/engine"
 
 module RailsAuditLog
+  # Global default columns to ignore across all audited models.
+  # Override in an initializer: RailsAuditLog.ignored_attributes = %w[updated_at cached_at]
+  mattr_accessor :ignored_attributes, default: %w[updated_at]
+
   def self.actor
     Thread.current[:rails_audit_log_actor]
   end
@@ -17,4 +21,16 @@ module RailsAuditLog
   ensure
     self.actor = previous
   end
+
+  def self.enabled?
+    !Thread.current[:rails_audit_log_disabled]
+  end
+
+  def self.disable
+    previous = Thread.current[:rails_audit_log_disabled]
+    Thread.current[:rails_audit_log_disabled] = true
+    yield
+  ensure
+    Thread.current[:rails_audit_log_disabled] = previous
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chuck Smith