mongoid 5.4.0 → 6.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08c29d43d146e27e4060d618a847e86dce00eb9ed09ccc040176bb36607c85d8'
-  data.tar.gz: 36e253fc8ba8ee3b873d3b86b644134a71927761ae6b3d3ee87681815552a22d
+  metadata.gz: b8c453904dce4061c6cd88c36e21f3514fb778b37976ffd12e985aaf80fc2b98
+  data.tar.gz: d10421a146387851daa6a9c27184b48da1cc50d96a946bce0851aa69fd56c9a5
 SHA512:
-  metadata.gz: 628fe19e7e6e0472e18d640d807c4aa611da9da1944992ee828717acf82d0d84f35891fcd149bf48d3fe12617e44c1d840323b6d014705d5f6691ff3e54ddbcb
-  data.tar.gz: 5ca94d2eff2fc0249af67f84ed337fcee8a6c433e5b2c16b51a25304226960e33ef3b3f634ba96b382f6277d39b4797298af969e1560b4ead3ed308c2272c222
+  metadata.gz: 6c0e672470d68faab3afc70e65524baa771801b46bbbb51b831a5cc709baf6df4ed7f0d81aed2dd5d0c3e3cf6730166da9bc8345b33577298f4438ec6c11fca3
+  data.tar.gz: 2008465437ba6eafe50235b22204df40b560b8e3bd27d064e97912c3249f5443af2ad1016c9a545d9d487abc6c1b38835624090a6d9165d06f9c4e676b561a23

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/Rakefile

@@ -1,4 +1,5 @@
 require "bundler"
+require "bundler/gem_tasks"
 Bundler.setup
 
 require "rake"
@@ -7,6 +8,9 @@ require "rspec/core/rake_task"
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "mongoid/version"
 
+tasks = Rake.application.instance_variable_get('@tasks')
+tasks['release:do'] = tasks.delete('release')
+
 task :gem => :build
 task :build do
   system "gem build mongoid.gemspec"
@@ -33,3 +37,25 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
 end
 
 task :default => :spec
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('yard-docs', Mongoid::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title mongoid-#{Mongoid::VERSION}"
+  end
+end
+
+namespace :release do
+  task :check_private_key do
+    unless File.exist?('gem-private_key.pem')
+      raise "No private key present, cannot release"
+    end
+  end
+end
+
+task :release => ['release:check_private_key', 'release:do']

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."
@@ -187,6 +206,20 @@ en:
             \_\_\_\_include Mongoid::Document\n
             \_\_\_\_scope :inactive, ->{ where(active: false) }\n
             \_\_end\n\n"
+        invalid_session_use:
+          message: "A session was attempted to be used with a model whose client cannot use
+            that session."
+          summary: "Sessions are started via driver clients (Model#mongo_client) and, in most cases, driver
+            clients are shared across models. When different models have their own clients, a session cannot
+            be obtained via one model and used for operations on another model."
+          resolution: "Only execute operations on the model class or instances of the model through which
+            the session was created. Otherwise, ensure that all models on which operations are executed
+            in the session block share the same driver client. For example, a model may have a different
+            client specified in its 'store_in' options.\n\n"
+        invalid_session_nesting:
+          message: "A session was started while another session was being used."
+          summary: "Sessions cannot be nested. Only one session can be used in a thread at once."
+          resolution: "Only use one session at a time; sessions cannot be nested."
         invalid_storage_options:
           message: "Invalid options passed to %{klass}.store_in: %{options}."
           summary: "The :store_in macro takes only a hash of parameters with
@@ -433,6 +466,13 @@ en:
             with the already defined method %{model_name}, or set the
             configuration option Mongoid.scope_overwrite_exception to false,
             which is its default. In this case a warning will be logged."
+        sessions_not_supported:
+          message: "Sessions are not supported by the connected server(s)."
+          summary: "A session was attempted to be used with a MongoDB server version
+            that doesn't support sessions. Sessions are supported in MongoDB
+            server versions 3.6 and higher."
+          resolution: "Verify that all servers in your deployment are at least
+            version 3.6 or don't attempt to use sessions with older server versions."
         taken:
           "is already taken"
         too_many_nested_attribute_records:

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, { '$each' => Array.wrap(value) })
         end
       end
 
@@ -123,7 +123,7 @@ module Mongoid
               mods[field].push(val)
             end
           elsif mods[field]['$each']
-            mods[field]['$each'].concat(value['$each']) 
+            mods[field]['$each'].concat(value['$each'])
           end
         else
           mods[field] = value

data/lib/mongoid/atomic.rb

@@ -110,10 +110,10 @@ module Mongoid
     #   performed in a single operation. Conflicting modifications are
     #   detected by the 'haveConflictingMod' function in MongoDB.
     #   Examination of the code suggests that two modifications (a $set
-    #   and a $pushAll, for example) conflict if:
+    #   and a $push with $each, for example) conflict if:
     #     (1) the key paths being modified are equal.
     #     (2) one key path is a prefix of the other.
-    #   So a $set of 'addresses.0.street' will conflict with a $pushAll
+    #   So a $set of 'addresses.0.street' will conflict with a $push and $each
     #   to 'addresses', and we will need to split our update into two
     #   pieces. We do not, however, attempt to match MongoDB's logic
     #   exactly. Instead, we assume that two updates conflict if the
@@ -218,11 +218,11 @@ module Mongoid
     # @example Get the pushes.
     #   person.atomic_pushes
     #
-    # @return [ Hash ] The $pushAll operations.
+    # @return [ Hash ] The The $push and $each operations.
     #
     # @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/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/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/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