stonegao-mongoid 2.0.0.rc.6

data/lib/mongoid/safe.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  # Contains behaviour for determining if Mongoid is in safe mode.
+  module Safe
+
+    # Determine based on configuration if we are persisting in safe mode or
+    # not.
+    #
+    # The query option will always override the global configuration.
+    #
+    # @example Are we in safe mode?
+    #   document.safe_mode?(:safe => true)
+    #
+    # @param [ Hash ] options Persistence options.
+    #
+    # @return [ true, false ] True if in safe mode, false if not.
+    def safe_mode?(options)
+      safe = options[:safe]
+      safe.nil? ? Mongoid.persist_in_safe_mode : safe
+    end
+  end
+end

data/lib/mongoid/safety.rb

@@ -0,0 +1,207 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  # The +Safety+ module is used to provide a DSL to execute database operations
+  # in safe mode on a per query basis, either from the +Document+ class level
+  # or instance level.
+  module Safety
+    extend ActiveSupport::Concern
+
+    # Execute the following class-level persistence operation in safe mode.
+    #
+    # @example Upsert in safe mode.
+    #   person.safely.upsert
+    #
+    # @example Destroy in safe mode with w and fsync options.
+    #   person.safely(:w => 2, :fsync => true).destroy
+    #
+    # @param [ Hash ] options The safe mode options.
+    #
+    # @option options [ Integer ] :w The number of nodes to write to.
+    # @option options [ Integer ] :wtimeout Time to wait for return from all
+    #   nodes.
+    # @option options [ true, false ] :fsync Should a fsync occur.
+    #
+    # @return [ Proxy ] The safety proxy.
+    def safely(safety = true)
+      Proxy.new(self, safety)
+    end
+
+    module ClassMethods #:nodoc:
+
+      # Execute the following class-level persistence operation in safe mode.
+      #
+      # @example Create in safe mode.
+      #   Person.safely.create(:name => "John")
+      #
+      # @example Delete all in safe mode with options.
+      #   Person.safely(:w => 2, :fsync => true).delete_all
+      #
+      # @param [ Hash ] options The safe mode options.
+      #
+      # @option options [ Integer ] :w The number of nodes to write to.
+      # @option options [ Integer ] :wtimeout Time to wait for return from all
+      #   nodes.
+      # @option options [ true, false ] :fsync Should a fsync occur.
+      #
+      # @return [ Proxy ] The safety proxy.
+      def safely(safety = true)
+        Proxy.new(self, safety)
+      end
+    end
+
+    # When this class proxies a document or class, the next persistence
+    # operation executed on it will query in safe mode.
+    #
+    # Operations that took a hash of attributes had to be somewhat duplicated
+    # here since we do not want to allow a :safe attribute to be included in
+    # the args. This is because safe could be a common attribute name and we
+    # don't want the collision between the attribute and determining whether or
+    # not safe mode is allowed.
+    class Proxy
+
+      attr_reader :target, :safety_options
+
+      # Create a new +Document+. This will instantiate a new document and
+      # insert it in a single call. Will always return the document
+      # whether save passed or not.
+      #
+      # @example Safely create a document.
+      #   Person.safely.create(:title => "Mr")
+      #
+      # @param [ Hash ] attributes The attributes to create with.
+      #
+      # @return [ Document ] The new document.
+      def create(attributes = {})
+        target.new(attributes).tap { |doc| doc.insert(:safe => safety_options) }
+      end
+
+      # Create a new +Document+. This will instantiate a new document and
+      # insert it in a single call. Will always return the document
+      # whether save passed or not, and if validation fails an error will be
+      # raise.
+      #
+      # @example Safely create a document.
+      #   Person.safely.create!(:title => "Mr")
+      #
+      # @param [ Hash ] attributes The attributes to create with.
+      #
+      # @raise [ Errors::Validations ] If validation failed.
+      #
+      # @return [ Document ] If validation passed.
+      def create!(attributes = {})
+        target.new(attributes).tap do |document|
+          fail_validate!(document) if document.insert(:safe => safety_options).errors.any?
+        end
+      end
+
+      # Delete all documents given the supplied conditions. If no conditions
+      # are passed, the entire collection will be dropped for performance
+      # benefits. Does not fire any callbacks.
+      #
+      # @example Delete all documents.
+      #   Person.safely.delete_all
+      #
+      # @example Conditionally delete all documents.
+      #   Person.safely.delete_all(:conditions => { :title => "Sir" })
+      #
+      # @param [ Hash ] conditions The conditions to delete with.
+      #
+      # @return [ Integer ] The number of documents deleted.
+      def delete_all(conditions = {})
+        Mongoid::Persistence::RemoveAll.new(
+          target,
+          { :validate => false, :safe => safety_options },
+          conditions[:conditions] || {}
+        ).persist
+      end
+
+      # destroy all documents given the supplied conditions. If no conditions
+      # are passed, the entire collection will be dropped for performance
+      # benefits. Fires the destroy callbacks if conditions were passed.
+      #
+      # @example destroy all documents.
+      #   Person.safely.destroy_all
+      #
+      # @example Conditionally destroy all documents.
+      #   Person.safely.destroy_all(:conditions => { :title => "Sir" })
+      #
+      # @param [ Hash ] conditions The conditions to destroy with.
+      #
+      # @return [ Integer ] The number of documents destroyd.
+      def destroy_all(conditions = {})
+        documents = target.all(conditions)
+        documents.count.tap do |count|
+          documents.each { |doc| doc.destroy(:safe => safety_options) }
+        end
+      end
+
+      # Increment the field by the provided value, else if it doesn't exists set
+      # it to that value.
+      #
+      # @example Safely increment a field.
+      #   person.safely.inc(:age, 1)
+      #
+      # @param [ Symbol, String ] field The field to increment.
+      # @param [ Integer ] value The value to increment by.
+      # @param [ Hash ] options Options to pass through to the driver.
+      def inc(field, value, options = {})
+        target.inc(field, value, :safe => safety_options)
+      end
+
+      # Create the new +Proxy+.
+      #
+      # @example Create the proxy.
+      #   Proxy.new(document, :w => 3)
+      #
+      # @param [ Document, Class ] target Either the class or the instance.
+      # @param [ true, Hash ] safety_options The options.
+      def initialize(target, safety_options)
+        @target = target
+        @safety_options = safety_options
+      end
+
+      # We will use method missing to proxy calls to the target.
+      #
+      # @example Save safely.
+      #   person.safely.save
+      #
+      # @param [ Array ] *args The arguments to pass on.
+      def method_missing(*args)
+        name = args[0]
+        attributes = args[1] || {}
+        target.send(name, attributes.merge(:safe => safety_options))
+      end
+
+      # Update the +Document+ attributes in the datbase.
+      #
+      # @example Safely update attributes.
+      #   person.safely.update_attributes(:title => "Sir")
+      #
+      # @param [ Hash ] attributes The attributes to update.
+      #
+      # @return [ true, false ] Whether the document was saved.
+      def update_attributes(attributes = {})
+        target.write_attributes(attributes)
+        target.update(:safe => safety_options)
+      end
+
+      # Update the +Document+ attributes in the datbase.
+      #
+      # @example Safely update attributes.
+      #   person.safely.update_attributes(:title => "Sir")
+      #
+      # @param [ Hash ] attributes The attributes to update.
+      #
+      # @raise [ Errors::Validations ] If validation failed.
+      #
+      # @return [ true ] If the document was saved.
+      def update_attributes!(attributes = {})
+        target.write_attributes(attributes)
+        update(:safe => safety_options).tap do |result|
+          target.class.fail_validate!(target) unless result
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/scope.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  # This module handles behaviour for defining scopes on classes.
+  class Scope
+    attr_reader :conditions, :extensions
+
+    # Create the new +Scope+. If a block is passed in, this Scope will store
+    # the block for future calls to #extend.
+    #
+    # @example Create a new scope.
+    #   Scope.new(:title => "Sir")
+    #
+    # @param [ Hash ] conditions The scoping limitations.
+    def initialize(conditions = {}, &block)
+      @conditions = conditions
+      @extensions = Module.new(&block) if block_given?
+    end
+
+    # Extend a supplied criteria.
+    #
+    # @example Extend the criteria.
+    #   scope.extend(criteria)
+    #
+    # @param [ Criteria } criteria A mongoid criteria to extend.
+    #
+    # @return [ Criteria ] The new criteria object.
+    def extend(criteria)
+      extensions ? criteria.extend(extensions) : criteria
+    end
+  end
+end

