mongoid 5.4.0 → 6.4.8

data/lib/mongoid.rb

@@ -12,11 +12,11 @@ require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
 
-require "origin"
 require "mongo"
 
 require "mongoid/version"
 require "mongoid/config"
+require "mongoid/persistence_context"
 require "mongoid/loggable"
 require "mongoid/clients"
 require "mongoid/document"
@@ -42,7 +42,7 @@ module Mongoid
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
 
   # The minimum MongoDB version supported.
-  MONGODB_VERSION = "2.4.0"
+  MONGODB_VERSION = "2.6.0"
 
   # Sets the Mongoid configuration options. Best used by passing a block.
   #
@@ -65,7 +65,7 @@ module Mongoid
   #
   # @return [ Mongo::Client ] The default client.
   #
-  # @since 3.0.0
+  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -77,7 +77,7 @@ module Mongoid
   #
   # @return [ true ] True.
   #
-  # @since 3.1.0
+  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -89,7 +89,7 @@ module Mongoid
   #
   # @return [ Mongo::Client ] The named client.
   #
-  # @since 3.0.0
+  # @since 5.0.0
   def client(name)
     Clients.with_name(name)
   end
@@ -101,5 +101,5 @@ module Mongoid
   #   Mongoid.database = Mongo::Connection.new.db("test")
   #
   # @since 1.0.0
-  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ] << { to: Config }))
+  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ]), to: Config)
 end

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -11,6 +11,10 @@ development:
       hosts:
         - localhost:27017
       options:
+        # Note that all options listed below are Ruby driver client options (the mongo gem).
+        # Please refer to the driver documentation of the version of the mongo gem you are using
+        # for the most up-to-date list of options.
+        #
         # Change the default write concern. (default = { w: 1 })
         # write:
         #   w: 1
@@ -34,11 +38,13 @@ development:
         #   - 'dbOwner'
 
         # Change the default authentication mechanism. Valid options are: :scram,
-        # :mongodb_cr, :mongodb_x509, and :plain. (default on 3.0 is :scram, default
-        # on 2.4 and 2.6 is :plain)
+        # :mongodb_cr, :mongodb_x509, and :plain. Note that all authentication
+        # mechanisms require username and password, with the exception of :mongodb_x509.
+        # Default on mongoDB 3.0 is :scram, default on 2.4 and 2.6 is :plain.
         # auth_mech: :scram
 
-        # The database or source to authenticate the user against. (default: admin)
+        # The database or source to authenticate the user against.
+        # (default: the database specified above or admin)
         # auth_source: admin
 
         # Force a the driver cluster to behave in a certain manner instead of auto-
@@ -120,6 +126,10 @@ development:
     # existing method. (default: false)
     # scope_overwrite_exception: false
 
+    # Raise an error when defining a field with the same name as an
+    # existing method. (default: false)
+    # duplicate_fields_exception: false
+
     # Use Active Support's time zone in conversions. (default: true)
     # use_activesupport_time_zone: true
 
@@ -131,6 +141,11 @@ development:
     # otherwise.(default: :info)
     # log_level: :info
 
+    # Control whether `belongs_to` association is required. By default
+    # `belongs_to` will trigger a validation error if the association
+    # is not present. (default: true)
+    # belongs_to_required_by_default: true
+
     # Application name that is printed to the mongodb logs upon establishing a
     # connection in server versions >= 3.4. Note that the name cannot exceed 128 bytes.
     # app_name: MyApplicationName

data/spec/app/models/agent.rb

@@ -9,6 +9,8 @@ class Agent
   belongs_to :game
   belongs_to :agency, touch: true, autobuild: true
 
+  belongs_to :same_name, class_name: 'Band', inverse_of: :same_name
+
   has_and_belongs_to_many :accounts
   has_and_belongs_to_many :basics
 end

data/spec/app/models/album.rb

@@ -9,6 +9,10 @@ class Album
   private
 
   def set_parent_name
-    artist.name = "destroyed"
+    artist.name = "destroyed" if artist
+  end
+
+  def set_parent_name_fail
+    throw(:abort)
   end
 end

