tpitale-mongo_mapper 0.6.9

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*~
+*.gem
+tmp
+.yardoc
+doc/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Nunemaker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= MongoMapper
+
+Awesome gem for modeling your domain and storing it in mongo.
+
+Releases are tagged on github and released on gemcutter. Master is pushed to whenever I add a patch or a new feature, but I do not release a new gem version each time I push.
+
+== 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 in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Install
+
+MongoMapper is only released on gemcutter. To install, you can setup gemcutter as your default gem source.
+
+ $ gem install gemcutter
+ $ gem tumble
+ 
+Then you can install MM:
+ 
+ $ gem install mongo_mapper
+
+You can also just declare the source:
+
+ $ gem install mongo_mapper -s http://gemcutter.org
+
+== Dependencies
+
+* ActiveSupport (typically the latest version)
+* Mongo Ruby Driver (mongo)
+* My fork of the validatable gem (jnunemaker-validatable)
+
+== Documentation
+
+Documentation is lacking right now because if you can't look through the code right now and feel comfortable, this is probably too young for you to use. Wait til it stabilizes a bit more.
+
+http://rdoc.info/projects/jnunemaker/mongomapper
+http://groups.google.com/group/mongomapper
+
+== More Info
+
+You can learn more about mongo here:
+http://www.mongodb.org/
+
+You can learn more about the mongo ruby driver here:
+http://github.com/mongodb/mongo-ruby-driver/tree/master
+
+== Copyright
+
+Copyright (c) 2009 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = "tpitale-mongo_mapper"
+  gem.summary     = %Q{Awesome gem for modeling your domain and storing it in mongo}
+  gem.email       = "nunemaker@gmail.com"
+  gem.homepage    = "http://github.com/jnunemaker/mongomapper"
+  gem.authors     = ["John Nunemaker"]
+  
+  gem.add_dependency('activesupport', '>= 2.3')
+  gem.add_dependency('mongo', '0.18.1')
+  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.8')
+end
+
+Jeweler::GemcutterTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.ruby_opts << '-rubygems'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+namespace :test do
+  Rake::TestTask.new(:units) do |test|
+    test.libs << 'test'
+    test.ruby_opts << '-rubygems'
+    test.pattern = 'test/unit/**/test_*.rb'
+    test.verbose = true
+  end
+  
+  Rake::TestTask.new(:functionals) do |test|
+    test.libs << 'test'
+    test.ruby_opts << '-rubygems'
+    test.pattern = 'test/functional/**/test_*.rb'
+    test.verbose = true
+  end
+end
+
+task :default  => :test
+task :test     => :check_dependencies
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = ["--legacy"] if RUBY_VERSION < "1.9.0"
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.9

