mongoid 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aa194434a7d5ebe53a1f05929202d4976201f90
-  data.tar.gz: 31e2605c59062cb947a510d399a25c173c9ff504
+  metadata.gz: 8d93faa3fdc0513cf6d8daafdf1ab90fd4744fd8
+  data.tar.gz: 77316de1b6bdd99154eacba90bd510b2ca636fdb
 SHA512:
-  metadata.gz: a4d133d4ce0e944995f0a0718ba506ca8ede6cc6f232a14cbe34d371f3db80d5736610ffdc6726bb5de3b658355c4ce818b10c82c172669da82aeafabbb13172
-  data.tar.gz: bf1274305b4c8165ac084e06246adf841fd17aeefdf017eb442e81d92c2aa75c6ab8183e591ba7e5b8a757d8ea39899c4a6ce41cb966d835f020edf3a45e6e6e
+  metadata.gz: 9397767bc7a5cfb49438682bea971816f69a6053beb740cc2ab17fec5add3e59f08d72958464b762d3ad399612479b99810b629969ca184c1bebc65fb661c1b2
+  data.tar.gz: 0725f14ab25f26b0bc29e73b721d9bfe84de5a83119a7fd390957ef4c81c90d8a270725bb42d56b7f3e782cf059e9292815ba8c683585d80ba813ed20e20f809

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2013 Durran Jordan
+Copyright (c) 2009-2016 Durran Jordan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -31,7 +31,7 @@ Please see the [MongoDB website](http://docs.mongodb.org/ecosystem/tutorial/ruby
 License
 -------
 
-Copyright (c) 2009-2015 Durran Jordan
+Copyright (c) 2009-2016 Durran Jordan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/mongoid/changeable.rb

@@ -69,7 +69,7 @@ module Mongoid
         change = attribute_change(attr)
         _changes[attr] = change if change
       end
-      _changes
+      _changes.with_indifferent_access
     end
 
     # Call this method after save, so the changes can be properly switched.

data/lib/mongoid/clients.rb

@@ -111,6 +111,7 @@ module Mongoid
       #
       # @since 3.0.0
       def mongo_client
+        return client_with_options if client_with_options
         client = Clients.with_name(client_name)
         opts = self.persistence_options ? self.persistence_options.dup : {}
         if defined?(Mongo::Client::VALID_OPTIONS)

data/lib/mongoid/clients/options.rb

@@ -43,14 +43,15 @@ module Mongoid
       end
 
       def mongo_client
-        if persistence_options
-          if persistence_options[:client]
-            client = Clients.with_name(persistence_options[:client])
+        tmp = persistence_options
+        if opts = tmp && tmp.dup
+          if opts[:client]
+            client = Clients.with_name(opts[:client])
           else
             client = Clients.with_name(self.class.client_name)
             client.use(self.class.database_name)
           end
-          client.with(persistence_options.reject{ |k, v| k == :collection || k == :client })
+          client.with(opts.reject{ |k, v| k == :collection || k == :client })
         end
       end
 
@@ -76,13 +77,27 @@ module Mongoid
           Thread.current["[mongoid][#{klass}]:persistence-options"]
         end
 
+        # Get the client with special options for the current thread.
+        #
+        # @example Get the client with options.
+        #   Threaded.client_with_options(Band)
+        #
+        # @param [ Class ] klass The model class.
+        #
+        # @return [ Mongo::Client ] The client.
+        #
+        # @since 5.1.0
+        def client_with_options(klass = self)
+          Thread.current["[mongoid][#{klass}]:mongo-client"]
+        end
+
         private
         # Set the persistence options on the current thread.
         #
         # @api private
         #
         # @example Set the persistence options.
-        #   Threaded.set_persistence_options(Band, { safe: { fsync: true }})
+        #   Threaded.set_persistence_options(Band, { write: { w: 3 }})
         #
         # @param [ Class ] klass The model class.
         # @param [ Hash ] options The persistence options.
@@ -93,6 +108,97 @@ module Mongoid
         def set_persistence_options(klass, options)
           Thread.current["[mongoid][#{klass}]:persistence-options"] = options
         end
+
+        # Unset the persistence options on the current thread.
+        #
+        # @api private
+        #
+        # @example Unset the persistence options.
+        #   Threaded.unset_persistence_options(Band)
+        #
+        # @param [ Class ] klass The model class.
+        #
+        # @return [ nil ] nil.
+        #
+        # @since 5.1.0
+        def unset_persistence_options(klass)
+          Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
+        end
+
+        # Set the persistence options and client with those options on the current thread.
+        # Note that a client will only be set if its cluster differs from the cluster of the
+        # original client.
+        #
+        # @api private
+        #
+        # @example Set the persistence options and client with those options on the current thread.
+        #   Threaded.set_options(Band, { write: { w: 3 }})
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Mongo::Client ] client The client with options.
+        #
+        # @return [ Mongo::Client, nil ] The client or nil if the cluster does not change.
+        #
+        # @since 5.1.0
+        def set_options(klass, options)
+          original_cluster = mongo_client.cluster
+          set_persistence_options(klass, options)
+          m = mongo_client
+          set_client_with_options(klass, m) unless m.cluster.equal?(original_cluster)
+        end
+
+        # Set the client with special options on the current thread.
+        #
+        # @api private
+        #
+        # @example Set the client with options.
+        #   Threaded.set_client_with_options(Band, client)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Mongo::Client ] client The client with options.
+        #
+        # @return [ Mongo::Client ] The client.
+        #
+        # @since 5.1.0
+        def set_client_with_options(klass, client)
+          Thread.current["[mongoid][#{klass}]:mongo-client"] = client
+        end
+
+        # Unset the client with special options on the current thread.
+        #
+        # @api private
+        #
+        # @example Unset the client with options.
+        #   Threaded.unset_client_with_options(Band)
+        #
+        # @param [ Class ] klass The model class.
+        #
+        # @return [ nil ] nil.
+        #
+        # @since 5.1.0
+        def unset_client_with_options(klass)
+          if client = Thread.current["[mongoid][#{klass}]:mongo-client"]
+            client.close
+            Thread.current["[mongoid][#{klass}]:mongo-client"] = nil
+          end
+        end
+
+        # Unset the persistence options and client with special options on the current thread.
+        #
+        # @api private
+        #
+        # @example Unset the persistence options and client with options.
+        #   Threaded.unset_options(Band)
+        #
+        # @param [ Class ] klass The model class.
+        #
+        # @return [ nil ] nil.
+        #
+        # @since 5.1.0
+        def unset_options(klass)
+          unset_persistence_options(klass)
+          unset_client_with_options(klass)
+        end
       end
 
       module ClassMethods
