mongoid 5.1.5 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abf3bc71acef310e6e22c9900a173ef44adcffe9
-  data.tar.gz: 3178495b48b2377e77929352b9349c02adee7017
+  metadata.gz: c45686b0e53c4e404c5f52563b399c2ae3909dce
+  data.tar.gz: aea6ea222ae4e97af3ec984a7cb185cce8de966a
 SHA512:
-  metadata.gz: 16106f196625909b1bbefd3bea0ab5e7b3397cd8055108c01c7f5b1ae7dc485810a9fa78ab5975b3794e2db8a2fe2b82d9c8d3e18b69e762f2ff994727397eba
-  data.tar.gz: e08c0e8efaa17427d5d3e329322dd367b72a44eb5f3a5c9e2d0d1c9bf5d4bebcae313ee155dbb5f78578cd98a767f2a7e78fad5747c87221176da465321384ab
+  metadata.gz: 033d87560a04cdcae0e2353117eccaa5f14ab4ea273e9bc491cd4cef659ae3488008f17894161375d6910c7be9533d249722eda57a556b8d388419761863366e
+  data.tar.gz: df6a8a161d146fd07a8ddc9867b0105c8f5285273770b169cd280b47c211d54ae31b7bb1ca96f27c35cc43a5e7ccf9e12485592722522efae0541f43d5ac42cf

data/lib/config/locales/en.yml

@@ -76,6 +76,12 @@ en:
           resolution: "For access to the collection that the embedded document is
             in, use %{klass}#_root.collection, or do not attempt to persist an
             embedded document without a parent set."
+        in_memory_collation_not_supported:
+          message: "A collation option cannot be applied when querying documents in-memory."
+          summary: "The query being run against documents in memory has a collation option set.
+            A collation option is only supported if the query is executed on a MongoDB server
+            with version >= 3.4."
+          resolution: "Remove the collation option from the query."
         invalid_config_option:
           message: "Invalid configuration option: %{name}."
           summary: "A invalid configuration option was provided in your
@@ -134,9 +140,18 @@ en:
             \_\_min: 1\n
             \_\_max: 1\n
             \_\_bits: 26\n
+            \_\_key: 26\n
             \_\_bucket_size : 1\n
+            \_\_sphere_version : 1\n
+            \_\_text_version : 1\n
+            \_\_version : 1\n
             \_\_weights: { content: 1, title: 2 }\n
             \_\_expire_after_seconds: number_of_seconds\n
+            \_\_partial_filter_expression\n
+            \_\_storage_engine\n
+            \_\_language_override\n
+            \_\_default_language\n
+            \_\_collation\n
             Valid types are: 1, -1, '2d', '2dsphere', 'geoHaystack', 'text', 'hashed'\n\n
             Example:\n
             \_\_class Band\n

data/lib/mongoid.rb

@@ -36,6 +36,11 @@ module Mongoid
   extend Loggable
   extend self
 
+  # A string added to the platform details of Ruby driver client handshake documents.
+  #
+  # @since 6.1.0
+  PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
+
   # The minimum MongoDB version supported.
   MONGODB_VERSION = "2.4.0"
 

data/lib/mongoid/attributes/dynamic.rb

@@ -37,7 +37,7 @@ module Mongoid
       # @since 4.0.0
       def define_dynamic_reader(name)
         return unless name.valid_method_name?
