effective_logging 2.0.8 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deba877f9d52dbbb410ed1ea2a9996f6dbff4d16
-  data.tar.gz: 3c6bc27bd1a2cd2e3a6b2a87bc8590cc68b85671
+  metadata.gz: 7a608aab5a3d18fc5904353993d99f79d5661512
+  data.tar.gz: f92d295365c081c2fc2656644d9826033dc7208d
 SHA512:
-  metadata.gz: 87675d323a2666c478c6ce4258d4e0a0b034cb963e8371bc674112bc43cdcd98f84be588a72b4a077d2b77caebaba59fa6be1065d725352b271dbf92e113ce38
-  data.tar.gz: f28003a2a9cdf88f75b6fed98f097f762820af5e356b21ac812c05889cd0421707220f2da89b72d66e176895c5f6c45ac370ba98d971004dd0e2ded346b7916d
+  metadata.gz: 41199b4ae698d4b6204979a76116bafacf9c9d2b25c741631938c174fc18ab090e22d987417dcfcecb3e27ee21ada1cdf40254aca0ebe3921accda85f79daf8b
+  data.tar.gz: 2eb2d0f92b144e7517bd752d927d4f4513f0becf7fa7ba8b34bf0c583d1945002f24c8cee43c20ecde45c0ae06a18405039a4951d9d15b3ac49e2539671d2a22

data/app/models/concerns/acts_as_loggable.rb

@@ -9,7 +9,7 @@ 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?
+      if (unknown = (@acts_as_loggable_options.keys - [:only, :except, :additionally, :include_associated, :include_nested])).present?
         raise ArgumentError.new("unknown keyword: #{unknown.join(', ')}")
       end
 
@@ -20,39 +20,12 @@ module ActsAsLoggable
   included do
     has_many :logged_changes, -> { order(:id).where(status: EffectiveLogging.log_changes_status) }, as: :associated, class_name: 'Effective::Log'
 
-    around_save(unless: -> { EffectiveLogging.supressed? }) do |_, block|
-      @acts_as_loggable_new_record = new_record?
-
-      unless @acts_as_loggable_new_record
-        @acts_as_loggable_update_record = ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).execute!
-      end
-
-      block.call
-      true
-    end
-
-    before_destroy(unless: -> { EffectiveLogging.supressed? }) do
-      @acts_as_loggable_destroy_record = true
-      ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).destroyed!
-      true
-    end
-
-    after_commit(unless: -> { EffectiveLogging.supressed? }) do
-      if @acts_as_loggable_new_record
-        ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).created!
-      elsif !@acts_as_loggable_destroy_record && @acts_as_loggable_update_record
-        ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).updated!
-      end
-
-      true
-    end
-
-    # Parse Options
     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 },
-      include_associated: @acts_as_loggable_options.fetch(:include_associated, true)
+      include_associated: @acts_as_loggable_options.fetch(:include_associated, true),
+      include_nested: @acts_as_loggable_options.fetch(:include_nested, true)
     }
 
     if name == 'User'
@@ -60,6 +33,18 @@ module ActsAsLoggable
     end
 
     self.send(:define_method, :log_changes_options) { log_changes_options }
+
+    after_create(unless: -> { EffectiveLogging.supressed? }) do
+      ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).execute!
+    end
+
+    after_destroy(unless: -> { EffectiveLogging.supressed? }) do
+      ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).execute!
+    end
+
+    after_update(unless: -> { EffectiveLogging.supressed? }) do
+      ::EffectiveLogging::ActiveRecordLogger.new(self, log_changes_options).execute!
+    end
   end
 
   module ClassMethods

data/app/views/effective/logs/_log.html.haml

@@ -1,17 +1,18 @@
 .panel.panel-default.card
   .panel-heading.card-header
     .row
-      .col-md-10
+      .col-md-8
         - parents_of_log(log).each do |parent|
           = link_to(log.message, request.fullpath.sub('/' + log.to_param, '/' + parent.to_param))
           = ' > '
         %p= log.message.html_safe
-      .col-md-2.text-right
+
+      .col-md-4.text-right
         - if log.prev_log
           = link_to 'Prev', request.fullpath.sub('/' + log.to_param, '/' + log.prev_log.to_param), class: 'btn btn-primary'
 
         - if log.next_log
-          = link_to 'Next', request.fullpath.sub('/' + log.to_param, '/' + log.prev_log.to_param), class: 'btn btn-primary'
+          = link_to 'Next', request.fullpath.sub('/' + log.to_param, '/' + log.next_log.to_param), class: 'btn btn-primary'
 
   .panel-body.card-body
     .row

data/lib/effective_logging/active_record_logger.rb

