mongomatic 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Myles
+
+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,49 @@
+= Mongomatic
+
+Mongomatic allows you to map your Ruby objects to Mongo documents. It is designed to be fast and simple.
+
+== Usage
+
+  require 'mongomatic'
+  
+  class User < Mongomatic::Base
+    validates_presence_of :name, :email
+  end
+  
+  # set the db settings for all models:
+  Mongomatic.settings = { :connection => ["localhost", 27017, {}], :db => "mongomatic_test" }
+  # or you can set it for a specific model:
+  User.settings = { :connection => ["localhost", 27017, {}], :db => "mongomatic_test_user" }
+
+  u = User.new(:name => "Ben")
+  => #<User:0x00000100d0cbf8 @doc={"name"=>"Ben"}, @removed=false> 
+  u.valid?
+  => false
+  u["email"] = "me@somewhere.com"
+  u.valid?
+  => true
+  u.insert
+  => BSON::ObjectID('4c32834f0218236321000001')
+  u
+  => #<User:0x00000100d0cbf8 @doc={"name"=>"Ben", "email"=>"me@somewhere.com", "_id"=>BSON::ObjectID('4c32834f0218236321000001')}, @removed=false, @validation_context=nil, @errors={}, @_initialized_validate_callbacks=true>
+  
+  cursor = User.find({"name" => "Ben"})
+  => #<Mongomatic::Cursor:0x00000100acd3d8 @obj_class=User, @mongo_cursor=DBResponse(flags=, cursor_id=, start=)> 
+  cursor.count
+  => 1 
+  cursor.next
+  => #<User:0x00000100a61e08 @doc={"_id"=>BSON::ObjectID('4c32834f0218236321000001'), "name"=>"Ben", "email"=>"me@somewhere.com"}, @removed=false>
+
+== 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 I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ben Myles. See LICENSE for details.

data/lib/mongomatic/base.rb

@@ -0,0 +1,123 @@
+module Mongomatic
+  class Base
+    include ActiveModel::Validations
+    include Mongomatic::Modifiers
+    
+    class << self
+      def settings
+        @settings || Mongomatic.settings
+      end
+
+      def settings=(hash)
+        @settings = hash
+        reconnect!; hash
+      end
+      
+      def reconnect!
+        @db = @collection = nil; true
+      end
+      
+      def db
+        @db ||= Mongo::Connection.new(*self.settings[:connection]).db(self.settings[:db])
+      end
+
+      def collection_name
+        self.to_s
+      end
+
+      def collection
+        @collection ||= self.db.collection(self.collection_name)
+      end
+
+      def find(query={})
+        Mongomatic::Cursor.new(self, collection.find(query))
+      end
+      
+      def all
+        find
+      end
+      
+      def each
+        find.each { |found| yield(found) }
+      end
+      
+      def first
+        find.limit(1).next_document
+      end
+      
+      def count
+        find.count
+      end
+    end
+
+    attr_accessor :removed
+
+    def initialize(doc={})
+      @doc = doc.stringify_keys
+      self.removed = false
+    end
+    
+    def []=(k,v)
+      @doc[k.to_s] = v
+    end
+    
+    def [](k)
+      @doc[k.to_s]
+    end
+    
+    def removed?
+      self.removed == true
+    end
+    
+    def ==(obj)
+      obj.is_a?(self.class) && obj.doc["_id"] == @doc["_id"]
+    end
+    
+    def new?
+      @doc["_id"] == nil
+    end
+
+    def reload
+      if obj = self.class.find({"_id" => @doc["_id"]}).next_document
+        @doc = obj.doc; true
+      end
+    end
+
+    def insert(opts={})
+      return false unless new? && valid?
+      if ret = self.class.collection.insert(@doc,opts)
+        @doc["_id"] = @doc.delete(:_id); ret
+      end
+    end
+    
+    def update(opts={},update_doc=@doc)
+      return false if new? || removed? || !valid?
+      self.class.collection.update({"_id" => @doc["_id"]}, update_doc, opts)
+    end
+    
+    def remove(opts={})
+      return false if new?
+      if ret = self.class.collection.remove({"_id" => @doc["_id"]})
+        self.removed = true; freeze; ret
+      end
+    end
+    
+    def to_hash
+      @doc || {}
+    end
+    
+    protected
+    
+    def read_attribute_for_validation(key)
+      @doc[key.to_s]
+    end
+    
+    def doc
+      @doc
+    end
+    
+    def doc=(v)
+      @doc = v
+    end
+  end
+end

data/lib/mongomatic/cursor.rb

@@ -0,0 +1,37 @@
+module Mongomatic
+  class Cursor
+    attr_accessor :mongo_cursor
+    
+    def initialize(obj_class, mongo_cursor)
+      @obj_class    = obj_class
+      @mongo_cursor = mongo_cursor
+      
+      @mongo_cursor.public_methods(false).each do |meth|
+        next if ["next_document","each","to_a"].include?(meth.to_s)
+        (class << self; self; end).class_eval do
+          define_method meth do |*args|
+            @mongo_cursor.send meth, *args
+          end
+        end
+      end
+    end
+    
+    def next_document
+      if doc = @mongo_cursor.next_document
+        @obj_class.new(doc)
+      end
+    end
+    
+    alias :next :next_document
+    
+    def each
+      @mongo_cursor.each do |doc|
+        yield(@obj_class.new(doc))
+      end
+    end
+    
+    def to_a
+      @mongo_cursor.to_a.collect { |doc| @obj_class.new(doc) }
+    end
+  end
+end

data/lib/mongomatic/modifiers.rb