data/spec/app/models/array_field.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ArrayField
+  include Mongoid::Document
+
+  field :af, type: Array
+end

data/spec/app/models/artist.rb

@@ -13,16 +13,37 @@ class Artist
   after_create :create_songs
   before_save :before_save_stub
   before_destroy :before_destroy_stub
+  before_update :before_update_stub
 
   protected
   def before_create_stub
     true
   end
 
+  def before_update_stub
+    true
+  end
+
+  def before_update_fail_stub
+    throw(:abort)
+  end
+
+  def before_save_fail_stub
+    throw(:abort)
+  end
+
+  def before_create_fail_stub
+    throw(:abort)
+  end
+
   def before_save_stub
     true
   end
 
+  def before_destroy_fail_stub
+    throw(:abort)
+  end
+
   def before_destroy_stub
     true
   end

data/spec/app/models/band.rb

@@ -20,8 +20,11 @@ class Band
 
   embeds_many :records, cascade_callbacks: true
   embeds_many :notes, as: :noteable, cascade_callbacks: true, validate: false
+  embeds_many :labels
   embeds_one :label, cascade_callbacks: true
 
+  has_many :same_name, class_name: 'Agent', inverse_of: :same_name
+
   after_upsert do |doc|
     doc.upserted = true
   end

data/spec/app/models/book.rb

@@ -1,6 +1,7 @@
 class Book
   include Mongoid::Document
   include Mongoid::Attributes::Dynamic
+  include Mongoid::Timestamps
   field :title, type: String
   field :chapters, type: Integer
   belongs_to :series
@@ -11,5 +12,5 @@ class Book
     doc.chapters = 5
   end
 
-  embeds_many :pages
+  embeds_many :pages, cascade_callbacks: true
 end

data/spec/app/models/delegating_patient.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+class DelegatingPatient
+  include Mongoid::Document
+
+  embeds_one :email
+
+  # Instance level delegation
+  delegate :address, to: :email
+
+  class << self
+    # Class level delegation
+    delegate :default_client, to: ::Mongoid
+  end
+end

data/spec/app/models/dokument.rb

@@ -2,4 +2,5 @@ class Dokument
   include Mongoid::Document
   include Mongoid::Timestamps
   embeds_many :addresses, as: :addressable, validate: false
+  field :title
 end

data/spec/app/models/ordered_post.rb

@@ -3,4 +3,9 @@ class OrderedPost
   field :title, type: String
   field :rating, type: Integer
   belongs_to :person
+
+  after_destroy do
+    person.title = 'Minus one ordered post.'
+    person.save
+  end
 end

data/spec/app/models/oscar.rb

@@ -7,9 +7,8 @@ class Oscar
   def complain
     if destroy_after_save?
       destroy
-      true
     else
-      false
+      throw(:abort)
     end
   end
 end

data/spec/app/models/page.rb

@@ -3,7 +3,7 @@ class Page
   embedded_in :quiz
   embeds_many :page_questions
 
-  embedded_in :book
+  embedded_in :book, touch: true
   embeds_many :notes
   field :content, :type => String
 

data/spec/app/models/person.rb

@@ -36,6 +36,7 @@ class Person
   field :overridden_setter, type: String
   field :arrays, type: Array
   field :range, type: Range
+  field :species, type: Symbol
 
   index age: 1
   index addresses: 1
@@ -43,8 +44,6 @@ class Person
   index name: 1
   index title: 1
 
-  index({ ssn: 1 }, { unique: true })
-
   attr_reader :rescored
 
   embeds_many :favorites, order: :title.desc, inverse_of: :perp, validate: false
@@ -134,7 +133,8 @@ class Person
     self.score_without_rescoring = score
   end
 
-  alias_method_chain :score=, :rescoring
+  alias_method :score_without_rescoring=, :score=
+  alias_method :score=, :score_with_rescoring=
 
   def update_addresses
     addresses.each do |address|

data/spec/app/models/princess.rb

@@ -1,8 +1,10 @@
 class Princess
   include Mongoid::Document
   field :primary_color