@@ -144,7 +250,13 @@ module Mongoid
         #
         # @since 3.0.0
         def with(options)
-          Proxy.new(self, (persistence_options || {}).merge(options))
+          if block_given?
+            set_options(self, options)
+            yield self
+            unset_options(self)
+          else
+            Proxy.new(self, (persistence_options || {}).merge(options))
+          end
         end
       end
 
@@ -174,7 +286,7 @@ module Mongoid
           end
           ret
         ensure
-          set_persistence_options(@target, nil)
+          unset_persistence_options(@target)
         end
 
         def send(symbol, *args)

data/lib/mongoid/config.rb

@@ -24,6 +24,7 @@ module Mongoid
     option :duplicate_fields_exception, default: false
     option :use_activesupport_time_zone, default: true
     option :use_utc, default: false
+    option :log_level, default: :info
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.
@@ -128,6 +129,7 @@ module Mongoid
       configuration = settings.with_indifferent_access
       self.options = configuration[:options]
       self.clients = configuration[:clients]
+      set_log_levels
     end
 
     # Override the database to use globally.
@@ -243,6 +245,11 @@ module Mongoid
 
     private
 
+    def set_log_levels
+      Mongoid.logger.level = Mongoid::Config.log_level
+      Mongo::Logger.logger.level = Mongoid.logger.level
+    end
+
     def clients=(clients)
       raise Errors::NoClientsConfig.new unless clients
       c = clients.with_indifferent_access

data/lib/mongoid/config/options.rb

@@ -69,6 +69,21 @@ module Mongoid
       def settings
         @settings ||= {}
       end
+
+      # Get the log level.
+      #
+      # @example Get the log level.
+      #   config.log_level
+      #
+      # @return [ Integer ] The log level.
+      #
+      # @since 5.1.0
+      def log_level
+        if settings[:log_level]
+          level = settings[:log_level].upcase.to_s
+          "Logger::#{level}".constantize
+        end
+      end
     end
   end
 end

