mongoid_paranoia 0.5.0 → 0.7.0

data/lib/mongoid/paranoia.rb

@@ -1,196 +1,202 @@
-# frozen_string_literal: true
-
-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
-      def configuration
-        @configuration ||= Configuration.new
-      end
-
-      def 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 configure
-        yield(configuration)
-      end
-    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
-
-    # 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
-    alias :orig_delete :delete
-
-    def remove(_ = {})
-      time = self.deleted_at = Time.now
-      _paranoia_update('$set' => { paranoid_field => time })
-      @destroyed = true
-      true
-    end
-
-    alias :delete :remove
-    alias :delete! :orig_delete
-
-    # Delete the paranoid +Document+ from the database completely. This will
-    # run the destroy and remove callbacks.
-    #
-    # @example Hard destroy the document.
-    #   document.destroy!
-    #
-    # @return [ true, false ] If the operation succeeded.
-    #
-    # @since 1.0.0
-    def destroy!(options = {})
-      raise Errors::ReadonlyDocument.new(self.class) if readonly?
-      self.flagged_for_destroy = true
-      result = run_callbacks(:destroy) do
-        run_callbacks(:remove) do
-          if catch(:abort) { apply_destroy_dependencies! }
-            delete!(options || {})
-          else
-            false
-          end
-        end
-      end
-      self.flagged_for_destroy = false
-      result
-    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
-        _paranoia_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
-      relations.each_pair do |name, association|
-        next unless association.dependent == :destroy
-        relation = send(name)
-        next unless relation.present? && relation.paranoid?
-        Array.wrap(relation).each do |doc|
-          doc.restore(recursive: true)
-        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 : 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
-
-    # @return [ Object ] Update result.
-    #
-    def _paranoia_update(value)
-      paranoid_collection.find(atomic_selector).update_one(value)
-    end
-  end
-end
+# frozen_string_literal: true
+
+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
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def 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 configure
+        yield(configuration)
+      end
+    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) }
+      scope :with_deleted, lambda {
+        msg = 'This scope requires Mongoid >= 9 and allow_scopes_to_unset_default_scope to be set to true'
+        raise msg unless Mongoid.try(:allow_scopes_to_unset_default_scope)
+
+        criteria.remove_scoping(unscoped.where(deleted_at: nil))
+      }
+      define_model_callbacks :restore
+      define_model_callbacks :remove
+    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
+    alias orig_delete delete
+
+    def remove(_ = {}) # rubocop:disable Naming/PredicateMethod
+      time = self.deleted_at = Time.now
+      _paranoia_update('$set' => { paranoid_field => time })
+      @destroyed = true
+      true
+    end
+
+    alias delete remove
+    alias delete! orig_delete
+
+    # Delete the paranoid +Document+ from the database completely. This will
+    # run the destroy and remove callbacks.
+    #
+    # @example Hard destroy the document.
+    #   document.destroy!
+    #
+    # @return [ true, false ] If the operation succeeded.
+    #
+    # @since 1.0.0
+    def destroy!(options = {})
+      raise Errors::ReadonlyDocument.new(self.class) if readonly?
+      self.flagged_for_destroy = true
+      result = run_callbacks(:destroy) do
+        run_callbacks(:remove) do
+          if catch(:abort) { apply_destroy_dependencies! }
+            delete!(options || {})
+          else
+            false
+          end
+        end
+      end
+      self.flagged_for_destroy = false
+      result
+    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
+        _paranoia_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
+      relations.each_pair do |name, association|
+        next unless association.dependent == :destroy
+        relation = send(name)
+        next unless relation.present? && relation.paranoid?
+        Array.wrap(relation).each do |doc|
+          doc.restore(recursive: true)
+        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 : 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
+
+    # @return [ Object ] Update result.
+    #
+    def _paranoia_update(value)
+      paranoid_collection.find(atomic_selector).update_one(value, session: _session)
+    end
+  end
+end

data/lib/mongoid-paranoia.rb

@@ -1,3 +1,3 @@
-# frozen_string_literal: true
-
-require 'mongoid/paranoia'
+# frozen_string_literal: true
+
+require 'mongoid/paranoia'

data/lib/mongoid_paranoia.rb

@@ -1,3 +1,3 @@
-# frozen_string_literal: true
-
-require 'mongoid/paranoia'
+# frozen_string_literal: true
+
+require 'mongoid/paranoia'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_paranoia
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Durran Jordan
@@ -9,36 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2026-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.3'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '7.3'
 description: Provides a Paranoia module documents which soft-deletes documents.
 email:
 - durran@gmail.com
@@ -55,29 +41,11 @@ files:
 - lib/mongoid/paranoia/monkey_patches.rb
 - lib/mongoid/paranoia/version.rb
 - lib/mongoid_paranoia.rb
