mongoid-braxton 2.0.2

data/lib/mongoid/config/replset_database.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Config #:nodoc:
+    class ReplsetDatabase < Hash
+
+      # Configure the database connections. This will return an array
+      # containing one Mongo::DB and nil (to keep compatibility with Mongoid::Config::Database)
+      # If you want the reads to go to a secondary node use the :read_secondary(true): option
+      #
+      # @example Configure the connection.
+      #   db.configure
+      #
+      # @return [ Array<Mongo::DB, nil ] The Mongo databases.
+      #
+      # @since 2.0.0.rc.5
+      def configure
+        #yes, construction is weird but the driver wants "A list of host-port pairs ending with a hash containing any options"
+        #mongo likes symbols
+        options = self.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo}
+        connection = Mongo::ReplSetConnection.new(*(hosts << options))
+
+        if authenticating?
+          connection.add_auth(database, username, password)
+          connection.apply_saved_authentication
+        end
+
+        [ connection.db(database), nil ]
+      end
+
+      # Do we need to authenticate against the database?
+      #
+      # @example Are we authenticating?
+      #   db.authenticating?
+      #
+      # @return [ true, false ] True if auth is needed, false if not.
+      #
+      # @since 2.0.2
+      def authenticating?
+        username || password
+      end
+
+      # Convenience for accessing the hash via dot notation.
+      #
+      # @example Access a value in alternate syntax.
+      #   db.host
+      #
+      # @return [ Object ] The value in the hash.
+      #
+      # @since 2.0.2
+      def method_missing(name, *args, &block)
+        self[name.to_s]
+      end
+
+      # Create the new db configuration class.
+      #
+      # @example Initialize the class.
+      #   Config::ReplsetDatabase.new(
+      #     "hosts" => [[host1,port1],[host2,port2]]
+      #   )
+      #
+      # replSet does not supports auth
+      #
+      # @param [ Hash ] options The configuration options.
+      #
+      # @option options [ Array ] :hosts The database host.
+      # @option options [ String ] :database The database name.
+      # @option options [ Boolean ] :read_secondary Tells the driver to read from secondaries.
+      # ...
+      #
+      # @see Mongo::ReplSetConnection for all options
+      #
+      # @since 2.0.0.rc.5
+      def initialize(options = {})
+        merge!(options)
+      end
+    end
+  end
+end

data/lib/mongoid/contexts.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require "mongoid/contexts/enumerable"
+require "mongoid/contexts/mongo"
+
+module Mongoid
+  module Contexts
+    # Determines the context to be used for this criteria. If the class is an
+    # embedded document, then the context will be the array in the has_many
+    # association it is in. If the class is a root, then the database itself
+    # will be the context.
+    #
+    # Example:
+    #
+    # <tt>Contexts.context_for(criteria)</tt>
+    def self.context_for(criteria, embedded = false)
+      embedded ? Enumerable.new(criteria) : Mongo.new(criteria)
+    end
+  end
+end

data/lib/mongoid/contexts/enumerable.rb

