mongoid 3.1.7 → 4.0.2

data/lib/mongoid/{indexes.rb → indexable.rb}

@@ -1,13 +1,19 @@
 # encoding: utf-8
-require "mongoid/indexes/validators/options"
+require "mongoid/indexable/specification"
+require "mongoid/indexable/validators/options"
+require "ostruct"
 
 module Mongoid
-  module Indexes
+
+  # Encapsulates behaviour around defining indexes.
+  #
+  # @since 4.0.0
+  module Indexable
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :index_options
-      self.index_options = {}
+      cattr_accessor :index_specifications
+      self.index_specifications = []
     end
 
     module ClassMethods
@@ -21,13 +27,14 @@ module Mongoid
       #
       # @since 1.0.0
       def create_indexes
-        return unless index_options
-        index_options.each_pair do |spec, options|
+        return unless index_specifications
+        index_specifications.each do |spec|
+          key, options = spec.key, spec.options
           if database = options[:database]
-            with(consistency: :strong, database: database).
-              collection.indexes.create(spec, options.except(:database))
+            with(read: :primary, database: database).
+              collection.indexes.create(key, options.except(:database))
           else
-            with(consistency: :strong).collection.indexes.create(spec, options)
+            with(read: :primary).collection.indexes.create(key, options)
           end
         end and true
       end
@@ -43,7 +50,7 @@ module Mongoid
       # @since 3.0.0
       def remove_indexes
         indexed_database_names.each do |database|
-          collection = with(consistency: :strong, database: database).collection
+          collection = with(read: :primary, database: database).collection
           collection.indexes.each do |spec|
             unless spec["name"] == "_id_"
               collection.indexes.drop(spec["key"])
@@ -62,20 +69,18 @@ module Mongoid
       #
       # @since 1.0.0
       def add_indexes
-        if hereditary? && !index_options[{ _type: 1 }]
-          index({ _type: 1 }, { unique: false, background: true })
+        if hereditary? && !index_keys.include?(_type: 1)
+          index({ _type: 1 }, unique: false, background: true)
         end
         true
       end
 
-      # Adds an index on the field specified. Options can be :unique => true or
-      # :unique => false. It will default to the latter.
+      # Adds an index definition for the provided single or compound keys.
       #
       # @example Create a basic index.
       #   class Person
       #     include Mongoid::Document
       #     field :name, type: String
-
       #     index({ name: 1 }, { background: true })
       #   end
       #
@@ -86,53 +91,29 @@ module Mongoid
       #
       # @since 1.0.0
       def index(spec, options = nil)
-        Validators::Options.validate(self, spec, options || {})
-        index_options[normalize_spec(spec)] = normalize_index_options(options)
-      end
-
-      private
-
-      # Normalize the index options, if any are provided.
-      #
-      # @api private
-      #
-      # @example Normalize the index options.
-      #   Model.normalize_index_options(drop_dups: true)
-      #
-      # @param [ Hash ] options The index options.
-      #
-      # @return [ Hash ] The normalized options.
-      #
-      # @since 3.0.0
-      def normalize_index_options(options)
-        opts = options || {}
-        opts[:dropDups] = opts.delete(:drop_dups) if opts.has_key?(:drop_dups)
-        opts[:bucketSize] = opts.delete(:bucket_size) if opts.has_key?(:bucket_size)
-        if opts.has_key?(:expire_after_seconds)
-          opts[:expireAfterSeconds] = opts.delete(:expire_after_seconds)
+        specification = Specification.new(self, spec, options)
+        if !index_specifications.include?(specification)
+          index_specifications.push(specification)
         end
-        opts
       end
 
-      # Normalize the spec, in case aliased fields are provided.
-      #
-      # @api private
+      # Get an index specification for the provided key.
       #
-      # @example Normalize the spec.
-      #   Model.normalize_spec(name: 1)
+      # @example Get the index specification.
+      #   Model.index_specification(name: 1)
       #
