mongo_mapper 0.5.6 → 0.5.7

data/lib/mongo_mapper/dynamic_finder.rb

@@ -14,7 +14,7 @@ module MongoMapper
     end
 
     protected
-      def match        
+      def match
         case method.to_s
           when /^find_(all_by|by)_([_a-zA-Z]\w*)$/
             @finder = :all if $1 == 'all_by'

data/lib/mongo_mapper/embedded_document.rb

@@ -332,9 +332,13 @@ module MongoMapper
         end
 
         def read_attribute(name)
-          value = _keys[name].get(instance_variable_get("@#{name}"))
-          instance_variable_set "@#{name}", value if !frozen?
-          value
+          if key = _keys[name]
+            value = key.get(instance_variable_get("@#{name}"))
+            instance_variable_set "@#{name}", value if !frozen?
+            value
+          else
+            raise KeyNotFound, "Could not find key: #{name.inspect}"
+          end
         end
 
         def read_attribute_before_typecast(name)

data/lib/mongo_mapper/finder_options.rb

@@ -1,66 +1,35 @@
 module MongoMapper
-  class FinderOptions    
-    def self.to_mongo_criteria(model, conditions, parent_key=nil)
-      criteria = {}
-      add_sci_scope(model, criteria)
-      
-      conditions.each_pair do |field, value|
-        field = field_normalized(field)
-        case value
-          when Array
-            operator_present = field.to_s =~ /^\$/            
-            criteria[field] = if operator_present
-                                value
-                              else
-                                {'$in' => value}
-                              end
-          when Hash
-            criteria[field] = to_mongo_criteria(model, value, field)
-          else            
-            criteria[field] = value
-        end
-      end
-      
-      criteria
+  # Controls the parsing and handling of options used by finders.
+  #
+  # == Important Note
+  #
+  # This class is private to MongoMapper and should not be considered part of 
+  # MongoMapper's public API. Some documentation herein, however, may prove 
+  # useful for understanding how MongoMapper handles the parsing of finder 
+  # conditions and options.
+  #
+  # @private
+  class FinderOperator
+    def initialize(field, operator)
+      @field, @operator = field, operator
     end
     
-    # adds _type single collection inheritance scope for models that need it
-    def self.add_sci_scope(model, criteria)
-      if model.single_collection_inherited?
-        criteria[:_type] = model.to_s
-      end
-    end
-        
-    def self.to_mongo_options(model, options)
-      options = options.dup
-      {
-        :fields => to_mongo_fields(options.delete(:fields) || options.delete(:select)),
-        :skip   => (options.delete(:skip) || options.delete(:offset) || 0).to_i,
-        :limit  => (options.delete(:limit) || 0).to_i,
-        :sort   => options.delete(:sort) || to_mongo_sort(options.delete(:order))
-      }
+    def to_criteria(value)
+      {@field => {@operator => value}}
     end
-    
-    def self.field_normalized(field)
-      if field.to_s == 'id'
-        :_id
-      else
-        field
-      end
-    end
-    
+  end
+  
+  class FinderOptions
     OptionKeys = [:fields, :select, :skip, :offset, :limit, :sort, :order]
-    
-    attr_reader :model, :options
-    
+
     def initialize(model, options)
-      raise ArgumentError, "FinderOptions must be a hash" unless options.is_a?(Hash)
-      
-      @model = model
-      
-      options = options.symbolize_keys
-      @options, @conditions = {}, options.delete(:conditions) || {}
+      raise ArgumentError, "Options must be a hash" unless options.is_a?(Hash)
+      options.symbolize_keys!
       
+      @model      = model
+      @options    = {}
+      @conditions = options.delete(:conditions) || {}
+
       options.each_pair do |key, value|
         if OptionKeys.include?(key)
           @options[key] = value
@@ -68,42 +37,94 @@ module MongoMapper
           @conditions[key] = value
         end
       end
+
+      add_sci_scope
     end
     
+    # @return [Hash] Mongo compatible criteria options
+    #
+    # @see FinderOptions#to_mongo_criteria
     def criteria
-      self.class.to_mongo_criteria(model, @conditions)
+      to_mongo_criteria(@conditions)
     end
     
+    # @return [Hash] Mongo compatible options
     def options
-      self.class.to_mongo_options(model, @options)
+      options = @options.dup
+
+      fields = options.delete(:fields) || options.delete(:select)
+      skip   = options.delete(:skip)   || options.delete(:offset) || 0
+      limit  = options.delete(:limit)  || 0
+      sort   = options.delete(:sort)   || convert_order_to_sort(options.delete(:order))
+
+      {:fields => to_mongo_fields(fields), :skip => skip.to_i, :limit => limit.to_i, :sort => sort}
     end
     
+    # @return [Array<Hash>] Mongo criteria and options enclosed in an Array
     def to_a
       [criteria, options]
     end
-    
+
     private
-      def self.to_mongo_fields(fields)
+      def to_mongo_criteria(conditions, parent_key=nil)
+        criteria = {}
+
+        conditions.each_pair do |field, value|
+          field = normalized_field(field)
+          if field.is_a?(FinderOperator)
+            criteria.merge!(field.to_criteria(value))
+            next
+          end
+          case value
+            when Array
+              operator_present = field.to_s =~ /^\$/
+              criteria[field] = operator?(field) ? value : {'$in' => value}
+            when Hash
+              criteria[field] = to_mongo_criteria(value, field)
+            else            
+              criteria[field] = value
+          end
+        end
+
+        criteria
+      end
+
+      def operator?(field)
+        field.to_s =~ /^\$/
+      end
+
+      def normalized_field(field)
+        field.to_s == 'id' ? :_id : field
+      end
+
+      # adds _type single collection inheritance scope for models that need it
+      def add_sci_scope
+        if @model.single_collection_inherited?
+          @conditions[:_type] = @model.to_s
+        end
+      end
+
+      def to_mongo_fields(fields)
         return if fields.blank?
-      
+
         if fields.is_a?(String)
           fields.split(',').map { |field| field.strip }
         else
           fields.flatten.compact
         end
       end
-    
-      def self.to_mongo_sort(sort)
+
+      def convert_order_to_sort(sort)
         return if sort.blank?
         pieces = sort.split(',')
         pieces.map { |s| to_mongo_sort_piece(s) }
       end
-    
-      def self.to_mongo_sort_piece(str)
+
+      def to_mongo_sort_piece(str)
         field, direction = str.strip.split(' ')
         direction ||= 'ASC'
         direction = direction.upcase == 'ASC' ? 1 : -1
         [field, direction]
       end
   end
-end
+end

data/lib/mongo_mapper/pagination.rb

@@ -30,6 +30,8 @@ module MongoMapper
       def skip
         (current_page - 1) * per_page
       end
+      alias offset skip # for will paginate support
+      
       
       def method_missing(name, *args, &block)
         @subject.send(name, *args, &block)

data/lib/mongo_mapper/serialization.rb

@@ -5,7 +5,7 @@ module MongoMapper #:nodoc:
     class Serializer #:nodoc:
       attr_reader :options
 
-      def initialize(record, options = {})
+      def initialize(record, options={})
         @record, @options = record, options.dup
       end
 
@@ -51,5 +51,4 @@ module MongoMapper #:nodoc:
   end
 end
 
-dir = Pathname(__FILE__).dirname.expand_path + 'serializers'
-require dir + 'json_serializer'
+require 'mongo_mapper/serializers/json_serializer'

data/lib/mongo_mapper/serializers/json_serializer.rb

@@ -49,7 +49,7 @@ module MongoMapper #:nodoc:
     #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
     #         "created_at": "2006/08/01", "awesome": true,
     #         "permalink": "1-konata-izumi"}
-    def to_json(options = {})
+    def to_json(options={})
       apply_to_json_defaults(options)
       
       if include_root_in_json

data/lib/mongo_mapper/support.rb

@@ -1,4 +1,5 @@
 class BasicObject #:nodoc:
+  alias_method :proxy_extend, :extend
   instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|^methods$|instance_eval|proxy_|^object_id$)/ }
 end unless defined?(BasicObject)
 
@@ -129,6 +130,14 @@ class String
   end
 end
 
+class Symbol
+  %w{gt lt gte lte ne in nin mod size where exists}.each do |operator|
+    define_method operator do
+      MongoMapper::FinderOperator.new(self, "$#{operator}")
+    end
+  end
+end
+
 class Time
   def self.to_mongo(value)
     if value.nil? || value == ''

data/lib/mongo_mapper/validations.rb

@@ -18,7 +18,9 @@ module MongoMapper
       option :scope
       
       def valid?(instance)
