mongoid 6.4.8 → 7.0.0.beta

metadata.gz.sig

@@ -1,5 +1,2 @@
-�y�{��� �$����fʉ(
-Ǡ|��r��
--�
-��@��T!(՛��:�f�֑�
-]22{|��gB�Y����-s\�Z��GT����s�zC��r��H���BA+�T��
+]o�Rn̵�7�'+Up�]�Ʊ�Î�*�� �ҖA��s�K)��������.(�i~�w���<U��r��ge��+�@�bN��0[>�l�F��ѕ�BwN�!;�]����Z�$
+�4"n���`V

data/lib/mongoid/clients/sessions.rb

@@ -1,113 +0,0 @@
-module Mongoid
-  module Clients
-
-    # Encapsulates behavior for getting a session from the client of a model class or instance,
-    # setting the session on the current thread, and yielding to a block.
-    # The session will be closed after the block completes or raises an error.
-    #
-    # @since 6.4.0
-    module Sessions
-
-      # Execute a block within the context of a session.
-      #
-      # @example Execute some operations in the context of a session.
-      #   band.with_session(causal_consistency: true) do
-      #     band.records << Record.create
-      #     band.name = 'FKA Twigs'
-      #     band.save
-      #     band.reload
-      #   end
-      #
-      # @param [ Hash ] options The session options. Please see the driver
-      #   documentation for the available session options.
-      #
-      # @note You cannot do any operations in the block using models or objects
-      #   that use a different client; the block will execute all operations
-      #   in the context of the implicit session and operations on any models using
-      #   another client will fail. For example, if you set a client using store_in on a
-      #   particular model and execute an operation on it in the session context block,
-      #   that operation can't use the block's session and an error will be raised.
-      #   An error will also be raised if sessions are nested.
-      #
-      # @raise [ Errors::InvalidSessionUse ] If an operation is attempted on a model using another
-      #   client from which the session was started or if sessions are nested.
-      #
-      # @return [ Object ] The result of calling the block.
-      #
-      # @yieldparam [ Mongo::Session ] The session being used for the block.
-      #
-      # @since 6.4.0
-      def with_session(options = {})
-        raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
-        session = persistence_context.client.start_session(options)
-        Threaded.set_session(session)
-        yield(session)
-      rescue Mongo::Error::InvalidSession => ex
-        if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
-          raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
-        end
-        raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)
-      ensure
-        Threaded.clear_session
-      end
-
-      private
-
-      def _session
-        Threaded.get_session
-      end
-
-      module ClassMethods
-
-        # Execute a block within the context of a session.
-        #
-        # @example Execute some operations in the context of a session.
-        #   Band.with_session(causal_consistency: true) do
-        #     band = Band.create
-        #     band.records << Record.new
-        #     band.save
-        #     band.reload.records
-        #   end
-        #
-        # @param [ Hash ] options The session options. Please see the driver
-        #   documentation for the available session options.
-        #
-        # @note You cannot do any operations in the block using models or objects
-        #   that use a different client; the block will execute all operations
-        #   in the context of the implicit session and operations on any models using
-        #   another client will fail. For example, if you set a client using store_in on a
-        #   particular model and execute an operation on it in the session context block,
-        #   that operation can't use the block's session and an error will be raised.
-        #   You also cannot nest sessions.
-        #
-        # @raise [ Errors::InvalidSessionUse ] If an operation is attempted on a model using another
-        #   client from which the session was started or if sessions are nested.
-        #
-        # @return [ Object ] The result of calling the block.
-        #
-        # @yieldparam [ Mongo::Session ] The session being used for the block.
-        #
-        # @since 6.4.0
-        def with_session(options = {})
-          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
-          session = persistence_context.client.start_session(options)
-          Threaded.set_session(session)
-          yield(session)
-        rescue Mongo::Error::InvalidSession => ex
-          if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
-            raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
-          end
-          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)
-        ensure
-          Threaded.clear_session
-        end
-
-        private
-
-        def _session
-          Threaded.get_session
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/errors/invalid_session_use.rb

