mongoid 7.5.1 → 8.1.2

data/spec/support/immutable_ids.rb

@@ -0,0 +1,118 @@
+module Mongoid
+  module ImmutableIds
+    def immutable_id_examples_as(name)
+      shared_examples_for name do
+        shared_examples 'a persisted document' do
+          it 'should ignore the change and issue a warning' do
+            expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
+            expect { invoke_operation! }.not_to raise_error
+            expect(id_is_unchanged).not_to be legacy_behavior_expects_id_to_change
+          end
+
+          context 'when immutable_ids is true' do
+            before { Mongoid::Config.immutable_ids = true }
+            after { Mongoid::Config.immutable_ids = false }
+
+            it 'should disallow _id to be updated' do
+              expect { invoke_operation! }
+                .to raise_error(Mongoid::Errors::ImmutableAttribute)
+            end
+      
+            context 'when id is set to the existing value' do
+              let(:new_id_value) { object._id }
+
+              it 'should allow the update to proceed' do
+                expect { invoke_operation! }
+                  .not_to raise_error
+              end
+            end
+          end
+        end
+
+        context 'when the field is _id' do
+          let(:new_id_value) { 1234 }
+
+          context 'when the document is top-level' do    
+            let(:legacy_behavior_expects_id_to_change) { false }
+
+            context 'when the document is new' do
+              let(:object) { Person.new }
+    
+              it 'should allow _id to be updated' do
+                invoke_operation!
+                expect(object.new_record?).to be false
+                expect(object.reload._id).to be == new_id_value
+              end
+            end
+    
+            context 'when the document has been persisted' do
+              let(:object) { Person.create }
+              let!(:original_id) { object._id }
+              let(:id_is_unchanged) { Person.exists?(original_id) }
+    
+              it_behaves_like 'a persisted document'
+            end
+          end
+    
+          context 'when the document is embedded' do
+            let(:parent) { Person.create }
+            let(:legacy_behavior_expects_id_to_change) { true }
+
+            context 'when the document is new' do
+              let(:object) { parent.favorites.new }
+    
+              it 'should allow _id to be updated' do
+                invoke_operation!
+                expect(object.new_record?).to be false
+                expect(parent.reload.favorites.first._id).to be == new_id_value
+              end
+            end
+    
+            context 'when the document has been persisted' do
+              let(:object) { parent.favorites.create }
+              let!(:original_id) { object._id }
+              let(:id_is_unchanged) { parent.favorites.where(_id: original_id).exists? }
+      
+              it_behaves_like 'a persisted document'
+
+              context 'updating embeds_one via parent' do
+                context 'when immutable_ids is false' do
+                  before { expect(Mongoid::Config.immutable_ids).to be false }
+
+                  it 'should ignore the change' do
+                    expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
+
+                    parent.pet = pet = Pet.new
+                    parent.save
+
+                    original_id = pet._id
+                    new_id = BSON::ObjectId.new
+
+                    expect { parent.update(pet: { _id: new_id }) }.not_to raise_error
+                    expect(parent.reload.pet._id.to_s).to be == original_id.to_s
+                  end
+                end
+
+                context 'when immutable_ids is true' do
+                  before { Mongoid::Config.immutable_ids = true }
+                  after { Mongoid::Config.immutable_ids = false }
+
+                  it 'should raise an exception' do
+                    parent.pet = pet = Pet.new
+                    parent.save
+
+                    original_id = pet._id
+                    new_id = BSON::ObjectId.new
+
+                    expect { parent.update(pet: { _id: new_id }) }
+                      .to raise_error(Mongoid::Errors::ImmutableAttribute)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/macros.rb

@@ -2,6 +2,7 @@
 
 module Mongoid
   module Macros
+
     def use_spec_mongoid_config
       around do |example|
         config_path = File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
@@ -39,6 +40,28 @@ module Mongoid
       end
     end
 
+    def driver_config_override(key, value)
+      around do |example|
+        existing = Mongo.send(key)
+
+        Mongo.send("#{key}=", value)
+
+        example.run
+
+        Mongo.send("#{key}=", existing)
+      end
+    end
+
+    def with_driver_config_values(key, *values, &block)
+      values.each do |value|
+        context "when #{key} is #{value}" do
+          driver_config_override key, value
+
+          class_exec(value, &block)
+        end
+      end
+    end
+
     def restore_config_clients
       around do |example|
         # Duplicate the config because some tests mutate it.
@@ -47,5 +70,60 @@ module Mongoid
         Mongoid::Config.send(:clients=, old_config)
       end
     end
