effective_logging 1.5.4 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 972197d1a2d63936b7f66950db15d0410575b4f0
-  data.tar.gz: 27cc2dd5644cf4f92b959974f5fb103a1cd39b1b
+  metadata.gz: d4b1c7d019d794088470dbc81796a8347b428218
+  data.tar.gz: d64386c06c75aa8896197bd6cc95a74f83148307
 SHA512:
-  metadata.gz: bf3aa0b8339b66b07ea33916601a9beee5c3b3c2a9a68a64d8ad1c0403bd8bd17017584261653e3e91ca8188b9d0dad9beb969507940939ec093ce6086b97bd0
-  data.tar.gz: 1481e088f54ea6e5cdd93849976184bb5c39e359ad49c850bd234d70dfef292947103c27b7efc2c6b4d8eedce235bbbe50c1620f28fa99bd79ed50ed79ab1ace
+  metadata.gz: 96945e6afd19f0fa439b87920e820f18a19806c2879d74a36919fc2d875a469d50b0fdeeb600368bf56cae67033f85d590a9dd54e2d57e21364b4f42a61bbc59
+  data.tar.gz: 192d2f2dfe7b82c420430b480a1f9ed0ce0b7360d716efe5c15f92b30302a9fe2c50d74fc5507f1810bc9d52950fa567c2c7fe88a6db4cbb2242db6f67aedbd0

data/README.md

@@ -232,6 +232,28 @@ There is some initial support for passing `only`, `except`, and `additionally` t
 
 Define your model with `log_changes additionally: [:method1, :method2]` to also log the value of methods.
 
+Apply your own formatting to the logged title of each attribute by creating an instance method on the resource:
+
+```ruby
+# Format the title of this attribute. Return nil to use the default attribute.titleize
+def log_changes_formatted_attribute(attribute)
+  attribute.downcase
+end
+```
+
+Apply your own formatting to the logged before and after values of each attribute by creating an instance method on the resource:
+
+```ruby
+# Format the value of this attribute. Return nil to use the default to_s
+def log_changes_formatted_value(attribute, value)
+  if ['cost'].include?(attribute)
+    ActionController::Base.helpers.number_to_currency(value)
+  elsif ['percentage'].include?(attribute)
+    ActionController::Base.helpers.number_to_percentage(value)
+  end
+end
+```
+
 ### Logging From JavaScript
 
 First, require the javascript in your application.js:

data/app/models/concerns/acts_as_loggable.rb

@@ -51,6 +51,16 @@ module ActsAsLoggable
 
   # Regular instance methods
 
+  # Format the title of this attribute. Return nil to use the default attribute.titleize
+  def log_changes_formatted_attribute(attribute)
+    # Intentionally does nothing
+  end
+
+  # Format the value of this attribute. Return nil to use the default to_s
+  def log_changes_formatted_value(attribute, value)
+    # Intentionally does nothing
+  end
+
   def log_changes_datatable
     if persisted?
       @log_changes_datatable ||= (

data/lib/effective_logging/active_record_logger.rb

@@ -2,6 +2,8 @@ module EffectiveLogging
   class ActiveRecordLogger
     attr_accessor :resource, :logger, :depth, :options
 
+    BLANK = "''"
+
     def initialize(resource, options = {})
       raise ArgumentError.new('options must be a Hash') unless options.kind_of?(Hash)
       raise ArgumentError.new('logger must respond to logged_changes') unless (options[:logger] || resource).respond_to?(:logged_changes)
@@ -41,10 +43,19 @@ module EffectiveLogging
     # before_save
     def changed!
       applicable(changes).each do |attribute, (before, after)|
+        if resource.respond_to?(:log_changes_formatted_value)
+          before = resource.log_changes_formatted_value(attribute, before) || before
+          after = resource.log_changes_formatted_value(attribute, after) || after
+        end
+
+        attribute = if resource.respond_to?(:log_changes_formatted_attribute)
+          resource.log_changes_formatted_attribute(attribute)
+        end || attribute.titleize
+
         if after.present?
-          log("#{attribute.titleize} changed from '#{before}' to '#{after}'", { attribute: attribute, before: before, after: after })
+          log("#{attribute} changed from #{before.presence || BLANK} to #{after.presence || BLANK}", { attribute: attribute, before: before, after: after })
         else
-          log("#{attribute.titleize} set to '#{before}'", { attribute: attribute, value: before })
+          log("#{attribute} set to #{before || BLANK}", { attribute: attribute, value: before })
         end
       end
 

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '1.5.4'.freeze
+  VERSION = '1.5.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.5
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails