mongoid 0.12.0 → 1.0.0

data/HISTORY

@@ -1,3 +1,15 @@
+=== 1.0.0
+- Validations cleanup: Only before_validation and
+  after_validation callbacks are supported now.
+
+- Dynamic fields have reader and writer methods
+  again, but only for instances where the dynamic
+  attribute exists.
+
+- Lots of refactoring, mostly coverting common
+  fucntionality into modules for the upcoming rails
+  2 and 3 gem split.
+
 === 0.12.0
 - Has one now works as expected:
 

data/README.rdoc

@@ -0,0 +1,56 @@
+= Overview
+
+== About Mongoid
+
+Mongoid is an ODM (Object-Document-Mapper) framework for MongoDB in Ruby.
+
+== Project Tracking
+
+* {Mongoid on Pivotal Tracker}[http://www.pivotaltracker.com/projects/27482]
+* {Mongoid Google Group}[http://groups.google.com/group/mongoid]
+* {Mongoid on CI Joe}[http://mongoid.org:4444/]
+* {Mongoid Website and Documentation}[http://mongoid.org]
+
+== Compatibility
+
+Mongoid is developed against Ruby 1.8.6, 1.8.7, 1.9.1, 1.9.2
+
+Note API changes will be frequent until 1.0, releases will be
+frequent, and backwards compatibility will not be supported. Do not
+expect the gem to be of full production quality until that
+point. However, once 1.0 is released I will be providing backwards
+compatibility through each minor version upgrade, as well as detailed
+release notes and documentation with each release.
+
+= Documentation
+
+Please see the new Mongoid website for up-to-date documentation:
+{mongoid.org}[http://mongoid.org]
+
+= License
+
+Copyright (c) 2009 Durran Jordan
+
+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.
+
+= Credits
+
+Durran Jordan: durran at gmail dot com

data/Rakefile

@@ -14,7 +14,7 @@ begin
 
     gem.add_dependency("activesupport", ">= 2.2.2")
     gem.add_dependency("mongo", ">= 0.18.2")
-    gem.add_dependency("durran-validatable", ">= 1.8.4")
+    gem.add_dependency("durran-validatable", ">= 2.0.0")
     gem.add_dependency("leshill-will_paginate", ">= 2.3.11")
 
     gem.add_development_dependency("rspec", ">= 1.2.9")

data/VERSION

@@ -1 +1 @@
-0.12.0
+1.0.0

data/lib/mongoid.rb

@@ -23,7 +23,7 @@ require "rubygems"
 
 gem "activesupport", ">= 2.2.2"
 gem "mongo", ">= 0.18.2"
-gem "durran-validatable", ">= 1.8.4"
+gem "durran-validatable", ">= 2.0.0"
 gem "leshill-will_paginate", ">= 2.3.11"
 
 require "delegate"
@@ -40,17 +40,21 @@ require "mongo"
 require "mongoid/associations"
 require "mongoid/associations/options"
 require "mongoid/attributes"
+require "mongoid/callbacks"
 require "mongoid/commands"
 require "mongoid/config"
 require "mongoid/complex_criterion"
 require "mongoid/criteria"
 require "mongoid/extensions"
 require "mongoid/errors"
-require "mongoid/field"
+require "mongoid/fields/field"
+require "mongoid/fields"
 require "mongoid/finders"
+require "mongoid/indexes"
 require "mongoid/memoization"
 require "mongoid/timestamps"
 require "mongoid/versioning"
+require "mongoid/components"
 require "mongoid/document"
 
 module Mongoid #:nodoc

data/lib/mongoid/associations.rb

@@ -50,11 +50,13 @@ module Mongoid # :nodoc:
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
+      #   class Person
+      #     include Mongoid::Document
       #     has_many :addresses
       #   end
       #
-      #   class Address < Mongoid::Document
+      #   class Address
+      #     include Mongoid::Document
       #     belongs_to :person, :inverse_of => :addresses
       #   end
       def belongs_to(name, options = {})
@@ -77,7 +79,8 @@ module Mongoid # :nodoc:
       #
       # Example:
       #
-      #   class Game < Mongoid::Document
+      #   class Game
+      #     include Mongoid::Document
       #     belongs_to_related :person
       #   end
       #
@@ -99,11 +102,13 @@ module Mongoid # :nodoc:
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
+      #   class Person
+      #     include Mongoid::Document
       #     has_many :addresses
       #   end
       #
-      #   class Address < Mongoid::Document
+      #   class Address
+      #     include Mongoid::Document
       #     belongs_to :person, :inverse_of => :addresses
       #   end
       def has_many(name, options = {})
@@ -122,7 +127,8 @@ module Mongoid # :nodoc:
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
+      #   class Person
+      #     include Mongoid::Document
       #     has_many_related :posts
       #   end
       #
@@ -146,11 +152,13 @@ module Mongoid # :nodoc:
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
+      #   class Person
+      #     include Mongoid::Document
       #     has_many :addresses
       #   end
       #
-      #   class Address < Mongoid::Document
+      #   class Address
+      #     include Mongoid::Document
       #     belongs_to :person
       #   end
       def has_one(name, options = {})
@@ -170,7 +178,8 @@ module Mongoid # :nodoc:
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
+      #   class Person
+      #     include Mongoid::Document
       #     has_one_related :game
       #   end
       def has_one_related(name, options = {})

data/lib/mongoid/attributes.rb

@@ -8,6 +8,27 @@ module Mongoid #:nodoc:
       end
     end
     module InstanceMethods
+      # Get the id associated with this object. This will pull the _id value out
+      # of the attributes +Hash+.
+      def id
+        @attributes[:_id]
+      end
+
+      # Set the id of the +Document+ to a new one.
+      def id=(new_id)
+        @attributes[:_id] = new_id
+      end
+
+      alias :_id :id
+      alias :_id= :id=
+
+      # Used for allowing accessor methods for dynamic attributes.
+      def method_missing(name, *args)
+        attr = name.to_s
+        return super unless @attributes.has_key?(attr.reader)
+        attr.writer? ? (@attributes[attr.reader] = *args) : @attributes[attr.reader]
+      end
+
       # Process the provided attributes casting them to their proper values if a
       # field exists for them on the +Document+. This will be limited to only the
       # attributes provided in the suppied +Hash+ so that no extra nil values get
@@ -17,7 +38,7 @@ module Mongoid #:nodoc:
           if Mongoid.allow_dynamic_fields && !respond_to?("#{key}=")
             @attributes[key] = value
           else
-            send("#{key}=", value) unless (value.is_a?(String) && value.blank?)
+            set_unless_blank(key, value)
           end
         end
       end
@@ -50,6 +71,18 @@ module Mongoid #:nodoc:
         @attributes.delete(name)
       end
 
+      # Returns the object type. This corresponds to the name of the class that
+      # this +Document+ is, which is used in determining the class to
+      # instantiate in various cases.
+      def _type
+        @attributes[:_type]
+      end
+
+      # Set the type of the +Document+. This should be the name of the class.
+      def _type=(new_type)
+        @attributes[:_type] = new_type
+      end
+
       # Write a single attribute to the +Document+ attribute +Hash+. This will
       # also fire the before and after update callbacks, and perform any
       # necessary typecasting.
@@ -102,6 +135,11 @@ module Mongoid #:nodoc:
           end
         end
       end
+
+      # Sets the attirbute value unless it is a blank string.
+      def set_unless_blank(name, value)
+        send("#{name}=", value) unless (value.is_a?(String) && value.blank?)
+      end
     end
 
     module ClassMethods
@@ -110,7 +148,8 @@ module Mongoid #:nodoc:
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
+      #   class Person
+      #     include Mongoid::Document
       #     has_one :name
       #     has_many :addresses
       #

data/lib/mongoid/callbacks.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Callbacks
+    def self.included(base)
+      base.class_eval do
+        include ActiveSupport::Callbacks
+
+        # Define all the callbacks that are accepted by the document.
+        define_callbacks \
+          :before_create,
+          :after_create,
+          :before_destroy,
+          :after_destroy,
+          :before_save,
+          :after_save,
+          :before_update,
+          :after_update,
+          :before_validation,
+          :after_validation
+      end
+    end
+  end
+end

data/lib/mongoid/components.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Components #:nodoc
+    def self.included(base)
+      base.class_eval do
+        # All modules that a +Document+ is composed of are defined in this
+        # module, to keep the document class from getting too cluttered.
+        include Associations
+        include Attributes
+        include Callbacks
+        include Commands
+        include Fields
+        include Indexes
+        include Memoization
+        include Observable
+        include Validatable
+        extend Finders
+      end
+    end
+  end
+end

data/lib/mongoid/criteria.rb

@@ -311,7 +311,8 @@ module Mongoid #:nodoc:
     #
     # Example:
     #
-    #   class Person < Mongoid::Document
+    #   class Person
+    #     include Mongoid::Document
     #     field :title
     #     field :terms, :type => Boolean, :default => false
     #

data/lib/mongoid/document.rb

@@ -3,49 +3,22 @@ module Mongoid #:nodoc:
   module Document
     def self.included(base)
       base.class_eval do
-        include ActiveSupport::Callbacks
-        include Associations, Attributes, Commands, Memoization, Observable, Validatable
+        include Components
         include InstanceMethods
-
         extend ClassMethods
-        extend Finders
-
-        # Set up the class attributes that must be available to all subclasses.
-        # These include defaults, fields
-        class_inheritable_accessor :defaults, :fields
 
-        # The same collection is used for the entire class hierarchy.
-        cattr_accessor :_collection, :collection_name, :embedded, :primary_key, :indexed
+        cattr_accessor :_collection, :collection_name, :embedded, :primary_key
 
-        # Set the initial values. Defaults and fields get set to a
-        # +HashWithIndifferentAccess+ while the collection name will get set to
-        # the demodulized class.
         self.collection_name = self.to_s.underscore.tableize.gsub("/", "_")
-        self.defaults = {}.with_indifferent_access
-        self.fields = {}.with_indifferent_access
-        self.indexed = false
 
         attr_accessor :association_name, :_parent
         attr_reader :attributes, :new_record
 
-        delegate :collection, :defaults, :embedded?, :fields, :primary_key, :to => "self.class"
-
-        # Define all the callbacks that are accepted by the document.
-        define_callbacks :before_create, :before_destroy, :before_save, :before_update, :before_validation
-        define_callbacks :after_create, :after_destroy, :after_save, :after_update, :after_validation
+        delegate :collection, :embedded?, :primary_key, :to => "self.class"
       end
     end
 
     module ClassMethods
-      # Add the default indexes to the root document if they do not already
-      # exist. Currently this is only _type.
-      def add_indexes
-        unless indexed
-          self._collection.create_index(:_type, false)
-          self.indexed = true
-        end
-      end
-
       # Returns the collection associated with this +Document+. If the
       # document is embedded, there will be no collection associated
       # with it.
@@ -57,40 +30,31 @@ module Mongoid #:nodoc:
         add_indexes; self._collection
       end
 
-      # return true if the +Document+ is embedded in another +Documnet+.
+      # return true if the +Document+ is embedded in another +Documnet+. The
+      # embedded flag is set by declaring a belongs_to association.
+      #
+      # Example:
+      #
+      # <tt>Address.embedded?</tt>
       def embedded?
         self.embedded == true
       end
 
-      # Defines all the fields that are accessable on the Document
-      # For each field that is defined, a getter and setter will be
-      # added as an instance method to the Document.
-      #
-      # Options:
-      #
-      # name: The name of the field, as a +Symbol+.
-      # options: A +Hash+ of options to supply to the +Field+.
+      # Returns a human readable version of the class.
       #
       # Example:
       #
-      # <tt>field :score, :default => 0</tt>
-      def field(name, options = {})
-        set_field(name, options)
-        set_default(name, options)
-      end
-
-      # Returns a human readable version of the class.
+      # <tt>MixedDrink.human_name # returns "Mixed Drink"</tt>
       def human_name
         name.underscore.humanize
       end
 
-      # Adds an index on the field specified. Options can be :unique => true or
-      # :unique => false. It will default to the latter.
-      def index(name, options = { :unique => false })
-        collection.create_index(name, options[:unique])
-      end
-
-      # Instantiate a new object, only when loaded from the database.
+      # Instantiate a new object, only when loaded from the database or when
+      # the attributes have already been typecast.
+      #
+      # Example:
+      #
+      # <tt>Person.instantiate(:title => "Sir", :age => 30)</tt>
       def instantiate(attrs = {}, allocating = false)
         attributes = attrs.with_indifferent_access
         if attributes[:_id] || allocating
@@ -105,14 +69,26 @@ module Mongoid #:nodoc:
       # Defines the field that will be used for the id of this +Document+. This
       # set the id of this +Document+ before save to a parameterized version of
       # the field that was supplied. This is good for use for readable URLS in
-      # web applications and *MUST* be defined on documents that are embedded
-      # in order for proper updates in has_may associations.
+      # web applications.
+      #
+      # Example:
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     field :first_name
+      #     field :last_name
+      #     key :first_name, :last_name
+      #   end
       def key(*fields)
         self.primary_key = fields
         before_save :generate_key
       end
 
       # Macro for setting the collection name to store in.
+      #
+      # Example:
+      #
+      # <tt>Person.store_in :populdation</tt>
       def store_in(name)
         self.collection_name = name.to_s
         self._collection = Mongoid.database.collection(name.to_s)
@@ -123,28 +99,6 @@ module Mongoid #:nodoc:
         @_type ||= (self.subclasses + [ self.name ])
       end
 
-      protected
-
-      # Define a field attribute for the +Document+.
-      def set_field(name, options = {})
-        meth = options.delete(:as) || name
-        fields[name] = Field.new(name.to_s, options)
-        create_accessors(name, meth, options)
-      end
-
-      # Create the field accessors.
-      def create_accessors(name, meth, options = {})
-        define_method(meth) { read_attribute(name) }
-        define_method("#{meth}=") { |value| write_attribute(name, value) }
-        define_method("#{meth}?") { read_attribute(name) == true } if options[:type] == Boolean
-      end
-
-      # Set up a default value for a field.
-      def set_default(name, options = {})
-        value = options[:default]
-        defaults[name] = value if value
-      end
-
     end
 
     module InstanceMethods
@@ -180,20 +134,6 @@ module Mongoid #:nodoc:
         self.class.instantiate(@attributes.except(:_id).except(:versions).dup, true)
       end
 
-      # Get the id associated with this object. This will pull the _id value out
-      # of the attributes +Hash+.
-      def id
-        @attributes[:_id]
-      end
-
-      # Set the id
-      def id=(new_id)
-        @attributes[:_id] = new_id
-      end
-
-      alias :_id :id
-      alias :_id= :id=
-
       # Instantiate a new +Document+, setting the Document's attributes if
       # given. If no attributes are provided, they will be initialized with
       # an empty +Hash+.
@@ -271,8 +211,7 @@ module Mongoid #:nodoc:
       # memoized association and notify the parent of the change.
       def remove(child)
         name = child.association_name
-        @attributes.remove(name, child.attributes)
-        remove_instance_variable("@#{name}")
+        reset(name) { @attributes.remove(name, child.attributes) }
         notify
       end
 
@@ -294,16 +233,6 @@ module Mongoid #:nodoc:
         id
       end
 
-      # Returns the object type.
-      def _type
-        @attributes[:_type]
-      end
-
-      # Set the type.
-      def _type=(new_type)
-        @attributes[:_type] = new_type
-      end
-
       # Observe a notify call from a child +Document+. This will either update
       # existing attributes on the +Document+ or clear them out for the child if
       # the clear boolean is provided.
@@ -325,15 +254,6 @@ module Mongoid #:nodoc:
         notify
       end
 
-      # Needs to run the appropriate callbacks the delegate up to the validatable
-      # gem.
-      def valid?
-        run_callbacks(:before_validation)
-        result = super
-        run_callbacks(:after_validation)
-        result
-      end
-
       protected
       def generate_key
         if primary_key