mongoid 8.0.5 → 8.1.0

data/lib/mongoid/query_cache.rb

@@ -14,6 +14,7 @@ module Mongoid
       #
       # @return [ nil ] Always nil.
       def clear_cache
+        Mongoid::Warnings.warn_mongoid_query_cache_clear
         Mongo::QueryCache.clear
       end
 
@@ -24,6 +25,7 @@ module Mongoid
       #
       # @param [ true | false ] value The enabled value.
       def enabled=(value)
+        Mongoid::Warnings.warn_mongoid_query_cache
         Mongo::QueryCache.enabled = value
       end
 
@@ -34,6 +36,7 @@ module Mongoid
       #
       # @return [ true | false ] If the cache is enabled.
       def enabled?
+        Mongoid::Warnings.warn_mongoid_query_cache
         Mongo::QueryCache.enabled?
       end
 
@@ -44,6 +47,7 @@ module Mongoid
       #
       # @return [ Object ] The result of the block.
       def cache(&block)
+        Mongoid::Warnings.warn_mongoid_query_cache
         Mongo::QueryCache.cache(&block)
       end
 
@@ -54,6 +58,7 @@ module Mongoid
       #
       # @return [ Object ] The result of the block.
       def uncached(&block)
+        Mongoid::Warnings.warn_mongoid_query_cache
         Mongo::QueryCache.uncached(&block)
       end
     end
@@ -61,4 +66,3 @@ module Mongoid
     Middleware = Mongo::QueryCache::Middleware
   end
 end
-

data/lib/mongoid/railties/database.rake

@@ -25,7 +25,7 @@ namespace :db do
 
   unless Rake::Task.task_defined?("db:setup")
     desc "Create the database, and initialize with the seed data"
-    task :setup => [ "db:create", "mongoid:create_indexes", "db:seed" ]
+    task :setup => [ "db:create", "mongoid:create_collections", "mongoid:create_indexes", "db:seed" ]
   end
 
   unless Rake::Task.task_defined?("db:reset")
@@ -55,10 +55,15 @@ namespace :db do
 
   unless Rake::Task.task_defined?("db:test:prepare")
     namespace :test do
-      task :prepare => "mongoid:create_indexes"
+      task :prepare => ["mongoid:create_collections", "mongoid:create_indexes"]
     end
   end
 
+  unless Rake::Task.task_defined?("db:create_collections")
+    desc "Create collections specified in Mongoid models"
+    task :create_collections => "mongoid:create_collections"
+  end
+
   unless Rake::Task.task_defined?("db:create_indexes")
     desc "Create indexes specified in Mongoid models"
     task :create_indexes => "mongoid:create_indexes"

data/lib/mongoid/reloadable.rb

@@ -16,14 +16,16 @@ module Mongoid
     #
     # @return [ Document ] The document, reloaded.
     def reload
+      if @atomic_selector
+        # Clear atomic_selector cache for sharded clusters. MONGOID-5076
+        remove_instance_variable('@atomic_selector')
+      end
+
       reloaded = _reload
       if Mongoid.raise_not_found_error && (reloaded.nil? || reloaded.empty?)
         shard_keys = atomic_selector.with_indifferent_access.slice(*shard_key_fields, :_id)
         raise Errors::DocumentNotFound.new(self.class, _id, shard_keys)
       end
-
-      reset_atomic_updates!
-
       @attributes = reloaded
       @attributes_before_type_cast = @attributes.dup
       @changed_attributes = {}

data/lib/mongoid/stateful.rb

@@ -95,6 +95,23 @@ module Mongoid
         !_parent.delayed_atomic_sets[atomic_path]
     end
 
+    # Flags the document as readonly. Will cause a ReadonlyDocument error to be
+    # raised if the document is attempted to be saved, updated or destroyed.
+    #
+    # @example Flag the document as readonly.
+    #   document.readonly!
+    #
+    # @return [ true | false ] true if the document was successfully marked
+    #   readonly, false otherwise.
+    def readonly!
+      if Mongoid.legacy_readonly
+        Mongoid::Warnings.warn_legacy_readonly
+        false
+      else
+        @readonly = true
+      end
+    end
+
     # Is the document readonly?
     #
     # @example Is the document readonly?
