mongoid 1.0.0 → 1.0.1

data/HISTORY

@@ -1,3 +1,15 @@
+=== 1.0.1
+- Documents now have named_scopes similar to
+  ActiveRecord named scopes. Please see rdoc or
+  specs for examples.
+
+- Document#to_json properly works in all cases.
+
+- ActiveSupport calls for inflections have been
+  moved into the String::Inflections module.
+
+- Updated dependency on Validatable to 2.0.1
+
 === 1.0.0
 - Validations cleanup: Only before_validation and
   after_validation callbacks are supported now.

data/Rakefile

@@ -14,7 +14,7 @@ begin
 
     gem.add_dependency("activesupport", ">= 2.2.2")
     gem.add_dependency("mongo", ">= 0.18.2")
-    gem.add_dependency("durran-validatable", ">= 2.0.0")
+    gem.add_dependency("durran-validatable", ">= 2.0.1")
     gem.add_dependency("leshill-will_paginate", ">= 2.3.11")
 
     gem.add_development_dependency("rspec", ">= 1.2.9")

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/mongoid.rb

@@ -23,7 +23,7 @@ require "rubygems"
 
 gem "activesupport", ">= 2.2.2"
 gem "mongo", ">= 0.18.2"
-gem "durran-validatable", ">= 2.0.0"
+gem "durran-validatable", ">= 2.0.1"
 gem "leshill-will_paginate", ">= 2.3.11"
 
 require "delegate"
@@ -45,6 +45,7 @@ require "mongoid/commands"
 require "mongoid/config"
 require "mongoid/complex_criterion"
 require "mongoid/criteria"
+require "mongoid/named_scopes"
 require "mongoid/extensions"
 require "mongoid/errors"
 require "mongoid/fields/field"

data/lib/mongoid/components.rb

@@ -15,6 +15,7 @@ module Mongoid #:nodoc
         include Observable
         include Validatable
         extend Finders
+        extend NamedScopes
       end
     end
   end

data/lib/mongoid/criteria.rb

@@ -103,6 +103,23 @@ module Mongoid #:nodoc:
       @count ||= @klass.collection.find(@selector, process_options).count
     end
 
+    # Translate the supplied argument hash
+    #
+    # Options:
+    #
+    # criteria_conditions: Hash of criteria keys, and parameter values
+    #
+    # Example:
+    #
+    # <tt>criteria.translate(:where => { :field => "value"}, :limit => 20)</tt>
+    #
+    # Returns <tt>self</tt>
+    def criteria(criteria_conditions = {})
+      criteria_conditions.inject(self) do |criteria, (key, value)|
+        criteria.send(key, value)
+      end
+    end
+
     # Iterate over each +Document+ in the results. This can take an optional
     # block to pass to each argument in the results.
     #

data/lib/mongoid/document.rb

@@ -9,12 +9,13 @@ module Mongoid #:nodoc:
 
         cattr_accessor :_collection, :collection_name, :embedded, :primary_key
 
-        self.collection_name = self.to_s.underscore.tableize.gsub("/", "_")
+        self.embedded = false
+        self.collection_name = self.name.collectionize
 
         attr_accessor :association_name, :_parent
         attr_reader :attributes, :new_record
 
-        delegate :collection, :embedded?, :primary_key, :to => "self.class"
+        delegate :collection, :embedded, :primary_key, :to => "self.class"
       end
     end
 
@@ -25,28 +26,18 @@ module Mongoid #:nodoc:
       #
       # Returns: <tt>Mongo::Collection</tt>
       def collection
-        raise Errors::InvalidCollection.new(self) if embedded?
+        raise Errors::InvalidCollection.new(self) if embedded
         self._collection ||= Mongoid.database.collection(self.collection_name)
         add_indexes; self._collection
       end
 
-      # return true if the +Document+ is embedded in another +Documnet+. The
-      # embedded flag is set by declaring a belongs_to association.
-      #
-      # Example:
-      #
-      # <tt>Address.embedded?</tt>
-      def embedded?
-        self.embedded == true
-      end
-
       # Returns a human readable version of the class.
       #
       # Example:
       #
       # <tt>MixedDrink.human_name # returns "Mixed Drink"</tt>
       def human_name
-        name.underscore.humanize
+        name.labelize
       end
 
       # Instantiate a new object, only when loaded from the database or when
@@ -228,6 +219,17 @@ module Mongoid #:nodoc:
         [ self ]
       end
 
+      # Return this document as a JSON string. Nothing special is required here
+      # since Mongoid bubbles up all the child associations to the parent
+      # attribute +Hash+ using observers throughout the +Document+ lifecycle.
+      #
+      # Example:
+      #
+      # <tt>person.to_json</tt>
+      def to_json
+        @attributes.to_json
+      end
+
       # Returns the id of the Document, used in Rails compatibility.
       def to_param
         id
@@ -257,8 +259,7 @@ module Mongoid #:nodoc:
       protected
       def generate_key
         if primary_key
-          values = primary_key.collect { |key| @attributes[key] }
-          @attributes[:_id] = values.join(" ").parameterize.to_s
+          @attributes[:_id] = extract_keys.join(" ").identify
         else
           @attributes[:_id] = Mongo::ObjectID.new.to_s unless id
         end
@@ -268,6 +269,10 @@ module Mongoid #:nodoc:
         @attributes[:_type] ||= self.class.name
       end
 
+      def extract_keys
+        primary_key.collect { |key| @attributes[key] }.reject { |val| val.nil? }
+      end
+
     end
 
   end

data/lib/mongoid/extensions/string/inflections.rb

@@ -17,6 +17,18 @@ module Mongoid #:nodoc:
           "descending" => "ascending"
         }
 
+        def collectionize
+          tableize.gsub("/", "_")
+        end
+
+        def identify
+          gsub(" ", "_").gsub(/\W/, "").dasherize.downcase
+        end
+
+        def labelize
+          underscore.humanize
+        end
+
         def invert
           REVERSALS[self]
         end

data/lib/mongoid/named_scopes.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module NamedScopes
+    # Return the scopes or default to an empty +Hash+.
+    def scopes
+      read_inheritable_attribute(:scopes) || write_inheritable_attribute(:scopes, {})
+    end
+
+    # Creates a named_scope for the +Document+, similar to ActiveRecord's
+    # named_scopes. +NamedScopes+ are proxied +Criteria+ objects that can be
+    # chained.
+    #
+    # Example:
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     field :active, :type => Boolean
+    #     field :count, :type => Integer
+    #
+    #     named_scope :active, :where => { :active => true }
+    #     named_scope :count_gt_one, :where => { :count.gt => 1 }
+    #     named_scope :at_least_count, lambda { |count| { :where => { :count.gt => count } } }
+    #   end
+    def named_scope(name, options = {}, &block)
+      name = name.to_sym
+      scopes[name] = lambda do |parent_scope, *args|
+        CriteriaProxy.new(parent_scope, Hash === options ? options : options.call(*args), &block)
+      end
+      (class << self; self; end).class_eval <<-EOT
+        def #{name}(*args)
+          scopes[:#{name}].call(self, *args)
+        end
+      EOT
+    end
+
+    class CriteriaProxy #:nodoc
+      attr_accessor :conditions, :klass, :parent_scope
+
+      delegate :scopes, :to => :parent_scope
+
+      # Instantiate the new +CriteriaProxy+. If the conditions contains an
+      # extension, the proxy will extend from that module. If a block is given
+      # it will be extended as well.
+      #
+      # Example:
+      #
+      # <tt>CriteriaProxy.new(parent, :where => { :active => true })</tt>
+      def initialize(parent_scope, conditions, &block)
+        conditions ||= {}
+        [ conditions.delete(:extend) ].flatten.each do |extension|
+          extend extension
+        end if conditions.include?(:extend)
+        extend Module.new(&block) if block_given?
+        self.klass = parent_scope unless CriteriaProxy === parent_scope
+        self.parent_scope, self.conditions = parent_scope, conditions
+      end
+
+      # First check if the proxy has the scope defined, otherwise look to the
+      # parent scope.
+      def respond_to?(method, include_private = false)
+        super || if klass
+          proxy_found.respond_to?(method, include_private)
+        else
+          parent_scope.respond_to?(method, include_private)
+        end
+      end
+
+      protected
+
+      def proxy_found
+        @found || load_found
+      end
+
+      private
+
+      def method_missing(method, *args, &block)
+        if scopes.include?(method)
+          scopes[method].call(self, *args)
+        elsif klass
+          proxy_found.send(method, *args, &block)
+        else
+          parent_scope.criteria(conditions)
+          parent_scope.send(method, *args, &block)
+        end
+      end
+
+      def load_found
+        @found = Criteria.new(klass)
+        @found.criteria(conditions); @found
+      end
+    end
+  end
+end
+

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2010-01-09}
+  s.date = %q{2010-01-10}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -73,6 +73,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/finders.rb",
      "lib/mongoid/indexes.rb",
      "lib/mongoid/memoization.rb",