-        doc = instance.class.find(:first, :conditions => {self.attribute => instance[attribute]}.merge(scope_conditions(instance)), :limit => 1)
+        value = instance[attribute]
+        return true if allow_blank && value.blank?
+        doc = instance.class.first({self.attribute => value}.merge(scope_conditions(instance)))
         doc.nil? || instance.id == doc.id
       end
 

data/mongo_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongo_mapper}
-  s.version = "0.5.6"
+  s.version = "0.5.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-10-22}
+  s.date = %q{2009-10-28}
   s.default_executable = %q{mmconsole}
   s.description = %q{Awesome gem for modeling your domain and storing it in mongo}
   s.email = %q{nunemaker@gmail.com}
@@ -74,7 +74,7 @@ Gem::Specification.new do |s|
      "test/functional/test_validations.rb",
      "test/models.rb",
      "test/support/custom_matchers.rb",
-     "test/support/test_timing.rb",
+     "test/support/timing.rb",
      "test/test_helper.rb",
      "test/unit/serializers/test_json_serializer.rb",
      "test/unit/test_association_base.rb",
@@ -117,7 +117,7 @@ Gem::Specification.new do |s|
      "test/functional/test_validations.rb",
      "test/models.rb",
      "test/support/custom_matchers.rb",
-     "test/support/test_timing.rb",
+     "test/support/timing.rb",
      "test/test_helper.rb",
      "test/unit/serializers/test_json_serializer.rb",
      "test/unit/test_association_base.rb",

data/test/functional/associations/test_many_documents_as_proxy.rb

@@ -137,7 +137,7 @@ class ManyDocumentsAsProxyTest < Test::Unit::TestCase
       end
 
       should "work with conditions" do
-        comments = @post.comments.find(:all, :conditions => {:body => 'comment1'})
+        comments = @post.comments.find(:all, :body => 'comment1')
         comments.should == [@comment1]
       end
 
@@ -154,7 +154,7 @@ class ManyDocumentsAsProxyTest < Test::Unit::TestCase
       end
 
       should "work with conditions" do
-        comments = @post.comments.all(:conditions => {:body => 'comment1'})
+        comments = @post.comments.all(:body => 'comment1')
         comments.should == [@comment1]
       end
 

data/test/functional/associations/test_many_embedded_polymorphic_proxy.rb

@@ -129,4 +129,28 @@ class ManyEmbeddedPolymorphicProxyTest < Test::Unit::TestCase
       from_db.transports[2].icu.should == true
     end
   end
-end
+
+  context "extending the association" do
+    should "work using a block passed to many" do
+      catalog = Catalog.new
+      medias = catalog.medias = [
+        Video.new("file" => "video.mpg", "length" => 3600, :visible => true),
+        Music.new("file" => "music.mp3", "bitrate" => "128kbps", :visible => true),
+        Image.new("file" => "image.png", "width" => 800, "height" => 600, :visible => false)
+      ]
+      catalog.save
+      catalog.medias.visible.should == [medias[0], medias[1]]
+    end
+  
+    should "work using many's :extend option" do
+      fleet = TrModels::Fleet.new
+      transports = fleet.transports = [
+        TrModels::Car.new("license_plate" => "ABC1223", "model" => "Honda Civic", "year" => 2003, :purchased_on => 2.years.ago.to_date),
+        TrModels::Bus.new("license_plate" => "XYZ9090", "max_passengers" => 51, :purchased_on => 3.years.ago.to_date),
+        TrModels::Ambulance.new("license_plate" => "HDD3030", "icu" => true, :purchased_on => 1.year.ago.to_date)
+      ]
+      fleet.save
+      fleet.transports.to_be_replaced.should == [transports[1]]
+    end
+  end
+end

data/test/functional/associations/test_many_embedded_proxy.rb

@@ -171,4 +171,29 @@ class ManyEmbeddedProxyTest < Test::Unit::TestCase
     
     meg.pets.find(sparky.id).should == sparky
   end
+  
+  context "extending the association" do
+    should "work using a block passed to many" do
+      project = Project.new(:name => "Some Project")
+      addr1 = Address.new(:address => "Gate-3 Lankershim Blvd.", :city => "Universal City", :state => "CA", :zip => "91608")
+      addr2 = Address.new(:address => "3000 W. Alameda Ave.", :city => "Burbank", :state => "CA", :zip => "91523")
+      addr3 = Address.new(:address => "111 Some Ln", :city => "Nashville", :state => "TN", :zip => "37211")
+      project.addresses = [addr1, addr2, addr3]
+      project.save
+      project.addresses.find_all_by_state("CA").should == [addr1, addr2]
+    end
+  
+    should "work using many's :extend option" do
+      project = Project.new(:name => "Some Project")
+      person1 = Person.new(:name => "Steve")
+      person2 = Person.new(:name => "Betty")
+      person3 = Person.new(:name => "Cynthia")
+
+      project.people << person1
+      project.people << person2
+      project.people << person3
+      project.save
+      project.people.find_by_name("Steve").should == person1
+    end
+  end
 end

