mongoid 7.3.5 → 7.5.0

data/lib/mongoid/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
-  VERSION = "7.3.5"
+  VERSION = "7.5.0"
 end

data/lib/mongoid/warnings.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mongoid
+
+  # Encapsulates behavior around logging and caching warnings so they are only
+  # logged once.
+  #
+  # @api private
+  module Warnings
+
+    class << self
+      def warning(id, message)
+        singleton_class.class_eval do
+          define_method("warn_#{id}") do
+            unless instance_variable_get("@#{id}")
+              Mongoid.logger.warn(message)
+              instance_variable_set("@#{id}", true)
+            end
+          end
+        end
+      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.'
+  end
+end
+

data/lib/mongoid.rb

@@ -1,7 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
-
-require "support/ruby_version"
 
 require "forwardable"
 require "time"
@@ -26,6 +23,7 @@ require "mongoid/clients"
 require "mongoid/document"
 require "mongoid/tasks/database"
 require "mongoid/query_cache"
+require "mongoid/warnings"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.
@@ -42,8 +40,6 @@ module Mongoid
   extend self
 
   # A string added to the platform details of Ruby driver client handshake documents.
-  #
-  # @since 6.1.0
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
 
   # The minimum MongoDB version supported.
@@ -62,8 +58,6 @@ module Mongoid
   #   end
   #
   # @return [ Config ] The configuration object.
-  #
-  # @since 1.0.0
   def configure
     block_given? ? yield(Config) : Config
   end
@@ -74,8 +68,6 @@ module Mongoid
   #   Mongoid.default_client
   #
   # @return [ Mongo::Client ] The default client.
-  #
-  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -86,8 +78,6 @@ module Mongoid
   #   Mongoid.disconnect_clients
   #
   # @return [ true ] True.
-  #
-  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -98,8 +88,6 @@ module Mongoid
   #   Mongoid.client(:default)
   #
   # @return [ Mongo::Client ] The named client.
-  #
-  # @since 5.0.0
   def client(name)
     Clients.with_name(name)
   end
@@ -109,8 +97,6 @@ module Mongoid
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
-  #
-  # @since 1.0.0
   def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
 
 

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'rails/generators/mongoid_generator'
 

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

@@ -125,9 +125,6 @@ development:
     # database name is not explicitly defined. (default: nil)
     # app_name: MyApplicationName
     
-    # Create indexes in background by default. (default: false)
-    # background_indexing: false
-    
     # Mark belongs_to associations as required by default, so that saving a
     # model with a missing belongs_to association will trigger a validation
     # error. (default: true)
@@ -172,6 +169,10 @@ development:
     # (default: false)
     # use_utc: false
 
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    # background_indexing: false
+
 test:
   clients:
     default:

data/lib/rails/generators/mongoid/model/model_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "rails/generators/mongoid_generator"
 

data/lib/rails/generators/mongoid_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "rails/generators/named_base"
 require "rails/generators/active_model"

data/lib/rails/mongoid.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Rails
   module Mongoid
@@ -45,8 +44,6 @@ module Rails
     #   Mongoid.load_model("/mongoid/behavior")
     #
     # @param [ String ] file The base filename.
-    #
-    # @since 2.0.0.rc.3
     def load_model(file)
       begin
         require_dependency(file)

data/spec/config/mongoid_with_schema_map_uuid.yml

@@ -0,0 +1,27 @@
+test:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        auto_encryption_options:
+          key_vault_namespace: 'admin.datakeys'
+          kms_providers:
+            local:
+              key: "z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U"
+          schema_map:
+            blog_development.comments:
+              properties:
+                message:
+                  encrypt:
+                    keyId:
+                      - !ruby/object:BSON::Binary
+                        data: !binary |-
+                          R/AgNcxASFiiJWKXqWGo5w==
+                        type: :uuid
+                    bsonType: "string"
+                    algorithm: "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
+              bsonType: "object"

data/spec/integration/app_spec.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 
 BASE = File.join(File.dirname(__FILE__), '../..')
 TMP_BASE = File.join(BASE, 'tmp')
 
+def check_call(cmd, **opts)
+  puts "Executing #{cmd.join(' ')}"
+  Mrss::ChildProcessHelper.check_call(cmd, **opts)
+end
+
 describe 'Mongoid application tests' do
   before(:all) do
     unless SpecConfig.instance.app_tests?
@@ -88,14 +92,14 @@ describe 'Mongoid application tests' do
 
       Dir.chdir(TMP_BASE) do
         FileUtils.rm_rf('mongoid-test')
-        Mrss::ChildProcessHelper.check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
+        check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
 
         Dir.chdir('mongoid-test') do
           adjust_app_gemfile
-          Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+          check_call(%w(bundle install), env: clean_env)
 
