mongo_mapper 0.5.1 → 0.5.2

data/Rakefile

@@ -12,7 +12,7 @@ begin
     gem.rubyforge_project = "mongomapper"
     
     gem.add_dependency('activesupport')
-    gem.add_dependency('mongo', '0.15')
+    gem.add_dependency('mongo', '0.15.1')
     gem.add_dependency('jnunemaker-validatable', '1.7.3')
     
     gem.add_development_dependency('mocha', '0.9.4')

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/mongo_mapper.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 
 gem 'activesupport'
-gem 'mongo', '0.15'
+gem 'mongo', '0.15.1'
 gem 'jnunemaker-validatable', '1.7.3'
 
 require 'activesupport'
@@ -82,6 +82,7 @@ require 'mongo_mapper/associations/many_embedded_polymorphic_proxy'
 require 'mongo_mapper/associations/many_documents_as_proxy'
 require 'mongo_mapper/callbacks'
 require 'mongo_mapper/finder_options'
+require 'mongo_mapper/dirty'
 require 'mongo_mapper/dynamic_finder'
 require 'mongo_mapper/key'
 require 'mongo_mapper/observing'

data/lib/mongo_mapper/dirty.rb

@@ -0,0 +1,137 @@
+module MongoMapper
+  module Dirty
+    DIRTY_SUFFIXES = ['_changed?', '_change', '_will_change!', '_was']
+    
+    def self.included(base)
+      base.alias_method_chain :write_attribute, :dirty
+      base.alias_method_chain :save,            :dirty
+      base.alias_method_chain :save!,           :dirty
+    end
+    
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /(_changed\?|_change|_will_change!|_was)$/
+        method_suffix = $1
+        key = method.to_s.gsub(method_suffix, '')
+        
+        if key_names.include?(key)
+          case method_suffix
+            when '_changed?'
+              key_changed?(key)
+            when '_change'
+              key_change(key)
+            when '_will_change!'
+              key_will_change!(key)
+            when '_was'
+              key_was(key)
+          end
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+    
+    def changed?
+      !changed_keys.empty?
+    end
+
+    # List of keys with unsaved changes.
+    #   person.changed # => []
+    #   person.name = 'bob'
+    #   person.changed # => ['name']
+    def changed
+      changed_keys.keys
+    end
+
+    # Map of changed attrs => [original value, new value].
+    #   person.changes # => {}
+    #   person.name = 'bob'
+    #   person.changes # => { 'name' => ['bill', 'bob'] }
+    def changes
+      changed.inject({}) { |h, attribute| h[attribute] = key_change(attribute); h }
+    end
+    
+    # Attempts to +save+ the record and clears changed keys if successful.
+    def save_with_dirty(*args) #:nodoc:
+      if status = save_without_dirty(*args)
+        changed_keys.clear
+      end
+      status
+    end
+
+    # Attempts to <tt>save!</tt> the record and clears changed keys if successful.
+    def save_with_dirty!(*args) #:nodoc:
+      status = save_without_dirty!(*args)
+      changed_keys.clear
+      status
+    end
+    
+    # <tt>reload</tt> the record and clears changed keys.
+    # def reload_with_dirty(*args) #:nodoc:
+    #   record = reload_without_dirty(*args)
+    #   changed_keys.clear
+    #   record
+    # end
+
+    private
+      def clone_key_value(attribute_name)
+        value = send(:read_attribute, attribute_name)
+        value.duplicable? ? value.clone : value
+      rescue TypeError, NoMethodError
+        value
+      end
+      
+      # Map of change <tt>attr => original value</tt>.
+      def changed_keys
+        @changed_keys ||= {}
+      end
+
+      # Handle <tt>*_changed?</tt> for +method_missing+.
+      def key_changed?(attribute)
+        changed_keys.include?(attribute)
+      end
+
+      # Handle <tt>*_change</tt> for +method_missing+.
+      def key_change(attribute)
+        [changed_keys[attribute], __send__(attribute)] if key_changed?(attribute)
+      end
+
+      # Handle <tt>*_was</tt> for +method_missing+.
+      def key_was(attribute)
+        key_changed?(attribute) ? changed_keys[attribute] : __send__(attribute)
+      end
+
+      # Handle <tt>*_will_change!</tt> for +method_missing+.
+      def key_will_change!(attribute)
+        changed_keys[attribute] = clone_key_value(attribute)
+      end
+
+      # Wrap write_attribute to remember original key value.
+      def write_attribute_with_dirty(attribute, value)
+        attribute = attribute.to_s
+
+        # The key already has an unsaved change.
+        if changed_keys.include?(attribute)
+          old = changed_keys[attribute]
+          changed_keys.delete(attribute) unless value_changed?(attribute, old, value)
+        else
+          old = clone_key_value(attribute)
+          changed_keys[attribute] = old if value_changed?(attribute, old, value)
+        end
+
+        # Carry on.
+        write_attribute_without_dirty(attribute, value)
+      end
+      
+      def value_changed?(key_name, old, value)
+        key = _keys[key_name]
+        
+        if key.number? && value.blank?
+          value = nil
+        end
+        
+        old != value
+      end
+  end
+end

