mongo_mapper 0.5.8 → 0.6.0

data/Rakefile

@@ -13,12 +13,12 @@ Jeweler::Tasks.new do |gem|
   
   gem.add_dependency('activesupport', '>= 2.3')
   gem.add_dependency('mongo', '0.16')
-  gem.add_dependency('jnunemaker-validatable', '1.8.0')
+  gem.add_dependency('jnunemaker-validatable', '1.8.1')
   
   gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
   gem.add_development_dependency('shoulda', '2.10.2')
   gem.add_development_dependency('timecop', '0.3.1')
-  gem.add_development_dependency('mocha', '0.9.4')
+  gem.add_development_dependency('mocha', '0.9.8')
 end
 
 Jeweler::GemcutterTasks.new
@@ -51,5 +51,5 @@ task :default  => :test
 task :test     => :check_dependencies
 
 YARD::Rake::YardocTask.new(:doc) do |t|
-  t.options = ["--legacy"]
-end
+  t.options = ["--legacy"] if RUBY_VERSION < "1.9.0"
+end

data/VERSION

@@ -1 +1 @@
-0.5.8
+0.6.0

data/bin/mmconsole

@@ -1,8 +1,13 @@
 #!/usr/bin/env ruby
-$:.unshift File.dirname(__FILE__)+"/../lib"
-
-require 'mongo_mapper'
-require 'irb'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+begin
+  require 'mongo_mapper'
+  require 'irb'
+rescue LoadError
+  require 'rubygems'
+  retry
+end
 
 IRB.setup(nil)
 irb = IRB::Irb.new
@@ -43,12 +48,12 @@ Example 2:
 
   all_things = Thing.all
   puts all_things.map { |object| object.name }.inspect
-
 @
 
 trap("SIGINT") do
   irb.signal_handle
 end
+
 catch(:IRB_EXIT) do
   irb.eval_input
 end

data/lib/mongo_mapper.rb

@@ -15,28 +15,32 @@ module MongoMapper
   # raised when document not valid and using !
   class DocumentNotValid < MongoMapperError
     def initialize(document)
-      @document = document
-      super("Validation failed: #{@document.errors.full_messages.join(", ")}")
+      super("Validation failed: #{document.errors.full_messages.join(", ")}")
     end
   end
   
+  # @api public
   def self.connection
     @@connection ||= Mongo::Connection.new
   end
-
+  
+  # @api public
   def self.connection=(new_connection)
     @@connection = new_connection
   end
   
+  # @api public
   def self.logger
     connection.logger
   end
-
+  
+  # @api public
   def self.database=(name)
     @@database = nil
     @@database_name = name
   end
-
+  
+  # @api public
   def self.database
     if @@database_name.blank?
       raise 'You forgot to set the default database name: MongoMapper.database = "foobar"'
@@ -45,14 +49,17 @@ module MongoMapper
     @@database ||= MongoMapper.connection.db(@@database_name)
   end
   
+  # @api private
   def self.ensured_indexes
     @@ensured_indexes ||= []
   end
   
+  # @api private
   def self.ensure_index(klass, keys, options={})
     ensured_indexes << {:klass => klass, :keys => keys, :options => options}
   end
   
+  # @api public
   def self.ensure_indexes!
     ensured_indexes.each do |index|
       unique = index[:options].delete(:unique)
@@ -60,6 +67,7 @@ module MongoMapper
     end
   end
   
+  # @api private
   module Finders
     def dynamic_find(finder, args)
       attributes = {}
@@ -83,9 +91,24 @@ module MongoMapper
       end
     end
   end
+  
+  # @api private
+  def self.use_time_zone?
+    Time.respond_to?(:zone) && Time.zone ? true : false
+  end
+  
+  # @api private
+  def self.time_class
+    use_time_zone? ? Time.zone : Time
+  end
+  
+  def self.normalize_object_id(value)
+    value.is_a?(String) ? Mongo::ObjectID.from_string(value) : value
+  end
 end
 
 require 'mongo_mapper/support'
+require 'mongo_mapper/types'
 require 'mongo_mapper/associations'
 require 'mongo_mapper/associations/base'
 require 'mongo_mapper/associations/proxy'

data/lib/mongo_mapper/associations.rb

@@ -1,13 +1,121 @@
 module MongoMapper
   module Associations
     module ClassMethods
