mongoid 3.1.5 → 8.0.2

data/CHANGELOG.md

@@ -3,6 +3,611 @@
 For instructions on upgrading to newer versions, visit
 [mongoid.org](http://mongoid.org/en/mongoid/docs/upgrading.html).
 
+### As of version 5.0.2, please refer to the github releases for change logs.
+
+## 5.0.1
+
+### Resolved Issues
+
+* [MONGOID-3020](https://jira.mongodb.org/browse/MONGOID-3020) Test added to show it's no longer an issue.
+* [MONGOID-3025](https://jira.mongodb.org/browse/MONGOID-3025) Test added to show it's no longer an issue.
+* [MONGOID-3061](https://jira.mongodb.org/browse/MONGOID-3061) No longer an issue.
+* [MONGOID-3073](https://jira.mongodb.org/browse/MONGOID-3073) Test added to show it's no longer an issue.
+* [MONGOID-3085](https://jira.mongodb.org/browse/MONGOID-3085) Test added to show it's no longer an issue.
+* [MONGOID-3101](https://jira.mongodb.org/browse/MONGOID-3101) No longer an issue.
+* [MONGOID-3160](https://jira.mongodb.org/browse/MONGOID-3160) No longer an issue.
+* [MONGOID-3176](https://jira.mongodb.org/browse/MONGOID-3176) No longer an issue.
+* [MONGOID-3214](https://jira.mongodb.org/browse/MONGOID-3214) Test added to show it's no longer an issue.
+* [MONGOID-3296](https://jira.mongodb.org/browse/MONGOID-3296) Add update callback for counter_cache.
+* [MONGOID-3326](https://jira.mongodb.org/browse/MONGOID-3326) Test added to show it's no longer an issue.
+* [MONGOID-3361](https://jira.mongodb.org/browse/MONGOID-3361) No longer an issue.
+* [MONGOID-3365](https://jira.mongodb.org/browse/MONGOID-3365) Test added to show it's no longer an issue.
+* [MONGOID-3402](https://jira.mongodb.org/browse/MONGOID-3402) Apply persistence options to parent.
+* [MONGOID-3524](https://jira.mongodb.org/browse/MONGOID-3524) No longer an issue.
+* [MONGOID-3529](https://jira.mongodb.org/browse/MONGOID-3529) Test exists already showing it's not an issue.
+* [MONGOID-3543](https://jira.mongodb.org/browse/MONGOID-3543) Test exists already showing it's not an issue.
+* [MONGOID-3611](https://jira.mongodb.org/browse/MONGOID-3611) Test added to show it's no longer an issue.
+* [MONGOID-3650](https://jira.mongodb.org/browse/MONGOID-3650) No longer an issue.
+* [MONGOID-3826](https://jira.mongodb.org/browse/MONGOID-3826), [MONGOID-4109](https://jira.mongodb.org/browse/MONGOID-4109) Fix Timelessness leaks.
+* [MONGOID-3946](https://jira.mongodb.org/browse/MONGOID-3946) Test added to show it's no longer an issue.
+* [MONGOID-3969](https://jira.mongodb.org/browse/MONGOID-3969) Test added to show it's no longer an issue.
+* [MONGOID-3971](https://jira.mongodb.org/browse/MONGOID-3971) Not an issue.
+* [MONGOID-3979](https://jira.mongodb.org/browse/MONGOID-3979) Not an issue, tests exist already.
+* [MONGOID-3985](https://jira.mongodb.org/browse/MONGOID-3985) Not an issue.
+* [MONGOID-4078](https://jira.mongodb.org/browse/MONGOID-4078) Behavior is intended.
+* [MONGOID-4079](https://jira.mongodb.org/browse/MONGOID-4079) Not an issue.
+* [MONGOID-4088](https://jira.mongodb.org/browse/MONGOID-4088) Account for sub-document dot notation with #pluck results.
+* [MONGOID-4098](https://jira.mongodb.org/browse/MONGOID-4098) Fixed by a change to the Ruby driver. See RUBY-1029.
+* [MONGOID-4101](https://jira.mongodb.org/browse/MONGOID-4101) Not an issue.
+* [MONGOID-4106](https://jira.mongodb.org/browse/MONGOID-4106) Not an issue.
+* [MONGOID-4110](https://jira.mongodb.org/browse/MONGOID-4110) Not an issue.
+* [MONGOID-4119](https://jira.mongodb.org/browse/MONGOID-4119) Ensure that criteria selector becomes pipeline operator value.
+* [MONGOID-4121](https://jira.mongodb.org/browse/MONGOID-4121) Not an issue.
+* [MONGOID-4123](https://jira.mongodb.org/browse/MONGOID-4123) Fixed as a result of MONGOID-4159.
+* [MONGOID-4125](https://jira.mongodb.org/browse/MONGOID-4125) Make sure none scopes referenced in procs are applied.
+* [MONGOID-4132](https://jira.mongodb.org/browse/MONGOID-4132) Not an issue.
+* [MONGOID-4157](https://jira.mongodb.org/browse/MONGOID-4157) Fixed by version 2.1.2 of the Ruby driver.
+* [MONGOID-4162](https://jira.mongodb.org/browse/MONGOID-4162) Adapt index option mappings to new driver. (@Nielsomat)
+* [MONGOID-3737](https://jira.mongodb.org/browse/MONGOID-3737) Test added to show it's no longer an issue.
+* [MONGOID-3621](https://jira.mongodb.org/browse/MONGOID-3621) Not an issue.
+* [MONGOID-3551](https://jira.mongodb.org/browse/MONGOID-3551) Not an issue.
+* [MONGOID-3696](https://jira.mongodb.org/browse/MONGOID-3696) Test added to show it's no longer an issue.
+* [MONGOID-3858](https://jira.mongodb.org/browse/MONGOID-3858) Test added to show it's no longer an issue.
+* [MONGOID-3672](https://jira.mongodb.org/browse/MONGOID-3672) Not an issue.
+* [MONGOID-4172](https://jira.mongodb.org/browse/MONGOID-4172) Use positional operator only on 1 level deep nesting.
+* Added public cert to repo and sign gem if private key is present
+
+## 5.0.0
+
+### 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 subclass 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 embedded 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
+
+### New Features
+
+* \#3931 Add #find_or_create_by! method to many associations. (Tom Beynon)
+
+* \#3731 Add find_by! method. (Guillermo Iguaran)
+
+### Resolved Issues
+
+* \#3722 Use the right database name when combining #store_in and #with. (Arthur Neves)
+
+* \#3934 Dont apply sort when doing a find_by. (Arthur Neves)
+
+* \#3935 fix multiple fields sorting on contextual memory. (chamnap)
+
+* \#3904 BSON::Document#symbolize_keys should return keys as symbols. (Arthur Neves)
+
+* \#3948 Fix remove_undefined_indexes on rails 4.2, to symbolize right the Document keys. (Adam Wróbel)
+
+* \#3626 Document#to_key, needs to return a ObjectId as String so we can query back using that id. (Arthur Neves)
+
+* \#3888 raise UnknownAttributeError when 'set' is called on non existing field and Mongoid::Attributes::Dynamic is not included in model. (Shweta Kale)
+
+* \#3889 'set' will allow to set value of non existing field when Mongoid::Attributes::Dynamic is included in model. (Shweta Kale)
+
+* \#3812 Fixed validation context when saving (Yaroslav Zemlyanuhin)
+
+## 4.0.1
+
+### Resolved Issues
+
+* \#3911 Fix relations named "parent". (nkriege)
+
+* \#3792/\#3881 Fix many internal calls to #_id instead of #id to avoid issues
+  when overloading #id (Gauthier Delacroix)
+
+* \#3847 Fix 'QueryCache#get_more' result, when collection has more documents than first query batch. (Angelica Korsun)
+
+* \#3684 Dont raise MissingAttributeError, when using a only() scope. (Arthur Neves)
+
+* \#3703 pluck method should not compact the values. (Arthur Neves)
+
+* \#3773 Use nanoseconds for cache_key timestamp instead of plain seconds. (Máximo Mussini)
+
+## 4.0.0
+
+### Major Changes (Backwards Incompatible)
+
+* \#3320 Remove Rails dependencies on database rake tasks. (Arthur Neves)
+
+    All db:* rake tasks should work as before when using Rails.
+    When not in a Rails, just load the database tasks using:
+
+        load 'mongoid/tasks/database.rake'
+
+* Mongoid 4 now only supports MongoDB 2.4.0 and higher.
+
+* `Document#metadata` has been renamed to `Document#relation_metadata` to
+  avoid common conflicts. Relation proxies also have this renamed to the
+  same as well.
+
+* Scopes and default scopes must now all be defined within lambdas or procs.
+
+* `skip_version_check` config option was removed.
+
+* 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 db: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)
+
+* \#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.
+  `without_protection` option was also removed.
+  `attr_accessible` class method was removed.
+  Mongoid and Strong parameters should work fine for mass assignment protection.
+
+* `delete_all` and `destroy_all` no longer take a `:conditions` hash but
+  just the raw attributes.
+
+* \#1908 Documents now loaded from criteria using `#only` or `#without` will now
+  raise an error when attempting to save, update, or delete these records.
+  Additionally fields excluded from the fields retrieved from the database will
+  also raise an exception when trying to access them.
+
+* \#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
+
+* Field types can now use symbols as well as class names. See:
+  https://github.com/mongoid/mongoid/blob/master/lib/mongoid/fields.rb#L16
+  for the available mappings.
+
+* \#3580 Fields can now be reset to their default values, with the methods:
+
+    document.reset_name_to_default!
+
+* \#3513 Documents now have a `#destroy!` method that will raise a
+  `Mongoid::Errors::DocumentNotDestroyed` error if a destroy callback returns
+  a false value.
+
+* \#3496 Added class level and criteria level `find_or_create_by!`.
+
+* \#3479 Map/reduce now respects criteria no timeout options if output is not
+  inline.
+
+* \#3478 Criteria objects now have a #none method that will cause the criteria to
+  never hit the database and always have zero documents.
+
+    Band.none
+    Band.none.where(name: "Tool") # Always has zero documents.
+
+* \#3410 Mongoid now has a query cache that can be used as a middleware in
+  Rack applications. (Arthur Neves)
+
+    For Rails:
+
+      config.middleware.use(Mongoid::QueryCache::Middleware)
+
+* \#3319 Counters can now be reset from a document instance:
+
+    document.reset_counters(:relation)
+
+* \#3310 embedded_in relations now accept a `touch` option to update parents.
+
+* \#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
+
+* \#3676 Make pluck work with embedded associations
+  (Arthur Neves)
+
+* \#2898 Dirty attribute methods now properly handle field aliases.
+  (Niels Ganser)
+
+* \#3620 Add ActiveModel module instance methods to prohibited_methods list.
+  (Arthur Neves)
+
+* \#3610 Don't allow atomic operations on read-only attributes
+  (Frederico Araujo)
+
+* \#3619 Don't validate documents that are flagged for destruction.
+  (Christopher J. Bottaro)
+
+* \#3617 Don't skip index creation on cyclic documents. (shaiker)
+
+* \#3568 Fixed missing attributes error on present localized fields.
+
+* \#3514 Fixed query cache to work on first/last calls.
+
+* \#3383/\#3495 Fix has_and_belongs_to_many eager load. (Arthur Neves)
+
+* \#3492 $rename operations should not mongoize values. (Vladislav Melanitskiy)
+
+* \#3490 Allow localized fields to work with boolean `false` values.
+
+* \#3487 Map Boolean to Mongoid::Boolean in field definitions. (Arthur Neves)
+
+* \#3449 Touch needs to work for create and update. (Greggory Rothmeier)
+
+* \#3347 Creating documents off of scopes for embedded relations now properly
+  sets the parent document on the created children.
+
+* \#3432 Fixed mongoization of DateTime losing precision.
+
+* \#3397 Fixed $ne matcher for embedded documents to match server behavior.
+
+* \#3352 Allow named scopes named "open" to work through 1-n relations.
+
+* \#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)
+
+* \#3233 Don't double call validation callbacks when cascading children and
+  relation validation is turned on.
+
+* \#3197 Improvements in the calls to `aggregates` on root and embedded
+  collections. (Wojciech Piekutowski)
+
+* \#3144/\#3219 Fixing name collision on @_children ivar. (Arthur Neves)
+
+* \#3088 Range field can accept a hash, which could be the attribute from the db.
+  (Daniel Libanori)
+
+* \#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)
+
+* \#3019 Atomic operations will no longer attempt to persist if the document
+  is not persisted.
+
+* \#2903 Removed unused string `to_a` extension.
+
+## 3.1.7
+
+### Resolved Issues
+
+* \#3465 Fixed ambiguous relation errors where inverse_of is set to nil.
+
+* \#3414 Backport skip and limit options on aggregation. (Wojciech Piekutowski)
+
+* \#3469 Fix RegexpError: failed to allocate memory: /\./ on .hash_dot_syntax?  (Dmitry Krasnoukhov)
+
+## 3.1.6
+
+### Resolved Issues
+
+* \#3337 Ensure localized fields map is cloned with inheritance.
+
+* \#3262 Fixed atomic array operations on HABTM foreign key fields from turning
+  single elements into arrays.
+
+* \#3282 Fixed .timeless option to use a thread local instead of a class attribute.
+  Also remove the timeless methods from all docs, and only add to timestamps docs.
+  (Arthur Neves)
+
 ## 3.1.5
 
 ### Resolved Issues
@@ -23,7 +628,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#3137 Allow multiple `belongs_to` sets in a row with ids.
 
-* \#3079 Embbed docs with paranoia parents, were losing the _id when
+* \#3079 Embedded docs with paranoia parents were losing the _id when
   reloading from db, as they didnt have the right persisted? value. (Arthur Neves)
 
 * \#3081 Criteria's `method_missing` now checks if an array responds to the provided
@@ -78,6 +683,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.
@@ -88,11 +694,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.
 
@@ -270,12 +871,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
@@ -702,8 +1305,8 @@ For instructions on upgrading to newer versions, visit
   validation fails. Instead, they get flagged for destruction and then the
   removal occurs upon the parent passing validation and going to persist.
 
-  Note this is a behaviour change, but since the API does not change and
-  the previous behaviour was incorrect and did not match AR this was able
+  Note this is a behavior change, but since the API does not change and
+  the previous behavior was incorrect and did not match AR this was able
   to go into a point release.
 
 ## 3.0.9
@@ -739,7 +1342,7 @@ For instructions on upgrading to newer versions, visit
 * \#2411 BigDecimal fields are properly stored as strings when mongoizing
   integers and floats.
 
-* \#2409 Don't warn about missing mongoid.yml if configured programatically.
+* \#2409 Don't warn about missing mongoid.yml if configured programmatically.
 
 * \#2403 Return false on `update_all` of an embeds many with no documents.
 
@@ -787,7 +1390,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#2353 Allow `update_attribute` to properly handle aliased fields.
 
-* \#2348 Conversion of strings to times should raise an arugment error if the
+* \#2348 Conversion of strings to times should raise an argument error if the
   string is invalid. (Campbell Allen)
 
 * \#2346 Ensure `belongs_to` relations are evolvable when passed the proxy and
@@ -1245,18 +1848,18 @@ For instructions on upgrading to newer versions, visit
   set a child on a relation without the proper inverse_of definitions
   due to Mongoid not being able to determine it.
 
-        class Lush
+        class Car
           include Mongoid::Document
-          embeds_one :whiskey, class_name: "Drink"
+          embeds_one :engine, class_name: "Motor"
         end
 
-        class Drink
+        class Motor
           include Mongoid::Document
-          embedded_in :alcoholic, class_name: "Lush"
+          embedded_in :machine, class_name: "Car"
         end
 
-        lush = Lush.new
-        lush.whiskey = Drink.new # raises an InverseNotFound error.
+        car = Car.new
+        car.engine = Motor.new # raises an InverseNotFound error.
 
 * \#1680 Polymorphic relations now use `*_type` keys in lookup queries.
 
@@ -1309,7 +1912,7 @@ For instructions on upgrading to newer versions, visit
         criteria.merge(filter)
 
 * \#1635 All exceptions now provide more comprehensive errors, including
-  the problem that occured, a detail summary of why it happened, and
+  the problem that occurred, a detail summary of why it happened, and
   potential resolutions. Example:
 
         (Mongoid::Errors::DocumentNotFound)
@@ -1326,7 +1929,7 @@ For instructions on upgrading to newer versions, visit
           false, which will cause a nil to be returned instead
           of raising this error.
 
-* \#1616 `Model.find_by` added which takes a hash of arugments to search
+* \#1616 `Model.find_by` added which takes a hash of arguments to search
   for in the database. If no single document is returned a DocumentNotFound
   error is raised. (Piotr Jakubowski)
 
@@ -1387,7 +1990,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#1291 Mongoid now supports any number of database connections as defined in
   the mongoid.yml. For example you could have a local single server db, a
-  multi availablity zone replica set, and a shard cluster all in the same
+  multi availability zone replica set, and a shard cluster all in the same
   application environment. Mongoid can connect to any session at any point in
   time.
 
@@ -1742,7 +2345,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#463 `Document#upsert` is no longer aliased to `Document#save` and now
   actually performs a proper MongoDB upsert command when called. If you
-  were using this method before and want the same behaviour, please switch
+  were using this method before and want the same behavior, please switch
   to `save`.
 
         band = Band.new(name: "Tool")
@@ -1798,7 +2401,7 @@ For instructions on upgrading to newer versions, visit
 * \#1972 `added`, `loaded`, and `unloaded` can now be valid scope names on a
   document that is part of a 1-n relation.
 
-* \#1952/#1950 `#all_in` behaviour on embedded documents now properly matches
+* \#1952/#1950 `#all_in` behavior on embedded documents now properly matches
   root documents when passing an empty array. (Hans Hasselberg)
 
 * \#1941/#1939 `Model.find_by` now returns nil if raise not found error is
@@ -2338,7 +2941,7 @@ For instructions on upgrading to newer versions, visit
 * \#1463 Batch insert consumers are now scoped to collection to avoid persistence
   of documents to other collections in callbacks going to the wrong place.
 
-* \#1462 Assigning has many relations via nested attribtues `*_attributes=` does
+* \#1462 Assigning has many relations via nested attributes `*_attributes=` does
   not autosave the relation.
 
 * \#1461 Fixed serialization of foreign key fields in complex criteria not to
@@ -2406,7 +3009,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#1394 Fix exists? to work when count is greater than 1. (Nick Hoffman)
 
-* \#1392 Return 0 on aggregation functions where field is nonexistant.
+* \#1392 Return 0 on aggregation functions where field is nonexistent.
 
 * \#1391 Uniqueness validation now works properly on embedded documents that are
   using primary key definitions.
@@ -2437,7 +3040,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#1386 Lowered mongo/bson dependency to 1.3
 
-* \#1377 Fix aggregation functions to properly handle nil or indefined values.
+* \#1377 Fix aggregation functions to properly handle nil or undefined values.
   (Maxime Garcia)
 
 * \#1373 Warn if a scope overrides another scope.
@@ -2518,7 +3121,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#1287 Fixed max versions limitation with versioning.
 
-* \#1277 attribute_will_change! properly flags the attribute even if no change occured.
+* \#1277 attribute_will_change! properly flags the attribute even if no change occurred.
 
 * \#1063 Paranoid documents properly run destroy callbacks on soft destroy.
 
@@ -2553,7 +3156,7 @@ For instructions on upgrading to newer versions, visit
 
 * \#1256 Mongoid now can create indexes for models in Rails engines. (Caio Filipini)
 
-* \#1228 Allow pre formatting of compsoite keys by passing a block to #key.
+* \#1228 Allow pre formatting of composite keys by passing a block to #key.
   (Ben Hundley)
 
 * \#1222 Scoped mass assignment is now supported. (Andrew Shaydurov)
@@ -2598,7 +3201,7 @@ For instructions on upgrading to newer versions, visit
 * \#1273 Mongoid.preload_models now checks if preload configuration option is set,
   where Mongoid.load_models always loads everything. (Ryan McGeary)
 
-* \#1244 Has one relations now adhere to default dependant behaviour.
+* \#1244 Has one relations now adhere to default dependant behavior.
 
 * \#1225 Fixed delayed persistence of embedded documents via $set.
 
@@ -2633,7 +3236,7 @@ For instructions on upgrading to newer versions, visit
 
 ## 2.2.4
 
-* \#1377 Fix aggregation functions to properly handle nil or indefined values.
+* \#1377 Fix aggregation functions to properly handle nil or undefined values.
   (Maxime Garcia)
 
 * \#1373 Warn if a scope overrides another scope.
@@ -2647,7 +3250,7 @@ For instructions on upgrading to newer versions, visit
   key without error.
 
 * \#1350, \#1351 Fixed errors in the string conversions of double quotes and
-  tilde when paramterizing keys.
+  tilde when parameterizing keys.
 
 * \#1349 Mongoid documents should not blow up when including Enumerable.
   (Jonas Nicklas)
@@ -2749,7 +3352,7 @@ validations error from before.
 
 * \#1173 has_many relations no longer delete all documents on a set of the relation
  (= [ doc_one, doc_two ]) but look to the dependent option to determine what
- behaviour should occur. :delete and :destroy will behave as before, :nullify and
+ behavior should occur. :delete and :destroy will behave as before, :nullify and
  no option specified will both nullify the old documents without deleting.
 
 * \#1142, \#767 Embedded relations no longer immediately persist atomically