+
+    def query_cache_enabled
+      around do |example|
+        Mongoid::QueryCache.cache do
+          example.run
+        end
+      end
+    end
+
+    def override_query_cache(enabled)
+      around do |example|
+        cache_enabled = Mongo::QueryCache.enabled?
+        Mongo::QueryCache.enabled = enabled
+        example.run
+        Mongo::QueryCache.enabled = cache_enabled
+      end
+    end
+
+    # Override the global persistence context.
+    #
+    # @param [ :client, :database ] component The component to override.
+    # @param [ Object ] value The value to override to.
+    def persistence_context_override(component, value)
+      around do |example|
+        meth = "#{component}_override"
+        old_value = Mongoid::Threaded.send(meth)
+        Mongoid::Threaded.send("#{meth}=", value)
+        example.run
+        Mongoid::Threaded.send("#{meth}=", old_value)
+      end
+    end
+
+    def time_zone_override(tz)
+      around do |example|
+        old_tz = Time.zone
+        Time.zone = tz
+        example.run
+        Time.zone = old_tz
+      end
+    end
+
+    def with_default_i18n_configs
+      around do |example|
+        I18n.locale = :en
+        I18n.default_locale = :en
+        I18n.try(:fallbacks=, I18n::Locale::Fallbacks.new)
+        I18n.enforce_available_locales = false
+        example.run
+      ensure
+        I18n.locale = :en
+        I18n.default_locale = :en
+        I18n.try(:fallbacks=, I18n::Locale::Fallbacks.new)
+        I18n.enforce_available_locales = false
+      end
+    end
   end
 end

data/spec/support/models/artist.rb

@@ -87,5 +87,4 @@ class Artist
   def after_remove_album(album)
     @after_remove_referenced_called = true
   end
-
 end

data/spec/support/models/augmentation.rb

@@ -10,4 +10,16 @@ class Augmentation
   after_build do
     self.name = "Infolink (#{player.frags})"
   end
+
+  field :after_find_player
+  field :after_initialize_player
+  field :after_default_player, default: ->{ self.player&._id }
+
+  after_find do |doc|
+    doc.after_find_player = player&._id
+  end
+
+  after_initialize do |doc|
+    doc.after_initialize_player = player&._id
+  end
 end

data/spec/support/models/band.rb

@@ -20,10 +20,14 @@ class Band
   field :y, as: :years, type: Integer
   field :founded, type: Date
   field :deleted, type: Boolean
+  field :mojo, type: Object
+  field :tags, type: Hash
+  field :fans
 
   embeds_many :records, cascade_callbacks: true
   embeds_many :notes, as: :noteable, cascade_callbacks: true, validate: false
   embeds_many :labels
+  embeds_many :fanatics
   embeds_one :label, cascade_callbacks: true
 
   scope :highly_rated, -> { gte(rating: 7) }

data/spec/support/models/book.rb

@@ -15,4 +15,5 @@ class Book
   end
 
   embeds_many :pages, cascade_callbacks: true
+  embeds_many :covers, cascade_callbacks: true
 end

data/spec/support/models/building.rb

@@ -3,6 +3,8 @@
 class Building
   include Mongoid::Document
 
+  field :name, type: String
+
   embeds_one :building_address, validate: false
   embeds_many :contractors
 end

data/spec/support/models/catalog.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Catalog
+  include Mongoid::Document
+
+  field :array_field, type: Array
+  field :big_decimal_field, type: BigDecimal
+  field :boolean_field, type: Boolean
+  field :date_field, type: Date
+  field :date_time_field, type: DateTime
+  field :float_field, type: Float
+  field :hash_field, type: Hash
+  field :integer_field, type: Integer
+  field :object_id_field, type: BSON::ObjectId
+  field :binary_field, type: BSON::Binary
+  field :range_field, type: Range
+  field :regexp_field, type: Regexp
+  field :set_field, type: Set
+  field :string_field, type: String
+  field :stringified_symbol_field, type: StringifiedSymbol
+  field :symbol_field, type: Symbol
+  field :time_field, type: Time
+  field :time_with_zone_field, type: ActiveSupport::TimeWithZone
+end

data/spec/support/models/circus.rb

@@ -4,6 +4,9 @@ class Circus
   include Mongoid::Document
 
   field :name
+  field :slogan
+
+  validates_uniqueness_of :slogan, allow_blank: true
 
   embeds_many :animals
 end

data/spec/support/models/cover.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Cover
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :title, type: String
+
+  embedded_in :book
+end

data/spec/support/models/fanatic.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Fanatic
+  include Mongoid::Document
+  field :age, type: Integer
+
+  embedded_in :band
+end

data/spec/support/models/implant.rb

