mongoid-audit_log 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 910aee76df538dfa623d329bb7c3434b34db263c
-  data.tar.gz: 5c8c388d1002e83786d7ba71b7fe2aa0c4ea5a9a
+  metadata.gz: 7c64fb48b393df395b00f96fd8f804df26a8c361
+  data.tar.gz: 63e4405ba7cd83a09bb306fd569ec1beec6d6e10
 SHA512:
-  metadata.gz: 9eafe09cfc8b25a50bb36ab05593dbb34bdf6c52abbe996d885c9d83595c3db61f0a04f4fcc2f6d83f7be2b08712dbd9288d0c19a7704adf82bc83090131c78b
-  data.tar.gz: 66413e69767f96505f46ce6ec3d9248b3a9b4c75fda2b0e58060c086d79879b9424faec4f6669d791ed60e5b93887e59daf98d1aad89c53473468d55031e3b63
+  metadata.gz: 8a3d0d35183456d3d385340d9343be542293dd280f4c7e8e7fea8c3e0b738df4799144a7bb032edc7afd78b01dd1a2528a2df4b2bde6f9594b24d379b1a57f62
+  data.tar.gz: ba9e4830088d3e14add3950bd29ea7f4f182136752db49235599aa76862d69ec5b7d075529e63b4e499ccbeebffc5a20b9ea92f642b253d35375bb054649b17a

data/lib/mongoid/audit_log.rb

@@ -61,9 +61,17 @@ module Mongoid
           :audited_type => self.class,
           :audited_id => id,
           :tracked_changes => @_audit_log_changes.all,
-          :model_attributes => attributes.dup
+          :model_attributes => attributes.dup,
+          :document_path => traverse_association_chain
         )
       end
     end
+
+    def traverse_association_chain(node = self, current_relation = nil)
+      relation = node.embedded? ? node.metadata_name.to_s : nil
+      list = node._parent ? traverse_association_chain(node._parent, relation) : []
+      list << { class_name: node.class.name, id: node.id, relation: current_relation }
+      list
+    end
   end
 end

data/lib/mongoid/audit_log/entry.rb

@@ -8,6 +8,7 @@ module Mongoid
       field :tracked_changes, :type => Hash, :default => {}
       field :modifier_id, :type => String
       field :model_attributes, :type => Hash
+      field :document_path, :type => Array
 
       belongs_to :audited, :polymorphic => true
 
@@ -50,6 +51,29 @@ module Mongoid
         @modifier = modifier
       end
 
+      def for_embedded_doc?
+        document_path.try(:length).to_i > 1
+      end
+
+      def audited
+        if for_embedded_doc?
+          lookup_from_document_path
+        else
+          audited_type.constantize.where(id: audited_id).first
+        end
+      end
+
+      def root
+        root = document_path.first
+        return audited if root.blank?
+
+        if for_embedded_doc?
+          root['class_name'].constantize.find(root['id'])
+        else
+          audited
+        end
+      end
+
       def respond_to?(sym, *args)
         key = sym.to_s
         (model_attributes.present? && model_attributes.has_key?(key)) || super
@@ -64,6 +88,32 @@ module Mongoid
           super
         end
       end
+
+      private
+
+      def lookup_from_document_path
+        return nil if document_path.blank?
+
+        document_path.reduce(root) do |current, path|
+          relation_match = if document_path_matches?(path, current)
+                             current
+                           elsif current.respond_to?(:detect)
+                             current.detect do |model|
+                               document_path_matches?(path, model)
+                             end
+                           end
+
+          if path['relation'].blank?
+            return relation_match
+          else
+            relation_match.send(path['relation'])
+          end
+        end
+      end
+
+      def document_path_matches?(path, object)
+        object.class.name == path['class_name'] && object.id == path['id']
+      end
     end
   end
 end

data/lib/mongoid/audit_log/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module AuditLog
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/mongoid-audit_log.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["bencrouse@gmail.com"]
   spec.description   = %q{Stupid simple audit logging for Mongoid}
   spec.summary       = %q{No fancy versioning, undo, redo, etc. Just saves changes to Mongoid models in a separate collection.}
-  spec.homepage      = "https://github.com/bencrouse/mongoid-audit-log"
+  spec.homepage      = "https://github.com/bencrouse/mongoid-audit_log"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/mongoid/audit_log/entry_spec.rb

@@ -10,12 +10,30 @@ module Mongoid
         class ::Product
           include Mongoid::Document
           include Mongoid::AuditLog
+          field :name, :type => String
+          embeds_many :variants
+        end
+
+        class ::Variant
+          include Mongoid::Document
+          include Mongoid::AuditLog
+          field :sku, :type => String
+          embedded_in :product
+          embeds_many :options
+        end
+
+        class ::Option
+          include Mongoid::Document
+          include Mongoid::AuditLog
+          field :name, :type => String
+          embedded_in :variant
         end
       end
 
       after(:all) do
         AuditLog.modifier_class_name = @remember_modifier_class_name
         Object.send(:remove_const, :Product)
+        Object.send(:remove_const, :Variant)
       end
 
       let(:user) { User.create! }
@@ -57,6 +75,17 @@ module Mongoid
         end
       end
 