@@ -1,24 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Errors
-
-    # This error is raised when a session is attempted to be used with a model whose client cannot use it, if
-    #   sessions are nested, or if the mongodb deployment doesn't support sessions.
-    #
-    # @since 6.4.0
-    class InvalidSessionUse < MongoidError
-
-      # Create the error.
-      #
-      # @example Create the error.
-      #   InvalidSessionUse.new(:invalid_session_use)
-      #
-      # @param [ :invalid_sesion_use, :invalid_session_nesting ] error_type The type of session misuse.
-      #
-      # @since 6.4.0
-      def initialize(error_type)
-        super(compose_message(error_type.to_s))
-      end
-    end
-  end
-end

data/lib/mongoid/matchable/nor.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-module Mongoid
-  module Matchable
-
-    # Defines behavior for handling $nor expressions in embedded documents.
-    class Nor < Default
-
-      # Does the supplied query match the attribute?
-      #
-      # Note: an empty array as an argument to $nor is prohibited by
-      # MongoDB server. Mongoid does allow this and returns false in this case.
-      #
-      # @example Does this match?
-      #   matcher._matches?("$nor" => [ { field => value } ])
-      #
-      # @param [ Array ] conditions The or expression.
-      #
-      # @return [ true, false ] True if matches, false if not.
-      #
-      # @since 6.4.2/7.0.2/7.1.0
-      def _matches?(conditions)
-        if conditions.length == 0
-          # MongoDB does not allow $nor array to be empty, but
-          # Mongoid accepts an empty array for $or which MongoDB also
-          # prohibits
-          return false
-        end
-        conditions.none? do |condition|
-          condition.all? do |key, value|
-            document._matches?(key => value)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,86 +0,0 @@
-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/relations.rb

@@ -1,148 +0,0 @@
-# encoding: utf-8
-require "mongoid/relations/accessors"
-require "mongoid/relations/auto_save"
-require "mongoid/relations/cascading"
-require "mongoid/relations/constraint"
-require "mongoid/relations/conversions"
-require "mongoid/relations/counter_cache"
-require "mongoid/relations/cyclic"
-require "mongoid/relations/proxy"
-require "mongoid/relations/bindings"
-require "mongoid/relations/builders"
-require "mongoid/relations/many"
-require "mongoid/relations/one"
-require "mongoid/relations/options"
-require "mongoid/relations/polymorphic"
-require "mongoid/relations/targets/enumerable"
-require "mongoid/relations/embedded/in"
-require "mongoid/relations/embedded/many"
-require "mongoid/relations/embedded/one"
-require "mongoid/relations/referenced/in"
-require "mongoid/relations/referenced/many"
-require "mongoid/relations/referenced/many_to_many"
-require "mongoid/relations/referenced/one"
-require "mongoid/relations/reflections"
-require "mongoid/relations/synchronization"
-require "mongoid/relations/touchable"
-require "mongoid/relations/metadata"
-require "mongoid/relations/macros"
-
-module Mongoid
-
-  # All classes and modules under the relations namespace handle the
-  # functionality that has to do with embedded and referenced (relational)
-  # associations.
-  module Relations
-    extend ActiveSupport::Concern
-    include Accessors
-    include AutoSave
-    include Cascading
-    include Cyclic
-    include Builders
-    include Macros
-    include Polymorphic
-    include Reflections
-    include Synchronization
-    include Touchable
-    include CounterCache
-
-    attr_accessor :__metadata
-    alias :relation_metadata :__metadata
-
-    # Determine if the document itself is embedded in another document via the
-    # proper channels. (If it has a parent document.)
-    #
-    # @example Is the document embedded?
-    #   address.embedded?
-    #
-    # @return [ true, false ] True if the document has a parent document.
-    #
-    # @since 2.0.0.rc.1
-    def embedded?
-      @embedded ||= (cyclic ? _parent.present? : self.class.embedded?)
-    end
-
-    # Determine if the document is part of an embeds_many relation.
-    #
-    # @example Is the document in an embeds many?
-    #   address.embedded_many?
-    #
-    # @return [ true, false ] True if in an embeds many.
-    #
-    # @since 2.0.0.rc.1
-    def embedded_many?
-      __metadata && __metadata.macro == :embeds_many
-    end
-
-    # Determine if the document is part of an embeds_one relation.
-    #
-    # @example Is the document in an embeds one?
-    #   address.embedded_one?
-    #
-    # @return [ true, false ] True if in an embeds one.
-    #
-    # @since 2.0.0.rc.1
-    def embedded_one?
-      __metadata && __metadata.macro == :embeds_one
-    end
-
-    # Get the metadata name for this document. If no metadata was defined
-    # will raise an error.
-    #
-    # @example Get the metadata name.
-    #   document.metadata_name
-    #
-    # @raise [ Errors::NoMetadata ] If no metadata is present.
-    #
-    # @return [ Symbol ] The metadata name.
-    #
-    # @since 3.0.0
-    def metadata_name
-      raise Errors::NoMetadata.new(self.class.name) unless __metadata
-      __metadata.name
-    end
-
-    # Determine if the document is part of an references_many relation.
-    #
-    # @example Is the document in a references many?
-    #   post.referenced_many?
-    #
-    # @return [ true, false ] True if in a references many.
-    #
-    # @since 2.0.0.rc.1
-    def referenced_many?
-      __metadata && __metadata.macro == :has_many
-    end
-
-    # Determine if the document is part of an references_one relation.
-    #
-    # @example Is the document in a references one?
-    #   address.referenced_one?
-    #
-    # @return [ true, false ] True if in a references one.
-    #
-    # @since 2.0.0.rc.1
-    def referenced_one?
-      __metadata && __metadata.macro == :has_one
-    end
-
-    # Convenience method for iterating through the loaded relations and
-    # reloading them.
-    #
-    # @example Reload the relations.
-    #   document.reload_relations
-    #
-    # @return [ Hash ] The relations metadata.
-    #
-    # @since 2.1.6
-    def reload_relations
-      relations.each_pair do |name, meta|
-        if instance_variable_defined?("@_#{name}")
-          if _parent.nil? || instance_variable_get("@_#{name}") != _parent
-            remove_instance_variable("@_#{name}")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/accessors.rb

