mongoid 7.5.4 → 8.1.3

data/lib/mongoid/validatable.rb

@@ -44,7 +44,9 @@ module Mongoid
     #
     # @param [ Hash ] options The options to check.
     #
-    # @return [ true, false ] If we are validating.
+    # @option options [ true | false ] :validate Whether or not to validate.
+    #
+    # @return [ true | false ] If we are validating.
     def performing_validations?(options = {})
       options[:validate].nil? ? true : options[:validate]
     end
@@ -83,7 +85,7 @@ module Mongoid
     #
     # @param [ Symbol ] context The optional validation context.
     #
-    # @return [ true, false ] True if valid, false if not.
+    # @return [ true | false ] True if valid, false if not.
     def valid?(context = nil)
       super context ? context : (new_record? ? :create : :update)
     end
@@ -93,7 +95,7 @@ module Mongoid
     # @example Is the document validated?
     #   document.validated?
     #
-    # @return [ true, false ] Has the document already been validated?
+    # @return [ true | false ] Has the document already been validated?
     def validated?
       Threaded.validated?(self)
     end
@@ -103,7 +105,7 @@ module Mongoid
     # @example Are we validating with a query?
     #   document.validating_with_query?
     #
-    # @return [ true, false ] If we are validating with a query.
+    # @return [ true | false ] If we are validating with a query.
     def validating_with_query?
       self.class.validating_with_query?
     end
@@ -129,7 +131,8 @@ module Mongoid
       # @example Validate with a specific validator.
       #   validates_with MyValidator, on: :create
       #
-      # @param [ Class<Array>, Hash ] args The validator classes and options.
+      # @param [ ActiveModel::Validator..., Hash ] *args The validator classes
+      #   and options hash.
       #
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is
@@ -151,7 +154,7 @@ module Mongoid
       # @example Are we validating with a query?
       #   Model.validating_with_query?
       #
-      # @return [ true, false ] If we are validating with a query.
+      # @return [ true | false ] If we are validating with a query.
       def validating_with_query?
         Threaded.executing?("#{name}-validate-with-query")
       end

data/lib/mongoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mongoid
-  VERSION = "7.5.4"
+  VERSION = "8.1.3"
 end

data/lib/mongoid/warnings.rb

@@ -21,9 +21,24 @@ module Mongoid
       end
     end
 
-    warning :id_sort_deprecated, 'The :id_sort option has been deprecated. Use Mongo#take to get a document without a sort on _id.'
-    warning :criteria_cache_deprecated, 'The criteria cache has been deprecated and will be removed in Mongoid 8. Please enable the Mongoid QueryCache to have caching functionality.'
-    warning :map_field_deprecated, 'The field argument to the Mongo#map method has been deprecated, please pass in a block instead. Support will be dropped in Mongoid 8.'
+    warning :geo_haystack_deprecated, 'The geoHaystack type is deprecated.'
+    warning :as_json_compact_deprecated, '#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.'
+    warning :symbol_type_deprecated, 'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type.'
+    warning :legacy_readonly, 'The readonly! method will only mark the document readonly when the legacy_readonly feature flag is switched off.'
+    warning :use_activesupport_time_zone_deprecated, 'Config option :use_activesupport_time_zone is deprecated and should be removed from your config. It will always be true beginning in Mongoid 9.0.'
+    warning :broken_aggregables_deprecated, 'Config option :broken_aggregables is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_alias_handling_deprecated, 'Config option :broken_alias_handling is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_and_deprecated, 'Config option :broken_and is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_scoping_deprecated, 'Config option :broken_scoping is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_updates_deprecated, 'Config option :broken_updates is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :compare_time_by_ms_deprecated, 'Config option :compare_time_by_ms is deprecated. It will always be true beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_attributes_deprecated, 'Config option :legacy_attributes is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_pluck_distinct_deprecated, 'Config option :legacy_pluck_distinct is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_triple_equals_deprecated, 'Config option :legacy_triple_equals is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :object_id_as_json_oid_deprecated, 'Config option :object_id_as_json_oid is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :overwrite_chained_operators_deprecated, 'Config option :overwrite_chained_operators is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :mutable_ids, 'In Mongoid 9.0 the _id field will be immutable. In earlier versions of 8.x, mutating the _id field was supported inconsistently. Prepare your code for 9.0 by setting Mongoid::Config.immutable_ids to true.'
+    warning :mongoid_query_cache, 'In Mongoid 9.0, Mongoid::QueryCache will be removed. Please replace it with Mongo::QueryCache.'
+    warning :mongoid_query_cache_clear, 'In Mongoid 9.0, Mongoid::QueryCache#clear_cache should be replaced it with Mongo::QueryCache#clear.'
   end
 end
-

data/lib/mongoid.rb

@@ -12,10 +12,13 @@ require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
 