data/test/functional/associations/test_many_polymorphic_proxy.rb

@@ -4,6 +4,7 @@ require 'models'
 class ManyPolymorphicProxyTest < Test::Unit::TestCase
   def setup
     Room.collection.clear
+    Message.collection.clear
   end
   
   should "default reader to empty array" do
@@ -181,7 +182,7 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
       
       should "work with conditions" do
-        messages = @lounge.messages.find(:all, :conditions => {:body => 'Loungin!'}, :order => "position")
+        messages = @lounge.messages.find(:all, :body => 'Loungin!', :order => "position")
         messages.should == [@lm1]
       end
       
@@ -197,7 +198,7 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
       
       should "work with conditions" do
-        messages = @lounge.messages.all(:conditions => {:body => 'Loungin!'}, :order => "position")
+        messages = @lounge.messages.all(:body => 'Loungin!', :order => "position")
         messages.should == [@lm1]
       end
       
@@ -213,7 +214,7 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
       
       should "work with conditions" do
-        message = @lounge.messages.find(:first, :conditions => {:body => 'I love loungin!'}, :order => "position asc")
+        message = @lounge.messages.find(:first, :body => 'I love loungin!', :order => "position asc")
         message.should == @lm2
       end
     end
@@ -224,7 +225,7 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
       
       should "work with conditions" do
-        message = @lounge.messages.first(:conditions => {:body => 'I love loungin!'}, :order => "position asc")
+        message = @lounge.messages.first(:body => 'I love loungin!', :order => "position asc")
         message.should == @lm2
       end
     end
@@ -235,7 +236,7 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
       
       should "work with conditions" do
-        message = @lounge.messages.find(:last, :conditions => {:body => 'Loungin!'}, :order => "position asc")
+        message = @lounge.messages.find(:last, :body => 'Loungin!', :order => "position asc")
         message.should == @lm1
       end
     end
@@ -246,7 +247,7 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
       
       should "work with conditions" do
-        message = @lounge.messages.last(:conditions => {:body => 'Loungin!'}, :order => "position asc")
+        message = @lounge.messages.last(:body => 'Loungin!', :order => "position asc")
         message.should == @lm1
       end
     end
@@ -263,6 +264,20 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
     end
     
+    context "with query options/criteria" do
+      should "work with order on association" do
+        @lounge.messages.should == [@lm1, @lm2]
+      end
+      
+      should "allow overriding the order provided to the association" do
+        @lounge.messages.all(:order => 'position desc').should == [@lm2, @lm1]
+      end
+      
+      should "allow using conditions on association" do
+        @hall.latest_messages.should == [@hm3, @hm2]
+      end
+    end
+    
     context "with multiple ids" do
       should "work for ids in association" do
         messages = @lounge.messages.find(@lm1.id, @lm2.id)
@@ -294,4 +309,31 @@ class ManyPolymorphicProxyTest < Test::Unit::TestCase
       end
     end
   end
+  
+  context "extending the association" do
+    should "work using a block passed to many" do
+      room = Room.new(:name => "Amazing Room")
+      messages = room.messages = [
+        Enter.new(:body => 'John entered room',  :position => 3),
+        Chat.new(:body => 'Heyyyoooo!',          :position => 4),
+        Exit.new(:body => 'John exited room',    :position => 5),
+        Enter.new(:body => 'Steve entered room', :position => 6),
+        Chat.new(:body => 'Anyone there?',       :position => 7),
+        Exit.new(:body => 'Steve exited room',   :position => 8)
+      ]
+      room.save
+      room.messages.older.should == messages[3..5]
+    end
+  
+    should "work using many's :extend option" do
+      room = Room.new(:name => "Amazing Room")
+      accounts = room.accounts = [
+        Bot.new(:last_logged_in => 3.weeks.ago),
+        User.new(:last_logged_in => nil),
+        Bot.new(:last_logged_in => 1.week.ago)
+      ]
+      room.save
+      room.accounts.inactive.should == [accounts[1]]
+    end
+  end
 end