mongoid-audit_log 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa9b0f3bd22dd2c706edd99f332a551fd9d32425
-  data.tar.gz: 8207dfc9dba5a7fa8461cd7695ab206b23998500
+  metadata.gz: 155cd76ed2ee5e3a9a6d9941f4c8d4b47cef005c
+  data.tar.gz: e16bc334bc6531efb3ffb1e6f0a7af5a6b301904
 SHA512:
-  metadata.gz: 62b0fd36deedc5b4b05c010351c3733d1ea821b9619222e2f622c0cdbb40e4c552eb1661e72db317edcbb01321fa3954cd648084956d1f6f52b6ef4330830a15
-  data.tar.gz: e314b74053728b9351fbb36a56a49364a93f0a4bd383b4516abdb48d7f7f4477c3ee8949fd3ab370852c7603943003136246be5ddb6d5c0e54f977c0a4cc670d
+  metadata.gz: 5a8d97bb2479bf9f6a53cefd8f1c1a754c9dd9d1c00633c6e1aa76a3dd0a023996d08db19c2f6ad027bca8605056bf1b2e3a04f180aa8898f301cf106645521a
+  data.tar.gz: 7fdeec856542dd3a3dd2e6ad95a96b8e945647942feecb8107f65d715c3b0220209538301db6edfc751213bc778fcbf8f17e7e0fe6829f5c46015ee8fd315a0a

data/README.md

@@ -77,7 +77,7 @@ Mongoid::AuditLog.record do
   module.update_attributes(:name => 'model')
 end
 
-model.audit_log_entries.length == 2
+model.audit_log_entries.length == 2 # => true
 
 model.audit_log_entries.first.create? # => true
 model.audit_log_entries.first.update? # => false
@@ -91,12 +91,12 @@ model.audit_log_entries.second.destroy? # => false
 model.audit_log_entries.second.tracked_changes.should == { 'name' => [nil, 'model'] }
 ```
 
-There are also some built-in scopes (from the tests):
+There are also some built-in scopes (examples from the tests):
 
 ```ruby
-  create = Entry.create!(:action => :create, :created_at => 10.minutes.ago) }
-  update = Entry.create!(:action => :update, :created_at => 5.minutes.ago) }
-  destroy = Entry.create!(:action => :destroy, :created_at => 1.minutes.ago) }
+  create = Entry.create!(:action => :create, :created_at => 10.minutes.ago)
+  update = Entry.create!(:action => :update, :created_at => 5.minutes.ago)
+  destroy = Entry.create!(:action => :destroy, :created_at => 1.minutes.ago)
 
   Entry.creates.to_a.should == [create]
   Entry.updates.to_a.should == [update]
