mongoid 1.1.4 → 1.2.0

data/lib/mongoid/criterion/exclusion.rb

@@ -19,6 +19,8 @@ module Mongoid #:nodoc:
       #
       # Returns: <tt>self</tt>
       def excludes(attributes = {})
+        mongo_id = attributes.delete(:id)
+        attributes = attributes.merge(:_id => mongo_id) if mongo_id
         update_selector(attributes, "$ne")
       end
 

data/lib/mongoid/criterion/optional.rb

@@ -54,8 +54,8 @@ module Mongoid #:nodoc:
       # Returns the offset option. If a per_page option is in the list then it
       # will replace it with a skip parameter and return the same value. Defaults
       # to 20 if nothing was provided.
-      def offset
-        @options[:skip]
+      def offset(*args)
+        args.size > 0 ? skip(args.first) : @options[:skip]
       end
 
       # Adds a criterion to the +Criteria+ that specifies the sort order of

data/lib/mongoid/cursor.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  class Cursor
+    include Enumerable
+    # Operations on the Mongo::Cursor object that will not get overriden by the
+    # Mongoid::Cursor are defined here.
+    OPERATIONS = [
+      :admin,
+      :close,
+      :closed?,
+      :count,
+      :explain,
+      :fields,
+      :full_collection_name,
+      :hint,
+      :limit,
+      :order,
+      :query_options_hash,
+      :query_opts,
+      :selector,
+      :skip,
+      :snapshot,
+      :sort,
+      :timeout
+    ]
+
+    attr_reader :collection
+
+    # The operations above will all delegate to the proxied Mongo::Cursor.
+    #
+    # Example:
+    #
+    # <tt>cursor.close</tt>
+    OPERATIONS.each do |name|
+      define_method(name) { |*args| @cursor.send(name, *args) }
+    end
+
+    # Iterate over each document in the cursor and yield to it.
+    #
+    # Example:
+    #
+    # <tt>cursor.each { |doc| p doc.title }</tt>
+    def each
+      @cursor.each do |document|
+        yield Mongoid::Factory.build(document)
+      end
+    end
+
+    # Create the new +Mongoid::Cursor+.
+    #
+    # Options:
+    #
+    # collection: The Mongoid::Collection instance.
+    # cursor: The Mongo::Cursor to be proxied.
+    #
+    # Example:
+    #
+    # <tt>Mongoid::Cursor.new(collection, cursor)</tt>
+    def initialize(collection, cursor)
+      @collection, @cursor = collection, cursor
+    end
+
+    # Return the next document in the cursor. Will instantiate a new Mongoid
+    # document with the attributes.
+    #
+    # Example:
+    #
+    # <tt>cursor.next_document</tt>
+    def next_document
+      Mongoid::Factory.build(@cursor.next_document)
+    end
+
+    # Returns an array of all the documents in the cursor.
+    #
+    # Example:
+    #
+    # <tt>cursor.to_a</tt>
+    def to_a
+      @cursor.to_a.collect { |attrs| Mongoid::Factory.build(attrs) }
+    end
+  end
+end

data/lib/mongoid/document.rb

@@ -33,7 +33,7 @@ module Mongoid #:nodoc:
       # Returns: <tt>Mongo::Collection</tt>
       def collection
         raise Errors::InvalidCollection.new(self) if embedded
-        self._collection ||= Mongoid.database.collection(self.collection_name)
+        self._collection ||= Mongoid::Collection.new(self.collection_name)
         add_indexes; self._collection
       end
 
@@ -94,7 +94,7 @@ module Mongoid #:nodoc:
       # <tt>Person.store_in :populdation</tt>
       def store_in(name)
         self.collection_name = name.to_s
-        self._collection = Mongoid.database.collection(name.to_s)
+        self._collection = Mongoid::Collection.new(name.to_s)
       end
 
       # Returns all types to query for when using this class as the base.
@@ -170,14 +170,6 @@ module Mongoid #:nodoc:
         identify
       end
 
