mongoid-rails2 1.9.3

data/lib/mongoid/config.rb

@@ -0,0 +1,191 @@
+# encoding: utf-8
+require "uri"
+
+module Mongoid #:nodoc
+  class Config #:nodoc
+    include Singleton
+
+    attr_accessor \
+      :allow_dynamic_fields,
+      :reconnect_time,
+      :parameterize_keys,
+      :persist_in_safe_mode,
+      :raise_not_found_error,
+      :use_object_ids
+
+    # Defaults the configuration options to true.
+    def initialize
+      reset
+    end
+
+    # Sets whether the times returned from the database are in UTC or local time.
+    # If you omit this setting, then times will be returned in
+    # the local time zone.
+    #
+    # Example:
+    #
+    # <tt>Config.use_utc = true</tt>
+    #
+    # Returns:
+    #
+    # A boolean
+    def use_utc=(value)
+      @use_utc = value || false
+    end
+
+    # Returns whether times are return from the database in UTC. If
+    # this setting is false, then times will be returned in the local time zone.
+    #
+    # Example:
+    #
+    # <tt>Config.use_utc</tt>
+    #
+    # Returns:
+    #
+    # A boolean
+    attr_reader :use_utc
+    alias_method :use_utc?, :use_utc
+
+    # Sets the Mongo::DB master database to be used. If the object trying to be
+    # set is not a valid +Mongo::DB+, then an error will be raised.
+    #
+    # Example:
+    #
+    # <tt>Config.master = Mongo::Connection.db("test")</tt>
+    #
+    # Returns:
+    #
+    # The Master DB instance.
+    def master=(db)
+      check_database!(db)
+      @master = db
+    end
+
+    # Returns the master database, or if none has been set it will raise an
+    # error.
+    #
+    # Example:
+    #
+    # <tt>Config.master</tt>
+    #
+    # Returns:
+    #
+    # The master +Mongo::DB+
+    def master
+      @master || (raise Errors::InvalidDatabase.new(nil))
+    end
+
+    alias :database :master
+    alias :database= :master=
+
+    # Sets the Mongo::DB slave databases to be used. If the objects trying to me
+    # set are not valid +Mongo::DBs+, then an error will be raise.
+    #
+    # Example:
+    #
+    # <tt>Config.slaves = [ Mongo::Connection.db("test") ]</tt>
+    #
+    # Returns:
+    #
+    # The slaves DB instances.
+    def slaves=(dbs)
+      dbs.each do |db|
+        check_database!(db)
+      end
+      @slaves = dbs
+    end
+
+    # Returns the slave databases, or if none has been set nil
+    #
+    # Example:
+    #
+    # <tt>Config.slaves</tt>
+    #
+    # Returns:
+    #
+    # The slave +Mongo::DBs+
+    def slaves
+      @slaves
+    end
+
+    # Confiure mongoid from a hash that was usually parsed out of yml.
+    #
+    # Example:
+    #
+    # <tt>Mongoid::Config.instance.from_hash({})</tt>
+    def from_hash(settings)
+      _master(settings)
+      _slaves(settings)
+      settings.except("database").each_pair do |name, value|
+        send("#{name}=", value) if respond_to?(name)
+      end
+    end
+
+    # Reset the configuration options to the defaults.
+    #
+    # Example:
+    #
+    # <tt>config.reset</tt>
+    def reset
+      @allow_dynamic_fields = true
+      @parameterize_keys = true
+      @persist_in_safe_mode = true
+      @raise_not_found_error = true
+      @reconnect_time = 3
+      @use_object_ids = false
+      @time_zone = nil
+    end
+
+    protected
+
+    # Check if the database is valid and the correct version.
+    #
+    # Example:
+    #
+    # <tt>config.check_database!</tt>
+    def check_database!(database)
+      raise Errors::InvalidDatabase.new(database) unless database.kind_of?(Mongo::DB)
+      version = database.connection.server_version
+      raise Errors::UnsupportedVersion.new(version) if version < Mongoid::MONGODB_VERSION
+    end
+
+    # Get a Rails logger or stdout logger.
+    #
+    # Example:
+    #
+    # <tt>config.logger</tt>
+    def logger
+      defined?(Rails) ? Rails.logger : Logger.new($stdout)
+    end
+
+    # Get a master database from settings.
+    #
+    # Example:
+    #
+    # <tt>config._master({}, "test")</tt>
+    def _master(settings)
+      name = settings["database"]
+      host = settings.delete("host") || "localhost"
+      port = settings.delete("port") || 27017
+      self.master = Mongo::Connection.new(host, port, :logger => logger).db(name)
+    end
+
+    # Get a bunch-o-slaves from settings and names.
+    #
+    # Example:
+    #
+    # <tt>config._slaves({}, "test")</tt>
+    def _slaves(settings)
+      name = settings["database"]
+      self.slaves = []
+      slaves = settings.delete("slaves")
+      slaves.to_a.each do |slave|
+        self.slaves << Mongo::Connection.new(
+          slave["host"],
+          slave["port"],
+          :slave_ok => true
+        ).db(name)
+      end
+    end
+  end
+end

