jnunemaker-mongomapper 0.2.0 → 0.3.0

data/.gitignore

@@ -4,3 +4,4 @@ coverage
 rdoc
 pkg
 *~
+*.gem

data/History

@@ -1,3 +1,20 @@
+0.3.0 7/28/2009
+* 5 major additions, 3 minor additions, 3 bug fix, and other miscellany
+  * BACKWORDS COMPATIBILITY BREAK: _id is now stored in binary form (recommended by mongodb team) instead of string, api is the same everywhere as before but data stored with string id's previous to change will need to be updated
+  * Added Document#paginate which works just like find but adds pagination (dcu did basics and I pimped)
+  * Added a basic console for playing around with MongoMapper (dcu)
+  * Embedded associations can now be deeply nested (Keith Hanson)
+  * Added support for many polymorphic documents (Felipe Coury and Me)
+  * Fixed bug where conditions that disallowed using $in, $all and $any with an array
+  * Bumped version of validatable so :if validation option supports symbol/string to proc.
+  * Document#create with no attributes now creates a document as long as it is valid
+  * Now defining accessor methods when key is declared rather than using method missing and all that jazz
+  * Attributes now have boolean methods that return true or false based on whether they have value present
+  * Added scoped finds and pagination on many document association.
+  * find first and last now use natural order which is more reliable.
+  * Updated to latest ruby driver (0.10.1)
+  
+
 0.2.0 7/7/2009
 * 2 major additions (observers, associations), several minor additions, and a few bug fixes
   * Added observers

data/README.rdoc

@@ -2,15 +2,18 @@
 
 Awesome gem for modeling your domain and storing it in mongo.
 
-== Note on Releases
+Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
 
-Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code and run 'rake install' to install the gem.
+* rake gemspec
+* gem build mongomapper.gemspec
+* gem install the gem that was built
 
 == Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Dependencies

data/Rakefile

@@ -12,8 +12,9 @@ begin
     gem.rubyforge_project = "mongomapper"
     
     gem.add_dependency('activesupport')
-    gem.add_dependency('mongodb-mongo', '0.9')
-    gem.add_dependency('jnunemaker-validatable', '1.7.1')
+    gem.add_dependency('mongodb-mongo', '0.10.1')
+    gem.add_dependency('jnunemaker-validatable', '1.7.2')
+    gem.add_dependency('deep_merge', '0.1.0')
     
     gem.add_development_dependency('mocha', '0.9.4')
     gem.add_development_dependency('jnunemaker-matchy', '0.4.0')

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/mmconsole

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+$:.unshift File.dirname(__FILE__)+"/../lib"
+
+require 'mongomapper'
+require 'irb'
+
+IRB.setup(nil)
+irb = IRB::Irb.new
+
+IRB.conf[:MAIN_CONTEXT] = irb.context
+
+irb.context.evaluate("require 'irb/completion'", 0)
+irb.context.evaluate(%@
+include XGen::Mongo::Driver
+include MongoMapper
+
+MongoMapper.database = "mmtest"
+$db = MongoMapper.database
+
+@, 0)
+
+puts %@
+Welcome to the MongoMapper Console!
+
+Example 1:
+  things = $db.collection("things")
+  things.insert("name" => "Raw Thing")
+  things.insert("name" => "Another Thing", "date" => Time.now)
+
+  cursor = things.find("name" => "Raw Thing")
+  puts cursor.next_object.inspect
+
+Example 2:
+  class Thing
+    include MongoMapper::Document
+    key :name, String, :required => true
+    key :date, Time
+  end
+
+  thing = Thing.new
+  thing.name = "My thing"
+  thing.date = Time.now
+  thing.save
+
+  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/mongomapper.rb

@@ -2,38 +2,69 @@ require 'pathname'
 require 'rubygems'
 
 gem 'activesupport'
-gem 'mongodb-mongo', '0.9'
-gem 'jnunemaker-validatable', '1.7.1'
+gem 'mongodb-mongo', '0.10.1'
+gem 'jnunemaker-validatable', '1.7.2'
+gem 'deep_merge', '0.1.0'
 
 require 'activesupport'
 require 'mongo'
 require 'validatable'
+require 'deep_merge'
 
