mongoid 2.4.10 → 3.0.0

data/lib/mongoid/persistence/insertion.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
+module Mongoid
+  module Persistence
 
     # Contains common logic for insertion operations.
     module Insertion
@@ -19,23 +19,17 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def prepare(&block)
-        document.tap do |doc|
-          unless validating? && document.invalid?(:create)
-            result = doc.run_callbacks(:save) do
-              doc.run_callbacks(:create) do
-                yield(doc)
-                doc.new_record = false
-                true
-              end
-            end
-
-            unless result == false
-              doc.reset_persisted_children
-              doc.move_changes
-              Threaded.clear_options!
+        unless validating? && document.invalid?(:create)
+          result = document.run_callbacks(:save) do
+            document.run_callbacks(:create) do
+              yield(document)
+              document.new_record = false
+              true
             end
           end
+          document.post_persist unless result == false
         end
+        document
       end
     end
   end

data/lib/mongoid/persistence/modification.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
+module Mongoid
+  module Persistence
 
     # Contains common logic for modification operations.
     module Modification
@@ -20,17 +20,13 @@ module Mongoid #:nodoc:
       # @since 2.1.0
       def prepare(&block)
         return false if validating? && document.invalid?(:update)
-        document.run_callbacks(:save) do
+        result = document.run_callbacks(:save) do
           document.run_callbacks(:update) do
             yield(document); true
           end
-        end.tap do |result|
-          unless result == false
-            document.reset_persisted_children
-            document.move_changes
-            Threaded.clear_options!
-          end
         end
+        document.post_persist unless result == false
+        result
       end
     end
   end

data/lib/mongoid/persistence/operations/embedded/insert.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
-    module Operations #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Persistence
+    module Operations
+      module Embedded
 
         # Insert is a persistence command responsible for taking a document that
         # has not been saved to the database and saving it. This specific class
@@ -28,10 +28,11 @@ module Mongoid #:nodoc:
           # @return [ Document ] The document to be inserted.
           def persist
             prepare do
-              if parent.new?
+              raise Errors::NoParent.new(document.class.name) unless parent
+              if parent.new_record?
                 parent.insert
               else
-                collection.update(parent.atomic_selector, inserts, options)
+                collection.find(parent.atomic_selector).update(inserts)
               end
             end
           end

data/lib/mongoid/persistence/operations/embedded/remove.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
-    module Operations #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Persistence
+    module Operations
+      module Embedded
 
         # Remove is a persistence command responsible for deleting a document from
         # the database.
@@ -29,7 +29,7 @@ module Mongoid #:nodoc:
             prepare do |doc|
               parent.remove_child(doc) if notifying_parent?
               if parent.persisted?
-                collection.update(parent.atomic_selector, deletes, options)
+                collection.find(parent.atomic_selector).update(deletes)
               end
             end
           end

data/lib/mongoid/persistence/operations/insert.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
-    module Operations #:nodoc:
+module Mongoid
+  module Persistence
+    module Operations
 
       # Insert is a persistence command responsible for taking a document that
       # has not been saved to the database and saving it.
@@ -24,7 +24,7 @@ module Mongoid #:nodoc:
         # @return [ Document ] The document to be inserted.
         def persist
           prepare do |doc|
-            collection.insert(doc.as_document, options)
+            collection.insert(doc.as_document)
             IdentityMap.set(doc)
           end
         end

data/lib/mongoid/persistence/operations/remove.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
-    module Operations #:nodoc:
+module Mongoid
+  module Persistence
+    module Operations
 
       # Remove is a persistence command responsible for deleting a document from
       # the database.
@@ -24,7 +24,7 @@ module Mongoid #:nodoc:
         # @return [ true ] Always true.
         def persist
           prepare do |doc|
-            collection.remove({ :_id => doc.id }, options)
+            collection.find(doc.atomic_selector).remove
           end
         end
       end

data/lib/mongoid/persistence/operations/update.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
-    module Operations #:nodoc:
+module Mongoid
+  module Persistence
+    module Operations
 
       # Update is a persistence command responsible for taking a document that
       # has already been saved to the database and saving it, depending on
@@ -42,9 +42,9 @@ module Mongoid #:nodoc:
         def persist
           prepare do
             unless updates.empty?
-              collection.update(selector, updates, options)
+              collection.find(selector).update(updates)
               conflicts.each_pair do |key, value|
-                collection.update(selector, { key => value }, options)
+                collection.find(selector).update({ key => value })
               end
             end
           end