-        class_eval <<-READER
+        class_eval <<-READER, __FILE__, __LINE__ + 1
           def #{name}
             attribute_will_change!(#{name.inspect})
             read_attribute(#{name.inspect})
@@ -56,7 +56,7 @@ module Mongoid
       #
       # @since 4.0.0
       def define_dynamic_before_type_cast_reader(name)
-        class_eval <<-READER
+        class_eval <<-READER, __FILE__, __LINE__ + 1
           def #{name}_before_type_cast
             attribute_will_change!(#{name.inspect})
             read_attribute_before_type_cast(#{name.inspect})
@@ -77,7 +77,7 @@ module Mongoid
       def define_dynamic_writer(name)
         return unless name.valid_method_name?
 
-        class_eval <<-WRITER
+        class_eval <<-WRITER, __FILE__, __LINE__ + 1
           def #{name}=(value)
             write_attribute(#{name.inspect}, value)
           end

data/lib/mongoid/clients/factory.rb

@@ -71,6 +71,8 @@ module Mongoid
       def options(configuration)
         config = configuration.dup
         options = config.delete(:options) || {}
+        options[:platform] = PLATFORM_DETAILS
+        options[:app_name] = Mongoid::Config.app_name if Mongoid::Config.app_name
         options.reject{ |k, v| k == :hosts }.to_hash.symbolize_keys!
       end
     end

data/lib/mongoid/config.rb

@@ -25,6 +25,7 @@ module Mongoid
     option :use_activesupport_time_zone, default: true
     option :use_utc, default: false
     option :log_level, default: :info
+    option :app_name, default: nil
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.

data/lib/mongoid/config/options.rb

@@ -31,7 +31,7 @@ module Mongoid
       def option(name, options = {})
         defaults[name] = settings[name] = options[:default]
 
-        class_eval <<-RUBY
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{name}
             settings[#{name.inspect}]
           end

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

@@ -124,7 +124,6 @@ module Mongoid
         def pipeline(field)
           db_field = "$#{database_field_name(field)}"
           pipeline = []
-          pipeline << { "$match" => criteria.selector }
           pipeline << { "$match" =>  criteria.exists(field => true).selector }
           pipeline << { "$sort" => criteria.options[:sort] } if criteria.options[:sort]
           pipeline << { "$skip" => criteria.options[:skip] } if criteria.options[:skip]

data/lib/mongoid/contextual/map_reduce.rb

@@ -32,12 +32,13 @@ module Mongoid
       #
       # @since 3.0.0
       def each
+        validate_out!
         if block_given?
-          documents.each do |doc|
+          @map_reduce.each do |doc|
             yield doc
           end
         else
-          to_enum
+          @map_reduce.to_enum
         end
       end
 
@@ -64,7 +65,7 @@ module Mongoid
       #
       # @since 3.0.0
       def finalize(function)
-        command[:finalize] = function
+        @map_reduce = @map_reduce.finalize(function)
         self
       end
 
@@ -79,10 +80,9 @@ module Mongoid
       #
       # @since 3.0.0
       def initialize(collection, criteria, map, reduce)
-        @collection, @criteria = collection, criteria
-        command[:mapreduce] = collection.name.to_s
-        command[:map], command[:reduce] = map, reduce
-        apply_criteria_options
+        @collection = collection
+        @criteria = criteria
+        @map_reduce = @criteria.view.map_reduce(map, reduce)
       end
 
       # Get the number of documents that were input into the map/reduce.
@@ -106,7 +106,7 @@ module Mongoid
       #
       # @since 3.0.0
       def js_mode
-        command[:jsMode] = true
+        @map_reduce = @map_reduce.js_mode(true)
         self
       end
 
@@ -134,7 +134,7 @@ module Mongoid
         normalized.update_values do |value|
           value.is_a?(::Symbol) ? value.to_s : value
         end
-        command[:out] = normalized
+        @map_reduce = @map_reduce.out(normalized)
         self
       end
 
@@ -159,8 +159,12 @@ module Mongoid
       #
       # @since 3.0.0
       def raw
-        results
+        validate_out!
+        cmd = command
+        opts = { read: cmd.delete(:read).options } if cmd[:read]
+        @map_reduce.database.command(cmd, opts || {}).first
       end
+      alias :results :raw
 
       # Execute the map/reduce, returning the raw output.
       # Useful when you don't care about map/reduce's ouptut.
@@ -196,7 +200,7 @@ module Mongoid
       #
       # @since 3.0.0
       def scope(object)
-        command[:scope] = object
+        @map_reduce = @map_reduce.scope(object)
         self
       end
 
@@ -232,95 +236,14 @@ module Mongoid
 }
       end
 
-      private
-
-      # Apply criteria specific options - query, sort, limit.
-      #
-      # @api private
-      #
-      # @example Apply the criteria options
-      #   map_reduce.apply_criteria_options
-      #
-      # @return [ nil ] Nothing.
-      #
-      # @since 3.0.0
-      def apply_criteria_options
-        command[:query] = criteria.selector
-        if sort = criteria.options[:sort]
-          command[:sort] = sort
-        end
-        if limit = criteria.options[:limit]
-          command[:limit] = limit
-        end
+      def command
+        @map_reduce.send(:map_reduce_spec)[:selector]
       end
 
-      # Get the result documents from the map/reduce. If the output was inline
-      # then we grab them from the results key. If the output was a temp
-      # collection then we need to execute a find on that collection.
-      #
-      # @api private
-      #
-      # @example Get the documents.
-      #   map_reduce.documents
-      #
-      # @return [ Array, Cursor ] The documents.
-      #
-      # @since 3.0.0
-      def documents
-        return results["results"] if results.has_key?("results")
-        view = client[output_collection].find
-        view.no_cursor_timeout if criteria.options[:timeout] == false
-        view
-      end
-
-      # Get the collection that the map/reduce results were stored in.
-      #
-      # @api private
-      #
-      # @example Get the output collection.
-      #   map_reduce.output_collection
-      #
-      # @return [ Symbol, String ] The output collection.
-      #
-      # @since 3.0.0
-      def output_collection
-        command[:out].values.first
-      end
-
-      # Execute the map/reduce command and get the results.
-      #
-      # @api private
-      #
-      # @example Get the results.
-      #   map_reduce.results
-      #
-      # @return [ Hash ] The results of the command.
-      #
-      # @since 3.0.0
-      def results
-        raise Errors::NoMapReduceOutput.new(command) unless command[:out]
-        @results ||= __client__.command(command).first
-      end
+      private
 
-      # Get the client with the proper consistency.
-      #
-      # @api private
-      #
-      # @note We can use eventual if the output is set to inline.
-      #
-      # @example Get the client.
-      #   map_reduce.__client__
-      #
-      # @return [ Mongo::Client ] The client with consistency set.
-      #
-      # @since 3.0.15
-      def __client__
-        if command[:out][:inline] != 1
-          # @todo: close
-          client.with(read: { mode: :primary })
-        else
-          client
-        end
+      def validate_out!
+        raise Errors::NoMapReduceOutput.new({}) unless @map_reduce.out
       end
     end
   end

data/lib/mongoid/contextual/memory.rb

@@ -373,6 +373,7 @@ module Mongoid
       #
       # @since 3.0.0
       def apply_options
+        raise Errors::InMemoryCollationNotSupported.new if criteria.options[:collation]
         skip(criteria.options[:skip]).limit(criteria.options[:limit])
       end
 

data/lib/mongoid/contextual/mongo.rb

@@ -18,7 +18,18 @@ module Mongoid
       # Options constant.
       #
       # @since 5.0.0
-      OPTIONS = [ :hint, :limit, :skip, :sort, :batch_size, :max_scan, :snapshot, :comment, :read ].freeze
+      OPTIONS = [ :hint,
+                  :limit,
+                  :skip,
+                  :sort,
+                  :batch_size,
+                  :max_scan,
+                  :snapshot,
+                  :comment,
+                  :read,
+                  :cursor_type,
+                  :collation
+                ].freeze
 
       # @attribute [r] view The Mongo collection view.
       attr_reader :view
@@ -68,9 +79,7 @@ module Mongoid
       #
       # @since 3.0.0
       def delete
-        self.count.tap do
-          view.delete_many
-        end
+        view.delete_many.deleted_count
       end
       alias :delete_all :delete
 
@@ -83,11 +92,10 @@ module Mongoid
       #
       # @since 3.0.0
       def destroy
-        destroyed = self.count
-        each do |doc|
+        each.inject(0) do |count, doc|
           doc.destroy
+          count += 1
         end
-        destroyed
       end
       alias :destroy_all :destroy
 
@@ -551,12 +559,6 @@ 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.
@@ -653,6 +655,7 @@ module Mongoid
       # @since 3.0.0
       def documents_for_iteration
         return documents if cached? && !documents.empty?
+        return view unless eager_loadable?
         docs = view.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
         eager_load(docs)
       end
@@ -670,8 +673,10 @@ module Mongoid
       #
       # @since 3.0.0
       def yield_document(document, &block)
-        yield(document)
-        documents.push(document) if cacheable?
+        doc = document.respond_to?(:_id) ?
+            document : Factory.from_db(klass, document, criteria.options[:fields])
+        yield(doc)
+        documents.push(doc) if cacheable?
       end
     end
   end

data/lib/mongoid/criteria.rb

@@ -193,6 +193,8 @@ module Mongoid
     # @since 1.0.0
     def initialize(klass)
       @klass = klass
+      @embedded = nil
+      @none = nil
       klass ? super(klass.aliased_fields, klass.fields) : super({}, {})
     end
 

data/lib/mongoid/document.rb

@@ -101,6 +101,7 @@ module Mongoid
     #
     # @since 1.0.0
     def initialize(attrs = nil)
+      @__parent = nil
       _building do
         @new_record = true
         @attributes ||= {}

data/lib/mongoid/errors.rb

@@ -5,6 +5,7 @@ require "mongoid/errors/callback"
 require "mongoid/errors/document_not_destroyed"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/eager_load"
+require "mongoid/errors/in_memory_collation_not_supported"
 require "mongoid/errors/invalid_collection"
 require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_field"

data/lib/mongoid/errors/in_memory_collation_not_supported.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting to do a query with a
+    # collation on documents in memory.
+    class InMemoryCollationNotSupported < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new unsupported collation error.
+      #   InMemoryCollationNotSupported.new
+      #
+      # @since 5.2.0
+      def initialize
+        super(compose_message("in_memory_collation_not_supported"))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/mongoid_error.rb

@@ -19,7 +19,7 @@ module Mongoid
       # @return [ String ] The composed message.
       #
       # @since 3.0.0
-      def compose_message(key, attributes)
+      def compose_message(key, attributes = {})
         @problem = translate_problem(key, attributes)
         @summary = translate_summary(key, attributes)
         @resolution = translate_resolution(key, attributes)