@@ -0,0 +1,275 @@
+# encoding: utf-8
+require 'mongoid/contexts/enumerable/sort'
+
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Enumerable
+      include Relations::Embedded::Atomic
+
+      attr_accessor :collection, :criteria
+
+      delegate :blank?, :empty?, :first, :last, :to => :execute
+      delegate :klass, :documents, :options, :field_list, :selector, :to => :criteria
+
+      # Return aggregation counts of the grouped documents. This will count by
+      # the first field provided in the fields array.
+      #
+      # @example Aggregate on a field.
+      #   person.addresses.only(:street).aggregate
+      #
+      # @return [ Hash ] Field values as keys, count as values
+      def aggregate
+        {}.tap do |counts|
+          group.each_pair { |key, value| counts[key] = value.size }
+        end
+      end
+
+      # Get the average value for the supplied field.
+      #
+      # @example Get the average.
+      #   context.avg(:age)
+      #
+      # @return [ Numeric ] 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.
+      #
+      # @example Get the count.
+      #   context.count
+      #
+      # @return [ Integer ] The count of documents.
+      def count
+        @count ||= filter.size
+      end
+
+      # Delete all the documents in the database matching the selector.
+      #
+      # @example Delete the documents.
+      #   context.delete_all
+      #
+      # @return [ Integer ] The number of documents deleted.
+      #
+      # @since 2.0.0.rc.1
+      def delete_all
+        atomically(:$pull) do
+          set_collection
+          count.tap { filter.each(&:delete) }
+        end
+      end
+      alias :delete :delete_all
+
+      # Destroy all the documents in the database matching the selector.
+      #
+      # @example Destroy the documents.
+      #   context.destroy_all
+      #
+      # @return [ Integer ] The number of documents destroyed.
+      #
+      # @since 2.0.0.rc.1
+      def destroy_all
+        atomically(:$pull) do
+          set_collection
+          count.tap { filter.each(&:destroy) }
+        end
+      end
+      alias :destroy :destroy_all
+
+      # Gets an array of distinct values for the supplied field across the
+      # entire array or the susbset given the criteria.
+      #
+      # @example Get the list of distinct values.
+      #   context.distinct(:title)
+      #
+      # @return [ Array<String> ] The distinct values.
+      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.
+      #
+      # @example Execute the context.
+      #   context.execute
+      #
+      # @return [ Array<Document> ] Documents that matched the selector.
+      def execute
+        limit(sort(filter)) || []
+      end
+
+      # Groups the documents by the first field supplied in the field options.
+      #
+      # @example Group the context.
+      #   context.group
+      #
+      # @return [ Hash ] Field values as keys, arrays of documents as values.
+      def group
+        field = field_list.first
+        execute.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 Create a new context.
+      #   Mongoid::Contexts::Enumerable.new(criteria)
+      #
+      # @param [ Criteria ] criteria The criteria for the context.
+      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 Iterate over the documents.
+      #   context.iterate { |doc| p doc }
+      def iterate(&block)
+        execute.each(&block)
+      end
+
+      # Get the largest value for the field in all the documents.
+      #
+      # @example Get the max value.
+      #   context.max(:age)
+      #
+      # @return [ Numeric ] The numerical largest value.
+      def max(field)
+        determine(field, :>=)
+      end
+
+      # Get the smallest value for the field in all the documents.
+      #
+      # @example Get the minimum value.
+      #   context.min(:age)
+      #
+      # @return [ Numeric ] The numerical smallest value.
+      def min(field)
+        determine(field, :<=)
+      end
+
+      # Get one document.
+      #
+      # @example Get one document.
+      #   context.one
+      #
+      # @return [ Document ] The first document in the array.
+      alias :one :first
+
+      # Get one document and tell the criteria to skip this record on
+      # successive calls.
+      #
+      # @example Shift the documents.
+      #   context.shift
+      #
+      # @return [ Document ] The first document in the array.
+      def shift
+        first.tap do |document|
+          self.criteria = criteria.skip((options[:skip] || 0) + 1)
+        end
+      end
+
+      # Get the sum of the field values for all the documents.
+      #
+      # @example Get the sum of the field.
+      #   context.sum(:cost)
+      #
+      # @return [ Numeric ] The numerical sum of all the document field values.
+      def sum(field)
+        sum = execute.inject(nil) do |memo, doc|
+          value = doc.send(field) || 0
+          memo ? memo += value : value
+        end
+      end
+
+      # Very basic update that will perform a simple atomic $set of the
+      # attributes provided in the hash. Can be expanded to later for more
+      # robust functionality.
+      #
+      # @example Update all matching documents.
+      #   context.update_all(:title => "Sir")
+      #
+      # @param [ Hash ] attributes The sets to perform.
+      #
+      # @since 2.0.0.rc.6
+      def update_all(attributes = nil)
+        iterate do |doc|
+          doc.update_attributes(attributes || {})
+        end
+      end
+      alias :update :update_all
+
+      protected
+
+      # Filters the documents against the criteria's selector
+      #
+      # @example Filter the documents.
+      #   context.filter
+      #
+      # @return [ Array ] The documents filtered.
+      def filter
+        documents.select { |document| document.matches?(selector) }
+      end
+
+      # If the field exists, perform the comparison and set if true.
+      #
+      # @example Compare.
+      #   context.determine
+      #
+      # @return [ Array<Document> ] The matching documents.
+      def determine(field, operator)
+        matching = documents.inject(nil) do |memo, doc|
+          value = doc.send(field) || 0
+          (memo && memo.send(operator, value)) ? memo : value
+        end
+      end
+
+      # Limits the result set if skip and limit options.
+      #
+      # @example Limit the results.
+      #   context.limit(documents)
+      #
+      # @return [ Array<Document> ] The limited documents.
+      def limit(documents)
+        skip, limit = options[:skip], options[:limit]
+        if skip && limit
+          return documents.slice(skip, limit)
+        elsif limit
+          return documents.first(limit)
+        elsif skip
+          return documents.slice(skip..-1)
+        end
+        documents
+      end
+
+      # Set the collection to the collection of the root document.
+      #
+      # @example Set the collection.
+      #   context.set_collection
+      #
+      # @return [ Collection ] The root collection.
+      def set_collection
+        root = documents.first._root
+        @collection = root.collection if root && !root.embedded?
+      end
+
+      # Sorts the result set if sort options have been set.
+      #
+      # @example Sort the documents.
+      #   context.sort(documents)
+      #
+      # @return [ Array<Document> ] The sorted documents.
+      def sort(documents)
+        return documents if options[:sort].blank?
+        documents.sort_by do |document|
+          options[:sort].map do |key, direction|
+            Sort.new(document.read_attribute(key), direction)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/contexts/enumerable/sort.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Enumerable
+      class Sort
+        attr_reader :value, :direction
+
+        # Create a new sorting object. This requires a value and a sort
+        # direction of +:asc+ or +:desc+.
+        def initialize(value, direction)
+          @value     = value
+          @direction = direction
+        end
+
+        # Return +true+ if the direction is +:asc+, otherwise false.
+        def ascending?
+          direction == :asc
+        end
+
+        # Compare two +Sort+ objects against each other, taking into
+        # consideration the direction of the sorting.
+        def <=>(other)
+          cmp = compare(value, other.value)
+          ascending? ? cmp : cmp * -1
+        end
+
+        private
+
+        # Compare two values allowing for nil values.
+        def compare(a, b)
+          case
+          when a.nil?
+            b.nil? ? 0 : 1
+          when b.nil?
+            -1
+          else
+            a <=> b
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/contexts/mongo.rb

