mongoid 3.0.23 → 3.1.0

data/CHANGELOG.md

@@ -3,23 +3,267 @@
 For instructions on upgrading to newer versions, visit
 [mongoid.org](http://mongoid.org/en/mongoid/docs/upgrading.html).
 
-## 3.0.23
+## 3.1.0 (branch: master)
 
-### Resolved Issues
+### New Features
+
+* The minimum MongoDB requirement is now raised to 2.2, since we now
+  depend on the aggregation framework.
+
+* The minimum Active Model and Active Support dependencies have been
+  raised to 3.2.
+
+* \#2809 Relations can now specify a primary key to use instead of the
+  id on foreign keys.
+
+        class Person
+          include Mongoid::Document
+          field :username, type: String
+          has_many :cats, primary_key: "username"
+        end
+
+        class Cat
+          include Mongoid::Document
+          belongs_to :person, primary_key: "username"
+        end
+
+* \#2804 $geoNear support has now been added to criteria.
+
+        Bar.where(:likes.gt => 1000).geo_near([ 52, 13 ])
+        Bar.geo_near([ 52, 13 ]).max_distance(0.5).spherical
+
+* \#2799 Criteria#map can now accept a symbol of a field name as well as
+  a block to perform a more optimized `map`. (Gosha Arinich)
+
+        Band.where(:likes.gt => 1000).map(:name)
+
+* \#2798 Aggregations (`sum`, `min`, `max`, `avg`) now use the
+  aggregation framework instead of map/reduce. (Gosha Arinich)
+
+* \#2776 MongoDB 2.4.x new index types are now supported: "2dsphere",
+  "text", and "hashed". (Irakli Janiashvili)
+
+* \#2767 $maxScan support from Origin is now supported. (Jonathan Hyman)
+
+* \#2701 Cleanup up extra excessive database queries with 1-1 relations.
+
+* \#2693 Custom collection names can be passed to the model generator.
+  (Subhash Bhushan)
+
+        rails g model band --collection=artists
+
+* \#2688 `Model.create` and `Model.create!` now can take an array of
+  attributes hashes to create multiple documents at once. If an array
+  of attributes is provided then an array of documents is returned.
+
+        Band.create([{ name: "Tool" }, { name: "Placebo" }])
+        Band.create!([{ name: "Tool" }, { name: "Placebo" }])
+
+* \#2670 Unsetting fields now accepts multiple fields instead of only 1.
+  (Arthur Neves)
+
+        band.unset(:name, :founded)
+        Band.where(name: "Placebo").unset(:members, :origin)
+
+* \#2669 Passing a block to `Criteria#new` now properly sends the
+  block through to the model's contructor. (Arthur Neves)
+
+* \#2667 `exists?` no longer hits the database in cases where we have
+  the necessary information in memory.
+
+* \#2665 Mongoid now supports a counter cache for `belongs_to`
+  relations. (Arthur Neves)
+
+        class Band
+          include Mongoid::Document
+          belongs_to :label, counter_cache: "b_count"
+        end
+
+        class Album
+          include Mongoid::Document
+          belongs_to :band, counter_cache: true
+        end
+
+* \#2662 Embedded documents that have `belongs_to` relations may now
+  eager load them.
+
+* \#2657 Logger getter and setter convenience methods have been
+  added to the `Config` module. (Arthur Neves)
+
+* \#2615 Index options can now take a specific database name if the
+  indexes are only to exist in a database other than the default.
+
+        class Band
+          include Mongoid::Document
+          index name: 1, { database: "another_db" }
+        end
+
+* \#2613 Procs can now be provided as values to `store_in`:
+
+        class Band
+          include Mongoid::Document
+          store_in database: ->{ Thread.current[:database] }
+        end
+
+* \#2609 Pass through batch_size option to query. (Martin Mauch)
+
+* \#2555 Passing hashes to `find` when the documents id is of type hash
+  now properly works. (Szymon Kurcab)
+
+* \#2545 The `$` positional operator is used for update selectors on
+  embedded documents that are nested 1 level deep, when appropriate.
+
+* \#2539 `Mongoid.models` now tracks all models in the application for more
+  accurate determination of models for things such as indexing rake tasks.
+  (Ara Howard)
+
+* \#2525 Added the ability to have short timestamped fields with aliases. This
+  sets timestamp fields as `c_at` and `u_at` that are also aliased as
+  `created_at` and `updated_at` for convenience. (Rodrigo Saito)
+
+        class Band
+          include Mongoid::Document
+          include Mongoid::Timestamps::Short # For c_at and u_at.
+        end
 
-* \#2851 Fixed BigDecimal demongoization of NaN values. (nkem)
+        class Band
+          include Mongoid::Document
+          include Mongoid::Timestamps::Created::Short # For c_at only.
+        end
+
+        class Band
+          include Mongoid::Document
+          include Mongoid::Timestamps::Updated::Short # For u_at only.
+        end
+
+* \#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.
+
+        class Event
+          include Mongoid::Document
+          field :status, type: Integer
+          index({ status: 1 }, { expire_after_seconds: 3600 })
+        end
+
+* \#2373 Relations with the `touch: true` option will now be automatically
+  touched when the child document is created or destroyed.
+
+* Added `Document.first_or_create!` and `Criteria#first_or_create!`. This
+  raises a validations error if creation fails validation.
+
+        Band.where(name: "Depeche Mode").first_or_create!
+        Band.where(name: "Tool").first_or_create!(active: true)
 
-* \#2841 Calling `delete_all` or `destroy_all` on an embeds many when in the
-  middle of a parent update will now properly execute the deletion.
+* Added `Document.first_or_initialize` and `Criteria#first_or_initialize`.
+  This is the same as `first_or_create` but initializes a new (unpersisted)
+  document if none is found.
+
+        Band.where(name: "Depeche Mode").first_or_initialize
+        Band.where(name: "Tool").first_or_initialize(active: true)
+
+* Added `Model.pluck` and `Criteria#pluck` similar to Active Record's, which
+  returns an array of values for the provided field. (Jason Lee)
+
+        Band.where(name: "Depeche Mode").pluck(:_id)
+        Band.where(name: "Tool").pluck(:likes)
+
+* \#2324 Embeds many relations now properly handle `delete_if`.
+
+* \#2317 Added `Document.first_or_create` and `Criteria#first_or_create`.
+  This will return the first matching document or create one with additional
+  attributes if one does not exist. (incorvia)
+
+        Band.where(name: "Depeche Mode").first_or_create
+        Band.where(name: "Tool").first_or_create(active: true)
+
+* \#2292 Added `Model.each_with_index`.
+
+* \#2285 `Config.load_configuration` is now public for those who want to instantiate
+  settings directly from a hash.
+
+* \#2275 Added rake task `db:mongoid:purge` that will drop all collections with
+  the exception of the system collections in the default database.
+
+* \#2257 `after_find` callbacks have been added for when documents are returned
+  from the database.
+
+        class Band
+          include Mongoid::Document
+
+          after_find do |doc|
+            # Some logic here.
+          end
+        end
+
+* \#2223 Allow to find documents by javascript with parameters that are
+  protected from javascript injection via `Model.for_js`.
+
+        Band.for_js("this.name = param", param: "Tool")
+        Band.where(:likes.gt => 1000).for_js("this.likes < this.follows")
+
+* \#2197 When providing session configuration with no ports, Mongoid will now
+  default these to 27017.
+
+* \#2180 1-n and n-n relations now support before/after add/remove callbacks.
+  (Rodrigo Saito)
+
+        class Band
+          include Mongoid::Document
+
+          embeds_many :albums, after_add: :notify_labels
+          has_many :followers, before_remove: ->(band, follower){ notify_unfollow(follower) }
+        end
+
+* \#2157 `Criteria#update` and `Criteria#update_all` now serialize values
+  according to their field type, if a field is defined.
+
+* \#2022 Custom callbacks can now register themselves for use with observers
+  by using the `observable` macro.
+
+        class Band
+          include Mongoid::Document
+
+          define_model_callbacks :notification
+          observable :notification
+        end
+
+        class BandObserver < Mongoid::Observer
+
+          def before_notification(band)
+            #...
+          end
+
+          def after_notification(band)
+            #...
+          end
+        end
+
+* \#1766 Many to many relations will not touch the database if the foreign key
+  is an empty array.
+
+* \#1564 Many to many foreign keys now have the default set lazily only if the
+  relation has been accessed. This avoids storing empty arrays if the relation
+  has not been touched.
+
+### Resolved Issues
+
+* \#2730 Calling sort on a context properly updates the context's criteria.
   (Arthur Neves)
 
-* \#2835 Fixed clearing of persistence options in uniqueness validator.
+* \#2719 `distinct` is now available at the class level.
+
+        Band.distinct(:name)
 
-* \#2826 Dynamic fields are now properly mongoized.
+* \#2714 Overriding sessions when the new session has a different database will
+  now properly switch the database at runtime as well.
 
-* \#2822 Marshal load of relations now properly reapplies extensions.
+* \#2697 Eager loading fixed when including multiple models that inherit from
+  the same class. (Kirill Lazarev)
 
-* \#2821 Autosaved relations should be duped in inheriting classes.
+* \#2664 In memory sorting of embedded documents now properly works when
+  multiple fields are provided. (Neer Friedman)
 
 ## 3.0.22
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 Durran Jordan
+Copyright (c) 2009-2013 Durran Jordan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -8,6 +8,7 @@ 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)
 
 Compatibility
 -------------