@@ -1,6 +1,6 @@
 module EffectiveLogging
   class ActiveRecordLogger
-    attr_accessor :object, :resource, :logger, :depth, :include_associated, :options
+    attr_accessor :object, :resource, :logger, :depth, :include_associated, :include_nested, :options
 
     BLANK = "''"
 
@@ -9,49 +9,46 @@ module EffectiveLogging
 
       @object = object
       @resource = Effective::Resource.new(object)
-      @logged = false # If work was done
 
       @logger = options.delete(:logger) || object
       @depth = options.delete(:depth) || 0
       @include_associated = options.fetch(:include_associated, true)
+      @include_nested = options.fetch(:include_nested, true)
       @options = options
 
       raise ArgumentError.new('logger must respond to logged_changes') unless @logger.respond_to?(:logged_changes)
     end
 
-    # execute! is called when we recurse, otherwise the following methods are best called individually
     def execute!
-      if object.new_record?
+      @logged = false
+
+      if new_record?(object)
         created!
-      elsif object.marked_for_destruction?
+      elsif destroyed_record?(object)
         destroyed!
       else
-        changed!
+        updated!
       end
 
-      log_nested_resources! if include_associated
-
-      @logged
+      logged?
     end
 
-    # before_destroy
     def destroyed!
-      log('Deleted')
+      log('Deleted', details: applicable(instance_attributes))
     end
 
-    # after_commit
     def created!
-      log('Created', details: applicable(resource.instance_attributes(include_associated: include_associated)))
+      log('Created', details: applicable(instance_attributes))
     end
 
-    # after_commit
     def updated!
-      log('Updated', details: applicable(resource.instance_attributes(include_associated: include_associated)))
-    end
+      log_resource_changes!
+      log_nested_resources!
 
-    private
+      log('Updated', details: applicable(instance_attributes)) if logged? && depth == 0
+    end
 
-    def changed!
+    def log_resource_changes!
       applicable(resource.instance_changes).each do |attribute, (before, after)|
         if object.respond_to?(:log_changes_formatted_value)
           before = object.log_changes_formatted_value(attribute, before) || before
@@ -70,17 +67,29 @@ module EffectiveLogging
     end
 
     def log_nested_resources!
+      return unless include_nested
+
       # Log changes on all accepts_as_nested_parameters has_many associations
       resource.nested_resources.each do |association|
         title = association.name.to_s.singularize.titleize
 
         Array(object.send(association.name)).each_with_index do |child, index|
-          child_options = options.merge(logger: logger, depth: depth+1, include_associated: include_associated, prefix: "#{title} #{index} - #{child} - ")
+          next unless child.present?
+
+          child_options = options.merge(logger: logger, depth: depth+1, prefix: "#{title} #{index} - #{child} - ", include_associated: include_associated, include_nested: include_nested)
+          child_options = child_options.merge(child.log_changes_options) if child.respond_to?(:log_changes_options)
+
           @logged = true if ::EffectiveLogging::ActiveRecordLogger.new(child, child_options).execute!
         end
       end
     end
 
+    private
+
+    def instance_attributes # effective_resources gem
+      resource.instance_attributes(include_associated: include_associated, include_nested: include_nested)
+    end
+
     def log(message, details: {})
       @logged = true
 
@@ -96,9 +105,12 @@ module EffectiveLogging
       log
     end
 
+    def logged?
+      @logged == true
+    end
+
     # TODO: Make this work better with nested objects
     def applicable(attributes)
-
       atts = if options[:only].present?
         attributes.stringify_keys.slice(*options[:only])
       elsif options[:except].present?
@@ -115,7 +127,22 @@ module EffectiveLogging
       end
 
       # Blacklist
-      atts.except(:logged_changes, :trash, 'logged_changes', 'trash')
+      atts.except(:logged_changes, :trash, :updated_at, 'logged_changes', 'trash', 'updated_at')
+    end
+
+    def new_record?(object)
+      return true if object.respond_to?(:new_record?) && object.new_record?
+      return true if object.respond_to?(:id_was) && object.id_was.nil?
+      return true if object.respond_to?(:previous_changes) && object.previous_changes.key?('id') && object.previous_changes['id'].first.nil?
+      false
+    end
+
+    def destroyed_record?(object)
+      return true if object.respond_to?(:destroyed?) && object.destroyed?
+      return true if object.respond_to?(:marked_for_destruction?) && object.marked_for_destruction?
+      return true if object.respond_to?(:previous_changes) && object.previous_changes.key?('id') && object.previous_changes['id'].last.nil?
+      false
     end
   end
+
 end

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '2.0.8'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.1.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails