mongoid-rails2 1.9.3

data/lib/mongoid/attributes.rb

@@ -0,0 +1,204 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Attributes
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+      end
+    end
+    module InstanceMethods
+      # Get the id associated with this object. This will pull the _id value out
+      # of the attributes +Hash+.
+      def id
+        @attributes["_id"]
+      end
+
+      # Set the id of the +Document+ to a new one.
+      def id=(new_id)
+        @attributes["_id"] = new_id
+      end
+
+      alias :_id :id
+      alias :_id= :id=
+
+      # Used for allowing accessor methods for dynamic attributes.
+      def method_missing(name, *args)
+        attr = name.to_s
+        return super unless @attributes.has_key?(attr.reader)
+        if attr.writer?
+          # "args.size > 1" allows to simulate 1.8 behavior of "*args"
+          @attributes[attr.reader] = (args.size > 1) ? args : args.first
+        else
+          @attributes[attr.reader]
+        end
+      end
+
+      # Process the provided attributes casting them to their proper values if a
+      # field exists for them on the +Document+. This will be limited to only the
+      # attributes provided in the suppied +Hash+ so that no extra nil values get
+      # put into the document's attributes.
+      def process(attrs = nil)
+        (attrs || {}).each_pair do |key, value|
+          if set_allowed?(key)
+            @attributes[key.to_s] = value
+          elsif write_allowed?(key)
+            send("#{key}=", value)
+          end
+        end
+        setup_modifications
+      end
+
+      # Read a value from the +Document+ attributes. If the value does not exist
+      # it will return nil.
+      #
+      # Options:
+      #
+      # name: The name of the attribute to get.
+      #
+      # Example:
+      #
+      # <tt>person.read_attribute(:title)</tt>
+      def read_attribute(name)
+        access = name.to_s
+        accessed(access, fields[access].get(@attributes[access]))
+      end
+
+      # Remove a value from the +Document+ attributes. If the value does not exist
+      # it will fail gracefully.
+      #
+      # Options:
+      #
+      # name: The name of the attribute to remove.
+      #
+      # Example:
+      #
+      # <tt>person.remove_attribute(:title)</tt>
+      def remove_attribute(name)
+        access = name.to_s
+        modify(access, @attributes.delete(access), nil)
+      end
+
+      # Returns the object type. This corresponds to the name of the class that
+      # this +Document+ is, which is used in determining the class to
+      # instantiate in various cases.
+      def _type
+        @attributes["_type"]
+      end
+
+      # Set the type of the +Document+. This should be the name of the class.
+      def _type=(new_type)
+        @attributes["_type"] = new_type
+      end
+
+      # Write a single attribute to the +Document+ attribute +Hash+. This will
+      # also fire the before and after update callbacks, and perform any
+      # necessary typecasting.
+      #
+      # Options:
+      #
+      # name: The name of the attribute to update.
+      # value: The value to set for the attribute.
+      #
+      # Example:
+      #
+      # <tt>person.write_attribute(:title, "Mr.")</tt>
+      #
+      # This will also cause the observing +Document+ to notify it's parent if
+      # there is any.
+      def write_attribute(name, value)
+        access = name.to_s
+        modify(access, @attributes[access], fields[access].set(value))
+        notify if !id.blank? && new_record?
+      end
+
+      # Writes the supplied attributes +Hash+ to the +Document+. This will only
+      # overwrite existing attributes if they are present in the new +Hash+, all
+      # others will be preserved.
+      #
+      # Options:
+      #
+      # attrs: The +Hash+ of new attributes to set on the +Document+
+      #
+      # Example:
+      #
+      # <tt>person.write_attributes(:title => "Mr.")</tt>
+      #
+      # This will also cause the observing +Document+ to notify it's parent if
+      # there is any.
+      def write_attributes(attrs = nil)
+        process(attrs || {})
+        identified = !id.blank?
+        if new_record? && !identified
+          identify; notify
+        end
+      end
+      alias :attributes= write_attributes
+
+      protected
+      # apply default values to attributes - calling procs as required
+      def default_attributes
+        default_values = defaults
+        default_values.each_pair do |key, val|
+          default_values[key] = val.call if val.respond_to?(:call)
+        end
+        default_values || {}
+      end
+
+      # Return true if dynamic field setting is enabled.
+      def set_allowed?(key)
+        Mongoid.allow_dynamic_fields && !respond_to?("#{key}=")
+      end
+
+      # Used when supplying a :reject_if block as an option to
+      # accepts_nested_attributes_for
+      def reject(attributes, options)
+        rejector = options[:reject_if]
+        if rejector
+          attributes.delete_if do |key, value|
+            rejector.call(value)
+          end
+        end
+      end
+
+      # Return true if writing to the given field is allowed
+      def write_allowed?(key)
+        name = key.to_s
+        existing = fields[name]
+        return true unless existing
+        existing.accessible?
+      end
+    end
+
+    module ClassMethods
+      # Defines attribute setters for the associations specified by the names.
+      # This will work for a has one or has many association.
+      #
+      # Example:
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     embeds_one :name
+      #     embeds_many :addresses
+      #
+      #     accepts_nested_attributes_for :name, :addresses
+      #   end
+      def accepts_nested_attributes_for(*args)
+        associations = args.flatten
+        options = associations.last.is_a?(Hash) ? associations.pop : {}
+        associations.each do |name|
+          define_method("#{name}_attributes=") do |attrs|
+            reject(attrs, options)
+            association = send(name)
+            if association
+              observe(association, true)
+              association.nested_build(attrs)
+            else
+              send("build_#{name}", attrs)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/callbacks.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Callbacks
+    def self.included(base)
+      base.class_eval do
+        include ActiveSupport::Callbacks
+
+        # Define all the callbacks that are accepted by the document.
+        define_callbacks \
+          :before_create,
+          :after_create,
+          :before_destroy,
+          :after_destroy,
+          :before_save,
+          :after_save,
+          :before_update,
+          :after_update,
+          :before_validation,
+          :after_validation
+      end
+    end
+  end
+end