+      describe '#audited' do
+        it 'uses the document path to find embedded documents' do
+          product = Product.create!(:name => 'Foo bar')
+          variant = product.variants.create!
+          option = AuditLog.record { variant.options.create! }
+
+          entry = Entry.desc(:created_at).first
+          entry.audited.should == option
+        end
+      end
+
       describe '#modifier_id=' do
         let(:entry) { Entry.new }
 

data/spec/mongoid/audit_log_spec.rb

@@ -12,6 +12,7 @@ module Mongoid
 
       class ::Variant
         include Mongoid::Document
+        include Mongoid::AuditLog
         field :sku, :type => String
         embedded_in :product
       end
@@ -124,6 +125,7 @@ module Mongoid
           entry = product.audit_log_entries.first
 
           entry.create?.should be_true
+          entry.root.should == product
 
           entry.tracked_changes.should == {
             'name' => [nil, 'Foo bar']
@@ -141,13 +143,14 @@ module Mongoid
           product.save!
 
           entry = product.audit_log_entries.first
+          entry.root.should == product
 
           entry.create?.should be_true
 
           entry.model_attributes.should == {
             '_id' => product.id,
             'name' => 'Foo bar',
-            'variants' => [{ '_id' => product.variants.first.id, 'sku'=>'sku' }]
+            'variants' => [{ '_id' => product.variants.first.id, 'sku' => 'sku' }]
           }
 
           entry.tracked_changes.should == {
@@ -155,6 +158,21 @@ module Mongoid
             'variants' => [{ 'sku' => [nil, 'sku'] }]
           }
         end
+
+        it 'tracks parents on embedded creations' do
+          product = Product.create!(:name => 'Foo bar')
+          variant = product.variants.create!(sku: 'sku')
+
+          entry = Mongoid::AuditLog::Entry.desc(:created_at).first
+          entry.root.should == product
+          entry.document_path.length.should == 2
+          entry.document_path.first['class_name'].should == product.class.name
+          entry.document_path.first['id'].should == product.id
+          entry.document_path.first['relation'].should == 'variants'
+          entry.document_path.second['class_name'].should == variant.class.name
+          entry.document_path.second['id'].should == variant.id
+          entry.document_path.second['relation'].should == nil
+        end
       end
 
       context 'update' do
@@ -164,6 +182,7 @@ module Mongoid
           entry = product.audit_log_entries.desc(:created_at).first
 
           entry.update?.should be_true
+          entry.root.should == product
           entry.tracked_changes.should == { 'name' => ['Foo bar', 'Bar baz'] }
         end
 
@@ -179,6 +198,7 @@ module Mongoid
           entry = product.audit_log_entries.desc(:created_at).first
 
           entry.update?.should be_true
+          entry.root.should == product
           entry.tracked_changes.should == {
             'name' => ['Foo bar', 'Bar baz'],
             'variants' => [{ 'sku' => ['sku', 'newsku'] }]
@@ -190,6 +210,23 @@ module Mongoid
           product.update_attributes(:name => 'Foo bar')
           product.audit_log_entries.length.should == 1
         end
+
+        it 'tracks parents on embedded updates' do
+          product = Product.create!(:name => 'Foo bar')
+          variant = product.variants.create!(sku: 'sku')
+          variant.sku = 'newsku'
+          variant.save!
+
+          entry = Mongoid::AuditLog::Entry.desc(:created_at).first
+          entry.root.should == product
+          entry.document_path.length.should == 2
+          entry.document_path.first['class_name'].should == product.class.name
+          entry.document_path.first['id'].should == product.id
+          entry.document_path.first['relation'].should == 'variants'
+          entry.document_path.second['class_name'].should == variant.class.name
+          entry.document_path.second['id'].should == variant.id
+          entry.document_path.second['relation'].should == nil
+        end
       end
 
       context 'destroy' do
@@ -199,6 +236,23 @@ module Mongoid
           entry = product.audit_log_entries.desc(:created_at).first
 
           entry.destroy?.should be_true
+          entry.root.should == nil
+        end
+
+        it 'tracks parents on embedded destroys' do
+          product = Product.create!(:name => 'Foo bar')
+          variant = product.variants.create!(sku: 'sku')
+          variant.destroy!
+
+          entry = Mongoid::AuditLog::Entry.desc(:created_at).first
+          entry.root.should == product
+          entry.document_path.length.should == 2
+          entry.document_path.first['class_name'].should == product.class.name
+          entry.document_path.first['id'].should == product.id
+          entry.document_path.first['relation'].should == 'variants'
+          entry.document_path.second['class_name'].should == variant.class.name
+          entry.document_path.second['id'].should == variant.id
+          entry.document_path.second['relation'].should == nil
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-audit_log
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Crouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -77,7 +77,7 @@ files:
 - spec/mongoid/audit_log_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-homepage: https://github.com/bencrouse/mongoid-audit-log
+homepage: https://github.com/bencrouse/mongoid-audit_log
 licenses:
 - MIT
 metadata: {}
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: No fancy versioning, undo, redo, etc. Just saves changes to Mongoid models
@@ -108,3 +108,4 @@ test_files:
 - spec/mongoid/audit_log_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
+has_rdoc: