mongoid 6.4.0 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 496715e8829978d85bd903477e9d6d7961fa4ffe8d9529d6720fbfdb2b3ec9a8
-  data.tar.gz: 907296ce5256555834c738f5fdf8d7277b57d6c09da3c733eb7cb0ba6526d0a2
+SHA1:
+  metadata.gz: 4f048aa8781f60c32235fe9d3daee1cfa17e7e58
+  data.tar.gz: 1fdca10737525f1272fbcde4273452c9d0ea116c
 SHA512:
-  metadata.gz: 9d16c8cff475066981b0736ed07ebe0b463c8ee4e8c43049087f43ad8ee6789ff88a5c2e73e3fe6a31a52f7732cc6b8614de72d8c76df2dd3c54ee48a5977a41
-  data.tar.gz: d15deebe3406b501b95fa864306c03cfa7b106f810909dffeda8d7402d14de5aa1dad3d1129685b859ef9d537e656108a015b77f066ea5affd9e32785e018b0a
+  metadata.gz: 191be89fce8a8d7437070a526b68ab6cd9622235d40ac8d01d22dfc477914bc4eec23a28056fde69c2a5651c36a9d2bfea84765d3dbf1f7b6367de941aa73778
+  data.tar.gz: 4e6371d1ae1d2fac3ff3c16d0283ac04132a9d09c83d390e8c3ae714a62ed833897f29d6ff0f2b1de9b6ae90b1019b0ae72d68752584792fbe62536db3a2e54a

data/lib/mongoid/clients/sessions.rb

@@ -53,7 +53,7 @@ module Mongoid
 
       private
 
-      def session
+      def _session
         Threaded.get_session
       end
 
@@ -104,7 +104,7 @@ module Mongoid
 
         private
 
-        def session
+        def _session
           Threaded.get_session
         end
       end

data/lib/mongoid/contextual/aggregable/mongo.rb

@@ -23,7 +23,7 @@ module Mongoid
         #
         # @since 3.0.0
         def aggregates(field)
-          result = collection.find.aggregate(pipeline(field), session: session).to_a
+          result = collection.find.aggregate(pipeline(field), session: _session).to_a
           if result.empty?
             { "count" => 0, "sum" => nil, "avg" => nil, "min" => nil, "max" => nil }
           else

data/lib/mongoid/contextual/map_reduce.rb

@@ -166,7 +166,7 @@ module Mongoid
         validate_out!
         cmd = command
         opts = { read: cmd.delete(:read).options } if cmd[:read]
-        @map_reduce.database.command(cmd, (opts || {}).merge(session: session)).first
+        @map_reduce.database.command(cmd, (opts || {}).merge(session: _session)).first
       end
       alias :results :raw
 
@@ -250,8 +250,8 @@ module Mongoid
         raise Errors::NoMapReduceOutput.new({}) unless @map_reduce.out
       end
 
-      def session
-        criteria.send(:session)
+      def _session
+        criteria.send(:_session)
       end
     end
   end

data/lib/mongoid/contextual/memory.rb

@@ -49,7 +49,7 @@ module Mongoid
         unless removed.empty?
           collection.find(selector).update_one(
             positionally(selector, "$pullAll" => { path => removed }),
-            session: session
+            session: _session
           )
         end
         deleted
@@ -304,7 +304,7 @@ module Mongoid
           updates["$set"].merge!(doc.atomic_updates["$set"] || {})
           doc.move_changes
         end
-        collection.find(selector).update_one(updates, session: session) unless updates["$set"].empty?
+        collection.find(selector).update_one(updates, session: _session) unless updates["$set"].empty?
       end
 
       # Get the limiting value.
@@ -446,8 +446,8 @@ module Mongoid
         doc.destroyed = true
       end
 
-      def session
-        @criteria.send(:session)
+      def _session
+        @criteria.send(:_session)
       end
     end
   end

data/lib/mongoid/contextual/mongo.rb

@@ -341,7 +341,7 @@ module Mongoid
         @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
         @collection = @klass.collection
         criteria.send(:merge_type_selection)
-        @view = collection.find(criteria.selector, session: session)
+        @view = collection.find(criteria.selector, session: _session)
         apply_options
       end
 
@@ -706,8 +706,8 @@ module Mongoid
         documents.push(doc) if cacheable?
       end
 
-      def session
-        @criteria.send(:session)
+      def _session
+        @criteria.send(:_session)
       end
 
       def acknowledged_write?

data/lib/mongoid/indexable.rb

@@ -32,10 +32,10 @@ module Mongoid
           key, options = spec.key, spec.options
           if database = options[:database]
             with(database: database) do |klass|
-              klass.collection.indexes(session: session).create_one(key, options.except(:database))
+              klass.collection.indexes(session: _session).create_one(key, options.except(:database))
             end
           else
-            collection.indexes(session: session).create_one(key, options)
+            collection.indexes(session: _session).create_one(key, options)
           end
         end and true
       end
@@ -53,9 +53,9 @@ module Mongoid
         indexed_database_names.each do |database|
           with(database: database) do |klass|
             begin
-              klass.collection.indexes(session: session).each do |spec|
+              klass.collection.indexes(session: _session).each do |spec|
                 unless spec["name"] == "_id_"
-                  klass.collection.indexes(session: session).drop_one(spec["key"])
+                  klass.collection.indexes(session: _session).drop_one(spec["key"])
                   logger.info(
                     "MONGOID: Removed index '#{spec["name"]}' on collection " +
                     "'#{klass.collection.name}' in database '#{database}'."

data/lib/mongoid/persistable.rb

@@ -204,7 +204,7 @@ module Mongoid
     def persist_atomic_operations(operations)
       if persisted? && operations
         selector = atomic_selector
-        _root.collection.find(selector).update_one(positionally(selector, operations), session: session)
+        _root.collection.find(selector).update_one(positionally(selector, operations), session: _session)
       end
     end
   end

data/lib/mongoid/persistable/creatable.rb

@@ -63,7 +63,7 @@ module Mongoid
           selector = _parent.atomic_selector
           _root.collection.find(selector).update_one(
               positionally(selector, atomic_inserts),
-              session: session)
+              session: _session)
         end
       end
 
@@ -78,7 +78,7 @@ module Mongoid
       #
       # @since 4.0.0
       def insert_as_root
-        collection.insert_one(as_attributes, session: session)
+        collection.insert_one(as_attributes, session: _session)
       end
 
       # Post process an insert, which sets the new record attribute to false

data/lib/mongoid/persistable/deletable.rb

@@ -64,7 +64,7 @@ module Mongoid
           selector = _parent.atomic_selector
           _root.collection.find(selector).update_one(
               positionally(selector, atomic_deletes),
-              session: session)
+              session: _session)
         end
         true
       end
@@ -80,7 +80,7 @@ module Mongoid
       #
       # @since 4.0.0
       def delete_as_root
-        collection.find(atomic_selector).delete_one(session: session)
+        collection.find(atomic_selector).delete_one(session: _session)
         true
       end
 

data/lib/mongoid/persistable/settable.rb

@@ -26,7 +26,7 @@ module Mongoid
             field_and_value_hash = hasherizer(field.split('.'), value)
             field = field_and_value_hash.keys.first.to_s
 
-            if fields[field] && fields[field].type == Hash && attributes.key?(field)
+            if fields[field] && fields[field].type == Hash && attributes.key?(field) && !value.empty?
               merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
               value = (attributes[field] || {}).merge(field_and_value_hash[field], &merger)
               process_attribute(field.to_s, value)

data/lib/mongoid/persistable/updatable.rb

@@ -134,9 +134,9 @@ module Mongoid
           unless updates.empty?
             coll = collection(_root)
             selector = atomic_selector
-            coll.find(selector).update_one(positionally(selector, updates), session: session)
+            coll.find(selector).update_one(positionally(selector, updates), session: _session)
             conflicts.each_pair do |key, value|
-              coll.find(selector).update_one(positionally(selector, { key => value }), session: session)
+              coll.find(selector).update_one(positionally(selector, { key => value }), session: _session)
             end
           end
         end

data/lib/mongoid/persistable/upsertable.rb

@@ -22,7 +22,7 @@ module Mongoid
       def upsert(options = {})
         prepare_upsert(options) do
           collection.find(atomic_selector).update_one(
-              as_attributes, upsert: true, session: session)
+              as_attributes, upsert: true, session: _session)
         end
       end
 

data/lib/mongoid/relations/embedded/batchable.rb

@@ -39,7 +39,7 @@ module Mongoid
           unless docs.empty?
             collection.find(selector).update_one(
               positionally(selector, "$unset" => { path => true }),
-              session: session
+              session: _session
             )
             post_process_batch_remove(docs, :delete)
           end