data/lib/mongo_mapper/document.rb

@@ -9,6 +9,7 @@ module MongoMapper
         include Observing
         include Callbacks
         include SaveWithValidation
+        include Dirty
         include RailsCompatibility::Document
         extend Validations::Macros
         extend ClassMethods

data/lib/mongo_mapper/embedded_document.rb

@@ -299,6 +299,12 @@ module MongoMapper
           _root_document.save
         end
       end
+      
+      def save!
+        if _root_document
+          _root_document.save!
+        end
+      end
 
       def update_attributes(attrs={})
         self.attributes = attrs
@@ -348,7 +354,7 @@ module MongoMapper
           end.map do |name, association|
             association
           end
-        end        
+        end
     end # InstanceMethods
   end # EmbeddedDocument
 end # MongoMapper

data/lib/mongo_mapper/finder_options.rb

@@ -74,14 +74,7 @@ module MongoMapper
       def self.to_mongo_sort(sort)
         return if sort.blank?
         pieces = sort.split(',')
-        pairs  = pieces.map { |s| to_mongo_sort_piece(s) }
-      
-        hash = OrderedHash.new
-        pairs.each do |pair|
-          field, sort_direction = pair
-          hash[field] = sort_direction
-        end
-        hash.symbolize_keys
+        pieces.map { |s| to_mongo_sort_piece(s) }
       end
     
       def self.to_mongo_sort_piece(str)

data/lib/mongo_mapper/key.rb

@@ -20,6 +20,10 @@ module MongoMapper
     def embeddable?
       type.respond_to?(:embeddable?) && type.embeddable? ? true : false
     end
+    
+    def number?
+      [Integer, Float].include?(type)
+    end
 
     def get(value)
       if value.nil? && !default_value.nil?

data/lib/mongo_mapper/support.rb

@@ -154,18 +154,4 @@ class Time
       Time.parse(value.to_s)
     end
   end
-end
-
-# duck punch to get access to internal mongo 
-# logger instance until my patch goes thorugh
-module Mongo
-  class Connection
-    def logger
-      @options[:logger]
-    end
-  end
-  
-  class DB
-    attr_reader :logger
-  end
 end

data/mongo_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongo_mapper}
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-10-07}
+  s.date = %q{2009-10-08}
   s.default_executable = %q{mmconsole}
   s.email = %q{nunemaker@gmail.com}
   s.executables = ["mmconsole"]
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
      "lib/mongo_mapper/associations/many_proxy.rb",
      "lib/mongo_mapper/associations/proxy.rb",
      "lib/mongo_mapper/callbacks.rb",
+     "lib/mongo_mapper/dirty.rb",
      "lib/mongo_mapper/document.rb",
      "lib/mongo_mapper/dynamic_finder.rb",
      "lib/mongo_mapper/embedded_document.rb",
@@ -65,6 +66,7 @@ Gem::Specification.new do |s|
      "test/functional/test_associations.rb",
      "test/functional/test_binary.rb",
      "test/functional/test_callbacks.rb",
+     "test/functional/test_dirty.rb",
      "test/functional/test_document.rb",
      "test/functional/test_embedded_document.rb",
      "test/functional/test_logger.rb",
@@ -107,6 +109,7 @@ Gem::Specification.new do |s|
      "test/functional/test_associations.rb",
      "test/functional/test_binary.rb",
      "test/functional/test_callbacks.rb",
+     "test/functional/test_dirty.rb",
      "test/functional/test_document.rb",
      "test/functional/test_embedded_document.rb",
      "test/functional/test_logger.rb",
@@ -138,20 +141,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<mongo>, ["= 0.15"])
+      s.add_runtime_dependency(%q<mongo>, ["= 0.15.1"])
       s.add_runtime_dependency(%q<jnunemaker-validatable>, ["= 1.7.3"])
       s.add_development_dependency(%q<mocha>, ["= 0.9.4"])
       s.add_development_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<mongo>, ["= 0.15"])
+      s.add_dependency(%q<mongo>, ["= 0.15.1"])
       s.add_dependency(%q<jnunemaker-validatable>, ["= 1.7.3"])
       s.add_dependency(%q<mocha>, ["= 0.9.4"])
       s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<mongo>, ["= 0.15"])
+    s.add_dependency(%q<mongo>, ["= 0.15.1"])
     s.add_dependency(%q<jnunemaker-validatable>, ["= 1.7.3"])
     s.add_dependency(%q<mocha>, ["= 0.9.4"])
     s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])

