mongo_mapper 0.7.6 → 0.8.0

data/README.rdoc

@@ -2,8 +2,6 @@
 
 A Ruby Object Mapper for 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.
@@ -18,14 +16,12 @@ Releases are tagged on github and released on gemcutter. Master is pushed to whe
 
 == Problems or Questions?
 
-Hit up the google group.
+Hit up the google group:
 http://groups.google.com/group/mongomapper
 
-To see if the problem you are having is a verified issue, you can see the MM pivotal tracker project:
-http://www.pivotaltracker.com/projects/33576
-
-There is no need to request to join the Pivotal Tracker project as I am only granting access to a select few (easier to keep things organized). If you have a problem, please use the mailing list. If I confirm it to be a bug, I am happy to add it to PT. Thanks!
+Hop on IRC:
+irc://chat.freenode.net/#mongomapper
 
 == Copyright
 
-Copyright (c) 2009 John Nunemaker. See LICENSE for details.
+See LICENSE for details.

data/bin/mmconsole

@@ -18,7 +18,7 @@ irb.context.evaluate("require 'irb/completion'", 0)
 irb.context.evaluate(%@
 include MongoMapper
 
-MongoMapper.database = "mmtest"
+MongoMapper.database = "mm-test"
 $db = MongoMapper.database
 
 @, 0)

data/examples/keys.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+
+  key :first_name,  String, :required => true
+  key :last_name,   String, :required => true
+  key :token,       String, :default => lambda { 'some random string' }
+  key :age,         Integer
+  key :skills,      Array
+  key :friend_ids,  Array, :typecast => 'ObjectId'
+  timestamps!
+end
+User.collection.remove # empties collection
+
+john = User.create({
+  :first_name => 'John',
+  :last_name  => 'Nunemaker',
+  :age        => 28,
+  :skills     => ['ruby', 'mongo', 'javascript'],
+}) 
+
+steve = User.create({
+  :first_name => 'Steve',
+  :last_name  => 'Smith',
+  :age        => 29,
+  :skills     => ['html', 'css', 'javascript', 'design'],
+})
+
+john.friend_ids << steve.id.to_s # will get typecast to ObjectId
+john.save
+
+pp john

data/examples/plugins.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+# To create your own plugin, just create a module.
+module FooPlugin
+  
+  # ClassMethods module will automatically get extended
+  module ClassMethods
+    def foo
+      'Foo class method!'
+    end
+  end
+
+  # InstanceMethods module will automatically get included
+  module InstanceMethods
+    def foo
+      'Foo instance method!'
+    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
+  end
+
+end
+
+class User
+  include MongoMapper::Document
+  plugin FooPlugin
+end
+
+puts User.foo
+puts User.new.foo
+puts User.key?(:foo)

data/examples/querying.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+  
+  key :name, String
+  key :tags, Array
+end
+User.collection.remove # empties collection
+
+User.create(:name => 'John',  :tags => %w[ruby mongo], :age => 28)
+User.create(:name => 'Bill',  :tags => %w[ruby mongo], :age => 30)
+User.create(:name => 'Frank', :tags => %w[mongo],      :age => 35)
+User.create(:name => 'Steve', :tags => %w[html5 css3], :age => 27)
+
+[
+
+  User.all(:name => 'John'),
+  User.all(:tags => %w[mongo]),
+  User.all(:tags.all => %w[ruby mongo]),
+  User.all(:age.gte => 30),
+
+  User.where(:age.gt => 27).sort(:age).all,
+  User.where(:age.gt => 27).sort(:age.desc).all,
+  User.where(:age.gt => 27).sort(:age).limit(1).all,
+  User.where(:age.gt => 27).sort(:age).skip(1).limit(1).all,
+
+].each do |result|
+  pp result
+  puts
+end

