rails_audit_log 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf000427595792f1a97214b6ad5d6dc7f6875681f315570260760accf4e70ba3
-  data.tar.gz: 8978577023bb75e0832d475b8fcaeaeedb4a02ac3c5b1e1500a6d2187e1c5e5c
+  metadata.gz: adf2bbd729f0c0a53c0016389d8b8af4ca66cedede3343bb3376cf880edc447c
+  data.tar.gz: 640764fdbe148a2f8d0309350ae74358256b7cc9b530f0c35d0bc045ef736b4c
 SHA512:
-  metadata.gz: 897e191130a3895876e5ec8328386d5cd8e456b866a348a0c10edbacc4969883a8ca550e2fa2491f68937ed1a9558c5143a49503c9c80b4f1824789bbc40eee1
-  data.tar.gz: d1035cdcfcc8d243fc8cfe43fac0842973e9e0dba78e16f4917c83ec83e6db81b8eb999dc441620d01027984ca4a89cdaafb8fb0501b3b98fa4712571d08a706
+  metadata.gz: 938374f49a4385c038124abb6aeb95eaa8369dccc20d8eb125e96071954c3b8858cb22dc94781bdfa31e96d006645df5bb07f989c83d4ca35d1792451cb82f07
+  data.tar.gz: 82f6ca3524c11b954705d62b576d11c8ae5008f49b26c973789d43466a6d1ab3d4462fd012885a0b83177220c8ceda83c381af5db07e0b371deafca1db14badc

data/README.md

@@ -1,6 +1,8 @@
 # RailsAuditLog
 
-[![Gem Version](https://badge.fury.io/rb/rails_audit_log.svg)](https://badge.fury.io/rb/rails_audit_log)
+[![CI](https://github.com/eclectic-coding/rails_audit_log/actions/workflows/ci.yml/badge.svg)](https://github.com/eclectic-coding/rails_audit_log/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/rails_audit_log.svg)](https://rubygems.org/gems/rails_audit_log)
+[![Downloads](https://img.shields.io/gem/dt/rails_audit_log.svg)](https://rubygems.org/gems/rails_audit_log)
 [![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.3-ruby)](https://www.ruby-lang.org)
 [![codecov](https://codecov.io/gh/eclectic-coding/rails_audit_log/branch/main/graph/badge.svg)](https://codecov.io/gh/eclectic-coding/rails_audit_log)
 

data/Rakefile

@@ -21,9 +21,9 @@ namespace :dev do
   dummy_env = { "RAILS_ENV" => "development" }
   dummy_rake = "cd spec/dummy && bundle exec rake"
 
-  desc "Create and migrate the development database"
+  desc "Create and load the development database from schema"
   task :setup do
-    sh dummy_env, "#{dummy_rake} db:create db:migrate"
+    sh dummy_env, "#{dummy_rake} db:create db:schema:load"
   end
 
   desc "Seed the development database"
@@ -31,8 +31,8 @@ namespace :dev do
     sh dummy_env, "#{dummy_rake} db:seed"
   end
 
-  desc "Drop, recreate, migrate, and seed the development database"
+  desc "Drop, recreate, load schema, and seed the development database"
   task :reset do
-    sh dummy_env, "#{dummy_rake} db:drop db:create db:migrate db:seed"
+    sh dummy_env, "#{dummy_rake} db:drop db:create db:schema:load db:seed"
   end
 end

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/app/models/rails_audit_log/audit_log_entry.rb

@@ -11,8 +11,52 @@ module RailsAuditLog
     validates :item_type, presence: true
     validates :item_id, presence: true
 
-    scope :creates,  -> { where(event: "create") }
-    scope :updates,  -> { where(event: "update") }
-    scope :destroys, -> { where(event: "destroy") }
+    # Event scopes
+    scope :created_events,  -> { where(event: "create") }
+    scope :updated_events,  -> { where(event: "update") }
+    scope :destroyed_events, -> { where(event: "destroy") }
+
+    # Deprecated short aliases kept for backwards compatibility
+
+    scope :creates,  -> { created_events }
+    scope :updates,  -> { updated_events }
+    scope :destroys, -> { destroyed_events }
+
+    # Actor / resource scopes
+    scope :by_actor, ->(actor) { where(actor_type: actor.class.name, actor_id: actor.id) }
+    scope :for_resource, lambda { |resource|
+      if resource.is_a?(Class)
+        where(item_type: resource.name)
+      else
+        where(item_type: resource.class.name, item_id: resource.id)
+      end
+    }
+
+    # Time scopes
+    scope :since, ->(time) { where(created_at: time..) }
+    scope :until, ->(time) { where(created_at: ..time) }
+
+    # Instance methods
+
+    def changed_attributes
+      object_changes&.keys || []
+    end
+
+    def diff
+      return {} unless object_changes
+
+      object_changes.transform_values { |from_to| { from: from_to[0], to: from_to[1] } }
+    end
+
+    # Attribute scope — uses json_extract (SQLite/MySQL) or json ? key (PostgreSQL)
+    scope :touching, ->(attribute) {
+      if connection.adapter_name =~ /PostgreSQL/i
+        # :nocov:
+        where("object_changes ? :key", key: attribute.to_s)
+        # :nocov:
+      else
+        where("json_extract(object_changes, ?) IS NOT NULL", "$.#{attribute}")
+      end
+    }
   end
 end

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "0.1.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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chuck Smith