mongoid 2.4.9 → 3.0.0.rc

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.rb

@@ -5,14 +5,14 @@ require "mongoid/persistence/operations/update"
 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 +80,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 +141,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

data/lib/mongoid/persistence.rb

@@ -5,7 +5,7 @@ require "mongoid/persistence/insertion"
 require "mongoid/persistence/modification"
 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 +19,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 +29,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 +49,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
@@ -79,7 +79,35 @@ module Mongoid #:nodoc:
       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
+      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 +128,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,12 +166,12 @@ 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) if errors.any?
+        self.class.fail_callback!(self, :update_attributes!)
       end
+      result
     end
 
     # Upsert the document - will perform an insert if the document is new, and
@@ -174,7 +208,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 +229,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) if doc.insert.errors.any?
+          fail_callback!(doc, :create!) if doc.new_record?
+          doc
         end
       end
 
@@ -216,11 +252,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 +276,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

data/lib/mongoid/railties/database.rake

@@ -1,27 +1,27 @@
 namespace :db do
 
   unless Rake::Task.task_defined?("db:drop")
-    desc 'Drops all the collections for the database for the current Rails.env'
+    desc "Drops all the collections for the database for the current Rails.env"
     task :drop => "mongoid:drop"
   end
 
   unless Rake::Task.task_defined?("db:seed")
-    # if another ORM has defined db:seed, don't run it twice.
-    desc 'Load the seed data from db/seeds.rb'
+    # if another ORM has defined db:seed, don"t run it twice.
+    desc "Load the seed data from db/seeds.rb"
     task :seed => :environment do
-      seed_file = File.join(Rails.root, 'db', 'seeds.rb')
+      seed_file = File.join(Rails.root, "db", "seeds.rb")
       load(seed_file) if File.exist?(seed_file)
     end
   end
 
   unless Rake::Task.task_defined?("db:setup")
-    desc 'Create the database, and initialize with the seed data'
-    task :setup => [ 'db:create', 'db:mongoid:create_indexes', 'db:seed' ]
+    desc "Create the database, and initialize with the seed data"
+    task :setup => [ "db:create", "db:mongoid:create_indexes", "db:seed" ]
   end
 
   unless Rake::Task.task_defined?("db:reseed")
-    desc 'Delete data and seed'
-    task :reseed => [ 'db:drop', 'db:seed' ]
+    desc "Delete data and seed"
+    task :reseed => [ "db:drop", "db:seed" ]
   end
 
   unless Rake::Task.task_defined?("db:create")
@@ -56,26 +56,13 @@ namespace :db do
     task :create_indexes => "mongoid:create_indexes"
   end
 
+  unless Rake::Task.task_defined?("db:remove_indexes")
+    task :remove_indexes => "mongoid:remove_indexes"
+  end
+
   namespace :mongoid do
-    # gets a list of the mongoid models defined in the app/models directory
-    def get_mongoid_models
-      documents = []
-      Dir.glob("app/models/**/*.rb").sort.each do |file|
-        model_path = file[0..-4].split('/')[2..-1]
-        begin
-          klass = model_path.map { |path| path.camelize }.join('::').constantize
-          if klass.ancestors.include?(Mongoid::Document) && !klass.embedded
-            documents << klass
-          end
-        rescue => e
-          # Just for non-mongoid objects that dont have the embedded
-          # attribute at the class level.
-        end
-      end
-      documents
-    end
 
-    desc 'Create the indexes defined on your mongoid models'
+    desc "Create the indexes defined on your mongoid models"
     task :create_indexes => :environment do
       engines_models_paths = Rails.application.railties.engines.map do |engine|
         engine.paths["app/models"].expanded
@@ -88,95 +75,22 @@ namespace :db do
       end
     end
 