@@ -12,7 +12,16 @@ class Implant
     doc.name = "Cochlear Implant (#{player.frags})"
   end
 
+  field :after_find_player
+  field :after_initialize_player
+  field :after_default_player, default: ->{ self.player&._id }
+
   after_find do |doc|
     doc.impressions += 1
+    doc.after_find_player = player&._id
+  end
+
+  after_initialize do |doc|
+    doc.after_initialize_player = player&._id
   end
 end

data/spec/support/models/label.rb

@@ -6,6 +6,8 @@ class Label
 
   field :name, type: String
   field :sales, type: BigDecimal
+  field :age, type: Integer
+
   field :after_create_called, type: Mongoid::Boolean, default: false
   field :after_save_called, type: Mongoid::Boolean, default: false
   field :after_update_called, type: Mongoid::Boolean, default: false

data/spec/support/models/passport.rb

@@ -10,4 +10,13 @@ class Passport
   field :localized_translations, localize: true
 
   embedded_in :person, autobuild: true
+
+  embeds_many :passport_pages
+end
+
+class PassportPage
+  include Mongoid::Document
+
+  field :num_stamps, type: Integer
+  embedded_in :passport
 end

data/spec/support/models/person.rb

@@ -40,6 +40,7 @@ class Person
   field :arrays, type: Array
   field :range, type: Range
   field :species, type: Symbol
+  field :posts_count, type: Integer, default: 0
 
   index age: 1
   index addresses: 1
@@ -69,6 +70,7 @@ class Person
   embeds_many :messages, validate: false
 
   embeds_one :passport, autobuild: true, store_as: :pass, validate: false
+  embeds_one :purse, store_as: "Purse"
   embeds_one :pet, class_name: "Animal", validate: false
   embeds_one :name, as: :namable, validate: false do
     def extension

data/spec/support/models/player.rb

@@ -25,6 +25,8 @@ class Player
   embeds_many :implants
   embeds_one :augmentation
 
+  has_and_belongs_to_many :shields
+
   after_find do |doc|
     doc.impressions += 1
   end

data/spec/support/models/powerup.rb

@@ -10,4 +10,16 @@ class Powerup
   after_build do
     self.name = "Quad Damage (#{player.frags})"
   end
+
+  field :after_find_player
+  field :after_initialize_player
+  field :after_default_player, default: ->{ self.player&._id }
+
+  after_find do |doc|
+    doc.after_find_player = player&._id
+  end
+
+  after_initialize do |doc|
+    doc.after_initialize_player = player&._id
+  end
 end

data/spec/support/models/product.rb

@@ -10,6 +10,7 @@ class Product
   field :website, localize: true
   field :sku, as: :stock_keeping_unit
   field :tl, as: :tagline, localize: true
+  field :title, localize: :present
   alias_attribute :cost, :price
 
   validates :name, presence: true

data/spec/support/models/purse.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Purse
+  include Mongoid::Document
+
+  field :brand, type: String
+
+  embedded_in :person
+end

data/spec/support/models/registry.rb

@@ -3,4 +3,5 @@
 class Registry
   include Mongoid::Document
   field :data, type: BSON::Binary
+  field :obj_id, type: BSON::ObjectId
 end

data/spec/support/models/school.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class School
+  include Mongoid::Document
+
+  has_many :students
+
+  field :district, type: String
+  field :team, type: String
+
+  field :after_destroy_triggered, default: false
+
+  accepts_nested_attributes_for :students, allow_destroy: true
+end

data/spec/support/models/shield.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+class Shield
+  include Mongoid::Document
+
+  has_and_belongs_to_many :players
+
+  field :after_find_player
+  field :after_initialize_player
+  field :after_default_player, default: ->{ players.first&._id }
+
+  after_find do |doc|
+    doc.after_find_player = players.first&._id
+  end
+
+  after_initialize do |doc|
+    doc.after_initialize_player = players.first&._id
+  end
+end

data/spec/support/models/student.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Student
+  include Mongoid::Document
+
+  belongs_to :school
+
+  field :name, type: String
+  field :grade, type: Integer, default: 3
+
+  after_destroy do |doc|
+    school.after_destroy_triggered = true if school
+  end
+end

data/spec/support/models/weapon.rb

@@ -10,4 +10,16 @@ class Weapon
   after_build do
     self.name = "Holy Hand Grenade (#{player.frags})"
   end
+
+  field :after_find_player
+  field :after_initialize_player
+  field :after_default_player, default: ->{ self.player&._id }
+
+  after_find do |doc|
+    doc.after_find_player = player&._id
+  end
+
+  after_initialize do |doc|
+    doc.after_initialize_player = player&._id
+  end
 end