@@ -23,6 +24,8 @@ 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'>
@@ -34,7 +37,7 @@ Donating
 License
 -------
 
-Copyright (c) 2009-2012 Durran Jordan
+Copyright (c) 2009-2013 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

@@ -74,7 +74,7 @@ en:
           resolution: "Remove the invalid option or fix the typo. If you were
             expecting the option to be there, please consult the following page
             with repect to Mongoid's configuration:\n\n
-            \_\_http://mongoid.org/docs/installation.html"
+            \_\_http://mongoid.org/en/mongoid/docs/installation.html"
         invalid_database:
           message: "Database should be a Mongo::DB, not %{name}."
           summary: "When setting a master database in the Mongoid configuration
@@ -135,7 +135,8 @@ en:
             \_\_max: 1\n
             \_\_bits: 26\n
             \_\_bucket_size : 1\n
-            Valid types are: 1, -1, '2d', 'geoHaystack'\n\n
+            \_\_weights: { content: 1, title: 2 }\n
+            Valid types are: 1, -1, '2d', '2dsphere', 'geoHaystack', 'text', 'hashed'\n\n
             Example:\n
             \_\_class Band\n
             \_\_\_\_include Mongoid::Document\n
@@ -323,8 +324,8 @@ en:
           message: "Cannot persist embedded document %{klass} without a
             parent document."
           summary: "If the document is embedded, in order to be persisted it
