MONGOID-5227 Add test and adjust docs for dotted attribute assignment in default scope (#5474)

* MONGOID-5227 Add test and adjust docs for dotted attribute assignment in default scope

* MONGOID-5227 adjust docs

* MONGOID-5227 clarify the docs and add tests

* Update docs/reference/queries.txt

Co-authored-by: Oleg Pudeyev <[email protected]>

Co-authored-by: Oleg Pudeyev <[email protected]>

Author: neilshweky

docs/reference/queries.txt

@@ -1887,8 +1887,8 @@ in the default scope, the value in the default scope takes precedence:
   Band.new # => #<Band _id: 5c3f74ddce4ef3791abbb088, name: nil, active: false>
 
 Because a default scope initializes fields in new models as just described,
-defining a default scope with a dotted key and a simple literal value is
-not possible:
+defining a default scope with a dotted key and a simple literal value, while
+possible, is not recommended:
 
 .. code-block:: ruby
 
@@ -1900,7 +1900,36 @@ not possible:
     default_scope ->{ where('tags.foo' => 'bar') }
   end
 
-  Band.create! # exception: BSON::String::IllegalKey ('tags.foo' is an illegal key in MongoDB. Keys may not start with '$' or contain a '.'.)
+  Band.create!
+  # => Created document: {"_id"=>BSON::ObjectId('632de48f3282a404bee1877b'), "tags.foo"=>"bar"}
+  Band.create!(tags: { 'foo' => 'bar' })
+  # => Created document: {"_id"=>BSON::ObjectId('632de4ad3282a404bee1877c'), "tags.foo"=>"bar", "tags"=>{"foo"=>"bar"}}
+  Band.all.to_a
+  # => [ #<Band _id: 632de4ad3282a404bee1877c, tags: {"foo"=>"bar"}> ]
+
+Mongoid 8 allows dotted keys to be used in Mongoid, and when creating a document,
+the scope is added as a dotted key in the attributes:
+
+.. code-block:: ruby
+
+  Band.new.attribute
+  # => {"_id"=>BSON::ObjectId('632de97d3282a404bee1877d'), "tags.foo"=>"bar"}
+
+Whereas when querying, Mongoid looks for an embedded document:
+
+.. code-block:: ruby
+
+  Band.create!
+  # => Created document: {"_id"=>BSON::ObjectId('632de48f3282a404bee1877b'), "tags.foo"=>"bar"}
+  Band.where
+  # => #<Mongoid::Criteria
+         selector: {"tags.foo"=>"bar"}
+         options:  {}
+         class:    Band
+         embedded: false>
+  # This looks for something like: { tags: { "foo" => "bar" } }
+  Band.count
+  # => 0
 
 A workaround is to define the default scope as a complex query:
 
@@ -1914,9 +1943,11 @@ A workaround is to define the default scope as a complex query:
     default_scope ->{ where('tags.foo' => {'$eq' => 'bar'}) }
   end
 
-  Band.create!(tags: {hello: 'world'})
-  Band.create!(tags: {foo: 'bar'})
-  Band.count # => 1
+  Band.create!(tags: { hello: 'world' })
+  Band.create!(tags: { foo: 'bar' })
+  # does not add a "tags.foo" dotted attribute
+  Band.count
+  # => 1
 
 You can tell Mongoid not to apply the default scope by using
 ``unscoped``, which can be inline or take a block.

spec/mongoid/scopable_spec.rb

@@ -121,6 +121,76 @@
         expect(selector).to eq({'active' => true})
       end
     end
+
+    context "when the default scope is dotted" do
+
+      let(:criteria) do
+        Band.where('tags.foo' => 'bar')
+      end
+
+      before do
+        Band.default_scope ->{ criteria }
+      end
+
+      after do
+        Band.default_scoping = nil
+      end
+
+      let!(:band) do
+        Band.create!
+      end
+
+      it "adds the scope as a dotted key attribute" do
+        expect(band.attributes['tags.foo']).to eq('bar')
+      end
+
+      it "adds the default scope to the class" do
+        expect(Band.default_scoping.call).to eq(criteria)
+      end
+
+      it "flags as being default scoped" do
+        expect(Band).to be_default_scoping
+      end
+
+      it "does not find the correct document" do
+        expect(Band.count).to eq(0)
+      end
+    end
+
+    context "when the default scope is dotted with a query" do
+
+      let(:criteria) do
+        Band.where('tags.foo' => {'$eq' => 'bar'})
+      end
+
+      before do
+        Band.default_scope ->{ criteria }
+      end
+
+      after do
+        Band.default_scoping = nil
+      end
+
+      let!(:band) do
+        Band.create!('tags' => { 'foo' => 'bar' })
+      end
+
+      it "does not add the scope as a dotted key attribute" do
+        expect(band.attributes).to_not have_key('tags.foo')
+      end
+
+      it "adds the default scope to the class" do
+        expect(Band.default_scoping.call).to eq(criteria)
+      end
+
+      it "flags as being default scoped" do
+        expect(Band).to be_default_scoping
+      end
+
+      it "finds the correct document" do
+        expect(Band.where.first).to eq(band)
+      end
+    end
   end
 
   describe ".default_scopable?" do

spec/support/models/band.rb

@@ -21,6 +21,7 @@ class Band
   field :founded, type: Date
   field :deleted, type: Boolean
   field :mojo, type: Object
+  field :tags, type: Hash
   field :fans
 
   embeds_many :records, cascade_callbacks: true