mongomatic 0.1.3 → 0.1.4

data/README.rdoc

@@ -2,12 +2,23 @@
 
 Mongomatic allows you to map your Ruby objects to Mongo documents. It is designed to be fast and simple.
 
+== What's different about Mongomatic?
+
+* Follows Mongo idioms wherever possible.
+* Only strives to do "just enough" and never too much.
+* When possible, we defer to Mongo. For example, there's no Mongomatic query API, instead you use the same query hash syntax you would with the Ruby Mongo driver.
+* No complex relationship management: if you want to model relationships then add your own finder methods.
+* Minimal dependencies.
+
 == Basic Usage
 
   require 'mongomatic'
   
   class User < Mongomatic::Base
-    validates_presence_of :name, :email
+    def validate
+      self.errors << ["Name", "can't be empty"]  if self["name"].blank?
+      self.errors << ["Email", "can't be empty"] if self["email"].blank?
+    end
   end
   
   # set the db for all models:
@@ -24,42 +35,33 @@ Mongomatic allows you to map your Ruby objects to Mongo documents. It is designe
   => 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>
+  
   u["name"] = "Ben Myles"
   => "Ben Myles" 
   u.update
-  => 142 
+  => 137 
+  
+  found = User.find_one({"name" => "Ben Myles"})
+  => #<User:0x00000101939a48 @doc={"_id"=>BSON::ObjectID('4c32834f0218236321000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false, @is_new=false, @errors=[]>
+  User.find_one(BSON::ObjectID('4c32834f0218236321000001')) == found
+  => true
   
   cursor = User.find({"name" => "Ben Myles"})
-  => #<Mongomatic::Cursor:0x00000100cf5110 @obj_class=User, @mongo_cursor=DBResponse(flags=, cursor_id=, start=)>  cursor.count
-  cursor.count
-  => 1 
+  => #<Mongomatic::Cursor:0x0000010195b4e0 @obj_class=User, @mongo_cursor=<Mongo::Cursor:0x80cadac0 namespace='mongomatic_test.User' @selector={"name"=>"Ben Myles"}>>
   found = cursor.next
-  => #<User:0x00000100ccd408 @doc={"_id"=>BSON::ObjectID('4c32c3720218236526000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false>
+  => #<User:0x00000101939a48 @doc={"_id"=>BSON::ObjectID('4c32834f0218236321000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false, @is_new=false, @errors=[]>
   found.remove
-  => 72
-  found
-  => #<User:0x00000101091f80 @doc={"_id"=>BSON::ObjectID('4c32c4480218236538000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=true> 
-  cursor = User.find({"name" => "Ben Myles"})
-  => #<Mongomatic::Cursor:0x00000100d9eb20 @obj_class=User, @mongo_cursor=DBResponse(flags=, cursor_id=, start=)> 
-  cursor.count
-  => 0 
-  cursor.next
+  => 67
+  User.count
+  => 0
+  User.find({"name" => "Ben Myles"}).next
   => nil
-  
-  found = User.find_one({"name" => "Ben Myles"})
-  => #<User:0x00000100ccd408 @doc={"_id"=>BSON::ObjectID('4c32c3720218236526000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false>
-  found = User.find_one(BSON::ObjectID('4c32c3720218236526000001'))
-  => #<User:0x00000100ccd408 @doc={"_id"=>BSON::ObjectID('4c32c3720218236526000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false>
-  
+    
 == Indexes
 
 Mongomatic doesn't do anything special to support indexes, but here's the suggested convention:
 
-  class Person < Mongomatic::Base
-    validates_presence_of :name, :email
-  
+  class Person < Mongomatic::Base  
     class << self
       def create_indexes
         collection.create_index("email", :unique => true)
@@ -69,7 +71,69 @@ Mongomatic doesn't do anything special to support indexes, but here's the sugges
   
 You can run Person.create_indexes whenever you add new indexes, it won't throw an error if they already exist.
 
