mongoid 5.4.1 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6193f790b2f66cf1e0632b9900555f6f5b36f9e519f01aa64c6286a58a2642f1
-  data.tar.gz: 76559818003d501dd396d74bc7a1ef08b6617bcf09e64b8e5953cc5bdcac468b
+SHA1:
+  metadata.gz: 8df15f3d764e3c19bcc5719c656f833ce258bb65
+  data.tar.gz: 335173b371125d1e84100af19293bccf459df5b8
 SHA512:
-  metadata.gz: baa3aa0cbbf678a1d9c9ee2d029e32cab1701e3f6c40c464ec711b154dda2c4d6eb635a25a8604559a7deaa57e3dc35a18620595b1eadd3fcdda6e8fe7456660
-  data.tar.gz: 61f0d82599f9053fb107de7b19dfdab43d92e42fcc2a83582ee8dd651e8b707f16ed55667cbd82be92fbb697a52093053452f4fa5c2148ad8fedeacd5f609201
+  metadata.gz: e6fabe8ac17c05be402c8dd42bff52a4158e0a0d0650cd36363a7439ea19e32d0a3b28427b85fb88749df2941d2ba5fa4c639aa74f9b70ef0e4875acd4438ae6
+  data.tar.gz: 40cf34caa79067109baeee5b434f8e2497c654a91248a73a220ac1ded8d685fbc3ea13adaa0e4335246af64f09ed4942848b5b3e6beacb966ae7f7250c655ac8

data/README.md

@@ -21,17 +21,17 @@ Project Tracking
 Compatibility
 -------------
 
-Mongoid is tested against MRI 1.9.3, 2.0.0, 2.1.0. 2.2.0 and JRuby (1.9).
+Mongoid is tested against MRI 2.2, 2.3 and JRuby (9.1).
 
 Documentation
 -------------
 
-Please see the [MongoDB website](http://docs.mongodb.org/ecosystem/tutorial/ruby-mongoid-tutorial/#ruby-mongoid-tutorial) for up-to-date documentation on 5.0.0:
+Please see the [MongoDB website](http://docs.mongodb.org/ecosystem/tutorial/ruby-mongoid-tutorial/#ruby-mongoid-tutorial) for up-to-date documentation.
 
 License
 -------
 
-Copyright (c) 2009-2016 Durran Jordan
+Copyright (c) 2009-2017 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/config/locales/en.yml

@@ -177,6 +177,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"
@@ -65,7 +65,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 +77,7 @@ module Mongoid
   #
   # @return [ true ] True.
   #
-  # @since 3.1.0
+  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -89,7 +89,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

@@ -222,7 +222,7 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_pushes
-      pushable? ? { atomic_position => as_document } : {}
+      pushable? ? { atomic_position => as_attributes } : {}
     end
 
     # Get all the attributes that need to be set.
@@ -234,7 +234,7 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_sets
-      updateable? ? setters : settable? ? { atomic_path => as_document } : {}
+      updateable? ? setters : settable? ? { atomic_path => as_attributes } : {}
     end
 
     # Get all the attributes that need to be unset.

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?)
@@ -244,22 +241,26 @@ module Mongoid
         (selection.values.first == 1 && !selection_included?(name, selection, field))
     end
 
+    # Return type-casted attributes.
+    #
+    # @example Type-casted attributes.
+    #   document.typed_attributes
+    #
+    # @return [ Object ] The hash with keys and values of the type-casted attributes.
+    #
+    # @since 6.1.0
+    def typed_attributes
+      attribute_names.map { |name| [name, send(name)] }.to_h
+    end
+
     private
 
     def selection_excluded?(name, selection, field)
-      if field && field.localized?
-        selection["#{name}.#{::I18n.locale}"] == 0
-      else
-        selection[name] == 0
-      end
+      selection[name] == 0
     end
 
     def selection_included?(name, selection, field)
-      if field && field.localized?
-        selection.key?("#{name}.#{::I18n.locale}")
-      else
-        selection.key?(name) || selection.keys.collect { |k| k.partition('.').first }.include?(name)
-      end
+      selection.key?(name) || selection.keys.collect { |k| k.partition('.').first }.include?(name)
     end
 
     # Does the string contain dot syntax for accessing hashes?
@@ -346,7 +347,7 @@ module Mongoid
     end
 
     def lookup_attribute_presence(name, value)
-      if localized_fields.has_key?(name)
+      if localized_fields.has_key?(name) && value
         value = localized_fields[name].send(:lookup, value)
       end
       value.present?

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

@@ -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

data/lib/mongoid/clients.rb

@@ -2,14 +2,12 @@
 require "mongoid/clients/factory"
 require "mongoid/clients/validators"
 require "mongoid/clients/storage_options"
-require "mongoid/clients/thread_options"
 require "mongoid/clients/options"
 
 module Mongoid
   module Clients
     extend ActiveSupport::Concern
     include StorageOptions
-    include ThreadOptions
     include Options
 
     class << self
@@ -35,7 +33,7 @@ module Mongoid
       #
       # @since 3.0.0
       def default
-        clients[:default] ||= Clients::Factory.default
+        with_name(:default)
       end
 
       # Disconnect all active clients.
@@ -63,7 +61,11 @@ module Mongoid
       #
       # @since 3.0.0
       def with_name(name)
-        clients[name.to_sym] ||= Clients::Factory.create(name)
+        name_as_symbol = name.to_sym
+        return clients[name_as_symbol] if clients[name_as_symbol]
+        CREATE_LOCK.synchronize do
+          clients[name_as_symbol] ||= Clients::Factory.create(name)
+        end
       end
 
       def set(name, client)
@@ -73,67 +75,10 @@ module Mongoid
       def clients
         @clients ||= {}
       end
-    end
-
-    # Get the collection for this model from the client. Will check for an
-    # overridden collection name from the store_in macro or the collection
-    # with a pluralized model name.
-    #
-    # @example Get the model's collection.
-    #   Model.collection
-    #
-    # @return [ Mongo::Collection ] The collection.
-    #
-    # @since 3.0.0
-    def collection
-      mongo_client[collection_name]
-    end
 
-    def mongo_client
-      super || self.class.mongo_client
-    end
+      private
 
-    def collection_name
-      super || self.class.collection_name
-    end
-
-    module ClassMethods
-
-      # Get the client for this model. This is determined in the following order:
-      #
-      #   1. Any custom configuration provided by the 'store_in' macro.
-      #   2. The 'default' client as provided in the mongoid.yml
-      #
-      # @example Get the client.
-      #   Model.mongo_client
-      #
-      # @return [ Mongo::Client ] The default mongo client.
-      #
-      # @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)
-          opts.reject! { |k, v| !Mongo::Client::VALID_OPTIONS.include?(k.to_sym) }
-        end
-        opts.merge!(database: database_name) unless client.database.name.to_sym == database_name.to_sym
-        client.with(opts)
-      end
-
-      # Get the collection for this model from the client. Will check for an
-      # overridden collection name from the store_in macro or the collection
-      # with a pluralized model name.
-      #
-      # @example Get the model's collection.
-      #   Model.collection
-      #
-      # @return [ Mongo::Collection ] The collection.
-      #
-      # @since 3.0.0
-      def collection
-        mongo_client[collection_name]
-      end
+      CREATE_LOCK = Mutex.new
     end
   end
 end