@@ -105,6 +105,25 @@ There are also some built-in scopes (from the tests):
 end
 ```
 
+### Additional saved data
+
+You can access the attributes of the model saved on the `Mongoid::AuditLog::Entry`.
+They are saved on the document in the `#model_attributes`, and include any changes in
+the `#tracked_changes` hash.
+
+Examples:
+```ruby
+Mongoid::AuditLog.record do
+  model = Model.create!(:name => 'foo bar')
+end
+
+model.audit_log_entries.length == 1 # => true
+
+model.audit_log_entries.first.create? # => true
+model.audit_log_entries.first.model_attributes # => {"name"=>"foo bar"}
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/mongoid/audit_log.rb

@@ -1,7 +1,6 @@
 require "mongoid/audit_log/version"
 require "mongoid/audit_log/config"
 require "mongoid/audit_log/entry"
-require "mongoid/audit_log/caches"
 require "mongoid/audit_log/changes"
 require "mongoid/audit_log/embedded_changes"
 
@@ -13,13 +12,13 @@ module Mongoid
       has_many :audit_log_entries, :as => :audited,
         :class_name => 'Mongoid::AuditLog::Entry', :validate => false
 
-      Mongoid::AuditLog.actions.each do |action|
+      AuditLog.actions.each do |action|
         send("before_#{action}") do
-          set_audit_log_changes if Mongoid::AuditLog.recording?
+          set_audit_log_changes if AuditLog.recording?
         end
 
         send("after_#{action}") do
-          save_audit_log_entry(action) if Mongoid::AuditLog.recording?
+          save_audit_log_entry(action) if AuditLog.recording?
         end
       end
     end
@@ -50,17 +49,17 @@ module Mongoid
     private
 
     def set_audit_log_changes
-      @_audit_log_changes = Mongoid::AuditLog::Changes.new(self).tap(&:read)
+      @_audit_log_changes = Changes.new(self).tap(&:read)
     end
 
     def save_audit_log_entry(action)
       unless action == :update && @_audit_log_changes.all.blank?
-        Mongoid::AuditLog::Entry.create!(
+        Entry.create!(
           :action => action,
           :audited_type => self.class,
           :audited_id => id,
           :tracked_changes => @_audit_log_changes.all,
-          :caches => Mongoid::AuditLog::Caches.new(self).all
+          :model_attributes => attributes.dup
         )
       end
     end

data/lib/mongoid/audit_log/config.rb

@@ -5,8 +5,5 @@ module Mongoid
 
     mattr_accessor :modifier_class_name
     self.modifier_class_name = 'User'
-
-    mattr_accessor :cache_fields
-    self.cache_fields = []
   end
 end

data/lib/mongoid/audit_log/entry.rb

@@ -7,7 +7,7 @@ module Mongoid
       field :action, :type => Symbol
       field :tracked_changes, :type => Hash, :default => {}
       field :modifier_id, :type => String
-      field :caches, :type => Hash
+      field :model_attributes, :type => Hash
 
       belongs_to :audited, :polymorphic => true
 
@@ -52,14 +52,14 @@ module Mongoid
 
       def respond_to?(sym, *args)
         key = sym.to_s
-        (caches.present? && caches.has_key?(key)) || super
+        (model_attributes.present? && model_attributes.has_key?(key)) || super
       end
 
       def method_missing(sym, *args, &block)
         key = sym.to_s
 
-        if caches.present? && caches.has_key?(key)
-          caches[key]
+        if model_attributes.present? && model_attributes.has_key?(key)
+          model_attributes[key]
         else
           super
         end

data/lib/mongoid/audit_log/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module AuditLog
-    VERSION = "0.0.8"
+    VERSION = "0.1.0"
   end
 end

data/spec/mongoid/audit_log/entry_spec.rb

@@ -72,18 +72,22 @@ module Mongoid
       end
 
       describe '#respond_to?' do
-        let(:entry) { Entry.new(:caches => { 'name' => 'foo', 'other' => nil }) }
+        let(:entry) do
+          Entry.new(:model_attributes => { 'name' => 'foo', 'other' => nil })
+        end
 
-        it 'returns true for cached methods it responds to' do
+        it 'returns true for methods from the model attributes' do
           entry.respond_to?(:name).should be_true
           entry.respond_to?(:other).should be_true
         end
       end
 
       describe '#method_missing' do
-        let(:entry) { Entry.new(:caches => { 'name' => 'foo', 'other' => nil }) }
+        let(:entry) do
+          Entry.new(:model_attributes => { 'name' => 'foo', 'other' => nil })
+        end
 
-        it 'responds to methods for which it has a cache' do
+        it 'responds to methods for which it has a model attribute' do
           entry.name.should == 'foo'
           entry.other.should == nil
         end

data/spec/mongoid/audit_log_spec.rb

@@ -51,10 +51,7 @@ module Mongoid
         end
       end
 
-      it 'saves cache fields from configuration' do
-        tmp = Mongoid::AuditLog.cache_fields
-        Mongoid::AuditLog.cache_fields << :name
-
+      it 'saves model attributes' do
         AuditLog.record do
           product = Product.create!(:name => 'Foo bar')
           product.update_attributes(:name => 'Bar baz')
@@ -62,11 +59,9 @@ module Mongoid
 
           product.audit_log_entries.count.should == 3
           product.audit_log_entries.each do |entry|
-            entry.name.should be_present
+            entry.model_attributes['name'].should be_present
           end
         end
-
-        Mongoid::AuditLog.cache_fields = tmp
       end
 
       it 'saves the modifier if passed' do
@@ -108,7 +103,15 @@ module Mongoid
           entry = product.audit_log_entries.first
 
           entry.create?.should be_true
-          entry.tracked_changes.should == { 'name' => [nil, 'Foo bar'] }
+
+          entry.tracked_changes.should == {
+            'name' => [nil, 'Foo bar']
+          }
+
+          entry.model_attributes.should == {
+            '_id' => product.id,
+            'name' => 'Foo bar'
+          }
         end
 
         it 'saves embedded creations' do
@@ -119,6 +122,13 @@ module Mongoid
           entry = product.audit_log_entries.first
 
           entry.create?.should be_true
+
+          entry.model_attributes.should == {
+            '_id' => product.id,
+            'name' => 'Foo bar',
+            'variants' => [{ '_id' => product.variants.first.id, 'sku'=>'sku' }]
+          }
+
           entry.tracked_changes.should == {
             'name' => [nil, 'Foo bar'],
             'variants' => [{ 'sku' => [nil, 'sku'] }]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-audit_log
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Crouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -66,7 +66,6 @@ files:
 - README.md
 - Rakefile
 - lib/mongoid/audit_log.rb
-- lib/mongoid/audit_log/caches.rb
 - lib/mongoid/audit_log/changes.rb
 - lib/mongoid/audit_log/config.rb
 - lib/mongoid/audit_log/embedded_changes.rb
@@ -98,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: No fancy versioning, undo, redo, etc. Just saves changes to Mongoid models
@@ -109,4 +108,3 @@ test_files:
 - spec/mongoid/audit_log_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-has_rdoc: 

data/lib/mongoid/audit_log/caches.rb

@@ -1,20 +0,0 @@
-module Mongoid
-  module AuditLog
-    class Caches
-      attr_reader :model
-
-      def initialize(model)
-        @model = model
-      end
-
-      def all
-        return nil unless Mongoid::AuditLog.cache_fields.present?
-
-        Mongoid::AuditLog.cache_fields.inject({}) do |memo, field|
-          memo[field] = model.send(field) if model.respond_to?(field)
-          memo
-        end
-      end
-    end
-  end
-end