data/lib/mongoid/serialization.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+
+  # This module provides the extra behaviour for including relations in JSON
+  # and XML serialization.
+  module Serialization
+    extend ActiveSupport::Concern
+    include ActiveModel::Serialization
+
+    # Gets the document as a serializable hash, used by ActiveModel's JSON and
+    # XML serializers. This override is just to be able to pass the :include
+    # and :except options to get associations in the hash.
+    #
+    # @example Get the serializable hash.
+    #   document.serializable_hash
+    #
+    # @example Get the serializable hash with options.
+    #   document.serializable_hash(:include => :addresses)
+    #
+    # @param [ Hash ] options The options to pass.
+    #
+    # @option options [ Symbol ] :include What relations to include
+    # @option options [ Symbol ] :only Limit the fields to only these.
+    # @option options [ Symbol ] :except Dont include these fields.
+    #
+    # @return [ Hash ] The document, ready to be serialized.
+    #
+    # @since 2.0.0.rc.6
+    def serializable_hash(options = nil)
+      options ||= {}
+      super(options).tap do |attrs|
+        serialize_relations(attrs, options) if options[:include]
+      end
+    end
+
+    private
+
+    # For each of the provided include options, get the relation needed and
+    # provide it in the hash.
+    #
+    # @example Serialize the included relations.
+    #   document.serialize_relations({}, :include => :addresses)
+    #
+    # @param [ Hash ] attributes The attributes to serialize.
+    # @param [ Hash ] options The serialization options.
+    #
+    # @option options [ Symbol ] :include What relations to include
+    # @option options [ Symbol ] :only Limit the fields to only these.
+    # @option options [ Symbol ] :except Dont include these fields.
+    #
+    # @since 2.0.0.rc.6
+    def serialize_relations(attributes = {}, options = {})
+      inclusions = options.delete(:include)
+      relation_names(inclusions).each do |name|
+        metadata = relations[name.to_s]
+        relation = send(metadata.name, false, :eager => true)
+        if relation
+          attributes[metadata.name.to_s] =
+            relation.serializable_hash(relation_options(inclusions, options, name))
+        end
+      end
+    end
+
+    # Since the inclusions can be a hash, symbol, or array of symbols, this is
+    # provided as a convenience to parse out the names.
+    #
+    # @example Get the relation names.
+    #   document.relation_names(:include => [ :addresses ])
+    #
+    # @param [ Hash, Symbol, Array<Symbol ] inclusions The inclusions.
+    #
+    # @return [ Array<Symbol> ] The names of the included relations.
+    #
+    # @since 2.0.0.rc.6
+    def relation_names(inclusions)
+      inclusions.is_a?(Hash) ? inclusions.keys : Array.wrap(inclusions)
+    end
+
+    # Since the inclusions can be a hash, symbol, or array of symbols, this is
+    # provided as a convenience to parse out the options.
+    #
+    # @example Get the relation options.
+    #   document.relation_names(:include => [ :addresses ])
+    #
+    # @param [ Hash, Symbol, Array<Symbol ] inclusions The inclusions.
+    # @param [ Symbol ] name The name of the relation.
+    #
+    # @return [ Hash ] The options for the relation.
+    #
+    # @since 2.0.0.rc.6
+    def relation_options(inclusions, options, name)
+      if inclusions.is_a?(Hash)
+        inclusions[name]
+      else
+        { :except => options[:except], :only => options[:only] }
+      end
+    end
+  end
+end

