mongoid 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5340f453822e7cbecd2710795296c23db607d92
-  data.tar.gz: 0adcfd1449d91980fb45bb60aa336e661b1482f9
+  metadata.gz: add22f9a2555b543be72f205bad6bc0baa3f00c5
+  data.tar.gz: e5e3472e31f1f826a4ad7cd0e2607aeef72a4adc
 SHA512:
-  metadata.gz: 9b1733f089831c0b58049cb486a8c13687f16a0845d2d9eb2acfb8c5aa0c99de3bbe3a81d6ab0bae0be9c8e4493c77864d64626b341565b5be8f7d695fb93acc
-  data.tar.gz: 1c7a4d343e583880595366b2f4afcb58a8d0f763c8a3bc5f04cea4134d1fb947f420d3ce7cb9b070902a0fd50cd03e71c1c4188c7f349a0e591774435b6a9908
+  metadata.gz: 6349535d149183db9330fa3469e8ad25a119e3bb78545046f0cf44e1de7c75be8ca3f1785aeb387856d2ab7d50e079a17dc3328c3a8fe4d26cf1332923a3a994
+  data.tar.gz: 78fecf90c0308eb831ace2022c9acd4ac817b3b4080332a8207c31db0aeafd1d683b4ce30257e99bfe20e1745215d9789d6c88e5a99c05e847d76f77e5f429f9

data/CHANGELOG.md