-          Mrss::ChildProcessHelper.check_call(%w(rails g model post), env: clean_env)
-          Mrss::ChildProcessHelper.check_call(%w(rails g model comment post:belongs_to), env: clean_env)
+          check_call(%w(rails g model post), env: clean_env)
+          check_call(%w(rails g model comment post:belongs_to), env: clean_env)
 
           # https://jira.mongodb.org/browse/MONGOID-4885
           comment_text = File.read('app/models/comment.rb')
@@ -110,16 +114,16 @@ describe 'Mongoid application tests' do
 
       Dir.chdir(TMP_BASE) do
         FileUtils.rm_rf('mongoid-test-config')
-        Mrss::ChildProcessHelper.check_call(%w(rails new mongoid-test-config --skip-spring --skip-active-record), env: clean_env)
+        check_call(%w(rails new mongoid-test-config --skip-spring --skip-active-record), env: clean_env)
 
         Dir.chdir('mongoid-test-config') do
           adjust_app_gemfile
-          Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+          check_call(%w(bundle install), env: clean_env)
 
           mongoid_config_file = File.join(TMP_BASE,'mongoid-test-config/config/mongoid.yml')
 
           File.exist?(mongoid_config_file).should be false
-          Mrss::ChildProcessHelper.check_call(%w(rails g mongoid:config), env: clean_env)
+          check_call(%w(rails g mongoid:config), env: clean_env)
           File.exist?(mongoid_config_file).should be true
 
           config_text = File.read(mongoid_config_file)
@@ -131,10 +135,11 @@ describe 'Mongoid application tests' do
   end
 
   def install_rails
-    Mrss::ChildProcessHelper.check_call(%w(gem uni rails -a))
+    check_call(%w(gem uni rails -a))
     if (rails_version = SpecConfig.instance.rails_version) == 'master'
     else
-      Mrss::ChildProcessHelper.check_call(%w(gem install rails --no-document -v) + [rails_version])
+      check_call(%w(gem list))
+      check_call(%w(gem install rails --no-document -v) + ["~> #{rails_version}.0"])
     end
   end
 
@@ -158,7 +163,7 @@ describe 'Mongoid application tests' do
               before do
                 Dir.chdir(APP_PATH) do
                   remove_bundler_req
-                  Mrss::ChildProcessHelper.check_call(%w(bundle install), env: env)
+                  check_call(%w(bundle install), env: env)
                   write_mongoid_yml
                 end
 
@@ -172,7 +177,7 @@ describe 'Mongoid application tests' do
                 end
                 index.should be nil
 
