mongo_mapper-unstable 2009.10.16 → 2009.10.31

data/lib/mongo_mapper/finder_options.rb

@@ -1,55 +1,35 @@
 module MongoMapper
-  class FinderOptions
-    attr_reader :options
-    
-    def self.to_mongo_criteria(conditions, parent_key=nil)
-      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(value, field)
-          else            
-            criteria[field] = value
-        end
-      end
-      
-      criteria
-    end
-        
-    def self.to_mongo_options(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))
-      }
+  # 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
     
-    def self.field_normalized(field)
-      if field.to_s == 'id'
-        :_id
-      else
-        field
-      end
+    def to_criteria(value)
+      {@field => {@operator => value}}
     end
-    
+  end
+  
+  class FinderOptions
     OptionKeys = [:fields, :select, :skip, :offset, :limit, :sort, :order]
-    
-    def initialize(options)
-      raise ArgumentError, "FinderOptions must be a hash" unless options.is_a?(Hash)
-      
-      options = options.symbolize_keys
-      @options, @conditions = {}, options.delete(:conditions) || {}
+
+    def initialize(model, options)
+      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
@@ -57,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(@conditions)
+      to_mongo_criteria(@conditions)
     end
     
+    # @return [Hash] Mongo compatible options
     def options
-      self.class.to_mongo_options(@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

@@ -4,65 +4,37 @@ module MongoMapper
       def validates_uniqueness_of(*args)
         add_validations(args, MongoMapper::Validations::ValidatesUniquenessOf)
       end
-
-      def validates_exclusion_of(*args)
-        add_validations(args, MongoMapper::Validations::ValidatesExclusionOf)
-      end
-
-      def validates_inclusion_of(*args)
-        add_validations(args, MongoMapper::Validations::ValidatesInclusionOf)
-      end
     end
     
     class ValidatesUniquenessOf < Validatable::ValidationBase
-      option :scope
-      
+      option :scope, :case_sensitive
+      default :case_sensitive => true
+
       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?
+        base_conditions = case_sensitive ? {self.attribute => value} : {}
+        doc = instance.class.first(base_conditions.merge(scope_conditions(instance)).merge(where_conditions(instance)))
         doc.nil? || instance.id == doc.id
       end
 
       def message(instance)
         super || "has already been taken"
       end
-      
+
       def scope_conditions(instance)
         return {} unless scope
         Array(scope).inject({}) do |conditions, key|
           conditions.merge(key => instance[key])
         end
       end
-    end
-    
-    class ValidatesExclusionOf < Validatable::ValidationBase
-      required_option :within
-      
-      def valid?(instance)
-        value = instance[attribute]
-        return true if allow_nil && value.nil?
-        return true if allow_blank && value.blank?
-        
-        !within.include?(instance[attribute])
-      end
-      
-      def message(instance)
-        super || "is reserved"
-      end
-    end
 
-    class ValidatesInclusionOf < Validatable::ValidationBase
-      required_option :within
-      
-      def valid?(instance)
-        value = instance[attribute]
-        return true if allow_nil && value.nil?
-        return true if allow_blank && value.blank?
-        
-        within.include?(value)
-      end
-      
-      def message(instance)
-        super || "is not in the list"
+      def where_conditions(instance)
+        conditions = {}
+        unless case_sensitive
+          conditions.merge!({'$where' => "this.#{attribute}.toLowerCase() == '#{instance[attribute].downcase}'"})
+        end
+        conditions
       end
     end
   end

data/lib/mongo_mapper.rb

@@ -1,16 +1,19 @@
-require 'rubygems'
-
-gem 'activesupport', '>= 2.3'
-gem 'mongo', '0.15.1'
-gem 'jnunemaker-validatable', '1.7.4'
-
-require 'activesupport'
+require 'active_support'
 require 'mongo'
 require 'validatable'
 
 module MongoMapper
-  DocumentNotFound  = Class.new(StandardError)
-  DocumentNotValid  = Class.new(StandardError) do
+  # generic MM error
+  class MongoMapperError < StandardError; end
+  
+  # raised when key expected to exist but not found
+  class KeyNotFound < MongoMapperError; end
+  
+  # raised when document expected but not found
+  class DocumentNotFound < MongoMapperError; end
+  
+  # raised when document not valid and using !
+  class DocumentNotValid < MongoMapperError
     def initialize(document)
       @document = document
       super("Validation failed: #{@document.errors.full_messages.join(", ")}")
@@ -60,13 +63,12 @@ module MongoMapper
   module Finders
     def dynamic_find(finder, args)
       attributes = {}
-      find_options = args.extract_options!.deep_merge(:conditions => attributes)
-
       finder.attributes.each_with_index do |attr, index|
         attributes[attr] = args[index]
       end
-
-      result = find(finder.finder, find_options)
+      
+      options = args.extract_options!.merge(attributes)
+      result  = find(finder.finder, options)
 
       if result.nil?
         if finder.bang

data/mongo_mapper.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{mongo_mapper}
-  s.version = "0.5.5"
+  s.version = "0.5.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-10-16}
+  s.date = %q{2009-10-29}
   s.default_executable = %q{mmconsole}
   s.email = %q{nunemaker@gmail.com}
   s.executables = ["mmconsole"]
@@ -73,7 +73,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",
@@ -94,7 +94,6 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jnunemaker/mongomapper}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{mongomapper}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Awesome gem for modeling your domain and storing it in mongo}
   s.test_files = [
@@ -117,7 +116,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",
@@ -142,16 +141,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3"])
-      s.add_runtime_dependency(%q<mongo>, ["= 0.15.1"])
-      s.add_runtime_dependency(%q<jnunemaker-validatable>, ["= 1.7.4"])
+      s.add_runtime_dependency(%q<mongo>, ["= 0.16"])
+      s.add_runtime_dependency(%q<jnunemaker-validatable>, ["= 1.8.0"])
       s.add_development_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
       s.add_development_dependency(%q<shoulda>, ["= 2.10.2"])
       s.add_development_dependency(%q<timecop>, ["= 0.3.1"])
       s.add_development_dependency(%q<mocha>, ["= 0.9.4"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.3"])
-      s.add_dependency(%q<mongo>, ["= 0.15.1"])
-      s.add_dependency(%q<jnunemaker-validatable>, ["= 1.7.4"])
+      s.add_dependency(%q<mongo>, ["= 0.16"])
+      s.add_dependency(%q<jnunemaker-validatable>, ["= 1.8.0"])
       s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
       s.add_dependency(%q<shoulda>, ["= 2.10.2"])
       s.add_dependency(%q<timecop>, ["= 0.3.1"])
@@ -159,11 +158,12 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.3"])
-    s.add_dependency(%q<mongo>, ["= 0.15.1"])
-    s.add_dependency(%q<jnunemaker-validatable>, ["= 1.7.4"])
+    s.add_dependency(%q<mongo>, ["= 0.16"])
+    s.add_dependency(%q<jnunemaker-validatable>, ["= 1.8.0"])
     s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
     s.add_dependency(%q<shoulda>, ["= 2.10.2"])
     s.add_dependency(%q<timecop>, ["= 0.3.1"])
     s.add_dependency(%q<mocha>, ["= 0.9.4"])
   end
 end
+

data/specs.watchr

@@ -4,7 +4,7 @@ def run(cmd)
 end
 
 def run_test_file(file)
-  run "ruby -Itest #{file}"
+  run %Q(ruby -I"lib:test" -rubygems #{file})
 end
 
 def run_all_tests
@@ -12,7 +12,7 @@ def run_all_tests
 end
 
 def related_test_files(path)
-  Dir['test/**/*.rb'].select { |file| file =~ /#{File.basename(path)}/ }
+  Dir['test/**/*.rb'].select { |file| file =~ /test_#{File.basename(path)}/ }
 end
 
 watch('test/test_helper\.rb') { run_all_tests }

data/test/functional/associations/test_belongs_to_polymorphic_proxy.rb

@@ -3,8 +3,8 @@ require 'models'
 
 class BelongsToPolymorphicProxyTest < Test::Unit::TestCase
   def setup
-    Status.collection.clear
-    Project.collection.clear
+    Status.collection.remove
+    Project.collection.remove
   end
   
   should "default to nil" do
@@ -14,7 +14,7 @@ class BelongsToPolymorphicProxyTest < Test::Unit::TestCase
   end
 
   should "be able to replace the association" do
-    status = Status.new
+    status = Status.new(:name => 'Foo!')
     project = Project.new(:name => "mongomapper")
     status.target = project
     status.save.should be_true
@@ -27,7 +27,7 @@ class BelongsToPolymorphicProxyTest < Test::Unit::TestCase
   end
 
   should "unset the association" do
-    status = Status.new
+    status = Status.new(:name => 'Foo!')
     project = Project.new(:name => "mongomapper")
     status.target = project
     status.save.should be_true
@@ -41,7 +41,7 @@ class BelongsToPolymorphicProxyTest < Test::Unit::TestCase
   
   context "association id set but document not found" do
     setup do
-      @status = Status.new
+      @status = Status.new(:name => 'Foo!')
       project = Project.new(:name => "mongomapper")
       @status.target = project
       @status.save.should be_true

data/test/functional/associations/test_belongs_to_proxy.rb

@@ -2,48 +2,46 @@ require 'test_helper'
 require 'models'
 
 class BelongsToProxyTest < Test::Unit::TestCase
-  def setup
-    Status.collection.clear
-    Project.collection.clear
+  def setup    
+    @post_class = Class.new do
+      include MongoMapper::Document
+    end
+    
+    @comment_class = Class.new do
+      include MongoMapper::Document
+      key :post_id, String
+    end
+    @comment_class.belongs_to :post, :class => @post_class
+    
+    @post_class.collection.remove
+    @comment_class.collection.remove
   end
   
   should "default to nil" do
-    status = Status.new
-    status.project.nil?.should == true
-    status.project.inspect.should == 'nil'
+    @comment_class.new.post.nil?.should be_true
   end
   
   should "be able to replace the association" do
-    status = Status.new
-    project = Project.new(:name => "mongomapper")
-    status.project = project
-    status.save.should be_true
+    post = @post_class.new(:name => 'mongomapper')
+    comment = @comment_class.new(:name => 'Foo!', :post => post)
+    comment.save.should be_true
     
-    from_db = Status.find(status.id)
-    from_db.project.nil?.should be_false
-    from_db.project.name.should == "mongomapper"
+    comment = comment.reload
+    comment.post.should == post
+    comment.post.nil?.should be_false
   end
   
   should "unset the association" do
-    status = Status.new
-    project = Project.new(:name => "mongomapper")
-    status.project = project
-    status.save.should be_true
+    post = @post_class.new(:name => 'mongomapper')
+    comment = @comment_class.new(:name => 'Foo!', :post => post)
+    comment.save.should be_true
     
-    from_db = Status.find(status.id)
-    from_db.project = nil
-    from_db.project.nil?.should be_true
-    from_db.project.inspect.should == 'nil'
+    comment = comment.reload
+    comment.post = nil
+    comment.post.nil?.should be_true
   end
   
-  context "association id set but document not found" do
-    setup do
-      @status = Status.new(:name => 'Foo', :project_id => '1234')
-    end
-
-    should "return nil instead of raising error" do
-      @status.project.nil?.should be_true
-      @status.project.inspect.should == 'nil'
-    end
+  should "return nil if id set but document not found" do
+    @comment_class.new(:name => 'Foo', :post_id => '1234').post.nil?.should be_true
   end
 end

data/test/functional/associations/test_many_documents_as_proxy.rb

@@ -3,8 +3,8 @@ require 'models'
 
 class ManyDocumentsAsProxyTest < Test::Unit::TestCase
   def setup
-    Post.collection.clear
-    PostComment.collection.clear
+    Post.collection.remove
+    PostComment.collection.remove
   end
 
   should "default reader to empty array" do
@@ -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

@@ -3,8 +3,8 @@ require 'models'
 
 class ManyEmbeddedPolymorphicProxyTest < Test::Unit::TestCase
   def setup
-    Catalog.collection.clear
-    TrModels::Fleet.collection.clear
+    Catalog.collection.remove
+    TrModels::Fleet.collection.remove
   end
   
   should "default reader to empty array" do
@@ -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