add with_deleted scope

Author: stanley90

lib/mongoid/paranoia.rb

@@ -46,6 +46,12 @@ def configure
 
       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

spec/mongoid/paranoia_spec.rb

@@ -98,6 +98,29 @@ class ParanoidConfiguredReset
     end
   end
 
+  describe ".with_deleted" do
+
+    let(:posts) do
+      2.times { |i| ParanoidPost.create(title: "testing #{i}") }
+    end
+
+    before do
+      Mongoid.configure do |config|
+        config.try(:allow_scopes_to_unset_default_scope=, true)
+      end
+
+      posts.first.destroy
+    end
+
+    let(:with_deleted) do
+      ParanoidPost.with_deleted
+    end
+
+    it "returns the deleted documents" do
+      expect(with_deleted).to eq(posts)
+    end
+  end if respond_to?(:allow_scopes_to_unset_default_scope=)
+
   describe "#destroy!" do
 
     context "when the document is a root" do

spec/mongoid/scoping_spec.rb

@@ -51,5 +51,28 @@
         expect(criteria.selector).to eq({ "fresh" => true })
       end
     end
+
+    context "when chaining with_deleted" do
+
+      let(:criteria) do
+        Fish.fresh.with_deleted
+      end
+
+      if respond_to?(:allow_scopes_to_unset_default_scope=)
+        before do
+          Mongoid.configure do |config|
+            config.try(:allow_scopes_to_unset_default_scope=, true)
+          end
+
+          it "removes only deleted_at from the selector" do
+            expect(criteria.selector).to eq({ "fresh" => true })
+          end
+        end
+      else
+        it "raises an error if the feature is not supported" do
+          expect { criteria.selector }.to raise_error(/requires Mongoid >= 9/)
+        end
+      end
+    end
   end
 end