mongoid 6.4.2 → 6.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c5d349e3de6af570dd7b1347fd76b6056848149180dc355e116f67f8ac2c3c6
-  data.tar.gz: e9be28598f701bb124ba6626bb777da07d05bca692224110078700557f2c0aa9
+  metadata.gz: ccf32387a001233a1704c7c20281e25dfbb8262134114bbdfedef5dcd888032c
+  data.tar.gz: 25fecceb3036b5feb86d572e8994c60a8cbac0c47daabd1307788723bc8090f3
 SHA512:
-  metadata.gz: 1bf33975f8969cc06ac717cef1a443429dd6ad8e8a7cd755c8b74ed9b7bc0e1a113413dac81098f54f9c181b91d03fc5958adfaaddb03d7fb91caa9f2e11dc84
-  data.tar.gz: c5ef0576ed9941a5ba0f0865fdaff885766e4d6fe6901d1037ce408a0acdc0e00fdbfe503a5a7d721d8178a83c39c6e5893aaf0c258e871b3dca17939d0e7d97
+  metadata.gz: 03be9dcb886f2bc83a7b57a93fecf2bf3e0732668ee173c30d810fb0459cc4ec4eae277717e4bd0695d969ec378d58e4767f5e99ea73b036eb764637da1cb8a6
+  data.tar.gz: fe0e129f059daabb83fd638455ea22fe0da7800b5095400210ee4d71acf6b02d78847f60e8393ae15815fbb57d4753bfbb2be0db76ca2351f75f075d3a65b5c7

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

@@ -134,13 +134,21 @@ module Mongoid
           ::Boolean.evolve(value)
         end
 
-        # Add a $geoIntersects or $geoWithin selection. Symbol operators must be used as shown in
-        # the examples to expand the criteria.
+        # Add a $geoIntersects or $geoWithin selection. Symbol operators must
+        # be used as shown in the examples to expand the criteria.
         #
         # @note The only valid geometry shapes for a $geoIntersects are:
         #   :intersects_line, :intersects_point, and :intersects_polygon.
         #
-        # @note The only valid geometry shape for a $geoWithin is :within_polygon
+        # @note The only valid options for a $geoWithin query are the geometry
+        #   shape :within_polygon and the operator :within_box.
+        #
+        # @note The :within_box operator for the $geoWithin query expects the
+        #   lower left (south west) coordinate pair as the first argument and
+        #   the upper right (north east) as the second argument.
+        #   Important: When latitude and longitude are passed, longitude is
+        #   expected as the first element of the coordinate pair.
+        #   Source: https://docs.mongodb.com/manual/reference/operator/query/box/
         #
         # @example Add a geo intersect criterion for a line.
         #   query.geo_spacial(:location.intersects_line => [[ 1, 10 ], [ 2, 10 ]])
@@ -154,6 +162,9 @@ module Mongoid
         # @example Add a geo within criterion for a polygon.
         #   query.geo_spacial(:location.within_polygon => [[ 1, 10 ], [ 2, 10 ], [ 1, 10 ]])
         #
+        # @example Add a geo within criterion for a box.
+        #   query.geo_spacial(:location.within_box => [[ 1, 10 ], [ 2, 10 ])
+        #
         # @param [ Hash ] criterion The criterion.
         #
         # @return [ Selectable ] The cloned selectable.
@@ -174,6 +185,7 @@ module Mongoid
         key :within_polygon, :override, "$geoWithin", "$geometry" do |value|
           { "type" => POLYGON, "coordinates" => value }
         end
+        key :within_box, :override, "$geoWithin", "$box"
 
         # Add the $gt criterion to the selector.
         #
@@ -501,6 +513,11 @@ module Mongoid
         # @example Construct a text search selector with options.
         #   selectable.text_search("testing", :$language => "fr")
         #
+        # @note Per https://docs.mongodb.com/manual/reference/operator/query/text/
+        #   it is not currently possible to supply multiple text search
+        #   conditions in a query. Mongoid will build such a query but the
+        #   server will return an error when trying to execute it.
+        #
         # @param [ String, Symbol ] terms A string of terms that MongoDB parses
         #   and uses to query the text index.
         # @param [ Hash ] opts Text search options. See MongoDB documentation
@@ -512,9 +529,19 @@ module Mongoid
         def text_search(terms, opts = nil)
           clone.tap do |query|
             if terms
