mongoid 7.0.4 → 7.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ae228df96e11fe59977a8d1af1bb0e86597fe5ee31d8cbe257a077d6e87d4f
-  data.tar.gz: b8face8e682359ca47c26c0dc168ab1a99762769176fd2f8796ae472a341cd76
+  metadata.gz: 1d4a5f733ce016f190a456b5801a1e3a1efbe89a30d99a20cd4c73e5696e7004
+  data.tar.gz: a40c8e747c7eeff97d8259bd6b11d35bf25de5434674c24f1c5ebe71ed5d6f3e
 SHA512:
-  metadata.gz: 1aafc53e49a0576a7bfb081bca208629ba7323c1a52468e0279644b0b9c2a9d4015c63d35cdf1f16b0967056ed976d015638fab512bce7a221acfeda75c867ed
-  data.tar.gz: 0c3e7557c424ccd5a95d3e5c4249e4a45a31f74577be2ba7cfac70d67d3226cd00b0b655e7f9d576086a0fc18c7b9d7bf37c57e8a06fb07131a3bec99e85fe8a
+  metadata.gz: 121ace21edf0fec13546294a101b4bb383eed7d7b7ead0d6bd3624ccfad5601a70a9e4b0363e710e687ba237835ea4a61da8d17ebab00a2537751a7fcbf5410f
+  data.tar.gz: d39854dd3981a7c517e6ba00c0d85feb1e9bb6e928dabf233f603bf35f8299706c0981ed3cb9ba3c121e2af58ae42bc0e0e876a3a45f0264ac344d48469e9401

data/Rakefile