-            must always have a reference to it's parent document. This is
-            most likely cause by either calling %{klass}.create or
+            must always have a reference to its parent document. This is
+            most likely caused by either calling %{klass}.create or
             %{klass}.create! without setting the parent document as an
             attribute."
           resolution: "Ensure that you've set the parent relation if
@@ -393,7 +394,7 @@ en:
           summary: "Attributes flagged as readonly via Model.attr_readonly
             can only have values set when the document is a new record."
           resolution: "Don't define '%{name}' as readonly, or do not attempt
-            to update it's value after the document is persisted."
+            to update its value after the document is persisted."
         scope_overwrite:
           message: "Cannot create scope :%{scope_name}, because of existing
             method %{model_name}.%{scope_name}."
@@ -403,7 +404,7 @@ en:
           resolution: "Change the name of the scope so it does not conflict
             with the already defined method %{model_name}, or set the
             configuration option Mongoid.scope_overwrite_exception to false,
-            which is it's default. In this case a warning will be logged."
+            which is its default. In this case a warning will be logged."
         taken:
           "is already taken"
         too_many_nested_attribute_records:

data/lib/mongoid.rb

@@ -20,6 +20,9 @@
 # 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 "delegate"
 require "time"
 require "set"
@@ -33,6 +36,7 @@ require "active_model"
 require "origin"
 require "moped"
 
