mongoid-paranoia 0.1.0

data/spec/app/models/song.rb

@@ -0,0 +1,8 @@
+class Song
+  include Mongoid::Document
+  field :title
+  embedded_in :artist
+
+  attr_accessor :before_add_called
+
+end

data/spec/app/models/square.rb

@@ -0,0 +1,4 @@
+class Square < Shape
+  field :width, type: Integer, default: 0
+  field :height, type: Integer, default: 0
+end

data/spec/app/models/strategy.rb

@@ -0,0 +1,3 @@
+class Strategy
+  include Mongoid::Document
+end

data/spec/app/models/sub_item.rb

@@ -0,0 +1,3 @@
+class SubItem < Item
+  embedded_in :parent
+end

data/spec/app/models/survey.rb

@@ -0,0 +1,5 @@
+class Survey
+  include Mongoid::Document
+  embeds_many :questions
+  accepts_nested_attributes_for :questions, reject_if: ->(a){ a[:content].blank? }, allow_destroy: true
+end

data/spec/app/models/symptom.rb

@@ -0,0 +1,6 @@
+class Symptom
+  include Mongoid::Document
+  field :name, type: String
+  embedded_in :person
+  default_scope asc(:name)
+end

data/spec/app/models/tag.rb

@@ -0,0 +1,8 @@
+class Tag
+  include Mongoid::Document
+  field :text, type: String
+  has_and_belongs_to_many :actors
+  has_and_belongs_to_many :articles
+  has_and_belongs_to_many :posts
+  has_and_belongs_to_many :related, class_name: "Tag", inverse_of: :related
+end

data/spec/app/models/target.rb

@@ -0,0 +1,5 @@
+class Target
+  include Mongoid::Document
+  field :name, type: String
+  embedded_in :targetable, polymorphic: true
+end

data/spec/app/models/template.rb

@@ -0,0 +1,5 @@
+class Template
+  include Mongoid::Document
+  field :active, type: Boolean, default: false
+  validates :active, presence: true
+end

data/spec/app/models/thing.rb

@@ -0,0 +1,9 @@
+class Thing
+  include Mongoid::Document
+  before_destroy :dont_do_it
+  embedded_in :actor
+
+  def dont_do_it
+    false
+  end
+end

data/spec/app/models/title.rb

@@ -0,0 +1,4 @@
+class Title
+  include Mongoid::Document
+  belongs_to :paranoid_post
+end

data/spec/app/models/tool.rb

@@ -0,0 +1,8 @@
+class Tool
+  include Mongoid::Document
+  embedded_in :palette
+  accepts_nested_attributes_for :palette
+end
+
+require "app/models/eraser"
+require "app/models/pencil"

data/spec/app/models/topping.rb

@@ -0,0 +1,5 @@
+class Topping
+  include Mongoid::Document
+  field :name, type: String
+  belongs_to :pizza
+end

data/spec/app/models/track.rb

@@ -0,0 +1,38 @@
+class Track
+  include Mongoid::Document
+  field :name, type: String
+
+  field :before_create_called, type: Boolean, default: false
+  field :before_save_called, type: Boolean, default: false
+  field :before_update_called, type: Boolean, default: false
+  field :before_validation_called, type: Boolean, default: false
+  field :before_destroy_called, type: Boolean, default: false
+
+  embedded_in :record
+
+  before_create :before_create_stub
+  before_save :before_save_stub
+  before_update :before_update_stub
+  before_validation :before_validation_stub
+  before_destroy :before_destroy_stub
+
+  def before_create_stub
+    self.before_create_called = true
+  end
+
+  def before_save_stub
+    self.before_save_called = true
+  end
+
+  def before_update_stub
+    self.before_update_called = true
+  end
+
+  def before_validation_stub
+    self.before_validation_called = true
+  end
+
+  def before_destroy_stub
+    self.before_destroy_called = true
+  end
+end

data/spec/app/models/translation.rb

@@ -0,0 +1,5 @@
+class Translation
+  include Mongoid::Document
+  field :language
+  embedded_in :name
+end

data/spec/app/models/tree.rb

@@ -0,0 +1,9 @@
+class Tree
+  include Mongoid::Document
+
+  field :name
+  field :evergreen, type: Boolean
+
+  scope :verdant, where(evergreen: true)
+  default_scope asc(:name)
+end

data/spec/app/models/truck.rb

@@ -0,0 +1,3 @@
+class Truck < Vehicle
+  embeds_one :bed
+end