-                Mrss::ChildProcessHelper.check_call(%w(bundle exec rake db:mongoid:create_indexes),
+                check_call(%w(bundle exec rake db:mongoid:create_indexes -t),
                   cwd: APP_PATH, env: env)
 
                 index = client['posts'].indexes.detect do |index|
@@ -190,11 +195,11 @@ describe 'Mongoid application tests' do
   def clone_application(repo_url, subdir: nil)
     Dir.chdir(TMP_BASE) do
       FileUtils.rm_rf(File.basename(repo_url))
-      Mrss::ChildProcessHelper.check_call(%w(git clone) + [repo_url])
+      check_call(%w(git clone) + [repo_url])
       Dir.chdir(File.join(*[File.basename(repo_url), subdir].compact)) do
         adjust_app_gemfile
         adjust_rails_defaults
-        Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+        check_call(%w(bundle install), env: clean_env)
         puts `git diff`
 
         write_mongoid_yml
@@ -317,7 +322,7 @@ describe 'Mongoid application tests' do
     # in `initialize': too long unix socket path (126bytes given but 108bytes max) (ArgumentError)
     # Is it trying to create unix sockets in current directory?
     # https://stackoverflow.com/questions/30302021/rails-runner-without-spring
-    Mrss::ChildProcessHelper.check_call(%w(bin/spring binstub --remove --all), env: clean_env)
+    check_call(%w(bin/spring binstub --remove --all), env: clean_env)
   end
 
   def clean_env

data/spec/integration/associations/belongs_to_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative '../../mongoid/association/referenced/has_one_models'

data/spec/integration/associations/embedded_dirty_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../mongoid/association/embedded/embeds_many_models'
+require_relative '../../mongoid/association/embedded/embeds_one_models'
+
+describe 'embedded associations' do
+  describe 'dirty tracking' do
+    context 'when association is cyclic' do
+      before do
+        # create deeply nested record
+        a = EmmOuter.create(level: 0)
+        level = 1
+        iter = a.inners.create(level: level)
+        loop do
+          iter.friends.create(level: (level += 1))
+          iter = iter.friends[0]
+          break if level == 40
+        end
+      end
+
+      let(:subject) { EmmOuter.first }
+
+      it 'performs dirty tracking efficiently' do
+        subject.changed?.should be false
+      end
+
+      it 'calculates the descendants properly' do
+        expect(subject._descendants.length).to eq(40)
+      end
+    end
+
+    context 'when association is cyclic and the _id is nil' do
+      before do
+        # create deeply nested record
+        a = EmmOuter.create(level: 0)
+        level = 1
+        iter = a.inners.create(id: nil, level: level)
+        loop do
+          iter.friends.create(id: nil, level: (level += 1))
+          iter = iter.friends[0]
+          break if level == 40
+        end
+      end
+
+      let(:subject) { EmmOuter.first }
+
+      it 'performs dirty tracking efficiently' do
+        subject.changed?.should be false
+      end
+
+      it 'calculates the descendants properly' do
+        expect(subject._descendants.length).to eq(40)
+      end
+    end
+  end
+end

data/spec/integration/associations/embedded_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative '../../mongoid/association/embedded/embeds_many_models'

data/spec/integration/associations/embeds_many_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/associations/embeds_one_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/associations/foreign_key_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative './foreign_key_spec_models'

data/spec/integration/associations/foreign_key_spec_models.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module ForeignKeySpec
   class Company

data/spec/integration/associations/has_many_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require 'mongoid/association/referenced/has_many_models'

data/spec/integration/associations/has_one_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require 'mongoid/association/referenced/has_one_models'

data/spec/integration/associations/nested_attributes_assignment_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/associations/reverse_population_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative './reverse_population_spec_models'

data/spec/integration/associations/reverse_population_spec_models.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module ReversePopulationSpec
   class Company

data/spec/integration/associations/scope_option_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../mongoid/association/referenced/has_and_belongs_to_many_models'
+require_relative '../../mongoid/association/referenced/has_many_models'
+require_relative '../../mongoid/association/referenced/has_one_models'
+
+describe 'association :scope option' do
+
+  context 'has_many and belongs_to' do
+    let!(:trainer1) { HmmTrainer.create!(name: 'Dave') }
+    let!(:trainer2) { HmmTrainer.create!(name: 'Ash') }
+    let!(:animal1) { HmmAnimal.create!(taxonomy: 'reptile', trainer: trainer1) }
+    let!(:animal2) { HmmAnimal.create!(taxonomy: 'bird', trainer: trainer1) }
+    let!(:animal3) { HmmAnimal.create!(taxonomy: 'mammal', trainer: trainer2) }
+
+    it 'initially associates the documents in-memory' do
+      expect(trainer1.animals).to eq [animal1, animal2]
+      expect(trainer2.animals).to eq [animal3]
+      expect(animal1.trainer).to eq trainer1
+      expect(animal2.trainer).to eq trainer1
+      expect(animal3.trainer).to eq trainer2
+    end
+
+    it 'loads correct documents when queried' do
+      expect(trainer1.reload.animals).to eq [animal1]
+      expect(trainer2.reload.animals).to eq []
+      expect(animal1.reload.trainer).to eq trainer1
+      expect(animal2.reload.trainer).to eq trainer1
+      expect(animal3.reload.trainer).to be_nil
+    end
+
+    it 'eager loads correct documents' do
+      expect(HmmTrainer.includes(:animals).find(trainer1._id).animals).to eq [animal1]
+      expect(HmmTrainer.includes(:animals).find(trainer2._id).animals).to eq []
+      expect(HmmAnimal.includes(:trainer).find(animal1._id).trainer).to eq trainer1
+      expect(HmmAnimal.includes(:trainer).find(animal2._id).trainer).to eq trainer1
+      expect(HmmAnimal.includes(:trainer).find(animal3._id).trainer).to be_nil
+    end
+  end
+
+  context 'has_one and belongs_to' do
+    let!(:trainer1) { HomTrainer.create!(name: 'Dave') }
+    let!(:trainer2) { HomTrainer.create!(name: 'Ash') }
+    let!(:animal1) { HomAnimal.create!(taxonomy: 'reptile', trainer: trainer1) }
+    let!(:animal2) { HomAnimal.create!(taxonomy: 'bird', trainer: trainer1) }
+    let!(:animal3) { HomAnimal.create!(taxonomy: 'mammal', trainer: trainer2) }
+
+    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(animal2.trainer).to eq trainer1
+      expect(animal3.trainer).to eq trainer2
+    end
+
+    it 'loads correct documents when queried' do
+      expect(trainer1.reload.animal).to eq animal1
+      expect(trainer2.reload.animal).to be_nil
+      expect(animal1.reload.trainer).to eq trainer1
+      expect(animal2.reload.trainer).to eq trainer1
+      expect(animal3.reload.trainer).to be_nil
+    end
+
+    it 'eager loads correct documents' do
+      expect(HomTrainer.includes(:animal).find(trainer1._id).animal).to eq animal1
+      expect(HomTrainer.includes(:animal).find(trainer2._id).animal).to be_nil
+      expect(HomAnimal.includes(:trainer).find(animal1._id).trainer).to eq trainer1
+      expect(HomAnimal.includes(:trainer).find(animal2._id).trainer).to eq trainer1
+      expect(HomAnimal.includes(:trainer).find(animal3._id).trainer).to be_nil
+    end
+  end
+
+  context 'has_and_belongs_to_many' do
+    let!(:trainer1) { HabtmmTrainer.create!(name: 'Dave') }
+    let!(:trainer2) { HabtmmTrainer.create!(name: 'Ash') }
+    let!(:animal1) { HabtmmAnimal.create!(taxonomy: 'reptile', trainers: [trainer1, trainer2]) }
+    let!(:animal2) { HabtmmAnimal.create!(taxonomy: 'bird', trainers: [trainer1, trainer2]) }
+
+    it 'initially associates the documents in-memory' do
+      expect(trainer1.animals).to eq [animal1]
+      expect(trainer2.animals).to eq [animal1]
+      expect(animal1.trainers).to eq [trainer1, trainer2]
+      expect(animal2.trainers).to eq [trainer1, trainer2]
+    end
+
+    it 'loads correct documents when queried' do
+      expect(trainer1.reload.animals).to eq [animal1]
+      expect(trainer2.reload.animals).to eq [animal1]
+      expect(animal1.reload.trainers).to eq [trainer1]
+      expect(animal2.reload.trainers).to eq [trainer1]
+    end
+
+    it 'eager loads correct documents' do
+      expect(HabtmmTrainer.includes(:animals).find(trainer1._id).animals).to eq [animal1]
+      expect(HabtmmTrainer.includes(:animals).find(trainer2._id).animals).to eq [animal1]
+      expect(HabtmmAnimal.includes(:trainers).find(animal1._id).trainers).to eq [trainer1]
+      expect(HabtmmAnimal.includes(:trainers).find(animal2._id).trainers).to eq [trainer1]
+    end
+  end
+end

data/spec/integration/atomic/modifiers_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "spec_helper"
 

data/spec/integration/bson_regexp_raw_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/callbacks_models.rb

@@ -47,3 +47,15 @@ class Planet
     self.age ||= 2_000
   end
 end
+
+class Emission
+  include Mongoid::Document
+
+  field :frequency
+
+  after_save do
+    @previous = attribute_was(:frequency)
+  end
+
+  attr_reader :previous
+end

data/spec/integration/callbacks_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 require_relative './callbacks_models'
@@ -149,7 +148,7 @@ describe 'callbacks integration tests' do
       end
     end
 
-    context 'when updating top-level document via #update_attributes' do
+    context 'when updating top-level document via #update_attributes!' do
       let!(:instance) do
         Galaxy.create!
       end
@@ -167,7 +166,7 @@ describe 'callbacks integration tests' do
 
         context 'set as a document instance' do
           before do
-            instance.update_attributes(stars: [Star.new])
+            instance.update_attributes!(stars: [Star.new])
           end
 
           include_examples 'persists the attribute value'
@@ -175,7 +174,7 @@ describe 'callbacks integration tests' do
 
         context 'set as attributes on parent' do
           before do
-            instance.update_attributes(stars: [{}])
+            instance.update_attributes!(stars: [{}])
           end
 
           include_examples 'persists the attribute value'
@@ -197,7 +196,7 @@ describe 'callbacks integration tests' do
 
         context 'set as a document instance' do
           before do
-            instance.update_attributes(stars: [Star.new(planets: [Planet.new])])
+            instance.update_attributes!(stars: [Star.new(planets: [Planet.new])])
           end
 
           include_examples 'persists the attribute value'
@@ -205,7 +204,7 @@ describe 'callbacks integration tests' do
 
         context 'set as attributes on parent' do
           before do
-            instance.update_attributes(stars: [planets: [{}]])
+            instance.update_attributes!(stars: [planets: [{}]])
           end
 
           include_examples 'persists the attribute value'
@@ -213,4 +212,17 @@ describe 'callbacks integration tests' do
       end
     end
   end
+
+  context 'attribute_was value in after_save callback' do
+    let!(:obj) { Emission.create!(frequency: 1) }
+
+    it 'is set to the new value' do
+      pending 'MONGOID-5104'
+
+      obj.frequency = 2
+      obj.save!
+
+      obj.previous.should == 2
+    end
+  end
 end

data/spec/integration/contextual/empty_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'