@@ -0,0 +1,105 @@
+module Mongomatic
+  module Modifiers
+
+    # { $push : { field : value } }
+    # appends value to field, if field is an existing array, otherwise sets field to the array [value] 
+    # if field is not present. If field is present but is not an array, an error condition is raised.
+    def push(field, val, do_reload=true)
+      field = field.to_s
+      if update({}, { "$push" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $pushAll : { field : value_array } }
+    # appends each value in value_array to field, if field is an existing array, otherwise sets field to 
+    # the array value_array if field is not present. If field is present but is not an array, an error 
+    # condition is raised.
+    def push_all(field, val, do_reload=true)
+      field = field.to_s
+      val = Array(val)
+      if update({}, { "$pushAll" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $pull : { field : _value } }
+    # removes all occurrences of value from field, if field is an array. If field is present but is not 
+    # an array, an error condition is raised.
+    def pull(field, val, do_reload=true)
+      field = field.to_s
+      if update({}, { "$pull" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $pullAll : { field : value_array } }
+    # removes all occurrences of each value in value_array from field, if field is an array. If field is 
+    # present but is not an array, an error condition is raised.
+    def pullAll(field, val, do_reload=true)
+      field = field.to_s
+      if update({}, { "$pullAll" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $inc : { field : value } }
+    # increments field by the number value if field is present in the object, otherwise sets field to the number value.
+    def inc(field, val, do_reload=true)
+      field = field.to_s
+      if update({}, { "$inc" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $set : { field : value } }
+    # sets field to value. All datatypes are supported with $set.
+    def set(field, val, do_reload=true)
+      field = field.to_s
+      if update({}, { "$set" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+
+    # { $unset : { field : 1} }
+    # Deletes a given field. v1.3+
+    def unset(field, do_reload=true)
+      field = field.to_s
+      if update({}, { "$unset" => { field => 1 } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $addToSet : { field : value } }
+    # Adds value to the array only if its not in the array already.
+    # 
+    # To add many valuest.update
+    # 
+    # { $addToSet : { a : { $each : [ 3 , 5 , 6 ] } } }
+    def add_to_set(field, val, do_reload=true)
+      field = field.to_s
+      if update({}, { "$addToSet" => { field => val } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $pop : { field : 1  } }
+    # removes the last element in an array (ADDED in 1.1)
+    def pop_last(field, do_reload=true)
+      field = field.to_s
+      if update({}, { "$pop" => { field => 1 } })
+        reload if do_reload; true
+      end
+    end
+    
+    # { $pop : { field : -1  } }
+    # removes the first element in an array (ADDED in 1.1)
+    def pop_first(field, do_reload=true)
+      field = field.to_s
+      if update({}, { "$pop" => { field => -1 } })
+        reload if do_reload; true
+      end
+    end
+    
+  end
+end

data/lib/mongomatic.rb

@@ -0,0 +1,26 @@
+gem "bson", "= 1.0.3"
+gem "bson_ext", "= 1.0.1"
+gem "mongo", "= 1.0.3"
+gem "activemodel", ">= 3.0.0.beta4"
+
+require "bson"
+require "mongo"
+require "active_model"
+
+module Mongomatic
+  class << self
+    def settings
+      @settings || { :connection => ["localhost", 27017, {}], :db => "main" }
+    end
+
+    def settings=(hash)
+      @settings = hash
+      @db = @collection = nil
+      hash
+    end
+  end
+end
+
+require "#{File.dirname(__FILE__)}/mongomatic/cursor"
+require "#{File.dirname(__FILE__)}/mongomatic/modifiers"
+require "#{File.dirname(__FILE__)}/mongomatic/base"

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'pp'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mongomatic'
+
+Mongomatic.settings = { :connection => ["localhost", 27017, {}], :db => "mongomatic_test" }
+
+class Person < Mongomatic::Base
+  validates_presence_of :name
+end
+
+class Test::Unit::TestCase
+end

data/test/test_meta_mongo.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class TestMongomatic < Test::Unit::TestCase
+  should "be able to insert, update, remove documents" do
+    Person.collection.remove
+    
+    p = Person.new
+    
+    assert !p.valid?
+    assert_equal({:name=>["can't be blank"]}, p.errors)
+    
+    p["name"] = "Ben Myles"
+    p["birth_year"] = 1984
+    p["created_at"] = Time.now.utc
+    p["admin"] = true
+    
+    assert !p.update
+    
+    assert p.insert.is_a?(BSON::ObjectID)
+    
+    assert_equal 1, Person.collection.count
+
+    cursor = Person.find({"_id" => p["_id"]})
+    found  = cursor.next
+    assert_equal p, found
+    assert_equal "Ben Myles", found["name"]
+    
+    p["name"] = "Benjamin"
+    assert p.update
+    
+    cursor = Person.find({"_id" => p["_id"]})
+    found  = cursor.next
+    assert_equal p, found
+    assert_equal "Benjamin", found["name"]
+    
+    assert p.remove
+    assert p.removed?
+    cursor = Person.find({"_id" => p["_id"]})
+    found  = cursor.next
+    assert_nil found
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: mongomatic
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Myles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 1
+        version: 2.11.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id005
+description: Mongomatic is a simple Ruby object mapper for Mongo
+email: ben.myles@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/mongomatic.rb
+- lib/mongomatic/base.rb
+- lib/mongomatic/cursor.rb
+- lib/mongomatic/modifiers.rb
+- LICENSE
+- README.rdoc
+- test/helper.rb
+- test/test_meta_mongo.rb
+has_rdoc: true
+homepage: http://github.com/benmyles/mongomatic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mongomatic is a simple Ruby object mapper for Mongo
+test_files: 
+- test/helper.rb
+- test/test_meta_mongo.rb