data/examples/scopes.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+
+  # plain old vanilla scopes with fancy queries
+  scope :johns,   where(:name => 'John')
+
+  # plain old vanilla scopes with hashes
+  scope :bills, :name => 'Bill'
+
+  # dynamic scopes with parameters
+  scope :by_name,  lambda { |name| where(:name => name) }
+  scope :by_ages,  lambda { |low, high| where(:age.gte => low, :age.lte => high) }
+
+  # Yep, even plain old methods work as long as they return a query
+  def self.by_tag(tag)
+    where(:tags => tag)
+  end
+
+  # You can even make a method that returns a scope
+  def self.twenties; by_ages(20, 29) end
+
+  key :name, String
+  key :tags, Array
+end
+User.collection.remove # empties collection
+
+User.create(:name => 'John',  :tags => %w[ruby mongo], :age => 28)
+User.create(:name => 'Bill',  :tags => %w[ruby mongo], :age => 30)
+User.create(:name => 'Frank', :tags => %w[mongo],      :age => 35)
+User.create(:name => 'Steve', :tags => %w[html5 css3], :age => 27)
+
+# simple scopes
+pp User.johns.first
+pp User.bills.first
+
+# scope with arg
+pp User.by_name('Frank').first
+
+# scope with two args
+pp User.by_ages(20, 29).all
+
+# chaining class methods on scopes
+pp User.by_ages(20, 40).by_tag('ruby').all
+
+# scope made using method that returns scope
+pp User.twenties.all

data/lib/mongo_mapper.rb

@@ -1,114 +1,94 @@
+# encoding: UTF-8
 # Make sure you have the correct versions of the gems (see gemspec) in your load path.
-require 'set'
-require 'uri'
-require 'mongo'
 require 'plucky'
 require 'validatable'
 require 'active_support/all'
 
 module MongoMapper
-  # generic MM error
-  class MongoMapperError < StandardError; end
-
-  # raised when key expected to exist but not found
-  class KeyNotFound < MongoMapperError; end
-
-  # raised when document expected but not found
-  class DocumentNotFound < MongoMapperError; end
-
-  # raised when trying to connect using uri with incorrect scheme
-  class InvalidScheme < MongoMapperError; end
-
-  # raised when document not valid and using !
-  class DocumentNotValid < MongoMapperError
-    def initialize(document)
-      super("Validation failed: #{document.errors.full_messages.join(", ")}")
+  autoload :Connection,             'mongo_mapper/connection'
+
+  autoload :Error,                  'mongo_mapper/exceptions'
+  autoload :KeyNotFound,            'mongo_mapper/exceptions'
+  autoload :DocumentNotFound,       'mongo_mapper/exceptions'
+  autoload :InvalidScheme,          'mongo_mapper/exceptions'
+  autoload :DocumentNotValid,       'mongo_mapper/exceptions'
+  autoload :AccessibleOrProtected,  'mongo_mapper/exceptions'
+
+  autoload :Document,               'mongo_mapper/document'
+  autoload :EmbeddedDocument,       'mongo_mapper/embedded_document'
+  autoload :Plugins,                'mongo_mapper/plugins'
+  autoload :Version,                'mongo_mapper/version'
+
+  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'
+
+    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 :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'
+      autoload :ManyPolymorphicProxy,         'mongo_mapper/plugins/associations/many_polymorphic_proxy'
+      autoload :ManyEmbeddedProxy,            'mongo_mapper/plugins/associations/many_embedded_proxy'
+      autoload :ManyEmbeddedPolymorphicProxy, 'mongo_mapper/plugins/associations/many_embedded_polymorphic_proxy'
+      autoload :ManyDocumentsAsProxy,         'mongo_mapper/plugins/associations/many_documents_as_proxy'
+      autoload :OneProxy,                     'mongo_mapper/plugins/associations/one_proxy'
+      autoload :OneEmbeddedProxy,             'mongo_mapper/plugins/associations/one_embedded_proxy'
+      autoload :InArrayProxy,                 'mongo_mapper/plugins/associations/in_array_proxy'
     end
-  end
-
-  # @api public
-  def self.connection
-    @@connection ||= Mongo::Connection.new
-  end
 
-  # @api public
-  def self.connection=(new_connection)
-    @@connection = new_connection
-  end
-
-  # @api public
-  def self.logger
-    connection.logger
-  end
-
-  # @api public
-  def self.database=(name)
-    @@database = nil
-    @@database_name = name
-  end
-
-  # @api public
-  def self.database
-    if @@database_name.blank?
-      raise 'You forgot to set the default database name: MongoMapper.database = "foobar"'
+    module DynamicQuerying
+      autoload :DynamicFinder, 'mongo_mapper/plugins/dynamic_querying/dynamic_finder'
     end
 