@@ -102,7 +119,11 @@ module Mongoid
     #
     # @return [ true | false ] If the document is readonly.
     def readonly?
-      __selected_fields != nil
+      if Mongoid.legacy_readonly
+        __selected_fields != nil
+      else
+        @readonly ||= false
+      end
     end
 
     # Determine if the document can be set.

data/lib/mongoid/tasks/database.rake

@@ -5,6 +5,11 @@ namespace :db do
     task :load_models do
     end
 
+    desc "Create collections for Mongoid models"
+    task :create_collections => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.create_collections
+    end
+
     desc "Create indexes specified in Mongoid models"
     task :create_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.create_indexes
@@ -34,5 +39,12 @@ namespace :db do
     task :purge => :environment do
       ::Mongoid.purge!
     end
+
+    namespace :create_collections do
+      desc "Drop and create collections for Mongoid models"
+      task :force => [:environment, :load_models] do
+        ::Mongoid::Tasks::Database.create_collections(force: true)
+      end
+    end
   end
 end

data/lib/mongoid/tasks/database.rb

@@ -5,6 +5,26 @@ module Mongoid
     module Database
       extend self
 
+      # Create collections for each model given the provided globs and the class is
+      # not embedded.
+      #
+      # @param [ Array<Mongoid::Document> ] models. Array of document classes for
+      #   which collections should be created. Defaulted to all document classes
+      #   in the application.
+      # @param [ true | false ] force If true, the method will drop existing
+      #   collections before creating new ones. If false, the method will create
+      #   only new collection (that do not exist in the database).
+      def create_collections(models = ::Mongoid.models, force: false)
+        models.each do |model|
+          if !model.embedded? || model.cyclic?
+            model.create_collection(force: force)
+            logger.info("MONGOID: Created collection for #{model}:")
+          else
+            logger.info("MONGOID: collection options ignored on: #{model}, please define in the root model.")
+          end
+        end
+      end
+
       # Create indexes for each model given the provided globs and the class is
       # not embedded.
       #

data/lib/mongoid/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mongoid
+
+  # @api private
+  module Utils
+
+    # This function should be used if you need to measure time.
+    # @example Calculate elapsed time.
+    #   starting = Utils.monotonic_time
+    #   # do something time consuming
+    #   ending = Utils.monotonic_time
+    #   puts "It took #{(ending - starting).to_i} seconds"
+    #
+    # @see https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+    #
+    # @return [Float] seconds according to monotonic clock
+    module_function def monotonic_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/mongoid/validatable/macros.rb

@@ -18,7 +18,7 @@ module Mongoid
       #     validates_associated :name, :addresses
       #   end
       #
-      # @param [ Array ] args The arguments to pass to the validator.
+      # @param [ Object... ] *args The arguments to pass to the validator.
       def validates_associated(*args)
         validates_with(AssociatedValidator, _merge_attributes(args))
       end
@@ -35,7 +35,7 @@ module Mongoid
       #     validates_uniqueness_of :title
       #   end
       #
-      # @param [ Array ] args The arguments to pass to the validator.
+      # @param [ Object... ] *args The arguments to pass to the validator.
       def validates_uniqueness_of(*args)
         validates_with(UniquenessValidator, _merge_attributes(args))
       end
@@ -50,7 +50,7 @@ module Mongoid
       #     validates_format_of :title, with: /\A[a-z0-9 \-_]*\z/i
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_format_of(*args)
         validates_with(FormatValidator, _merge_attributes(args))
       end
@@ -65,7 +65,7 @@ module Mongoid
       #     validates_length_of :title, minimum: 100
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_length_of(*args)
         validates_with(LengthValidator, _merge_attributes(args))
       end
@@ -80,7 +80,7 @@ module Mongoid
       #     validates_presence_of :title
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_presence_of(*args)
         validates_with(PresenceValidator, _merge_attributes(args))
       end

data/lib/mongoid/validatable.rb

@@ -44,6 +44,8 @@ module Mongoid
     #
     # @param [ Hash ] options The options to check.
     #
+    # @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]
@@ -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

data/lib/mongoid/version.rb

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

data/lib/mongoid/warnings.rb

@@ -23,6 +23,22 @@ module Mongoid
 
     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 :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,8 +12,10 @@ 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"
@@ -25,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.
@@ -58,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/integration/app_spec.rb

@@ -326,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|
@@ -336,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/callbacks_models.rb

@@ -153,3 +153,40 @@ class Building
 
   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

data/spec/integration/callbacks_spec.rb

@@ -447,4 +447,138 @@ describe 'callbacks integration tests' do
       expect(saved_person.previously_persisted_value).to be_truthy
     end
   end
+
+  context 'saved_change_to_attribute, attribute_before_last_save, will_save_change_to_attribute' do
+    class TestSCTAAndABLSInCallbacks
+      include Mongoid::Document
+
+      field :name, type: String
+      field :age, type: Integer
+
+      set_callback :save, :before do |doc|
+        [:name, :age].each do |attr|
+          saved_change_to_attribute_values_before[attr] += [saved_change_to_attribute(attr)]
+          attribute_before_last_save_values_before[attr] += [attribute_before_last_save(attr)]
+          will_save_change_to_attribute_values_before[attr] += [will_save_change_to_attribute?(attr)]
+        end
+      end
+
+      set_callback :save, :after do |doc|
+        [:name, :age].each do |attr|
+          saved_change_to_attribute_values_after[attr] += [saved_change_to_attribute(attr)]
+          saved_change_to_attribute_q_values_after[attr] += [saved_change_to_attribute?(attr)]
+          attribute_before_last_save_values_after[attr] += [attribute_before_last_save(attr)]
+        end
+      end
+
+      def saved_change_to_attribute_values_before
+        @saved_change_to_attribute_values_before ||= Hash.new do
+          []
+        end
+      end
+
+      def attribute_before_last_save_values_before
+        @attribute_before_last_save_values_before ||= Hash.new do
+          []
+        end
+      end
+
+      def saved_change_to_attribute_values_after
+        @saved_change_to_attribute_values_after ||= Hash.new do
+          []
+        end
+      end
+
+      def saved_change_to_attribute_q_values_after
+        @saved_change_to_attribute_q_values_after ||= Hash.new do
+          []
+        end
+      end
+
+      def attribute_before_last_save_values_after
+        @attribute_before_last_save_values_after ||= Hash.new do
+          []
+        end
+      end
+
+      def will_save_change_to_attribute_values_before
+        @will_save_change_to_attribute_values_before ||= Hash.new do
+          []
+        end
+      end
+    end
+
+    it 'reproduces ActiveRecord::AttributeMethods::Dirty behavior' do
+      subject = TestSCTAAndABLSInCallbacks.new(name: 'Name 1')
+      subject.save!
+      subject.age = 18
+      subject.save!
+      subject.name = 'Name 2'
+      subject.save!
+
+      expect(subject.saved_change_to_attribute_values_before).to eq(
+        {
+          :name => [nil, [nil, "Name 1"], nil],
+          :age => [nil, nil, [nil, 18]],
+        }
+      )
+      expect(subject.saved_change_to_attribute_values_after).to eq(
+        {
+          :name => [[nil, "Name 1"], nil, ["Name 1", "Name 2"]],
+          :age => [nil, [nil, 18], nil],
+        }
+      )
+      expect(subject.saved_change_to_attribute_q_values_after).to eq(
+        {
+          :name => [true, false, true],
+          :age => [false, true, false],
+        }
+      )
+      expect(subject.attribute_before_last_save_values_before).to eq(
+        {
+          :name => [nil, nil, "Name 1"],
+          :age => [nil, nil, nil]
+        }
+      )
+      expect(subject.attribute_before_last_save_values_after).to eq(
+        {
+          :name => [nil, "Name 1", "Name 1"],
+          :age => [nil, nil, 18]
+        }
+      )
+      expect(subject.will_save_change_to_attribute_values_before).to eq(
+        {
+          :name => [true, false, true],
+          :age => [false, true, false]
+        }
+      )
+    end
+  end
+
+  context 'nested embedded documents' do
+    config_override :prevent_multiple_calls_of_embedded_callbacks, true
+
+    let(:logger) { Array.new }
+
+    let(:root) do
+      Root.new(
+        embedded_once: [
+          EmbeddedOnce.new(
+            embedded_twice: [EmbeddedTwice.new]
+          )
+        ]
+      )
+    end
+
+    before(:each) do
+      root.logger = logger
+      root.embedded_once.first.logger = logger
+      root.embedded_once.first.embedded_twice.first.logger = logger
+    end
+
+    it 'runs callbacks in the correct order' do
+      root.save!
+      expect(logger).to eq(%i[embedded_twice embedded_once root])
+    end
+  end
 end

data/spec/integration/discriminator_key_spec.rb

@@ -81,8 +81,9 @@ describe "#discriminator_key" do
     end
 
     context "before class creation" do
+      config_override :discriminator_key, "test"
+
       before do
-        Mongoid.discriminator_key = "test"
 
         class PreGlobalIntDiscriminatorParent
           include Mongoid::Document
@@ -93,7 +94,6 @@ describe "#discriminator_key" do
       end
 
       after do
-        Mongoid.discriminator_key = "_type"
         Object.send(:remove_const, :PreGlobalIntDiscriminatorParent)
         Object.send(:remove_const, :PreGlobalIntDiscriminatorChild)
       end
@@ -336,9 +336,9 @@ describe "#discriminator_key" do
     end
 
     context "Example 3" do
-      before do
-        Mongoid.discriminator_key = "shape_type"
+      config_override :discriminator_key, "shape_type"
 
+      before do
         class Example3Shape
           include Mongoid::Document
           field :x, type: Integer
@@ -358,7 +358,6 @@ describe "#discriminator_key" do
       end
 
       after do
-        Mongoid.discriminator_key = "_type"
         Object.send(:remove_const, :Example3Shape)
         Object.send(:remove_const, :Example3Circle)
         Object.send(:remove_const, :Example3Rectangle)

data/spec/integration/i18n_fallbacks_spec.rb

@@ -3,11 +3,12 @@
 require 'spec_helper'
 
 describe 'i18n fallbacks' do
-  with_i18n_fallbacks
+  require_fallbacks
 
   context 'when fallbacks are enabled with a locale list' do
+    with_default_i18n_configs
+
     before do
-      I18n.default_locale = :en
       I18n.fallbacks[:de] = [ :en ]
     end
 

data/spec/mongoid/association/embedded/embedded_in/proxy_spec.rb

@@ -616,4 +616,31 @@ describe Mongoid::Association::Embedded::EmbeddedIn::Proxy do
       end
     end
   end
+
+  context "when assigning a hash" do
+    let(:building_address) { BuildingAddress.new }
+
+    before do
+      building_address.building = { name: "Chrysler" }
+    end
+
+    it "creates the objects correctly" do
+      expect(building_address.building).to be_a(Building)
+      expect(building_address.building.name).to eq("Chrysler")
+    end
+  end
+
+  context "when replacing an association with a hash" do
+    let(:building_address) { BuildingAddress.new }
+
+    before do
+      building_address.building = { name: "Chrysler" }
+      building_address.building = { name: "Empire State" }
+    end
+
+    it "creates the objects correctly" do
+      expect(building_address.building).to be_a(Building)
+      expect(building_address.building.name).to eq("Empire State")
+    end
+  end
 end