data/lib/mongoid/collection.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+require "mongoid/collections/operations"
+require "mongoid/collections/cyclic_iterator"
+require "mongoid/collections/master"
+require "mongoid/collections/slaves"
+
+module Mongoid #:nodoc
+  # The Mongoid wrapper to the Mongo Ruby driver's collection object.
+  class Collection
+    attr_reader :counter, :name
+
+    # All write operations should delegate to the master connection. These
+    # operations mimic the methods on a Mongo:Collection.
+    #
+    # Example:
+    #
+    # <tt>collection.save({ :name => "Al" })</tt>
+    Collections::Operations::PROXIED.each do |name|
+      define_method(name) { |*args| master.send(name, *args) }
+    end
+
+    # Determines where to send the next read query. If the slaves are not
+    # defined then send to master. If the read counter is under the configured
+    # maximum then return the master. In any other case return the slaves.
+    #
+    # Example:
+    #
+    # <tt>collection.directed</tt>
+    #
+    # Return:
+    #
+    # Either a +Master+ or +Slaves+ collection.
+    def directed(options = {})
+      options.delete(:cache)
+      enslave = options.delete(:enslave) || @klass.enslaved?
+      enslave ? master_or_slaves : master
+    end
+
+    # Find documents from the database given a selector and options.
+    #
+    # Options:
+    #
+    # selector: A +Hash+ selector that is the query.
+    # options: The options to pass to the db.
+    #
+    # Example:
+    #
+    # <tt>collection.find({ :test => "value" })</tt>
+    def find(selector = {}, options = {})
+      cursor = Mongoid::Cursor.new(@klass, self, directed(options).find(selector, options))
+      if block_given?
+        yield cursor; cursor.close
+      else
+        cursor
+      end
+    end
+
+    # Find the first document from the database given a selector and options.
+    #
+    # Options:
+    #
+    # selector: A +Hash+ selector that is the query.
+    # options: The options to pass to the db.
+    #
+    # Example:
+    #
+    # <tt>collection.find_one({ :test => "value" })</tt>
+    def find_one(selector = {}, options = {})
+      directed(options).find_one(selector, options)
+    end
+
+    # Initialize a new Mongoid::Collection, setting up the master, slave, and
+    # name attributes. Masters will be used for writes, slaves for reads.
+    #
+    # Example:
+    #
+    # <tt>Mongoid::Collection.new(masters, slaves, "test")</tt>
+    def initialize(klass, name)
+      @klass, @name = klass, name
+    end
+
+    # Perform a map/reduce on the documents.
+    #
+    # Options:
+    #
+    # map: The map javascript funcdtion.
+    # reduce: The reduce javascript function.
+    def map_reduce(map, reduce, options = {})
+      directed(options).map_reduce(map, reduce, options)
+    end
+
+    alias :mapreduce :map_reduce
+
+    # Return the object responsible for writes to the database. This will
+    # always return a collection associated with the Master DB.
+    #
+    # Example:
+    #
+    # <tt>collection.writer</tt>
+    def master
+      @master ||= Collections::Master.new(Mongoid.master, @name)
+    end
+
+    # Return the object responsible for reading documents from the database.
+    # This is usually the slave databases, but in their absence the master will
+    # handle the task.
+    #
+    # Example:
+    #
+    # <tt>collection.reader</tt>
+    def slaves
+      @slaves ||= Collections::Slaves.new(Mongoid.slaves, @name)
+    end
+
+    protected
+    def master_or_slaves
+      slaves.empty? ? master : slaves
+    end
+  end
+end

