mongoid_paranoia 0.1.2 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjFjZDkxZDIzNmM0MzRjMDNiODYyNmRkOGZjNWNiMzljZmI1NGU2Yg==
-  data.tar.gz: !binary |-
-    NjAxNjc2MjRiYjAxNWE5ZTc5M2UyYTRiNTQ4ZmZmODRmMzJhYjY5YQ==
+SHA1:
+  metadata.gz: deac1371595d42d09d10aab1039561adb1190da7
+  data.tar.gz: b29cbcc347078b464c218646b58780a8f50bb3bf
 SHA512:
-  metadata.gz: !binary |-
-    YjBiYmQ2Zjc3MjEyZjAzZTVkNTM2ZDQ4NWI4NzYwM2YzMWIzODRjY2NmYmNl
-    ZDIxZmVjNDE1NTI0ZTYzOTBmNWI2NGE0YzQ4ZDVhOTA5NjhhZGMwNDgwMmFh
-    MGFhZDNhYTkwZTQ0ZTc3ZTNlNGNiOWE3MThmMWY1NTNkOGNiMzA=
-  data.tar.gz: !binary |-
-    NjkzMTE1N2UxMDY1ZWEyYWJmNjA0Njg1Zjk0MWYxMmRkZjExZDEyNWQzZjE2
-    YzA0ZmUyNzRlZjc3YjRiM2M0NTI3ZTE2MzQ2NTNjOWJiMGExZTJiMWI4ZmZm
-    Zjc1MGM1MTU2YTgxZjNiOGY2NGExOGI4OTdlMjY5YjBjNWVkMWY=
+  metadata.gz: 6b0dc3130837783326de78218f63c4f807c2c09cf45de8f52038dec7eb12667488362db029954a789c79377f9266d4ff78d247ed76097ba4348389b28354218e
+  data.tar.gz: 45a65478ef3edab1351c4834b52afed11c26f117721ad5c444b94439ebe159cdb6fad6a31cf31254b2eaaaaeef80be352541b26f4525caf161605d95dc75afe6

data/LICENSE