data/lib/mongoid/persistence/operations/upsert.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid
+  module Persistence
+    module Operations
+
+      # Wraps behaviour for performing upserts in Mongodb. No matter if the
+      # document has been modified or not, it will be sent to the db and Mongo
+      # will determin whether or not to insert or update.
+      class Upsert
+        include Upsertion, Operations
+
+        # Persist the upsert operation.
+        #
+        # @example Execute the upsert.
+        #   operation.persist
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 3.0.0
+        def persist
+          prepare do
+            collection.find(selector).update(document.as_document, [ :upsert ])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/operations.rb

@@ -2,17 +2,18 @@
 require "mongoid/persistence/operations/insert"
 require "mongoid/persistence/operations/remove"
 require "mongoid/persistence/operations/update"
+require "mongoid/persistence/operations/upsert"
 require "mongoid/persistence/operations/embedded/insert"
 require "mongoid/persistence/operations/embedded/remove"
 
-module Mongoid #:nodoc:
-  module Persistence #:nodoc:
+module Mongoid
+  module Persistence
 
     # Persistence operations include this module to get basic functionality
     # on initialization.
     module Operations
 
-      attr_reader :conflicts, :document
+      attr_reader :conflicts, :document, :options
 
       # Get the collection we should be persisting to.
       #
@@ -80,19 +81,6 @@ module Mongoid #:nodoc:
         @notifying_parent ||= !@options.delete(:suppress)
       end
 
-      # Get all the options that will be sent to the database. Right now this
-      # is only safe mode opts.
-      #
-      # @example Get the options hash.
-      #   operation.options
-      #
-      # @return [ Hash ] The options for the database.
-      #
-      # @since 2.1.0
-      def options
-        Safety.merge_safety_options(@options)
-      end
-
       # Get the parent of the provided document.
       #
       # @example Get the parent.
@@ -154,9 +142,9 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def init_updates
-        document.atomic_updates.tap do |updates|
-          @conflicts = updates.delete(:conflicts) || {}
-        end
+        updates = document.atomic_updates
+        @conflicts = updates.delete(:conflicts) || {}
+        updates
       end
 
       class << self
@@ -205,6 +193,21 @@ module Mongoid #:nodoc:
         def update(doc, options = {})
           Update.new(doc, options)
         end
+
+        # Get the appropriate upsert operation based on the document.
+        #
+        # @example Get the upsert operation.
+        #   Operations.upsert(doc, options)
+        #
+        # @param [ Document ] doc The document to persist.
+        # @param [ Hash ] options The persistence options.
+        #
+        # @return [ Operations ] The operation.
+        #
+        # @since 3.0.0
+        def upsert(doc, options = {})
+          Upsert.new(doc, options)
+        end
       end
     end
   end

data/lib/mongoid/persistence/upsertion.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mongoid
+  module Persistence
+
+    # Contains common logic for upsert operations.
+    module Upsertion
+
+      # Wrap all the common upsert logic for root docments.
+      #
+      # @example Execute common upsert logic.
+      #   prepare do |doc|
+      #     collection.find({ :_id => 1 }).upsert({ name: "test" }, [ :upsert ])
+      #   end
+      #
+      # @param [ Proc ] block The block to call.
+      #
+      # @return [ true, false ] If the save passed or not.
+      #
+      # @since 3.0.0
+      def prepare(&block)
+        return false if validating? && document.invalid?(:upsert)
+        result = document.run_callbacks(:upsert) do
+          yield(document); true
+        end
+        document.post_persist unless result == false
+        result
+      end
+    end
+  end
+end

data/lib/mongoid/persistence.rb

@@ -3,9 +3,10 @@ require "mongoid/persistence/atomic"
 require "mongoid/persistence/deletion"
 require "mongoid/persistence/insertion"
 require "mongoid/persistence/modification"
+require "mongoid/persistence/upsertion"
 require "mongoid/persistence/operations"
 
-module Mongoid #:nodoc:
+module Mongoid
 
   # The persistence module is a mixin to provide database accessor methods for
   # the document. These correspond to the appropriate accessors on a
@@ -19,7 +20,7 @@ module Mongoid #:nodoc:
     extend ActiveSupport::Concern
     include Atomic
 
-    # Remove the document from the datbase with callbacks.
+    # Remove the document from the database with callbacks.
     #
     # @example Destroy a document.
     #   document.destroy
@@ -29,11 +30,11 @@ module Mongoid #:nodoc:
     # @return [ true, false ] True if successful, false if not.
     def destroy(options = {})
       self.flagged_for_destroy = true
-      run_callbacks(:destroy) do
+      result = run_callbacks(:destroy) do
         remove(options)
-      end.tap do
-        self.flagged_for_destroy = false
       end
+      self.flagged_for_destroy = false
+      result
     end
 
     # Insert a new document into the database. Will return the document