data/lib/mongoid/state.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  # This module contains the behaviour for getting the various states a
+  # document can transition through.
+  module State
+
+    # Returns true if the +Document+ has not been persisted to the database,
+    # false if it has. This is determined by the variable @new_record
+    # and NOT if the object has an id.
+    #
+    # @example Is the document new?
+    #   person.new_record?
+    #
+    # @return [ true, false ] True if new, false if not.
+    def new_record?
+      @new_record == true
+    end
+    alias :new? :new_record?
+
+    # Sets the new_record boolean - used after document is saved.
+    #
+    # @example Set whether the document is new.
+    #   person.new_record = true
+    #
+    # @param [ true, false ] saved The value to set for new_record.
+    #
+    # @return [ true, false ] The new_record value.
+    def new_record=(saved)
+      @new_record = saved
+    end
+
+    # Checks if the document has been saved to the database.
+    #
+    # @example Is the document persisted?
+    #   person.persisted?
+    #
+    # @return [ true, false ] True if persisted, false if not.
+    def persisted?
+      !new_record?
+    end
+
+    # Returns true if the +Document+ has been succesfully destroyed, and false
+    # if it hasn't. This is determined by the variable @destroyed and NOT
+    # by checking the database.
+    #
+    # @example Is the document destroyed?
+    #   person.destroyed?
+    #
+    # @return [ true, false ] True if destroyed, false if not.
+    def destroyed?
+      @destroyed == true
+    end
+    alias :deleted? :destroyed?
+
+    # Sets the destroyed boolean - used after document is destroyed.
+    #
+    # @example Set the destroyed flag.
+    #   person.destroyed = true
+    #
+    # @return [ true, false ] The value set for destroyed.
+    def destroyed=(destroyed)
+      @destroyed = destroyed && true
+    end
+  end
+end

