mongoid-audit_log 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35867d14fd329fd4f087b5f01dab102b2b83bd9d
-  data.tar.gz: a98c23806a1fd139755419984fe9d0e8932b59be
+  metadata.gz: 76f6838e59f9a32deaa8bb63779f7f5cbb35b280
+  data.tar.gz: 52ec79ea1c7f19cac8f7632e3fb9792189f1580f
 SHA512:
-  metadata.gz: 2bbbbb0f5b34f99bbc1c7131adf7c8fb4b3482428f2615d3f516de3421a078c5e63908f90b022e590ce056a0bfe6816cc4f61a91d46c2cf160366a788532070f
-  data.tar.gz: 183f25bf3f728f06b626802cc034f16f75bc54850e225daafdd76bbb0e0a5e9f445a6e8646f732820c763165f3968e34f1200b54bebea9bba86d67e14d1a2a4a
+  metadata.gz: 17f735eaaf6b40708cf6ef734699a2356a004496945e9b6851a41bc6b41c9598b3de2efee47e157773f79b6ee89aaed0a4e68a52833d1d656c2142d0b5f1dccc
+  data.tar.gz: 10c684e7888e5db8153a1d8e7a49671d9e025a16d83230214a2b4d998e8a8819a22e850b4bfcec6f7823caf80354a4638beeffcdb4e00a0625798e179a1e65c2

data/README.md