+require 'concurrent-ruby'
+
 require "mongo"
-require 'mongo/active_support'
+require "mongo/active_support"
 
 require "mongoid/version"
+require "mongoid/deprecable"
 require "mongoid/config"
 require "mongoid/persistence_context"
 require "mongoid/loggable"
@@ -24,6 +27,7 @@ require "mongoid/document"
 require "mongoid/tasks/database"
 require "mongoid/query_cache"
 require "mongoid/warnings"
+require "mongoid/utils"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.
@@ -57,9 +61,19 @@ module Mongoid
   #     }
   #   end
   #
+  # @example Using a block without an argument. Use `config` inside
+  #   the block to perform variable assignment.
+  #
+  #   Mongoid.configure do
+  #     connect_to("mongoid_test")
+  #
+  #     config.preload_models = true
+  #
   # @return [ Config ] The configuration object.
-  def configure
-    block_given? ? yield(Config) : Config
+  def configure(&block)
+    return Config unless block_given?
+
+    block.arity == 0 ? Config.instance_exec(&block) : yield(Config)
   end
 
   # Convenience method for getting the default client.

data/spec/config/mongoid.yml

@@ -40,6 +40,22 @@ test:
     app_name: 'testing'
     background_indexing: false
     join_contexts: false
+  driver_options:
+    broken_view_options: false
+    # Don't set validate_update_replace here, as it is used to check if the
+    # default driver options are kept in Mongoid.
+test_nil:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+  driver_options:
+    broken_view_options:
+    validate_update_replace: false
+
 test_with_max_staleness:
   clients:
     default:

data/spec/integration/app_spec.rb

@@ -163,6 +163,14 @@ describe 'Mongoid application tests' do
               before do
                 Dir.chdir(APP_PATH) do
                   remove_bundler_req
+
+                  if BSON::Environment.jruby?
+                    # Remove existing Gemfile.lock - see
+                    # https://github.com/rubygems/rubygems/issues/3231
+                    require 'fileutils'
+                    FileUtils.rm_f('Gemfile.lock')
+                  end
+
                   check_call(%w(bundle install), env: env)
                   write_mongoid_yml
                 end
@@ -287,18 +295,6 @@ describe 'Mongoid application tests' do
         f << lines.join
       end
     end
-
-    if rails_version == '5.1'
-      secrets = {
-        'development' => {
-          'secret_key_base' => 'abracadabra',
-          'my_secret_token' => 'very_secret',
-        },
-      }
-      File.open('config/secrets.yml', 'w') do |f|
-        f << YAML.dump(secrets)
-      end
-    end
   end
 
   def remove_bundler_req
@@ -330,7 +326,7 @@ describe 'Mongoid application tests' do
   end
 
   def wait_for_port(port, timeout, process)
-    deadline = Time.now + timeout
+    deadline = Mongoid::Utils.monotonic_time + timeout
     loop do
       begin
         Socket.tcp('localhost', port, nil, nil, connect_timeout: 0.5) do |socket|
@@ -340,7 +336,7 @@ describe 'Mongoid application tests' do
         unless process.alive?
           raise "Process #{process} died while waiting for port #{port}"
         end
-        if Time.now > deadline
+        if Mongoid::Utils.monotonic_time > deadline
           raise
         end
       end

data/spec/integration/associations/belongs_to_spec.rb

@@ -12,4 +12,22 @@ describe 'belongs_to associations' do
       expect(child).to be_valid
     end
   end
+
+  context 'when an anonymous class defines a belongs_to association' do
+    let(:klass) do
+      Class.new do
+        include Mongoid::Document
+        belongs_to :movie
+      end
+    end
+
+    it 'loads the association correctly' do
+      expect { klass }.to_not raise_error
+      expect { klass.new.movie }.to_not raise_error
+      instance = klass.new
+      movie = Movie.new
+      instance.movie = movie
+      expect(instance.movie).to eq movie
+    end
+  end
 end

data/spec/integration/associations/embedded_spec.rb

@@ -265,4 +265,19 @@ describe 'embedded associations' do
       end
     end
   end
+
+  context "when summing properties on an embedded child" do
+    let(:user) { EmmUser.new }
+    before do
+      user.orders.build(amount: 200)
+      expect(user.orders.sum(:amount)).to eq(200)
+
+      user.orders.delete_all
+      user.orders.build(amount: 500)
+    end
+
+    it "the cache is cleared after deletion" do
+      expect(user.orders.sum(:amount)).to eq(500)
+    end
+  end
 end

data/spec/integration/associations/embeds_many_spec.rb

@@ -172,8 +172,6 @@ describe 'embeds_many associations' do
           # Mongoid uses the new value of `x` in the $pullAll query,
           # which doesn't match the document that is in the database,
           # resulting in the empty array assignment not taking effect.
