mongo_mapper 0.8.6 → 0.9.0

data/UPGRADES

@@ -1,3 +1,13 @@
+0.8.6 => 0.9
+  * [attribute]_before_typecast should become [attribute]_before_type_cast (note the extra _)
+  * Change validates_exclusion_of :within option to :in
+  * Change validates_inclusion_of :within option to :in
+  * descendants now returns all descendants use direct_descendants for just children
+  * Switch validate_on_create and validate_on_update use validate :on => :create syntax
+  * Added #update_attribute
+  * belongs_to and one associations now return a true nil instead of a proxy to nil, so you must now call .build_thing instead of thing.build.
+  * Plugins should now extend ActiveSupport::Concern
+
 0.7.6 => 0.8
   * Proxy#owner has been removed in favor of Proxy#proxy_owner
   * @new instance variable renamed to @_new (you shouldn't be using this anyway)

data/bin/mmconsole

@@ -16,7 +16,6 @@ IRB.conf[:MAIN_CONTEXT] = irb.context
 
 irb.context.evaluate("require 'irb/completion'", 0)
 irb.context.evaluate(%@
-include MongoMapper
 
 MongoMapper.database = "mm-test"
 $db = MongoMapper.database

data/examples/identity_map/automatic.rb

@@ -1,8 +1,2 @@
 # Using the following will turn on identity map for all models
-module IdentityMapAddition
-  def self.included(model)
-    model.plugin MongoMapper::Plugins::IdentityMap
-  end
-end
-
-MongoMapper::Document.append_inclusions(IdentityMapAddition)
+MongoMapper::Document.plugin(MongoMapper::Plugins::IdentityMap)

data/examples/plugins.rb

@@ -4,9 +4,11 @@ require 'pp'
 
 MongoMapper.database = 'testing'
 
-# To create your own plugin, just create a module.
+# To create your own plugin, just create a module that
+# extends ActiveSupport::Concern.
 module FooPlugin
-  
+  extend ActiveSupport::Concern
+
   # ClassMethods module will automatically get extended
   module ClassMethods
     def foo
@@ -21,14 +23,12 @@ module FooPlugin
     end
   end
 
-  # If present, configure method will be called and passed the 
-  # model as an argument. Feel free to class_eval or add keys.
-  # if method is not present, it doesn't call it.
-  def self.configure(model)
-    puts "Configuring #{model}..."
-    model.key :foo, String
+  # Any configuration can be done in the #included block, which gets
+  # class evaled. Feel free to add keys, validations, or anything else.
+  included do
+    puts "Configuring #{self}..."
+    key :foo, String
   end
-
 end
 
 class User

data/examples/safe.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+  key :email, String
+end
+
+# Drop collection and ensure unique index on email
+User.collection.drop
+User.ensure_index(:email, :unique => true)
+
+User.create(:email => 'nunemaker@gmail.com')
+User.create(:email => 'nunemaker@gmail.com')
+
+puts "Count should only be one since the second create failed, count is: #{User.count}" # 1 because second was not created, but no exception raised
+puts
+
+# save method also takes options, including :safe
+# which will force raise when duplicate is hit
+begin
+  user = User.new(:email => 'nunemaker@gmail.com')
+  user.save(:safe => true)
+rescue Mongo::OperationFailure => e
+  puts 'Mongo Operation failure raised because duplicate email was entered'
+  puts e.inspect
+  puts
+end
+
+# Mark user model as safe, same as doing this...
+# class User
+#   include MongoMapper::Document
+#   safe
+# end
+User.safe
+
+begin
+  User.create(:email => 'nunemaker@gmail.com')
+rescue Mongo::OperationFailure => e
+  puts 'Mongo Operation failure raised because duplicate email was entered'
+  puts e.inspect
+end

data/lib/mongo_mapper.rb

@@ -1,8 +1,10 @@
 # encoding: UTF-8
-# Make sure you have the correct versions of the gems (see gemspec) in your load path.
 require 'plucky'
-require 'validatable'
-require 'active_support/all'
+require 'active_support/core_ext'
+require 'active_model'
+require "mongo_mapper/railtie" if defined?(Rails)
+
+I18n.load_path << File.expand_path('../mongo_mapper/locale/en.yml', __FILE__)
 
 module MongoMapper
   autoload :Connection,             'mongo_mapper/connection'
@@ -16,43 +18,52 @@ module MongoMapper
   autoload :Document,               'mongo_mapper/document'
   autoload :EmbeddedDocument,       'mongo_mapper/embedded_document'
   autoload :Plugins,                'mongo_mapper/plugins'
+  autoload :Translation,            'mongo_mapper/translation'
   autoload :Version,                'mongo_mapper/version'
 
+  module Middleware
+    autoload :IdentityMap, 'mongo_mapper/middleware/identity_map'
+  end
+
   module Plugins
-    autoload :Associations,     'mongo_mapper/plugins/associations'
-    autoload :Accessible,       'mongo_mapper/plugins/accessible'
-    autoload :Callbacks,        'mongo_mapper/plugins/callbacks'
-    autoload :Caching,          'mongo_mapper/plugins/caching'
-    autoload :Clone,            'mongo_mapper/plugins/clone'
-    autoload :Descendants,      'mongo_mapper/plugins/descendants'
-    autoload :Dirty,            'mongo_mapper/plugins/dirty'
-    autoload :Document,         'mongo_mapper/plugins/document'
-    autoload :DynamicQuerying,  'mongo_mapper/plugins/dynamic_querying'
-    autoload :EmbeddedDocument, 'mongo_mapper/plugins/embedded_document'
-    autoload :Equality,         'mongo_mapper/plugins/equality'
-    autoload :IdentityMap,      'mongo_mapper/plugins/identity_map'
-    autoload :Inspect,          'mongo_mapper/plugins/inspect'
-    autoload :Indexes,          'mongo_mapper/plugins/indexes'
-    autoload :Keys,             'mongo_mapper/plugins/keys'
-    autoload :Logger,           'mongo_mapper/plugins/logger'
-    autoload :Modifiers,        'mongo_mapper/plugins/modifiers'
-    autoload :Pagination,       'mongo_mapper/plugins/pagination'
-    autoload :Persistence,      'mongo_mapper/plugins/persistence'
-    autoload :Protected,        'mongo_mapper/plugins/protected'
-    autoload :Querying,         'mongo_mapper/plugins/querying'
-    autoload :Rails,            'mongo_mapper/plugins/rails'
-    autoload :Safe,             'mongo_mapper/plugins/safe'
-    autoload :Sci,              'mongo_mapper/plugins/sci'
-    autoload :Scopes,           'mongo_mapper/plugins/scopes'
-    autoload :Serialization,    'mongo_mapper/plugins/serialization'
-    autoload :Timestamps,       'mongo_mapper/plugins/timestamps'
-    autoload :Userstamps,       'mongo_mapper/plugins/userstamps'
-    autoload :Validations,      'mongo_mapper/plugins/validations'
+    autoload :ActiveModel,        'mongo_mapper/plugins/active_model'
+    autoload :Associations,       'mongo_mapper/plugins/associations'
+    autoload :Accessible,         'mongo_mapper/plugins/accessible'
+    autoload :Callbacks,          'mongo_mapper/plugins/callbacks'
+    autoload :Caching,            'mongo_mapper/plugins/caching'
+    autoload :Clone,              'mongo_mapper/plugins/clone'
+    autoload :Dirty,              'mongo_mapper/plugins/dirty'
+    autoload :Document,           'mongo_mapper/plugins/document'
+    autoload :DynamicQuerying,    'mongo_mapper/plugins/dynamic_querying'
+    autoload :EmbeddedCallbacks,  'mongo_mapper/plugins/embedded_callbacks'
+    autoload :EmbeddedDocument,   'mongo_mapper/plugins/embedded_document'
+    autoload :Equality,           'mongo_mapper/plugins/equality'
+    autoload :IdentityMap,        'mongo_mapper/plugins/identity_map'
+    autoload :Inspect,            'mongo_mapper/plugins/inspect'
+    autoload :Indexes,            'mongo_mapper/plugins/indexes'
+    autoload :Keys,               'mongo_mapper/plugins/keys'
+    autoload :Logger,             'mongo_mapper/plugins/logger'
+    autoload :Modifiers,          'mongo_mapper/plugins/modifiers'
+    autoload :Pagination,         'mongo_mapper/plugins/pagination'
+    autoload :Persistence,        'mongo_mapper/plugins/persistence'
+    autoload :Protected,          'mongo_mapper/plugins/protected'
+    autoload :Querying,           'mongo_mapper/plugins/querying'
+    autoload :Rails,              'mongo_mapper/plugins/rails'
+    autoload :Safe,               'mongo_mapper/plugins/safe'
+    autoload :Sci,                'mongo_mapper/plugins/sci'
+    autoload :Scopes,             'mongo_mapper/plugins/scopes'
+    autoload :Serialization,      'mongo_mapper/plugins/serialization'
+    autoload :Timestamps,         'mongo_mapper/plugins/timestamps'
+    autoload :Userstamps,         'mongo_mapper/plugins/userstamps'
+    autoload :Validations,        'mongo_mapper/plugins/validations'
 
     module Associations
       autoload :Base,                         'mongo_mapper/plugins/associations/base'
       autoload :Collection,                   'mongo_mapper/plugins/associations/collection'
       autoload :EmbeddedCollection,           'mongo_mapper/plugins/associations/embedded_collection'
+      autoload :ManyAssociation,              'mongo_mapper/plugins/associations/many_association'
+      autoload :BelongsToAssociation,         'mongo_mapper/plugins/associations/belongs_to_association'
+      autoload :OneAssociation,               'mongo_mapper/plugins/associations/one_association'
       autoload :ManyDocumentsProxy,           'mongo_mapper/plugins/associations/many_documents_proxy'
       autoload :BelongsToProxy,               'mongo_mapper/plugins/associations/belongs_to_proxy'
       autoload :BelongsToPolymorphicProxy,    'mongo_mapper/plugins/associations/belongs_to_polymorphic_proxy'
@@ -76,4 +87,6 @@ end
 require 'mongo_mapper/support/descendant_appends'
 
 # FIXME: autoload with proxy is failing, need to investigate
-require 'mongo_mapper/plugins/associations/proxy'
+require 'mongo_mapper/plugins/associations/proxy'
+
+ActiveSupport.run_load_hooks(:mongo_mapper, MongoMapper)

data/lib/mongo_mapper/document.rb

@@ -1,41 +1,42 @@
 # encoding: UTF-8
 module MongoMapper
   module Document
+    extend ActiveSupport::Concern
+    extend Plugins
     extend Support::DescendantAppends
 
-    def self.included(model)
-      model.class_eval do
-        extend  Plugins
+    include Plugins::ActiveModel
+    include Plugins::Document
+    include Plugins::Querying # for now needs to be before associations (save_to_collection)
+    include Plugins::Associations
+    include Plugins::Caching
+    include Plugins::Clone
+    include Plugins::DynamicQuerying
+    include Plugins::Equality
+    include Plugins::Inspect
+    include Plugins::Indexes
+    include Plugins::Keys
+    include Plugins::Dirty # for now dirty needs to be after keys
+    include Plugins::Logger
+    include Plugins::Modifiers
+    include Plugins::Pagination
+    include Plugins::Persistence
+    include Plugins::Accessible
+    include Plugins::Protected
+    include Plugins::Rails
+    include Plugins::Safe # needs to be after querying (save_to_collection)
+    include Plugins::Sci
+    include Plugins::Scopes
+    include Plugins::Serialization
+    include Plugins::Timestamps
+    include Plugins::Userstamps
+    include Plugins::Validations
+    include Plugins::EmbeddedCallbacks
+    include Plugins::Callbacks # for now callbacks needs to be after validations
 
-        plugin Plugins::Document
-        plugin Plugins::Querying # for now needs to be before associations (save_to_collection)
-        plugin Plugins::Associations
-        plugin Plugins::Caching
-        plugin Plugins::Clone
-        plugin Plugins::Descendants
-        plugin Plugins::DynamicQuerying
-        plugin Plugins::Equality
-        plugin Plugins::Inspect
-        plugin Plugins::Indexes
-        plugin Plugins::Keys
-        plugin Plugins::Dirty # for now dirty needs to be after keys
-        plugin Plugins::Logger
-        plugin Plugins::Modifiers
-        plugin Plugins::Pagination
-        plugin Plugins::Persistence
-        plugin Plugins::Accessible
-        plugin Plugins::Protected
-        plugin Plugins::Rails
-        plugin Plugins::Safe # needs to be after querying (save_to_collection)
-        plugin Plugins::Sci
-        plugin Plugins::Scopes
-        plugin Plugins::Serialization
-        plugin Plugins::Timestamps
-        plugin Plugins::Userstamps
-        plugin Plugins::Validations
-        plugin Plugins::Callbacks # for now callbacks needs to be after validations
-      end
-      super
+    included do
+      extend Plugins
+      extend Translation
     end
   end # Document
 end # MongoMapper

data/lib/mongo_mapper/embedded_document.rb

@@ -2,30 +2,30 @@
 module MongoMapper
   module EmbeddedDocument
     extend Support::DescendantAppends
+    extend ActiveSupport::Concern
+    extend Plugins
 
-    def self.included(model)
-      model.class_eval do
-        extend  Plugins
+    include Plugins::ActiveModel
+    include Plugins::EmbeddedDocument
+    include Plugins::Associations
+    include Plugins::Caching
+    include Plugins::Clone
+    include Plugins::Equality
+    include Plugins::Inspect
+    include Plugins::Keys
+    include Plugins::Logger
+    include Plugins::Persistence
+    include Plugins::Accessible
+    include Plugins::Protected
+    include Plugins::Rails
+    include Plugins::Sci
+    include Plugins::Serialization
+    include Plugins::Validations
+    include Plugins::EmbeddedCallbacks
 
-        plugin Plugins::EmbeddedDocument
-        plugin Plugins::Associations
-        plugin Plugins::Caching
-        plugin Plugins::Clone
-        plugin Plugins::Descendants
-        plugin Plugins::Equality
-        plugin Plugins::Inspect
-        plugin Plugins::Keys
-        plugin Plugins::Logger
-        plugin Plugins::Persistence
-        plugin Plugins::Accessible
-        plugin Plugins::Protected
-        plugin Plugins::Rails
-        plugin Plugins::Sci
-        plugin Plugins::Serialization
-        plugin Plugins::Validations
-        plugin Plugins::Callbacks
-      end
-      super
+    included do
+      extend Plugins
+      extend Translation
     end
   end
 end

data/lib/mongo_mapper/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  mongo_mapper:
+    errors:
+      messages:
+        taken: "has already been taken"

data/lib/mongo_mapper/middleware/identity_map.rb

@@ -0,0 +1,16 @@
+module MongoMapper
+  module Middleware
+    class IdentityMap
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        MongoMapper::Plugins::IdentityMap.clear
+        @app.call(env)
+      ensure
+        MongoMapper::Plugins::IdentityMap.clear
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins.rb

@@ -1,15 +1,28 @@
 # encoding: UTF-8
 module MongoMapper
   module Plugins
+    include ActiveSupport::DescendantsTracker
+
     def plugins
       @plugins ||= []
     end
 
     def plugin(mod)
-      extend mod::ClassMethods     if mod.const_defined?(:ClassMethods)
-      include mod::InstanceMethods if mod.const_defined?(:InstanceMethods)
-      mod.configure(self)          if mod.respond_to?(:configure)
+      if ActiveSupport::Concern === mod
+        include mod
+      else
+        warn "[DEPRECATED] Plugins must extend ActiveSupport::Concern"
+        extend mod::ClassMethods     if mod.const_defined?(:ClassMethods)
+        include mod::InstanceMethods if mod.const_defined?(:InstanceMethods)
+        mod.configure(self)          if mod.respond_to?(:configure)
+      end
+      direct_descendants.each {|model| model.send(:include, mod) }
       plugins << mod
     end
+
+    def included(base = nil, &block)
+      direct_descendants << base if base
+      super
+    end
   end
 end

data/lib/mongo_mapper/plugins/accessible.rb

@@ -1,6 +1,8 @@
 module MongoMapper
   module Plugins
     module Accessible
+      extend ActiveSupport::Concern
+
       module ClassMethods
         def attr_accessible(*attrs)
           raise AccessibleOrProtected.new(name) if try(:protected_attributes?)

data/lib/mongo_mapper/plugins/active_model.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module ActiveModel
+      extend ActiveSupport::Concern
+
+      include ::ActiveModel::Naming
+      include ::ActiveModel::Conversion
+      include ::ActiveModel::Serialization
+      include ::ActiveModel::Serializers::Xml
+      include ::ActiveModel::Serializers::JSON
+
+      included do
+        extend ::ActiveModel::Translation
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/associations.rb

@@ -2,6 +2,8 @@
 module MongoMapper
   module Plugins
     module Associations
+      extend ActiveSupport::Concern
+
       module ClassMethods
         def inherited(subclass)
           subclass.associations = associations.dup
@@ -9,57 +11,48 @@ module MongoMapper
         end
 
         def belongs_to(association_id, options={}, &extension)
-          create_association(:belongs_to, association_id, options, &extension)
+          create_association(BelongsToAssociation.new(association_id, options, &extension))
         end
 
         def many(association_id, options={}, &extension)
-          create_association(:many, association_id, options, &extension)
+          create_association(ManyAssociation.new(association_id, options, &extension))
         end
 
         def one(association_id, options={}, &extension)
-          create_association(:one, association_id, options, &extension)
+          create_association(OneAssociation.new(association_id, options, &extension))
         end
 
         def associations
-          @associations ||= HashWithIndifferentAccess.new
+          @associations ||= {}
         end
 
         def associations=(hash)
           @associations = hash
         end
 
-        private
-          def create_association(type, name, options, &extension)
-            association = Associations::Base.new(type, name, options, &extension)
-            associations[association.name] = association
-
-            define_method(association.name) do
-              get_proxy(association)
-            end
-
-            define_method("#{association.name}=") do |value|
-              get_proxy(association).replace(value)
-              value
-            end
+        def associations_module_defined?
+          if method(:const_defined?).arity == 1 # Ruby 1.9 compat check
+            const_defined?('MongoMapperAssociations')
+          else
+            const_defined?('MongoMapperAssociations', false)
+          end
+        end
 
-            if association.one? || association.belongs_to?
-              define_method("#{association.name}?") do
-                get_proxy(association).present?
-              end
+        def associations_module
+          if associations_module_defined?
+            const_get 'MongoMapperAssociations'
+          else
+            Module.new.tap do |m|
+              const_set 'MongoMapperAssociations', m
+              include m
             end
+          end
+        end
 
-            if association.options[:dependent] && association.many? && !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
+        private
+          def create_association(association)
+            associations[association.name] = association
+            association.setup(self)
           end
       end
 
@@ -69,26 +62,28 @@ module MongoMapper
         end
 
         def embedded_associations
-          associations.select do |name, association|
-            association.embeddable?
-          end.map do |name, association|
-            association
-          end
+          associations.values.select { |assoc| assoc.embeddable? }
+        end
+
+        def build_proxy(association)
+          proxy = association.proxy_class.new(self, association)
+          self.instance_variable_set(association.ivar, proxy)
+
+          proxy
         end
 
         def get_proxy(association)
           unless proxy = self.instance_variable_get(association.ivar)
-            proxy = association.proxy_class.new(self, association)
-            self.instance_variable_set(association.ivar, proxy)
+            proxy = build_proxy(association)
           end
           proxy
         end
 
         def save_to_collection(options={})
-          super
+          super if defined?(super)
           associations.each do |association_name, association|
             proxy = get_proxy(association)
-            proxy.save_to_collection(options) if proxy.proxy_respond_to?(:save_to_collection)
+            proxy.save_to_collection(options) if proxy.proxy_respond_to?(:save_to_collection) && association.autosave?
           end
         end
       end