effective_logging 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f13ff153b87e251c687b2fbd6fe49dc870050c0
-  data.tar.gz: bbee752de6d570e21276612e9a14d97448671640
+  metadata.gz: 731f331a434fe08296dac04c2b5220521f06163c
+  data.tar.gz: b50f15e84035e9dc56bcbb5644ad8893e9673cd6
 SHA512:
-  metadata.gz: 5c805494dba913dd2bd10dd047e10b047f22e7c79164419cfaa76ab1ba22e51191b854a7681bc6129061e41f0804615b890e115759cfd703c749c091e1929b7b
-  data.tar.gz: 3aa1ec9ddf7cfa73e0de6dca4fea9bbf53fa35c3a057ca0fc84c0c0faad950fd6f64340b5df89780db0b6d6f0a580b6b62dc4ee6fd4062fb6c45193239e5bf96
+  metadata.gz: c0114fdb00a7a7abe49218a689ca57c921a21a833965537c438e1074baf1bc654d8fff6f48f3117737093fddd69c07c2f4f4fcfffd463e9cf38a2c1c2e8d3792
+  data.tar.gz: 67725f27c6d721f0c6f029d1c6ff2552cc1b7e83c1779323240208833f1d8ad9ffc86ed9ac2edd82cb1079ab5d399ae28ac807e5bb95d6e9d90dc09885aeb45d

data/README.md

@@ -225,6 +225,14 @@ Each changed attribute will have its before and after values logged to form an a
 
 And on each create / destroy / update, a full dump of all current attributes is saved, forming an audit log.
 
+If this ends up hammering your database, you can skip logging the associations by using `except` or `include_associated: false`
+
+```ruby
+class Post < ActiveRecord::Base
+  log_changes include_associated: false
+end
+```
+
 There is some initial support for passing `only`, `except`, and `additionally` to the mixin to customize what attributes are saved.
 
 Define your model with `log_changes additionally: [:method1, :method2]` to also _always_ log the value of that method. Even if it's unchanged.

data/app/models/concerns/acts_as_loggable.rb

@@ -9,6 +9,10 @@ module ActsAsLoggable
         raise ArgumentError.new('invalid arguments passed to (effective_logging) log_changes. Example usage: log_changes except: [:created_at]')
       end
 
+      if (unknown = (@acts_as_loggable_options.keys - [:only, :except, :additionally, :include_associated])).present?
+        raise ArgumentError.new("unknown keyword: #{unknown.join(', ')}")
+      end
+
       include ::ActsAsLoggable
     end
   end
@@ -47,9 +51,14 @@ module ActsAsLoggable
     log_changes_options = {
       only: Array(@acts_as_loggable_options[:only]).map { |attribute| attribute.to_s },
       except: Array(@acts_as_loggable_options[:except]).map { |attribute| attribute.to_s },
-      additionally: Array(@acts_as_loggable_options[:additionally]).map { |attribute| attribute.to_s }
+      additionally: Array(@acts_as_loggable_options[:additionally]).map { |attribute| attribute.to_s },
+      include_associated: @acts_as_loggable_options.fetch(:include_associated, true)
     }
 
+    if name == 'User'
+      log_changes_options[:except] += %w(sign_in_count current_sign_in_at current_sign_in_ip last_sign_in_at last_sign_in_ip encrypted_password remember_created_at reset_password_token invitation_sent_at invitation_created_at invitation_token)
+    end
+
     self.send(:define_method, :log_changes_options) { log_changes_options }
   end
 

data/lib/effective_logging/active_record_logger.rb

@@ -1,6 +1,6 @@
 module EffectiveLogging
   class ActiveRecordLogger
-    attr_accessor :object, :resource, :logger, :depth, :options
+    attr_accessor :object, :resource, :logger, :depth, :include_associated, :options
 
     BLANK = "''"
 
@@ -13,6 +13,7 @@ module EffectiveLogging
 
       @logger = options.delete(:logger) || object
       @depth = options.delete(:depth) || 0
+      @include_associated = options.fetch(:include_associated, true)
       @options = options
 
       raise ArgumentError.new('logger must respond to logged_changes') unless @logger.respond_to?(:logged_changes)
@@ -27,24 +28,25 @@ module EffectiveLogging
       else
         changed!
       end
-      log_nested_resources!
+
+      log_nested_resources! if include_associated
 
       @logged
     end
 
     # before_destroy
     def destroyed!
-      log('Deleted', details: applicable(resource.instance_attributes))
+      log('Deleted')
     end
 
     # after_commit
     def created!
-      log('Created', details: applicable(resource.instance_attributes))
+      log('Created', details: applicable(resource.instance_attributes(include_associated: include_associated)))
     end
 
     # after_commit
     def updated!
-      log('Updated', details: applicable(resource.instance_attributes))
+      log('Updated', details: applicable(resource.instance_attributes(include_associated: include_associated)))
     end
 
     private
@@ -73,7 +75,8 @@ module EffectiveLogging
         title = association.name.to_s.singularize.titleize
 
         Array(object.send(association.name)).each_with_index do |child, index|
-          @logged = true if ::EffectiveLogging::ActiveRecordLogger.new(child, options.merge(logger: logger, depth: depth+1, prefix: "#{title} #{index} - #{child} - ")).execute!
+          child_options = options.merge(logger: logger, depth: depth+1, include_associated: include_associated, prefix: "#{title} #{index} - #{child} - ")
+          @logged = true if ::EffectiveLogging::ActiveRecordLogger.new(child, child_options).execute!
         end
       end
     end
@@ -114,6 +117,5 @@ module EffectiveLogging
       # Blacklist
       atts.except(:logged_changes, :trash, 'logged_changes', 'trash')
     end
-
   end
 end

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.0.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Code and Effect