mongomatic 0.5.8 → 0.6.0

data/README.rdoc

@@ -2,6 +2,20 @@
 
 Mongomatic allows you to map your Ruby objects to Mongo documents. It is designed to be fast and simple.
 
+== 0.6.0 CHANGELOG NOTES
+
+ !! THE ERROR CLASS HAS BEEN REWORKED IN THIS VERSION.
+ !! DO NOT EXPECT YOUR UPGRADE TO BE SEAMLESS. NOTHING /SHOULD/
+ !! BREAK BUT YOU SHOULD TEST THOROUGHLY.
+
+ * Added methods to bring ActiveModel compliancy
+ 
+ * Pulled in do_callback fix (no more NoMethodError catching)
+ 
+ * Relaxed restrictions on dependencies
+ 
+ * Reworked the Error class to mimic the ActiveModel style errors.
+
 == What's different about Mongomatic?
 
 * Follows Mongo idioms wherever possible.
@@ -16,8 +30,8 @@ Mongomatic allows you to map your Ruby objects to Mongo documents. It is designe
   
   class User < Mongomatic::Base
     def validate
-      self.errors << ["Name", "can't be empty"]  if self["name"].blank?
-      self.errors << ["Email", "can't be empty"] if self["email"].blank?
+      self.errors.add "name", "can't be empty" if self["name"].blank?
+      self.errors.add "email", "can't be empty" if self["email"].blank?
     end
   end
   
@@ -85,9 +99,9 @@ You can add validations to your model by creating a validate method. If your val
 
   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?
+      self.errors.add "name", "blank" if self["name"].blank?
+      self.errors.add "email", "blank" if self["email"].blank?
+      self.errors.add "address.zip", "blank" if (self["address"] || {})["zip"].blank?
     end
   end
   
@@ -114,8 +128,8 @@ To make writing your validate method a little simpler you can use Mongomatic::Ex
      
      def validate
        expectations do
-         be_present self['name'], "Name cannot be blank"
-         not_be_match self['nickname'], "Nickname cannot contain an uppercase letter", :with => /[A-Z]/
+         be_present   self['name'], ["name", "cannot be blank"]
+         not_be_match self['nickname'], ["nickname", "cannot contain an uppercase letter"], :with => /[A-Z]/
        end
      end
   end

data/lib/mongomatic/active_model_compliancy.rb

@@ -0,0 +1,29 @@
+module Mongomatic
+  module ActiveModelCompliancy
+
+    def to_model
+      self
+    end
+    
+    def new_record?
+      new?
+    end
+    
+    def destroyed?
+      removed?
+    end
+    
+    def persisted?
+      !new?
+    end
+    
+    def to_key
+      self["_id"]
+    end
+    
+    def to_param
+      self["_id"] ? self["_id"].to_s : nil
+    end
+
+  end
+end

data/lib/mongomatic/base.rb

@@ -2,6 +2,7 @@ module Mongomatic
   class Base
     include Mongomatic::Modifiers
     include Mongomatic::Util
+    include Mongomatic::ActiveModelCompliancy
     
     class << self
       # Returns this models own db attribute if set, otherwise will return Mongomatic.db
@@ -72,11 +73,8 @@ module Mongomatic
       private
       
       def do_callback(meth)
-        begin
-          send(meth)
-        rescue NoMethodError => e
-          false
-        end
+        return false unless respond_to?(meth, true)
+        send(meth)
       end
     end
 
@@ -102,7 +100,7 @@ module Mongomatic
     # Simply push your errors into the self.errors property and
     # if self.errors remains empty your document will be valid.
     #  def validate
-    #    self.errors << ["name", "cannot be blank"]
+    #    self.errors.add "name", "cannot be blank"
     #  end
     def validate
       true
@@ -254,11 +252,8 @@ module Mongomatic
     end
     
     def do_callback(meth)
-      begin
-        send(meth)
-      rescue NoMethodError => e
-        false
-      end
+      return false unless respond_to?(meth, true)
+      send(meth)
     end
   end
 end

data/lib/mongomatic/errors.rb

@@ -1,22 +1,83 @@
 module Mongomatic
-  class Errors < Array
-    def full_messages(sep=" ")
-      collect { |e| e.join(sep) }
+  class Errors
+    def initialize
+      @errors = HashWithIndifferentAccess.new
     end
     
-    def on(field, sep=" ")
-      ret = []
-      self.each do |err|
-        ret << err.join(sep) if err.first =~ /^#{field.to_s.split('_').join(' ')}/i 
-      end
-      case ret.size
-      when 0
-        nil
-      when 1
-        ret.first
+    def add(field, message)
+      @errors[field] ||= []
+      @errors[field] << message
+    end
+    
+    def <<(error_array)
+      error_array = Array(error_array)
+      if error_array.size == 2
+        add error_array[0], error_array[1]
       else
