mongoid 5.4.1 → 6.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6193f790b2f66cf1e0632b9900555f6f5b36f9e519f01aa64c6286a58a2642f1
-  data.tar.gz: 76559818003d501dd396d74bc7a1ef08b6617bcf09e64b8e5953cc5bdcac468b
+SHA1:
+  metadata.gz: 57db37f3ffe123d41531a6c93d9ae52e37cb81d2
+  data.tar.gz: bdd70c57cb017f481fa796c8a86dc34599c1a05c
 SHA512:
-  metadata.gz: baa3aa0cbbf678a1d9c9ee2d029e32cab1701e3f6c40c464ec711b154dda2c4d6eb635a25a8604559a7deaa57e3dc35a18620595b1eadd3fcdda6e8fe7456660
-  data.tar.gz: 61f0d82599f9053fb107de7b19dfdab43d92e42fcc2a83582ee8dd651e8b707f16ed55667cbd82be92fbb697a52093053452f4fa5c2148ad8fedeacd5f609201
+  metadata.gz: 7c6b4a55f532af6dfd8c2593bb8bd05244a5916235ed9512487b7d45952e37a06e9eb50f61958d4b63da826d9631ca6422e0febb638da45e122246ead03e1461
+  data.tar.gz: 15cbe1acb92704217bb2f2f084d14c076dce7c6c7aa5afcd6955f724825f2e6e72a89c6e0c62170c4ba4d60d04866052ce041d37ee3ea4f1be8a4d15d38070b9

data/lib/config/locales/en.yml

@@ -76,12 +76,6 @@ 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
@@ -121,7 +115,10 @@ en:
         invalid_includes:
           message: "Invalid includes directive: %{klass}.includes(%{args})"
           summary: "Eager loading in Mongoid only supports providing arguments