data/test/functional/test_dirty.rb

@@ -0,0 +1,138 @@
+require 'test_helper'
+require 'models'
+
+class DirtyTest < Test::Unit::TestCase
+  def setup
+    @document = Class.new do
+      include MongoMapper::Document
+      set_collection_name 'test'
+      key :phrase, String
+    end
+    @document.collection.clear
+    
+    Status.collection.clear
+    Project.collection.clear
+  end
+  
+  context "marking changes" do
+    should "not happen if there are none" do
+      doc = @document.new
+      doc.phrase_changed?.should be_false
+      doc.phrase_change.should be_nil
+    end
+    
+    should "happen when change happens" do
+      doc = @document.new
+      doc.phrase = 'Golly Gee Willikers Batman'
+      doc.phrase_changed?.should be_true
+      doc.phrase_was.should be_nil
+      doc.phrase_change.should == [nil, 'Golly Gee Willikers Batman']
+    end
+    
+    should "clear changes on save" do
+      doc = @document.new
+      doc.phrase = 'Golly Gee Willikers Batman'
+      doc.phrase_changed?.should be_true
+      doc.save
+      doc.phrase_changed?.should_not be_true
+      doc.phrase_change.should be_nil
+    end
+    
+    should "clear changes on save!" do
+      doc = @document.new
+      doc.phrase = 'Golly Gee Willikers Batman'
+      doc.phrase_changed?.should be_true
+      doc.save!
+      doc.phrase_changed?.should_not be_true
+      doc.phrase_change.should be_nil
+    end
+  end
+  
+  context "blank new value and type integer" do
+    should "not mark changes" do
+      @document.key :age, Integer
+
+      [nil, ''].each do |value|
+        doc = @document.new
+        doc.age = value
+        doc.age_changed?.should be_false
+        doc.age_change.should be_nil
+      end
+    end
+  end
+  
+  context "blank new value and type float" do
+    should "not mark changes" do
+      @document.key :amount, Float
+
+      [nil, ''].each do |value|
+        doc = @document.new
+        doc.amount = value
+        doc.amount_changed?.should be_false
+        doc.amount_change.should be_nil
+      end
+    end
+  end  
+  
+  context "changed?" do
+    should "be true if key changed" do
+      doc = @document.new
+      doc.phrase = 'A penny saved is a penny earned.'
+      doc.changed?.should be_true
+    end
+    
+    should "be false if no keys changed" do
+      @document.new.changed?.should be_false
+    end
+  end
+  
+  context "changes" do
+    should "be empty hash if no changes" do
+      @document.new.changes.should == {}
+    end
+    
+    should "be hash of keys with values of changes if there are changes" do
+      doc = @document.new
+      doc.phrase = 'A penny saved is a penny earned.'
+      doc.changes.should == {'phrase' => [nil, 'A penny saved is a penny earned.']}
+    end
+  end
+  
+  context "changed" do
+    should "be empty array if no changes" do
+      @document.new.changed.should == []
+    end
+    
+    should "be array of keys that have changed if there are changes" do
+      doc = @document.new
+      doc.phrase = 'A penny saved is a penny earned.'
+      doc.changed.should == ['phrase']
+    end
+  end
+  
+  context "will_change!" do
+    should "mark changes" do
+      doc = @document.create(:phrase => 'Foo')
+      
+      doc.phrase << 'bar'
+      doc.phrase_changed?.should be_false
+      
+      doc.phrase_will_change!
+      doc.phrase_changed?.should be_true
+      doc.phrase_change.should == ['Foobar', 'Foobar']
+      
+      doc.phrase << '!'
+      doc.phrase_changed?.should be_true
+      doc.phrase_change.should == ['Foobar', 'Foobar!']
+    end
+  end
+  
+  context "changing a foreign key through association" do
+    should "mark changes" do
+      status = Status.create(:name => 'Foo')
+      status.project = Project.create(:name => 'Bar')
+      status.changed?.should be_true
+      status.changed.should == %w(project_id)
+    end
+  end
+end

data/test/unit/test_finder_options.rb

@@ -75,53 +75,42 @@ class FinderOptionsTest < Test::Unit::TestCase
   
   context "ordering" do
     should "single field with ascending direction" do
-      hash = OrderedHash.new
-      hash[:foo] = 1
-      FinderOptions.to_mongo_options(:order => 'foo asc')[:sort].should == hash
-      FinderOptions.to_mongo_options(:order => 'foo ASC')[:sort].should == hash
+      sort = [['foo', 1]]
+      FinderOptions.to_mongo_options(:order => 'foo asc')[:sort].should == sort
+      FinderOptions.to_mongo_options(:order => 'foo ASC')[:sort].should == sort
     end
     
     should "single field with descending direction" do