-        ret
+        add_to_base error_array[0]
+      end
+    end
+    
+    def add_to_base(message)
+      @errors["base"] ||= []
+      @errors["base"] << message
+    end
+    
+    def remove(field, message)
+      @errors[field] ||= []
+      @errors[field].delete message
+    end
+    
+    def empty?
+      !(@errors.any? { |k,v| v && !v.empty? })
+    end
+    
+    def full_messages
+      full_messages = []
+      @errors.each do |field, messages|
+        messages.each do |message|
+          msg = []
+          msg << field unless field == "base"
+          msg << message
+          full_messages << msg.join(" ")
+        end
       end
+      full_messages
+    end
+    
+    def [](field)
+      @errors[field] || []
+    end
+    
+    def to_hash
+      @errors
+    end
+    
+    def on(field)
+      self[field]
     end
   end
-end
+end
+
+# module Mongomatic
+#   class Errors < Array
+#     def full_messages(sep=" ")
+#       collect { |e| e.join(sep) }
+#     end
+#     
+#     def on(field, sep=" ")
+#       ret = []
+#       self.each do |err|
+#         ret << err.join(sep) if err.first =~ /^#{field.to_s.split('_').join(' ')}/i 
+#       end
+#       case ret.size
+#       when 0
+#         nil
+#       when 1
+#         ret.first
+#       else
+#         ret
+#       end
+#     end
+#   end
+# end

data/lib/mongomatic/expectations/be_reference.rb

@@ -0,0 +1,15 @@
+module Mongomatic
+  module Expectations
+    class BeReference < Expectation
+      def self.name
+        "reference"
+      end
+  
+      def to_be
+        return true if opts[:allow_nil] && value.nil?
+    
+        add_error_msg unless value.is_a? BSON::ObjectId
+      end
+    end
+  end
+end

data/lib/mongomatic/expectations.rb

@@ -80,7 +80,12 @@ module Mongomatic
       end
       
       def add_error_msg
-        instance.errors << Array(message)
+        vars = Array(message)
+        if vars.size == 2
+          instance.errors.add(vars[0], vars[1])
+        else
+          instance.errors.add_to_base(vars[0])
+        end
       end
     end
   end

data/lib/mongomatic.rb

@@ -1,5 +1,5 @@
-gem "bson", "= 1.1"
-gem "mongo", "= 1.1"
+gem "bson", "~> 1.1"
+gem "mongo", "~> 1.1"
 gem "activesupport", ">= 2.3.5"
 
 require "bson"
@@ -35,4 +35,5 @@ require "#{File.dirname(__FILE__)}/mongomatic/cursor"
 require "#{File.dirname(__FILE__)}/mongomatic/modifiers"
 require "#{File.dirname(__FILE__)}/mongomatic/errors"
 require "#{File.dirname(__FILE__)}/mongomatic/expectations"
+require "#{File.dirname(__FILE__)}/mongomatic/active_model_compliancy"
 require "#{File.dirname(__FILE__)}/mongomatic/base"

data/test/helper.rb

@@ -31,7 +31,7 @@ class Person < Mongomatic::Base
   end
 
   def validate
-    self.errors << ["Name", "can't be empty"] if self["name"].blank?
+    self.errors.add "name", "can't be empty" if self["name"].blank?
   end
   
   private

data/test/test_mongomatic.rb

@@ -94,7 +94,7 @@ class TestMongomatic < Test::Unit::TestCase
     p = Person.new
     
     assert !p.valid?
-    assert_equal(["Name can't be empty"], p.errors.full_messages)
+    assert_equal(["name can't be empty"], p.errors.full_messages)
     
     p["name"] = "Ben Myles"
     p["birth_year"] = 1984
@@ -248,6 +248,23 @@ class TestMongomatic < Test::Unit::TestCase
     assert_equal found["_id"], "mycustomid"
     assert_equal 26, found["age"]
   end
+  
+  should "be able to use array style error adding" do
+    class Foobar < Mongomatic::Base
+      def validate
+        errors << ["color", "must not be blank"] if self["color"].blank?
+        errors << "missing style" if self["style"].blank?
+      end
+    end
+    
+    f = Foobar.new
+    assert !f.valid?
+    assert_equal ["color must not be blank", "missing style"], f.errors.full_messages
+    f["color"] = "pink"; f.valid?
+    assert_equal ["missing style"], f.errors.full_messages
+    f["style"] = "awesome"; f.valid?
+    assert_equal [], f.errors.full_messages
+  end
  
   should "be able to use the be_expect expectation" do
     p = Person.new
@@ -444,6 +461,25 @@ class TestMongomatic < Test::Unit::TestCase
     assert p.valid?
   end
   
+  should "be able to use be_reference expectation" do
+    id = Person.new('name' => 'jordan').insert
+    p = Person.new
+    class << p
+      def validate
+        expectations do 
+          be_reference self['friend'], 'friend must be an ObjectId'
+        end
+      end
+    end
+    
+    assert !p.valid?
+    assert_equal ["friend must be an ObjectId"], p.errors.full_messages
+    
+    p['friend'] = id
+    
+    assert p.valid?
+  end
+  
   should "raise an error if expectations are called outside of helper block" do
     p = Person.new
     class << p