-    @@database ||= MongoMapper.connection.db(@@database_name)
-  end
-
-  def self.config=(hash)
-    @@config = hash
-  end
-
-  def self.config
-    raise 'Set config before connecting. MongoMapper.config = {...}' unless defined?(@@config)
-    @@config
-  end
-
-  # @api private
-  def self.config_for_environment(environment)
-    env = config[environment]
-    return env if env['uri'].blank?
-
-    uri = URI.parse(env['uri'])
-    raise InvalidScheme.new('must be mongodb') unless uri.scheme == 'mongodb'
-    {
-      'host'     => uri.host,
-      'port'     => uri.port,
-      'database' => uri.path.gsub(/^\//, ''),
-      'username' => uri.user,
-      'password' => uri.password,
-    }
-  end
-
-  def self.connect(environment, options={})
-    raise 'Set config before connecting. MongoMapper.config = {...}' if config.blank?
-    env = config_for_environment(environment)
-    MongoMapper.connection = Mongo::Connection.new(env['host'], env['port'], options)
-    MongoMapper.database = env['database']
-    MongoMapper.database.authenticate(env['username'], env['password']) if env['username'] && env['password']
+    module Keys
+      autoload :Key, 'mongo_mapper/plugins/keys/key'
+    end
+    
+    module Querying
+      autoload :Decorator, 'mongo_mapper/plugins/querying/decorator'
+    end
   end
 
-  def self.setup(config, environment, options={})
-    using_passenger = options.delete(:passenger)
-    handle_passenger_forking if using_passenger
-    self.config = config
-    connect(environment, options)
+  module Support
+    autoload :DescendantAppends, 'mongo_mapper/support/descendant_appends'
   end
 
-  def self.handle_passenger_forking
-    if defined?(PhusionPassenger)
-      PhusionPassenger.on_event(:starting_worker_process) do |forked|
-        connection.connect_to_master if forked
-      end
-    end
-  end
+  extend Connection
+end
 
-  autoload :Query,            'mongo_mapper/query'
-  autoload :Document,         'mongo_mapper/document'
-  autoload :EmbeddedDocument, 'mongo_mapper/embedded_document'
-  autoload :Version,          'mongo_mapper/version'
+Dir[File.join(File.dirname(__FILE__), 'mongo_mapper', 'extensions', '*.rb')].each do |extension|
+  require extension
 end
 
-require 'mongo_mapper/support'
-require 'mongo_mapper/plugins'
+# FIXME: autoload with proxy is failing, need to investigate
+require 'mongo_mapper/plugins/associations/proxy'

data/lib/mongo_mapper/connection.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+require 'uri'
+
+module MongoMapper
+  module Connection
+    # @api public
+    def connection
+      @@connection ||= Mongo::Connection.new
+    end
+
+    # @api public
+    def connection=(new_connection)
+      @@connection = new_connection
+    end
+
+    # @api public
+    def logger
+      connection.logger
+    end
+
+    # @api public
+    def database=(name)
+      @@database = nil
+      @@database_name = name
+    end
+
+    # @api public
+    def database
+      if @@database_name.blank?
+        raise 'You forgot to set the default database name: MongoMapper.database = "foobar"'
+      end
+
+      @@database ||= MongoMapper.connection.db(@@database_name)
+    end
+
+    def config=(hash)
+      @@config = hash
+    end
+
+    def config
+      raise 'Set config before connecting. MongoMapper.config = {...}' unless defined?(@@config)
+      @@config
+    end
+
+    # @api private
+    def config_for_environment(environment)
+      env = config[environment]
+      return env if env['uri'].blank?
+
+      uri = URI.parse(env['uri'])
+      raise InvalidScheme.new('must be mongodb') unless uri.scheme == 'mongodb'
+      {
+        'host'     => uri.host,
+        'port'     => uri.port,
+        'database' => uri.path.gsub(/^\//, ''),
+        'username' => uri.user,
+        'password' => uri.password,
+      }
+    end
+
+    def connect(environment, options={})
+      raise 'Set config before connecting. MongoMapper.config = {...}' if config.blank?
+      env = config_for_environment(environment)
+      MongoMapper.connection = Mongo::Connection.new(env['host'], env['port'], options)
+      MongoMapper.database = env['database']
+      MongoMapper.database.authenticate(env['username'], env['password']) if env['username'] && env['password']
+    end
+
+    def setup(config, environment, options={})
+      handle_passenger_forking
+      self.config = config
+      connect(environment, options)
+    end
+
+    def handle_passenger_forking
+      if defined?(PhusionPassenger)
+        PhusionPassenger.on_event(:starting_worker_process) do |forked|
+          connection.connect_to_master if forked
+        end
+      end
+    end
+  end
+end