-If you have defined a unique index and want Mongomatic to raise an exception on a duplicate insert you need to use insert_safe or update_safe. The error thrown will be Mongo::OperationFailure. See the test suite for examples.
+If you have defined a unique index and want Mongomatic to raise an exception on a duplicate insert you need to use insert! or update!. The error thrown will be Mongo::OperationFailure. See the test suite for examples.
+
+== Validations
+
+You can add validations to your model by creating a validate method. If your validate method pushes anything into the self.errors object your model will fail to validate, otherwise if self.errors remains empty the validations will be taken to have passed.
+
+  class Person < Mongomatic::Base  
+    def validate
+      self.errors << ["name", "blank"]  if self["name"].blank?
+      self.errors << ["email", "blank"] if self["email"].blank?
+      self.errors << ["address.zip", "blank"] if (self["address"] || {})["zip"].blank?
+    end
+  end
+  
+  p = Person.new
+  => #<Person:0x000001018c2d58 @doc={}, @removed=false, @is_new=true, @errors=[]>
+  p.valid?
+  => false
+  p.errors
+  => [["name", "blank"], ["email", "blank"], ["address.zip", "blank"]]
+  p.errors.full_messages
+  => ["name blank", "email blank", "address.zip blank"]
+  p["name"] = "Ben"
+  p["email"] = "Myles"
+  p["address"] = { "zip" => 94107 }
+  p.valid?
+  => true
+
+== Relationships
+
+Mongomatic doesn't have any kind of special support for relationship management but it's easy to add this to your models where you need it. Here's an example that models Twitter-like followers on a User model:
+
+  class User < Mongomatic::Base  
+    class << self
+      def create_indexes
+        self.collection.create_index("following_ids")
+      end
+    end
+  
+    def follow(user)
+      self.push("following_ids", user["_id"])
+    end
+  
+    def unfollow(user)
+      self.pull("following_ids", user["_id"])
+    end
+  
+    def following
+      return nil if new?
+      self.class.find( { "_id" => { "$in" => (self["following_ids"] || []) } } )
+    end
+  
+    def followers
+      return nil if new?
+      self.class.find( { "following_ids" => self["_id"] } )
+    end
+  
+    def friends
+      return nil if new?
+      self.class.find( { "following_ids" => self["_id"], 
+                         "_id" => { "$in" => (self["following_ids"] || []) } } )
+    end
+  end
 
 == Note on Patches/Pull Requests
  

data/lib/mongomatic/base.rb

@@ -1,7 +1,6 @@
 module Mongomatic
   class Base
     include Mongomatic::Modifiers
-    include Mongomatic::Validatable
     
     class << self
       def db
@@ -48,12 +47,25 @@ module Mongomatic
       end
     end
 
-    attr_accessor :removed, :is_new
+    attr_accessor :removed, :is_new, :errors
 
     def initialize(doc={}, is_new=true)
       @doc = doc.stringify_keys
       self.removed = false
       self.is_new  = is_new
+      self.errors  = Mongomatic::Errors.new
+    end
+    
+    def validate
+      true
+    end
+    
+    def valid?
+      self.errors = Mongomatic::Errors.new
+      self.send(:before_validate) if self.respond_to?(:before_validate)
+      validate
+      self.send(:after_validate) if self.respond_to?(:after_validate)
+      self.errors.empty?
     end
     
     def is_new?
@@ -103,9 +115,8 @@ module Mongomatic
       ret
     end
     
-    def insert_safe(opts={})
-      opts.merge!(:safe => true)
-      insert(opts)
+    def insert!(opts={})
+      insert(opts.merge(:safe => true))
     end
     
     def update(opts={},update_doc=@doc)
@@ -118,9 +129,8 @@ module Mongomatic
       ret
     end
     
-    def update_safe(opts={},update_doc=@doc)
-      opts.merge!(:safe => true)
-      update(opts,update_doc)
+    def update!(opts={},update_doc=@doc)
+      update(opts.merge(:safe => true),update_doc)
     end
     
     def remove(opts={})
@@ -133,9 +143,8 @@ module Mongomatic
       ret
     end
     
-    def remove_safe(opts={})
-      opts.merge!(:safe => true)
-      remove(opts)
+    def remove!(opts={})
+      remove(opts.merge(:safe => true))
     end
     
     def to_hash

data/lib/mongomatic/errors.rb

@@ -0,0 +1,7 @@
+module Mongomatic
+  class Errors < Array
+    def full_messages(sep=" ")
+      collect { |e| e.join(sep) }
+    end
+  end
+end

data/lib/mongomatic.rb