-      def belongs_to(association_id, options={})
-        create_association(:belongs_to, association_id, options)
+      ##
+      # This macro allows you define a "belongs-to" relationship between one 
+      # document and some other document.
+      #
+      # == Requirements
+      #
+      # Usage of this macro requires that your document define a key that can 
+      # be used to store the ID of the target document that is the parent of 
+      # this document.
+      #
+      # == Conventions
+      # 
+      # The following is a list of the conventions used by MongoMapper in 
+      # defining a belongs-to relationship. Each can likely be overridden via 
+      # the +options+ parameter.
+      #
+      # * The name of your belongs-to association is the lowercase, singular 
+      #   name of the target class
+      # * A key with the name of your association exists with an "_id" suffix 
+      #   to store the ID of the target of this relationship
+      #
+      # @param [Symbol] association_id The name of this association
+      # @param [Hash] options Optional parameters that define the 
+      #   characteristics of this relationship. These are often used to 
+      #   override MongoMapper conventions.
+      # @option options [Boolean] :polymorphic (false) Set this option to 
+      #   <code>true</code> to define a relationship that can be between this 
+      #   document and any other type of document. Note that you *must* also 
+      #   have a key on your document to store the type of document in this 
+      #   relationship.
+      # @option options [String] :class_name If your relationship doesn't use 
+      #   the name of some class, you *must* use this option to indicate the 
+      #   target class for this relationship.
+      # @option options [Symbol] :foreign_key Use this option to specify a 
+      #   non-conventional key that stores the ID of the parent in this 
+      #   relationship
+      #
+      # @example Conventional, and simple, usage of <code>belongs_to</code>
+      #   class Novel
+      #     include MongoMapper::Document
+      #
+      #     key :author_id, String # our "foreign key"
+      #
+      #     belongs_to :author
+      #   end
+      #
+      # @example Using :foreign_key and :class_name
+      #   class Pet
+      #     include MongoMapper::Document
+      #
+      #     key :person_id, String
+      #
+      #     belongs_to :owner,
+      #       :foreign_key => :person_id,
+      #       :class_name  => "Person"
+      #   end
+      #
+      # @example Defining a polymorphic belongs-to relationship
+      #   class Vehicle
+      #     include MongoMapper::Document
+      #
+      #     key :owner_id,   String
+      #     key :owner_type, String
+      #
+      #     belongs_to :owner,
+      #       :polymorphic => true
+      #   end
+      #
+      # @example Non-standard polymorphic belongs-to relationship
+      #   class Vehicle
+      #     include MongoMapper::Document
+      #
+      #     key :person_id,   String
+      #     key :person_type, String
+      #
+      #     belongs_to :owner,
+      #       :polymorphic   => true,
+      #       :foreign_key   => "person_id",
+      #       :type_key_name => "person_type"
+      #   end
+      def belongs_to(association_id, options={}, &extension)
+        create_association(:belongs_to, association_id, options, &extension)
         self
       end
 
-      def many(association_id, options = {}, &block)
-        create_association(:many, association_id, options, &block)
+      ##
+      # This macro allows you to define a "has-many" relationship between a 
+      # document, and numerous child documents.
+      #
+      # == Conventions
+      #
+      # The following is a list of the conventions used by MongoMapper in 
+      # defining this relationship. Each can likely be overridden via the 
+      # +options+ parameter.
+      #
+      # * The name of your association is the lowercase, *plural* name of the 
+      #   target class
+      # * Your target class must have a "foreign key" bearing the name of this 
+      #   class suffixed by "_id"
+      #
+      # @param [Symbol] association_id The name of this association
+      # @param [Hash] options Optional parameters that define the 
+      #   characteristics of this relationship. These are often used to 
+      #   override MongoMapper conventions.
+      # @option options [String] :class_name If your relationship doesn't use 
+      #   the name of some class, you *must* use this option to indicate the 
+      #   target class for this relationship.
+      # @option options [Symbol] :foreign_key Use this option to specify a 
+      #   non-conventional key that stores the ID of the parent in this 
+      #   relationship
+      # @option options [#to_s] :as Used when the target relationship is 
+      #   polymorphic (i.e. the +belongs_to+ has set <tt>:polymorphic</tt> to 
+      #   +true+). See examples for usage.
+      def many(association_id, options={}, &extension)
+        create_association(:many, association_id, options, &extension)
         self
       end
 
@@ -19,19 +127,12 @@ module MongoMapper
 
       private
         def create_association(type, name, options, &extension)
-          options[:extend] = modulized_extensions(extension, options[:extend])
-          association = Associations::Base.new(type, name, options)
+          association = Associations::Base.new(type, name, options, &extension)
           associations[association.name] = association
           define_association_methods(association)
           define_dependent_callback(association)
           association
         end
-        
-        def modulized_extensions(*extensions)
-          extensions.flatten.compact.map do |extension|
-            Proc === extension ? Module.new(&extension) : extension
-          end
-        end
 
         def define_association_methods(association)
           define_method(association.name) do

data/lib/mongo_mapper/associations/base.rb

@@ -1,15 +1,20 @@
 module MongoMapper
   module Associations
+    # Base class for keeping track of associations.
+    #
+    # @private
     class Base
       attr_reader :type, :name, :options, :finder_options
-      
+
       # Options that should not be considered MongoDB query options/criteria
-      AssociationOptions = [:as, :class_name, :dependent, :extend, :foreign_key, :polymorphic]
-      
-      def initialize(type, name, options={})
-        @type, @name = type, name
-        @options, @finder_options = {}, {}
-        
+      AssociationOptions = [:as, :class, :class_name, :dependent, :extend, :foreign_key, :polymorphic]
+
+      def initialize(type, name, options={}, &extension)
+        @type, @name, @options, @finder_options = type, name, {}, {}
+        options.symbolize_keys!
+
+        options[:extend] = modulized_extensions(extension, options[:extend])
+
         options.each_pair do |key, value|
           if AssociationOptions.include?(key)
             @options[key] = value