data/lib/mongoid/contextual/geo_near.rb

@@ -198,6 +198,18 @@ module Mongoid
         stats["time"]
       end
 
+      # Is this context's criteria considered empty?
+      #
+      # @example Is this context's criteria considered empty?
+      #   geo_near.empty_and_chainable?
+      #
+      # @return [ true ] Always true.
+      #
+      # @since 5.1.0
+      def empty_and_chainable?
+        true
+      end
+
       private
 
       # Apply criteria specific options - query, limit.

data/lib/mongoid/contextual/mongo.rb

@@ -543,6 +543,12 @@ module Mongoid
         if criteria.options[:timeout] == false
           @view = view.no_cursor_timeout
         end
+        if criteria.options[:cursor_type]
+          # @todo: update to use #cursor_type method on view when driver 2.3 is released.
+          # See RUBY-1080
+          @view = view.clone
+          @view.options.merge!(cursor_type: criteria.options[:cursor_type])
+        end
       end
 
       # Apply an option.

data/lib/mongoid/criteria.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require "mongoid/criteria/findable"
+require "mongoid/criteria/includable"
 require "mongoid/criteria/inspectable"
 require "mongoid/criteria/marshalable"
 require "mongoid/criteria/modifiable"
@@ -19,6 +20,7 @@ module Mongoid
     include Origin::Queryable
     include Findable
     include Inspectable
+    include Includable
     include Marshalable
     include Modifiable
     include Scopable
@@ -194,62 +196,6 @@ module Mongoid
       klass ? super(klass.aliased_fields, klass.fields) : super({}, {})
     end
 
-    # Eager loads all the provided relations. Will load all the documents
-    # into the identity map whose ids match based on the extra query for the
-    # ids.
-    #
-    # @note This will work for embedded relations that reference another
-    #   collection via belongs_to as well.
-    #
-    # @note Eager loading brings all the documents into memory, so there is a
-    #   sweet spot on the performance gains. Internal benchmarks show that
-    #   eager loading becomes slower around 100k documents, but this will
-    #   naturally depend on the specific application.
-    #
-    # @example Eager load the provided relations.
-    #   Person.includes(:posts, :game)
-    #
-    # @param [ Array<Symbol> ] relations The names of the relations to eager
-    #   load.
-    #
-    # @return [ Criteria ] The cloned criteria.
-    #
-    # @since 2.2.0
-    def includes(*relations)
-      relations.flatten.each do |name|
-        metadata = klass.reflect_on_association(name)
-        raise Errors::InvalidIncludes.new(klass, relations) unless metadata
-        inclusions.push(metadata) unless inclusions.include?(metadata)
-      end
-      clone
-    end
-
-    # Get a list of criteria that are to be executed for eager loading.
-    #
-    # @example Get the eager loading inclusions.
-    #   Person.includes(:game).inclusions
-    #
-    # @return [ Array<Metadata> ] The inclusions.
-    #
-    # @since 2.2.0
-    def inclusions
-      @inclusions ||= []
-    end
-
-    # Set the inclusions for the criteria.
-    #
-    # @example Set the inclusions.
-    #   criteria.inclusions = [ meta ]
-    #
-    # @param [ Array<Metadata> ] The inclusions.
-    #
-    # @return [ Array<Metadata> ] The new inclusions.
-    #
-    # @since 3.0.0
-    def inclusions=(value)
-      @inclusions = value
-    end
-
     # Merges another object with this +Criteria+ and returns a new criteria.
     # The other object may be a +Criteria+ or a +Hash+. This is used to
     # combine multiple scopes together, where a chained scope situation

data/lib/mongoid/criteria/findable.rb

@@ -120,7 +120,10 @@ module Mongoid
       #
       # @since 3.0.0
       def mongoize_ids(ids)
-        ids.map{ |id| klass.fields["_id"].mongoize(id) }
+        ids.map do |id|
+          id = id[:id] if id.respond_to?(:keys) && id[:id]
+          klass.fields["_id"].mongoize(id)
+        end
       end
 
       # Convenience method of raising an invalid options error.

