mongoid_paranoia 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a91dadeb276e443e5060c0365961ca55f0a64e52dc6d98ec9d1f8c27323e4c9
-  data.tar.gz: 71acb61e9ac0c78c37b9e70c9985bcfbbd778364b0e4394ae087dbfc3c260955
+  metadata.gz: c03b7dee0f348835ab02ae6dd3543c6af25a9593a2b3655192d35516dbe6eeec
+  data.tar.gz: 43bf43f4fa43bff574b843213beb54e5a2d3ed4b6c80205d3443212e6ac1ca2a
 SHA512:
-  metadata.gz: 3c1516b87ec542acbd708b0d5aca3a372b2cdc16123df093223d2159eb8b4a8c2c13720b4bd8492ada399e58308a49e5ba1895273fb18bac2bd784978e4f282c
-  data.tar.gz: 71eb2a17add46c46f97f6b5fab35907765c6ba1e97ebc24016e0314feee8d0bf9ac0964e3e45910d260ea3b1abb4e9492ac4928181a6307772347f919f16a463
+  metadata.gz: b5a5b3bf5cf3074a00565798032c1b3fae4c23e2c4ed80091600305a11a52e981ad735503a1ddb6369aa17da4900e010b366e2af8b46db842a0c1b55bdff3e3c
+  data.tar.gz: fceeb94c3cf50a52dd90e500988f63c9e4e850153d31808604bf226a7099b33401df37e04448474f07511905371fd9f068390689509c2480f8b5862b521b4d44

data/README.md

@@ -1,12 +1,21 @@
 # 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.
+`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.
+The `Mongoid::Paranoia` functionality was originally supported in Mongoid
+itself, but was dropped from version 4.0 onwards. This gem was extracted
+from the [Mongoid 3.0.0-stable branch](https://github.com/mongodb/mongoid/tree/3.0.0-stable).
 
 **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.
 
+## Version Support
+
+* The current release is compatible with Mongoid 7.3 and later, and Ruby 2.7 and later.
+* Earlier Mongoid and Ruby versions are supported on earlier releases.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/mongoid/paranoia/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid
   module Paranoia
-    VERSION = '0.4.1'
+    VERSION = '0.6.0'
   end
 end

data/lib/mongoid/paranoia.rb

@@ -50,23 +50,6 @@ module Mongoid
       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"
@@ -92,34 +75,41 @@ module Mongoid
     # @return [ true ] True.
     #
     # @since 1.0.0
-    alias orig_remove :remove
+    alias orig_delete delete
 
     def remove(_ = {})
-      return false unless catch(:abort) do
-        if respond_to?(:apply_destroy_dependencies!)
-          apply_destroy_dependencies!
-        else
-          apply_delete_dependencies!
-        end
-      end
       time = self.deleted_at = Time.now
       _paranoia_update('$set' => { paranoid_field => time })
       @destroyed = true
       true
     end
 
-    alias delete :remove
+    alias delete remove
+    alias delete! orig_delete
 
-    # Delete the paranoid +Document+ from the database completely.
+    # Delete the paranoid +Document+ from the database completely. This will
+    # run the destroy and remove callbacks.
     #
-    # @example Hard delete the document.
-    #   document.delete!
+    # @example Hard destroy the document.
+    #   document.destroy!
     #
     # @return [ true, false ] If the operation succeeded.
     #
     # @since 1.0.0
-    def delete!
-      orig_remove
+    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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_paranoia
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Durran Jordan
@@ -9,16 +9,13 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2023-09-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.0'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '7.3'
   type: :runtime
@@ -26,25 +23,8 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-    - - "<"
       - !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
 description: Provides a Paranoia module documents which soft-deletes documents.
 email:
 - durran@gmail.com
@@ -61,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:
@@ -99,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.4
 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

data/spec/app/models/fish.rb

@@ -1,8 +0,0 @@
-class Fish
-  include Mongoid::Document
-  include Mongoid::Paranoia
-
-  def self.fresh
-    where(fresh: true)
-  end
-end

data/spec/app/models/paranoid_phone.rb

@@ -1,25 +0,0 @@
-class ParanoidPhone
-  include Mongoid::Document
-  include Mongoid::Paranoia
-
-  attr_accessor :after_destroy_called, :before_destroy_called
-
-  field :number, type: String
-
-  embedded_in :person
-
-  before_destroy :before_destroy_stub, :halt_me
-  after_destroy :after_destroy_stub
-
-  def before_destroy_stub
-    self.before_destroy_called = true
-  end
-
-  def after_destroy_stub
-    self.after_destroy_called = true
-  end
-
-  def halt_me
-    throw :abort if person.age == 42
-  end
-end

data/spec/app/models/paranoid_post.rb

@@ -1,65 +0,0 @@
-class ParanoidPost
-  include Mongoid::Document
-  include Mongoid::Paranoia
-
-  field :title, type: String
-
-  attr_accessor :after_destroy_called, :before_destroy_called,
-                :after_restore_called, :before_restore_called,
-                :after_remove_called, :before_remove_called,
-                :around_before_restore_called, :around_after_restore_called
-
-  belongs_to :person
-
-  has_and_belongs_to_many :tags
-  has_many :authors, dependent: :delete_all, inverse_of: :post
-  has_many :titles, dependent: :restrict_with_error
-
-  scope :recent, -> {where(created_at: { "$lt" => Time.now, "$gt" => 30.days.ago })}
-
-  before_destroy :before_destroy_stub
-  after_destroy  :after_destroy_stub
-
-  before_remove :before_remove_stub
-  after_remove  :after_remove_stub
-
-  before_restore :before_restore_stub
-  after_restore  :after_restore_stub
-  around_restore :around_restore_stub
-
-  def before_destroy_stub
-    self.before_destroy_called = true
-  end
-
-  def after_destroy_stub
-    self.after_destroy_called = true
-  end
-
-  def before_remove_stub
-    self.before_remove_called = true
-  end
-
-  def after_remove_stub
-    self.after_remove_called = true
-  end
-
-  def before_restore_stub
-    self.before_restore_called = true
-  end
-
-  def after_restore_stub
-    self.after_restore_called = true
-  end
-
-  def around_restore_stub
-    self.around_before_restore_called = true
-    yield
-    self.around_after_restore_called = true
-  end
-
-  class << self
-    def old
-      where(created_at: { "$lt" => 30.days.ago })
-    end
-  end
-end

data/spec/app/models/person.rb

@@ -1,21 +0,0 @@
-class Person
-  include Mongoid::Document
-
-  field :age, type: Integer, default: "100"
-  field :score, type: Integer
-
-  attr_reader :rescored
-
-  embeds_many :phone_numbers, class_name: "Phone", validate: false
-  embeds_many :phones, store_as: :mobile_phones, validate: false
-  embeds_many :addresses, as: :addressable, validate: false
-
-  embeds_many :appointments, validate: false
-  embeds_many :paranoid_phones, validate: false
-
-  has_many :paranoid_posts, validate: false
-  belongs_to :paranoid_post
-
-  accepts_nested_attributes_for :addresses
-  accepts_nested_attributes_for :paranoid_phones
-end

data/spec/app/models/phone.rb

@@ -1,11 +0,0 @@
-class Phone
-  include Mongoid::Document
-
-  attr_accessor :number_in_observer
-
-  field :_id, type: String, default: ->{ number }
-
-  field :number
-  embeds_one :country_code
-  embedded_in :person
-end