data/lib/mongoid/collections/cyclic_iterator.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Collections #:nodoc:
+    class CyclicIterator
+
+      attr_reader :counter
+
+      # Performs iteration over an array, if the array gets to the end then loop
+      # back to the first.
+      #
+      # Example:
+      #
+      # <tt>CyclicIterator.new([ first, second ])</tt>
+      def initialize(array)
+        @array, @counter = array, -1
+      end
+
+      # Get the next element in the array. If the element is the last in the
+      # array then return the first.
+      #
+      # Example:
+      #
+      # <tt>iterator.next</tt>
+      #
+      # Returns:
+      #
+      # The next element in the array.
+      def next
+        (@counter == @array.size - 1) ? @counter = 0 : @counter = @counter + 1
+        @array[@counter]
+      end
+    end
+  end
+end

data/lib/mongoid/collections/master.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Collections #:nodoc:
+    class Master
+
+      attr_reader :collection
+
+      # All read and write operations should delegate to the master connection.
+      # These operations mimic the methods on a Mongo:Collection.
+      #
+      # Example:
+      #
+      # <tt>collection.save({ :name => "Al" })</tt>
+      Operations::ALL.each do |name|
+        define_method(name) { |*args| collection.send(name, *args) }
+      end
+
+      # Create the new database writer. Will create a collection from the
+      # master database.
+      #
+      # Example:
+      #
+      # <tt>Master.new(master, "mongoid_people")</tt>
+      def initialize(master, name)
+        @collection = master.collection(name)
+      end
+    end
+  end
+end

data/lib/mongoid/collections/operations.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Collections #:nodoc:
+    module Operations #:nodoc:
+      # Constant definining all the read operations available for a
+      # Mongo:Collection. This is used in delegation.
+      READ = [
+        :[],
+        :db,
+        :count,
+        :distinct,
+        :find,
+        :find_one,
+        :group,
+        :index_information,
+        :map_reduce,
+        :mapreduce,
+        :options
+      ]
+
+      # Constant definining all the write operations available for a
+      # Mongo:Collection. This is used in delegation.
+      WRITE = [
+        :<<,
+        :create_index,
+        :drop,
+        :drop_index,
+        :drop_indexes,
+        :insert,
+        :remove,
+        :rename,
+        :save,
+        :update
+      ]
+
+      # Convenience constant for getting back all collection operations.
+      ALL = (READ + WRITE)
+      PROXIED = ALL - [ :find, :find_one, :map_reduce, :mapreduce ]
+    end
+  end
+end

