mongodoc 0.2.2 → 0.2.4

data/Rakefile

@@ -81,6 +81,27 @@ namespace :mongo do
   end
 end
 
+namespace :mongoid do
+  desc 'Sync criteria from Mongoid'
+  task :sync do
+    require 'pathname'
+
+    src_dir = Pathname.new('../durran-mongoid/lib/mongoid')
+    dest_dir = Pathname.new('lib/mongoid')
+    dest_dir.mkpath
+    %w(criteria.rb contexts/paging.rb criterion extensions/symbol/inflections.rb extensions/hash/criteria_helpers.rb matchers).each do |f|
+      src = src_dir + f
+      if src.directory?
+        FileUtils.cp_r(src, dest_dir)
+      else
+        dest = dest_dir + f
+        dest.dirname.mkpath
+        FileUtils.cp(src, dest)
+      end
+    end
+  end
+end
+
 namespace :bench do
   desc 'Run benchmark for MongoDoc'
   task 'mongodoc' do

data/TODO

@@ -1,10 +1,15 @@
-As of 2010-02-05
+As of 2010-02-23
 
 Associations
 ------------
 
 Pull associations out of attributes and refactor
 
+Criteria
+--------
+
+Make critieria module, include into Document, CriteriaProxy, Association?
+
 Documentation
 -------------
 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.4

data/features/finders.feature

@@ -52,7 +52,7 @@ Feature: Finders
     And I save the document 'contractor'
 
   Scenario: All
-    When I query contacts with all
+    When I query contacts with find_all
     Then the query result has 3 documents
 
   Scenario: Count

data/features/mongodoc_base.feature

@@ -109,11 +109,20 @@ Feature: MongoDoc::Base
     Then the Place collection should have 1 document
     And the document 'hashrocket' roundtrips
 
-  Scenario: Finder
+  Scenario: Class criteria
     Given an empty Contact document collection
     And a Contact document named 'hashrocket' :
       | Name       | Type    |
       | Hashrocket | company |
     And I save the last document
-    When I query contacts with find {:where => {'type' => 'company'}}
+    When I query contacts with criteria where('type' => 'company')
+    Then the size of the last return value is 1
+
+  Scenario: Finder
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       | Type    |
+      | Hashrocket | company |
+    And I save the document 'hashrocket'
+    When I find a contact using the id of 'hashrocket'
     Then the size of the last return value is 1

data/features/step_definitions/document_steps.rb

@@ -42,7 +42,7 @@ end
 
 Given /^I set the id on the document '(.*)' to (.*)$/ do |doc_name, value|
   doc = instance_variable_get("@#{doc_name}")
-  doc._id = Mongo::ObjectID.new([value.to_i])
+  doc._id = Mongo::ObjectID.from_string("%024x" % value.to_i(16))
 end
 
 Given /^'(.+)' has one (.+?) as (.+?) \(identified by '(.+)'\):$/ do |doc_name, class_name, assoc_name, var_name, table|
@@ -79,10 +79,21 @@ When /^I update the document '(.*)' with the hash named '(.*)'$/ do |doc_name, h
   @last_return = doc.update_attributes(attrs)
 end
 
-When /^I query (.*) with find (.*)$/ do |doc, criteria_text|
+When /^I query (.*) with criteria (.*)$/ do |doc, criteria_text|
+  klass = doc.singularize.camelize
+  @query = @last_return = eval("#{klass}.criteria.#{criteria_text}")
+end
+
+When /^I query (.*) with the '(.*)' id$/ do |doc, name|
   klass = doc.singularize.camelize.constantize
-  criteria = eval(criteria_text)
-  @last_return = klass.find(:all, criteria)
+  doc = instance_variable_get("@#{name}")
+  @query = @last_return = klass.criteria.id(doc.id).entries
+end
+
+When /^I find a (.*) using the id of '(.*)'$/ do |type, doc_name|
+  klass = type.camelize.constantize
+  doc = instance_variable_get("@#{doc_name}")
+  @last_return = klass.find(doc.id)
 end
 
 When /^'(.+)' is the first (.+?) of '(.+)'$/ do |var_name, single_assoc, doc_name|

data/features/step_definitions/documents.rb