+  field :name, type: String
   def color
     primary_color.to_s
   end
   validates_presence_of :color
+  validates :name, presence: true, on: :update
 end

data/spec/app/models/record.rb

@@ -1,6 +1,7 @@
 class Record
   include Mongoid::Document
   field :name, type: String
+  field :producers, type: Array
 
   field :before_create_called, type: Mongoid::Boolean, default: false
   field :before_save_called, type: Mongoid::Boolean, default: false

data/spec/app/models/subscription.rb

@@ -1,4 +1,5 @@
 class Subscription
   include Mongoid::Document
   has_many :packs, class_name: "ShippingPack"
+  field :packs_count, type: Integer
 end

data/spec/app/models/thing.rb

@@ -4,6 +4,6 @@ class Thing
   embedded_in :actor
 
   def dont_do_it
-    false
+    throw(:abort)
   end
 end

data/spec/config/mongoid.yml

@@ -17,6 +17,10 @@ test:
       database: reports
       hosts:
         - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+      options:
+        user: "mongoid-user"
+        password: "password"
+        auth_source: "admin"
   options:
     include_root_in_json: false
     include_type_for_serialization: false
@@ -26,4 +30,15 @@ test:
     use_activesupport_time_zone: true
     use_utc: false
     log_level: :warn
+    belongs_to_required_by_default: false
     app_name: 'testing'
+test_with_max_staleness:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+      options:
+        read:
+          mode: :primary_preferred
+          max_staleness: 100

data/spec/integration/document_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Mongoid::Document do
+  context 'when including class uses delegate' do
+    let(:patient) do
+      DelegatingPatient.new(
+        email: Email.new(address: 'test@example.com'),
+      )
+    end
+
+    it 'works for instance level delegation' do
+      patient.address.should == 'test@example.com'
+    end
+
+    it 'works for class level delegation' do
+      DelegatingPatient.default_client.should be Mongoid.default_client
+    end
+  end
+end

data/spec/mongoid/atomic/modifiers_spec.rb