data/lib/mongoid/timestamps.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  # This module handles the behaviour for setting up document created at and
+  # updated at timestamps.
+  module Timestamps
+    extend ActiveSupport::Concern
+
+    included do
+      field :created_at, :type => Time
+      field :updated_at, :type => Time
+
+      set_callback :create, :before, :set_created_at
+      set_callback :save, :before, :set_updated_at
+
+      class_attribute :record_timestamps
+      self.record_timestamps = true
+    end
+
+    # Update the created_at field on the Document to the current time. This is
+    # only called on create.
+    #
+    # @example Set the created at time.
+    #   person.set_created_at
+    def set_created_at
+      self.created_at = Time.now.utc if !created_at
+    end
+
+    # Update the updated_at field on the Document to the current time.
+    # This is only called on create and on save.
+    #
+    # @example Set the updated at time.
+    #   person.set_updated_at
+    def set_updated_at
+      self.updated_at = Time.now.utc
+    end
+  end
+end

data/lib/mongoid/validations/associated.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Validations #:nodoc:
+
+    # Validates whether or not an association is valid or not. Will correctly
+    # handle has one and has many associations.
+    #
+    # @example Set up the association validations.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     embeds_one :name
+    #     embeds_many :addresses
+    #
+    #     validates_associated :name, :addresses
+    #   end
+    class AssociatedValidator < ActiveModel::EachValidator
+
+      # Validates that the associations provided are either all nil or all
+      # valid. If neither is true then the appropriate errors will be added to
+      # the parent document.
+      #
+      # @example Validate the association.
+      #   validator.validate_each(document, :name, name)
+      #
+      # @param [ Document ] document The document to validate.
+      # @param [ Symbol ] attribute The relation to validate.
+      # @param [ Object ] value The value of the relation.
+      def validate_each(document, attribute, value)
+        unless document.validated?
+          document.validated = true
+          valid = value.to_a.collect { |doc| doc.nil? || doc.valid? }.all?
+          document.validated = false
+          return if valid
+          document.errors.add(attribute, :invalid, options.merge(:value => value))
+        else
+          document.validated = false
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/validations/uniqueness.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Validations #:nodoc:
+
+    # Validates whether or not a field is unique against the documents in the
+    # database.
+    #
+    # @example Define the uniqueness validator.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     field :title
+    #
+    #     validates_uniqueness_of :title
+    #   end
+    class UniquenessValidator < ActiveModel::EachValidator
+
+      # Unfortunately, we have to tie Uniqueness validators to a class.
+      def setup(klass)
+        @klass = klass
+      end
+
+      # Validate the document for uniqueness violations.
+      #
+      # @example Validate the document.
+      #   validate_each(person, :title, "Sir")
+      #
+      # @param [ Document ] document The document to validate.
+      # @param [ Symbol ] attribute The field to validate on.
+      # @param [ Object ] value The value of the field.
+      #
+      # @todo Durran: This method needs refactoring.
+      def validate_each(document, attribute, value)
+        if document.embedded?
+          return if document._parent.nil?
+          criteria = document._parent.send(document.metadata.name)
+          # If the parent document embeds_one, no need to validate uniqueness
+          return if criteria.is_a?(Mongoid::Document)
+          criteria = criteria.where(attribute => unique_search_value(value), :_id => {'$ne' => document._id})
+        else
+          criteria = @klass.where(attribute => unique_search_value(value))
+          unless document.new_record?
+            criteria = criteria.where(:_id => {'$ne' => document._id})
+          end
+        end
+
+        Array.wrap(options[:scope]).each do |item|
+          criteria = criteria.where(item => document.attributes[item])
+        end
+        if criteria.exists?
+          document.errors.add(
+            attribute,
+            :taken,
+            options.except(:case_sensistive, :scope).merge(:value => value)
+          )
+        end
+      end
+
+      protected
+
+      # Determine if the primary key has changed on the document.
+      #
+      # @example Has the key changed?
+      #   key_changed?(document)
+      #
+      # @param [ Document ] document The document to check.
+      #
+      # @return [ true, false ] True if changed, false if not.
+      def key_changed?(document)
+        (document.primary_key || {}).each do |key|
+          return true if document.send("#{key}_changed?")
+        end; false
+      end
+
+      # ensure :case_sensitive is true by default
+      def unique_search_value(value)
+        if options[:case_sensitive] == false
+          value ? Regexp.new("^#{Regexp.escape(value.to_s)}$", Regexp::IGNORECASE) : nil
+        else
+          value
+        end
+      end
+    end
+  end
+end