@@ -24,7 +24,7 @@ class Contact
   key :interests
   has_many :addresses
 
-  named_scope :rubyists, :in => {:interests => ['ruby']}
-  named_scope :contract_work, :in => {:interests => ['contract work']}
-  named_scope :in_state, lambda {|state| { :where => {'addresses.state' => state}}}
+  scope :rubyists, any_in(:interests => ['ruby'])
+  scope :contract_work, any_in(:interests => ['contract work'])
+  scope :in_state, lambda {|state| where('addresses.state' => state)}
 end

data/features/step_definitions/query_steps.rb

@@ -6,19 +6,23 @@ def query(klass_name = nil)
   @query ||= klass(klass_name).criteria
 end
 
-Then /^the (first|last) query result is equal to the document '(.*)'$/ do |position, name|
-  object = instance_variable_get("@#{name}")
-  query.send(position).should == object
+Then /^the query result is equal to the document '(.*)'$/ do |name|
+  doc = instance_variable_get("@#{name}")
+  query.should == doc
 end
 
 Then /^one of the query results is the document '(.*)'$/ do |name|
-  object = instance_variable_get("@#{name}")
-  query.any? {|doc| doc == object}
+  doc = instance_variable_get("@#{name}")
+  query.any? {|d| d == doc}.should be_true
 end
 
-Then /^the aggregate query result with "(.*)" == "(.*)" has a count of (.*)$/ do |key, value, count|
-  result = query.aggregate
-  result.find {|r| r.has_key?(key) and r[key] == value }['count'].should == count.to_i
+Then /^the query result with "(.*)" == "(.*)" has a count of (.*)$/ do |key, value, count|
+  query.find {|r| r.has_key?(key) and r[key] == value }['count'].should == count.to_i
+end
+
+Then /^the query result with "([^\"]*)" == "([^\"]*)" has the document '(.*)'$/ do |key, value, name|
+  doc = instance_variable_get("@#{name}")
+  query.find {|r| r.has_key?(key) and r[key] == value }['group'].should include(doc)
 end
 
 Then /^the query result has (.*) documents*$/ do |count|
@@ -29,14 +33,13 @@ Then /^the query result has (.*) documents*$/ do |count|
   end
 end
 
-Then /^the size of the query result is (.*)$/ do |count|
-  query.to_a.size.should == count.to_i
+Then /^the (first|last) query result is the document '(.*)'$/ do |position, name|
+  doc = instance_variable_get("@#{name}")
+  query.entries.send(position).should == doc
 end
 
-Then /^the group query result with "([^\"]*)" == "([^\"]*)" has the document '(.*)'$/ do |key, value, name|
-  object = instance_variable_get("@#{name}")
-  result = query.group
-  result.find {|r| r.has_key?(key) and r[key] == value }['group'].should include(object)
+Then /^the size of the query result is (.*)$/ do |count|
+  query.to_a.size.should == count.to_i
 end
 
 Then /^the query result is the document '(.*)'$/ do |name|

data/features/using_criteria.feature

@@ -74,76 +74,55 @@ Feature: MongoDoc::Base
     And I save the document 'jax'
 
   Scenario: Counting results
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
+    When I query contacts with criteria all('interests' => ['ruby', 'rails', 'employment'])
     Then the query result has 2 documents
 
   Scenario: Finding contacts with interests in ruby and rails
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
-    Then the query result has 2 documents
-    And one of the query results is the document 'rocketeer'
+    When I query contacts with criteria all('interests' => ['ruby', 'rails', 'employment'])
+    Then one of the query results is the document 'rocketeer'
 
-  Scenario: Finding contacts with interests in restaurants and hotels
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
-    Then the query result has 2 documents
-    And one of the query results is the document 'contractor'
+  Scenario: Finding contacts with interests in restaurants or hotels
+    When I query contacts with criteria in('interests' => ['restaurants', 'hotels'])
+    Then one of the query results is the document 'contractor'
 
   Scenario: Aggregating Places
-    When I query places to select field "type"
-    And I query places where "{'address.state' => 'FL'}"
-    Then the aggregate query result with "type" == "hotel" has a count of 2
+    When I query places with criteria only('type').where('address.state' => 'FL').aggregate
+    Then the query result with "type" == "hotel" has a count of 2
 
   Scenario: Excluding places in Neptune Beach