+require "mongoid/atomic/positionable"
 require "mongoid/evolvable"
 require "mongoid/extensions"
 require "mongoid/errors"
@@ -44,6 +48,7 @@ require "mongoid/callbacks"
 require "mongoid/config"
 require "mongoid/contextual"
 require "mongoid/copyable"
+require "mongoid/equality"
 require "mongoid/criteria"
 require "mongoid/dirty"
 require "mongoid/factory"
@@ -124,6 +129,18 @@ module Mongoid
     Sessions.default
   end
 
+  # Disconnect all active sessions.
+  #
+  # @example Disconnect all active sessions.
+  #   Mongoid.disconnect_sessions
+  #
+  # @return [ true ] True.
+  #
+  # @since 3.1.0
+  def disconnect_sessions
+    Sessions.disconnect
+  end
+
   # Convenience method for getting a named session.
   #
   # @example Get a named session.
@@ -144,6 +161,6 @@ module Mongoid
   #
   # @since 1.0.0
   delegate(*(Config.public_instance_methods(false) +
-    ActiveModel::Observing::ClassMethods.public_instance_methods(false) <<
+    ActiveModel::Observing::ClassMethods.public_instance_methods(false) - [:logger=, :logger] <<
     { to: Config }))
 end

data/lib/mongoid/atomic.rb

@@ -54,6 +54,18 @@ module Mongoid
       (delayed_atomic_unsets[document.metadata_name.to_s] ||= []).push(document)
     end
 
+    # Returns path of the attribute for modification
+    #
+    # @example Get path of the attribute
+    #   address.atomic_attribute_name(:city)
+    #
+    # @return [ String ] The path to the document attribute in the database
+    #
+    # @since 3.0.0
+    def atomic_attribute_name(name)
+      embedded? ? "#{atomic_position}.#{name}" : name
+    end
+
     # For array fields these are the pushes that need to happen.
     #
     # @example Get the array pushes.
@@ -113,7 +125,7 @@ module Mongoid
     # @return [ Hash ] The updates and their modifiers.
     #
     # @since 2.1.0
-    def atomic_updates
+    def atomic_updates(use_indexes = false)
       process_flagged_destroys
       mods = Modifiers.new
       generate_atomic_updates(mods, self)
@@ -168,14 +180,16 @@ module Mongoid
       atomic_paths.position
     end
 
-    # Returns path of the attribute for modification
+    # Get the atomic paths utility for this document.
     #
-    # @example Get path of the attribute
-    #   address.atomic_attribute_name(:city)
+    # @example Get the atomic paths.
+    #   document.atomic_paths
     #
-    # @return [ String ] The path to the document attribute in the database
-    def atomic_attribute_name(name)
-      embedded? ? "#{atomic_position}.#{name}" : name
+    # @return [ Object ] The associated path.
+    #
+    # @since 2.1.0
+    def atomic_paths
+      @atomic_paths ||= metadata ? metadata.path(self) : Atomic::Paths::Root.new(self)
     end
 
     # Get all the attributes that need to be pulled.
@@ -208,7 +222,7 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_pushes
-      pushable? ? { atomic_path => as_document } : {}
+      pushable? ? { atomic_position => as_document } : {}
     end
 
     # Return the selector for this document to be matched exactly for use
@@ -335,18 +349,6 @@ module Mongoid
 
     private
 
-    # Get the atomic paths utility for this document.
-    #
-    # @example Get the atomic paths.
-    #   document.atomic_paths
-    #
-    # @return [ Object ] The associated path.
-    #
-    # @since 2.1.0
-    def atomic_paths
-      @atomic_paths ||= metadata ? metadata.path(self) : Atomic::Paths::Root.new(self)
-    end
-
     # Generates the atomic updates in the correct order.
     #
     # @example Generate the updates.