-- perf/scope.rb
-- spec/app/models/address.rb
-- spec/app/models/appointment.rb
-- spec/app/models/author.rb
-- spec/app/models/fish.rb
-- spec/app/models/paranoid_phone.rb
-- spec/app/models/paranoid_post.rb
-- spec/app/models/person.rb
-- spec/app/models/phone.rb
-- spec/app/models/relations.rb
-- spec/app/models/tag.rb
-- spec/app/models/title.rb
-- spec/mongoid/configuration_spec.rb
-- spec/mongoid/document_spec.rb
-- spec/mongoid/nested_attributes_spec.rb
-- spec/mongoid/paranoia_spec.rb
-- spec/mongoid/scoping_spec.rb
-- spec/mongoid/validatable/uniqueness_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/simi/mongoid-paranoia
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -93,27 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Paranoid documents
-test_files:
-- perf/scope.rb
-- spec/app/models/address.rb
-- spec/app/models/appointment.rb
-- spec/app/models/author.rb
-- spec/app/models/fish.rb
-- spec/app/models/paranoid_phone.rb
-- spec/app/models/paranoid_post.rb
-- spec/app/models/person.rb
-- spec/app/models/phone.rb
-- spec/app/models/relations.rb
-- spec/app/models/tag.rb
-- spec/app/models/title.rb
-- spec/mongoid/configuration_spec.rb
-- spec/mongoid/document_spec.rb
-- spec/mongoid/nested_attributes_spec.rb
-- spec/mongoid/paranoia_spec.rb
-- spec/mongoid/scoping_spec.rb
-- spec/mongoid/validatable/uniqueness_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/perf/scope.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'mongoid'
-require 'mongoid/paranoia'
-require 'benchmark'
-
-Mongoid.configure do |config|
-  config.connect_to('my_little_test')
-end
-
-class Model
-  include Mongoid::Document
-  field :text, type: String
-
-  index({ text: 'text' })
-end
-
-class ParanoidModel
-  include Mongoid::Document
-  include Mongoid::Paranoia
-  field :text, type: String
-
-  index({ text: 'text' })
-end
-
-class MetaParanoidModel
-  include Mongoid::Document
-  field :text, type: String
-  field :deleted_at, type: Time
-  default_scope -> { where(deleted_at: nil) }
-
-  index({ text: 'text' })
-end
-
-if ENV['FORCE']
-  Mongoid.purge!
-  ::Mongoid::Tasks::Database.create_indexes
-
-  n = 50_000
-  n.times {|i| Model.create(text: "text #{i}") }
-  n.times {|i| ParanoidModel.create(text: "text #{i}") }
-  n.times {|i| MetaParanoidModel.create(text: "text #{i}") }
-end
-
-n = 100
-
-puts 'text_search benchmark ***'
-Benchmark.bm(20) do |x|
-  x.report('without') { n.times { Model.text_search('text').execute } }
-  x.report('with')    { n.times { ParanoidModel.text_search('text').execute } }
-  x.report('meta')    { n.times { MetaParanoidModel.text_search('text').execute } }
-  x.report('unscoped meta') { n.times { MetaParanoidModel.unscoped.text_search('text').execute } }
-  x.report('unscoped paranoid') { n.times { ParanoidModel.unscoped.text_search('text').execute } }
-end
-
-puts ''
-puts 'Pluck all ids benchmark ***'
-Benchmark.bm(20) do |x|
-  x.report('without') { n.times { Model.all.pluck(:id) } }
-  x.report('with')    { n.times { ParanoidModel.all.pluck(:id) } }
-  x.report('meta')    { n.times { MetaParanoidModel.all.pluck(:id) } }
-  x.report('unscoped meta') { n.times { MetaParanoidModel.unscoped.all.pluck(:id) } }
-  x.report('unscoped paranoid') { n.times { ParanoidModel.unscoped.all.pluck(:id) } }
-end

data/spec/app/models/address.rb

@@ -1,71 +0,0 @@
-class Address
-  include Mongoid::Document
-
-  field :_id, type: String, default: ->{ street.try(:parameterize) }
-
-  attr_accessor :mode
-
-  field :address_type
-  field :number, type: Integer
-  field :street
-  field :city
-  field :state
-  field :post_code
-  field :parent_title
-  field :services, type: Array
-  field :latlng, type: Array
-  field :map, type: Hash
-  field :move_in, type: DateTime
-  field :s, type: String, as: :suite
-  field :name, localize: true
-
-  embeds_one :code, validate: false
-  embeds_one :target, as: :targetable, validate: false
-
-  embedded_in :addressable, polymorphic: true do
-    def extension
-      "Testing"
-    end
-    def doctor?
-      title == "Dr"
-    end
-  end
-
-  accepts_nested_attributes_for :code, :target
-
-  belongs_to :account
-
-  scope :without_postcode, -> {where(postcode: nil)}
-  scope :rodeo, -> {
-    where(street: "Rodeo Dr") do
-      def mansion?
-        all? { |address| address.street == "Rodeo Dr" }
-      end
-    end
-  }
-
-  validates_presence_of :street, on: :update
-  validates_format_of :street, with: /\D/, allow_nil: true
-
-  def set_parent=(set = false)
-    self.parent_title = addressable.title if set
-  end
-
-  def <=>(other)
-    street <=> other.street
-  end
-
-  class << self
-    def california
-      where(state: "CA")
-    end
-
-    def homes
-      where(address_type: "Home")
-    end
-
-    def streets
-      all.map(&:street)
-    end
-  end
-end

data/spec/app/models/appointment.rb

@@ -1,7 +0,0 @@
-class Appointment
-  include Mongoid::Document
-  field :active, type: Boolean, default: true
-  field :timed, type: Boolean, default: true
-  embedded_in :person
-  default_scope ->{where(active: true)}
-end

data/spec/app/models/author.rb

@@ -1,6 +0,0 @@
-class Author
-  include Mongoid::Document
-  field :name, type: String
-
-  belongs_to :post, class_name: "ParanoidPost"
-end