@@ -49,7 +50,7 @@ module Mongoid #:nodoc:
       Operations.insert(self, options).persist
     end
 
-    # Remove the document from the datbase.
+    # Remove the document from the database.
     #
     # @example Remove the document.
     #   document.remove
@@ -62,6 +63,25 @@ module Mongoid #:nodoc:
     end
     alias :delete :remove
 
+    # Save the document - will perform an insert if the document is new, and
+    # update if not.
+    #
+    # @example Save the document.
+    #   document.save
+    #
+    # @param [ Hash ] options Options to pass to the save.
+    #
+    # @return [ true, false ] True is success, false if not.
+    #
+    # @since 1.0.0
+    def save(options = {})
+      if new_record?
+        insert(options).persisted?
+      else
+        update(options)
+      end
+    end
+
     # Save the document - will perform an insert if the document is new, and
     # update if not. If a validation error occurs an error will get raised.
     #
@@ -72,14 +92,42 @@ module Mongoid #:nodoc:
     #
     # @return [ true, false ] True if validation passed.
     def save!(options = {})
-      unless upsert(options)
-        self.class.fail_validate!(self) if errors.any?
+      unless save(options)
+        self.class.fail_validate!(self) unless errors.empty?
         self.class.fail_callback!(self, :save!)
       end
       return true
     end
 
-    # Update the document in the datbase.
+    # Touch the document, in effect updating it's updated_at timestamp and
+    # optionally the provided field to the current time. If any belongs_to
+    # relations exist with a touch option, they will be updated as well.
+    #
+    # @example Update the updated_at timestamp.
+    #   document.touch
+    #
+    # @example Update the updated_at and provided timestamps.
+    #   document.touch(:audited)
+    #
+    # @note This will not autobuild relations if those options are set.
+    #
+    # @param [ Symbol ] field The name of an additional field to update.
+    #
+    # @return [ true ] true.
+    #
+    # @since 3.0.0
+    def touch(field = nil)
+      current = Time.now
+      write_attribute(:updated_at, current) if fields["updated_at"]
+      write_attribute(field, current) if field
+      _root.collection.find(atomic_selector).update(atomic_updates)
+      without_autobuild do
+        touchables.each { |name| send(name).try(:touch) }
+      end
+      move_changes and true
+    end
+
+    # Update the document in the database.
     #
     # @example Update an existing document.
     #   document.update
@@ -100,15 +148,21 @@ module Mongoid #:nodoc:
     # @param [ Symbol, String ] name The name of the attribute.
     # @param [ Object ] value The new value of the attribute.a
     #
+    # @raise [ Errors::ReadonlyAttribute ] If the field cannot be changed due
+    #   to being flagged as reaodnly.
+    #
     # @return [ true, false ] True if save was successfull, false if not.
     #
     # @since 2.0.0.rc.6
     def update_attribute(name, value)
+      unless attribute_writable?(name.to_s)
+        raise Errors::ReadonlyAttribute.new(name, value)
+      end
       write_attribute(name, value)
-      save(:validate => false)
+      save(validate: false)
     end
 
-    # Update the document attributes in the datbase.
+    # Update the document attributes in the database.
     #
     # @example Update the document's attributes
     #   document.update_attributes(:title => "Sir")
@@ -132,31 +186,29 @@ module Mongoid #:nodoc:
     #
     # @return [ true, false ] True if validation passed.
     def update_attributes!(attributes = {}, options = {})
-      update_attributes(attributes, options).tap do |result|
-        unless result
-          self.class.fail_validate!(self) if errors.any?
-          self.class.fail_callback!(self, :update_attributes!)
-        end
+      result = update_attributes(attributes, options)
+      unless result
+        self.class.fail_validate!(self) unless errors.empty?
+        self.class.fail_callback!(self, :update_attributes!)
       end
+      result
     end
 
-    # Upsert the document - will perform an insert if the document is new, and
-    # update if not.
+    # Perform an upsert of the document. If the document does not exist in the
+    # database, then Mongo will insert a new one, otherwise the fields will get
+    # overwritten with new values on the existing document.
     #
     # @example Upsert the document.
     #   document.upsert
     #
-    # @param [ Hash ] options Options to pass to the upsert.
+    # @param [ Hash ] options The validation options.
     #
-    # @return [ true, false ] True is success, false if not.
+    # @return [ true ] True.
+    #
+    # @since 3.0.0
     def upsert(options = {})
-      if new_record?
-        insert(options).persisted?
-      else
-        update(options)
-      end
+      Operations.upsert(self, options).persist
     end
-    alias :save :upsert
 
     module ClassMethods #:nodoc:
 
@@ -174,7 +226,9 @@ module Mongoid #:nodoc:
       # @return [ Document ] The newly created document.
       def create(attributes = {}, options = {}, &block)
         _creating do