-      # apply default values to attributes - calling procs as required
-      def attributes_with_defaults(attributes = {})
-        default_values = defaults.merge(attributes)
-        default_values.each_pair do |key, val|
-          default_values[key] = val.call if val.respond_to?(:call)
-        end
-      end
-
       # Returns the class name plus its attributes.
       def inspect
         attrs = fields.map { |name, field| "#{name}: #{@attributes[name].inspect}" } * ", "
@@ -262,7 +254,7 @@ module Mongoid #:nodoc:
       # Example:
       #
       # <tt>person.to_json</tt>
-      def to_json(options=nil)
+      def to_json(options = nil)
         attributes.to_json(options)
       end
 
@@ -292,8 +284,15 @@ module Mongoid #:nodoc:
         clear ? @attributes.delete(name) : @attributes.insert(name, attrs)
         notify
       end
-    end
 
+      protected
+      # apply default values to attributes - calling procs as required
+      def attributes_with_defaults(attributes = {})
+        default_values = defaults.merge(attributes)
+        default_values.each_pair do |key, val|
+          default_values[key] = val.call if val.respond_to?(:call)
+        end
+      end
+    end
   end
-
 end

data/lib/mongoid/errors.rb

@@ -3,7 +3,12 @@ module Mongoid #:nodoc
   module Errors #:nodoc
 
     # Raised when querying the database for a document by a specific id which
-    # does not exist.
+    # does not exist. If multiple ids were passed then it will display all of
+    # those.
+    #
+    # Example:
+    #
+    # <tt>DocumentNotFound.new(Person, ["1", "2"])</tt>
     class DocumentNotFound < RuntimeError
       def initialize(klass, ids)
         @klass, @identifier = klass, ids.is_a?(Array) ? ids.join(", ") : ids
@@ -14,12 +19,34 @@ module Mongoid #:nodoc
     end
 
     # Raised when invalid options are passed into a constructor or method.
+    #
+    # Example:
+    #
+    # <tt>InvalidOptions.new</tt>
     class InvalidOptions < RuntimeError; end
 
-    # Raised when the database connection has not been set up.
-    class InvalidDatabase < RuntimeError; end
+    # Raised when the database connection has not been set up properly, either
+    # by attempting to set an object on the db that is not a +Mongo::DB+, or
+    # not setting anything at all.
+    #
+    # Example:
+    #
+    # <tt>InvalidDatabase.new("Not a DB")</tt>
+    class InvalidDatabase < RuntimeError
+      def initialize(database)
+        @database = database
+      end
+      def message
+        "Database should be a Mongo::DB, not #{@database.class.name}"
+      end
+    end
 
-    # Raised when a persisence method ending in ! fails validation.
+    # Raised when a persisence method ending in ! fails validation. The message
+    # will contain the full error messages from the +Document+ in question.
+    #
+    # Example:
+    #
+    # <tt>Validations.new(person.errors)</tt>
     class Validations < RuntimeError
       def initialize(errors)
         @errors = errors
@@ -31,6 +58,10 @@ module Mongoid #:nodoc
 
     # This error is raised when trying to access a Mongo::Collection from an
     # embedded document.
+    #
+    # Example:
+    #
+    # <tt>InvalidCollection.new(Address)</tt>
     class InvalidCollection < RuntimeError
       def initialize(klass)
         @klass = klass

data/lib/mongoid/extensions.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require "mongoid/extensions/array/accessors"
+require "mongoid/extensions/array/aliasing"
 require "mongoid/extensions/array/assimilation"
 require "mongoid/extensions/array/conversions"
 require "mongoid/extensions/array/parentization"

data/lib/mongoid/extensions/array/aliasing.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+class Array
+  alias :count :size
+end

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

@@ -10,6 +10,44 @@ module Mongoid #:nodoc:
           inflect.irregular("canvas", "canvases")
         end
 