data/spec/app/models/user.rb

@@ -0,0 +1,20 @@
+class User
+  include Mongoid::Document
+
+  field :name
+  field :last_login, type: DateTime
+  field :account_expires, type: Date
+
+  has_one :account, foreign_key: :creator_id, validate: false
+  has_many :posts, foreign_key: :author_id, validate: false
+  has_many :descriptions
+
+  has_and_belongs_to_many :followed_shops, inverse_of: :followers, class_name: "Shop"
+  has_and_belongs_to_many :businesses, class_name: "Business", validate: false
+  has_one :shop
+
+  belongs_to :next, class_name: "User"
+
+  accepts_nested_attributes_for :posts
+  index name: 1
+end

data/spec/app/models/user_account.rb

@@ -0,0 +1,10 @@
+class UserAccount
+  include Mongoid::Document
+  field :username, type: String
+  field :name, type: String
+  field :email, type: String
+  validates_uniqueness_of :username, message: "is not unique"
+  validates_uniqueness_of :email, message: "is not unique", case_sensitive: false
+  validates_length_of :name, minimum: 2, allow_nil: true
+  has_and_belongs_to_many :people
+end

data/spec/app/models/validation_callback.rb

@@ -0,0 +1,10 @@
+class ValidationCallback
+  include Mongoid::Document
+  field :history, type: Array, default: []
+  validate do
+    self.history << :validate
+  end
+
+  before_validation { self.history << :before_validation }
+  after_validation { self.history << :after_validation }
+end

data/spec/app/models/vehicle.rb

@@ -0,0 +1,11 @@
+class Vehicle
+  include Mongoid::Document
+  belongs_to :shipping_container
+  belongs_to :driver
+
+  accepts_nested_attributes_for :driver
+  accepts_nested_attributes_for :shipping_container
+end
+
+require "app/models/car"
+require "app/models/truck"

data/spec/app/models/version.rb

@@ -0,0 +1,5 @@
+class Version
+  include Mongoid::Document
+  field :number, type: Integer
+  embedded_in :memorable, polymorphic: true
+end

data/spec/app/models/vet_visit.rb

@@ -0,0 +1,5 @@
+class VetVisit
+  include Mongoid::Document
+  field :date, type: Date
+  embedded_in :pet
+end

data/spec/app/models/video.rb

@@ -0,0 +1,17 @@
+class Video
+  include Mongoid::Document
+  field :title, type: String
+  field :year, type: Integer
+  field :release_dates, type: Set
+  field :genres, type: Array
+
+  embedded_in :person
+  belongs_to :post
+  belongs_to :game
+
+  default_scope asc(:title)
+
+  attr_accessible :title, as: [ :default, :admin ]
+  attr_accessible :year, as: [ :default ]
+  attr_accessible :person_attributes, as: [ :default ]
+end

data/spec/app/models/weapon.rb

@@ -0,0 +1,11 @@
+class Weapon
+  include Mongoid::Document
+
+  field :name
+
+  belongs_to :player, inverse_of: :weapons
+
+  after_build do
+    self.name = "Holy Hand Grenade (#{player.frags})"
+  end
+end

data/spec/app/models/wiki_page.rb

@@ -0,0 +1,17 @@
+class WikiPage
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Versioning
+
+  field :title, type: String
+  field :transient_property, type: String, versioned: false
+  field :author, type: String
+  field :description, type: String, localize: true
+  max_versions 5
+
+  attr_protected :author
+
+  has_many :comments, dependent: :destroy, validate: false
+  has_many :child_pages, class_name: "WikiPage", dependent: :delete, inverse_of: :parent_pages
+  belongs_to :parent_pages, class_name: "WikiPage", inverse_of: :child_pages
+end

data/spec/app/models/word.rb

@@ -0,0 +1,12 @@
+class Word
+  include Mongoid::Document
+  field :name, type: String
+
+  belongs_to :dictionary
+
+  embeds_many :definitions, validate: false
+  embeds_many :word_origins, validate: false
+  embeds_one :pronunciation, validate: false
+
+  accepts_nested_attributes_for :definitions, allow_destroy: true
+end

data/spec/app/models/word_origin.rb

@@ -0,0 +1,11 @@
+class WordOrigin
+  include Mongoid::Document
+
+  field :_id, type: Integer, default: ->{ origin_id }
+
+  field :origin_id, type: Integer
+  field :country, type: String
+  field :city, type: String
+
+  embedded_in :word
+end