data/lib/mongoid/collections/slaves.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Collections #:nodoc:
+    class Slaves
+
+      attr_reader :iterator
+
+      # All read operations should delegate to the slave connections.
+      # These operations mimic the methods on a Mongo:Collection.
+      #
+      # Example:
+      #
+      # <tt>collection.save({ :name => "Al" })</tt>
+      Operations::READ.each do |name|
+        define_method(name) { |*args| collection.send(name, *args) }
+      end
+
+      # Is the collection of slaves empty or not?
+      #
+      # Return:
+      #
+      # True is the iterator is not set, false if not.
+      def empty?
+        @iterator.nil?
+      end
+
+      # Create the new database reader. Will create a collection from the
+      # slave databases and cycle through them on each read.
+      #
+      # Example:
+      #
+      # <tt>Reader.new(slaves, "mongoid_people")</tt>
+      def initialize(slaves, name)
+        unless slaves.blank?
+          @iterator = CyclicIterator.new(slaves.collect { |db| db.collection(name) })
+        end
+      end
+
+      protected
+      def collection
+        @iterator.next
+      end
+    end
+  end
+end

data/lib/mongoid/collections.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  # The collections module is used for providing functionality around setting
+  # up and updating collections.
+  module Collections
+    extend ActiveSupport::Concern
+    included do
+      cattr_accessor :_collection, :collection_name
+      self.collection_name = self.name.collectionize
+      delegate :collection, :to => "self.class"
+    end
+
+    module ClassMethods #:nodoc:
+      # Returns the collection associated with this +Document+. If the
+      # document is embedded, there will be no collection associated
+      # with it.
+      #
+      # Returns: <tt>Mongo::Collection</tt>
+      def collection
+        raise Errors::InvalidCollection.new(self) if embedded?
+        self._collection || set_collection
+        add_indexes; self._collection
+      end
+
+      # Macro for setting the collection name to store in.
+      #
+      # Example:
+      #
+      # <tt>Person.store_in :populdation</tt>
+      def store_in(name)
+        self.collection_name = name.to_s
+        set_collection
+      end
+
+      protected
+      def set_collection
+        self._collection = Mongoid::Collection.new(self, self.collection_name)
+      end
+    end
+  end
+end

data/lib/mongoid/components.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Components #:nodoc
+    extend ActiveSupport::Concern
+    included do
+      # All modules that a +Document+ is composed of are defined in this
+      # module, to keep the document class from getting too cluttered.
+      include Mongoid::Associations
+      include Mongoid::Attributes
+      include Mongoid::Callbacks
+      include Mongoid::Collections
+      include Mongoid::Dirty
+      include Mongoid::Extras
+      include Mongoid::Fields
+      include Mongoid::Indexes
+      include Mongoid::Matchers
+      include Mongoid::Memoization
+      include Mongoid::Observable
+      include Mongoid::Paths
+      include Mongoid::Persistence
+      include Mongoid::State
+      include Validatable
+      extend Mongoid::Finders
+      extend Mongoid::NamedScope
+    end
+  end
+end

data/lib/mongoid/concern.rb

@@ -0,0 +1,31 @@
+unless defined?(ActiveSupport::Concern)
+  module ActiveSupport
+    module Concern
+      def self.extended(base)
+        base.instance_variable_set("@_dependencies", [])
+      end
+
+      def append_features(base)
+        if base.instance_variable_defined?("@_dependencies")
+          base.instance_variable_get("@_dependencies") << self
+          return false
+        else
+          return false if base < self
+          @_dependencies.each { |dep| base.send(:include, dep) }
+          super
+          base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
+          base.send :include, const_get("InstanceMethods") if const_defined?("InstanceMethods")
+          base.class_eval(&@_included_block) if instance_variable_defined?("@_included_block")
+        end
+      end
+
+      def included(base = nil, &block)
+        if base.nil?
+          @_included_block = block
+        else
+          super
+        end
+      end
+    end
+  end
+end