ssherman-mongo_mapper 0.8.6

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,33 @@
+= MongoMapper
+
+A Ruby Object Mapper for Mongo.
+
+== Install
+
+    $ gem install mongo_mapper
+
+== 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.
+
+== Development
+
+    $ gem install bundler (if you don't have it)
+    $ bundle install
+    $ bundle exec rake
+
+== 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/UPGRADES

@@ -0,0 +1,7 @@
+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)
+  * Removed undefining of object_id in proxies and equal? method in Equality. This means checking equal? for a proxy and a regular document will always be false even if proxy refers to same document. Check Proxy#target instead. (ie: root.equal?(item.root.target))
+  * find no longer takes options as a last argument. It only works with id, multiple ids, array of ids.
+  * MongoMapper::MongoMapperError is now MongoMapper::Error
+  * metaclass, meta_eval, meta_def, class_def removed as they were not being used

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/attr_accessible.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+  key :email, String
+  key :admin, Boolean, :default => false
+
+  # Only accessible or protected can be used, they cannot be used together
+  attr_accessible :email
+end
+
+# only accessible are set on new/create/etc.
+user = User.create(:email => 'IDontLowerCaseThings@gmail.com', :admin => true)
+puts user.admin # false
+
+# can be set using accessor
+user.admin = true
+user.save
+puts user.admin # true

data/examples/attr_protected.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+  key :email, String
+  key :admin, Boolean, :default => false
+
+  # Only accessible or protected can be used, they cannot be used together
+  attr_protected :admin
+end
+
+# protected are ignored on new/create/etc.
+user = User.create(:email => 'IDontLowerCaseThings@gmail.com', :admin => true)
+puts user.admin # false
+
+# can be set using accessor
+user.admin = true
+user.save
+puts user.admin # true

data/examples/cache_key.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+end
+
+# New Documents
+puts User.new.cache_key     # User/new
+
+# Created Documents
+puts User.create.cache_key  # User/:id (ie: User/4c7a940cbcd1b3319b000003)
+
+# With Suffix
+puts User.create.cache_key(:foo) # User/:id/foo
+
+# With Multiple Suffixes
+puts User.create.cache_key(:foo, :bar, :baz) # User/:id/foo/bar/baz
+
+# When updated_at key exists it will be used
+User.timestamps!
+puts User.create.cache_key  # User/:id-:updated_at (ie: User/4c7a940cbcd1b3319b000003-20100829170828)

data/examples/custom_types.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class DowncasedString
+  # to_mongo gets called anytime a value is assigned
+  def self.to_mongo(value)
+    value.nil? ? nil : value.to_s.downcase
+  end
+
+  # from mongo gets called anytime a value is read
+  def self.from_mongo(value)
+    value.nil? ? nil : value.to_s.downcase
+  end
+end
+
+class User
+  include MongoMapper::Document
+  key :email, DowncasedString
+end
+
+pp User.create(:email => 'IDontLowerCaseThings@gmail.com')

data/examples/identity_map.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'mongo_mapper'
+require 'pp'
+
+MongoMapper.database = 'testing'
+
+class User
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::IdentityMap
+
+  key :name, String
+end
+User.delete_all
+
+user = User.create(:name => 'John')
+
+# User gets added to map on save
+pp User.identity_map[user.id]
+
+# Does not matter how you find user, it is always the same object until the identity map is cleared
+puts "#{User.identity_map[user.id].object_id} == #{user.object_id}"
+puts "#{User.find(user.id).object_id} == #{user.object_id}"
+puts "#{User.all[0].object_id} == #{user.object_id}"
+
+MongoMapper::Plugins::IdentityMap.clear
+puts "#{User.find(user.id).object_id} != #{user.object_id}"
+
+# User gets removed from map on destroy
+user = User.create
+user.destroy
+puts "Should be nil: " + User.identity_map[user.id].inspect
+
+

data/examples/identity_map/automatic.rb

@@ -0,0 +1,8 @@
+# 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)

data/examples/identity_map/middleware.rb

@@ -0,0 +1,14 @@
+# To use this, add the following line in environment.rb
+# config.middleware.use 'PerRequestIdentityMap'
+class PerRequestIdentityMap
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    MongoMapper::Plugins::IdentityMap.clear
+    @app.call(env)
+  ensure
+    MongoMapper::Plugins::IdentityMap.clear
+  end
+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/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