-      # @param [ Hash ] spec The index specification.
+      # @param [ Hash ] key The index key/direction pair.
       #
-      # @return [ Hash ] The normalized specification.
+      # @return [ Specification ] The found specification.
       #
-      # @since 3.0.7
-      def normalize_spec(spec)
-        spec.inject({}) do |normalized, (name, direction)|
-          normalized[database_field_name(name).to_sym] = direction
-          normalized
-        end
+      # @since 4.0.0
+      def index_specification(index_hash)
+        index = OpenStruct.new(fields: index_hash.keys, key: index_hash)
+        index_specifications.detect { |spec| spec == index }
       end
 
+      private
+
       # Get the names of all databases for this model that have index
       # definitions.
       #
@@ -145,10 +126,24 @@ module Mongoid
       #
       # @since 3.1.0
       def indexed_database_names
-        index_options.values.map do |options|
-          options[:database] || database_name
+        index_specifications.map do |spec|
+          spec.options[:database] || database_name
         end.uniq
       end
+
+      # Gets a list of index specification keys.
+      #
+      # @api private
+      #
+      # @example Get the specification key list.
+      #   Model.index_keys
+      #
+      # @return [ Array<Hash> ] The specification keys.
+      #
+      # @since 4.0.0
+      def index_keys
+        index_specifications.map{ |spec| spec.key }
+      end
     end
   end
 end

data/lib/mongoid/{inspection.rb → inspectable.rb}

@@ -1,9 +1,10 @@
 # encoding: utf-8
 module Mongoid
 
-  # Contains the bahviour around inspecting documents via
-  # <tt>Object#inspect</tt>.
-  module Inspection
+  # Contains the bahviour around inspecting documents via inspect.
+  #
+  # @since 4.0.0
+  module Inspectable
 
     # Returns the class name plus its attributes. If using dynamic fields will
     # include those as well.
@@ -12,6 +13,8 @@ module Mongoid
     #   person.inspect
     #
     # @return [ String ] A nice pretty string to look at.
+    #
+    # @since 1.0.0
     def inspect
       inspection = []
       inspection.concat(inspect_fields).concat(inspect_dynamic_fields)
@@ -22,10 +25,14 @@ module Mongoid
 
     # Get an array of inspected fields for the document.
     #
+    # @api private
+    #
     # @example Inspect the defined fields.
     #   document.inspect_fields
     #
     # @return [ String ] An array of pretty printed field values.
+    #
+    # @since 1.0.0
     def inspect_fields
       fields.map do |name, field|
         unless name == "_id"
@@ -37,19 +44,16 @@ module Mongoid
 
     # Get an array of inspected dynamic fields for the document.
     #
+    # @api private
+    #
     # @example Inspect the dynamic fields.
     #   document.inspect_dynamic_fields
     #
     # @return [ String ] An array of pretty printed dynamic field values.
+    #
+    # @since 1.0.0
     def inspect_dynamic_fields
-      if Mongoid.allow_dynamic_fields
-        keys = @attributes.keys - fields.keys - relations.keys - ["_id", "_type"]
-        return keys.map do |name|
-          "#{name}: #{@attributes[name].inspect}"
-        end
-      else
-        []
-      end
+      []
     end
   end
 end

data/lib/mongoid/{callbacks.rb → interceptable.rb}

@@ -2,7 +2,9 @@
 module Mongoid
 
   # This module contains all the callback hooks for Mongoid.