-    When I query places to select field "type"
-    And I query places that excludes "{'address.city' => 'Neptune Beach'}"
-    Then the aggregate query result with "type" == "hotel" has a count of 1
+    When I query places with criteria only('type').where('address.city' => 'Neptune Beach').aggregate
+    Then the query result with "type" == "hotel" has a count of 1
 
   Scenario: Using extras to limit results
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
-    And I set the query extras limit on contacts to 1
+    When I query contacts with criteria all('interests' => ['ruby', 'rails', 'employment']).limit(1)
     Then the size of the query result is 1
 
   Scenario: Finding the first result
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
-    Then the first query result is equal to the document 'hashrocket'
+    When I query contacts with criteria all('interests' => ['ruby', 'rails', 'employment']).first
+    Then the query result is equal to the document 'hashrocket'
 
   Scenario: Grouping places by type
-    When I query places to select field "type"
-    And I query places where "{'type' => 'hotel'}"
-    Then the group query result with "type" == "hotel" has the document 'one_ocean'
+    When I query places with criteria only('type').where('type' => 'hotel').group
+    Then the query result with "type" == "hotel" has the document 'one_ocean'
 
   Scenario: Selecting contacts with in operator
-    When I query contacts with in "{'interests' => ['ruby', 'rails', 'employment']}"
+    When I query contacts with criteria in('interests' => ['ruby', 'rails', 'employment'])
     Then the query result has 3 documents
 
   Scenario: Selecting a contact with the id operator
     When I query contacts with the 'hashrocket' id
     Then the query result has 1 documents
-    And the first query result is equal to the document 'hashrocket'
-
-  Scenario: Finding the last result
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
-    Then the last query result is equal to the document 'rocketeer'
-
-  Scenario: Using limit on results
-    When I query contacts with every "{'interests' => ['ruby', 'rails', 'employment']}"
-    And I set the query on contacts to limit 1
-    Then the size of the query result is 1
+    And the query result is the document 'hashrocket'
 
   Scenario: Selecting contacts with not in operator
-    When I query contacts with not in "{'interests' => ['contract work', 'employment']}"
+    When I query contacts with criteria not_in('interests' => ['contract work', 'employment'])
     Then the query result has 0 documents
 
   Scenario: Ordering contacts
-    When I query contacts with in "{'interests' => ['ruby', 'rails']}"
-    And I order the contacts query by "[[:name, :asc]]"
-    Then the first query result is equal to the document 'contractor'
-    Then the last query result is equal to the document 'rocketeer'
+    When I query contacts with criteria in('interests' => ['ruby', 'rails']).order_by([[:name, :asc]]).entries
+    Then the first query result is the document 'contractor'
+    And the last query result is the document 'rocketeer'
 
   Scenario: Using skip on results
-    When I query contacts with every "{'interests' => ['ruby', 'rails']}"
-    And I set the query on contacts to skip 1
+    When I query contacts with criteria all('interests' => ['ruby', 'rails']).skip(1)
     Then the size of the query result is 2
-
-  Scenario: All
-    When I query contacts with 'all'
-    Then the size of the query result is 3

data/lib/mongodoc.rb

@@ -11,7 +11,7 @@ require 'validatable'
 require 'will_paginate/collection'
 
 module MongoDoc
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end
 
 require 'mongodoc/connection'

data/lib/mongodoc/associations/collection_proxy.rb

@@ -2,7 +2,9 @@
 # http://github.com/sandro
 module MongoDoc
   module Associations
-    class CollectionProxy < ProxyBase
+    class CollectionProxy
+      include ProxyBase
+
       # List of array methods (that are not in +Object+) that need to be
       # delegated to +collection+.
       ARRAY_METHODS = (Array.instance_methods - Object.instance_methods).map { |n| n.to_s }

data/lib/mongodoc/associations/document_proxy.rb

@@ -1,9 +1,12 @@
 module MongoDoc
   module Associations
-    class DocumentProxy < ProxyBase
+    class DocumentProxy
+      include ProxyBase
 
       attr_reader :document
 