data/spec/app/models/writer.rb

@@ -0,0 +1,11 @@
+class Writer
+  include Mongoid::Document
+  field :speed, type: Integer, default: 0
+
+  embedded_in :canvas
+
+  def write; end
+end
+
+require "app/models/pdf_writer"
+require "app/models/html_writer"

data/spec/config/mongoid.yml

@@ -0,0 +1,40 @@
+test:
+  sessions:
+    default:
+      database: mongoid_test
+      hosts:
+        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+      options:
+        consistency: :strong
+    mongohq_single:
+      database: <%=ENV["MONGOHQ_SINGLE_NAME"]%>
+      username: <%=ENV["MONGOHQ_SINGLE_USER"]%>
+      password: <%=ENV["MONGOHQ_SINGLE_PASS"]%>
+      hosts:
+        - <%=ENV["MONGOHQ_SINGLE_URL"]%>
+      options:
+        safe: true
+        consistency: :strong
+    mongohq_repl:
+      database: <%=ENV["MONGOHQ_REPL_NAME"]%>
+      username: <%=ENV["MONGOHQ_REPL_USER"]%>
+      password: <%=ENV["MONGOHQ_REPL_PASS"]%>
+      hosts:
+        - <%=ENV["MONGOHQ_REPL_1_URL"]%>
+        - <%=ENV["MONGOHQ_REPL_2_URL"]%>
+      options:
+        consistency: :strong
+        safe: true
+    mongohq_repl_uri:
+      uri: <%= ENV["MONGOHQ_REPL_URI"]%>
+  options:
+    allow_dynamic_fields: true
+    identity_map_enabled: false
+    include_root_in_json: false
+    include_type_for_serialization: false
+    preload_models: false
+    scope_overwrite_exception: false
+    raise_not_found_error: true
+    skip_version_check: true
+    use_activesupport_time_zone: true
+    use_utc: false

data/spec/mongoid/paranoia_spec.rb