-              criterion = { :$text => { :$search => terms } }
-              criterion[:$text].merge!(opts) if opts
-              query.selector = criterion
+              criterion = {'$text' => { '$search' => terms }}
+              criterion['$text'].merge!(opts) if opts
+              if query.selector['$text']
+                # Per https://docs.mongodb.com/manual/reference/operator/query/text/
+                # multiple $text expressions are not currently supported by
+                # MongoDB server, but build the query correctly instead of
+                # overwriting previous text search condition with the currently
+                # given one.
+                Mongoid.logger.warn('Multiple $text expressions per query are not currently supported by the server')
+                query.selector = {'$and' => [query.selector]}.merge(criterion)
+              else
+                query.selector = query.selector.merge(criterion)
+              end
             end
           end
         end

data/lib/mongoid/document.rb

@@ -190,11 +190,11 @@ module Mongoid
     #
     # @since 5.1.0
     def as_json(options = nil)
-      if options && (options[:compact] == true)
-        super(options).reject! { |k,v| v.nil? }
-      else
-        super(options)
+      rv = super
+      if options && options[:compact]
+        rv = rv.compact
       end
+      rv
     end
 
     # Returns an instance of the specified class with the attributes,

data/lib/mongoid/extensions/big_decimal.rb

@@ -53,7 +53,7 @@ module Mongoid
         #
         # @since 3.0.0
         def demongoize(object)
-          object && object.numeric? ? ::BigDecimal.new(object.to_s) : nil
+          object && object.numeric? ? BigDecimal(object.to_s) : nil
         end
 
         # Mongoize an object of any type to how it's stored in the db as a String.

data/lib/mongoid/extensions/regexp.rb

@@ -17,6 +17,7 @@ module Mongoid
         #
         # @since 3.0.0
         def mongoize(object)
+          return nil if object.nil?
           ::Regexp.new(object)
         end
       end

data/lib/mongoid/railtie.rb

@@ -102,6 +102,23 @@ module Rails
         puts "There is a configuration error with the current mongoid.yml."
         puts e.message
       end
+
+      # Include Controller extension that measures Mongoid runtime
+      # during request processing. The value then appears in Rails'
+      # instrumentation event `process_action.action_controller`.
+      #
+      # The measurement is made via internal Mongo monitoring subscription
+      initializer "mongoid.runtime-metric" do
+        require "mongoid/railties/controller_runtime"
+
+        ActiveSupport.on_load :action_controller do
+          include ::Mongoid::Railties::ControllerRuntime::ControllerExtension
+        end
+
+        Mongo::Monitoring::Global.subscribe Mongo::Monitoring::COMMAND,
+            ::Mongoid::Railties::ControllerRuntime::Collector.new
+      end
+
     end
   end
 end

data/lib/mongoid/railties/controller_runtime.rb

@@ -0,0 +1,86 @@
+module Mongoid
+  module Railties
+    module ControllerRuntime
+
+      # This extension mimics the Rails' internal method to
+      # measure ActiveRecord runtime during request processing.
+      # It appends MongoDB runtime value (`mongoid_runtime`) into payload
+      # of instrumentation event `process_action.action_controller`.
+      module ControllerExtension
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :mongoid_runtime
+
+        # Reset the runtime before each action.
+        def process_action(action, *args)
+          Collector.reset_runtime
+          super
+        end
+
+        # Override to collect the measurements.
+        def cleanup_view_runtime
+          mongo_rt_before_render = Collector.reset_runtime
+          runtime = super
+          mongo_rt_after_render = Collector.reset_runtime
+          self.mongoid_runtime = mongo_rt_before_render + mongo_rt_after_render
+          runtime - mongo_rt_after_render
+        end
+
+        # Add the measurement to the instrumentation event payload.
+        def append_info_to_payload(payload)
+          super
+          payload[:mongoid_runtime] = (mongoid_runtime || 0) + Collector.reset_runtime
+        end
+
+        module ClassMethods
+
+          # Append MongoDB runtime information to ActionController runtime
+          # log message.
+          def log_process_action(payload)
+            messages = super
+            mongoid_runtime = payload[:mongoid_runtime]
+            messages << ("MongoDB: %.1fms" % mongoid_runtime.to_f) if mongoid_runtime
+            messages
+          end
+
+        end
+
+      end
+
+      # The Collector of MongoDB runtime metric, that subscribes to Mongo
+      # driver command monitoring. Stores the value within a thread-local
+      # variable to provide correct accounting when an application issues
+      # MongoDB operations from background threads.
+      class Collector
+
+        VARIABLE_NAME = "Mongoid.controller_runtime".freeze
+
+        def started _; end
+
+        def _completed e
+          Collector.runtime += e.duration
+        end
+        alias :succeeded :_completed
+        alias :failed :_completed
+
+        def self.runtime
+          Thread.current[VARIABLE_NAME] ||= 0
+        end
+
+        def self.runtime= value
+          Thread.current[VARIABLE_NAME] = value
+        end
+
+        def self.reset_runtime
+          to_now = runtime
+          self.runtime = 0
+          to_now
+        end
+
+      end
+
+    end
+  end
+end