@@ -33,3 +33,15 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
 end
 
 task :default => :spec
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('yard-docs', Mongoid::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title mongoid-#{Mongoid::VERSION}"
+  end
+end

data/lib/mongoid/atomic/paths/embedded.rb

@@ -20,7 +20,7 @@ module Mongoid
         #
         # @since 2.1.0
         def path
-          @path ||= position.sub(/\.\d+$/, "")
+          @path ||= position.sub(/\.\d+\z/, "")
         end
       end
     end

data/lib/mongoid/criteria/modifiable.rb

@@ -3,6 +3,10 @@ module Mongoid
   class Criteria
     module Modifiable
 
+      # @attribute [r] create_attrs Additional attributes to add to the Document upon creation.
+      # @api private
+      attr_reader :create_attrs
+
       # Build a document given the selector and return it.
       # Complex criteria, such as $in and $or operations will get ignored.
       #
@@ -57,6 +61,9 @@ module Mongoid
 
       # Define attributes with which new documents will be created.
       #
+      # Note that if `find_or_create_by` is called after this in a method chain, the attributes in
+      # the query will override those from this method.
+      #
       # @example Define attributes to be used when a new document is created.
       #   Person.create_with(job: 'Engineer').find_or_create_by(employer: 'MongoDB')
       #
@@ -64,7 +71,9 @@ module Mongoid
       #
       # @since 5.1.0
       def create_with(attrs = {})
-        where(selector.merge(attrs))
+        tap do
+          (@create_attrs ||= {}).merge!(attrs)
+        end
       end
 
       # Find the first +Document+ given the conditions, or creates a new document
@@ -172,7 +181,8 @@ module Mongoid
       #
       # @since 3.0.0
       def create_document(method, attrs = nil, &block)
-        attributes = selector.reduce(attrs ? attrs.dup : {}) do |hash, (key, value)|
+        attrs = (create_attrs || {}).merge(attrs || {})
+        attributes = selector.reduce(attrs) do |hash, (key, value)|
           unless invalid_key?(hash, key) || invalid_embedded_doc?(value)
             hash[key] = value
           end

data/lib/mongoid/criteria/queryable/key.rb

@@ -3,16 +3,75 @@ module Mongoid
   class Criteria
     module Queryable
 
-      # The key is a representation of a field in a queryable, that can be
-      # expanded to special MongoDB selectors.
+      # Key objects represent specifications for building query expressions
+      # utilizing MongoDB selectors.
+      #
+      # Simple key-value conditions are translated directly into expression
+      # hashes by Mongoid without utilizing Key objects. For example, the
+      # following condition:
+      #
+      #   Foo.where(price: 1)
+      #
+      # ... is translated to the following simple expression:
+      #
+      #   {price: 1}
+      #
+      # More complex conditions would start involving Key objects. For example:
+      #
+      #   Foo.where(:price.gt => 1)
+      #
+      # ... causes a Key instance to be created thusly:
+      #
+      #   Key.new(:price, :__override__, '$gt')
+      #
+      # This Key instance utilizes +operator+ but not +expanded+ nor +block+.
+      # The corresponding MongoDB query expression is:
+      #
+      #    {price: {'$gt' => 1}}
+      #
+      # A yet more more complex example is the following condition:
+      #
+      #   Foo.geo_spacial(:boundary.intersects_point => [1, 10])
+      #
+      # Processing this condition will cause a Key instance to be created as
+      # follows:
+      #
+      #   Key.new(:location, :__override__, '$geoIntersects', '$geometry') do |value|
+      #     { "type" => POINT, "coordinates" => value }
+      #   end
+      #
+      # ... eventually producing the following MongoDB query expression:
+      #
+      # {
+      #   boundary: {
+      #     '$geoIntersects' => {
+      #       '$geometry' => {
+      #         type: "Point" ,
+      #         coordinates: [ 1, 10 ]
+      #       }
+      #     }
+      #   }
+      # }
+      #
+      # Key instances can be thought of as procs that map a value to the
+      # MongoDB query expression required to obtain the key's condition,
+      # given the value.
       class Key
 
-        # @attribute [r] name The name of the field.
-        # @attribute [r] block The optional block to transform values.
-        # @attribute [r] operator The MongoDB query operator.
-        # @attribute [r] expanded The MongoDB expanded query operator.
-        # @attribute [r] strategy The name of the merge strategy.
-        attr_reader :block, :name, :operator, :expanded, :strategy
+        # @return [ String | Symbol ] The name of the field.
+        attr_reader :name
+
+        # @return [ String ] The MongoDB query operator.
+        attr_reader :operator
+
+        # @return [ String ] The MongoDB expanded query operator.
+        attr_reader :expanded
+
+        # @return [ Symbol ] The name of the merge strategy.
+        attr_reader :strategy
+
+        # @return [ Proc ] The optional block to transform values.
+        attr_reader :block
 
         # Does the key equal another object?
         #

data/lib/mongoid/criteria/queryable/selectable.rb

@@ -24,7 +24,7 @@ module Mongoid
         # @since 2.0.0
         POLYGON = "Polygon"
 
-        # @attribute [rw] negating If the next spression is negated.
+        # @attribute [rw] negating If the next expression is negated.
         # @attribute [rw] selector The query selector.
         attr_accessor :negating, :selector
 

data/lib/mongoid/criteria/queryable/selector.rb

@@ -21,9 +21,10 @@ module Mongoid
           other.each_pair do |key, value|
             if value.is_a?(Hash) && self[key.to_s].is_a?(Hash)
               value = self[key.to_s].merge(value) do |_key, old_val, new_val|
-                if in?(_key)
+                case _key
+                when '$in'
                   new_val & old_val
-                elsif nin?(_key)
+                when '$nin'
                   (old_val + new_val).uniq
                 else
                   new_val
@@ -52,10 +53,13 @@ module Mongoid
         def store(key, value)
           name, serializer = storage_pair(key)
           if multi_selection?(name)
-            super(name, evolve_multi(value))
+            store_name = name
+            store_value = evolve_multi(value)
           else
-            super(localized_key(name, serializer), evolve(serializer, value))
+            store_name = localized_key(name, serializer)
+            store_value = evolve(serializer, value)
           end
+          super(store_name, store_value)
         end
         alias :[]= :store
 
@@ -178,33 +182,7 @@ module Mongoid
         #
         # @since 1.0.0
         def multi_selection?(key)
-          key =~ /\$and|\$or|\$nor/
-        end
-
-        # Determines if the selection operator takes a list. Returns true for $in and $nin.
-        #
-        # @api private
-        #
-        # @example Does the selection operator take multiple values?
-        #   selector.multi_value?("$nin")
-        #
-        # @param [ String ] key The key to check.
-        #
-        # @return [ true, false ] If the key is $in or $nin.
-        #
-        # @since 2.1.1
-        def multi_value?(key)
-          key =~ /\$nin|\$in/
-        end
-
-        private
-
-        def in?(key)
-          key =~ /\$in/
-        end
-
-        def nin?(key)
-          key =~ /\$nin/
+          %w($and $or $nor).include?(key)
         end
       end
     end

data/lib/mongoid/extensions/string.rb

@@ -69,7 +69,7 @@ module Mongoid
       #
       # @since 2.3.1
       def mongoid_id?
-        self =~ /\A(|_)id$/
+        self =~ /\A(|_)id\z/
       end
 
       # Is the string a number? The literals "NaN", "Infinity", and "-Infinity"
@@ -96,7 +96,7 @@ module Mongoid
       #
       # @since 1.0.0
       def reader
-        delete("=").sub(/\_before\_type\_cast$/, '')
+        delete("=").sub(/\_before\_type\_cast\z/, '')
       end
 
       # Is this string a writer?

data/lib/mongoid/positional.rb

@@ -64,7 +64,7 @@ module Mongoid
       matches = position.scan(/\.\d+\./)
       if matches.size == 1
         keys.each do |kk|
-          if position =~ /^#{kk}\.\d+\.(.*)/
+          if position =~ /\A#{kk}\.\d+\.(.*)\z/
             return "#{kk}.$.#{$1}"
           end
         end

data/lib/mongoid/query_cache.rb

@@ -258,7 +258,7 @@ module Mongoid
       end
 
       def system_collection?
-        collection.namespace =~ /^system./
+        collection.namespace =~ /\Asystem./
       end
     end
 

data/lib/mongoid/validatable/macros.rb

@@ -48,7 +48,7 @@ module Mongoid
       #     include Mongoid::Document
       #     field :title
       #
-      #     validates_format_of :title, with: /^[a-z0-9 \-_]*$/i
+      #     validates_format_of :title, with: /\A[a-z0-9 \-_]*\z/i
       #   end
       #
       # @param [ Array ] args The names of the fields to validate.

data/lib/mongoid/version.rb

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

data/spec/README.md

@@ -0,0 +1,18 @@
+# Running Mongoid Tests
+
+## Overview
+### Quick Start
+Spin up a MongoDB deployment against which to run the Mongoid specs. Mongoid specs support a variety of MongoDB topologies, but the simplest is a single MongoDB instance:
+
+    # Launch mongod in one terminal
+    mkdir /tmp/mdb
+    mongod --dbpath /tmp/mdb
+
+Run the test suite in a separate terminal:
+
+    rake
+
+
+## Caveats
+### "Too many open files" error
+On MacOS, you may encounter a "Too many open files" error on the MongoDB server when running the tests. If this happens, stop the server, run the command `ulimit -n 10000` in the same terminal session as the server, and restart the server. This will increase the number of files that can be opened. Then, re-run the tests.

data/spec/mongoid/clients/factory_spec.rb

@@ -132,8 +132,8 @@ describe Mongoid::Clients::Factory do
 
             let(:config) do
               {
-                default: { hosts: [ "127.0.0.1:1234" ], database: database_id },
-                secondary: { uri: "mongodb://127.0.0.1:1234,127.0.0.1:5678/mongoid_test" }
+                default: { hosts: [ "127.0.0.1:1234" ], database: database_id, server_selection_timeout: 1 },
+                secondary: { uri: "mongodb://127.0.0.1:1234,127.0.0.1:5678/mongoid_test?serverSelectionTimeoutMS=1000" }
               }
             end
 

data/spec/mongoid/clients/sessions_spec.rb

@@ -16,17 +16,26 @@ describe Mongoid::Clients::Sessions do
   end
 
   let(:subscriber) do
-    Mongoid::Clients.with_name(:other).send(:monitoring).subscribers['Command'].find do |s|
+    client = Mongoid::Clients.with_name(:other)
+    monitoring = if client.respond_to?(:monitoring, true)
+      client.send(:monitoring)
+    else
+      # driver 2.5
+      client.instance_variable_get('@monitoring')
+    end
+    monitoring.subscribers['Command'].find do |s|
       s.is_a?(EventSubscriber)
     end
   end
 
   let(:insert_events) do
-    subscriber.started_events.select { |event| event.command_name == 'insert' }
+    # Driver 2.5 sends command_name as a symbol
+    subscriber.started_events.select { |event| event.command_name.to_s == 'insert' }
   end
 
   let(:update_events) do
-    subscriber.started_events.select { |event| event.command_name == 'update' }
+    # Driver 2.5 sends command_name as a symbol
+    subscriber.started_events.select { |event| event.command_name.to_s == 'update' }
   end
 
   context 'when a session is used on a model class' do

data/spec/mongoid/clients/transactions_spec.rb

@@ -1,18 +1,27 @@
 require "spec_helper"
 
 describe Mongoid::Clients::Sessions do
+  before(:all) do
+    unless Mongo::VERSION >= '2.6'
+      skip 'Driver does not support transactions'
+    end
+  end
 
   before(:all) do
-    CONFIG[:clients][:other] = CONFIG[:clients][:default].dup
-    CONFIG[:clients][:other][:database] = 'other'
-    Mongoid::Clients.clients.values.each(&:close)
-    Mongoid::Config.send(:clients=, CONFIG[:clients])
-    Mongoid::Clients.with_name(:other).subscribe(Mongo::Monitoring::COMMAND, EventSubscriber.new)
+    if Mongo::VERSION >= '2.6'
+      CONFIG[:clients][:other] = CONFIG[:clients][:default].dup
+      CONFIG[:clients][:other][:database] = 'other'
+      Mongoid::Clients.clients.values.each(&:close)
+      Mongoid::Config.send(:clients=, CONFIG[:clients])
+      Mongoid::Clients.with_name(:other).subscribe(Mongo::Monitoring::COMMAND, EventSubscriber.new)
+    end
   end
 
   after(:all) do
-    Mongoid::Clients.with_name(:other).close
-    Mongoid::Clients.clients.delete(:other)
+    if Mongo::VERSION >= '2.6'
+      Mongoid::Clients.with_name(:other).close
+      Mongoid::Clients.clients.delete(:other)
+    end
   end
 
   let(:subscriber) do

data/spec/mongoid/contextual/geo_near_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 describe Mongoid::Contextual::GeoNear do
+  max_server_version '4.0'
 
   describe "#average_distance" do
 

data/spec/mongoid/criteria/modifiable_spec.rb

@@ -1643,11 +1643,15 @@ describe Mongoid::Criteria::Modifiable do
         { 'username' => 'Turnip' }
       end
 
-      it 'returns a criteria with the defined attributes' do
-        expect(Person.create_with(attrs).selector).to eq(attrs)
+      it 'does not modify the selector' do
+        expect(Person.create_with(attrs).selector[:username]).to be_nil
       end
 
-      context 'when a method is chained' do
+      it 'create_attrs is modified' do
+        expect(Person.create_with(attrs).create_attrs).to eq(attrs)
+      end
+
+      context 'when a create is chained' do
 
         context 'when a write method is chained' do
 
@@ -1671,6 +1675,25 @@ describe Mongoid::Criteria::Modifiable do
             expect(new_person.age).to eq(50)
           end
 
+          context 'when a matching document is already in the collection' do
+            let(:query) do
+              { 'username' => 'foo', 'age' => 12 }
+            end
+
+            let(:person) do
+              Person.create!(query)
+            end
+
+            let(:found_person) do
+              Person.create_with(attrs).find_or_create_by(query)
+            end
+
+            it 'finds the matching document' do
+              person
+              expect(found_person.id).to eq(person.id)
+            end
+          end
+
           context 'when the attributes are shared with the write method args' do
 
             let(:query) do
@@ -1681,7 +1704,7 @@ describe Mongoid::Criteria::Modifiable do
               Person.create_with(attrs).find_or_create_by(query)
             end
 
-            it 'gives the write method args precedence' do
+            it 'gives the find method args precedence' do
               expect(new_person.username).to eq('Beet')
               expect(new_person.age).to eq(50)
             end
@@ -1708,8 +1731,12 @@ describe Mongoid::Criteria::Modifiable do
             { 'username' => 'Beet', 'age' => 50 }
           end
 
+          it 'does not modify the selector' do
+            expect(criteria.create_with(attrs).selector).to eq(criteria_selector)
+          end
+
           it 'overwrites all the original attributes' do
-            expect(criteria.create_with(attrs).selector).to eq(attrs)
+            expect(criteria.create_with(attrs).create_attrs).to eq(attrs)
           end
         end
       end
@@ -1720,8 +1747,12 @@ describe Mongoid::Criteria::Modifiable do
           { 'username' => 'Beet' }
         end
 
+        it 'does not modify the selector' do
+          expect(criteria.create_with(attrs).selector).to eq(criteria_selector)
+        end
+
         it 'only overwrites the shared attributes' do
-          expect(criteria.create_with(attrs).selector).to eq(criteria_selector.merge!(attrs))
+          expect(criteria.create_with(attrs).create_attrs).to eq(attrs)
         end
       end
 
@@ -1730,12 +1761,11 @@ describe Mongoid::Criteria::Modifiable do
         let(:attrs) do
           { 'username' => 'Turnip' }
         end
-
         let(:query) do
           { 'username' => 'Beet', 'age' => 50 }
         end
 
-        context 'when a write method is chained' do
+        context 'when a create method is chained' do
 
           it 'executes the method' do
             expect(criteria.create_with(attrs).new.username).to eq('Turnip')
@@ -1749,9 +1779,28 @@ describe Mongoid::Criteria::Modifiable do
             criteria.create_with(attrs).find_or_create_by(query)
           end
 
-          it 'executes the query' do
+          it 'gives the find method arg precedence' do
             expect(new_person.username).to eq('Beet')
-            expect(new_person.age).to eq(50)
+            expect(new_person.age).to be(50)
+          end
+
+          context 'when a matching document is already in the collection' do
+            let(:query) do
+              { 'username' => 'foo', 'age' => 12 }
+            end
+
+            let(:person) do
+              Person.create!(query)
+            end
+
+            let(:found_person) do
+              criteria.create_with(attrs).find_or_create_by(query)
+            end
+
+            it 'finds the matching document' do
+              person
+              expect(found_person.id).to eq(person.id)
+            end
           end
         end
       end