-    def convert_ids(obj)
-      if obj.is_a?(String) && obj =~ /^[a-f0-9]{24}$/
-        BSON::ObjectId(obj)
-      elsif obj.is_a?(Array)
-        obj.map do |v|
-          convert_ids(v)
-        end
-      elsif obj.is_a?(Hash)
-        obj.each_pair do |k, v|
-          obj[k] = convert_ids(v)
-        end
-      else
-        obj
-      end
-    end
-
-    def collection_names
-      @collection_names ||= get_mongoid_models.map{ |d| d.collection.name }.uniq
-    end
-
-    desc "Convert string objectids in mongo database to ObjectID type"
-    task :objectid_convert => :environment do
-      collection_names.each do |collection_name|
-        puts "Converting #{collection_name} to use ObjectIDs"
-
-        # get old collection
-        collection = Mongoid.master.collection(collection_name)
-
-        # get new collection (a clean one)
-        collection.db["#{collection_name}_new"].drop
-        new_collection = collection.db["#{collection_name}_new"]
-
-        # convert collection documents
-        collection.find({}, :timeout => false, :sort => "_id") do |cursor|
-           cursor.each do |doc|
-            new_doc = convert_ids(doc)
-            new_collection.insert(new_doc, :safe => true)
-          end
-        end
-
-        puts "Done! Converted collection is in #{new_collection.name}\n\n"
-      end
-
-      # no errors. great! now rename _new to collection_name
-      collection_names.each do |collection_name|
-        collection = Mongoid.master.collection(collection_name)
-        new_collection = collection.db["#{collection_name}_new"]
-
-        # swap collection to _old
-        puts "Moving #{collection.name} to #{collection_name}_old"
-        collection.db["#{collection_name}_old"].drop
-
-        begin
-          collection.rename("#{collection_name}_old")
-        rescue Exception => e
-          puts "Unable to rename database #{collection_name} to #{collection_name}_old"
-          puts "reason: #{e.message}\n\n"
-        end
-
-        # swap _new to collection
-        puts "Moving #{new_collection.name} to #{collection_name}\n\n"
-
-        begin
-          new_collection.rename(collection_name)
-        rescue Exception => e
-          puts "Unable to rename database #{new_collection.name} to #{collection_name}"
-          puts "reason: #{e.message}\n\n"
-        end
+    desc "Remove the indexes defined on your mongoid models without questions!"
+    task :remove_indexes => :environment do
+      engines_models_paths = Rails.application.railties.engines.map do |engine|
+        engine.paths["app/models"].expanded
       end
+      root_models_paths = Rails.application.paths["app/models"]
+      models_paths = engines_models_paths.push(root_models_paths).flatten
 
-      puts "DONE! Run `rake db:mongoid:cleanup_old_collections` to remove old collections"
-    end
-
-    desc "Clean up old collections backed up by objectid_convert"
-    task :cleanup_old_collections => :environment do
-      collection_names.each do |collection_name|
-        collection = Mongoid.master.collection(collection_name)
-        collection.db["#{collection.name}_old"].drop
+      models_paths.each do |path|
+        ::Rails::Mongoid.remove_indexes("#{path}/**/*.rb")
       end
     end
 
     desc "Drops the database for the current Rails.env"
     task :drop => :environment do
-      Mongoid.master.collections.select {|c| c.name !~ /system/ }.each { |c| c.drop }
+      ::Mongoid::Sessions.default.drop
     end
-
-    ########
-    # TODO: lots more useful db tasks can be added here. stuff like copyDatabase, etc
-    ########
   end
-
 end

data/lib/mongoid/relations/accessors.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
+module Mongoid
+  module Relations
 
     # This module contains all the behaviour related to accessing relations
     # through the getters and setters, and how to delegate to builders to
@@ -12,7 +12,7 @@ module Mongoid # :nodoc:
       # document is nil, then sets the relation on this document.
       #
       # @example Build the relation.
-      #   person.build(:addresses, { :id => 1 }, metadata)
+      #   person.__build__(:addresses, { :id => 1 }, metadata)
       #
       # @param [ String, Symbol ] name The name of the relation.
       # @param [ Hash, BSON::ObjectId ] object The id or attributes to use.
@@ -22,7 +22,7 @@ module Mongoid # :nodoc:
       # @return [ Proxy ] The relation.
       #
       # @since 2.0.0.rc.1
-      def build(name, object, metadata)
+      def __build__(name, object, metadata)
         relation = create_relation(object, metadata)
         set_relation(name, relation)
       end
@@ -74,7 +74,64 @@ module Mongoid # :nodoc:
         instance_variable_set("@#{name}", relation)
       end
 