-dir = Pathname(__FILE__).dirname.expand_path + 'mongomapper'
+class BasicObject #:nodoc:
+  instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
+end unless defined?(BasicObject)
 
-require dir + 'key'
-require dir + 'finder_options'
-require dir + 'rails_compatibility'
-require dir + 'save_with_validation'
-require dir + 'serialization'
-require dir + 'callbacks'
-require dir + 'observing'
-require dir + 'validations'
+class Boolean
+  def self.mm_typecast(value)
+    ['true', 't', '1'].include?(value.to_s.downcase)
+  end
+end
+
+class MongoID < XGen::Mongo::Driver::ObjectID
+  def self.mm_typecast(value)
+    begin
+      if value.is_a?(XGen::Mongo::Driver::ObjectID)
+        value
+      else
+        XGen::Mongo::Driver::ObjectID::from_string(value.to_s)
+      end
+    rescue => exception
+      if exception.message == 'illegal ObjectID format'
+        raise MongoMapper::DocumentNotFound
+      else
+        raise exception
+      end
+    end
+  end
+end
+
+dir = Pathname(__FILE__).dirname.expand_path + 'mongomapper'
 
+require dir + 'associations'
 require dir + 'associations/proxy'
 require dir + 'associations/array_proxy'
 require dir + 'associations/base'
-
-require dir + 'associations/has_many_proxy'
-require dir + 'associations/has_many_embedded_proxy'
+require dir + 'associations/many_proxy'
+require dir + 'associations/many_embedded_proxy'
+require dir + 'associations/many_embedded_polymorphic_proxy'
 require dir + 'associations/belongs_to_proxy'
-require dir + 'associations/polymorphic_belongs_to_proxy'
-require dir + 'associations'
+require dir + 'associations/belongs_to_polymorphic_proxy'
+require dir + 'callbacks'
+require dir + 'finder_options'
+require dir + 'key'
+require dir + 'observing'
+require dir + 'pagination'
+require dir + 'rails_compatibility/document'
+require dir + 'rails_compatibility/embedded_document'
+require dir + 'save_with_validation'
+require dir + 'serialization'
+require dir + 'validations'
 
 require dir + 'embedded_document'
 require dir + 'document'
 
-module MongoMapper
+module MongoMapper  
   class DocumentNotFound < StandardError; end
   class DocumentNotValid < StandardError
     def initialize(document)

data/lib/mongomapper/associations.rb

@@ -2,33 +2,12 @@ module MongoMapper
   module Associations
     module ClassMethods
       def belongs_to(association_id, options = {})
-        association = create_association(:belongs_to, association_id, options)
-
-        ref_id = "#{association_id}_id"
-        key ref_id, String
-
-        define_method("#{ref_id}=") do |value|
-          write_attribute(ref_id, value)
-        end
-
-        if options[:polymorphic]
-          ref_type = "#{association_id}_type"
-          key ref_type, String
-
-          define_method("#{ref_type}=") do |value|
-            write_attribute(ref_type, value)
-          end
-        end
-
-        define_association_methods(association)
-
+        create_association(:belongs_to, association_id, options)        
         self
       end
 
       def many(association_id, options = {})
-        association = create_association(:many, association_id, options)
-        define_association_methods(association)
-
+        create_association(:many, association_id, options)        
         self
       end
 
@@ -37,31 +16,44 @@ module MongoMapper
       end
 
       private
-      def create_association(type, name, options)
-        association = Associations::Base.new(type, name, options)
-        associations[association.name] = association
-        association
-      end
-
-      def define_association_methods(association)
-        define_method(association.name) do
-          get_proxy(association)
+        def create_association(type, name, options)
+          association = Associations::Base.new(type, name, options)
+          associations[association.name] = association
+          define_association_methods(association)
+          define_association_keys(association)
+          association
         end
-
-        define_method("#{association.name}=") do |value|
-          get_proxy(association).replace(value)
-          value
+        
+        def define_association_methods(association)
+          define_method(association.name) do
+            get_proxy(association)
+          end
+          
+          define_method("#{association.name}=") do |value|
+            get_proxy(association).replace(value)
+            value
+          end
+        end
+        
+        def define_association_keys(association)
+          if association.belongs_to?
+            key(association.belongs_to_key_name, String)
+            key(association.type_key_name, String) if association.polymorphic?            
+          end
+          
+          if association.many? && association.polymorphic?
+            association.klass.send(:key, association.type_key_name, String)
+          end
         end