@@ -3,7 +3,72 @@
 For instructions on upgrading to newer versions, visit
 [mongoid.org](http://mongoid.org/en/mongoid/docs/upgrading.html).
 
-## 4.0.3 - Not released
+## 5.0.0 - Not released
+
+### Major Changes (Backwards Incompatible)
+
+* Mongoid now uses the official Mongo Ruby Driver 2.x instead of Moped.
+
+* Most driver specific configuration options have changed, please see [here](http://docs.mongodb.org/ecosystem/tutorial/ruby-driver-tutorial/#ruby-options) for the new options.
+
+* All references to `session` are now replaced with `client`. This includes the mongoid.yml configuration, `store_in` options, and all exceptions and modules with `Session` in the name.
+
+* `find_and_modify` has been removed and replaced with 3 options: `find_one_and_update`, `find_one_and_delete` and `find_one_and_replace`.
+
+* `text_search` has been removed as it is now a `$text` option in a query from 2.6 on.
+
+* Mongoid no longer supports MongoDB 2.2 - support is now for only 2.4 and higher.
+
+* \#3768 `first` and `last` no longer add an `_id` sort when no sorting options have been provided. In order to guarantee that a document is the first or last, it needs to now contain an explicit sort.
+
+* `Document#deleted?` alias has been removed, please continue to use `Document#destroyed?`.
+
+### New Features
+
+* \#4016 Allow private and protected setters on fields for atomic operations. (Rob Smith)
+
+* \#3985 Return nil when using `{upsert: true}` in `find_and_modify` (Adrien Siami)
+
+* \#3963 Allow extended JSON object ids to be passed to `find`.
+
+* \#3846 Allow #pluck when none is used in criteria. (Braulio Martinez)
+
+### Resolved Issues
+
+* \#4091 Use sublcass context when calling a scope defined in a superclass. (Edgars Beigarts)
+
+* \#4075 Made remove index logging specific to each index that was actually getting removed.
+
+* \#4071 Fixed loading of enumerable relation to check the added documents when iterating.
+
+* \#4077 Many relations now include Enumerable.
+
+* \#4052 Fixed uniqueness validation on localized fields with no value.
+
+* \#4033 Removed all uses of the $ positional operator in atomic updates.
+
+* \#4030 Dup/clone exceptions auto-include dynamic attributes.
+
+* \#4005 Fixed inclusion of mongoid with Rails components that don't have the Rails environment.
+
+* \#3993 Fixes issue where `dup`/`clone` fails for embedded documents that use store_as without using Mongoid::Atributes::Dynamic
+
+* \#3991 Fixed emebdded documents not flagging as changed after calling #changed? and modifying the
+child elements.
+
+* \#3874 Adding snapshot option to context.
+
+* \#3868 Loading models in rake tasks now expands the rails path.
+
+* \#3764 Fixed case statement check for enumerable targets.
+
+* \#3740 Fixes `Missing attribute: '_id'` error when using methods only or without (dx7)
+
+* \#3631 Fixes issue where `before_save` callback can get called twice after a child create
+
+* \#3599 Fixed application of default scopes from superclass in subclasses.
+
+* \#3104 Fixed enumerable targets to check first/last in proper order.
 
 ## 4.0.2
 

data/README.md

@@ -1,12 +1,16 @@
 # Mongoid
-[![Build Status](https://travis-ci.org/mongoid/mongoid.svg?branch=master)](https://travis-ci.org/mongoid/mongoid) 
-[![Code Climate](https://codeclimate.com/github/mongoid/mongoid.svg)](https://codeclimate.com/github/mongoid/mongoid)
-[![Coverage Status](https://img.shields.io/coveralls/mongoid/mongoid/master.svg)](https://coveralls.io/r/mongoid/mongoid?branch=master)
+[![Build Status](https://travis-ci.org/mongodb/mongoid.svg?branch=master)](https://travis-ci.org/mongodb/mongoid)
+[![Code Climate](https://codeclimate.com/github/mongodb/mongoid.svg)](https://codeclimate.com/github/mongodb/mongoid)
+[![Coverage Status](https://img.shields.io/coveralls/mongodb/mongoid/master.svg)](https://coveralls.io/r/mongodb/mongoid?branch=master)
 [![Dependency Status](https://www.versioneye.com/ruby/mongoid/4.0.0/badge.svg)](https://www.versioneye.com/ruby/mongoid/4.0.0)
 
-
 Mongoid is an ODM (Object-Document-Mapper) framework for MongoDB in Ruby.
 
+Issues
+------
+
+Issues are now in the [Mongoid Jira project](https://jira.mongodb.org/browse/MONGOID/).
+
 Project Tracking
 ----------------
 
@@ -18,29 +22,17 @@ Project Tracking
 Compatibility
 -------------
 
-Mongoid is tested against MRI 1.9.3, 2.0.0, 2.1.0 and JRuby (1.9).
+Mongoid is tested against MRI 1.9.3, 2.0.0, 2.1.0. 2.2.0 and JRuby (1.9).
 
 Documentation
 -------------
 
-Please see the new Mongoid website for up-to-date documentation:
-[mongoid.org](http://mongoid.org)
-
-Donating
---------
-
-[Support Mongoid at Pledgie](http://www.pledgie.com/campaigns/7757)
-
-<a href='http://www.pledgie.com/campaigns/7757'>
-<img alt='Click here to lend your support to: Mongoid and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/7757.png?skin_name=chrome' border='0'/>
-</a>
-
-[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=durran&url=http://github.com/mongoid&title=mongoid&language=&tags=github&category=software)
+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:
 
 License
 -------
 
-Copyright (c) 2009-2013 Durran Jordan
+Copyright (c) 2009-2015 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

@@ -4,6 +4,9 @@ en:
       messages:
         blank_in_locale:
           "can't be blank in %{location}"
+        message_title: "message"
+        summary_title: "summary"
+        resolution_title: "resolution"
         ambiguous_relationship:
           message: "Ambiguous relations %{candidates} defined on %{klass}."
           summary:
@@ -175,7 +178,7 @@ en:
         invalid_storage_options:
           message: "Invalid options passed to %{klass}.store_in: %{options}."
           summary: "The :store_in macro takes only a hash of parameters with
-            the keys :database, :collection, or :session."
+            the keys :database, :collection, or :client."
           resolution: "Change the options passed to store_in to match the
             documented API, and ensure all keys in the options hash are
             symbols.\n\n
@@ -249,9 +252,9 @@ en:
             for each parent up the hierarchy."
           resolution: "Consider not embedding %{embedded}, or do the key
             storage and access in a custom manner in the application code."
-        mixed_session_configuration:
+        mixed_client_configuration:
           message: "Both uri and standard configuration options defined for
-            session: '%{name}'."
+            client: '%{name}'."
           summary: "Instead of simply giving uri or standard options a
             preference order, Mongoid assumes that you have made a mistake in
             your configuration and requires that you provide one or the other,
@@ -276,15 +279,15 @@ en:
             \_\_\_\_has_many :albums\n
             \_\_\_\_accepts_nested_attributes_for :albums\n
             \_\_end\n\n"
-        no_default_session:
-          message: "No default session configuration is defined."
+        no_default_client:
+          message: "No default client configuration is defined."
           summary: "The configuration provided settings for: %{keys}, but
             Mongoid requires a :default to be defined at minimum."
           resolution: "If configuring via a mongoid.yml, ensure that within
-            your :sessions section a :default session is defined.\n\n
+            your :clients section a :default client is defined.\n\n
             Example:\n
             \_\_development:\n
-            \_\_\_\_sessions:\n
+            \_\_\_\_clients:\n
             \_\_\_\_\_\_default:\n
             \_\_\_\_\_\_\_\_hosts:\n
             \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
@@ -338,59 +341,59 @@ en:
           resolution: "Ensure that you've set the parent relation if
             instantiating the embedded document directly, or always create new
             embedded documents via the parent relation."
-        no_session_config:
-          message: "No configuration could be found for a session named
+        no_client_config:
+          message: "No configuration could be found for a client named
             '%{name}'."
-          summary: "When attempting to create the new session, Mongoid could
-            not find a session configuration for the name: '%{name}'. This is
+          summary: "When attempting to create the new client, Mongoid could
+            not find a client configuration for the name: '%{name}'. This is
             necessary in order to know the host, port, and options needed
             to connect."
           resolution: "Double check your mongoid.yml to make sure under the
-            sessions key that a configuration exists for '%{name}'. If you
+            clients key that a configuration exists for '%{name}'. If you
             have set the configuration programatically, ensure that '%{name}'
             exists in the configuration hash."
-        no_sessions_config:
-          message: "No sessions configuration provided."
+        no_clients_config:
+          message: "No clients configuration provided."
           summary: "Mongoid's configuration requires that you provide details
-            about each session that can be connected to, and requires in
-            the sessions config at least 1 default session to exist."
+            about each client that can be connected to, and requires in
+            the clients config at least 1 default client to exist."
           resolution: "Double check your mongoid.yml to make sure that you
-            have a top-level sessions key with at least 1 default session
+            have a top-level clients key with at least 1 default client
             configuration for it. You can regenerate a new mongoid.yml for
             assistance via `rails g mongoid:config`.\n\n
             Example:\n
             \_\_development:\n
-            \_\_\_\_sessions:\n
+            \_\_\_\_clients:\n
             \_\_\_\_\_\_default:\n
             \_\_\_\_\_\_\_\_database: mongoid_dev\n
             \_\_\_\_\_\_\_\_hosts:\n
             \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
-        no_session_database:
-          message: "No database provided for session configuration: :%{name}."
-          summary: "Each session configuration must provide a database so Mongoid
+        no_client_database:
+          message: "No database provided for client configuration: :%{name}."
+          summary: "Each client configuration must provide a database so Mongoid
             knows where the default database to persist to. What was provided
             was: %{config}."
           resolution: "If configuring via a mongoid.yml, ensure that within
-            your :%{name} section a :database value for the session's default
+            your :%{name} section a :database value for the client's default
             database is defined.\n\n
             Example:\n
             \_\_development:\n
-            \_\_\_\_sessions:\n
+            \_\_\_\_clients:\n
             \_\_\_\_\_\_%{name}:\n
             \_\_\_\_\_\_\_\_database: my_app_db\n
             \_\_\_\_\_\_\_\_hosts:\n
             \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
-        no_session_hosts:
-          message: "No hosts provided for session configuration: :%{name}."
-          summary: "Each session configuration must provide hosts so Mongoid
+        no_client_hosts:
+          message: "No hosts provided for client configuration: :%{name}."
+          summary: "Each client configuration must provide hosts so Mongoid
             knows where the database server is located. What was provided
             was: %{config}."
           resolution: "If configuring via a mongoid.yml, ensure that within
-            your :%{name} section a :hosts value for the session hosts is
+            your :%{name} section a :hosts value for the client hosts is
             defined.\n\n
             Example:\n
             \_\_development:\n
-            \_\_\_\_sessions:\n
+            \_\_\_\_clients:\n
             \_\_\_\_\_\_%{name}:\n
             \_\_\_\_\_\_\_\_database: my_app_db\n
             \_\_\_\_\_\_\_\_hosts:\n
@@ -442,8 +445,8 @@ en:
         unsaved_document:
           message: "Attempted to save %{document} before the parent %{base}."
           summary: "You cannot call create or create! through the
-            relation (%{document}) who's parent (%{base}) is
-            not already saved. This would case the database to be out of sync
+            relation (%{document}) whose parent (%{base}) is
+            not already saved. This would cause the database to be out of sync
             since the child could potentially reference a nonexistant parent."
           resolution: "Make sure to only use create or create! when the parent
             document %{base} is persisted."

data/lib/mongoid/atomic.rb

@@ -329,9 +329,7 @@ module Mongoid
     # @since 3.0.10
     def process_flagged_destroys
       _assigning do
-        flagged_destroys.each do |block|
-          block.call
-        end
+        flagged_destroys.each(&:call)
       end
       flagged_destroys.clear
     end
@@ -373,7 +371,7 @@ module Mongoid
     # @since 3.0.6
     def touch_atomic_updates(field = nil)
       updates = atomic_updates
-      return {} unless atomic_updates.has_key?("$set")
+      return {} unless atomic_updates.key?("$set")
       touches = {}
       updates["$set"].each_pair do |key, value|
         touches.merge!({ key => value }) if key =~ /updated_at|#{field}/

data/lib/mongoid/attributes/processing.rb

@@ -92,7 +92,10 @@ module Mongoid
       #
       # @since 2.0.0.rc.7
       def process_attribute(name, value)
-        responds = respond_to?("#{name}=")
+        if !respond_to?("#{name}=", true) && store_as = aliased_fields.invert[name.to_s]
+          name = store_as
+        end
+        responds = respond_to?("#{name}=", true)
         raise Errors::UnknownAttribute.new(self.class, name) unless responds
         send("#{name}=", value)
       end

data/lib/mongoid/attributes/readonly.rb

@@ -23,7 +23,7 @@ module Mongoid
       #
       # @since 3.0.0
       def attribute_writable?(name)
-        new_record? || !readonly_attributes.include?(name.to_s)
+        new_record? || !readonly_attributes.include?(database_field_name(name))
       end
 
       module ClassMethods
@@ -47,7 +47,7 @@ module Mongoid
         # @since 3.0.0
         def attr_readonly(*names)
           names.each do |name|
-            readonly_attributes << name.to_s
+            readonly_attributes << database_field_name(name)
           end
         end
       end

data/lib/mongoid/attributes.rb

@@ -58,7 +58,7 @@ module Mongoid
     #
     # @since 3.0.0
     def has_attribute?(name)
-      attributes.has_key?(name.to_s)
+      attributes.key?(name.to_s)
     end
 
     # Does the document have the provided attribute before it was assigned
@@ -74,7 +74,7 @@ module Mongoid
     #
     # @since 3.1.0
     def has_attribute_before_type_cast?(name)
-      attributes_before_type_cast.has_key?(name.to_s)
+      attributes_before_type_cast.key?(name.to_s)
     end
 
     # Read a value from the document attributes. If the value does not exist
@@ -119,7 +119,7 @@ module Mongoid
     # @since 3.1.0
     def read_attribute_before_type_cast(name)
       attr = name.to_s
-      if attributes_before_type_cast.has_key?(attr)
+      if attributes_before_type_cast.key?(attr)
         attributes_before_type_cast[attr]
       else
         read_attribute(attr)
@@ -256,9 +256,9 @@ module Mongoid
 
     def selection_included?(name, selection, field)
       if field && field.localized?
-        selection.has_key?("#{name}.#{::I18n.locale}")
+        selection.key?("#{name}.#{::I18n.locale}")
       else
-        selection.has_key?(name)
+        selection.key?(name)
       end
     end
 
@@ -273,7 +273,7 @@ module Mongoid
     #
     # @since 3.0.15
     def hash_dot_syntax?(string)
-      string.include?(".")
+      string.include?(".".freeze)
     end
 
     # Return the typecasted value for a field.
@@ -288,7 +288,7 @@ module Mongoid
     #
     # @since 1.0.0
     def typed_value_for(key, value)
-      fields.has_key?(key) ? fields[key].mongoize(value) : value.mongoize
+      fields.key?(key) ? fields[key].mongoize(value) : value.mongoize
     end
 
     module ClassMethods

data/lib/mongoid/changeable.rb

@@ -16,7 +16,7 @@ module Mongoid
     #
     # @since 2.4.0
     def changed
-      changed_attributes.keys
+      changed_attributes.keys.select { |attr| attribute_change(attr) }
     end
 
     # Has the document changed?
@@ -40,9 +40,7 @@ module Mongoid
     #
     # @since 2.4.1
     def children_changed?
-      _children.any? do |child|
-        child.changed?
-      end
+      _children.any?(&:changed?)
     end
 
     # Get the attribute changes.
@@ -184,7 +182,7 @@ module Mongoid
     # @since 2.1.6
     def attribute_changed?(attr)
       attr = database_field_name(attr)
-      return false unless changed_attributes.has_key?(attr)
+      return false unless changed_attributes.key?(attr)
       changed_attributes[attr] != attributes[attr]
     end
 
@@ -228,7 +226,7 @@ module Mongoid
     #
     # @since 2.3.0
     def attribute_will_change!(attr)
-      unless changed_attributes.has_key?(attr)
+      unless changed_attributes.key?(attr)
         changed_attributes[attr] = read_attribute(attr).__deep_copy__
       end
     end

data/lib/mongoid/clients/factory.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module Mongoid
+  module Clients
+    module Factory
+      extend self
+
+      # Create a new client given the named configuration. If no name is
+      # provided, return a new client with the default configuration. If a
+      # name is provided for which no configuration exists, an error will be
+      # raised.
+      #
+      # @example Create the client.
+      #   Factory.create(:secondary)
+      #
+      # @param [ String, Symbol ] name The named client configuration.
+      #
+      # @raise [ Errors::NoClientConfig ] If no config could be found.
+      #
+      # @return [ Mongo::Client ] The new client.
+      #
+      # @since 3.0.0
+      def create(name = nil)
+        return default unless name
+        config = Mongoid.clients[name]
+        raise Errors::NoClientConfig.new(name) unless config
+        create_client(config)
+      end
+
+      # Get the default client.
+      #
+      # @example Get the default client.
+      #   Factory.default
+      #
+      # @raise [ Errors::NoClientConfig ] If no default configuration is
+      #   found.
+      #
+      # @return [ Mongo::Client ] The default client.
+      #
+      # @since 3.0.0
+      def default
+        create_client(Mongoid.clients[:default])
+      end
+
+      private
+
+      # Create the client for the provided config.
+      #
+      # @api private
+      #
+      # @example Create the client.
+      #   Factory.create_client(config)
+      #
+      # @param [ Hash ] configuration The client config.
+      #
+      # @return [ Mongo::Client ] The client.
+      #
+      # @since 3.0.0
+      def create_client(configuration)
+        raise Errors::NoClientsConfig.new unless configuration
+        if configuration[:uri]
+          Mongo::Client.new(configuration[:uri], options(configuration))
+        else
+          Mongo::Client.new(
+            configuration[:hosts],
+            options(configuration).merge(database: configuration[:database])
+          )
+        end
+      end
+
+      def options(configuration)
+        config = configuration.dup
+        options = config.delete(:options) || {}
+        options.reject{ |k, v| k == :hosts }.to_hash.symbolize_keys!
+      end
+    end
+  end
+end

data/lib/mongoid/{sessions → clients}/options.rb

@@ -1,11 +1,12 @@
 # encoding: utf-8
 module Mongoid
-  module Sessions
+  module Clients
     module Options
       extend ActiveSupport::Concern
+      extend Gem::Deprecate
 
       # Tell the next persistance operation to store in a specific collection,
-      # database or session.
+      # database or client.
       #
       # @example Save the current document to a different collection.
       #   model.with(collection: "secondary").save
@@ -13,17 +14,22 @@ module Mongoid
       # @example Save the current document to a different database.
       #   model.with(database: "secondary").save
       #
-      # @example Save the current document to a different session.
-      #   model.with(session: "replica_set").save
+      # @example Save the current document to a different client.
+      #   model.with(client: "replica_set").save
       #
       # @example Save with a combination of options.
-      #   model.with(session: "sharded", database: "secondary").save
+      #   model.with(client: "sharded", database: "secondary").save
+      #
+      # @note This method will instantiate a new client under the covers and
+      #   can be expensive. It is also recommended that the user manually
+      #   closes the extra client after using it, otherwise an excessive amount
+      #   of connections to the server will be eventually opened.
       #
       # @param [ Hash ] options The storage options.
       #
       # @option options [ String, Symbol ] :collection The collection name.
       # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
+      # @option options [ String, Symbol ] :client The client name.
       #
       # @return [ Document ] The current document.
       #
@@ -37,17 +43,19 @@ module Mongoid
         @persistence_options
       end
 
-      def mongo_session
+      def mongo_client
         if persistence_options
-          if persistence_options[:session]
-            session = Sessions.with_name(persistence_options[:session])
+          if persistence_options[:client]
+            client = Clients.with_name(persistence_options[:client])
           else
-            session = Sessions.with_name(self.class.session_name)
-            session.use(self.class.database_name)
+            client = Clients.with_name(self.class.client_name)
+            client.use(self.class.database_name)
           end
-          session.with(persistence_options)
+          client.with(persistence_options.reject{ |k, v| k == :collection || k == :client })
         end
       end
+      alias :mongo_session :mongo_client
+      deprecate :mongo_session, :mongo_client, 2015, 12
 
       def collection_name
         if persistence_options && v = persistence_options[:collection]
@@ -91,14 +99,17 @@ module Mongoid
       end
 
       module ClassMethods
+        extend Gem::Deprecate
         include Threaded
 
-        def session_name
-          if persistence_options && v = persistence_options[:session]
+        def client_name
+          if persistence_options && v = persistence_options[:client]
             return v.to_sym
           end
           super
         end
+        alias :session_name :client_name
+        deprecate :session_name, :client_name, 2015, 12
 
         def collection_name
           if persistence_options && v = persistence_options[:collection]
@@ -115,7 +126,7 @@ module Mongoid
         end
 
         # Tell the next persistance operation to store in a specific collection,
-        # database or session.
+        # database or client.
         #
         # @example Create a document in a different collection.
         #   Model.with(collection: "secondary").create(name: "test")
@@ -123,17 +134,17 @@ module Mongoid
         # @example Create a document in a different database.
         #   Model.with(database: "secondary").create(name: "test")
         #
-        # @example Create a document in a different session.
-        #   Model.with(session: "secondary").create(name: "test")
+        # @example Create a document in a different client.
+        #   Model.with(client: "secondary").create(name: "test")
         #
         # @example Create with a combination of options.
-        #   Model.with(session: "sharded", database: "secondary").create
+        #   Model.with(client: "sharded", database: "secondary").create
         #
         # @param [ Hash ] options The storage options.
         #
         # @option options [ String, Symbol ] :collection The collection name.
         # @option options [ String, Symbol ] :database The database name.
-        # @option options [ String, Symbol ] :session The session name.
+        # @option options [ String, Symbol ] :client The client name.
         #
         # @return [ Class ] The model class.
         #