@@ -1,267 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module contains all the behaviour related to accessing relations
-    # through the getters and setters, and how to delegate to builders to
-    # create new ones.
-    module Accessors
-      extend ActiveSupport::Concern
-
-      # Builds the related document and creates the relation unless the
-      # document is nil, then sets the relation on this document.
-      #
-      # @example Build the relation.
-      #   person.__build__(:addresses, { :_id => 1 }, metadata)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      # @param [ Hash, BSON::ObjectId ] object The id or attributes to use.
-      # @param [ Metadata ] metadata The relation's metadata.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def __build__(name, object, metadata)
-        relation = create_relation(object, metadata)
-        set_relation(name, relation)
-      end
-
-      # Create a relation from an object and metadata.
-      #
-      # @example Create the relation.
-      #   person.create_relation(document, metadata)
-      #
-      # @param [ Document, Array<Document> ] object The relation target.
-      # @param [ Metadata ] metadata The relation metadata.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def create_relation(object, metadata)
-        type = @attributes[metadata.inverse_type]
-        target = metadata.builder(self, object).build(type)
-        target ? metadata.relation.new(self, target, metadata) : nil
-      end
-
-      # Resets the criteria inside the relation proxy. Used by many to many
-      # relations to keep the underlying ids array in sync.
-      #
-      # @example Reset the relation criteria.
-      #   person.reset_relation_criteria(:preferences)
-      #
-      # @param [ Symbol ] name The name of the relation.
-      #
-      # @since 3.0.14
-      def reset_relation_criteria(name)
-        if instance_variable_defined?("@_#{name}")
-          send(name).reset_unloaded
-        end
-      end
-
-      # Set the supplied relation to an instance variable on the class with the
-      # provided name. Used as a helper just for code cleanliness.
-      #
-      # @example Set the proxy on the document.
-      #   person.set(:addresses, addresses)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      # @param [ Proxy ] relation The relation to set.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def set_relation(name, relation)
-        instance_variable_set("@_#{name}", relation)
-      end
-
-      private
-
-      # Get the relation. Extracted out from the getter method to avoid
-      # infinite recursion when overriding the getter.
-      #
-      # @api private
-      #
-      # @example Get the relation.
-      #   document.get_relation(:name, metadata)
-      #
-      # @param [ Symbol ] name The name of the relation.
-      # @param [ Metadata ] metadata The relation metadata.
-      # @param [ true, false ] reload If the relation is to be reloaded.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 3.0.16
-      def get_relation(name, metadata, object, reload = false)
-        if !reload && (value = ivar(name)) != false
-          value
-        else
-          _building do
-            _loading do
-              if object && needs_no_database_query?(object, metadata)
-                __build__(name, object, metadata)
-              else
-                __build__(name, attributes[metadata.key], metadata)
-              end
-            end
-          end
-        end
-      end
-
-      def needs_no_database_query?(object, metadata)
-        object.is_a?(Document) && !object.embedded? &&
-          object._id == attributes[metadata.key]
-      end
-
-      # Is the current code executing without autobuild functionality?
-      #
-      # @example Is autobuild disabled?
-      #   document.without_autobuild?
-      #
-      # @return [ true, false ] If autobuild is disabled.
-      #
-      # @since 3.0.0
-      def without_autobuild?
-        Threaded.executing?(:without_autobuild)
-      end
-
-      # Yield to the block with autobuild functionality turned off.
-      #
-      # @example Execute without autobuild.
-      #   document.without_autobuild do
-      #     document.name
-      #   end
-      #
-      # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
-      def without_autobuild
-        Threaded.begin_execution("without_autobuild")
-        yield
-      ensure
-        Threaded.exit_execution("without_autobuild")
-      end
-
-      module ClassMethods
-
-        # Adds the existence check for relations.
-        #
-        # @example Add the existence check.
-        #   Person.existence_check(:name, meta)
-        #
-        # @example Check if a relation exists.
-        #   person = Person.new
-        #   person.has_game?
-        #   person.game?
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        #
-        # @return [ Class ] The model being set up.
-        #
-        # @since 3.0.0
-        def existence_check(name)
-          module_eval <<-END, __FILE__, __LINE__ + 1
-            def #{name}?
-              without_autobuild { !__send__(:#{name}).blank? }
-            end
-            alias :has_#{name}? :#{name}?
-          END
-          self
-        end
-
-        # Defines the getter for the relation. Nothing too special here: just
-        # return the instance variable for the relation if it exists or build
-        # the thing.
-        #
-        # @example Set up the getter for the relation.
-        #   Person.getter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def getter(name, metadata)
-          re_define_method(name) do |reload = false|
-            value = get_relation(name, metadata, nil, reload)
-            if value.nil? && metadata.autobuilding? && !without_autobuild?
-              value = send("build_#{name}")
-            end
-            value
-          end
-          self
-        end
-
-        # Defines the getter for the ids of documents in the relation. Should
-        # be specify only for referenced many relations.
-        #
-        # @example Set up the ids getter for the relation.
-        #   Person.ids_getter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        #
-        # @return [ Class ] The class being set up.
-        def ids_getter(name, metadata)
-          ids_method = "#{name.to_s.singularize}_ids"
-          re_define_method(ids_method) do
-            send(name).only(:id).map(&:id)
-          end
-          self
-        end
-
-        # Defines the setter for the relation. This does a few things based on
-        # some conditions. If there is an existing association, a target
-        # substitution will take place, otherwise a new relation will be
-        # created with the supplied target.
-        #
-        # @example Set up the setter for the relation.
-        #   Person.setter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def setter(name, metadata)
-          re_define_method("#{name}=") do |object|
-            without_autobuild do
-              if value = get_relation(name, metadata, object)
-                if value.respond_to?(:substitute)
-                  set_relation(name, value.substitute(object.substitutable))
-                else
-                  value = __build__(name, value, metadata)
-                  set_relation(name, value.substitute(object.substitutable))
-                end
-              else
-                __build__(name, object.substitutable, metadata)
-              end
-            end
-          end
-          self
-        end
-
-        # Defines the setter method that allows you to set documents
-        # in this relation by their ids. The defined setter, finds
-        # documents with given ids and invokes regular relation setter
-        # with found documents. Ids setters should be defined only for
-        # referenced many relations.
-        #
-        # @example Set up the id_setter for the relation.
-        #   Person.ids_setter("addesses", metadata)
-        #
-        #  @param [ String, Symbol ] name The name of the relation.
-        #  @param [ Metadata ] metadata The metadata for the relation.
-        #
-        #  @return [ Class ] The class being set up.
-        def ids_setter(name, metadata)
-          ids_method = "#{name.to_s.singularize}_ids="
-          re_define_method(ids_method) do |ids|
-            send(metadata.setter, metadata.klass.find(ids.reject(&:blank?)))
-          end
-          self
-        end
-      end
-    end
-  end
-end