crnixon-mongomapper 0.2.0 → 0.3.4

data/.gitignore

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

data/History

@@ -1,3 +1,51 @@
+0.3.4 8/28/2009
+  * BACKWORDS COMPATIBILITY BREAK: Timestamps are now optional. To use them add timestamps! to your model.
+  * BACKWORDS COMPATIBILITY BREAK: Associations keys are no longer created automatically when you use belongs_to and many. Too much was hidden from the developer. You now have to declare them like key :creator_id, String and such.
+  * to_json now includes dynamic keys and embedded stuff by default
+  * added polymorphic many with :as option (dcu)
+  
+0.3.3 8/16/2009
+  * BACKWORDS COMPATIBILITY BREAK: _id is now once again a string rather than an object id and will stay that way.
+  * Custom id's can now be used because of the change to string id's
+  * Added dynamic finders to document. (dcu)
+  * Added destroy_all, delete_all and nullify for many document association
+  * Added :dependent option for many documents assocation (dcu)
+  * update_attributes now returns true or false instead of the document. (Durran Jordan and me)
+  * Keys no longer require a type
+  * Keys can now be added on the fly using []=
+  
+0.3.2 8/6/2009
+  * Added many polymorphic documents association
+  * Implemented build and create for many and many polymorphic documents
+  * <<, push and concat now work correctly for many and many polymorphic documents
+  * find(:first) now accepts order option
+  * id is now included by default with to_json
+  * _id is now always excluded from to_json
+  * Times are now always returned as UTC
+  * Default values are now a bit more intelligent for Array and Hash keys (djsun)
+  * Embedded documents now have _id as well so they can be identified more easily
+  
+0.3.1 7/28/2009
+* 1 minor tweak
+  * Removed deep_merge gem as dependency as ActiveSupport has deep_merge that works good enough
+  
+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,16 +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.
 * 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 I can ignore when I pull)
+* 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,14 +12,16 @@ 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.11.1')
+    gem.add_dependency('jnunemaker-validatable', '1.7.2')
     
     gem.add_development_dependency('mocha', '0.9.4')
     gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
   end
-
-  Jeweler::RubyforgeTasks.new
+  
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.4

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,8 +2,8 @@ require 'pathname'
 require 'rubygems'
 
 gem 'activesupport'
-gem 'mongodb-mongo', '0.9'
-gem 'jnunemaker-validatable', '1.7.1'
+gem 'mongodb-mongo', '0.11.1'
+gem 'jnunemaker-validatable', '1.7.2'
 
 require 'activesupport'
 require 'mongo'
@@ -11,37 +11,48 @@ require 'validatable'
 
 dir = Pathname(__FILE__).dirname.expand_path + 'mongomapper'
 
-require dir + 'key'
+require dir + 'support'
+
+require dir + 'associations'
+require dir + 'associations/base'
+
+require dir + 'associations/proxy'
+require dir + 'associations/many_documents_proxy'
+
+require dir + 'associations/belongs_to_proxy'
+require dir + 'associations/belongs_to_polymorphic_proxy'
+require dir + 'associations/many_proxy'
+require dir + 'associations/many_polymorphic_proxy'
+require dir + 'associations/many_embedded_proxy'
+require dir + 'associations/many_embedded_polymorphic_proxy'
+require dir + 'associations/many_documents_as_proxy'
+
+require dir + 'callbacks'
 require dir + 'finder_options'
-require dir + 'rails_compatibility'
+require dir + 'dynamic_finder'
+require dir + 'key'
+require dir + 'observing'
+require dir + 'pagination'
 require dir + 'save_with_validation'
 require dir + 'serialization'
-require dir + 'callbacks'
-require dir + 'observing'
 require dir + 'validations'
 
-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/belongs_to_proxy'
-require dir + 'associations/polymorphic_belongs_to_proxy'
-require dir + 'associations'
+require dir + 'rails_compatibility/document'
+require dir + 'rails_compatibility/embedded_document'
 
 require dir + 'embedded_document'
 require dir + 'document'
 
 module MongoMapper
-  class DocumentNotFound < StandardError; end
-  class DocumentNotValid < StandardError
+  DocumentNotFound  = Class.new(StandardError)
+  
+  DocumentNotValid  = Class.new(StandardError) do
     def initialize(document)
       @document = document
       super("Validation failed: #{@document.errors.full_messages.join(", ")}")
     end
   end
-
+  
   def self.connection
     @@connection ||= XGen::Mongo::Driver::Mongo.new
   end

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,67 @@ module MongoMapper
       end
 
       private
-      def create_association(type, name, options)
-        association = Associations::Base.new(type, name, options)
-        associations[association.name] = association
-        association
-      end
+        def create_association(type, name, options)
+          association = Associations::Base.new(type, name, options)
+          associations[association.name] = association
+          define_association_methods(association)
+          define_dependent_callback(association)
+          association
+        end
 
-      def define_association_methods(association)
-        define_method(association.name) do
-          get_proxy(association)
+        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
 
-        define_method("#{association.name}=") do |value|
-          get_proxy(association).replace(value)
-          value
+        def define_dependent_callback(association)
+          if association.options[:dependent]
+            if association.many?
+              define_dependent_callback_for_many(association)
+            elsif association.belongs_to?
+              define_dependent_callback_for_belongs_to(association)
+            end
+          end
+        end
+
+        def define_dependent_callback_for_many(association)
+          return if association.embeddable?
+
+          after_destroy do |doc|
+            case association.options[:dependent]
+            when :destroy
+              doc.get_proxy(association).destroy_all
+            when :delete_all
+              doc.get_proxy(association).delete_all
+            when :nullify
+              doc.get_proxy(association).nullify
+            end
+          end
+        end
+
+        def define_dependent_callback_for_belongs_to(association)
+          after_destroy do |doc|
+            case association.options[:dependent]
+            when :destroy
+              doc.get_proxy(association).destroy
+            end
+          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)
+          self.instance_variable_set(association.ivar, proxy) if !frozen?
         end
+
         proxy
       end
     end

data/lib/mongomapper/associations/base.rb

@@ -4,20 +4,14 @@ module MongoMapper
       attr_reader :type, :name, :options
 
       def initialize(type, name, options = {})
-        @options = options
-        @type = type
-        @name = name
-      end
-
-      def klass
-        class_name.constantize
+        @type, @name, @options = type, name, options
       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
@@ -25,26 +19,65 @@ module MongoMapper
         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 as?
+        !!@options[:as]
+      end
+
+      def type_key_name
+        @type_key_name ||= many? ? '_type' : "#{as}_type"
+      end
+
+      def as
+        @options[:as] || self.name
+      end
+
+      def foreign_key
+        @options[:foreign_key] || "#{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
+        @proxy_class ||= begin
+          if many?
             if self.klass.embeddable?
-              HasManyEmbeddedProxy
+              polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
             else
-              HasManyProxy
+              if polymorphic?
+                ManyPolymorphicProxy
+              elsif as?
+                ManyDocumentsAsProxy
+              else
+                ManyProxy
+              end
             end
-        end
-      end
+          else
+            polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
+          end
+        end # end begin
+      end # end proxy_class
     end
   end
 end