data/lib/mongoid/contexts/enumerable.rb

@@ -0,0 +1,151 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Enumerable
+      include Ids, Paging
+      attr_reader :criteria
+
+      delegate :blank?, :empty?, :first, :last, :to => :execute
+      delegate :klass, :documents, :options, :selector, :to => :criteria
+
+      # Return aggregation counts of the grouped documents. This will count by
+      # the first field provided in the fields array.
+      #
+      # Returns:
+      #
+      # A +Hash+ with field values as keys, count as values
+      def aggregate
+        counts = {}
+        group.each_pair { |key, value| counts[key] = value.size }
+        counts
+      end
+
+      # Get the average value for the supplied field.
+      #
+      # Example:
+      #
+      # <tt>context.avg(:age)</tt>
+      #
+      # Returns:
+      #
+      # A numeric value that is the average.
+      def avg(field)
+        total = sum(field)
+        total ? (total.to_f / count) : nil
+      end
+
+      # Gets the number of documents in the array. Delegates to size.
+      def count
+        @count ||= documents.size
+      end
+
+      # Gets an array of distinct values for the supplied field across the
+      # entire array or the susbset given the criteria.
+      #
+      # Example:
+      #
+      # <tt>context.distinct(:title)</tt>
+      def distinct(field)
+        execute.collect { |doc| doc.send(field) }.uniq
+      end
+
+      # Enumerable implementation of execute. Returns matching documents for
+      # the selector, and adds options if supplied.
+      #
+      # Returns:
+      #
+      # An +Array+ of documents that matched the selector.
+      def execute(paginating = false)
+        limit(documents.select { |document| document.matches?(selector) })
+      end
+
+      # Groups the documents by the first field supplied in the field options.
+      #
+      # Returns:
+      #
+      # A +Hash+ with field values as keys, arrays of documents as values.
+      def group
+        field = options[:fields].first
+        documents.group_by { |doc| doc.send(field) }
+      end
+
+      # Create the new enumerable context. This will need the selector and
+      # options from a +Criteria+ and a documents array that is the underlying
+      # array of embedded documents from a has many association.
+      #
+      # Example:
+      #
+      # <tt>Mongoid::Contexts::Enumerable.new(criteria)</tt>
+      def initialize(criteria)
+        @criteria = criteria
+      end
+
+      # Iterate over each +Document+ in the results. This can take an optional
+      # block to pass to each argument in the results.
+      #
+      # Example:
+      #
+      # <tt>context.iterate { |doc| p doc }</tt>
+      def iterate(&block)
+        execute.each(&block)
+      end
+
+      # Get the largest value for the field in all the documents.
+      #
+      # Returns:
+      #
+      # The numerical largest value.
+      def max(field)
+        determine(field, :>=)
+      end
+
+      # Get the smallest value for the field in all the documents.
+      #
+      # Returns:
+      #
+      # The numerical smallest value.
+      def min(field)
+        determine(field, :<=)
+      end
+
+      # Get one document.
+      #
+      # Returns:
+      #
+      # The first document in the +Array+
+      alias :one :first
+
+      # Get the sum of the field values for all the documents.
+      #
+      # Returns:
+      #
+      # The numerical sum of all the document field values.
+      def sum(field)
+        sum = documents.inject(nil) do |memo, doc|
+          value = doc.send(field)
+          memo ? memo += value : value
+        end
+      end
+
+      protected
+      # If the field exists, perform the comparison and set if true.
+      def determine(field, operator)
+        matching = documents.inject(nil) do |memo, doc|
+          value = doc.send(field)
+          (memo && memo.send(operator, value)) ? memo : value
+        end
+      end
+
+      # Limits the result set if skip and limit options.
+      def limit(documents)
+        skip, limit = options[:skip], options[:limit]
+        if skip && limit
+          return documents.slice(skip, limit)
+        elsif limit
+          return documents.first(limit)
+        end
+        documents
+      end
+    end
+  end
+end