+        # Represents how special characters will get converted when creating a
+        # composite key that should be unique and part of a url.
+        CHAR_CONV = {
+          " " => "-",
+          "!" => "-excl-",
+          "\"" => "-bckslsh-",
+          "#" => "-hash-",
+          "$" => "-dol-",
+          "%" => "-perc-",
+          "&" => "-and-",
+          "'" => "-quo-",
+          "(" => "-oparen-",
+          ")" => "-cparen-",
+          "*" => "-astx-",
+          "+" => "-plus-",
+          "," => "-comma-",
+          "-" => "-dash-",
+          "." => "-period-",
+          "/" => "-fwdslsh-",
+          ":" => "-colon-",
+          ";" => "-semicol-",
+          "<" => "-lt-",
+          "=" => "-eq-",
+          ">" => "-gt-",
+          "?" => "-ques-",
+          "@" => "-at-",
+          "[" => "-obrck-",
+          "\\" => "-bckslsh-",
+          "]" => "-clbrck-",
+          "^" => "-carat-",
+          "_" => "-undscr-",
+          "`" => "-bcktick-",
+          "{" => "-ocurly-",
+          "|" => "-pipe-",
+          "}" => "-clcurly-",
+          "~" => "-tilda-"
+        }
+
         REVERSALS = {
           "asc" => "desc",
           "ascending" => "descending",
@@ -22,7 +60,12 @@ module Mongoid #:nodoc:
         end
 
         def identify
-          gsub(" ", "_").gsub(/\W/, "").dasherize.downcase
+          if Mongoid.parameterize_keys
+            key = ""
+            each_char { |c| key += (CHAR_CONV[c] || c.downcase) }; key
+          else
+            self
+          end
         end
 
         def labelize

data/lib/mongoid/factory.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  class Factory #:nodoc:
+    # Builds a new +Document+ from the supplied attributes.
+    #
+    # Example:
+    #
+    # <tt>Mongoid::Factory.build(Person, {})</tt>
+    #
+    # Options:
+    #
+    # attributes: The +Document+ attributes.
+    def self.build(attributes)
+      attributes["_type"].constantize.instantiate(attributes)
+    end
+  end
+end

data/lib/mongoid/finders.rb

@@ -63,7 +63,7 @@ module Mongoid #:nodoc:
     #
     # <tt>Person.find_or_create_by(:attribute => "value")</tt>
     def find_or_create_by(attrs = {})
-      first(:conditions => attrs) || self.create(attrs)
+      find_or(:create, attrs)
     end
 
     # Find the first +Document+ given the conditions, or instantiates a new document
@@ -75,7 +75,7 @@ module Mongoid #:nodoc:
     #
     # <tt>Person.find_or_initialize_by(:attribute => "value")</tt>
     def find_or_initialize_by(attrs = {})
-      first(:conditions => attrs) || self.new(attrs)
+      find_or(:new, attrs)
     end
 
     # Find the first +Document+ given the conditions.
@@ -215,5 +215,10 @@ module Mongoid #:nodoc:
       Criteria.new(self).where(selector)
     end
 
+    protected
+    # Find the first object or create/initialize it.
+    def find_or(method, attrs = {})
+      first(:conditions => attrs) || send(method, attrs)
+    end
   end
 end

data/lib/mongoid/matchers/default.rb

@@ -12,9 +12,15 @@ module Mongoid #:nodoc:
       end
 
       protected
+      # Return the first value in the hash.
       def first(value)
         value.values.first
       end
+
+      # If object exists then compare, else return false
+      def determine(value, operator)
+        @attribute ? @attribute.send(operator, first(value)) : false
+      end
     end
   end
 end

data/lib/mongoid/matchers/gt.rb

@@ -4,7 +4,7 @@ module Mongoid #:nodoc:
     class Gt < Default
       # Return true if the attribute is greater than the value.
       def matches?(value)
-        @attribute ? @attribute > first(value) : false
+        determine(value, :>)
       end
     end
   end

data/lib/mongoid/matchers/gte.rb

@@ -4,7 +4,7 @@ module Mongoid #:nodoc:
     class Gte < Default
       # Return true if the attribute is greater than or equal to the value.
       def matches?(value)
-        @attribute ? @attribute >= first(value) : false
+        determine(value, :>=)
       end
     end
   end

data/lib/mongoid/matchers/lt.rb

@@ -4,7 +4,7 @@ module Mongoid #:nodoc:
     class Lt < Default
       # Return true if the attribute is less than the value.
       def matches?(value)
-        @attribute ? @attribute < first(value) : false
+        determine(value, :<)
       end
     end
   end

data/lib/mongoid/matchers/lte.rb

@@ -4,7 +4,7 @@ module Mongoid #:nodoc:
     class Lte < Default
       # Return true if the attribute is less than or equal to the value.
       def matches?(value)
-        @attribute ? @attribute <= first(value) : false
+        determine(value, :<=)
       end
     end
   end

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "1.1.4"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2010-01-26}
+  s.date = %q{2010-02-07}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -35,6 +35,12 @@ Gem::Specification.new do |s|
      "lib/mongoid/associations/proxy.rb",
      "lib/mongoid/attributes.rb",
      "lib/mongoid/callbacks.rb",