-            to %{klass}.includes that are the names of relations on the %{klass}."
+            to %{klass}.includes that are the names of relations on the %{klass}
+            model, and only supports one level of eager loading. (ie, eager loading
+            associations not on the %{klass} but one step away via another relation
+            is not allowed."
           resolution: "Ensure that each parameter passed to %{klass}.includes is
             a valid name of a relation on the %{klass} model. These are: %{relations}."
         invalid_index:
@@ -140,18 +137,9 @@ 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
@@ -177,6 +165,25 @@ en:
             collection. Double check the relation definitions and fix any
             instances where embedded documents are improperly referenced
             from other collections."
+        invalid_persistence_option:
+          message: "Invalid persistence option :%{invalid}."
+          summary: "The options used to change the persistence context must be one
+             of the valid options for a mongo client, or a collection name."
+          resolution: "Valid options are: %{valid}, make sure these are the ones
+             you are using."
+        invalid_relation:
+          message: "Defining a relation named '%{name}' is not allowed."
+          summary: "Defining this relation would override the method '%{name}',
+            which would cause issues with expectations around the original
+            method and cause extremely hard to debug issues. The original
+            method was defined in:\n
+            \_\_Object: %{origin}\n
+            \_\_File: %{file}\n
+            \_\_Line: %{line}"
+          resolution: "Use Mongoid.destructive_fields to see what names are not
+            allowed, and don't use these names. These include names that also
+            conflict with core Ruby methods on Object, Module, Enumerable, or
+            included gems that inject methods into these or Mongoid internals."
         invalid_scope:
           message: "Defining a scope of value %{value} on %{klass} is not
             allowed."

data/lib/mongoid.rb

@@ -12,11 +12,11 @@ require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
 
-require "origin"
 require "mongo"
 
 require "mongoid/version"
 require "mongoid/config"
+require "mongoid/persistence_context"
 require "mongoid/loggable"
 require "mongoid/clients"
 require "mongoid/document"
@@ -36,11 +36,6 @@ 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"
 
@@ -65,7 +60,7 @@ module Mongoid
   #
   # @return [ Mongo::Client ] The default client.
   #
-  # @since 3.0.0
+  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -77,7 +72,7 @@ module Mongoid
   #
   # @return [ true ] True.
   #
-  # @since 3.1.0
+  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -89,7 +84,7 @@ module Mongoid
   #
   # @return [ Mongo::Client ] The named client.
   #
-  # @since 3.0.0
+  # @since 5.0.0
   def client(name)
     Clients.with_name(name)
   end

data/lib/mongoid/atomic.rb

@@ -31,7 +31,7 @@ module Mongoid
     # @example Add the atomic pull.
     #   person.add_atomic_pull(address)
     #
-    # @param [ Document ] document The embedded document to pull.
+    # @param [ Document ] The embedded document to pull.
     #
     # @since 2.2.0
     def add_atomic_pull(document)

data/lib/mongoid/atomic/modifiers.rb

@@ -68,7 +68,7 @@ module Mongoid
         modifications.each_pair do |field, value|
           push_fields[field] = field
           mods = push_conflict?(field) ? conflicting_pushes : pushes
-          add_operation(mods, field, {'$each' => Array.wrap(value)})
+          add_operation(mods, field, Array.wrap(value))
         end
       end
 
@@ -118,12 +118,8 @@ module Mongoid
       # @since 2.2.0
       def add_operation(mods, field, value)
         if mods.has_key?(field)
-          if mods[field].is_a?(Array)
-            value.each do |val|
-              mods[field].push(val)
-            end
-          elsif mods[field]['$each']
-            mods[field]['$each'].concat(value['$each']) 
+          value.each do |val|
+            mods[field].push(val)
           end
         else
           mods[field] = value
@@ -194,7 +190,7 @@ module Mongoid
       #
       # @since 2.2.0
       def conflicting_pushes
-        conflicts["$push"] ||= {}
+        conflicts["$pushAll"] ||= {}
       end
 
       # Get the conflicting set modifications.
@@ -281,16 +277,16 @@ module Mongoid
         self["$pull"] ||= {}
       end
 
-      # Get the $push/$each operations or initialize a new one.
+      # Get the $pushAll operations or intialize a new one.
       #
-      # @example Get the $push/$each operations.
+      # @example Get the $pushAll operations.
       #   modifiers.pushes
       #
-      # @return [ Hash ] The $push/$each operations.
+      # @return [ Hash ] The $pushAll operations.
       #
       # @since 2.1.0
       def pushes
-        self["$push"] ||= {}
+        self["$pushAll"] ||= {}
       end
 
       # Get the $set operations or intialize a new one.

data/lib/mongoid/attributes.rb

@@ -139,14 +139,12 @@ module Mongoid
     #
     # @since 1.0.0
     def remove_attribute(name)
-      access = name.to_s
-      unless attribute_writable?(name)
-        raise Errors::ReadonlyAttribute.new(name, :nil)
-      end
-      _assigning do
-        attribute_will_change!(access)
-        delayed_atomic_unsets[atomic_attribute_name(access)] = [] unless new_record?
-        attributes.delete(access)
+      as_writable_attribute!(name) do |access|
+        _assigning do
+          attribute_will_change!(access)
+          delayed_atomic_unsets[atomic_attribute_name(access)] = [] unless new_record?
+          attributes.delete(access)
+        end
       end
     end
 
@@ -165,8 +163,7 @@ module Mongoid
     #
     # @since 1.0.0
     def write_attribute(name, value)
-      access = database_field_name(name.to_s)
-      if attribute_writable?(access)
+      as_writable_attribute!(name) do |access|
         _assigning do
           validate_attribute_value(access, value)
           localized = fields[access].try(:localized?)
@@ -218,6 +215,7 @@ module Mongoid
     #   person.attributes = { :title => "Mr." }
     #
     # @param [ Hash ] attrs The new attributes to set.
+    # @param [ Boolean ] guard_protected_attributes False to skip mass assignment protection.
     #
     # @since 1.0.0
     def write_attributes(attrs = nil)
@@ -331,7 +329,7 @@ module Mongoid
     # the value is valid for given a field.
     # For now, only Hash and Array fields are validated.
     #
-    # @param [ String, Symbol ] access The name of the attribute to validate.
+    # @param [ String, Symbol ] name The name of the attribute to validate.
     # @param [ Object ] value The to be validated.
     #
     # @since 3.0.10

data/lib/mongoid/attributes/dynamic.rb

@@ -13,8 +13,7 @@ module Mongoid
       # @example Does this object respond to the method?
       #   person.respond_to?(:title)
       #
-      # @param [ Array ] name The name of the method.
-      # @param [ true, false ] include_private
+      # @param [ Array ] *args The name of the method.
       #
       # @return [ true, false ] True if it does, false if not.
       #
@@ -38,7 +37,7 @@ module Mongoid
       # @since 4.0.0
       def define_dynamic_reader(name)
         return unless name.valid_method_name?
-        class_eval <<-READER, __FILE__, __LINE__ + 1
+        class_eval <<-READER
           def #{name}
             attribute_will_change!(#{name.inspect})
             read_attribute(#{name.inspect})
@@ -57,7 +56,7 @@ module Mongoid
       #
       # @since 4.0.0
       def define_dynamic_before_type_cast_reader(name)
-        class_eval <<-READER, __FILE__, __LINE__ + 1
+        class_eval <<-READER
           def #{name}_before_type_cast
             attribute_will_change!(#{name.inspect})
             read_attribute_before_type_cast(#{name.inspect})
@@ -78,7 +77,7 @@ module Mongoid
       def define_dynamic_writer(name)
         return unless name.valid_method_name?
 
-        class_eval <<-WRITER, __FILE__, __LINE__ + 1
+        class_eval <<-WRITER
           def #{name}=(value)
             write_attribute(#{name.inspect}, value)
           end
@@ -127,7 +126,7 @@ module Mongoid
       #   document.method_missing(:test)
       #
       # @param [ String, Symbol ] name The name of the method.
-      # @param [ Array ] args The arguments to the method.
+      # @param [ Array ] *args The arguments to the method.
       #
       # @return [ Object ] The result of the method call.
       #

data/lib/mongoid/attributes/nested.rb

@@ -34,7 +34,7 @@ module Mongoid
         #     accepts_nested_attributes_for :addresses, :game, :posts
         #   end
         #
-        # @param [ Array<Symbol>, Hash ] args A list of relation names, followed
+        # @param [ Array<Symbol>, Hash ] *args A list of relation names, followed
         #   by a hash of options.
         #
         # @option *args [ true, false ] :allow_destroy Can deletion occur?

data/lib/mongoid/attributes/processing.rb

@@ -118,6 +118,8 @@ module Mongoid
       # @example Process the pending items.
       #   document.process_pending
       #
+      # @param [ Hash ] options The mass assignment options.
+      #
       # @since 2.0.0.rc.7
       def process_pending
         process_nested and process_relations
@@ -130,6 +132,8 @@ module Mongoid
       # @example Process the relations.
       #   document.process_relations
       #
+      # @param [ Hash ] options The mass assignment options.
+      #
       # @since 2.0.0.rc.7
       def process_relations
         pending_relations.each_pair do |name, value|

data/lib/mongoid/attributes/readonly.rb

@@ -22,10 +22,32 @@ module Mongoid
       #   readonly.
       #
       # @since 3.0.0
+      #
+      # @deprecated Use #as_writable_attribute! instead.
       def attribute_writable?(name)
         new_record? || !readonly_attributes.include?(database_field_name(name))
       end
 
+      private
+
+      def as_writable_attribute!(name, value = :nil)
+        normalized_name = database_field_name(name)
+        if new_record? || (!readonly_attributes.include?(normalized_name) && loaded?(normalized_name))
+          yield(normalized_name)
+        else
+          raise Errors::ReadonlyAttribute.new(name, value)
+        end
+      end
+
+      def loaded?(name)
+        __selected_fields.nil? || projected_field?(name)
+      end
+
+      def projected_field?(name)
+        projected = (__selected_fields || {}).keys.select { |f| __selected_fields[f] == 1 }
+        projected.empty? || projected.include?(name)
+      end
+
       module ClassMethods
 
         # Defines an attribute as readonly. This will ensure that the value for

data/lib/mongoid/cacheable.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Mongoid
+
+  # Encapsulates behaviour around caching.
+  #
+  # @since 6.0.0
+  module Cacheable
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :cache_timestamp_format, instance_writer: false
+      self.cache_timestamp_format = :nsec
+    end
+
+    # Print out the cache key. This will append different values on the
+    # plural model name.
+    #
+    # If new_record?     - will append /new
+    # If not             - will append /id-updated_at.to_s(cache_timestamp_format)
+    # Without updated_at - will append /id
+    #
+    # This is usually called insode a cache() block
+    #
+    # @example Returns the cache key
+    #   document.cache_key
+    #
+    # @return [ String ] the string with or without updated_at
+    #
+    # @since 2.4.0
+    def cache_key
+      return "#{model_key}/new" if new_record?
+      return "#{model_key}/#{id}-#{updated_at.utc.to_s(cache_timestamp_format)}" if do_or_do_not(:updated_at)
+      "#{model_key}/#{id}"
+    end
+  end
+end

data/lib/mongoid/changeable.rb

@@ -265,7 +265,7 @@ module Mongoid
       #   Model.create_dirty_methods("name", "name")
       #
       # @param [ String ] name The name of the field.
-      # @param [ String ] meth The name of the accessor.
+      # @param [ String ] name The name of the accessor.
       #
       # @return [ Module ] The fields module.
       #
@@ -278,6 +278,8 @@ module Mongoid
         create_dirty_previous_value_accessor(name, meth)
         create_dirty_reset(name, meth)
         create_dirty_reset_to_default(name, meth)
+        create_dirty_previously_changed?(name, meth)
+        create_dirty_previous_change(name, meth)
       end
 
       # Creates the dirty change accessor.
@@ -398,6 +400,40 @@ module Mongoid
           end
         end
       end
+
+      # Creates the dirty change check.
+      #
+      # @example Create the dirty change check.
+      #   Model.create_dirty_previously_changed?("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 6.0.0
+      def create_dirty_previously_changed?(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_previously_changed?") do
+            previous_changes.keys.include?(name)
+          end
+        end
+      end
+
+      # Creates the dirty change accessor.
+      #
+      # @example Create the dirty change accessor.
+      #   Model.create_dirty_previous_change("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 6.0.0
+      def create_dirty_previous_change(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_previous_change") do
+            previous_changes[name]
+          end
+        end
+      end
     end
   end
 end