mongoid 3.1.7 → 4.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49f91c3bfdee011f4254db9a310c1ee705534a6f
-  data.tar.gz: 17e51120acb04dc04419144c4f8c67731e58198e
+  metadata.gz: 0e868be748277deddf1b1ef5bc060551904de8ed
+  data.tar.gz: a285380f00b0d3f7dcb9d06f1d669e6b4262a980
 SHA512:
-  metadata.gz: fa78c03c62ff52aeeb68a5f5bb1092df93321143a5c4b25e8661d5e5dca0ec46f57820f20b14a104905bb419aa925dba7767eec8bd97c252b5b9d07abea4ce00
-  data.tar.gz: 098d1c1762169ad463118552c61417156e8fd6a96964dd7d84c08fa31e6479f6ec4cedd9011f24cd20e9debaba84cae8c9abe310723937f28225fd0885f90e16
+  metadata.gz: c7f1bc5844c340f5a8335e7c74d80a78082402de62e75d025cf510409f14842a785bb70644655f93ccf38e33e0859dfb1c4237ef961d377a3838586c92c15878
+  data.tar.gz: 52d507c0df35681fd4f7afb28f3d23ea5b6ff1c455e96bde67c44ef3ae4039a6c195aa957453ff95d437bb8de67f583d6422cf1fe84648a984e8787e95fcba60

data/CHANGELOG.md