data/lib/mongoid/criteria/includable.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+
+    # Module providing functionality for parsing (nested) inclusion definitions.
+    module Includable
+
+      # Eager loads all the provided relations. Will load all the documents
+      # into the identity map whose ids match based on the extra query for the
+      # ids.
+      #
+      # @note This will work for embedded relations that reference another
+      #   collection via belongs_to as well.
+      #
+      # @note Eager loading brings all the documents into memory, so there is a
+      #   sweet spot on the performance gains. Internal benchmarks show that
+      #   eager loading becomes slower around 100k documents, but this will
+      #   naturally depend on the specific application.
+      #
+      # @example Eager load the provided relations.
+      #   Person.includes(:posts, :game)
+      #
+      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the relations to eager
+      #   load.
+      #
+      # @return [ Criteria ] The cloned criteria.
+      #
+      # @since 2.2.0
+      def includes(*relations)
+        relations.flatten.each do |relation|
+          if relation.is_a?(Hash)
+            extract_nested_inclusion(klass, relation)
+          else
+            add_inclusion(klass, relation)
+          end
+        end
+        clone
+      end
+
+      # Get a list of criteria that are to be executed for eager loading.
+      #
+      # @example Get the eager loading inclusions.
+      #   Person.includes(:game).inclusions
+      #
+      # @return [ Array<Metadata> ] The inclusions.
+      #
+      # @since 2.2.0
+      def inclusions
+        @inclusions ||= []
+      end
+
+      # Set the inclusions for the criteria.
+      #
+      # @example Set the inclusions.
+      #   criteria.inclusions = [ meta ]
+      #
+      # @param [ Array<Metadata> ] The inclusions.
+      #
+      # @return [ Array<Metadata> ] The new inclusions.
+      #
+      # @since 3.0.0
+      def inclusions=(value)
+        @inclusions = value
+      end
+
+      private
+
+      # Add an inclusion definition to the list of inclusions for the criteria.
+      #
+      # @example Add an inclusion.
+      #   criteria.add_inclusion(Person, :posts)
+      #
+      # @param [ Class, String, Symbol ] _klass The class or string/symbol of the class name.
+      # @param [ Symbol ] relation The relation.
+      #
+      # @raise [ Errors::InvalidIncludes ] If no relation is found.
+      #
+      # @since 5.1.0
+      def add_inclusion(_klass, relation)
+        metadata = get_inclusion_metadata(_klass, relation)
+        raise Errors::InvalidIncludes.new(_klass, [ relation ]) unless metadata
+        inclusions.push(metadata) unless inclusions.include?(metadata)
+      end
+
+      # Extract inclusion definitions from a list.
+      #
+      # @example Extract the inclusions from a list.
+      #   criteria.extract_relations_list(:posts, [{ :alerts => :items }])
+      #
+      # @param [ Symbol ] association The name of the association.
+      # @param [ Array ] relations A list of associations.
+      #
+      # @since 5.1.0
+      def extract_relations_list(association, relations)
+        relations.each do |relation|
+          if relation.is_a?(Hash)
+            extract_nested_inclusion(association, relation)
+          else
+            add_inclusion(association, relation)
+          end
+        end
+      end
+
+      # Extract nested inclusion.
+      #
+      # @example Extract the inclusions from a nested definition.
+      #   criteria.extract_nested_inclusion(User, { :posts => [:alerts] })
+      #
+      # @param [ Class, Symbol ] _klass The class for which the inclusion should be added.
+      # @param [ Hash ] relation The nested inclusion.
+      #
+      # @since 5.1.0
+      def extract_nested_inclusion(_klass, relation)
+        relation.each do |association, _inclusion|
+          add_inclusion(_klass, association)
+          if _inclusion.is_a?(Array)
+            extract_relations_list(association, _inclusion)
+          else
+            add_inclusion(association, _inclusion)
+          end
+        end
+      end
+
+      # Get the metadata for an inclusion.
+      #
+      # @example Get the metadata for an inclusion definition.
+      #   criteria.get_inclusion_metadata(User, :posts)
+      #
+      # @param [ Class, Symbol, String ] _klass The class for determining the association metadata
+      # @param [ Symbol  ] association The name of the association.
+      #
+      # @since 5.1.0
+      def get_inclusion_metadata(_klass, association)
+        if _klass.is_a?(Class)
+          _klass.reflect_on_association(association)
+        else
+          _klass.to_s.classify.constantize.reflect_on_association(association)
+        end
+      end
+    end
+  end
+end