@@ -27,8 +27,7 @@ module Mongomatic
   end
 end
 
-require "#{File.dirname(__FILE__)}/mongomatic/validatable"
-
 require "#{File.dirname(__FILE__)}/mongomatic/cursor"
 require "#{File.dirname(__FILE__)}/mongomatic/modifiers"
+require "#{File.dirname(__FILE__)}/mongomatic/errors"
 require "#{File.dirname(__FILE__)}/mongomatic/base"

data/test/helper.rb

@@ -10,13 +10,16 @@ require 'mongomatic'
 Mongomatic.db = Mongo::Connection.new.db("mongomatic_test")
 
 class Person < Mongomatic::Base
-  validates_presence_of :name
   attr_accessor :callback_tests
   
   def self.create_indexes
     collection.create_index("name", :unique => true)
   end
   
+  def validate
+    self.errors << ["Name", "can't be empty"] if self["name"].blank?
+  end
+  
   def before_validate
     self.callback_tests ||= []
     self.callback_tests << :before_validate

data/test/test_mongomatic.rb

@@ -22,7 +22,7 @@ class TestMongomatic < Test::Unit::TestCase
     Person.create_indexes
     
     p = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
-    assert p.insert_safe.is_a?(BSON::ObjectID)
+    assert p.insert!.is_a?(BSON::ObjectID)
     assert_equal 1, Person.count
     
     found = Person.find({"_id" => BSON::ObjectID(p["_id"].to_s)}).next
@@ -175,11 +175,11 @@ class TestMongomatic < Test::Unit::TestCase
     Person.create_indexes
     
     p = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
-    assert p.insert_safe.is_a?(BSON::ObjectID)
+    assert p.insert!.is_a?(BSON::ObjectID)
     assert_equal 1, Person.count
     
     p = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
-    assert_raise(Mongo::OperationFailure) { p.insert_safe }
+    assert_raise(Mongo::OperationFailure) { p.insert! }
     
     assert_equal 1, Person.count
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Ben Myles
@@ -21,6 +21,7 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -35,6 +36,7 @@ dependencies:
   name: bson
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -49,6 +51,7 @@ dependencies:
   name: bson_ext
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -63,6 +66,7 @@ dependencies:
   name: mongo
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -77,6 +81,7 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -100,31 +105,12 @@ files:
 - lib/mongomatic.rb
 - lib/mongomatic/base.rb
 - lib/mongomatic/cursor.rb
+- lib/mongomatic/errors.rb
 - lib/mongomatic/modifiers.rb
-- lib/mongomatic/validatable.rb
-- lib/mongomatic/validatable/child_validation.rb
-- lib/mongomatic/validatable/errors.rb
-- lib/mongomatic/validatable/included_validation.rb
-- lib/mongomatic/validatable/macros.rb
-- lib/mongomatic/validatable/object_extension.rb
-- lib/mongomatic/validatable/requireable.rb
-- lib/mongomatic/validatable/understandable.rb
-- lib/mongomatic/validatable/validatable_class_methods.rb
-- lib/mongomatic/validatable/validatable_instance_methods.rb
-- lib/mongomatic/validatable/validations/validates_acceptance_of.rb
-- lib/mongomatic/validatable/validations/validates_associated.rb
-- lib/mongomatic/validatable/validations/validates_confirmation_of.rb
-- lib/mongomatic/validatable/validations/validates_each.rb
-- lib/mongomatic/validatable/validations/validates_exclusion_of.rb
-- lib/mongomatic/validatable/validations/validates_format_of.rb
-- lib/mongomatic/validatable/validations/validates_inclusion_of.rb
-- lib/mongomatic/validatable/validations/validates_length_of.rb
-- lib/mongomatic/validatable/validations/validates_numericality_of.rb
-- lib/mongomatic/validatable/validations/validates_presence_of.rb
-- lib/mongomatic/validatable/validations/validates_true_for.rb
-- lib/mongomatic/validatable/validations/validation_base.rb
 - LICENSE
 - README.rdoc
+- test/helper.rb
+- test/test_mongomatic.rb
 has_rdoc: true
 homepage: http://github.com/benmyles/mongomatic
 licenses: []
@@ -135,6 +121,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -142,6 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -151,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Mongomatic is a simple Ruby object mapper for Mongo