@@ -3,15 +3,323 @@
 For instructions on upgrading to newer versions, visit
 [mongoid.org](http://mongoid.org/en/mongoid/docs/upgrading.html).
 
-## 3.1.7
+## 4.0.0
+
+### Major Changes (Backwards Incompatible)
+
+* IdentityMap removed. (Arthur Neves)
+
+* Eager load rework. Eager load now doesnt need the identity map to load
+  related documents. A set of preloaders can eager load the associations
+  passed to .includes method. (Arthur Neves)
+
+* Mongoid now supports the new read preferences that the core drivers
+  provide. These include:
+
+    - `:primary`: Will always read from a primary node. (default)
+    - `:primary_preferred`: Attempt a primary first, then secondary if none available.
+    - `:secondary`: Will always read from a secondary node.
+    - `:secondary_preferred`: Attempt a secondary first, then primary if none available.
+    - `:nearest`: Attempt to read from the node with the lowest latency.
+
+    Sample syntax:
+
+        Person.with(read: :secondary).first
+
+    The `:consistency` option is no longer valid, use the `:read` option now.
+
+* Mongoid now defaults all writes to propagate (formerly "safe mode") and now
+  has different propagate semantics:
+
+    - `{ w: -1 }`: Don't verify writes and raise no network errors.
+    - `{ w: 0 }`: Don't verify writes and raise network errors.
+    - `{ w: 1 }`: Verify writes on the primary node. (default)
+    - `{ w: n }`: Verify writes on n number of nodes.
+    - `{ w: "majority" }`: Verify writes on a majority of nodes.
+
+    Sample syntax:
+
+        Person.with(write: {w: :majority}).create!(name: "John")
+
+    The `:safe` option is no longer valid use the `:write` option now.
+
+* \#3230 Array and Hash fields now validate that the correct types are
+  getting set, instead of allowing any value. (Rodrigo Saito)
+
+* \#3043/\#2949 Rework on the internals of persistence options. (Arthur Neves)
+
+* Mongoid now requires Active Model 4 or higher.
+
+* `Document#set` now accepts multiple attributes in the form of a hash,
+  instead of the previous `(field, value)` args. Field aliases and typecasting
+  are also now supported in this operation.
+
+        document.set(name: "Photek", likes: 10000)
+
+* `Document#rename` now accepts multiple attributes in the form of a hash,
+  instead of the previous `(field, value)` args. Field aliases are supported.
+
+        document.rename(first_name: "fn", last_name: "ln")
+
+* `Document#inc` now accepts multiple attributes in the form of a hash, instead
+  of previously only being able to increment one value at a time. Aliases and
+  serialization is supported.
+
+        document.inc(score: 10, place: -1, lives: -10)
+
+* `Document#pop` now accepts multiple attributes in the form of a hash, instead
+  of previously only being able to pop one value at a time. Aliases and
+  serialization is supported.
+
+        document.pop(names: 1, aliases: -1)
+
+* `Document#bit` now accepts multiple attributes in the form of a hash, instead
+  of previously only being able to apply one set of operations at a time.
+  Aliases and serialization are supported.
+
+        document.bit(age: { and: 13 }, score: { or: 13 })
+
+* `Document#pull` now accepts multiple attributes in the form of a hash, instead
+  of previously only being able to pull one value at a time. Aliases and
+  serialization is supported.
+
+        document.pull(names: "James", aliases: "007")
+
+* `Document#pull_all` now accepts multiple attributes in the form of a hash,
+  instead of previously only being able to pull one value at a time. Aliases and
+  serialization is supported.
+
+        document.pull_all(names: ["James", "Bond"], aliases: ["007"])
+
+* `Document#push_all` has been removed since it was deprecated in MongoDB 2.4.
+  Use `Document.push` instead.
+
+* `Document#push` now accepts multiple attributes in the form of a hash, and
+  can handle the pushing of single values or multiple values to the field via
+  $push with $each. Aliases and serialization is supported.
+
+        document.push(names: "James", aliases: [ "007", "Jim" ])
+
+* `Document#add_to_set` now accepts multiple attributes in the form of a hash,
+  and now aliases and serialization are supported.
+
+        document.add_to_set(names: "James", aliases: "007")
+
+* Criteria atomic operations API is now changed to match the changes in the
+  single document atomic API, for example:
+
+        Band.where(name: "Depeche Mode").inc(likes: 10, followers: 20)
+
+* \#3399 #create and #create! on relations can now take an array of attributes as
+  the first parameter to create multiple documents at once.
+
+        person.addresses.create([{ street: "Bond" }, { street: "Upper" }])
+        person.addresses.create!([{ street: "Bond" }, { street: "Upper" }])
+
+* \#3141 `rake db:test:prepare` now sets up all defined indexes if Mongoid is the
+  only ODM/ORM in the environment.
+
+* \#3138 `update_attributes` can now be accessed simply by calling `update`.
+
+* \#3083 A new rake task: `rake mongoid:remove_undefined_indexes` has been added to
+  remove indexes from the database that are not explicitly defined in the models.
+  (Aidan Feldman)
+
+* \#3029 The `relation_field` field that is added for a single use case with polymorphic
+  relations has been removed. So where the following would work before:
+
+        class Eye
+          include Mongoid::Document
+          belongs_to :eyeable, polymorphic: true
+        end
+
+        class Face
+          include Mongoid::Document
+          has_one :left_eye, class_name: "Eye", as: :eyeable
+          has_one :right_eye, class_name: "Eye", as: :eyeable
+        end
+
+      This would now need to be modeled as (with the appropriate migration):
+
+        class Eye
+          include Mongoid::Document
+          belongs_to :left_socket, class_name: "Face", inverse_of: :left_eye
+          belongs_to :right_socket, class_name: "Face", inverse_of: :right_eye
+        end
+
+        class Face
+          include Mongoid::Document
+          has_one :left_eye, class_name: "Eye", inverse_of: :left_socket
+          has_one :right_eye, class_name: "Eye", inverse_of: :right_socket
+        end
+
+* \#3075 `update_attribute` now properly calls the setter method instead of
+  using `write_attribute`.
+
+* \#3060 Allow atomically blocks to allow multiple calls of the same type.
+  (Brian Norton)
+
+* \#3037 Model indexes are no longer stored in an `index_options` hash on the
+  model class. Instead, an array named `index_specifications` now exists on the
+  class which contains a list of `Indexable::Specification` objects. This is so
+  we could properly handle the case of indexes with the same keys but different
+  order.
+
+* \#2956 Caching on queries now only happens when `cache` is specifically
+  called. (Arthur Neves)
+
+* \#2898 Dirty attribute methods now properly handle field aliases.
+  (Niels Ganser)
+
+* \#2659 `Mongoid::Railtie` now properly uses only one initializer and
+  the name has changed to `mongoid.load-config`.
+
+* \#2656 `rake db:reseed` is now `rake db:reset` (Arthur Neves)
+
+* \#2648 `Boolean` becomes `Mongoid::Boolean` to avoid polluting the global
+  namespace with a commonly used class by other libraries.
+
+* \#2603 Return values from setters are now always the set value, regardless
+  of calling the setter or using send.
+
+* \#2597 `Mongoid::Observer` was removed in line with Rails 4.
+
+* \#2563 The `allow_dynamic_fields` configuration option has been removed as
+  dynamic fields are now allowed on a per-model level. In order to allow a
+  model to use dynamic fields, simply include the module in each.
+  (Josh Martin)
+
+        class Band
+          include Mongoid::Document
+          include Mongoid::Attributes::Dynamic
+        end
+
+* \#2497 Calling `to_json` no longer tampers with the return value from the
+  driver, and proper returns `{ "$oid" : object_id.to_s }` instead of just
+  the string representation previously.
+
+* \#2433 `Mongoid::Paranoia` has been removed.
+
+* \#2432 `Mongoid::Versioning` has been removed.
+
+* \#2218 Creating or instantiating documents that have default scopes will now
+  apply the default scope to the document, if the scope is not complex.
+
+* \#2200 Mass assignment security now mirrors Rails 4's behavior.
+
+* `delete_all` and `destroy_all` no longer take a `:conditions` hash but
+  just the raw attributes.
+
+* \#1344 Atomic updates can now be executed in an `atomically` block, which will
+  delay any atomic updates on the document the block was called on until the
+  block is complete.
+
+    Update calls can be executed as normal in the block:
+
+        document.atomically do
+          document.inc(likes: 10)
+          document.bit(members: { and: 10 })
+          document.set(name: "Photek")
+        end
+
+    The document is also yielded to the block:
+
+        document.atomically do |doc|
+          doc.inc(likes: 10)
+          doc.bit(members: { and: 10 })
+          doc.set(name: "Photek")
+        end
+
+    The atomic commands are have a fluid interface:
+
+        document.atomically do |doc|
+          doc.inc(likes: 10).bit(members: { and: 10 }).set(name: "Photek")
+        end
+
+    If the fluid interface is leveraged without the `atomically` block, the
+    operations will persist in individual calls. For example, the following
+    would hit the database 3 times without the block provided:
+
+        doc.inc(likes: 10).bit(members: { and: 10 }).set(name: "Photek")
+
+    The block is only good for 1 document at a time, so embedded and root
+    document updates cannot be mixed at this time.
+
+### New Features
+
+* Mongoid now uses ActiveSupport::LogSubscriber to subscribe logs, and
+  ActiveSupport::Notifications to send operation logs. (Arthur Neves)
+  Example of log subscription:
+
+    ActiveSupport::Notifications.subscribe('query.moped') do |event|
+      ..
+    end
+
+* \#3319 Counters can now be reset from a document instance:
+
+    document.reset_counters(:relation)
+
+* \#3302 Aliasing using `alias_attribute` now properly handles aliases in criteria.
+
+* \#3155 Range field will persist the exclude_end when provided.
+  (Daniel Libanori)
+
+* \#3146 Adding :overwrite field option, when it`s true, it wont check duplicates.
+ (Daniel Libanori)
+
+* \#3002 Reloading the Rails console will also now clear Mongoid's identity map.
+
+* \#2938 A configuration option `duplicate_fields_exception` has been added that
+  when set to `true` will raise an exception when defining a field that will
+  override an existing method. (Arthur Neves)
+
+* \#2924 MongoDB 2.4 beta text search now has a DSL provided by Mongoid. Like
+  other queries, text searches are lazy evaluated, and available off the class
+  or criteria level.
+
+    Note that any 3rd party gem that provides a `text_search` method will now no
+    longer work with Mongoid, and will need to change its syntax. Examples:
+
+        Band.text_search("mode").project(name: 1).each do |doc|
+          # ...
+        end
+
+        Band.limit(10).text_search("phase").language("latin")
+        Band.where(:likes.gt => 1000).text_search("lucy")
+
+* \#2855 Multiple extensions can now be supplied to relations. (Daniel Libanori)
 
 ### Resolved Issues
 
 * \#3397 Fixed $ne matcher for embedded documents to match server behaviour.
 
-* \#3414 Backkport skip and limit options on aggregation. (Wojciech Piekutowski)
+* \#3348 Fixing compounded indexes having the same keys with
+  different directions. (Arthur Neves)
+
+* \#2701 Fixing extra query on belongs_to binding. (Arthur Neves)
+
+* \#3089 Allow demongoization of strings to floats (Daniel Libanori)
+
+* \#3278 Counter cache should update the document in memory too. (Arthur Neves)
+
+* \#3242 Has_many relation must use the inverse foreign_key. (Arthur Neves)
+
+* \#3197 Improvements in the calls to `aggregates` on root and embedded
+  collections. (Wojciech Piekutowski)
+
+* \#3144/\#3219 Fixing name colission on @_children ivar. (Arthur Neves)
+
+* \#3088 Range field can accept a hash, which could be the attribute from the db.
+  (Daniel Libanori)
 
-* \#3469 Fix RegexpError: failed to allocate memory: /\./ on .hash_dot_syntax?  (Dmitry Krasnoukhov)
+* \#3116 Relations instance variables are now all prefixed with `_`.
+
+* \#3093 Only flatten 1 level when atomically pushing arrays.
+
+* \#3063 `Document#becomes` now properly sets base object on errors.
+  (Adam Ross Cohen)
+
+* \#2903 Removed unused string `to_a` extension.
 
 ## 3.1.6
 
@@ -101,6 +409,7 @@ For instructions on upgrading to newer versions, visit
 ### Resolved Issues
 
 * Dont duplicate embedded documents when saving after calling becomes method.
+  (Arthur Neves)
 
 * \#2961 Reloading a mongoid.yml configuration now properly clears previously
   configured sessions.
@@ -111,11 +420,6 @@ For instructions on upgrading to newer versions, visit
 * \#2921 Don't use type in identity map selection if inheritance is not
   in play. (Arthur Neves)
 
-* \#2899 Dirty attribute methods now properly handle field aliases.
-  (Niels Ganser)
-
-* \#2895 Allow scopes that return nil to still be chainable. (niedhui)
-
 * \#2893 Removed memoization of collection name and database name so lambdas
   with `store_in` work properly when changing.
 
@@ -293,12 +597,14 @@ For instructions on upgrading to newer versions, visit
 * \#2465 Documents now have an `attribute_before_type_cast` for proper
   handling of validations. (Gerad Suyderhoud)
 
-* \#2443 `expire_after_seconds` is now a valid index option.
+* \#2443 `expire_after_seconds` is now a valid index option
+  (http://docs.mongodb.org/manual/core/indexes/#ttl-indexes,
+   http://docs.mongodb.org/manual/tutorial/expire-data/).
 
         class Event
           include Mongoid::Document
-          field :status, type: Integer
-          index({ status: 1 }, { expire_after_seconds: 3600 })
+          field :created_at, type: DateTime
+          index({ created_at: 1 }, { expire_after_seconds: 3600 })
         end
 
 * \#2373 Relations with the `touch: true` option will now be automatically

data/README.md

@@ -1,4 +1,4 @@
-Mongoid [![Build Status](https://secure.travis-ci.org/mongoid/mongoid.png?branch=master&.png)](http://travis-ci.org/mongoid/mongoid)
+Mongoid [![Build Status](https://secure.travis-ci.org/mongoid/mongoid.png?branch=master)](http://travis-ci.org/mongoid/mongoid) [![Code Climate](https://codeclimate.com/github/mongoid/mongoid.png)](https://codeclimate.com/github/mongoid/mongoid) [![Coverage Status](https://coveralls.io/repos/mongoid/mongoid/badge.png?branch=master)](https://coveralls.io/r/mongoid/mongoid?branch=master)
 ========
 
 Mongoid is an ODM (Object-Document-Mapper) framework for MongoDB in Ruby.
@@ -6,9 +6,10 @@ Mongoid is an ODM (Object-Document-Mapper) framework for MongoDB in Ruby.
 Project Tracking
 ----------------
 
-* [Mongoid Google Group](http://groups.google.com/group/mongoid)
 * [Mongoid Website and Documentation](http://mongoid.org)
-* [Mongoid Code Climate](https://codeclimate.com/github/mongoid/mongoid)
+* [Mongoid Google Group](http://groups.google.com/group/mongoid)
+* [Stackoverflow](http://stackoverflow.com/questions/tagged/mongoid)
+* #mongoid on freenode IRC
 
 Compatibility
 -------------
@@ -24,8 +25,6 @@ Please see the new Mongoid website for up-to-date documentation:
 Donating
 --------
 
-[Support Mongoid at Wepay](https://www.wepay.com/donations/mongoid)
-
 [Support Mongoid at Pledgie](http://www.pledgie.com/campaigns/7757)
 
 <a href='http://www.pledgie.com/campaigns/7757'>

data/lib/config/locales/en.yml

@@ -222,6 +222,10 @@ en:
             from the child side which relation to go in."
           resolution: "Set the values from the parent, or redefine the relation
             with only a single definition in the parent."
+        invalid_value:
+          message: "Value of type %{value_class} cannot be written to a field of type %{field_class}"
+          summary: "Tried to set a value of type %{value_class} to a field of type %{field_class}"
+          resolution: "Verify if the value to be set correspond to field definition"
         mixed_relations:
           message: "Referencing a(n) %{embedded} document from the %{root}
             document via a relational association is not allowed since the
@@ -411,12 +415,12 @@ en:
         unknown_attribute:
           message: "Attempted to set a value for '%{name}' which is not
             allowed on the model %{klass}."
-          summary: "When setting Mongoid.allow_dynamic_fields to false and the
-            attribute does not already exist in the attributes hash, attempting
-            to call %{klass}#%{name}= for it is not allowed. This is also
-            triggered by passing the attribute to any method that accepts an
+          summary: "Without including Mongoid::Attributes::Dynamic in your model
+            and the attribute does not already exist in the attributes hash,
+            attempting to call %{klass}#%{name}= for it is not allowed. This is
+            also triggered by passing the attribute to any method that accepts an
             attributes hash, and is raised instead of getting a NoMethodError."
-          resolution: "You can set Mongoid.allow_dynamic_fields to true if you
+          resolution: "You can include Mongoid::Attributes::Dynamic if you
             expect to be writing values for undefined fields often."
         unsaved_document:
           message: "Attempted to save %{document} before the parent %{base}."
@@ -439,13 +443,6 @@ en:
           summary: "The following errors were found: %{errors}"
           resolution: "Try persisting the document with valid data or remove
             the validations."
-        versioning_not_on_root:
-          message: "Versioning not allowed on embedded document: %{klass}."
-          summary: "Mongoid::Versioning behaviour is only allowed on documents
-            that are the root document in the hierarchy."
-          resolution: "Remove the versioning from the embedded %{klass} or
-            consider moving it to a root location in the hierarchy if
-            versioning is needed."
         delete_restriction:
           message: "Cannot delete %{document} because of dependent '%{relation}'."
           summary: "When defining '%{relation}' with a :dependent => :restrict,

data/lib/mongoid.rb

@@ -1,34 +1,12 @@
 # encoding: utf-8
-
-# Copyright (c) 2009 - 2011 Durran Jordan and friends.
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'support/ruby_version'
+require "support/ruby_version"
 
 require "delegate"
 require "time"
 require "set"
 
 require "active_support/core_ext"
-require 'active_support/json'
+require "active_support/json"
 require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
@@ -36,49 +14,12 @@ require "active_model"
 require "origin"
 require "moped"
 
-require "mongoid/atomic/positionable"
-require "mongoid/evolvable"
-require "mongoid/extensions"
-require "mongoid/errors"
-require "mongoid/threaded"
-require "mongoid/relations"
-require "mongoid/atomic"
-require "mongoid/attributes"
-require "mongoid/callbacks"
+require "mongoid/version"
 require "mongoid/config"
-require "mongoid/contextual"
-require "mongoid/copyable"
-require "mongoid/equality"
-require "mongoid/criteria"
-require "mongoid/dirty"
-require "mongoid/factory"
-require "mongoid/fields"
-require "mongoid/finders"
-require "mongoid/hierarchy"
-require "mongoid/identity_map"
-require "mongoid/indexes"
-require "mongoid/inspection"
-require "mongoid/json"
 require "mongoid/loggable"
-require "mongoid/matchers"
-require "mongoid/multi_parameter_attributes"
-require "mongoid/nested_attributes"
-require "mongoid/observer"
-require "mongoid/persistence"
-require "mongoid/reloading"
-require "mongoid/scoping"
-require "mongoid/serialization"
 require "mongoid/sessions"
-require "mongoid/sharding"
-require "mongoid/state"
-require "mongoid/timestamps"
-require "mongoid/unit_of_work"
-require "mongoid/validations"
-require "mongoid/version"
-require "mongoid/versioning"
-require "mongoid/components"
-require "mongoid/paranoia"
 require "mongoid/document"
+require "mongoid/log_subscriber"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.
@@ -86,27 +27,19 @@ if defined?(Rails)
   require "mongoid/railtie"
 end
 
-# If we are using any Rack based application then we need the Mongoid rack
-# middleware to ensure our app is running properly.
-if defined?(Rack)
-  require "rack/mongoid"
-end
-
 # add english load path by default
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
 module Mongoid
   extend Loggable
-  extend UnitOfWork
   extend self
 
-  MONGODB_VERSION = "2.0.0"
+  MONGODB_VERSION = "2.2.0"
 
   # Sets the Mongoid configuration options. Best used by passing a block.
   #
   # @example Set up configuration options.
   #   Mongoid.configure do |config|
-  #     config.allow_dynamic_fields = false
   #     config.use(name: "mongoid_test", host: "localhost", port: 27017)
   #   end
   #
@@ -160,7 +93,5 @@ module Mongoid
   #   Mongoid.database = Mongo::Connection.new.db("test")
   #
   # @since 1.0.0
-  delegate(*(Config.public_instance_methods(false) +
-    ActiveModel::Observing::ClassMethods.public_instance_methods(false) - [:logger=, :logger] <<
-    { to: Config }))
+  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ] << { to: Config }))
 end