data/lib/mongoid/scopable.rb

@@ -102,7 +102,7 @@ module Mongoid
       #
       # @since 3.0.0
       def default_scopable?
-        default_scoping? && !Threaded.executing?(:without_default_scope)
+        default_scoping? && !Threaded.without_default_scope?(self)
       end
 
       # Get a queryable, either the last one on the scope stack or a fresh one.
@@ -244,10 +244,10 @@ module Mongoid
       #
       # @since 3.0.0
       def without_default_scope
-        Threaded.begin_execution("without_default_scope")
+        Threaded.begin_without_default_scope(self)
         yield
       ensure
-        Threaded.exit_execution("without_default_scope")
+        Threaded.exit_without_default_scope(self)
       end
 
       private

data/lib/mongoid/threaded.rb

@@ -163,6 +163,30 @@ module Mongoid
       validations_for(document.class).delete_one(document._id)
     end
 
+    # Begin suppressing default scopes for given model on the current thread.
+    #
+    # @example Begin without default scope stack.
+    #   Threaded.begin_without_default_scope(klass)
+    #
+    # @param [ Class ] klass The model to suppress default scoping on.
+    #
+    # @api private
+    def begin_without_default_scope(klass)
+      stack(:without_default_scope).push(klass)
+    end
+
+    # Exit suppressing default scopes for given model on the current thread.
+    #
+    # @example Exit without default scope stack.
+    #   Threaded.exit_without_default_scope(klass)
+    #
+    # @param [ Class ] klass The model to unsuppress default scoping on.
+    #
+    # @api private
+    def exit_without_default_scope(klass)
+      stack(:without_default_scope).delete(klass)
+    end
+
     # Get the global client override.
     #
     # @example Get the global client override.
@@ -247,6 +271,18 @@ module Mongoid
       end
     end
 
+    # Is the given klass' default scope suppressed on the current thread?
+    #
+    # @example Is the given klass' default scope suppressed?
+    #   Threaded.without_default_scope?(klass)
+    #
+    # @param [ Class ] klass The model to check for default scope suppression.
+    #
+    # @api private
+    def without_default_scope?(klass)
+      stack(:without_default_scope).include?(klass)
+    end
+
     # Is the document autosaved on the current thread?
     #
     # @example Is the document autosaved?

data/lib/mongoid/version.rb

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

data/spec/mongoid/contextual/mongo_spec.rb

@@ -2363,7 +2363,7 @@ describe Mongoid::Contextual::Mongo do
       end
 
       it 'creates a pipeline with the selector as one of the $match criteria' do
-        expect(pipeline_match).to include({ :'$text' => { :'$search' => "New Order" } })
+        expect(pipeline_match).to include({ '$text' => { '$search' => "New Order" } })
       end
 
       it 'creates a pipeline with the $exists operator as one of the $match criteria' do

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

@@ -7,7 +7,7 @@ describe BigDecimal do
     context "when provided a big decimal" do
 
       let(:big_decimal) do
-        BigDecimal.new("123456.789")
+        BigDecimal("123456.789")
       end
 
       it "returns the decimal as a string" do
@@ -25,11 +25,11 @@ describe BigDecimal do
     context "when provided an array of big decimals" do
 
       let(:bd_one) do
-        BigDecimal.new("123456.789")
+        BigDecimal("123456.789")
       end
 
       let(:bd_two) do
-        BigDecimal.new("123333.789")
+        BigDecimal("123333.789")
       end
 
       let(:array) do

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

@@ -1073,6 +1073,26 @@ describe Mongoid::Criteria::Queryable::Selectable do
           })
         end
 
+        context "when used with the $box operator ($geoWithin query) " do
+          let(:selection) do
+            query.geo_spacial(
+              :location.within_box => [[ 1, 10 ], [ 2, 10 ]]
+            )
+          end
+  
+          it "adds the $geoIntersects expression" do
+            expect(selection.selector).to eq({
+              "location" => {
+                "$geoWithin" => {
+                  "$box" => [
+                    [ 1, 10 ], [ 2, 10 ]
+                  ]
+                }
+              }
+            })
+          end
+        end
+
         it_behaves_like "a cloning selection"
       end
     end