@@ -128,6 +128,23 @@ model.audit_log_entries.first.create? # => true
 model.audit_log_entries.first.model_attributes # => {"name"=>"foo bar"}
 ```
 
+### Restoring
+
+You can restore models for `Mongoid::AuditLog::Entry` instances for deletions.
+This works for both root and embedded documents.
+
+Examples:
+```ruby
+model = Model.create!(:name => 'foo bar')
+Mongoid::AuditLog.record { model.destroy }
+
+entry = Mongoid::AuditLog::Entry.first
+entry.restore!
+
+model == Model.find_by(name: 'foo bar') # => true
+```
+
+It's possible to end up in a situation where a destroy entry cannot be restored, e.g. an entry deleting an embedded document for a root document that's already been deleted. In these scenarios, `Mongoid::AuditLog::Restore::InvalidRestore` will be raised.
 
 ## Contributing
 

data/lib/mongoid/audit_log.rb

@@ -3,6 +3,7 @@ require "mongoid/audit_log/config"
 require "mongoid/audit_log/entry"
 require "mongoid/audit_log/changes"
 require "mongoid/audit_log/embedded_changes"
+require "mongoid/audit_log/restore"
 
 module Mongoid
   module AuditLog
@@ -57,7 +58,7 @@ module Mongoid
     def self.current_modifier
       Thread.current[:mongoid_audit_log_modifier]
     end
-    
+
     def self.current_modifier=(modifier)
       Thread.current[:mongoid_audit_log_modifier] = modifier
     end

data/lib/mongoid/audit_log/entry.rb

@@ -9,6 +9,7 @@ module Mongoid
       field :modifier_id, :type => String
       field :model_attributes, :type => Hash
       field :document_path, :type => Array
+      field :restored, :type => Boolean, default: false
 
       if Gem::Version.new(Mongoid::VERSION) < Gem::Version.new('6.0.0.beta')
         belongs_to :audited, :polymorphic => true
@@ -82,6 +83,17 @@ module Mongoid
         end
       end
 
+      def restore!
+        raise Restore::InvalidRestore if restored? || !destroy?
+
+        Restore.new(self).perform
+        update_attributes!(:restored => true)
+      end
+
+      def restorable?
+        destroy? && !restored? && Restore.new(self).valid?
+      end
+
       def respond_to?(sym, *args)
         key = sym.to_s
         (model_attributes.present? && model_attributes.has_key?(key)) || super

data/lib/mongoid/audit_log/restore.rb

@@ -0,0 +1,94 @@
+module Mongoid
+  module AuditLog
+    class Restore
+      class DuplicateError < StandardError; end
+      class InvalidRestore < StandardError; end
+
+      attr_reader :entry
+      delegate :name, to: :restored
+      delegate :for_embedded_doc?, to: :entry
+
+      def initialize(entry)
+        @entry = entry
+      end
+
+      def valid?
+        !entry.for_embedded_doc? || restored_root.present?
+      end
+
+      def perform
+        restored.attributes = attributes
+        restored.save!
+      end
+
+      def attributes
+        @attributes ||=
+          begin
+            attrs = entry.model_attributes.deep_dup
+            restored.send(:process_localized_attributes, model_class, attrs)
+            attrs
+          end
+      end
+
+      def model_class
+        entry.audited_type.constantize
+      end
+
+      def restored
+        @restored ||=
+          if entry.for_embedded_doc?
+            find_embedded_restored
+          else
+            find_root_restored
+          end
+      end
+
+      def find_root_restored
+        model_class.new
+      end
+
+      def find_embedded_restored
+        raise InvalidRestore if restored_root.blank?
+
+        last_path = document_path.last
+        metadata = restored_root.class.reflect_on_association(last_path['relation'])
+        relation = restored_root.send(last_path['relation'])
+
+        if metadata.many?
+          relation.build
+        elsif relation.present?
+          raise DuplicateError
+        else
+          restored_root.send("build_#{metadata.name}")
+        end
+      end
+
+      def restored_root
+        document_path.reduce(entry.root) do |current, path|
+          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 == document_path.last
+            return match
+          else
+            match.send(path['relation'])
+          end
+        end
+      end
+
+      def document_path
+        # don't need last because that entry represents the deleted doc
+        entry.document_path[0..-2]
+      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.4.1"
+    VERSION = "0.5.0"
   end
 end

data/spec/mongoid/audit_log/entry_spec.rb

@@ -144,6 +144,74 @@ module Mongoid
           entry.root.should be_nil
         end
       end
+
+      describe '#restore!' do
+        it 'marks the entry as restored' do
+          product = Product.create!(:name => 'Foo bar')
+          AuditLog.record { product.destroy }
+
+          entry = Entry.desc(:created_at).first
+          entry.restore!
+          entry.should be_restored
+        end
+
+        it 'raises InvalidRestore if already restored' do
+          product = Product.create!(:name => 'Foo bar')
+          AuditLog.record { product.destroy }
+
+          entry = Entry.desc(:created_at).first
+          entry.restore!
+
+          expect { entry.restore! }.to raise_error(Restore::InvalidRestore)
+        end
+
+        it 'raises InvalidRestore if not a destroy' do
+          product = Product.create!(:name => 'Foo bar')
+          AuditLog.record { product.variants.create! }
+
+          entry = Entry.desc(:created_at).first
+          expect { entry.restore! }.to raise_error(Restore::InvalidRestore)
+        end
+
+        it 'raises InvalidRestore if the root is blank' do
+          product = Product.create!(:name => 'Foo bar')
+          product.variants.create!
+          AuditLog.record { product.variants.first.destroy }
+          product.destroy
+
+          entry = Entry.desc(:created_at).first
+          expect { entry.restore! }.to raise_error(Restore::InvalidRestore)
+        end
+      end
+
+      describe '#restorable?' do
+        it 'is false if already restored' do
+          product = Product.create!(:name => 'Foo bar')
+          AuditLog.record { product.destroy }
+
+          entry = Entry.desc(:created_at).first
+          entry.restore!
+          entry.should_not be_restorable
+        end
+
+        it 'is false if not a destroy' do
+          product = Product.create!(:name => 'Foo bar')
+          AuditLog.record { product.variants.create! }
+
+          entry = Entry.desc(:created_at).first
+          entry.should_not be_restorable
+        end
+
+        it 'is false is root is blank' do
+          product = Product.create!(:name => 'Foo bar')
+          product.variants.create!
+          AuditLog.record { product.variants.first.destroy }
+          product.destroy
+
+          entry = Entry.desc(:created_at).first
+          entry.should_not be_restorable
+        end
+      end
     end
   end
 end

data/spec/mongoid/audit_log/restore_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Mongoid
+  module AuditLog
+    describe Restore do
+      before(:all) do
+        class ::First
+          include Mongoid::Document
+          include Mongoid::AuditLog
+
+          field :name, type: String, localize: true
+          embeds_many :seconds
+        end
+
+        class ::Second
+          include Mongoid::Document
+          include Mongoid::AuditLog
+
+          field :name, type: String, localize: true
+          embedded_in :first
+          embeds_many :thirds
+        end
+
+        class ::Third
+          include Mongoid::Document
+          include Mongoid::AuditLog
+
+          field :name, type: String, localize: true
+          embedded_in :second
+        end
+      end
+
+      after(:all) do
+        [:First, :Second, :Third].each { |c| Object.send(:remove_const, c) }
+      end
+
+      describe '.perform' do
+        it 'restores a root document' do
+          root = First.create!(name: 'Foo')
+          Mongoid::AuditLog.record { root.destroy }
+          restore = Restore.new(Mongoid::AuditLog::Entry.first)
+          restore.perform
+
+          restore.restored.should be_persisted
+          First.count.should == 1
+          restore.restored.should == First.first
+          restore.restored.name.should == 'Foo'
+        end
+
+        it 'restores an embedded array document' do
+          root = First.create!(name: 'Foo', seconds: [{ name: 'Bar' }])
+          Mongoid::AuditLog.record { root.seconds.first.destroy }
+          restore = Restore.new(Mongoid::AuditLog::Entry.first)
+          restore.perform
+          root.reload
+
+          restore.restored.should be_persisted
+          root.seconds.length.should == 1
+          root.seconds.first.should == restore.restored
+          root.seconds.first.name.should == 'Bar'
+        end
+
+        it 'restores a nested array document' do
+          root = First.create!(
+            name: 'Foo',
+            seconds: [{ name: 'Bar', thirds: [{ name: 'Baz' }] }]
+          )
+          Mongoid::AuditLog.record { root.seconds.first.thirds.first.destroy }
+          restore = Restore.new(Mongoid::AuditLog::Entry.first)
+          restore.perform
+          root.reload
+
+          restore.restored.should be_persisted
+          root.seconds.first.thirds.length.should == 1
+          root.seconds.first.thirds.first.should == restore.restored
+          root.seconds.first.thirds.first.name.should == 'Baz'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-audit_log
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Crouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -70,10 +70,12 @@ files:
 - lib/mongoid/audit_log/config.rb
 - lib/mongoid/audit_log/embedded_changes.rb
 - lib/mongoid/audit_log/entry.rb
+- lib/mongoid/audit_log/restore.rb
 - lib/mongoid/audit_log/version.rb
 - mongoid-audit_log.gemspec
 - spec/mongoid/audit_log/changes_spec.rb
 - spec/mongoid/audit_log/entry_spec.rb
+- spec/mongoid/audit_log/restore_spec.rb
 - spec/mongoid/audit_log_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
@@ -105,6 +107,7 @@ summary: No fancy versioning, undo, redo, etc. Just saves changes to Mongoid mod
 test_files:
 - spec/mongoid/audit_log/changes_spec.rb
 - spec/mongoid/audit_log/entry_spec.rb
+- spec/mongoid/audit_log/restore_spec.rb
 - spec/mongoid/audit_log_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb