mongoid 6.1.0 → 6.1.1

data/lib/mongoid/tasks/database.rb

@@ -36,7 +36,8 @@ module Mongoid
       # @example Return the list of unused indexes.
       #   Mongoid::Tasks::Database.undefined_indexes
       #
-      # @return Hash{Class => Array(Hash)} The list of undefined indexes by model.
+      # @return [ Array<Hash> ] The list of undefined indexes by model.
+      #
       def undefined_indexes(models = ::Mongoid.models)
         undefined_by_model = {}
 

data/lib/mongoid/threaded.rb

@@ -64,7 +64,7 @@ module Mongoid
     # @example Set the global database override.
     #   Threaded.database_override = :testing
     #
-    # @param [ String, Symbol ] The global override name.
+    # @param [ String, Symbol ] name The global override name.
     #
     # @return [ String, Symbol ] The override.
     #
@@ -180,7 +180,7 @@ module Mongoid
     # @example Set the global client override.
     #   Threaded.client_override = :testing
     #
-    # @param [ String, Symbol ] The global override name.
+    # @param [ String, Symbol ] name The global override name.
     #
     # @return [ String, Symbol ] The override.
     #
@@ -304,7 +304,7 @@ module Mongoid
     # @example Get all autosaves.
     #   Threaded.autosaves_for(Person)
     #
-    # @param [ Class ] The class to check.
+    # @param [ Class ] klass The class to check.
     #
     # @return [ Array ] The current autosaves.
     #
@@ -317,7 +317,7 @@ module Mongoid
     # @example Get all validations.
     #   Threaded.validations_for(Person)
     #
-    # @param [ Class ] The class to check.
+    # @param [ Class ] klass The class to check.
     #
     # @return [ Array ] The current validations.
     #

data/lib/mongoid/validatable.rb

@@ -144,7 +144,7 @@ module Mongoid
       # @example Validate with a specific validator.
       #   validates_with MyValidator, on: :create
       #
-      # @param [ Class<Array>, Hash ] *args The validator classes and options.
+      # @param [ Class<Array>, Hash ] args The validator classes and options.
       #
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is

data/lib/mongoid/validatable/macros.rb

@@ -17,7 +17,8 @@ module Mongoid
       #     validates_associated :name, :addresses
       #   end
       #
-      # @param [ Array ] *args The arguments to pass to the validator.
+      # @param [ Array ] args The arguments to pass to the validator.
+      #
       def validates_associated(*args)
         validates_with(AssociatedValidator, _merge_attributes(args))
       end
@@ -34,7 +35,8 @@ module Mongoid
       #     validates_uniqueness_of :title
       #   end
       #
-      # @param [ Array ] *args The arguments to pass to the validator.
+      # @param [ Array ] args The arguments to pass to the validator.
+      #
       def validates_uniqueness_of(*args)
         validates_with(UniquenessValidator, _merge_attributes(args))
       end

data/lib/mongoid/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Mongoid
-  VERSION = "6.1.0"
+  VERSION = "6.1.1"
 end

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

@@ -34,8 +34,9 @@ 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.
@@ -121,6 +122,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
 
@@ -132,6 +137,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/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/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/mongoid/contextual/none_spec.rb

@@ -65,6 +65,21 @@ describe Mongoid::Contextual::None do
     end
   end
 
+  describe "#distinct" do
+
+    let!(:band) do
+      Band.create(name: "Depeche Mode")
+    end
+
+    let(:context) do
+      described_class.new(Band.where(name: "Depeche Mode"))
+    end
+
+    it "returns an empty array" do
+      expect(context.distinct(:id)).to eq([])
+    end
+  end
+
   describe "#pluck" do
 
     let!(:band) do

data/spec/mongoid/criteria/queryable/extensions/regexp_raw_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe Mongoid::Criteria::Queryable::Extensions::Regexp::Raw do
+
+  describe ".evolve" do
+
+    context "when provided a bson raw regexp" do
+
+      let(:regexp) do
+        BSON::Regexp::Raw.new("^[123]")
+      end
+
+      let(:evolved) do
+        BSON::Regexp::Raw.evolve(regexp)
+      end
+
+      it "returns the regexp" do
+        expect(evolved).to be(regexp)
+      end
+    end
+
+    context "when providing a string" do
+
+      let(:regexp_string) do
+        '^[123]'
+      end
+
+      let(:evolved) do
+        BSON::Regexp::Raw.evolve(regexp_string)
+      end
+
+      it "returns the converted raw regexp" do
+        expect(evolved).to eq(BSON::Regexp::Raw.new(regexp_string))
+      end
+    end
+
+    context "when provided an array" do
+
+      context "when the elements are bson raw regexps" do
+
+        let(:regexp) do
+          BSON::Regexp::Raw.new("^[123]")
+        end
+
+        let(:array) do
+          [ regexp ]
+        end
+
+        let(:evolved) do
+          BSON::Regexp::Raw.evolve(array)
+        end
+
+        it "returns the array containing raw regexps" do
+          expect(evolved).to eq([ regexp ])
+        end
+
+        it "does not evolve in place" do
+          expect(evolved).to_not equal(array)
+        end
+      end
+
+      context "when the elements are strings" do
+
+        let(:regexp_string) do
+          "^[123]"
+        end
+
+        let(:evolved) do
+          BSON::Regexp::Raw.evolve([ regexp_string ])
+        end
+
+        it "returns the regexps" do
+          expect(evolved).to eq([ BSON::Regexp::Raw.new(regexp_string) ])
+        end
+      end
+    end
+  end
+
+  describe "#regexp?" do
+
+    let(:regexp) do
+      BSON::Regexp::Raw.new('^[123]')
+    end
+
+    it "returns true" do
+      expect(regexp).to be_regexp
+    end
+  end
+end

data/spec/mongoid/criteria/queryable/selectable_spec.rb

@@ -3469,6 +3469,21 @@ describe Mongoid::Criteria::Queryable::Selectable do
             expect(selection.selector).to eq({ "user_id" => document.id })
           end
         end
+
+        context 'when the field is a String and the value is a BSON::Regexp::Raw' do
+
+          let(:raw_regexp) do
+            BSON::Regexp::Raw.new('^Em')
+          end
+
+          let(:selection) do
+            Login.where(_id: raw_regexp)
+          end
+
+          it 'does not convert the bson raw regexp object to a String' do
+            expect(selection.selector).to eq({ "_id" => raw_regexp })
+          end
+        end
       end
     end
 

data/spec/mongoid/criteria_spec.rb

@@ -412,7 +412,7 @@ describe Mongoid::Criteria do
       end
 
       let(:criteria) do
-        Band.where(name: "Depeche Mode").asc(:name).includes(:records)
+        Band.where(name: "Depeche Mode").asc(:name).includes(:records).read(mode: :secondary)
       end
 
       before do
@@ -433,7 +433,7 @@ describe Mongoid::Criteria do
       end
 
       it "contains equal options" do
-        expect(clone.options).to eq({ sort: { "name" => 1 }})
+        expect(clone.options).to eq({ sort: { "name" => 1 }, read: { mode: :secondary } })
       end
 
       it "clones the options" do
@@ -467,6 +467,10 @@ describe Mongoid::Criteria do
       it "sets the context to nil" do
         expect(clone.instance_variable_get(:@context)).to be_nil
       end
+
+      it 'does not convert the option keys to string from symbols' do
+        expect(clone.options[:read][:mode]).to eq(:secondary)
+      end
     end
   end
 

data/spec/mongoid/interceptable_spec.rb

@@ -1152,6 +1152,25 @@ describe Mongoid::Interceptable do
               expect(band.reload.records.first.before_validation_called).to be true
             end
           end
+
+          context 'when the parent is updated' do
+
+            let(:band) do
+              Band.create(name: "Moderat")
+            end
+
+            before do
+              band.update(records: [ { name: 'Black on Both Sides' }])
+            end
+
+            it 'executes the callback' do
+              expect(band.records.first.before_validation_called).to be true
+            end
+
+            it 'persists the change' do
+              expect(band.reload.records.first.before_validation_called).to be true
+            end
+          end
         end
 
         context "when the child is persisted" do

data/spec/mongoid/matchable/all_spec.rb

@@ -6,25 +6,25 @@ describe Mongoid::Matchable::All do
     described_class.new(["first", "second", "third"])
   end
 
-  describe "#matches?" do
+  describe "#_matches?" do
 
     context "when the attribute includes all of the values" do
 
       it "returns true" do
-        expect(matcher.matches?("$all" => ["first", /\Asec.*\z/])).to be true
+        expect(matcher._matches?("$all" => ["first", /\Asec.*\z/])).to be true
       end
     end
 
     context "when the attributes doesn't include all of the values" do
 
       it "returns false" do
-        expect(matcher.matches?("$all" => ["second", "third", "fourth"])).to be false
+        expect(matcher._matches?("$all" => ["second", "third", "fourth"])).to be false
       end
     end
 
     context "when the value is empty" do
       it "returns false" do
-        expect(matcher.matches?("$all" => [])).to be false
+        expect(matcher._matches?("$all" => [])).to be false
       end
     end
   end

data/spec/mongoid/matchable/and_spec.rb

@@ -10,7 +10,7 @@ describe Mongoid::Matchable::And do
     described_class.new("value", person)
   end
 
-  describe "#matches?" do
+  describe "#_matches?" do
 
     context "when provided a simple expression" do
 
@@ -19,7 +19,7 @@ describe Mongoid::Matchable::And do
         context "when the value matches" do
 
           let(:matches) do
-            matcher.matches?([ { title: "Sir" } ])
+            matcher._matches?([ { title: "Sir" } ])
           end
 
           before do
@@ -34,7 +34,7 @@ describe Mongoid::Matchable::And do
         context "when the expression is a $not" do
 
           let(:matches) do
-            matcher.matches?([ { title: {:$not => /Foobar/ } }])
+            matcher._matches?([ { title: {:$not => /Foobar/ } }])
           end
 
           context "when the value matches" do
@@ -59,7 +59,7 @@ describe Mongoid::Matchable::And do
         context "when the value does not match" do
 
           let(:matches) do
-            matcher.matches?([ { title: "Sir" } ])
+            matcher._matches?([ { title: "Sir" } ])
           end
 
           it "returns false" do
@@ -73,7 +73,7 @@ describe Mongoid::Matchable::And do
         context "when all of the values are equal" do
 
           let(:matches) do
-            matcher.matches?(
+            matcher._matches?(
               [ { title: "Sir" }, { _id: person.id } ]
             )
           end
@@ -90,7 +90,7 @@ describe Mongoid::Matchable::And do
         context "when one of the values does not match" do
 
           let(:matches) do
-            matcher.matches?(
+            matcher._matches?(
               [ { title: "Sir" }, { _id: BSON::ObjectId.new } ]
             )
           end
@@ -107,7 +107,7 @@ describe Mongoid::Matchable::And do
         context "when provided no expressions" do
 
           let(:matches) do
-            matcher.matches?([])
+            matcher._matches?([])
           end
 
           it "returns true" do
@@ -122,7 +122,7 @@ describe Mongoid::Matchable::And do
       context "when all of the values are equal" do
 
         let(:matches) do
-          matcher.matches?(
+          matcher._matches?(
             [
               { title: { "$in" => [ "Sir", "Madam" ] } },
               { _id: person.id }
@@ -142,7 +142,7 @@ describe Mongoid::Matchable::And do
       context "when one of the values does not match" do
 
         let(:matches) do
-          matcher.matches?(
+          matcher._matches?(
             [
               { title: { "$in" => [ "Prince", "Madam" ] } },
               { _id: BSON::ObjectId.new }
@@ -164,7 +164,7 @@ describe Mongoid::Matchable::And do
         context "when all the expressions match" do
 
           let(:matches) do
-            matcher.matches?(
+            matcher._matches?(
               [
                 { title: "Sir", age: 23 },
                 { _id: person.id }