-          pending 'MONGOID-5037'
-
           canvas.shapes.first.x = 1
           canvas.shapes = []
           canvas.save!
@@ -203,4 +201,19 @@ describe 'embeds_many associations' do
       end
     end
   end
+
+  context 'when an anonymous class defines an embeds_many association' do
+    let(:klass) do
+      Class.new do
+        include Mongoid::Document
+        embeds_many :addresses
+      end
+    end
+
+    it 'loads the association correctly' do
+      expect { klass }.to_not raise_error
+      expect { klass.new.addresses }.to_not raise_error
+      expect(klass.new.addresses.build).to be_a Address
+    end
+  end
 end

data/spec/integration/associations/embeds_one_spec.rb

@@ -20,4 +20,22 @@ describe 'embeds_one associations' do
       end
     end
   end
+
+  context 'when an anonymous class defines an embeds_one association' do
+    let(:klass) do
+      Class.new do
+        include Mongoid::Document
+        embeds_one :address
+      end
+    end
+
+    it 'loads the association correctly' do
+      expect { klass }.to_not raise_error
+      expect { klass.new.address }.to_not raise_error
+      instance = klass.new
+      address = Address.new
+      instance.address = address
+      expect(instance.address).to eq address
+    end
+  end
 end

data/spec/integration/associations/foreign_key_spec.rb

@@ -27,6 +27,15 @@ describe 'Association foreign key configuration' do
       expect(email.company.id).to eq(company.id)
     end
 
+    it "has the correct criteria" do
+      company = ForeignKeySpec::Company.create!(c: "3")
+      email = ForeignKeySpec::Email.create!(company: company)
+
+      criteria = ForeignKeySpec::Email.where(company: company)
+
+      expect(criteria.selector).to eq({ "c_ref" => "3" })
+    end
+
     context 'with default scope' do
       context 'using default scope' do
         it 'looks up child' do

data/spec/integration/associations/has_and_belongs_to_many_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'has_and_belongs_to_many associations' do
+
+  context 'when an anonymous class defines a has_and_belongs_to_many association' do
+    let(:klass) do
+      Class.new do
+        include Mongoid::Document
+        has_and_belongs_to_many :movies, inverse_of: nil
+      end
+    end
+
+    it 'loads the association correctly' do
+      expect { klass }.to_not raise_error
+      expect { klass.new.movies }.to_not raise_error
+      expect(klass.new.movies.build).to be_a Movie
+    end
+  end
+end

data/spec/integration/associations/has_one_spec.rb

@@ -94,7 +94,7 @@ describe 'has_one associations' do
         context 'using send' do
           it 'delegates to the field' do
             if reloaded
-              pending 'MONGOID-4018'
+              pending 'MONGOID-5018'
             end
 
             parent.accreditation.send(:format).should == 'fmt'
@@ -173,4 +173,100 @@ describe 'has_one associations' do
       end
     end
   end
+
+  context "when assigning to a has_one" do
+    let(:post) { HomPost.create! }
+    let(:comment1) { HomComment.create!(content: "Comment 1") }
+
+    context "when assigning the same value" do
+      let(:comment2) { HomComment.create! }
+
+      it "persists it correctly" do
+        post.comment = comment1
+        post.reload
+        expect(post.comment).to eq(comment1)
+
+        post.comment = comment1
+        post.reload
+        expect(post.comment).to eq(comment1)
+      end
+    end
+
+    context "when assigning two values with the same _id" do
+      let(:comment2) { HomComment.new(id: comment1.id) }
+
+      it "raises a duplicate key error" do
+        post.comment = comment1
+        expect do
+          post.comment = comment2
+        end.to raise_error(Mongo::Error::OperationFailure, /duplicate key/)
+      end
+    end
+
+    context "when duping the object and changing attributes" do
+      let(:comment2) { comment1.dup }
+
+      before do
+        comment2.content = "Comment 2"
+
+        post.comment = comment1
+        post.reload
+      end
+
+      it "updates the attributes correctly" do
+        post.comment = comment2
+        post.reload
+
+        expect(post.comment).to eq(comment2)
+        expect(post.comment.content).to eq(comment2.content)
+      end
+    end
+
+    context "when explicitly setting the foreign key" do
+      let(:comment2) { HomComment.new(post_id: post.id, content: "2") }
+
+      it "persists the new comment" do
+        post.comment = comment1
+        post.reload
+
+        post.comment = comment2
+        post.reload
+
+        expect(post.comment).to eq(comment2)
+        expect(post.comment.content).to eq(comment2.content)
+      end
+    end
+
+    context "when reassigning the same value" do
+      let(:comment2) { HomComment.create!(content: "Comment 2") }
+
+      it "persists it correctly" do
+        post.comment = comment1
+        post.reload
+        expect(post.comment).to eq(comment1)
+
+        post.comment = comment2
+        post.reload
+        expect(post.comment).to eq(comment2)
+
+        post.comment = comment1
+        post.reload
+        expect(post.comment).to eq(nil)
+      end
+    end
+  end
+
+  context "when overwriting an association" do
+    let(:post1) { HomPost.create!(title: "post 1") }
+    let(:post2) { HomPost.create!(title: "post 2") }
+    let(:comment) { HomComment.create(post: post1) }
+
+    it "does not overwrite the original value" do
+      pending "MONGOID-3999"
+      p1 = comment.post
+      expect(p1.title).to eq("post 1")
+      comment.post = post2
+      expect(p1.title).to eq("post 1")
+    end
+  end
 end