data/bin/mmconsole

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+begin
+  require 'mongo_mapper'
+  require 'irb'
+rescue LoadError
+  require 'rubygems'
+  retry
+end
+
+IRB.setup(nil)
+irb = IRB::Irb.new
+
+IRB.conf[:MAIN_CONTEXT] = irb.context
+
+irb.context.evaluate("require 'irb/completion'", 0)
+irb.context.evaluate(%@
+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/mongo_mapper/associations/base.rb

@@ -0,0 +1,110 @@
+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, :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
+          else
+            @finder_options[key] = value
+          end
+        end
+      end
+
+      def class_name
+        @class_name ||= begin
+          if cn = options[:class_name]
+            cn
+          elsif many?
+            name.to_s.singularize.camelize
+          else
+            name.to_s.camelize
+          end
+        end
+      end
+
+      def klass
+        @klass ||= options[:class] || 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
+        @proxy_class ||= begin
+          if many?
+            if self.klass.embeddable?
+              polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
+            else
+              if polymorphic?
+                ManyPolymorphicProxy
+              elsif as?
+                ManyDocumentsAsProxy
+              else
+                ManyDocumentsProxy
+              end
+            end
+          else
+            polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
+          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

@@ -0,0 +1,26 @@
+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[reflection.foreign_key] = id
+        owner[reflection.type_key_name] = type
+        reset
+      end
+      
+      protected
+        def find_target
+          return nil if association_class.nil? || owner[reflection.foreign_key].nil?
+          association_class.first(:id => owner[reflection.foreign_key])
+        end
+        
+        def association_class
+          proxy_owner[reflection.type_key_name] ? proxy_owner[reflection.type_key_name].constantize : nil
+        end
+    end
+  end
+end

data/lib/mongo_mapper/associations/belongs_to_proxy.rb

@@ -0,0 +1,21 @@
+module MongoMapper
+  module Associations
+    class BelongsToProxy < Proxy
+      def replace(doc)
+        if doc
+          doc.save if doc.new?
+          id = doc.id
+        end
+        
+        owner[reflection.foreign_key] = id
+        reset
+      end
+
+      protected
+        def find_target
+          return nil if owner[reflection.foreign_key].nil?
+          klass.first(:id => owner[reflection.foreign_key])
+        end
+    end
+  end
+end

data/lib/mongo_mapper/associations/collection.rb

@@ -0,0 +1,19 @@
+module MongoMapper
+  module Associations
+    class Collection < Proxy
+      def to_ary
+        load_target
+        if target.is_a?(Array)
+          target.to_ary
+        else
+          Array(target)
+        end
+      end
+      
+      def reset
+        super
+        target = []
+      end
+    end
+  end
+end

data/lib/mongo_mapper/associations/many_documents_as_proxy.rb

@@ -0,0 +1,26 @@
+module MongoMapper
+  module Associations
+    class ManyDocumentsAsProxy < ManyDocumentsProxy
+      protected
+        def scoped_conditions
+          {type_key_name => owner.class.name, id_key_name => owner.id}
+        end
+
+        def apply_scope(doc)
+          ensure_owner_saved
+          doc[type_key_name] = owner.class.name
+          doc[id_key_name] = owner.id
+          doc
+        end
+        
+      private
+        def type_key_name
+          "#{options[:as]}_type"
+        end
+        
+        def id_key_name
+          "#{options[:as]}_id"
+        end
+    end
+  end
+end

data/lib/mongo_mapper/associations/many_documents_proxy.rb

@@ -0,0 +1,115 @@
+module MongoMapper
+  module Associations
+    class ManyDocumentsProxy < Collection
+      include ::MongoMapper::Finders
+      
+      def find(*args)
+        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))
+      end
+
+      def all(options={})
+        klass.all(scoped_options(options))
+      end
+
+      def first(options={})
+        klass.first(scoped_options(options))
+      end
+
+      def last(options={})
+        klass.last(scoped_options(options))
+      end
+
+      def count(options={})
+        klass.count(scoped_options(options))
+      end
+
+      def replace(docs)
+        load_target
+        target.map(&:destroy)
+        docs.each { |doc| apply_scope(doc).save }
+        reset
+      end
+
+      def <<(*docs)
+        ensure_owner_saved
+        flatten_deeper(docs).each { |doc| apply_scope(doc).save }
+        reset
+      end
+      alias_method :push, :<<
+      alias_method :concat, :<<
+
+      def build(attrs={})
+        doc = klass.new(attrs)
+        apply_scope(doc)
+        doc
+      end
+
+      def create(attrs={})
+        doc = klass.new(attrs)
+        apply_scope(doc).save
+        doc
+      end
+      
+      def create!(attrs={})
+        doc = klass.new(attrs)
+        apply_scope(doc).save!
+        doc
+      end
+
+      def destroy_all(options={})
+        all(options).map(&:destroy)
+        reset
+      end
+
+      def delete_all(options={})
+        klass.delete_all(options.merge(scoped_conditions))
+        reset
+      end
+      
+      def nullify
+        criteria = FinderOptions.new(klass, scoped_conditions).criteria
+        all(criteria).each do |doc|
+          doc.update_attributes(self.foreign_key => nil)
+        end
+        reset
+      end
+
+      protected
+        def scoped_conditions
+          {self.foreign_key => owner.id}
+        end
+        
+        def scoped_options(options)
+          reflection.finder_options.merge(options).merge(scoped_conditions)
+        end
+
+        def find_target
+          all
+        end
+
+        def ensure_owner_saved
+          owner.save if owner.new?
+        end
+
+        def apply_scope(doc)
+          ensure_owner_saved
+          doc[foreign_key] = owner.id
+          doc
+        end
+
+        def foreign_key
+          options[:foreign_key] || owner.class.name.underscore.gsub("/", "_") + "_id"
+        end
+    end
+  end
+end

data/lib/mongo_mapper/associations/many_embedded_polymorphic_proxy.rb

@@ -0,0 +1,31 @@
+module MongoMapper
+  module Associations
+    class ManyEmbeddedPolymorphicProxy < Collection
+      def replace(values)
+        @_values = values.map do |v|
+          if v.kind_of?(EmbeddedDocument)
+            v.attributes.merge(reflection.type_key_name => v.class.name)
+          else
+            v
+          end
+        end
+        reset
+      end
+
+      protected
+        def find_target
+          (@_values || []).map do |hash|
+            polymorphic_class(hash).new(hash)
+          end
+        end
+        
+        def polymorphic_class(doc)
+          if class_name = doc[reflection.type_key_name]
+            class_name.constantize
+          else
+            klass
+          end
+        end
+    end
+  end
+end

data/lib/mongo_mapper/associations/many_embedded_proxy.rb

@@ -0,0 +1,54 @@
+module MongoMapper
+  module Associations
+    class ManyEmbeddedProxy < Collection
+      def replace(values)
+        @_values = values.map do |v|
+          v.kind_of?(EmbeddedDocument) ? v.attributes : v
+        end
+        reset
+      end
+
+      def build(attributes={})
+        doc = klass.new(attributes)
+        assign_root_document(doc)
+        self << doc
+        doc
+      end
+
+      # TODO: test that both string and oid version work
+      def find(id)
+        load_target
+        target.detect { |item| item.id.to_s == id || item.id == id }
+      end
+
+      def <<(*docs)
+        load_target
+        docs.each do |doc|
+          assign_root_document(doc)
+          target << doc
+        end
+      end
+      alias_method :push, :<<
+      alias_method :concat, :<<
+
+      private
+        def find_target
+          (@_values || []).map do |v|
+            child = klass.new(v)
+            assign_root_document(child)
+            child
+          end
+        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

data/lib/mongo_mapper/associations/many_polymorphic_proxy.rb

@@ -0,0 +1,11 @@
+module MongoMapper
+  module Associations
+    class ManyPolymorphicProxy < ManyDocumentsProxy
+      private
+        def apply_scope(doc)
+          doc[reflection.type_key_name] = doc.class.name
+          super
+        end
+    end
+  end
+end