+     "lib/mongoid/collection.rb",
+     "lib/mongoid/collections/cyclic_iterator.rb",
+     "lib/mongoid/collections/master.rb",
+     "lib/mongoid/collections/mimic.rb",
+     "lib/mongoid/collections/operations.rb",
+     "lib/mongoid/collections/slaves.rb",
      "lib/mongoid/commands.rb",
      "lib/mongoid/commands/create.rb",
      "lib/mongoid/commands/delete.rb",
@@ -54,10 +60,12 @@ Gem::Specification.new do |s|
      "lib/mongoid/criterion/exclusion.rb",
      "lib/mongoid/criterion/inclusion.rb",
      "lib/mongoid/criterion/optional.rb",
+     "lib/mongoid/cursor.rb",
      "lib/mongoid/document.rb",
      "lib/mongoid/errors.rb",
      "lib/mongoid/extensions.rb",
      "lib/mongoid/extensions/array/accessors.rb",
+     "lib/mongoid/extensions/array/aliasing.rb",
      "lib/mongoid/extensions/array/assimilation.rb",
      "lib/mongoid/extensions/array/conversions.rb",
      "lib/mongoid/extensions/array/parentization.rb",
@@ -78,6 +86,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/extensions/string/inflections.rb",
      "lib/mongoid/extensions/symbol/inflections.rb",
      "lib/mongoid/extensions/time/conversions.rb",
+     "lib/mongoid/factory.rb",
      "lib/mongoid/field.rb",
      "lib/mongoid/fields.rb",
      "lib/mongoid/finders.rb",
@@ -105,6 +114,7 @@ Gem::Specification.new do |s|
      "spec/integration/mongoid/associations_spec.rb",
      "spec/integration/mongoid/attributes_spec.rb",
      "spec/integration/mongoid/commands_spec.rb",
+     "spec/integration/mongoid/contexts/enumerable_spec.rb",
      "spec/integration/mongoid/criteria_spec.rb",
      "spec/integration/mongoid/document_spec.rb",
      "spec/integration/mongoid/extensions_spec.rb",
@@ -142,6 +152,11 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/associations_spec.rb",
      "spec/unit/mongoid/attributes_spec.rb",
      "spec/unit/mongoid/callbacks_spec.rb",
+     "spec/unit/mongoid/collection_spec.rb",
+     "spec/unit/mongoid/collections/cyclic_iterator_spec.rb",
+     "spec/unit/mongoid/collections/master_spec.rb",
+     "spec/unit/mongoid/collections/mimic_spec.rb",
+     "spec/unit/mongoid/collections/slaves_spec.rb",
      "spec/unit/mongoid/commands/create_spec.rb",
      "spec/unit/mongoid/commands/delete_all_spec.rb",
      "spec/unit/mongoid/commands/delete_spec.rb",
@@ -157,6 +172,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/criterion/exclusion_spec.rb",
      "spec/unit/mongoid/criterion/inclusion_spec.rb",
      "spec/unit/mongoid/criterion/optional_spec.rb",