data/spec/integration/associations/scope_option_spec.rb

@@ -49,7 +49,7 @@ describe 'association :scope option' do
     it 'initially associates the documents in-memory' do
       expect(trainer1.animal).to eq animal2
       expect(trainer2.animal).to eq animal3
-      expect(animal1.trainer).to eq trainer1
+      expect(animal1.trainer).to be_nil
       expect(animal2.trainer).to eq trainer1
       expect(animal3.trainer).to eq trainer2
     end

data/spec/integration/callbacks_models.rb

@@ -1,12 +1,17 @@
 class Galaxy
   include Mongoid::Document
+  include Mongoid::Timestamps
 
   field :age, type: Integer
-
+  field :was_touched, type: Mongoid::Boolean, default: false
   before_validation :set_age
 
   embeds_many :stars
 
+  set_callback(:touch, :before) do |document|
+    self.was_touched = true
+  end
+
   private
 
   def set_age
@@ -16,15 +21,21 @@ end
 
 class Star
   include Mongoid::Document
+  include Mongoid::Timestamps
 
   embedded_in :galaxy
 
   field :age, type: Integer
+  field :was_touched_after_parent, type: Mongoid::Boolean, default: false
 
   before_validation :set_age
 
   embeds_many :planets
 
+  set_callback(:touch, :before) do |document|
+    self.was_touched_after_parent = true if galaxy.was_touched
+  end
+
   private
 
   def set_age
@@ -34,13 +45,19 @@ end
 
 class Planet
   include Mongoid::Document
+  include Mongoid::Timestamps
 
   embedded_in :star
 
   field :age, type: Integer
+  field :was_touched_after_parent, type: Mongoid::Boolean, default: false
 
   before_validation :set_age
 
+  set_callback(:touch, :before) do |document|
+    self.was_touched_after_parent = true if star.was_touched_after_parent
+  end
+
   private
 
   def set_age
@@ -59,3 +76,117 @@ class Emission
 
   attr_reader :previous
 end
+
+class Country
+  include Mongoid::Document
+
+  field :age
+
+  before_validation :set_age
+
+  embeds_one :president
+
+  private
+
+  def set_age
+    self.age ||= 245
+  end
+end
+
+class President
+  include Mongoid::Document
+
+  embedded_in :country
+
+  field :age
+
+  field :name
+
+  before_validation :set_age
+
+  embeds_one :first_spouse
+
+  private
+
+  def set_age
+    self.age ||= 79
+  end
+end
+
+class FirstSpouse
+  include Mongoid::Document
+
+  embedded_in :president
+
+  field :name
+  field :age, type: Integer
+
+  before_validation :set_age
+
+  private
+
+  def set_age
+    self.age ||= 70
+  end
+end
+
+class Architect
+  include Mongoid::Document
+
+  has_and_belongs_to_many :buildings, after_add: :after_add_callback,
+    after_remove: :after_remove_callback, dependent: :nullify
+
+  field :after_add_num_buildings, type: Integer
+  field :after_remove_num_buildings, type: Integer
+
+  def after_add_callback(obj)
+    self.after_add_num_buildings = self.buildings.length
+  end
+
+  def after_remove_callback(obj)
+    self.after_remove_num_buildings = self.buildings.length
+  end
+end
+
+class Building
+  include Mongoid::Document
+
+  has_and_belongs_to_many :architects, dependent: :nullify
+end
+
+class Root
+  include Mongoid::Document
+  embeds_many :embedded_once, cascade_callbacks: true
+  after_save :trace
+
+  attr_accessor :logger
+
+  def trace
+    logger << :root
+  end
+end
+
+class EmbeddedOnce
+  include Mongoid::Document
+  embeds_many :embedded_twice, cascade_callbacks: true
+  embedded_in :root
+  after_save :trace
+
+  attr_accessor :logger
+
+  def trace
+    logger << :embedded_once
+  end
+end
+
+class EmbeddedTwice
+  include Mongoid::Document
+  embedded_in :embedded_once
+  after_save :trace
+
+  attr_accessor :logger
+
+  def trace
+    logger << :embedded_twice
+  end
+end