@@ -1,22 +1,22 @@
-Copyright (c) 2013 Josef Šimánek
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+Copyright (c) 2013 Josef Šimánek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,110 +1,124 @@
-# Paranoid Documents for Mongoid 4 [![Build Status](https://travis-ci.org/simi/mongoid-paranoia.png?branch=master)](https://travis-ci.org/simi/mongoid-paranoia)
-
-`Mongoid::Paranoia` enables a "soft delete" of Mongoid documents. Instead of being removed from the database, paranoid docs are flagged with a `deleted_at` timestamp and are ignored from queries by default.
-
-The `Mongoid::Paranoia` functionality was originally supported in Mongoid itself, but was dropped from version 4.0.0 onwards. This gem was extracted from the [Mongoid 3.0.0-stable branch](https://github.com/simi/mongoid-paranoia/tree/3.0.0-stable). This gem should not be used with Mongoid versions 3.x and prior.
-
-**Caution:** This repo/gem `mongoid_paranoia` (underscored) is different than `mongoid-paranoia` (hyphenated).
-The owner of `mongoid-paranoia` (hyphenated) is not accepting enhancements and has declined our requests
-to share maintenance of the gem.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'mongoid_paranoia'
-```
-
-## Changes in 4.0
-
-### Uniqueness validator is not overriden
-
-#### Old syntax:
-```ruby
-validates_uniqueness_of :title
-validates :title, :uniqueness => true
-```
-
-#### New syntax:
-```ruby
-validates :title, uniqueness: { conditions: -> { where(deleted_at: nil) } }
-```
-
-## Usage
-
-```ruby
-class Person
-  include Mongoid::Document
-  include Mongoid::Paranoia
-end
-
-person.delete   # Sets the deleted_at field to the current time, ignoring callbacks.
-person.delete!  # Permanently deletes the document, ignoring callbacks.
-person.destroy  # Sets the deleted_at field to the current time, firing callbacks.
-person.destroy! # Permanently deletes the document, firing callbacks.
-person.restore  # Brings the "deleted" document back to life.
-```
-
-The documents that have been "flagged" as deleted (soft deleted) can be accessed at any time by calling the deleted class method on the class.
-
-```ruby
-Person.deleted # Returns documents that have been "flagged" as deleted.
-```
-
-You can also access all documents (both deleted and non-deleted) at any time by using the `unscoped` class method:
-
-```ruby
-Person.unscoped.all # Returns all documents, both deleted and non-deleted
-```
-
-### Callbacks ([@zhouguangming](https://github.com/zhouguangming))
-
-`before_restore`, `after_restore` and `around_restore` callbacks are added to your model. They work similarly to the `before_destroy`, `after_destroy` and `around_destroy` callbacks.
-
-```ruby
-class User
-  include Mongoid::Document
-  include Mongoid::Paranoia
-  
-  before_restore :before_restore_action
-  after_restore  :after_restore_action
-  around_restore :around_restore_action
-
-  private
-
-  def before_restore_action
-    puts "BEFORE"
-  end
-
-  def after_restore_action
-    puts "AFTER"
-  end
-  
-  def around_restore_action
-    puts "AROUND - BEFORE"
-    yield # restoring
-    puts "AROUND - AFTER"
-  end
-end
-```
-
-## TODO
-- get rid of [monkey_patches.rb](https://github.com/simi/mongoid-paranoia/blob/master/lib/mongoid/paranoia/monkey_patches.rb)
-- [review persisted? behaviour](https://github.com/simi/mongoid-paranoia/issues/2)
-
-## Authors
-
-* original [Mongoid](https://github.com/mongoid/mongoid) implementation by [@durran](https://github.com/durran)
-* extracted from [Mongoid](https://github.com/mongoid/mongoid) by [@simi](https://github.com/simi)
-* [documentation improvements](https://github.com/simi/mongoid-paranoia/pull/3) by awesome [@loopj](https://github.com/loopj)
-* [latest mongoid support, restore_callback support](https://github.com/simi/mongoid-paranoia/pull/8) by fabulous [@zhouguangming](https://github.com/zhouguangming)
-
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Paranoid Documents for Mongoid 4 and 5 [![Build Status](https://travis-ci.org/simi/mongoid_paranoia.png?branch=master)](https://travis-ci.org/simi/mongoid_paranoia)[![Gitter chat](https://badges.gitter.im/simi/mongoid_paranoia.png)](https://gitter.im/simi/mongoid_paranoia)
+
+`Mongoid::Paranoia` enables a "soft delete" of Mongoid documents. Instead of being removed from the database, paranoid docs are flagged with a `deleted_at` timestamp and are ignored from queries by default.
+
+The `Mongoid::Paranoia` functionality was originally supported in Mongoid itself, but was dropped from version 4.0.0 onwards. This gem was extracted from the [Mongoid 3.0.0-stable branch](https://github.com/mongoid/mongoid/tree/3.0.0-stable). This gem should not be used with Mongoid versions 3.x and prior.
+
+**Caution:** This repo/gem `mongoid_paranoia` (underscored) is different than [mongoid-paranoia](https://github.com/haihappen/mongoid-paranoia) (hyphenated). The goal of `mongoid-paranoia` (hyphenated) is to stay API compatible and it only accepts security fixes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_paranoia'
+```
+
+## Changes in 4.0
+
+### Uniqueness validator is not overriden
+
+#### Old syntax:
+```ruby
+validates_uniqueness_of :title
+validates :title, :uniqueness => true
+```
+
+#### New syntax:
+```ruby
+validates :title, uniqueness: { conditions: -> { where(deleted_at: nil) } }
+```
+
+## Usage
+
+```ruby
+class Person
+  include Mongoid::Document
+  include Mongoid::Paranoia
+end
+
+person.delete   # Sets the deleted_at field to the current time, ignoring callbacks.
+person.delete!  # Permanently deletes the document, ignoring callbacks.
+person.destroy  # Sets the deleted_at field to the current time, firing callbacks.
+person.destroy! # Permanently deletes the document, firing callbacks.
+person.restore  # Brings the "deleted" document back to life.
+person.restore(:recursive => true) # Brings "deleted" associated documents back to life recursively
+```
+
+The documents that have been "flagged" as deleted (soft deleted) can be accessed at any time by calling the deleted class method on the class.
+
+```ruby
+Person.deleted # Returns documents that have been "flagged" as deleted.
+```
+
+You can also access all documents (both deleted and non-deleted) at any time by using the `unscoped` class method:
+
+```ruby
+Person.unscoped.all # Returns all documents, both deleted and non-deleted
+```
+
+You can also configure the paranoid field naming on a global basis.  Within the context of a Rails app this is done via an initializer.
+
+```ruby
+# config/initializers/mongoid_paranoid.rb
+
+Mongoid::Paranoia.configure do |c|
+  c.paranoid_field = :myFieldName
+end
+```
+
+### Callbacks
+
+#### Restore
+`before_restore`, `after_restore` and `around_restore` callbacks are added to your model. They work similarly to the `before_destroy`, `after_destroy` and `around_destroy` callbacks.
+
+#### Remove
+`before_remove`, `after_remove` and `around_remove` are added to your model. They are called when record is deleted permanently .
+
+#### Example
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Paranoia
+
+  before_restore :before_restore_action
+  after_restore  :after_restore_action
+  around_restore :around_restore_action
+
+  private
+
+  def before_restore_action
+    puts "BEFORE"
+  end
+
+  def after_restore_action
+    puts "AFTER"
+  end
+
+  def around_restore_action
+    puts "AROUND - BEFORE"
+    yield # restoring
+    puts "AROUND - AFTER"
+  end
+end
+```
+
+## TODO
+- get rid of [monkey_patches.rb](https://github.com/simi/mongoid_paranoia/blob/master/lib/mongoid/paranoia/monkey_patches.rb)
+- [review persisted? behaviour](https://github.com/simi/mongoid_paranoia/issues/2)
+
+## Authors
+
+* original [Mongoid](https://github.com/mongoid/mongoid) implementation by [@durran](https://github.com/durran)
+* extracted from [Mongoid](https://github.com/mongoid/mongoid) by [@simi](https://github.com/simi)
+* [documentation improvements](https://github.com/simi/mongoid_paranoia/pull/3) by awesome [@loopj](https://github.com/loopj)
+* [latest mongoid support, restore_callback support](https://github.com/simi/mongoid_paranoia/pull/8) by fabulous [@zhouguangming](https://github.com/zhouguangming)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/mongoid-paranoia.rb

@@ -1 +1 @@
-require "mongoid/paranoia"
+require "mongoid/paranoia"

data/lib/mongoid/paranoia.rb

@@ -1,154 +1,208 @@
-# encoding: utf-8
-require 'mongoid/paranoia/monkey_patches'
-require 'active_support'
-require 'active_support/deprecation'
-
-module Mongoid
-
-  # Include this module to get soft deletion of root level documents.
-  # This will add a deleted_at field to the +Document+, managed automatically.
-  # Potentially incompatible with unique indices. (if collisions with deleted items)
-  #
-  # @example Make a document paranoid.
-  #   class Person
-  #     include Mongoid::Document
-  #     include Mongoid::Paranoia
-  #   end
-  module Paranoia
-    include Mongoid::Persistable::Deletable
-    extend ActiveSupport::Concern
-
-    included do
-      field :deleted_at, type: Time
-      self.paranoid = true
-
-      default_scope -> { where(deleted_at: nil) }
-      scope :deleted, -> { ne(deleted_at: nil) }
-      define_model_callbacks :restore
-    end
-
-    # Delete the paranoid +Document+ from the database completely. This will
-    # run the destroy callbacks.
-    #
-    # @example Hard destroy the document.
-    #   document.destroy!
-    #
-    # @return [ true, false ] If the operation succeeded.
-    #
-    # @since 1.0.0
-    def destroy!
-      run_callbacks(:destroy) { delete! }
-    end
-
-    # Override the persisted method to allow for the paranoia gem.
-    # If a paranoid record is selected, then we only want to check
-    # if it's a new record, not if it is "destroyed"
-    #
-    # @example
-    #   document.persisted?
-    #
-    # @return [ true, false ] If the operation succeeded.
-    #
-    # @since 4.0.0
-    def persisted?
-      !new_record?
-    end
-
-    # Delete the +Document+, will set the deleted_at timestamp and not actually
-    # delete it.
-    #
-    # @example Soft remove the document.
-    #   document.remove
-    #
-    # @param [ Hash ] options The database options.
-    #
-    # @return [ true ] True.
-    #
-    # @since 1.0.0
-    def remove_with_paranoia(options = {})
-      cascade!
-      time = self.deleted_at = Time.now
-      paranoid_collection.find(atomic_selector).
-        update({ "$set" => { paranoid_field => time }})
-      @destroyed = true
-      true
-    end
-    alias_method_chain :remove, :paranoia
-    alias :delete :remove
-
-    # Delete the paranoid +Document+ from the database completely.
-    #
-    # @example Hard delete the document.
-    #   document.delete!
-    #
-    # @return [ true, false ] If the operation succeeded.
-    #
-    # @since 1.0.0
-    def delete!
-      remove_without_paranoia
-    end
-
-    # Determines if this document is destroyed.
-    #
-    # @example Is the document destroyed?
-    #   person.destroyed?
-    #
-    # @return [ true, false ] If the document is destroyed.
-    #
-    # @since 1.0.0
-    def destroyed?
-      (@destroyed ||= false) || !!deleted_at
-    end
-    alias :deleted? :destroyed?
-
-    # Restores a previously soft-deleted document. Handles this by removing the
-    # deleted_at flag.
-    #
-    # @example Restore the document from deleted state.
-    #   document.restore
-    #
-    # TODO: @return [ Time ] The time the document had been deleted.
-    #
-    # @since 1.0.0
-    def restore
-      run_callbacks(:restore) do
-        paranoid_collection.find(atomic_selector).
-          update({ "$unset" => { paranoid_field => true }})
-        attributes.delete("deleted_at")
-        @destroyed = false
-        true
-      end
-    end
-
-    # Returns a string representing the documents's key suitable for use in URLs.
-    def to_param
-      new_record? ? nil : to_key.join('-')
-    end
-
-    private
-
-    # Get the collection to be used for paranoid operations.
-    #
-    # @example Get the paranoid collection.
-    #   document.paranoid_collection
-    #
-    # @return [ Collection ] The root collection.
-    #
-    # @since 2.3.1
-    def paranoid_collection
-      embedded? ? _root.collection : self.collection
-    end
-
-    # Get the field to be used for paranoid operations.
-    #
-    # @example Get the paranoid field.
-    #   document.paranoid_field
-    #
-    # @return [ String ] The deleted at field.
-    #
-    # @since 2.3.1
-    def paranoid_field
-      embedded? ? "#{atomic_position}.deleted_at" : "deleted_at"
-    end
-  end
-end
+# encoding: utf-8
+require 'mongoid/compatibility'
+require 'mongoid/paranoia/monkey_patches'
+require 'mongoid/paranoia/configuration'
+require 'active_support'
+require 'active_support/deprecation'
+
+module Mongoid
+
+  # Include this module to get soft deletion of root level documents.
+  # This will add a deleted_at field to the +Document+, managed automatically.
+  # Potentially incompatible with unique indices. (if collisions with deleted items)
+  #
+  # @example Make a document paranoid.
+  #   class Person
+  #     include Mongoid::Document
+  #     include Mongoid::Paranoia
+  #   end
+  module Paranoia
+    include Mongoid::Persistable::Deletable
+    extend ActiveSupport::Concern
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    # Allow the paranoid +Document+ to use an alternate field name for deleted_at.
+    #
+    # @example
+    #   Mongoid::Paranoia.configure do |c|
+    #     c.paranoid_field = :myFieldName
+    #   end
+    def self.configure
+      yield(configuration)
+    end
+
+    included do
+      field Paranoia.configuration.paranoid_field, as: :deleted_at, type: Time
+
+      self.paranoid = true
+
+      default_scope -> { where(deleted_at: nil) }
+      scope :deleted, -> { ne(deleted_at: nil) }
+      define_model_callbacks :restore
+      define_model_callbacks :remove
+    end
+
+    # Delete the paranoid +Document+ from the database completely. This will
+    # run the destroy callbacks.
+    #
+    # @example Hard destroy the document.
+    #   document.destroy!
+    #
+    # @return [ true, false ] If the operation succeeded.
+    #
+    # @since 1.0.0
+    def destroy!
+      run_callbacks(:destroy) do
+        run_callbacks(:remove) do
+          delete!
+        end
+      end
+    end
+
+    # Override the persisted method to allow for the paranoia gem.
+    # If a paranoid record is selected, then we only want to check
+    # if it's a new record, not if it is "destroyed"
+    #
+    # @example
+    #   document.persisted?
+    #
+    # @return [ true, false ] If the operation succeeded.
+    #
+    # @since 4.0.0
+    def persisted?
+      !new_record?
+    end
+
+    # Delete the +Document+, will set the deleted_at timestamp and not actually
+    # delete it.
+    #
+    # @example Soft remove the document.
+    #   document.remove
+    #
+    # @param [ Hash ] options The database options.
+    #
+    # @return [ true ] True.
+    #
+    # @since 1.0.0
+    def remove_with_paranoia(options = {})
+      cascade!
+      time = self.deleted_at = Time.now
+      update("$set" => { paranoid_field => time })
+      @destroyed = true
+      true
+    end
+    alias_method_chain :remove, :paranoia
+    alias :delete :remove
+
+    # Delete the paranoid +Document+ from the database completely.
+    #
+    # @example Hard delete the document.
+    #   document.delete!
+    #
+    # @return [ true, false ] If the operation succeeded.
+    #
+    # @since 1.0.0
+    def delete!
+      remove_without_paranoia
+    end
+
+    # Determines if this document is destroyed.
+    #
+    # @example Is the document destroyed?
+    #   person.destroyed?
+    #
+    # @return [ true, false ] If the document is destroyed.
+    #
+    # @since 1.0.0
+    def destroyed?
+      (@destroyed ||= false) || !!deleted_at
+    end
+    alias :deleted? :destroyed?
+
+    # Restores a previously soft-deleted document. Handles this by removing the
+    # deleted_at flag.
+    #
+    # @example Restore the document from deleted state.
+    #   document.restore
+    #
+    # For resoring associated documents use :recursive => true
+    # @example Restore the associated documents from deleted state.
+    #   document.restore(:recursive => true)
+    #
+    # TODO: @return [ Time ] The time the document had been deleted.
+    #
+    # @since 1.0.0
+    def restore(opts = {})
+      run_callbacks(:restore) do
+        update("$unset" => { paranoid_field => true })
+        attributes.delete("deleted_at")
+        @destroyed = false
+        restore_relations if opts[:recursive]
+        true
+      end
+    end
+
+    # Returns a string representing the documents's key suitable for use in URLs.
+    def to_param
+      new_record? ? nil : to_key.join('-')
+    end
+
+    def restore_relations
+      self.relations.each_pair do |name, metadata|
+        next unless metadata[:dependent] == :destroy
+        relation = self.send(name)
+        if relation.present? && relation.paranoid?
+          Array.wrap(relation).each do |doc|
+            doc.restore(:recursive => true)
+          end
+        end
+      end
+    end
+
+    private
+
+    # Get the collection to be used for paranoid operations.
+    #
+    # @example Get the paranoid collection.
+    #   document.paranoid_collection
+    #
+    # @return [ Collection ] The root collection.
+    def paranoid_collection
+      embedded? ? _root.collection : self.collection
+    end
+
+    # Get the field to be used for paranoid operations.
+    #
+    # @example Get the paranoid field.
+    #   document.paranoid_field
+    #
+    # @return [ String ] The deleted at field.
+    def paranoid_field
+      field = Paranoia.configuration.paranoid_field
+      embedded? ? "#{atomic_position}.#{field}" : field
+    end
+
+    # Update value in the collection.
+    #
+    # @return [ Object ] Update result.
+    def update(value)
+      query = paranoid_collection.find(atomic_selector)
+      if Mongoid::Compatibility::Version.mongoid5?
+        query.update_one(value)
+      else
+        query.update(value)
+      end
+    end
+  end
+end