-      hash = OrderedHash.new
-      hash[:foo] = -1
-      FinderOptions.to_mongo_options(:order => 'foo desc')[:sort].should == hash
-      FinderOptions.to_mongo_options(:order => 'foo DESC')[:sort].should == hash
+      sort = [['foo', -1]]
+      FinderOptions.to_mongo_options(:order => 'foo desc')[:sort].should == sort
+      FinderOptions.to_mongo_options(:order => 'foo DESC')[:sort].should == sort
     end
     
     should "convert field without direction to ascending" do
-      hash = OrderedHash.new
-      hash[:foo] = 1
-      FinderOptions.to_mongo_options(:order => 'foo')[:sort].should == hash
+      sort = [['foo', 1]]
+      FinderOptions.to_mongo_options(:order => 'foo')[:sort].should == sort
     end
     
     should "convert multiple fields with directions" do
-      hash = OrderedHash.new
-      hash[:foo] = -1
-      hash[:bar] = 1
-      hash[:baz] = -1
-      FinderOptions.to_mongo_options(:order => 'foo desc, bar asc, baz desc')[:sort].should == hash
+      sort = [['foo', -1], ['bar', 1], ['baz', -1]]
+      FinderOptions.to_mongo_options(:order => 'foo desc, bar asc, baz desc')[:sort].should == sort
     end
     
     should "convert multiple fields with some missing directions" do
-      hash = OrderedHash.new
-      hash[:foo] = -1
-      hash[:bar] = 1
-      hash[:baz] = 1
-      FinderOptions.to_mongo_options(:order => 'foo desc, bar, baz')[:sort].should == hash
+      sort = [['foo', -1], ['bar', 1], ['baz', 1]]
+      FinderOptions.to_mongo_options(:order => 'foo desc, bar, baz')[:sort].should == sort
     end
     
     should "just use sort if sort and order are present" do
-      FinderOptions.to_mongo_options(:sort => {'$natural' => 1}, :order => 'foo asc')[:sort].should == {
-        '$natural' => 1
-      }
+      sort = [['$natural', 1]]
+      FinderOptions.to_mongo_options(:sort => sort, :order => 'foo asc')[:sort].should == sort
     end
     
     should "convert natural in order to proper" do
-      hash = OrderedHash.new
-      hash[:'$natural'] = 1
-      FinderOptions.to_mongo_options(:order => '$natural asc')[:sort].should == hash
-      hash[:'$natural'] = -1
-      FinderOptions.to_mongo_options(:order => '$natural desc')[:sort].should == hash
+      sort = [['$natural', 1]]
+      FinderOptions.to_mongo_options(:order => '$natural asc')[:sort].should == sort
+      sort = [['$natural', -1]]
+      FinderOptions.to_mongo_options(:order => '$natural desc')[:sort].should == sort
     end
     
     should "work for natural order ascending" do

data/test/unit/test_key.rb

@@ -91,6 +91,15 @@ class KeyTest < Test::Unit::TestCase
     should "know if it is not a embedded_document" do
       Key.new(:name, String).embeddable?.should be_false
     end
+    
+    should "know if it is a number" do
+      Key.new(:age, Integer).number?.should be_true
+      Key.new(:age, Float).number?.should be_true
+    end
+    
+    should "know if it is not a number" do
+      Key.new(:age, String).number?.should be_false
+    end
   end
 
   context "setting a value with a custom type" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_mapper
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - John Nunemaker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-07 00:00:00 -04:00
+date: 2009-10-08 00:00:00 -04:00
 default_executable: mmconsole
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: "0.15"
+        version: 0.15.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: jnunemaker-validatable
@@ -91,6 +91,7 @@ files:
 - lib/mongo_mapper/associations/many_proxy.rb
 - lib/mongo_mapper/associations/proxy.rb
 - lib/mongo_mapper/callbacks.rb
+- lib/mongo_mapper/dirty.rb
 - lib/mongo_mapper/document.rb
 - lib/mongo_mapper/dynamic_finder.rb
 - lib/mongo_mapper/embedded_document.rb
@@ -119,6 +120,7 @@ files:
 - test/functional/test_associations.rb
 - test/functional/test_binary.rb
 - test/functional/test_callbacks.rb
+- test/functional/test_dirty.rb
 - test/functional/test_document.rb
 - test/functional/test_embedded_document.rb
 - test/functional/test_logger.rb
@@ -182,6 +184,7 @@ test_files:
 - test/functional/test_associations.rb
 - test/functional/test_binary.rb
 - test/functional/test_callbacks.rb
+- test/functional/test_dirty.rb
 - test/functional/test_document.rb
 - test/functional/test_embedded_document.rb
 - test/functional/test_logger.rb