@@ -0,0 +1,715 @@
+require "spec_helper"
+
+describe Mongoid::Paranoia do
+
+  describe ".scoped" do
+
+    it "returns a scoped criteria" do
+      ParanoidPost.scoped.selector.should eq({ "deleted_at" => nil })
+    end
+  end
+
+  describe ".deleted" do
+
+    context "when called on a root document" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      before do
+        post.destroy
+      end
+
+      let(:deleted) do
+        ParanoidPost.deleted
+      end
+
+      it "returns the deleted documents" do
+        deleted.should eq([ post ])
+      end
+    end
+
+    context "when called on an embedded document" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create
+      end
+
+      before do
+        phone.destroy
+        person.reload
+      end
+
+      it "returns the deleted documents" do
+        person.paranoid_phones.deleted.should eq([ phone ])
+      end
+
+      it "returns the correct count" do
+        person.paranoid_phones.deleted.count.should eq(1)
+      end
+    end
+  end
+
+  describe "#destroy!" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      before do
+        post.destroy!
+      end
+
+      let(:raw) do
+        ParanoidPost.collection.find(_id: post.id).first
+      end
+
+      it "hard deletes the document" do
+        raw.should be_nil
+      end
+
+      it "executes the before destroy callbacks" do
+        post.before_destroy_called.should be_true
+      end
+
+      it "executes the after destroy callbacks" do
+        post.after_destroy_called.should be_true
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      before do
+        phone.destroy!
+      end
+
+      let(:raw) do
+        Person.collection.find(_id: person.id).first
+      end
+
+      it "hard deletes the document" do
+        raw["paranoid_phones"].should be_empty
+      end
+
+      it "executes the before destroy callbacks" do
+        phone.before_destroy_called.should be_true
+      end
+
+      it "executes the after destroy callbacks" do
+        phone.after_destroy_called.should be_true
+      end
+    end
+
+    context "when the document has a dependent relation" do
+
+      let(:post) do
+        ParanoidPost.create(title: "test")
+      end
+
+      let!(:author) do
+        post.authors.create(name: "poe")
+      end
+
+      before do
+        post.destroy!
+      end
+
+      it "cascades the dependent option" do
+        expect {
+          author.reload
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+    end
+  end
+
+  describe "#destroy" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      before do
+        post.destroy
+      end
+
+      let(:raw) do
+        ParanoidPost.collection.find(_id: post.id).first
+      end
+
+      it "soft deletes the document" do
+        raw["deleted_at"].should be_within(1).of(Time.now)
+      end
+
+      it "does not return the document in a find" do
+        expect {
+          ParanoidPost.find(post.id)
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+
+      it "executes the before destroy callbacks" do
+        post.before_destroy_called.should be_true
+      end
+
+      it "executes the after destroy callbacks" do
+        post.after_destroy_called.should be_true
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      before do
+        phone.destroy
+      end
+
+      let(:raw) do
+        Person.collection.find(_id: person.id).first
+      end
+
+      it "soft deletes the document" do
+        raw["paranoid_phones"].first["deleted_at"].should be_within(1).of(Time.now)
+      end
+
+      it "does not return the document in a find" do
+        expect {
+          person.paranoid_phones.find(phone.id)
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+
+      it "does not include the document in the relation" do
+        person.paranoid_phones.scoped.should be_empty
+      end
+
+      it "executes the before destroy callbacks" do
+        phone.before_destroy_called.should be_true
+      end
+
+      it "executes the after destroy callbacks" do
+        phone.after_destroy_called.should be_true
+      end
+    end
+
+    context "when the document has a dependent: :delete relation" do
+
+      let(:post) do
+        ParanoidPost.create(title: "test")
+      end
+
+      let!(:author) do
+        post.authors.create(name: "poe")
+      end
+
+      before do
+        post.destroy
+      end
+
+      it "cascades the dependent option" do
+        expect {
+          author.reload
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+    end
+
+    context "when the document has a dependent: :restrict relation" do
+
+      let(:post) do
+        ParanoidPost.create(title: "test")
+      end
+
+      let!(:title) do
+        post.titles.create
+      end
+
+      before do
+        begin
+          post.destroy
+        rescue Mongoid::Errors::DeleteRestriction
+        end
+      end
+
+      it "does not destroy the document" do
+        post.should_not be_destroyed
+      end
+    end
+  end
+
+  describe "#destroyed?" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      context "when the document is hard deleted" do
+
+        before do
+          post.destroy!
+        end
+
+        it "returns true" do
+          post.should be_destroyed
+        end
+      end
+
+      context "when the document is soft deleted" do
+
+        before do
+          post.destroy
+        end
+
+        it "returns true" do
+          post.should be_destroyed
+        end
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      context "when the document is hard deleted" do
+
+        before do
+          phone.destroy!
+        end
+
+        it "returns true" do
+          phone.should be_destroyed
+        end
+      end
+
+      context "when the document is soft deleted" do
+
+        before do
+          phone.destroy
+        end
+
+        it "returns true" do
+          phone.should be_destroyed
+        end
+      end
+    end
+  end
+
+  describe "#deleted?" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      context "when the document is hard deleted" do
+
+        before do
+          post.destroy!
+        end
+
+        it "returns true" do
+          post.should be_deleted
+        end
+      end
+
+      context "when the document is soft deleted" do
+
+        before do
+          post.destroy
+        end
+
+        it "returns true" do
+          post.should be_deleted
+        end
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      context "when the document is hard deleted" do
+
+        before do
+          phone.destroy!
+        end
+
+        it "returns true" do
+          phone.should be_deleted
+        end
+      end
+
+      context "when the document is soft deleted" do
+
+        before do
+          phone.destroy
+        end
+
+        it "returns true" do
+          phone.should be_deleted
+        end
+      end
+    end
+  end
+
+  describe "#delete!" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      before do
+        post.delete!
+      end
+
+      let(:raw) do
+        ParanoidPost.collection.find(_id: post.id).first
+      end
+
+      it "hard deletes the document" do
+        raw.should be_nil
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      before do
+        phone.delete!
+      end
+
+      let(:raw) do
+        Person.collection.find(_id: person.id).first
+      end
+
+      it "hard deletes the document" do
+        raw["paranoid_phones"].should be_empty
+      end
+    end
+
+    context "when the document has a dependent relation" do
+
+      let(:post) do
+        ParanoidPost.create(title: "test")
+      end
+
+      let!(:author) do
+        post.authors.create(name: "poe")
+      end
+
+      before do
+        post.delete!
+      end
+
+      it "cascades the dependent option" do
+        expect {
+          author.reload
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+    end
+  end
+
+  describe "#delete" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      before do
+        post.delete
+      end
+
+      let(:raw) do
+        ParanoidPost.collection.find(_id: post.id).first
+      end
+
+      it "soft deletes the document" do
+        raw["deleted_at"].should be_within(1).of(Time.now)
+      end
+
+      it "does not return the document in a find" do
+        expect {
+          ParanoidPost.find(post.id)
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+
+      it "clears out the persistence options" do
+        Mongoid::Threaded.persistence_options(ParanoidPost).should be_nil
+      end
+
+      it "clears out the identity map" do
+        Mongoid::IdentityMap.should be_empty
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      before do
+        phone.delete
+      end
+
+      let(:raw) do
+        Person.collection.find(_id: person.id).first
+      end
+
+      it "soft deletes the document" do
+        raw["paranoid_phones"].first["deleted_at"].should be_within(1).of(Time.now)
+      end
+
+      it "does not return the document in a find" do
+        expect {
+          person.paranoid_phones.find(phone.id)
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+
+      it "does not include the document in the relation" do
+        person.paranoid_phones.scoped.should be_empty
+      end
+    end
+
+    context "when the document has a dependent relation" do
+
+      let(:post) do
+        ParanoidPost.create(title: "test")
+      end
+
+      let!(:author) do
+        post.authors.create(name: "poe")
+      end
+
+      before do
+        post.delete
+      end
+
+      it "cascades the dependent option" do
+        expect {
+          author.reload
+        }.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+    end
+
+    context "when the document has a dependent: :restrict relation" do
+
+      let(:post) do
+        ParanoidPost.create(title: "test")
+      end
+
+      let!(:title) do
+        post.titles.create
+      end
+
+      before do
+        begin
+          post.delete
+        rescue Mongoid::Errors::DeleteRestriction
+        end
+      end
+
+      it "does not destroy the document" do
+        post.should_not be_destroyed
+      end
+    end
+  end
+
+  describe "#remove" do
+
+    let(:post) do
+      ParanoidPost.new
+    end
+
+    let!(:time) do
+      Time.now
+    end
+
+    before do
+      post.remove
+    end
+
+    it "sets the deleted flag" do
+      post.should be_destroyed
+    end
+  end
+
+  describe "#restore" do
+
+    context "when the document is a root" do
+
+      let(:post) do
+        ParanoidPost.create(title: "testing")
+      end
+
+      before do
+        post.delete
+        post.restore
+      end
+
+      it "removes the deleted at time" do
+        post.deleted_at.should be_nil
+      end
+
+      it "persists the change" do
+        post.reload.deleted_at.should be_nil
+      end
+
+      it "marks document again as persisted" do
+        post.persisted?.should be_true
+      end
+    end
+
+    context "when the document is embedded" do
+
+      let(:person) do
+        Person.create
+      end
+
+      let(:phone) do
+        person.paranoid_phones.create(number: "911")
+      end
+
+      before do
+        phone.delete
+        phone.restore
+      end
+
+      it "removes the deleted at time" do
+        phone.deleted_at.should be_nil
+      end
+
+      it "persists the change" do
+        person.reload.paranoid_phones.first.deleted_at.should be_nil
+      end
+    end
+  end
+
+  describe ".scoped" do
+
+    let(:scoped) do
+      ParanoidPost.scoped
+    end
+
+    it "returns a scoped criteria" do
+      scoped.selector.should eq({ "deleted_at" => nil })
+    end
+  end
+
+  describe "#set" do
+
+    let!(:post) do
+      ParanoidPost.create
+    end
+
+    let(:time) do
+      20.days.ago
+    end
+
+    before do
+      post.set(:deleted_at, time)
+    end
+
+    it "persists the change" do
+      post.reload.deleted_at.should be_within(1).of(time)
+    end
+  end
+
+  describe ".unscoped" do
+
+    let(:unscoped) do
+      ParanoidPost.unscoped
+    end
+
+    it "returns an unscoped criteria" do
+      unscoped.selector.should eq({})
+    end
+  end
+
+  describe "#to_param" do
+
+    let(:post) do
+      ParanoidPost.new(title: "testing")
+    end
+
+    context "when the document is new" do
+
+      it "still returns nil" do
+        post.to_param.should be_nil
+      end
+    end
+
+    context "when the document is not deleted" do
+
+      before do
+        post.save
+      end
+
+      it "returns the id as a string" do
+        post.to_param.should eq(post.id.to_s)
+      end
+    end
+
+    context "when the document is deleted" do
+
+      before do
+        post.save
+        post.delete
+      end
+
+      it "returns the id as a string" do
+        post.to_param.should eq(post.id.to_s)
+      end
+    end
+  end
+end