mongoid_paranoia 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43d1da1cdc376721364043d5031170e7958fffcb759f9c0e64990a51ba0f5480
-  data.tar.gz: b5d1105826ee2edfa11a1b1432230200986ddb8d55b844dc80487c27ccb7cc48
+  metadata.gz: ec456afdb66a1a23fdb5dc73db06b9dc6344932f8aa3c95b378ca60560aea474
+  data.tar.gz: b80b6cfaedfb9523b9dbfe791d586493eb4c9d3e65b7286d3cdc2010d8f9874e
 SHA512:
-  metadata.gz: 306b10fc581eb21195661f6303bf76316854c1cfb5be09c33443b51b4fa865851d4b4c819b7402d7e269684358f62773adbaca4003c7c0b87ef856a9ddcb608e
-  data.tar.gz: 1466019a022ce6a6a419d49794ba6c9a00121183dacbe982519174e2b6cf155261e44245bff87711e6333f42cc0a86352dbe4f4ef180f86a3cd8717073c54b6b
+  metadata.gz: 3aff3ad8f7f06f0a1498143baf6cf72d58c24b99b3a4f0bfb19fd314ec836625356291989293ddee2dc230d148dda65f84bc153660bd00566ba8bc727e21ee9f
+  data.tar.gz: 5322c2f12d84591a8e0bc3463faf1e82571f09c5877bc3a3f7bcfbf7c10c87e198bb8be2add2ab42c6e71341df77fdbe7dbe368ccc476d7e44c8f41839c283cb

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,117 +1,117 @@
-# Paranoid Documents for Mongoid
-[![Build Status](https://travis-ci.org/simi/mongoid_paranoia.svg?branch=master)](https://travis-ci.org/simi/mongoid_paranoia) [![Gem Version](https://img.shields.io/gem/v/mongoid_paranoia.svg)](https://rubygems.org/gems/mongoid_paranoia) [![Gitter chat](https://badges.gitter.im/simi/mongoid_paranoia.svg)](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. Current master branch targeted on Mongoid 6.0. With release 0.3.0 Mongoid 4 and 5 versions will be dropped.
-
-**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'
-```
-
-## 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
-```
-
-### Validations
-#### You need override uniqueness validates
-
-```ruby
-validates :title, uniqueness: { conditions: -> { where(deleted_at: nil) } }
-```
-
-### 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
+# Paranoid Documents for Mongoid
+[![Build Status](https://travis-ci.org/simi/mongoid_paranoia.svg?branch=master)](https://travis-ci.org/simi/mongoid_paranoia) [![Gem Version](https://img.shields.io/gem/v/mongoid_paranoia.svg)](https://rubygems.org/gems/mongoid_paranoia) [![Gitter chat](https://badges.gitter.im/simi/mongoid_paranoia.svg)](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. Current master branch targeted on Mongoid 6.0. With release 0.3.0 Mongoid 4 and 5 versions will be dropped.
+
+**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'
+```
+
+## 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
+```
+
+### Validations
+#### You need override uniqueness validates
+
+```ruby
+validates :title, uniqueness: { conditions: -> { where(deleted_at: nil) } }
+```
+
+### 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/configuration.rb

@@ -1,11 +1,13 @@
-module Mongoid
-  module Paranoia
-    class Configuration
-      attr_accessor :paranoid_field
-
-      def initialize
-        @paranoid_field = :deleted_at
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Mongoid
+  module Paranoia
+    class Configuration
+      attr_accessor :paranoid_field
+
+      def initialize
+        @paranoid_field = :deleted_at
+      end
+    end
+  end
+end

data/lib/mongoid/paranoia/monkey_patches.rb

@@ -1,113 +1,114 @@
-# encoding: utf-8
-module Mongoid
-  module Paranoia
-    module Document
-      extend ActiveSupport::Concern
-
-      included do
-        # Indicates whether or not the document includes Mongoid::Paranoia.
-        # In Mongoid 3, this method was defined on all Mongoid::Documents.
-        # In Mongoid 4, it is no longer defined, hence we are shimming it here.
-        class_attribute :paranoid
-      end
-    end
-  end
-end
-
-Mongoid::Document.send(:include, Mongoid::Paranoia::Document)
-
-module Mongoid
-  module Association
-    module Nested
-      class Many
-        # Destroy the child document, needs to do some checking for embedded
-        # relations and delay the destroy in case parent validation fails.
-        #
-        # @api private
-        #
-        # @example Destroy the child.
-        #   builder.destroy(parent, relation, doc)
-        #
-        # @param [ Document ] parent The parent document.
-        # @param [ Proxy ] relation The relation proxy.
-        # @param [ Document ] doc The doc to destroy.
-        #
-        # @since 3.0.10
-        def destroy(parent, relation, doc)
-          doc.flagged_for_destroy = true
-          if !doc.embedded? || parent.new_record? || doc.paranoid?
-            destroy_document(relation, doc)
-          else
-            parent.flagged_destroys.push(->{ destroy_document(relation, doc) })
-          end
-        end
-      end
-    end
-  end
-end
-
-module Mongoid
-  module Association
-    module Embedded
-      class EmbedsMany
-        class Proxy < Association::Many
-          # Delete the supplied document from the target. This method is proxied
-          # in order to reindex the array after the operation occurs.
-          #
-          # @example Delete the document from the relation.
-          #   person.addresses.delete(address)
-          #
-          # @param [ Document ] document The document to be deleted.
-          #
-          # @return [ Document, nil ] The deleted document or nil if nothing deleted.
-          #
-          # @since 2.0.0.rc.1
-          def delete(document)
-            execute_callback :before_remove, document
-            doc = _target.delete_one(document)
-            if doc && !_binding?
-              _unscoped.delete_one(doc) unless doc.paranoid?
-              if _assigning?
-                if doc.paranoid?
-                  doc.destroy(suppress: true)
-                else
-                  _base.add_atomic_pull(doc)
-                end
-              else
-                doc.delete(suppress: true)
-                unbind_one(doc)
-              end
-            end
-            reindex
-            execute_callback :after_remove, document
-            doc
-          end
-        end
-      end
-    end
-  end
-end
-
-module Mongoid
-  module Association
-    module Embedded
-      class EmbedsMany
-        class Proxy < Association::Many
-          # For use only with Mongoid::Paranoia - will be removed in 4.0.
-          #
-          # @example Get the deleted documents from the relation.
-          #   person.paranoid_phones.deleted
-          #
-          # @return [ Criteria ] The deleted documents.
-          #
-          # @since 3.0.10
-          def deleted
-            unscoped.deleted
-          end
-          # This class handles the behaviour for a document that embeds many other
-          # documents within in it as an array.
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Mongoid
+  module Paranoia
+    module Document
+      extend ActiveSupport::Concern
+
+      included do
+        # Indicates whether or not the document includes Mongoid::Paranoia.
+        # In Mongoid 3, this method was defined on all Mongoid::Documents.
+        # In Mongoid 4, it is no longer defined, hence we are shimming it here.
+        class_attribute :paranoid
+      end
+    end
+  end
+end
+
+Mongoid::Document.include Mongoid::Paranoia::Document
+
+module Mongoid
+  module Association
+    module Nested
+      class Many
+        # Destroy the child document, needs to do some checking for embedded
+        # relations and delay the destroy in case parent validation fails.
+        #
+        # @api private
+        #
+        # @example Destroy the child.
+        #   builder.destroy(parent, relation, doc)
+        #
+        # @param [ Document ] parent The parent document.
+        # @param [ Proxy ] relation The relation proxy.
+        # @param [ Document ] doc The doc to destroy.
+        #
+        # @since 3.0.10
+        def destroy(parent, relation, doc)
+          doc.flagged_for_destroy = true
+          if !doc.embedded? || parent.new_record? || doc.paranoid?
+            destroy_document(relation, doc)
+          else
+            parent.flagged_destroys.push(-> { destroy_document(relation, doc) })
+          end
+        end
+      end
+    end
+  end
+end
+
+module Mongoid
+  module Association
+    module Embedded
+      class EmbedsMany
+        class Proxy < Association::Many
+          # Delete the supplied document from the target. This method is proxied
+          # in order to reindex the array after the operation occurs.
+          #
+          # @example Delete the document from the relation.
+          #   person.addresses.delete(address)
+          #
+          # @param [ Document ] document The document to be deleted.
+          #
+          # @return [ Document, nil ] The deleted document or nil if nothing deleted.
+          #
+          # @since 2.0.0.rc.1
+          def delete(document)
+            execute_callback :before_remove, document
+            doc = _target.delete_one(document)
+            if doc && !_binding?
+              _unscoped.delete_one(doc) unless doc.paranoid?
+              if _assigning?
+                if doc.paranoid?
+                  doc.destroy(suppress: true)
+                else
+                  _base.add_atomic_pull(doc)
+                end
+              else
+                doc.delete(suppress: true)
+                unbind_one(doc)
+              end
+            end
+            reindex
+            execute_callback :after_remove, document
+            doc
+          end
+        end
+      end
+    end
+  end
+end
+
+module Mongoid
+  module Association
+    module Embedded
+      class EmbedsMany
+        class Proxy < Association::Many
+          # For use only with Mongoid::Paranoia - will be removed in 4.0.
+          #
+          # @example Get the deleted documents from the relation.
+          #   person.paranoid_phones.deleted
+          #
+          # @return [ Criteria ] The deleted documents.
+          #
+          # @since 3.0.10
+          def deleted
+            unscoped.deleted
+          end
+          # This class handles the behaviour for a document that embeds many other
+          # documents within in it as an array.
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/paranoia/version.rb

@@ -1,5 +1,7 @@
-module Mongoid
-  module Paranoia
-    VERSION = '0.4.0'.freeze
-  end
-end
+# frozen_string_literal: true
+
+module Mongoid
+  module Paranoia
+    VERSION = '0.5.0'
+  end
+end