-      end
     end
 
     module InstanceMethods
       def get_proxy(association)
-        proxy = self.instance_variable_get(association.ivar)
-        if proxy.nil?
+        unless proxy = self.instance_variable_get(association.ivar)
           proxy = association.proxy_class.new(self, association)
           self.instance_variable_set(association.ivar, proxy)
         end
+        
         proxy
       end
     end

data/lib/mongomapper/associations/base.rb

@@ -8,43 +8,61 @@ module MongoMapper
         @type = type
         @name = name
       end
-
-      def klass
-        class_name.constantize
-      end
-
+      
       def class_name
         @class_name ||= begin
           if cn = options[:class_name]
             cn
-          elsif @type == :many
+          elsif many?
             name.to_s.singularize.camelize
           else
             name.to_s.camelize
           end
         end
       end
-
+      
+      def klass
+        @klass ||= class_name.constantize
+      end
+      
+      def many?
+        @many_type ||= @type == :many
+      end
+      
+      def belongs_to?
+        @belongs_to_type ||= @type == :belongs_to
+      end
+      
+      def polymorphic?
+        !!@options[:polymorphic]
+      end
+      
+      def type_key_name
+        @type_key_name ||= many? ? '_type' : "#{name}_type"
+      end
+      
+      def belongs_to_key_name
+        "#{name}_id"
+      end
+      
       def ivar
         @ivar ||= "@_#{name}"
       end
+      
+      def embeddable?
+        many? && klass.embeddable?
+      end
 
       def proxy_class
-        case @type
-          when :belongs_to
-            if @options[:polymorphic]
-              PolymorphicBelongsToProxy
-            else
-              BelongsToProxy
-            end
-          when :many
-            if self.klass.embeddable?
-              HasManyEmbeddedProxy
-            else
-              HasManyProxy
-            end
-        end
-      end
+        @proxy_class ||= begin
+          if many?
+            return ManyProxy unless self.klass.embeddable?            
+            polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
+          else
+            polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
+          end
+        end # end begin
+      end # end proxy_class
     end
   end
 end

data/lib/mongomapper/associations/belongs_to_polymorphic_proxy.rb

@@ -0,0 +1,33 @@
+module MongoMapper
+  module Associations
+    class BelongsToPolymorphicProxy < Proxy
+      def replace(doc)        
+        if doc
+          doc.save if doc.new?
+          id, type = doc.id, doc.class.name
+        end
+        
+        @owner.send("#{@association.belongs_to_key_name}=", id)
+        @owner.send("#{@association.type_key_name}=", type)
+        
+        reload_target
+      end
+      
+      protected
+        def find_target
+          proxy_class.find(proxy_id) if proxy_id && proxy_class
+        end
+        
+        def proxy_id
+          @proxy_id ||= @owner.send(@association.belongs_to_key_name)
+        end
+        
+        def proxy_class
+          @proxy_class ||= begin
+            klass = @owner.send(@association.type_key_name)
+            klass && klass.constantize
+          end
+        end
+    end
+  end
+end

data/lib/mongomapper/associations/belongs_to_proxy.rb

@@ -1,26 +1,22 @@
 module MongoMapper
   module Associations
     class BelongsToProxy < Proxy
-      def replace(v)
-        ref_id = "#{@association.name}_id"
-
-        if v
-          v.save if v.new?
-          @owner.__send__(:write_attribute, ref_id, v.id)
-        else
-          @owner.__send__(:write_attribute, ref_id, nil)
+      def replace(doc)
+        if doc
+          doc.save if doc.new?
+          id = doc.id
         end
-
+        
+        @owner.send("#{@association.belongs_to_key_name}=", id)
         reload_target
       end
 
       protected
-      def find_target
-        ref = @owner.__send__(:read_attribute, "#{@association.name}_id")
-        if ref
-          @association.klass.find(ref)
+        def find_target
+          if ref = @owner.send(@association.belongs_to_key_name)
+            @association.klass.find(ref)
+          end
         end
-      end
     end
   end
 end