-  module Callbacks
+  #
+  # @since 4.0.0
+  module Interceptable
     extend ActiveSupport::Concern
 
     CALLBACKS = [
@@ -123,7 +125,13 @@ module Mongoid
     # @since 2.3.0
     def run_callbacks(kind, *args, &block)
       cascadable_children(kind).each do |child|
-        unless child.run_callbacks(child_callback_type(kind, child), *args)
+        # This is returning false for some destroy tests on 4.1.0.beta1,
+        # causing them to fail since 4.1.0 expects a block to be passed if the
+        # callbacks for the type are empty. If no block is passed then the nil
+        # return value gets interpreted as false and halts the chain.
+        #
+        # @see https://github.com/rails/rails/blob/master/activesupport/lib/active_support/callbacks.rb#L79
+        if child.run_callbacks(child_callback_type(kind, child), *args) == false
           return false
         end
       end
@@ -168,7 +176,7 @@ module Mongoid
           relation = send(name)
           Array.wrap(relation).each do |child|
             next if children.include?(child)
-            children.add(child) if cascadable_child?(kind, child)
+            children.add(child) if cascadable_child?(kind, child, metadata)
             child.send(:cascadable_children, kind, children)
           end
         end
@@ -187,10 +195,9 @@ module Mongoid
     # @return [ true, false ] If the child should fire the callback.
     #
     # @since 2.3.0
-    def cascadable_child?(kind, child)
-      if kind == :initialize || kind == :find
-        return false
-      end
+    def cascadable_child?(kind, child, metadata)
+      return false if kind == :initialize || kind == :find
+      return false if kind == :validate && metadata.validate?
       child.callback_executable?(kind) ? child.in_callback_state?(kind) : false
     end
 
@@ -250,65 +257,26 @@ module Mongoid
       unless respond_to?(name)
         chain = ActiveSupport::Callbacks::CallbackChain.new(name, {})
         send("_#{kind}_callbacks").each do |callback|
-          chain.push(callback) if callback.kind == place
+          chain.append(callback) if callback.kind == place
         end
-        class_eval <<-EOM
-          def #{name}() #{chain.compile} end
-          protected :#{name}
-        EOM
-      end
-      send(name)
-    end
-
-    class << self
-
-      # Get all callbacks that can be observed.
-      #
-      # @example Get the observables.
-      #   Callbacks.observables
-      #
-      # @return [ Array<Symbol> ] The names of the observables.
-      #
-      # @since 3.1.0
-      def observables
-        CALLBACKS + registered_observables
-      end
 
-      # Get all registered callbacks that can be observed, not included in
-      # Mongoid's defaults.
-      #
-      # @example Get the observables.
-      #   Callbacks.registered_observables
-      #
-      # @return [ Array<Symbol> ] The names of the registered observables.
-      #
-      # @since 3.1.0
-      def registered_observables
-        @registered_observables ||= []
-      end
-    end
-
-    module ClassMethods
-
-      # Set a custom callback as able to be observed.
-      #
-      # @example Set a custom callback as observable.
-      #   class Band
-      #     include Mongoid::Document
-      #
-      #     define_model_callbacks :notification
-      #     observable :notification
-      #   end
-      #
-      # @param [ Array<Symbol> ] args The names of the observable callbacks.
-      #
-      # @since 3.0.1
-      def observable(*args)
-        observables = args.flat_map do |name|
-          [ :"before_#{name}", :"after_#{name}", :"around_#{name}" ]
+        if Gem::Version.new("4.1.0") <= Gem::Version.new(ActiveSupport::VERSION::STRING)
+          self.class.send :define_method, name do
+            runner = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
+            chain.compile.call(runner).value
+          end
+          self.class.send :protected, name
+        else
+          class_eval <<-EOM
+            def #{name}()
+              #{chain.compile}
+            end
+            protected :#{name}
+          EOM
         end
-        Callbacks.registered_observables.concat(observables).uniq
+
       end
+      send(name)
     end
   end
 end

data/lib/mongoid/log_subscriber.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+module Mongoid
+  # A Log subscriber to the moped queries
+  #
+  # @since 4.0.0
+  class LogSubscriber < ActiveSupport::LogSubscriber
+
+    # Log the query operation on moped
+    #
+    # @since 4.0.0
+    def query(event)
+      return unless logger.debug?
+
+      payload = event.payload
+      runtime = ("%.4fms" % event.duration)
+      debug(payload[:prefix], payload[:ops], runtime)
+    end
+
+    def query_cache(event)
+      return unless logger.debug?
+
+      database, collection, selector = event.payload[:key]
+      operation = "%-12s database=%s collection=%s selector=%s" % ["QUERY CACHE", database, collection, selector.inspect]
+      logger.debug operation
+    end
+    # Log the provided operations.
+    #
+    # @example Delegates the operation to moped so it can log it.
+    #   subscriber.debug("MOPED", {}, 30)
+    #
+    # @param [ String ] prefix The prefix for all operations in the log.
+    # @param [ Array ] ops The operations.
+    # @param [ String ] runtime The runtime in formatted ms.
+    #
+    # @since 4.0.0
+    def debug(prefix, operations, runtime)
+      Moped::Loggable.log_operations(prefix, operations, runtime)
+    end
+
+    # Get the logger.
+    #
+    # @example Get the logger.
+    #   subscriber.logger
+    #
+    # @return [ Logger ] The logger.
+    #
+    # @since 4.0.0
+    def logger
+      Moped.logger
+    end
+  end
+end
+
+Mongoid::LogSubscriber.attach_to :moped
+Mongoid::LogSubscriber.attach_to :mongoid

data/lib/mongoid/{matchers → matchable}/all.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Checks that all values match.
     class All < Default

data/lib/mongoid/{matchers → matchable}/and.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Defines behavior for handling $or expressions in embedded documents.
     class And < Default
@@ -20,7 +20,7 @@ module Mongoid
           condition.keys.each do |k|
             key = k
             value = condition[k]
-            return false unless Strategies.matcher(document, key, value).matches?(value)
+            return false unless Matchable.matcher(document, key, value).matches?(value)
           end
         end
         true

data/lib/mongoid/{matchers → matchable}/default.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Contains all the default behavior for checking for matching documents
     # given MongoDB expressions.

data/lib/mongoid/{matchers → matchable}/exists.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Checks for existance.
     class Exists < Default

data/lib/mongoid/{matchers → matchable}/gt.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs Greater Than matching.
     class Gt < Default

data/lib/mongoid/{matchers → matchable}/gte.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs Greater than or equal to matching.
     class Gte < Default

data/lib/mongoid/{matchers → matchable}/in.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs matching for any value in an array.
     class In < Default
@@ -14,7 +14,7 @@ module Mongoid
       #
       # @return [ true, false ] If a value exists.
       def matches?(value)
-        attribute_array = Array.wrap(@attribute)
+        attribute_array = @attribute.nil? ? [nil] : Array.wrap(@attribute)
         value.values.first.any? do |e|
           attribute_array.any? { |_attribute| e === _attribute }
         end

data/lib/mongoid/{matchers → matchable}/lt.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs less than matching.
     class Lt < Default

data/lib/mongoid/{matchers → matchable}/lte.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs less than or equal to matching.
     class Lte < Default

data/lib/mongoid/{matchers → matchable}/ne.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs non-equivalency checks.
     class Ne < Default

data/lib/mongoid/{matchers → matchable}/nin.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs not in checking.
     class Nin < Default
@@ -14,7 +14,8 @@ module Mongoid
       #
       # @return [ true, false ] If a value exists.
       def matches?(value)
-        Array.wrap(@attribute).none? { |e| value.values.first.include?(e) }
+        attribute_array = @attribute.nil? ? [nil] : Array.wrap(@attribute)
+        attribute_array.none? { |e| value.values.first.include?(e) }
       end
     end
   end

data/lib/mongoid/{matchers → matchable}/or.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Defines behavior for handling $or expressions in embedded documents.
     class Or < Default
@@ -21,7 +21,7 @@ module Mongoid
           condition.keys.each do |k|
             key = k
             value = condition[k]
-            res &&= Strategies.matcher(document, key, value).matches?(value)
+            res &&= Matchable.matcher(document, key, value).matches?(value)
             break unless res
           end
           return res if res

data/lib/mongoid/{matchers → matchable}/size.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Matchers
+  module Matchable
 
     # Performs size checking.
     class Size < Default