data/lib/mongoid/contexts/ids.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    module Ids
+      # Return documents based on an id search. Will handle if a single id has
+      # been passed or mulitple ids.
+      #
+      # Example:
+      #
+      #   context.id_criteria([1, 2, 3])
+      #
+      # Returns:
+      #
+      # The single or multiple documents.
+      def id_criteria(params)
+        criteria.id(params)
+        result = params.is_a?(Array) ? criteria.entries : one
+        if Mongoid.raise_not_found_error
+          raise Errors::DocumentNotFound.new(klass, params) if result.blank?
+        end
+        return result
+      end
+    end
+  end
+end

data/lib/mongoid/contexts/mongo.rb

@@ -0,0 +1,285 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Mongo
+      include Ids, Paging
+      attr_reader :criteria
+
+      delegate :klass, :options, :selector, :to => :criteria
+
+      # Aggregate the context. This will take the internally built selector and options
+      # and pass them on to the Ruby driver's +group()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned it will provided a grouping of keys with counts.
+      #
+      # Example:
+      #
+      # <tt>context.aggregate</tt>
+      #
+      # Returns:
+      #
+      # A +Hash+ with field values as keys, counts as values
+      def aggregate
+        klass.collection.group(options[:fields], selector, { :count => 0 }, Javascript.aggregate, true)
+      end
+
+      # Get the average value for the supplied field.
+      #
+      # This will take the internally built selector and options
+      # and pass them on to the Ruby driver's +group()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned it will provided a grouping of keys with averages.
+      #
+      # Example:
+      #
+      # <tt>context.avg(:age)</tt>
+      #
+      # Returns:
+      #
+      # A numeric value that is the average.
+      def avg(field)
+        total = sum(field)
+        total ? (total / count) : nil
+      end
+
+      # Determine if the context is empty or blank given the criteria. Will
+      # perform a quick has_one asking only for the id.
+      #
+      # Example:
+      #
+      # <tt>context.blank?</tt>
+      def blank?
+        klass.collection.find_one(selector, { :fields => [ :_id ] }).nil?
+      end
+
+      alias :empty? :blank?
+
+      # Get the count of matching documents in the database for the context.
+      #
+      # Example:
+      #
+      # <tt>context.count</tt>
+      #
+      # Returns:
+      #
+      # An +Integer+ count of documents.
+      def count
+        @count ||= klass.collection.find(selector, process_options).count
+      end
+
+      # Gets an array of distinct values for the supplied field across the
+      # entire collection or the susbset given the criteria.
+      #
+      # Example:
+      #
+      # <tt>context.distinct(:title)</tt>
+      def distinct(field)
+        klass.collection.distinct(field, selector)
+      end
+
+      # Execute the context. This will take the selector and options
+      # and pass them on to the Ruby driver's +find()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned new documents of the type of class provided will be instantiated.
+      #
+      # Example:
+      #
+      # <tt>context.execute</tt>
+      #
+      # Returns:
+      #
+      # An enumerable +Cursor+.
+      def execute(paginating = false)
+        cursor = klass.collection.find(selector, process_options)
+        if cursor
+          @count = cursor.count if paginating
+          cursor
+        else
+          []
+        end
+      end
+
+      # Groups the context. This will take the internally built selector and options
+      # and pass them on to the Ruby driver's +group()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned it will provided a grouping of keys with objects.
+      #
+      # Example:
+      #
+      # <tt>context.group</tt>
+      #
+      # Returns:
+      #
+      # A +Hash+ with field values as keys, arrays of documents as values.
+      def group
+        klass.collection.group(
+          options[:fields],
+          selector,
+          { :group => [] },
+          Javascript.group
+        ).collect do |docs|
+          docs["group"] = docs["group"].collect do |attrs|
+            Mongoid::Factory.build(klass, attrs)
+          end
+          docs
+        end
+      end
+
+      # Create the new mongo context. This will execute the queries given the
+      # selector and options against the database.
+      #
+      # Example:
+      #
+      # <tt>Mongoid::Contexts::Mongo.new(criteria)</tt>
+      def initialize(criteria)
+        @criteria = criteria
+        if klass.hereditary
+          criteria.in(:_type => criteria.klass._types)
+        end
+        criteria.enslave if klass.enslaved?
+        criteria.cache if klass.cached?
+      end
+
+      # Iterate over each +Document+ in the results. This can take an optional
+      # block to pass to each argument in the results.
+      #
+      # Example:
+      #
+      # <tt>context.iterate { |doc| p doc }</tt>
+      def iterate(&block)
+        return caching(&block) if criteria.cached?
+        if block_given?
+          execute.each { |doc| yield doc }
+        end
+      end
+
+      # Return the last result for the +Context+. Essentially does a find_one on
+      # the collection with the sorting reversed. If no sorting parameters have
+      # been provided it will default to ids.
+      #
+      # Example:
+      #
+      # <tt>context.last</tt>
+      #
+      # Returns:
+      #
+      # The last document in the collection.
+      def last
+        opts = process_options
+        sorting = opts[:sort]
+        sorting = [[:_id, :asc]] unless sorting
+        opts[:sort] = sorting.collect { |option| [ option[0], option[1].invert ] }
+        attributes = klass.collection.find_one(selector, opts)
+        attributes ? Mongoid::Factory.build(klass, attributes) : nil
+      end
+
+      # Return the max value for a field.
+      #
+      # This will take the internally built selector and options
+      # and pass them on to the Ruby driver's +group()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned it will provided a grouping of keys with sums.
+      #
+      # Example:
+      #
+      # <tt>context.max(:age)</tt>
+      #
+      # Returns:
+      #
+      # A numeric max value.
+      def max(field)
+        grouped(:max, field.to_s, Javascript.max)
+      end
+
+      # Return the min value for a field.
+      #
+      # This will take the internally built selector and options
+      # and pass them on to the Ruby driver's +group()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned it will provided a grouping of keys with sums.
+      #
+      # Example:
+      #
+      # <tt>context.min(:age)</tt>
+      #
+      # Returns:
+      #
+      # A numeric minimum value.
+      def min(field)
+        grouped(:min, field.to_s, Javascript.min)
+      end
+
+      # Return the first result for the +Context+.
+      #
+      # Example:
+      #
+      # <tt>context.one</tt>
+      #
+      # Return:
+      #
+      # The first document in the collection.
+      def one
+        attributes = klass.collection.find_one(selector, process_options)
+        attributes ? Mongoid::Factory.build(klass, attributes) : nil
+      end
+
+      alias :first :one
+
+      # Sum the context.
+      #
+      # This will take the internally built selector and options
+      # and pass them on to the Ruby driver's +group()+ method on the collection. The
+      # collection itself will be retrieved from the class provided, and once the
+      # query has returned it will provided a grouping of keys with sums.
+      #
+      # Example:
+      #
+      # <tt>context.sum(:age)</tt>
+      #
+      # Returns:
+      #
+      # A numeric value that is the sum.
+      def sum(field)
+        grouped(:sum, field.to_s, Javascript.sum)
+      end
+
+      # Common functionality for grouping operations. Currently used by min, max
+      # and sum. Will gsub the field name in the supplied reduce function.
+      def grouped(start, field, reduce)
+        collection = klass.collection.group(
+          nil,
+          selector,
+          { start => "start" },
+          reduce.gsub("[field]", field)
+        )
+        collection.empty? ? nil : collection.first[start.to_s]
+      end
+
+      # Filters the field list. If no fields have been supplied, then it will be
+      # empty. If fields have been defined then _type will be included as well.
+      def process_options
+        fields = options[:fields]
+        if fields && fields.size > 0 && !fields.include?(:_type)
+          fields << :_type
+          options[:fields] = fields
+        end
+        options.dup
+      end
+
+      protected
+
+      # Iterate over each +Document+ in the results and cache the collection.
+      def caching(&block)
+        if defined? @collection
+          @collection.each(&block)
+        else
+          @collection = []
+          execute.each do |doc|
+            @collection << doc
+            yield doc if block_given?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/contexts/paging.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    module Paging
+      # Paginates the documents.
+      #
+      # Example:
+      #
+      # <tt>context.paginate(:page => 6, :per_page => 25)</tt>
+      #
+      # Returns:
+      #
+      # A collection of documents paginated.
+      # All previous <tt>limit</tt> and <tt>skip</tt> call will be ignored.
+      def paginate(pager_options={})
+        if pager_options[:per_page]
+          options[:limit] = pager_options[:per_page].to_i
+          if pager_options[:page]
+            options[:skip]  = (pager_options[:page].to_i - 1) * pager_options[:per_page].to_i
+          end
+        end
+
+        @collection ||= execute(true)
+        WillPaginate::Collection.create(page, per_page, count) do |pager|
+          pager.replace(@collection.to_a)
+        end
+      end
+
+      # Either returns the page option and removes it from the options, or
+      # returns a default value of 1.
+      #
+      # Returns:
+      #
+      # An +Integer+ page number.
+      def page
+        skips, limits = options[:skip], options[:limit]
+        (skips && limits) ? (skips + limits) / limits : 1
+      end
+
+      # Get the number of results per page or the default of 20.
+      #
+      # Returns:
+      #
+      # The +Integer+ number of documents in each page.
+      def per_page
+        (options[:limit] || 20).to_i
+      end
+    end
+  end
+end