@@ -0,0 +1,345 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Mongo
+      attr_accessor :criteria
+
+      delegate :klass, :options, :field_list, :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(
+          :key => field_list,
+          :cond => selector,
+          :initial => { :count => 0 },
+          :reduce => Javascript.aggregate
+        )
+      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 Get the count without skip and limit taken into consideration.
+      #   context.count
+      #
+      # @example Get the count with skip and limit applied.
+      #   context.count(true)
+      #
+      # @param [Boolean] extras True to inclued previous skip/limit
+      #   statements in the count; false to ignore them. Defaults to `false`.
+      #
+      # @return [ Integer ] The count of documents.
+      def count(extras = false)
+        @count ||= klass.collection.find(selector, process_options).count(extras)
+      end
+
+      # Delete all the documents in the database matching the selector.
+      #
+      # @example Delete the documents.
+      #   context.delete_all
+      #
+      # @return [ Integer ] The number of documents deleted.
+      #
+      # @since 2.0.0.rc.1
+      def delete_all
+        klass.delete_all(:conditions => selector)
+      end
+      alias :delete :delete_all
+
+      # Destroy all the documents in the database matching the selector.
+      #
+      # @example Destroy the documents.
+      #   context.destroy_all
+      #
+      # @return [ Integer ] The number of documents destroyed.
+      #
+      # @since 2.0.0.rc.1
+      def destroy_all
+        klass.destroy_all(:conditions => selector)
+      end
+      alias :destroy :destroy_all
+
+      # 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
+        klass.collection.find(selector, process_options) || []
+      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(
+          :key => field_list,
+          :cond => selector,
+          :initial => { :group => [] },
+          :reduce => Javascript.group
+        ).collect do |docs|
+          docs["group"] = docs["group"].collect do |attrs|
+            Mongoid::Factory.from_db(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.selector.keys.include?(:_type)
+          @criteria = criteria.in(:_type => criteria.klass._types)
+        end
+        @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.from_db(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.from_db(klass, attributes) : nil
+      end
+
+      alias :first :one
+
+      # Return the first result for the +Context+ and skip it
+      # for successive calls.
+      #
+      # Returns:
+      #
+      # The first document in the collection.
+      def shift
+        document = first
+        criteria.skip((options[:skip] || 0) + 1)
+        document
+      end
+
+      # 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(
+          :cond => selector,
+          :initial => { start => "start" },
+          :reduce => 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)
+          if fields.kind_of?(Hash)
+            fields[:_type] = 1 if fields.first.last != 0 # Not excluding
+          else
+            fields << :type
+          end
+          options[:fields] = fields
+        end
+        options.dup
+      end
+
+      # Very basic update that will perform a simple atomic $set of the
+      # attributes provided in the hash. Can be expanded to later for more
+      # robust functionality.
+      #
+      # @example Update all matching documents.
+      #   context.update_all(:title => "Sir")
+      #
+      # @param [ Hash ] attributes The sets to perform.
+      #
+      # @since 2.0.0.rc.4
+      def update_all(attributes = {})
+        klass.collection.update(
+          selector,
+          { "$set" => attributes },
+          :multi => true,
+          :safe => Mongoid.persist_in_safe_mode
+        )
+      end
+      alias :update :update_all
+
+      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