@@ -60,7 +60,7 @@ module Mongoid
           if !docs.empty?
             collection.find(selector).update_one(
               positionally(selector, "$pullAll" => { path => removals }),
-              session: session
+              session: _session
             )
             post_process_batch_remove(docs, method)
           end
@@ -136,7 +136,7 @@ module Mongoid
           if insertable?
             collection.find(selector).update_one(
                 positionally(selector, '$set' => { path => inserts }),
-                session: session
+                session: _session
             )
             post_process_batch_insert(docs)
           end
@@ -161,7 +161,7 @@ module Mongoid
           if insertable?
             collection.find(selector).update_one(
                 positionally(selector, '$push' => { path => { '$each' => pushes } }),
-                session: session
+                session: _session
             )
             post_process_batch_insert(docs)
           end

data/lib/mongoid/relations/embedded/many.rb

@@ -294,6 +294,29 @@ module Mongoid
           end
         end
 
+        # Shift documents off the relation. This can be a single document or
+        # multiples, and will automatically persist the changes.
+        #
+        # @example Shift a single document.
+        #   relation.shift
+        #
+        # @example Shift multiple documents.
+        #   relation.shift(3)
+        #
+        # @param [ Integer ] count The number of documents to shift, or 1 if not
+        #   provided.
+        #
+        # @return [ Document, Array<Document> ] The shifted document(s).
+        def shift(count = nil)
+          if count
+            if target.size > 0 && docs = target[0, count]
+              docs.each { |doc| delete(doc) }
+            end
+          else
+            delete(target[0])
+          end
+        end
+
         # Substitutes the supplied target documents for the existing documents
         # in the relation.
         #

data/lib/mongoid/relations/many.rb

@@ -213,8 +213,8 @@ module Mongoid
 
       private
 
-      def session
-        base.send(:session)
+      def _session
+        base.send(:_session)
       end
 
       # Find the first object given the supplied attributes or create/initialize it.

data/lib/mongoid/relations/referenced/many.rb

@@ -477,7 +477,7 @@ module Mongoid
         # @since 3.0.0
         def persist_delayed(docs, inserts)
           unless docs.empty?
-            collection.insert_many(inserts, session: session)
+            collection.insert_many(inserts, session: _session)
             docs.each do |doc|
               doc.new_record = false
               doc.run_after_callbacks(:create, :save)

data/lib/mongoid/relations/touchable.rb

@@ -31,7 +31,7 @@ module Mongoid
         touches = touch_atomic_updates(field)
         unless touches["$set"].blank?
           selector = atomic_selector
-          _root.collection.find(selector).update_one(positionally(selector, touches), session: session)
+          _root.collection.find(selector).update_one(positionally(selector, touches), session: _session)
         end
         run_callbacks(:touch)
         true

data/lib/mongoid/reloadable.rb

@@ -58,7 +58,7 @@ module Mongoid
     #
     # @since 2.3.2
     def reload_root_document
-      {}.merge(collection.find({ _id: _id }, session: session).read(mode: :primary).first || {})
+      {}.merge(collection.find({ _id: _id }, session: _session).read(mode: :primary).first || {})
     end
 
     # Reload the embedded document.

data/lib/mongoid/tasks/database.rb

@@ -44,7 +44,7 @@ module Mongoid
         models.each do |model|
           unless model.embedded?
             begin
-              model.collection.indexes(session: model.send(:session)).each do |index|
+              model.collection.indexes(session: model.send(:_session)).each do |index|
                 # ignore default index
                 unless index['name'] == '_id_'
                   key = index['key'].symbolize_keys
@@ -77,7 +77,7 @@ module Mongoid
           indexes.each do |index|
             key = index['key'].symbolize_keys
             collection = model.collection