+     "spec/unit/mongoid/cursor_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/errors_spec.rb",
      "spec/unit/mongoid/extensions/array/accessors_spec.rb",
@@ -180,6 +196,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/extensions/string/inflections_spec.rb",
      "spec/unit/mongoid/extensions/symbol/inflections_spec.rb",
      "spec/unit/mongoid/extensions/time/conversions_spec.rb",
+     "spec/unit/mongoid/factory_spec.rb",
      "spec/unit/mongoid/field_spec.rb",
      "spec/unit/mongoid/fields_spec.rb",
      "spec/unit/mongoid/finders_spec.rb",
@@ -213,6 +230,7 @@ Gem::Specification.new do |s|
     "spec/integration/mongoid/associations_spec.rb",
      "spec/integration/mongoid/attributes_spec.rb",
      "spec/integration/mongoid/commands_spec.rb",
+     "spec/integration/mongoid/contexts/enumerable_spec.rb",
      "spec/integration/mongoid/criteria_spec.rb",
      "spec/integration/mongoid/document_spec.rb",
      "spec/integration/mongoid/extensions_spec.rb",
@@ -249,6 +267,11 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/associations_spec.rb",
      "spec/unit/mongoid/attributes_spec.rb",
      "spec/unit/mongoid/callbacks_spec.rb",
+     "spec/unit/mongoid/collection_spec.rb",
+     "spec/unit/mongoid/collections/cyclic_iterator_spec.rb",
+     "spec/unit/mongoid/collections/master_spec.rb",
+     "spec/unit/mongoid/collections/mimic_spec.rb",
+     "spec/unit/mongoid/collections/slaves_spec.rb",
      "spec/unit/mongoid/commands/create_spec.rb",
      "spec/unit/mongoid/commands/delete_all_spec.rb",
      "spec/unit/mongoid/commands/delete_spec.rb",
@@ -264,6 +287,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/criterion/exclusion_spec.rb",
      "spec/unit/mongoid/criterion/inclusion_spec.rb",
      "spec/unit/mongoid/criterion/optional_spec.rb",
+     "spec/unit/mongoid/cursor_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/errors_spec.rb",
      "spec/unit/mongoid/extensions/array/accessors_spec.rb",
@@ -287,6 +311,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/extensions/string/inflections_spec.rb",
      "spec/unit/mongoid/extensions/symbol/inflections_spec.rb",
      "spec/unit/mongoid/extensions/time/conversions_spec.rb",
+     "spec/unit/mongoid/factory_spec.rb",
      "spec/unit/mongoid/field_spec.rb",
      "spec/unit/mongoid/fields_spec.rb",
      "spec/unit/mongoid/finders_spec.rb",
@@ -320,14 +345,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, ["<= 2.3.5"])
       s.add_runtime_dependency(%q<mongo>, [">= 0.18.2"])
       s.add_runtime_dependency(%q<durran-validatable>, [">= 2.0.1"])
-      s.add_runtime_dependency(%q<leshill-will_paginate>, [">= 2.3.11"])
+      s.add_runtime_dependency(%q<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.3.5"])
       s.add_dependency(%q<mongo>, [">= 0.18.2"])
       s.add_dependency(%q<durran-validatable>, [">= 2.0.1"])
-      s.add_dependency(%q<leshill-will_paginate>, [">= 2.3.11"])
+      s.add_dependency(%q<will_paginate>, [">= 2.3.11"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<mocha>, [">= 0.9.8"])
     end
@@ -335,7 +360,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>, ["<= 2.3.5"])
     s.add_dependency(%q<mongo>, [">= 0.18.2"])
     s.add_dependency(%q<durran-validatable>, [">= 2.0.1"])
-    s.add_dependency(%q<leshill-will_paginate>, [">= 2.3.11"])
+    s.add_dependency(%q<will_paginate>, [">= 2.3.11"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<mocha>, [">= 0.9.8"])
   end