@@ -3369,7 +3389,7 @@ describe Mongoid::Criteria::Queryable::Selectable do
       end
 
       it "constructs a text search document" do
-        expect(selection.selector).to eq({ :$text => { :$search => "testing" }})
+        expect(selection.selector).to eq({ '$text' => { '$search' => "testing" }})
       end
 
       it "returns the cloned selectable" do
@@ -3383,16 +3403,35 @@ describe Mongoid::Criteria::Queryable::Selectable do
         end
 
         it "constructs a text search document" do
-          expect(selection.selector[:$text][:$search]).to eq("essais")
+          expect(selection.selector['$text']['$search']).to eq("essais")
         end
 
         it "add the options to the text search document" do
-          expect(selection.selector[:$text][:$language]).to eq("fr")
+          expect(selection.selector['$text'][:$language]).to eq("fr")
         end
 
         it_behaves_like "a cloning selection"
       end
     end
+
+    context 'when given more than once' do
+      let(:selection) do
+        query.text_search("one").text_search('two')
+      end
+
+      # MongoDB server can only handle one text expression at a time,
+      # per https://docs.mongodb.com/manual/reference/operator/query/text/.
+      # Nonetheless we test that the query is built correctly when
+      # a user supplies more than one text condition.
+      it 'merges conditions' do
+        expect(Mongoid.logger).to receive(:warn)
+        expect(selection.selector).to eq('$and' => [
+            {'$text' => {'$search' => 'one'}}
+          ],
+          '$text' => {'$search' => 'two'},
+        )
+      end
+    end
   end
 
   describe "#where" do

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

@@ -370,11 +370,11 @@ describe Mongoid::Criteria::Queryable::Selector do
         context "when providing an array" do
 
           let(:big_one) do
-            BigDecimal.new("1.2321")
+            BigDecimal("1.2321")
           end
 
           let(:big_two) do
-            BigDecimal.new("4.2222")
+            BigDecimal("4.2222")
           end
 
           let(:array) do

data/spec/mongoid/criteria/scopable_spec.rb

@@ -388,4 +388,85 @@ describe Mongoid::Criteria::Scopable do
       end
     end
   end
+
+  describe 'scope and where' do
+    class ScopeWhereModel
+      include Mongoid::Document
+
+      scope :foo, -> { where(foo: true) }
+    end
+
+    shared_examples_for 'restricts to both' do
+      it 'restricts to both' do
+        expect(result.selector['foo']).to eq(true)
+        expect(result.selector['hello']).to eq('world')
+      end
+    end
+
+    context 'scope is given first' do
+      let(:result) { ScopeWhereModel.foo.where(hello: 'world') }
+
+      it_behaves_like 'restricts to both'
+    end
+
+    context 'where is given first' do
+      let(:result) { ScopeWhereModel.where(hello: 'world').foo }
+
+      it_behaves_like 'restricts to both'
+    end
+  end
+
+  describe 'scope with argument and where' do
+    class ArgumentScopeWhereModel
+      include Mongoid::Document
+
+      scope :my_text_search, ->(search) { where('$text' => {'$search' => search}) }
+    end
+
+    shared_examples_for 'restricts to both' do
+      it 'restricts to both' do
+        expect(result.selector['$text']).to eq({'$search' => 'bar'})
+        expect(result.selector['hello']).to eq('world')
+      end
+    end
+
+    context 'scope is given first' do
+      let(:result) { ArgumentScopeWhereModel.my_text_search('bar').where(hello: 'world') }
+
+      it_behaves_like 'restricts to both'
+    end
+
+    context 'where is given first' do
+      let(:result) { ArgumentScopeWhereModel.where(hello: 'world').my_text_search('bar') }
+
+      it_behaves_like 'restricts to both'
+    end
+  end
+
+  describe 'built in text search scope and where' do
+    class TextSearchScopeWhereModel
+      include Mongoid::Document
+
+      # using the default text_search scope
+    end
+
+    shared_examples_for 'restricts to both' do
+      it 'restricts to both' do
+        expect(result.selector['$text']).to eq({'$search' => 'bar'})
+        expect(result.selector['hello']).to eq('world')
+      end
+    end
+
+    context 'scope is given first' do
+      let(:result) { TextSearchScopeWhereModel.text_search('bar').where(hello: 'world') }
+
+      it_behaves_like 'restricts to both'
+    end
+
+    context 'where is given first' do
+      let(:result) { TextSearchScopeWhereModel.where(hello: 'world').text_search('bar') }
+
+      it_behaves_like 'restricts to both'
+    end
+  end
 end