@@ -32,13 +37,13 @@ module MongoMapper
       end
 
       def klass
-        @klass ||= class_name.constantize
+        @klass ||= options[:class] || class_name.constantize
       end
 
       def many?
         @many_type ||= @type == :many
       end
-      
+
       def belongs_to?
         @belongs_to_type ||= @type == :belongs_to
       end
@@ -90,6 +95,16 @@ module MongoMapper
           end
         end # end begin
       end # end proxy_class
+
+      private
+
+        # @param [Array<Module, Proc>] extensions a collection of Modules or 
+        #   Procs that extend the behaviour of this association.
+        def modulized_extensions(*extensions)
+          extensions.flatten.compact.map do |extension|
+            Proc === extension ? Module.new(&extension) : extension
+          end
+        end
     end
   end
 end

data/lib/mongo_mapper/associations/belongs_to_polymorphic_proxy.rb

@@ -4,7 +4,7 @@ module MongoMapper
       def replace(doc)
         if doc
           doc.save if doc.new?
-          id, type = doc.id, doc.class.name
+          id, type = doc._id, doc.class.name
         end
         
         @owner.send("#{@association.foreign_key}=", id)

data/lib/mongo_mapper/associations/belongs_to_proxy.rb

@@ -4,7 +4,7 @@ module MongoMapper
       def replace(doc)
         if doc
           doc.save if doc.new?
-          id = doc.id
+          id = doc._id
         end
 
         @owner.send("#{@association.foreign_key}=", id)

data/lib/mongo_mapper/associations/many_documents_as_proxy.rb

@@ -3,13 +3,13 @@ module MongoMapper
     class ManyDocumentsAsProxy < ManyDocumentsProxy
       protected
         def scoped_conditions
-          {as_type_name => @owner.class.name, as_id_name => @owner.id}
+          {as_type_name => @owner.class.name, as_id_name => @owner._id}
         end
 
         def apply_scope(doc)
           ensure_owner_saved
           doc.send("#{as_type_name}=", @owner.class.name)
-          doc.send("#{as_id_name}=", @owner.id)
+          doc.send("#{as_id_name}=", @owner._id)
           doc
         end
 

data/lib/mongo_mapper/associations/many_documents_proxy.rb

@@ -10,6 +10,11 @@ module MongoMapper
         options = args.extract_options!
         klass.find(*args << scoped_options(options))
       end
+      
+      def find!(*args)
+        options = args.extract_options!
+        klass.find!(*args << scoped_options(options))
+      end
 
       def paginate(options)
         klass.paginate(scoped_options(options))
@@ -93,7 +98,7 @@ module MongoMapper
       
       protected
         def scoped_conditions
-          {self.foreign_key => @owner.id}
+          {self.foreign_key => @owner._id}
         end
         
         def scoped_options(options)
@@ -110,7 +115,7 @@ module MongoMapper
 
         def apply_scope(doc)
           ensure_owner_saved
-          doc.send("#{self.foreign_key}=", @owner.id)
+          doc.send("#{self.foreign_key}=", @owner._id)
           doc
         end
 

data/lib/mongo_mapper/associations/many_embedded_proxy.rb

@@ -5,34 +5,24 @@ module MongoMapper
         @_values = v.map { |e| e.kind_of?(EmbeddedDocument) ? e.attributes : e }
         reset
       end
-      
-      def build(opts={})
-        owner = @owner
-        child = @association.klass.new(opts)
-        assign_parent_reference(child)
-        child._root_document = owner
-        self << child
-        child
+
+      def build(attributes={})
+        doc = @association.klass.new(attributes)
+        assign_root_document(doc)
+        self << doc
+        doc
       end
-      
-      def find(opts)
-        case opts
-        when :all
-          self
-        when String
-          if load_target
-            child = @target.detect {|item| item.id == opts}
-            assign_parent_reference(child)
-            child
-          end
-        end
+
+      # TODO: test that both string and oid version work
+      def find(id)
+        load_target
+        @target.detect { |item| item.id == id || item._id == id }
       end
 
       def <<(*docs)
         if load_target
-          root = @owner._root_document || @owner
           docs.each do |doc|
-            doc._root_document = root
+            assign_root_document(doc)
             @target << doc
           end
         end
@@ -40,28 +30,24 @@ module MongoMapper
       alias_method :push, :<<
       alias_method :concat, :<<
 
-      protected
+      private
         def find_target
           (@_values || []).map do |e|
             child = @association.klass.new(e)
-            assign_parent_reference(child)
+            assign_root_document(child)
             child
           end
         end
-        
-      private
-      
-        def assign_parent_reference(child)
-          return unless child && @owner
-          return if @owner.class.name.blank?
-          owner = @owner
-          child.class_eval do
-            define_method(owner.class.name.underscore) do
-              owner
-            end
+
+        def root_document
+          @owner._root_document || @owner
+        end
+
+        def assign_root_document(*docs)
+          docs.each do |doc|
+            doc._root_document = root_document
           end
         end
-      
     end
   end
 end