@@ -212,7 +212,7 @@ describe Mongoid::Atomic::Modifiers do
         it "adds the push all modifiers" do
           expect(modifiers).to eq(
             { "$push" =>
-              { "addresses" => { '$each' => [
+                { "addresses" => { '$each' => [
                   { "street" => "Oxford St" }
                 ] }
               }
@@ -300,7 +300,7 @@ describe Mongoid::Atomic::Modifiers do
           expect(modifiers).to eq(
             { "$pullAll" => {
               "addresses" => { "street" => "Bond St" }},
-              conflicts: { "$push" => 
+              conflicts: { "$push" =>
                 { "addresses" => { '$each' => [
                     { "street" => "Oxford St" }
                   ] }
@@ -329,7 +329,7 @@ describe Mongoid::Atomic::Modifiers do
         it "adds the push all modifiers to the conflicts hash" do
           expect(modifiers).to eq(
             { "$push" => {
-              "addresses.0.locations" => {'$each' => [{ "street" => "Bond St" }]}},
+              "addresses.0.locations" => { '$each' => [{ "street" => "Bond St" }] } },
               conflicts: { "$push" =>
                 { "addresses" => { '$each' => [
                     { "street" => "Oxford St" }

data/spec/mongoid/atomic_spec.rb

@@ -76,13 +76,13 @@ describe Mongoid::Atomic do
             person.addresses.build(street: "Oxford St")
           end
 
-          it "returns a $set and $push and $each for modifications" do
+          it "returns a $set and $push for modifications" do
             expect(person.atomic_updates).to eq(
               {
                 "$set" => { "title" => "Sir" },
-                "$push" => { "addresses" => {'$each' => [
+                "$push" => { "addresses" => { '$each' => [
                     { "_id" => "oxford-st", "street" => "Oxford St" }
-                  ] } }
+                  ]} }
               }
             )
           end
@@ -339,14 +339,14 @@ describe Mongoid::Atomic do
             address.locations.build(name: "Home")
           end
 
-          it "returns the proper $sets and $pushs and $eaches for all levels" do
+          it "returns the proper $sets and $pushes for all levels" do
             expect(person.atomic_updates).to eq(
               {
                 "$set" => {
                   "title" => "Sir",
                 },
                 "$push" => {
-                  "addresses" => { "$each" => [{
+                  "addresses" => { '$each' => [{
                     "_id" => address.id,
                     "street" => "Another",
                     "locations" => [

data/spec/mongoid/attributes/nested_spec.rb

@@ -205,6 +205,10 @@ describe Mongoid::Attributes::Nested do
         Post.accepts_nested_attributes_for :person
       end
 
+      after do
+        Post.reset_callbacks(:save)
+      end
+
       let(:post) do
         Post.new(person_attributes: { title: "Sir" })
       end
@@ -1335,7 +1339,7 @@ describe Mongoid::Attributes::Nested do
                 expect {
                   person.addresses_attributes =
                     { "foo" => { "id" => "test", "street" => "Test" } }
-                }.to raise_error
+                }.to raise_error(Mongoid::Errors::DocumentNotFound)
               end
             end
           end
@@ -1434,7 +1438,7 @@ describe Mongoid::Attributes::Nested do
                       Person.create(age: 42)
                     end
 
-                    context "when the child returns false in a before callback" do
+                    context "when the child halts the callback chain in a before callback" do
 
                       context "when the child is not paranoid" do
 
@@ -1970,7 +1974,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "ignores the the marked document" do
+                  it "ignores the marked document" do
                     expect(person.addresses.size).to eq(1)
                   end
 
@@ -2031,7 +2035,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "adds the the marked document" do
+                  it "adds the marked document" do
                     expect(person.addresses.first.street).to eq("Maybachufer")
                   end
 
@@ -2091,7 +2095,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "adds the the marked document" do
+                  it "adds the marked document" do
                     expect(person.addresses.first.street).to eq("Maybachufer")
                   end
 
@@ -3028,7 +3032,7 @@ describe Mongoid::Attributes::Nested do
                 expect {
                   person.posts_attributes =
                     { "foo" => { "id" => "test", "title" => "Test" } }
-                }.to raise_error
+                }.to raise_error(Mongoid::Errors::DocumentNotFound)
               end
             end
           end
@@ -3431,7 +3435,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "ignores the the marked document" do
+                  it "ignores the marked document" do
                     expect(person.posts.size).to eq(1)
                   end
 
@@ -3492,7 +3496,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "adds the the marked document" do
+                  it "adds the marked document" do
                     expect(person.posts.first.title).to eq("New Blog")
                   end
 
@@ -3552,7 +3556,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "adds the the marked document" do
+                  it "adds the marked document" do
                     expect(person.posts.first.title).to eq("New Blog")
                   end
 
@@ -3745,7 +3749,7 @@ describe Mongoid::Attributes::Nested do
                 expect {
                   person.preferences_attributes =
                     { "foo" => { "id" => "test", "name" => "Test" } }
-                }.to raise_error
+                }.to raise_error(Mongoid::Errors::DocumentNotFound)
               end
             end
           end
@@ -4097,7 +4101,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "ignores the the marked document" do
+                  it "ignores the marked document" do
                     expect(person.preferences.size).to eq(1)
                   end
 
@@ -4158,7 +4162,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "adds the the marked document" do
+                  it "adds the marked document" do
                     expect(person.preferences.first.name).to eq("New Blog")
                   end
 
@@ -4218,7 +4222,7 @@ describe Mongoid::Attributes::Nested do
                       }
                   end
 
-                  it "adds the the marked document" do
+                  it "adds the marked document" do
                     expect(person.preferences.first.name).to eq("New Blog")
                   end
 
@@ -4852,7 +4856,7 @@ describe Mongoid::Attributes::Nested do
           end
 
           it "the update raises an error" do
-            expect{ error_raising_update }.to raise_error
+            expect{ error_raising_update }.to raise_error(Mongoid::Errors::Validations)
           end
 
           it "the update does not occur" do