mongo_odm 0.2.15 → 0.2.16

data/README.rdoc

@@ -161,9 +161,11 @@ To embed just one copy of another class, just define the field type of that clas
     field :name
     field :rgb, RGB
     
-    create_index :name, :unique => true
+    index :name, :unique => true
   end
   
+  Color.create_indexes
+  
   color = Color.new(:name => "red", :rgb => RGB.new(255,0,0))
   color.save
   

data/lib/mongo_odm/document.rb

@@ -10,6 +10,7 @@ module MongoODM
     autoload :AttributeMethods
     autoload :Callbacks
     autoload :Fields
+    autoload :Indexes
     autoload :Inspect
     autoload :Persistence
     autoload :Timestamps
@@ -27,6 +28,7 @@ module MongoODM
       include Document::Persistence
       include Document::AttributeMethods
       include Document::Fields
+      include Document::Indexes
       include Document::Inspect
       include Document::Callbacks
       include Document::Validations

data/lib/mongo_odm/document/indexes.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module MongoODM
+  module Document
+    module Indexes
+
+      extend ActiveSupport::Concern
+
+      class Index
+        attr_reader :spec
+        attr_reader :opts
+
+        # Creates a new document index.
+        # @param [String, Array] spec should be either a single field name or an array of field name, direction pairs. Directions should be specified as Mongo::ASCENDING, Mongo::DESCENDING, or Mongo::GEO2D.
+        #
+        # Note that geospatial indexing only works with versions of MongoDB >= 1.3.3+. Keep in mind, too, that in order to geo-index a given field, that field must reference either an array or a sub-object where the first two values represent x- and y-coordinates. Examples can be seen below.
+        #
+        # Also note that it is permissible to create compound indexes that include a geospatial index as long as the geospatial index comes first.
+        #
+        # If your code calls create_index frequently, you can use Collection#ensure_index to cache these calls and thereby prevent excessive round trips to the database.
+        # @option opts [Hash] :default ({}) a customizable set of options
+        def initialize(spec, opts = {})
+          @spec = spec
+          @opts = opts
+        end
+      end
+
+      module ClassMethods
+        def inherited(subclass)
+          super
+          indexes.concat(subclass.indexes)
+        end
+
+        def indexes
+          @indexes ||= []
+        end
+
+        def index(spec, opts = {})
+          new_index = Index.new(spec, opts)
+          indexes << new_index
+          new_index
+        end
+        
+        def create_indexes
+          indexes.each {|index| create_index index.spec, index.opts }
+        end
+      end
+
+    end
+  end
+end

data/lib/mongo_odm/version.rb

@@ -2,6 +2,6 @@
 module MongoODM
   VERSION_MAJOR = "0"
   VERSION_MINOR = "2"
-  VERSION_BUILD = "15"
+  VERSION_BUILD = "16"
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_BUILD}"
 end

metadata

@@ -2,7 +2,7 @@
 name: mongo_odm
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.15
+  version: 0.2.16
 platform: ruby
 authors: 
 - Carlos Paramio
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 +01:00
+date: 2011-03-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -267,6 +267,7 @@ files:
 - lib/mongo_odm/document/callbacks.rb
 - lib/mongo_odm/document/equality.rb
 - lib/mongo_odm/document/fields.rb
+- lib/mongo_odm/document/indexes.rb
 - lib/mongo_odm/document/inspect.rb
 - lib/mongo_odm/document/persistence.rb
 - lib/mongo_odm/document/timestamps.rb