-      module ClassMethods #:nodoc:
+      private
+
+      # Is the current code executing without autobuild functionality?
+      #
+      # @example Is autobuild disabled?
+      #   document.without_autobuild?
+      #
+      # @return [ true, false ] If autobuild is disabled.
+      #
+      # @since 3.0.0
+      def without_autobuild?
+        Threaded.executing?(:without_autobuild)
+      end
+
+      # Yield to the block with autobuild functionality turned off.
+      #
+      # @example Execute without autobuild.
+      #   document.without_autobuild do
+      #     document.name
+      #   end
+      #
+      # @return [ Object ] The result of the yield.
+      #
+      # @since 3.0.0
+      def without_autobuild
+        Threaded.begin("without_autobuild")
+        yield
+      ensure
+        Threaded.exit("without_autobuild")
+      end
+
+      module ClassMethods
+
+        # Adds the existence check for relations.
+        #
+        # @example Add the existence check.
+        #   Person.existence_check(:name, meta)
+        #
+        # @example Check if a relation exists.
+        #   person = Person.new
+        #   person.has_game?
+        #   person.game?
+        #
+        # @param [ String, Symbol ] name The name of the relation.
+        # @param [ Metadata ] The metadata.
+        #
+        # @return [ Class ] The model being set up.
+        #
+        # @since 3.0.0
+        def existence_check(name, metadata)
+          module_eval <<-END
+            def #{name}?
+              without_autobuild { !#{name}.blank? }
+            end
+            alias :has_#{name}? :#{name}?
+          END
+          self
+        end
 
         # Defines the getter for the relation. Nothing too special here: just
         # return the instance variable for the relation if it exists or build
@@ -90,22 +147,43 @@ module Mongoid # :nodoc:
         #
         # @since 2.0.0.rc.1
         def getter(name, metadata)
-          tap do
-            define_method(name) do |*args|
-              reload, variable = args.first, "@#{name}"
-              if instance_variable_defined?(variable) && !reload
-                instance_variable_get(variable)
-              else
-                _building do
-                  _loading do
-                    build(name, attributes[metadata.key], metadata)
-                  end
-                end
+          re_define_method(name) do |*args|
+            reload, variable = args.first, "@#{name}"
+            value = if instance_variable_defined?(variable) && !reload
+              instance_variable_get(variable)
+            else
+              _building do
+                _loading { __build__(name, attributes[metadata.key], metadata) }
               end
             end
+            if value.nil? && metadata.autobuilding? && !without_autobuild?
+              send("build_#{name}")
+            else
+              value
+            end
+          end
+          self
+        end
+
+        # Defines the getter for the ids of documents in the relation. Should
+        # be specify only for referenced many relations.
+        #
+        # @example Set up the ids getter for the relation.
+        #   Person.ids_getter("addresses", metadata)
+        #
+        # @param [ String, Symbol ] name The name of the relation.
+        # @param [ Metadata] metadata The metadata for the relation.
+        #
+        # @return [ Class ] The class being set up.
+        def ids_getter(name, metadata)
+          ids_method = "#{name.to_s.singularize}_ids"
+          re_define_method(ids_method) do
+            send(name).only(:id).map(&:id)
           end
+          self
         end
 
+
         # Defines the setter for the relation. This does a few things based on
         # some conditions. If there is an existing association, a target
         # substitution will take place, otherwise a new relation will be
@@ -121,16 +199,38 @@ module Mongoid # :nodoc:
         #
         # @since 2.0.0.rc.1
         def setter(name, metadata)
-          tap do
-            define_method("#{name}=") do |object|
+          re_define_method("#{name}=") do |object|
+            without_autobuild do
               if relation_exists?(name) || metadata.many? ||
                 (object.blank? && send(name))
                 set_relation(name, send(name).substitute(object.substitutable))
               else
-                build(name, object.substitutable, metadata)
+                __build__(name, object.substitutable, metadata)
               end
             end
           end
+          self
+        end
+
+        # Defines the setter method that allows you to set documents
+        # in this relation by their ids. The defined setter, finds
+        # documents with given ids and invokes regular relation setter
+        # with found documents. Ids setters should be defined only for
+        # referenced many relations.
+        #
+        # @example Set up the id_setter for the relation.
+        #   Person.ids_setter("addesses", metadata)
+        #
+        #  @param [ String, Symbol ] name The name of the relation.
+        #  @param [ Metadata ] metadata The metadata for the relation.
+        #
+        #  @return [ Class ] The class being set up.
+        def ids_setter(name, metadata)
+          ids_method = "#{name.to_s.singularize}_ids="
+          re_define_method(ids_method) do |ids|
+            send(metadata.setter, metadata.klass.find(ids))
+          end
+          self
         end
       end
     end