@@ -492,20 +528,20 @@ class TestMongomatic < Test::Unit::TestCase
     end
 
     p.valid?
-    assert_equal ['name cannot be empty', 'name must be at least 3 characters long'], p.errors.on(:name)
-    assert_equal 'age must be a number', p.errors.on('age')
+    assert_equal ['cannot be empty', 'must be at least 3 characters long'], p.errors.on(:name)
+    assert_equal ['must be a number'], p.errors.on('age')
     
     p['name'] = 'Jo'
     p['age'] = 21
     
     p.valid?
-    assert_equal 'name must be at least 3 characters long', p.errors.on('name')
-    assert_nil p.errors.on(:age)
+    assert_equal ['must be at least 3 characters long'], p.errors.on('name')
+    assert_equal [], p.errors.on(:age)
     
     p['name'] = 'Jordan'
     
     p.valid?
-    assert_nil p.errors.on(:name)
+    assert_equal [], p.errors.on(:name)
   end
 
   should "be able to use errors.on with one part error messages" do
@@ -513,28 +549,28 @@ class TestMongomatic < Test::Unit::TestCase
     class << p
       def validate
         expectations do 
-          be_expected self['name'], 'name cannot be empty' 
-          be_of_length self['name'], 'name must be at least 3 characters long', :minimum => 3
-          be_a_number self['age'],  'age must be a number'
+          be_expected self['name'], ['name', 'cannot be empty' ]
+          be_of_length self['name'], ['name', 'must be at least 3 characters long'], :minimum => 3
+          be_a_number self['age'],  ['age','must be a number']
         end
       end
     end
 
     p.valid?
-    assert_equal ['name cannot be empty', 'name must be at least 3 characters long'], p.errors.on(:name)
-    assert_equal 'age must be a number', p.errors.on('age')
+    assert_equal ['cannot be empty', 'must be at least 3 characters long'], p.errors.on(:name)
+    assert_equal ['must be a number'], p.errors.on('age')
     
     p['name'] = 'Jo'
     p['age'] = 21
     
     p.valid?
-    assert_equal 'name must be at least 3 characters long', p.errors.on('name')
-    assert_nil p.errors.on(:age)
+    assert_equal ['must be at least 3 characters long'], p.errors.on('name')
+    assert_equal [], p.errors.on(:age)
     
     p['name'] = 'Jordan'
     
     p.valid?
-    assert_nil p.errors.on(:name)
+    assert_equal [], p.errors.on(:name)
   end
   
   should "be able to use errors.on case insensitive" do
@@ -542,15 +578,15 @@ class TestMongomatic < Test::Unit::TestCase
     class << p
       def validate
         expectations do 
-          be_expected self['name'], ['Name', 'cannot be empty']
-          be_expected self['age'], 'Age cannot be empty'
+          be_expected self['name'], ['name', 'cannot be empty']
+          be_expected self['age'], ['age','cannot be empty']
         end
       end
     end
     
     p.valid?
-    assert_equal 'Name cannot be empty', p.errors.on('name')
-    assert_equal 'Age cannot be empty', p.errors.on(:age)
+    assert_equal ['cannot be empty'], p.errors.on('name')
+    assert_equal ['cannot be empty'], p.errors.on(:age)
   end
 
   should "be able to use errors.on with multi word fields" do
@@ -558,13 +594,13 @@ class TestMongomatic < Test::Unit::TestCase
     class << p
       def validate
         expectations do 
-          be_expected self['hair_color'], 'Hair color must exist'
+          be_expected self['hair_color'], ['hair_color', 'must exist']
         end
       end
     end
     
     p.valid?
-    assert_equal 'Hair color must exist', p.errors.on(:hair_color)
+    assert_equal ['must exist'], p.errors.on(:hair_color)
   end
   
   should "be able to use has_key?" do
@@ -602,4 +638,19 @@ class TestMongomatic < Test::Unit::TestCase
     assert_equal "Meta+Level Games", p.value_for_key("employer.name")
     assert_nil p.value_for_key("some_key.that_does_not.exist")
   end
+  
+  should "not rescue a NoMethodError raised in a callback" do
+    class Thing < Mongomatic::Base
+      def before_insert
+        raise NoMethodError
+      end
+
+      def self.before_drop
+        raise NoMethodError
+      end
+    end
+
+    assert_raise(NoMethodError) { Thing.new.insert }
+    assert_raise(NoMethodError) { Thing.drop }
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 8
-  version: 0.5.8
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Ben Myles
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 -07:00
+date: 2010-11-10 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,7 +38,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 1
@@ -52,7 +52,7 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 1
@@ -86,10 +86,12 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/mongomatic.rb
+- lib/mongomatic/active_model_compliancy.rb
 - lib/mongomatic/base.rb
 - lib/mongomatic/cursor.rb
 - lib/mongomatic/errors.rb
 - lib/mongomatic/expectations.rb
+- lib/mongomatic/expectations/be_reference.rb
 - lib/mongomatic/expectations/expected.rb
 - lib/mongomatic/expectations/is_number.rb
 - lib/mongomatic/expectations/match.rb