+     "lib/mongoid/named_scopes.rb",
      "lib/mongoid/timestamps.rb",
      "lib/mongoid/versioning.rb",
      "mongoid.gemspec",
@@ -83,6 +84,7 @@ Gem::Specification.new do |s|
      "spec/integration/mongoid/document_spec.rb",
      "spec/integration/mongoid/finders_spec.rb",
      "spec/integration/mongoid/inheritance_spec.rb",
+     "spec/integration/mongoid/named_scopes_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/unit/mongoid/associations/belongs_to_related_spec.rb",
@@ -130,6 +132,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/finders_spec.rb",
      "spec/unit/mongoid/indexes_spec.rb",
      "spec/unit/mongoid/memoization_spec.rb",
+     "spec/unit/mongoid/named_scopes_spec.rb",
      "spec/unit/mongoid/timestamps_spec.rb",
      "spec/unit/mongoid/versioning_spec.rb",
      "spec/unit/mongoid_spec.rb"
@@ -146,6 +149,7 @@ Gem::Specification.new do |s|
      "spec/integration/mongoid/document_spec.rb",
      "spec/integration/mongoid/finders_spec.rb",
      "spec/integration/mongoid/inheritance_spec.rb",
+     "spec/integration/mongoid/named_scopes_spec.rb",
      "spec/spec_helper.rb",
      "spec/unit/mongoid/associations/belongs_to_related_spec.rb",
      "spec/unit/mongoid/associations/belongs_to_spec.rb",
@@ -192,6 +196,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/finders_spec.rb",
      "spec/unit/mongoid/indexes_spec.rb",
      "spec/unit/mongoid/memoization_spec.rb",
+     "spec/unit/mongoid/named_scopes_spec.rb",
      "spec/unit/mongoid/timestamps_spec.rb",
      "spec/unit/mongoid/versioning_spec.rb",
      "spec/unit/mongoid_spec.rb"
@@ -204,14 +209,14 @@ 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.2.2"])
       s.add_runtime_dependency(%q<mongo>, [">= 0.18.2"])