-          new(attributes, options, &block).tap { |doc| doc.save }
+          doc = new(attributes, options, &block)
+          doc.save
+          doc
         end
       end
 
@@ -193,10 +247,10 @@ module Mongoid #:nodoc:
       # @return [ Document ] The newly created document.
       def create!(attributes = {}, options = {}, &block)
         _creating do
-          new(attributes, options, &block).tap do |doc|
-            fail_validate!(doc) if doc.insert.errors.any?
-            fail_callback!(doc, :create!) if doc.new?
-          end
+          doc = new(attributes, options, &block)
+          fail_validate!(doc) unless doc.insert.errors.empty?
+          fail_callback!(doc, :create!) if doc.new_record?
+          doc
         end
       end
 
@@ -216,11 +270,12 @@ module Mongoid #:nodoc:
       def delete_all(conditions = nil)
         conds = conditions || {}
         selector = conds[:conditions] || conds
-        selector.merge!(:_type => name) if hereditary?
-        collection.find(selector).count.tap do
-          collection.remove(selector, Safety.merge_safety_options)
-          Threaded.clear_options!
-        end
+        selector.merge!(_type: name) if hereditary?
+        coll = collection
+        deleted = coll.find(selector).count
+        coll.find(selector).remove_all
+        Threaded.clear_options!
+        deleted
       end
 
       # Delete all documents given the supplied conditions. If no conditions
@@ -239,9 +294,9 @@ module Mongoid #:nodoc:
       def destroy_all(conditions = nil)
         conds = conditions || {}
         documents = where(conds[:conditions] || conds)
-        documents.count.tap do
-          documents.each { |doc| doc.destroy }
-        end
+        destroyed = documents.count
+        documents.each { |doc| doc.destroy }
+        destroyed
       end
 
       # Raise an error if validation failed.

data/lib/mongoid/railtie.rb

@@ -1,14 +1,13 @@
 # encoding: utf-8
-require "singleton"
 require "mongoid"
 require "mongoid/config"
 require "mongoid/railties/document"
 require "rails"
 require "rails/mongoid"
 
-module Rails #:nodoc:
-  module Mongoid #:nodoc:
-    class Railtie < Rails::Railtie #:nodoc:
+module Rails
+  module Mongoid
+    class Railtie < Rails::Railtie
 
       # Determine which generator to use. app_generators was introduced after
       # 3.0.0.
@@ -23,7 +22,7 @@ module Rails #:nodoc:
         config.respond_to?(:app_generators) ? :app_generators : :generators
       end
 
-      # Maping of rescued exceptions to HTTP responses
+      # Mapping of rescued exceptions to HTTP responses
       #
       # @example
       #   railtie.rescue_responses
@@ -38,7 +37,7 @@ module Rails #:nodoc:
         }
       end
 
-      config.send(generator).orm :mongoid, :migration => false
+      config.send(generator).orm :mongoid, migration: false
 
       if config.action_dispatch.rescue_responses
         config.action_dispatch.rescue_responses.merge!(rescue_responses)
@@ -73,15 +72,22 @@ module Rails #:nodoc:
       #       # - host: localhost
       #         # port: 27019
       #     allow_dynamic_fields: false
-      #     parameterize_keys: false
       #     persist_in_safe_mode: false
       #
       initializer "setup database" do
         config_file = Rails.root.join("config", "mongoid.yml")
-        # @todo: Durran: Remove extra check when #1291 complete.
-        if config_file.file? &&
-          YAML.load(ERB.new(File.read(config_file)).result)[Rails.env].values.flatten.any?
-          ::Mongoid.load!(config_file)
+        if config_file.file?
+          begin
+            ::Mongoid.load!(config_file)
+          rescue ::Mongoid::Errors::NoSessionsConfig => e
+            handle_configuration_error(e)
+          rescue ::Mongoid::Errors::NoDefaultSession => e
+            handle_configuration_error(e)
+          rescue ::Mongoid::Errors::NoSessionDatabase => e
+            handle_configuration_error(e)
+          rescue ::Mongoid::Errors::NoSessionHosts => e
+            handle_configuration_error(e)
+          end
         end
       end
 
@@ -139,6 +145,15 @@ module Rails #:nodoc:
           end
         end
       end
+
+      # Rails runs all initializers first before getting into any generator
+      # code, so we have no way in the intitializer to know if we are
+      # generating a mongoid.yml. So instead of failing, we catch all the
+      # errors and print them out.
+      def handle_configuration_error(e)
+        puts "There is a configuration error with the current mongoid.yml."
+        puts e.message
+      end
     end
   end
 end