thorsson-mongo_mapper 0.8.2

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,27 @@
+= MongoMapper
+
+A Ruby Object Mapper for Mongo.
+
+== 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
+
+ $ gem install mongo_mapper
+
+== Problems or Questions?
+
+Hit up the google group:
+http://groups.google.com/group/mongomapper
+
+Hop on IRC:
+irc://chat.freenode.net/#mongomapper
+
+== Copyright
+
+See LICENSE for details.

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 = "mm-test"
+$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/examples/keys.rb

@@ -0,0 +1,40 @@
+$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'
+  key :links,       Hash
+  timestamps!
+end
+User.collection.remove # empties collection
+
+john = User.create({
+  :first_name => 'John',
+  :last_name  => 'Nunemaker',
+  :age        => 28,
+  :skills     => ['ruby', 'mongo', 'javascript'],
+  :links      => {"Google" => "http://www.google.com"}
+}) 
+
+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.links["Ruby on Rails"] = "http://www.rubyonrails.com"
+john.save
+
+pp john

data/examples/modifiers/set.rb

@@ -0,0 +1,25 @@
+$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
+
+john = User.create(:name => 'John',  :tags => %w[ruby mongo], :age => 28)
+bill = User.create(:name => 'Bill',  :tags => %w[ruby mongo], :age => 30)
+
+User.set({:name => 'John'}, :tags => %[ruby])
+pp john.reload
+
+User.set(john.id, :tags => %w[ruby mongo])
+pp john.reload
+
+john.set(:tags => %w[something different])
+pp john.reload

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

@@ -0,0 +1,79 @@
+# 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'
+
+module MongoMapper
+  autoload :Connection,             'mongo_mapper/connection'
+
+  autoload :Error,                  '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
+
+  extend Connection
+end
+
+Dir[File.join(File.dirname(__FILE__), 'mongo_mapper', 'extensions', '*.rb')].each do |extension|
+  require extension
+end
+
+require 'mongo_mapper/support/descendant_appends'
+
+# 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