-      s.add_runtime_dependency(%q<durran-validatable>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<durran-validatable>, [">= 2.0.1"])
       s.add_runtime_dependency(%q<leshill-will_paginate>, [">= 2.3.11"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.2.2"])
       s.add_dependency(%q<mongo>, [">= 0.18.2"])
-      s.add_dependency(%q<durran-validatable>, [">= 2.0.0"])
+      s.add_dependency(%q<durran-validatable>, [">= 2.0.1"])
       s.add_dependency(%q<leshill-will_paginate>, [">= 2.3.11"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<mocha>, [">= 0.9.8"])
@@ -219,7 +224,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<activesupport>, [">= 2.2.2"])
     s.add_dependency(%q<mongo>, [">= 0.18.2"])
-    s.add_dependency(%q<durran-validatable>, [">= 2.0.0"])
+    s.add_dependency(%q<durran-validatable>, [">= 2.0.1"])
     s.add_dependency(%q<leshill-will_paginate>, [">= 2.3.11"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<mocha>, [">= 0.9.8"])

data/spec/integration/mongoid/document_spec.rb

@@ -457,6 +457,34 @@ describe Mongoid::Document do
 
   end
 
+  describe "#to_json" do
+
+    before do
+      @person = Person.new(:title => "Sir", :age => 30)
+      @address = Address.new(:street => "Nan Jing Dong Lu")
+      @person.addresses << @address
+    end
+
+    context "on a new document" do
+
+      it "returns the json string" do
+        @person.to_json.should == @person.attributes.to_json
+      end
+
+    end
+
+    context "on a persisted document" do
+
+      it "returns the json string" do
+        @person.save
+        from_db = Person.find(@person.id)
+        from_db.to_json.should == from_db.attributes.to_json
+      end
+
+    end
+
+  end
+
   context "typecasting" do
 
     before do

data/spec/integration/mongoid/inheritance_spec.rb

@@ -11,7 +11,7 @@ describe Mongoid::Document do
 
     it "saves in the same collection as the root" do
       collection = Mongoid.database.collection("canvases")
-      attributes = collection.find({ :name => "Test"}, {}).first
+      attributes = collection.find({ :name => "Test"}, {}).next_document
       attributes["version"].should == 3
       attributes["name"].should == "Test"
       attributes["_type"].should == "Browser"
@@ -29,7 +29,7 @@ describe Mongoid::Document do
 
     it "saves in the same collection as the root" do
       collection = Mongoid.database.collection("canvases")
-      attributes = collection.find({ :name => "Testy"}, {}).first
+      attributes = collection.find({ :name => "Testy"}, {}).next_document
       attributes["version"].should == 2
       attributes["name"].should == "Testy"
       attributes["_type"].should == "Firefox"

data/spec/integration/mongoid/named_scopes_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Mongoid::NamedScopes do
+
+  describe ".named_scope" do
+
+    class Person
+      named_scope :doctors, {:where => {:title => 'Dr.'}}
+    end
+
+    before do
+      @document = Person.create(:title => "Dr.")
+    end
+
+    after do
+      Person.delete_all
+    end
+
+    it "returns the document" do
+      Person.doctors.first.should == @document
+    end
+
+  end
+
+end

data/spec/unit/mongoid/commands_spec.rb

@@ -215,6 +215,7 @@ describe Mongoid::Commands do
     end
 
     it "runs the validation callbacks" do
+      @comment.expects(:run_callbacks).with(:validate)
       @comment.expects(:run_callbacks).with(:before_validation)
       @comment.expects(:run_callbacks).with(:after_validation)
       @comment.valid?

data/spec/unit/mongoid/criteria_spec.rb

@@ -1129,4 +1129,17 @@ describe Mongoid::Criteria do
 
   end
 
+  context "#criteria" do
+
+    it ":where => {:title => 'Test'} returns a criteria with the correct selector" do
+      @result = @criteria.criteria(:where => { :title => 'Test' })
+      @result.selector[:title].should == 'Test'
+    end
+
+    it ":where => {:title => 'Test'}, :skip => 10 returns a criteria with the correct selector and options" do
+      @result = @criteria.criteria(:where => { :title => 'Test' }, :skip => 10)
+      @result.selector[:title].should == 'Test'
+      @result.options.should == { :skip => 10 }
+    end
+  end
 end

data/spec/unit/mongoid/document_spec.rb

@@ -164,12 +164,12 @@ describe Mongoid::Document do
 
   end
 
-  describe ".embedded?" do
+  describe ".embedded" do
 
     context "when the document is embedded" do
 
       it "returns true" do
-        Address.embedded?.should be_true
+        Address.embedded.should be_true
       end
 
     end
@@ -177,7 +177,7 @@ describe Mongoid::Document do
     context "when the document is not embedded" do
 
       it "returns false" do
-        Person.embedded?.should be_false
+        Person.embedded.should be_false
       end
 
     end
@@ -190,7 +190,7 @@ describe Mongoid::Document do
 
       it "returns true" do
         address = Address.new
-        address.embedded?.should be_true
+        address.embedded.should be_true
       end
 
     end
@@ -199,7 +199,7 @@ describe Mongoid::Document do
 
       it "returns false" do
         person = Person.new
-        person.embedded?.should be_false
+        person.embedded.should be_false
       end
 
     end
@@ -208,7 +208,7 @@ describe Mongoid::Document do
 
       it "returns true" do
         circle = Circle.new
-        circle.should be_embedded
+        circle.embedded.should be_true
       end
 
     end

data/spec/unit/mongoid/extensions/string/inflections_spec.rb

@@ -2,6 +2,42 @@ require "spec_helper"
 
 describe Mongoid::Extensions::String::Inflections do
 
+  describe "#collectionize" do
+
+    context "when class is namepaced" do
+
+      it "returns an underscored tableized name" do
+        Medical::Patient.name.collectionize.should == "medical_patients"
+      end
+
+    end
+
+    context "when class is not namespaced" do
+
+      it "returns an underscored tableized name" do
+        MixedDrink.name.collectionize.should == "mixed_drinks"
+      end
+
+    end
+
+  end
+
+  describe "#identify" do
+
+    it "converts the string to all lowercase and dashed" do
+      "A Midnight Summer Night's Dream".identify.should == "a-midnight-summer-nights-dream"
+    end
+
+  end
+
+  describe "#labelize" do
+
+    it "returns the underscored name humanized" do
+      MixedDrink.name.labelize.should == "Mixed drink"
+    end
+
+  end
+
   describe "#singular?" do
 
     context "when singular" do

data/spec/unit/mongoid/named_scopes_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe Mongoid::NamedScopes do
+
+  context "AR2 scopes" do
+    module Extension
+      def extension_module_method
+        "extension module method"
+      end
+    end
+
+    class NamedScopeTest
+      include Mongoid::Document
+
+      field :active, :type => Boolean
+      field :count, :type => Integer
+
+      named_scope :active, :where => {:active => true} do
+        def extension_method
+          "extension method"
+        end
+      end
+      named_scope :count_gt_one, :where => { :count.gt => 1 }, :extend => Extension
+      named_scope :at_least_count, lambda { |count| { :where => { :count.gt => count } } }
+    end
+
+    context ".named_scope" do
+      it "adds the named scope to the hash of scopes" do
+        NamedScopeTest.scopes.should have_key(:active)
+      end
+
+      it "creates a class method for the named scope" do
+        NamedScopeTest.should respond_to(:active)
+      end
+    end
+
+    context "accessing a named scope" do
+      it "is a criteria proxy" do
+        Mongoid::NamedScopes::CriteriaProxy.should === NamedScopeTest.active
+      end
+
+      it "responds like a criteria" do
+        NamedScopeTest.active.should respond_to(:selector)
+      end
+
+      it "instantiates the criteria" do
+        criteria = Mongoid::Criteria.new(NamedScopeTest)
+        Mongoid::Criteria.expects(:new).returns(criteria)
+        NamedScopeTest.active.selector
+      end
+
+      it "has set the conditions on the criteria" do
+        NamedScopeTest.active.selector[:active].should be_true
+      end
+
+      it "sets the association extension by block" do
+        NamedScopeTest.active.extension_method.should == "extension method"
+      end
+
+      it "sets the association extension by :extend" do
+        NamedScopeTest.count_gt_one.extension_module_method.should == "extension module method"
+      end
+
+      context "when using a lambda" do
+        it "accepts parameters to the criteria" do
+          NamedScopeTest.at_least_count(3).selector[:count].should == {'$gt' => 3}
+        end
+      end
+    end
+
+    context "chained scopes" do
+      it "instantiates the criteria" do
+        criteria = Mongoid::Criteria.new(NamedScopeTest)
+        Mongoid::Criteria.expects(:new).returns(criteria)
+        NamedScopeTest.active.count_gt_one.selector
+      end
+
+      it "merges the criteria" do
+        selector = NamedScopeTest.active.count_gt_one.selector
+        selector[:count].should == {'$gt' => 1}
+        selector[:active].should be_true
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 -05:00
+date: 2010-01-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: 2.0.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: leshill-will_paginate
@@ -139,6 +139,7 @@ files:
 - lib/mongoid/finders.rb
 - lib/mongoid/indexes.rb
 - lib/mongoid/memoization.rb
+- lib/mongoid/named_scopes.rb
 - lib/mongoid/timestamps.rb
 - lib/mongoid/versioning.rb
 - mongoid.gemspec
@@ -149,6 +150,7 @@ files:
 - spec/integration/mongoid/document_spec.rb
 - spec/integration/mongoid/finders_spec.rb
 - spec/integration/mongoid/inheritance_spec.rb
+- spec/integration/mongoid/named_scopes_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/unit/mongoid/associations/belongs_to_related_spec.rb
@@ -196,6 +198,7 @@ files:
 - spec/unit/mongoid/finders_spec.rb
 - spec/unit/mongoid/indexes_spec.rb
 - spec/unit/mongoid/memoization_spec.rb
+- spec/unit/mongoid/named_scopes_spec.rb
 - spec/unit/mongoid/timestamps_spec.rb
 - spec/unit/mongoid/versioning_spec.rb
 - spec/unit/mongoid_spec.rb
@@ -234,6 +237,7 @@ test_files:
 - spec/integration/mongoid/document_spec.rb
 - spec/integration/mongoid/finders_spec.rb
 - spec/integration/mongoid/inheritance_spec.rb
+- spec/integration/mongoid/named_scopes_spec.rb
 - spec/spec_helper.rb
 - spec/unit/mongoid/associations/belongs_to_related_spec.rb
 - spec/unit/mongoid/associations/belongs_to_spec.rb
@@ -280,6 +284,7 @@ test_files:
 - spec/unit/mongoid/finders_spec.rb
 - spec/unit/mongoid/indexes_spec.rb
 - spec/unit/mongoid/memoization_spec.rb
+- spec/unit/mongoid/named_scopes_spec.rb
 - spec/unit/mongoid/timestamps_spec.rb
 - spec/unit/mongoid/versioning_spec.rb
 - spec/unit/mongoid_spec.rb