+      delegate :to_bson, :id, :to => :document
+
       def _root=(root)
         @_root = root
         document._root = root if is_document?(document)

data/lib/mongodoc/associations/hash_proxy.rb

@@ -2,7 +2,9 @@ module MongoDoc
   class InvalidEmbeddedHashKey < RuntimeError; end
 
   module Associations
-    class HashProxy < ProxyBase
+    class HashProxy
+      include ProxyBase
+
       HASH_METHODS = (Hash.instance_methods - Object.instance_methods).map { |n| n.to_s }
 
       MUST_DEFINE = %w[to_a inspect to_bson ==]

data/lib/mongodoc/associations/proxy_base.rb

@@ -1,9 +1,11 @@
 module MongoDoc
   module Associations
-    class ProxyBase
-      undef_method :id, :to_bson
-
-      attr_reader :assoc_name, :assoc_class, :_parent, :_root
+    module ProxyBase
+      def self.included(klass)
+        klass.class_eval do
+          attr_reader :assoc_name, :assoc_class, :_parent, :_root
+        end
+      end
 
       def _parent=(parent)
         @_parent = parent

data/lib/mongodoc/attributes.rb

@@ -51,7 +51,7 @@ module MongoDoc
       def has_one(*args)
         options = args.extract_options!
         assoc_class = if class_name = options.delete(:class_name)
-          type_name_with_module(class_name).constantize
+          self.class_from_name(class_name)
         end
 
         args.each do |name|
@@ -75,7 +75,7 @@ module MongoDoc
       def has_many(*args)
         options = args.extract_options!
         assoc_class = if class_name = options.delete(:class_name)
-          type_name_with_module(class_name).constantize
+          self.class_from_name(class_name)
         end
 
         args.each do |name|
@@ -84,7 +84,7 @@ module MongoDoc
           define_method("#{name}") do
             association = instance_variable_get("@#{name}")
             unless association
-              association = Associations::CollectionProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.type_name_with_module(name.to_s.classify).constantize)
+              association = Associations::CollectionProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.class_from_name(name))
               instance_variable_set("@#{name}", association)
             end
             association
@@ -105,7 +105,7 @@ module MongoDoc
       def has_hash(*args)
         options = args.extract_options!
         assoc_class = if class_name = options.delete(:class_name)
-          type_name_with_module(class_name).constantize
+          self.class_from_name(class_name)
         end
 
         args.each do |name|
@@ -114,7 +114,7 @@ module MongoDoc
           define_method("#{name}") do
             association = instance_variable_get("@#{name}")
             unless association
-              association = Associations::HashProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.type_name_with_module(name.to_s.classify).constantize)
+              association = Associations::HashProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.class_from_name(name))
               instance_variable_set("@#{name}", association)
             end
             association
@@ -133,7 +133,7 @@ module MongoDoc
       end
 
       def type_name_with_module(type_name)
-        (/^::/ =~ type_name) ? type_name : "#{parents}::#{type_name}"
+        (/^::/ =~ type_name) ? type_name : "#{parent}::#{type_name}"
       end
     end
   end

data/lib/mongodoc/contexts.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require "mongoid/contexts/paging"
+require "mongodoc/contexts/enumerable"
+require "mongodoc/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)
+      if criteria.klass.respond_to?(:collection)
+        return MongoDoc::Contexts::Mongo.new(criteria)
+      end
+      return MongoDoc::Contexts::Enumerable.new(criteria)
+    end
+
+  end
+end

data/lib/mongodoc/contexts/enumerable.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+module MongoDoc #:nodoc:
+  module Contexts #:nodoc:
+    class Enumerable
+      include Mongoid::Contexts::Paging
+      attr_reader :criteria
+
+      delegate :first, :last, :to => :execute
+      delegate :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
+
+      # Gets the number of documents in the array. Delegates to size.
+      def count
+        @count ||= documents.size
+      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
+
+      # 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
+
+      # 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?(String) ? one : criteria.entries
+        return result
+      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>MongoDoc::Contexts::Enumerable.new(criteria)</tt>
+      def initialize(criteria)
+        @criteria = criteria
+      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)
+        end
+        documents
+      end
+    end
+  end
+end
+