-            collection.indexes(session: model.send(:session)).drop_one(key)
+            collection.indexes(session: model.send(:_session)).drop_one(key)
             logger.info(
               "MONGOID: Removed index '#{index['name']}' on collection " +
               "'#{collection.name}' in database '#{collection.database.name}'."

data/lib/mongoid/version.rb

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

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

@@ -11,6 +11,10 @@ development:
       hosts:
         - localhost:27017
       options:
+        # Note that all options listed below are Ruby driver client options (the mongo gem).
+        # Please refer to the driver documentation of the version of the mongo gem you are using
+        # for the most up-to-date list of options.
+        #
         # Change the default write concern. (default = { w: 1 })
         # write:
         #   w: 1

data/spec/mongoid/persistable/settable_spec.rb

@@ -278,7 +278,22 @@ describe Mongoid::Persistable::Settable do
       end
     end
 
-    context 'when the field is a bested hash' do
+    context 'when the field is a nested hash' do
+
+      context 'when the field is reset to an empty hash' do
+
+        before do
+          church.set('location' => {})
+        end
+
+        it 'updates the field locally' do
+          expect(church.location).to eq({})
+        end
+
+        it 'updates the field in the database' do
+          expect(church.reload.location).to eq({})
+        end
+      end
 
       context 'when a leaf value in the nested hash is updated' do
 

data/spec/mongoid/relations/embedded/many_spec.rb

@@ -2583,6 +2583,25 @@ describe Mongoid::Relations::Embedded::Many do
         person.addresses.create(street: "hermannstr")
       end
 
+      context "when the number is zero" do
+
+        let!(:popped) do
+          person.addresses.pop(0)
+        end
+
+        it "returns an empty array" do
+          expect(popped).to eq([])
+        end
+
+        it "does not remove the document from the relation" do
+          expect(person.addresses).to eq([ address_one, address_two ])
+        end
+
+        it "does not persist the pop" do
+          expect(person.reload.addresses).to eq([ address_one, address_two ])
+        end
+      end
+
       context "when the number is not larger than the relation" do
 
         let!(:popped) do
@@ -2640,6 +2659,125 @@ describe Mongoid::Relations::Embedded::Many do
     end
   end
 
+  describe "#shift" do
+
+    let(:person) do
+      Person.create
+    end
+
+    context "when no argument is provided" do
+
+      let!(:address_one) do
+        person.addresses.create(street: "sonnenallee")
+      end
+
+      let!(:address_two) do
+        person.addresses.create(street: "hermannstr")
+      end
+
+      let!(:shifted) do
+        person.addresses.shift
+      end
+
+      it "returns the shifted document" do
+        expect(shifted).to eq(address_one)
+      end
+
+      it "removes the document from the relation" do
+        expect(person.addresses).to eq([ address_two ])
+      end
+
+      it "persists the shift" do
+        expect(person.reload.addresses).to eq([ address_two ])
+      end
+    end
+
+    context "when an integer is provided" do
+
+      let!(:address_one) do
+        person.addresses.create(street: "sonnenallee")
+      end
+
+      let!(:address_two) do
+        person.addresses.create(street: "hermannstr")
+      end
+
+      context "when the number is zero" do
+
+        let!(:shifted) do
+          person.addresses.shift(0)
+        end
+
+        it "returns an empty array" do
+          expect(shifted).to eq([])
+        end
+
+        it "does not remove the document from the relation" do
+          expect(person.addresses).to eq([ address_one, address_two ])
+        end
+
+        it "does not persist the shift" do
+          expect(person.reload.addresses).to eq([ address_one, address_two ])
+        end
+      end
+
+      context "when the number is not larger than the relation" do
+
+        let!(:shifted) do
+          person.addresses.shift(2)
+        end
+
+        it "returns the shifted documents" do
+          expect(shifted).to eq([ address_one, address_two ])
+        end
+
+        it "removes the document from the relation" do
+          expect(person.addresses).to be_empty
+        end
+
+        it "persists the shift" do
+          expect(person.reload.addresses).to be_empty
+        end
+      end
+
+      context "when the number is larger than the relation" do
+
+        let!(:shifted) do
+          person.addresses.shift(4)
+        end
+
+        it "returns the shifted documents" do
+          expect(shifted).to eq([ address_one, address_two ])
+        end
+
+        it "removes the document from the relation" do
+          expect(person.addresses).to be_empty
+        end
+
+        it "persists the shift" do
+          expect(person.reload.addresses).to be_empty
+        end
+      end
+    end
+
+    context "when the relation is empty" do
+
+      context "when providing no number" do
+
+        it "returns nil" do
+          expect(person.addresses.shift).to be_nil
+        end
+      end
+
+      context "when providing a number" do
+
+        it "returns nil" do
+          expect(person.addresses.shift(2)).to be_nil
+        end
+      end
+    end
+  end
+
   describe "#scoped" do
 
     let(:person) do
@@ -3846,7 +3984,7 @@ describe Mongoid::Relations::Embedded::Many do
     end
   end
 
-  context "#delete or #clear with before_remove callback" do
+  context "#delete, or #clear, or #pop, or #shift with before_remove callback" do
 
     let(:artist) do
       Artist.new
@@ -3892,35 +4030,81 @@ describe Mongoid::Relations::Embedded::Many do
         end
       end
 
-      context "when errors are raised" do
+      describe "#pop" do
 
         before do
-          expect(artist).to receive(:before_remove_song).and_raise
+          artist.songs.pop
         end
 
-        describe "#delete" do
+        it "executes the callback" do
+          artist.songs.pop
+          expect(artist.before_remove_embedded_called).to be true
+        end
+      end
 
-          it "does not remove the document from the relation" do
-            begin; artist.songs.delete(song); rescue; end
-            expect(artist.songs).to eq([ song ])
-          end
+      describe "#shift" do
+
+        before do
+          artist.songs.shift
         end
 
-        describe "#clear" do
+        it "executes the callback" do
+          artist.songs.shift
+          expect(artist.before_remove_embedded_called).to be true
+        end
+      end
+    end
 
-          before do
-            begin; artist.songs.clear; rescue; end
-          end
+    context "when errors are raised" do
 
-          it "removes the documents from the relation" do
-            expect(artist.songs).to eq([ song ])
-          end
+      before do
+        expect(artist).to receive(:before_remove_song).and_raise
+      end
+
+      describe "#delete" do
+
+        it "does not remove the document from the relation" do
+          begin; artist.songs.delete(song); rescue; end
+          expect(artist.songs).to eq([ song ])
+        end
+      end
+
+      describe "#clear" do
+
+        before do
+          begin; artist.songs.clear; rescue; end
+        end
+
+        it "removes the documents from the relation" do
+          expect(artist.songs).to eq([ song ])
+        end
+      end
+
+      describe "#pop" do
+
+        before do
+          begin; artist.songs.pop; rescue; end
+        end
+
+        it "should remove from collection" do
+          expect(artist.songs).to eq([ song ])
+        end
+      end
+
+      describe "#shift" do
+
+        before do
+          begin; artist.songs.shift; rescue; end
+        end
+
+        it "should remove from collection" do
+          expect(artist.songs).to eq([ song ])
         end
       end
     end
   end
 
-  context "#delete or #clear with after_remove callback" do
+  context "#delete, or #clear, or #pop, or #shift with after_remove callback" do
 
     let(:artist) do
       Artist.new
@@ -3957,6 +4141,30 @@ describe Mongoid::Relations::Embedded::Many do
           expect(artist.after_remove_embedded_called).to be true
         end
       end
+
+      describe "#pop" do
+
+        before do
+          artist.labels.pop
+        end
+
+        it "executes the callback" do
+          artist.labels.pop
+          expect(artist.after_remove_embedded_called).to be true
+        end
+      end
+
+      describe "#shift" do
+
+        before do
+          artist.labels.shift
+        end
+
+        it "executes the callback" do
+          artist.labels.shift
+          expect(artist.after_remove_embedded_called).to be true
+        end
+      end
     end
 
     context "when errors are raised" do
@@ -3986,6 +4194,28 @@ describe Mongoid::Relations::Embedded::Many do
           expect(artist.labels).to be_empty
         end
       end
+
+      describe "#pop" do
+
+        before do
+          begin; artist.labels.pop; rescue; end
+        end
+
+        it "should remove from collection" do
+          expect(artist.labels).to be_empty
+        end
+      end
+
+      describe "#shift" do
+
+        before do
+          begin; artist.labels.shift; rescue; end
+        end
+
+        it "should remove from collection" do
+          expect(artist.labels).to be_empty
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.4.1
 platform: ruby
 authors:
 - Durran Jordan
@@ -30,7 +30,7 @@ cert_chain:
   fxN/GvhskJEgmdQToxEBRLOu5/udtPpVe/hb3gk5hzsxcWuKN/VTi4SbtFQdz9cq
   fqd6ctFDOqcJmOYdlSRgb9g8zm4BiNgFWPBSk8NsP7c=
   -----END CERTIFICATE-----
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -872,7 +872,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: mongoid
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Elegant Persistence in Ruby for MongoDB.