data/lib/mongomatic/validatable/child_validation.rb

@@ -1,17 +0,0 @@
-module Mongomatic
-  module Validatable
-    class ChildValidation #:nodoc:
-      attr_accessor :attribute, :map, :should_validate_proc
-    
-      def initialize(attribute, map, should_validate_proc)
-        @attribute = attribute
-        @map = map
-        @should_validate_proc = should_validate_proc
-      end
-    
-      def should_validate?(instance)
-        instance.instance_eval &should_validate_proc
-      end
-    end
-  end
-end

data/lib/mongomatic/validatable/errors.rb

@@ -1,108 +0,0 @@
-module Mongomatic
-  module Validatable
-    class Errors
-      extend Forwardable
-      include Enumerable
-
-      def_delegators :errors, :clear, :each, :each_pair, :empty?, :length, :size
-
-      # Returns true if the specified +attribute+ has errors associated with it.
-      #
-      #   class Company < ActiveRecord::Base
-      #     validates_presence_of :name, :address, :email
-      #     validates_length_of :name, :in => 5..30
-      #   end
-      #
-      #   company = Company.create(:address => '123 First St.')
-      #   company.errors.invalid?(:name)      # => true
-      #   company.errors.invalid?(:address)   # => false
-      def invalid?(attribute)
-        !@errors[attribute.to_sym].nil?
-      end
-
-      # Adds an error to the base object instead of any particular attribute. This is used
-      # to report errors that don't tie to any specific attribute, but rather to the object
-      # as a whole. These error messages don't get prepended with any field name when iterating
-      # with +each_full+, so they should be complete sentences.
-      def add_to_base(msg)
-        add(:base, msg)
-      end
-
-      # Returns errors assigned to the base object through +add_to_base+ according to the normal rules of <tt>on(attribute)</tt>.
-      def on_base
-        on(:base)
-      end    
-
-      # call-seq: on(attribute)
-      #
-      # * Returns nil, if no errors are associated with the specified +attribute+.
-      # * Returns the error message, if one error is associated with the specified +attribute+.
-      # * Returns an array of error messages, if more than one error is associated with the specified +attribute+.
-      def on(attribute)
-        return nil if errors[attribute.to_sym].nil?
-        errors[attribute.to_sym].size == 1 ? errors[attribute.to_sym].first : errors[attribute.to_sym]
-      end
-
-      # Rails 3 API for errors, always return array.
-      def [](attribute)
-        errors[attribute.to_sym] || []
-      end
-
-      def add(attribute, message) #:nodoc:
-        errors[attribute.to_sym] = [] if errors[attribute.to_sym].nil?
-        errors[attribute.to_sym] << message
-      end
-
-      def merge!(errors) #:nodoc:
-        errors.each_pair{|k, v| add(k,v)}
-        self
-      end
-
-      # call-seq: replace(attribute)
-      #
-      # * Replaces the errors value for the given +attribute+
-      def replace(attribute, value)
-        errors[attribute.to_sym] = value
-      end
-
-      # call-seq: raw(attribute)
-      #
-      # * Returns an array of error messages associated with the specified +attribute+.
-      def raw(attribute)
-        errors[attribute.to_sym]
-      end
-
-      def errors #:nodoc:
-        @errors ||= {}
-      end
-
-      def count #:nodoc:
-        errors.values.flatten.size
-      end
-
-      # call-seq: full_messages -> an_array_of_messages
-      #
-      # Returns an array containing the full list of error messages.
-      def full_messages
-        full_messages = []
-
-        errors.each_key do |attribute|
-          errors[attribute].each do |msg|
-            next if msg.nil?
-
-            if attribute.to_s == "base"
-              full_messages << msg
-            else
-              full_messages << humanize(attribute.to_s) + " " + msg
-            end
-          end
-        end
-        full_messages
-      end
-
-      def humanize(lower_case_and_underscored_word) #:nodoc:
-        lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
-      end
-    end
-  end
-end

data/lib/mongomatic/validatable/included_validation.rb

@@ -1,11 +0,0 @@
-module Mongomatic
-  module Validatable
-    class IncludedValidation #:nodoc:
-      attr_accessor :attribute
-    
-      def initialize(attribute)
-        @attribute = attribute
-      end
-    end
-  end
-end