mongo 0.19.3 → 0.20

data/lib/mongo/cursor.rb

@@ -227,7 +227,7 @@ module Mongo
     # @return [True]
     def close
       if @cursor_id
-        message = ByteBuffer.new([0, 0, 0, 0])
+        message = BSON::ByteBuffer.new([0, 0, 0, 0])
         message.put_int(1)
         message.put_long(@cursor_id)
         @connection.send_message(Mongo::Constants::OP_KILL_CURSORS, message, "cursor.close")
@@ -282,6 +282,8 @@ module Mongo
           returning({}) do |hash|
             fields.each { |field| hash[field] = 1 }
           end
+        when Hash
+          return fields
       end
     end
 
@@ -301,11 +303,6 @@ module Mongo
       end
     end
 
-    # Returns true if the query contains order, explain, hint, or snapshot.
-    def query_contains_special_fields?
-      @order || @explain || @hint || @snapshot
-    end
-
     # Return a number of documents remaining for this cursor.
     def num_remaining
       refill_via_get_more if @cache.length == 0
@@ -314,11 +311,11 @@ module Mongo
 
     def refill_via_get_more
       return if send_initial_query || @cursor_id.zero?
-      message = ByteBuffer.new([0, 0, 0, 0])
+      message = BSON::ByteBuffer.new([0, 0, 0, 0])
 
       # DB name.
       db_name = @admin ? 'admin' : @db.name
-      BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
+      BSON::BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
 
       # Number of results to return; db decides for now.
       message.put_int(0)
@@ -346,18 +343,15 @@ module Mongo
     end
 
     def construct_query_message
-      message = ByteBuffer.new
+      message = BSON::ByteBuffer.new
       message.put_int(query_opts)
       db_name = @admin ? 'admin' : @db.name
-      BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
+      BSON::BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
       message.put_int(@skip)
       message.put_int(@limit)
-      selector = @selector
-      if query_contains_special_fields?
-        selector = selector_with_special_query_fields
-      end
-      message.put_array(BSON.serialize(selector, false).to_a)
-      message.put_array(BSON.serialize(@fields, false).to_a) if @fields
+      spec = query_contains_special_fields? ? construct_query_spec : @selector
+      message.put_array(BSON::BSON_CODER.serialize(spec, false).to_a)
+      message.put_array(BSON::BSON_CODER.serialize(@fields, false).to_a) if @fields
       message
     end
 
@@ -367,24 +361,20 @@ module Mongo
       "#{@order ? ('.sort(' + @order.inspect + ')') : ''}"
     end
 
-    def selector_with_special_query_fields
-      sel = OrderedHash.new
-      sel['query']     = @selector
-      sel['orderby']   = formatted_order_clause if @order
-      sel['$hint']     = @hint if @hint && @hint.length > 0
-      sel['$explain']  = true if @explain
-      sel['$snapshot'] = true if @snapshot
-      sel
+    def construct_query_spec
+      return @selector if @selector.has_key?('$query')
+      spec = OrderedHash.new
+      spec['$query']    = @selector
+      spec['$orderby']  = Mongo::Support.format_order_clause(@order) if @order
+      spec['$hint']     = @hint if @hint && @hint.length > 0
+      spec['$explain']  = true if @explain
+      spec['$snapshot'] = true if @snapshot
+      spec
     end
 
-    def formatted_order_clause
-      case @order
-        when String, Symbol then string_as_sort_parameters(@order)
-        when Array then array_as_sort_parameters(@order)
-        else
-          raise InvalidSortValueError, "Illegal sort clause, '#{@order.class.name}'; must be of the form " +
-            "[['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]"
-      end
+    # Returns true if the query contains order, explain, hint, or snapshot.
+    def query_contains_special_fields?
+      @order || @explain || @hint || @snapshot
     end
 
     def to_s

data/lib/mongo/db.rb

@@ -54,10 +54,10 @@ module Mongo
     # @param [Mongo::Connection] connection a connection object pointing to MongoDB. Note
     #   that databases are usually instantiated via the Connection class. See the examples below.
     #
-    # @option options [Boolean] strict (False) If true, collections must exist to be accessed and must
+    # @option options [Boolean] :strict (False) If true, collections must exist to be accessed and must
     #   not exist to be created. See DB#collection and DB#create_collection.
     #
-    # @option options [Object, #create_pk(doc)] pk (Mongo::ObjectID) A primary key factory object,
+    # @option options [Object, #create_pk(doc)] :pk (Mongo::ObjectID) A primary key factory object,
     #   which should take a hash and return a hash which merges the original hash with any primary key
     #   fields the factory wishes to inject. (NOTE: if the object already has a primary key,
     #   the factory should not inject a new key).
@@ -229,7 +229,7 @@ module Mongo
     # @return [Mongo::Collection]
     def collection(name)
       return Collection.new(self, name, @pk_factory) if !strict? || collection_names.include?(name)
-      raise MongoDBError, "Collection #{name} doesn't exist. Currently in strict mode."
+      raise Mongo::MongoDBError, "Collection #{name} doesn't exist. Currently in strict mode."
     end
     alias_method :[], :collection
 
@@ -325,8 +325,8 @@ module Mongo
     #
     # @return [String] the return value of the function.
     def eval(code, *args)
-      if not code.is_a? Code
-        code = Code.new(code)
+      if not code.is_a? BSON::Code
+        code = BSON::Code.new(code)
       end
 
       oh = OrderedHash.new
@@ -386,6 +386,14 @@ module Mongo
       info
     end
 
+
+    # Return stats on this database. Uses MongoDB's dbstats command.
+    #
+    # @return [Hash]
+    def stats
+      self.command({:dbstats => 1})
+    end
+
     # Create a new index on the given collection.
     # Normally called by Collection#create_index.
     #

data/lib/mongo/exceptions.rb

@@ -24,17 +24,17 @@ module Mongo
   # Raised when configuration options cause connections, queries, etc., to fail.
   class ConfigurationError < MongoRubyError; end
 
-  # Raised with fatal errors to GridFS.
+  # Raised on fatal errors to GridFS.
   class GridError < MongoRubyError; end
 
-  # Raised when invalid arguments are sent to Mongo Ruby methods.
-  class MongoArgumentError < MongoRubyError; end
+  # Raised on fatal errors to GridFS.
+  class GridFileNotFound < GridError; end
 
-  # Raised when given a string is not valid utf-8 (Ruby 1.8 only).
-  class InvalidStringEncoding < MongoRubyError; end
+  # Raised on fatal errors to GridFS.
+  class GridMD5Failure < GridError; end
 
-  # Raised when attempting to initialize an invalid ObjectID.
-  class InvalidObjectID < MongoRubyError; end
+  # Raised when invalid arguments are sent to Mongo Ruby methods.
+  class MongoArgumentError < MongoRubyError; end
 
   # Raised on failures in connection to the database server.
   class ConnectionError < MongoRubyError; end
@@ -42,9 +42,8 @@ module Mongo
   # Raised on failures in connection to the database server.
   class ConnectionTimeoutError < MongoRubyError; end
 
-  # Raised when trying to insert a document that exceeds the 4MB limit or
-  # when the document contains objects that can't be serialized as BSON.
-  class InvalidDocument < MongoDBError; end
+  # Raised when a connection operation fails.
+  class ConnectionFailure < MongoDBError; end
 
   # Raised when authentication fails.
   class AuthenticationError < MongoDBError; end
@@ -52,14 +51,11 @@ module Mongo
   # Raised when a database operation fails.
   class OperationFailure < MongoDBError; end
 
-  # Raised when a connection operation fails.
-  class ConnectionFailure < MongoDBError; end
-
   # Raised when a client attempts to perform an invalid operation.
   class InvalidOperation < MongoDBError; end
 
-  # Raised when an invalid name is used.
-  class InvalidName < RuntimeError; end
+  # Raised when an invalid collection or database name is used (invalid namespace name).
+  class InvalidNSName < RuntimeError; end
 
   # Raised when the client supplies an invalid value to sort by.
   class InvalidSortValueError < MongoRubyError; end

data/lib/mongo/gridfs/grid.rb

@@ -34,14 +34,14 @@ module Mongo
       @chunks  = @db["#{fs_name}.chunks"]
       @fs_name = fs_name
 
-      @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]])
+      @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
     end
 
     # Store a file in the file store.
     #
     # @param [String, #read] data a string or io-like object to store.
-    # @param [String] filename a name for the file.
     #
+    # @options opts [String] :filename (nil) a name for the file.
     # @options opts [Hash] :metadata ({}) any additional data to store with the file.
     # @options opts [ObjectID] :_id (ObjectID) a unique id for
     #   the file to be use in lieu of an automatically generated one.
@@ -53,7 +53,14 @@ module Mongo
     #   will be validated using an md5 hash. If validation fails, an exception will be raised.
     #
     # @return [Mongo::ObjectID] the file's id.
-    def put(data, filename, opts={})
+    def put(data, opts={}, old_opts={})
+      if opts.is_a?(String)
+        warn "The filename is now optional. Please pass the filename as a hash option: Grid#put(data, :filename => 'file.jpg')."
+        filename = opts
+        opts     = old_opts
+      else
+        filename = opts[:filename]
+      end
       opts.merge!(default_grid_io_opts)
       file = GridIO.new(@files, @chunks, filename, 'w', opts=opts)
       file.write(data)
@@ -73,6 +80,10 @@ module Mongo
 
     # Delete a file from the store.
     #
+    # Note that deleting a GridFS file can result in read errors if another process
+    # is attempting to read a file while it's being deleted. While the odds for this
+    # kind of race condition are small, it's important to be aware of.
+    #
     # @param [] id
     #
     # @return [Boolean]

data/lib/mongo/gridfs/grid_file_system.rb

@@ -34,8 +34,10 @@ module Mongo
       @chunks  = @db["#{fs_name}.chunks"]
       @fs_name = fs_name
 
-      @files.create_index([['filename', 1], ['uploadDate', -1]])
       @default_query_opts = {:sort => [['filename', 1], ['uploadDate', -1]], :limit => 1}
+
+      @files.create_index([['filename', 1], ['uploadDate', -1]])
+      @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
     end
 
     # Open a file for reading or writing. Note that the options for this method only apply
@@ -53,6 +55,9 @@ module Mongo
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
     # @options opts [Integer] (262144) :chunk_size size of file chunks in bytes.
+    # @options opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option
+    #  only work in 'w' mode. Certain precautions must be taken when deleting GridFS files. See the notes under
+    #  GridFileSystem#delete.
     # @options opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
     #   will be validated using an md5 hash. If validation fails, an exception will be raised.
     #
@@ -76,15 +81,23 @@ module Mongo
     #  @grid.open('image.jpg, 'w') do |f|
     #    f.write @file
     #  end
+    #
+    #  @return [Mongo::GridIO]
     def open(filename, mode, opts={})
       opts.merge!(default_grid_io_opts(filename))
-      file   = GridIO.new(@files, @chunks, filename, mode, opts)
+      del  = opts.delete(:delete_old) && mode == 'w'
+      file = GridIO.new(@files, @chunks, filename, mode, opts)
       return file unless block_given?
       result = nil
       begin
         result = yield file
       ensure
-        file.close
+        id = file.close
+        if del
+          self.delete do
+            @files.find({'filename' => filename, '_id' => {'$ne' => id}}, :fields => ['_id'])
+          end
+        end
       end
       result
     end
@@ -92,11 +105,21 @@ module Mongo
     # Delete the file with the given filename. Note that this will delete
     # all versions of the file.
     #
+    # Note that deleting a GridFS file can result in read errors if another process
+    # is attempting to read a file while it's being deleted. While the odds for this
+    # kind of race condition are small, it's important to be aware of.
+    #
     # @param [String] filename
     #
+    # @yield [] pass a block that returns an array of documents to be deleted.
+    #
     # @return [Boolean]
-    def delete(filename)
-      files = @files.find({'filename' => filename}, :fields => ['_id'])
+    def delete(filename=nil)
+      if block_given?
+        files = yield
+      else
+        files = @files.find({'filename' => filename}, :fields => ['_id'])
+      end
       files.each do |file|
         @files.remove({'_id' => file['_id']})
         @chunks.remove({'files_id' => file['_id']})

data/lib/mongo/gridfs/grid_io.rb

@@ -27,6 +27,7 @@ module Mongo
   class GridIO
     DEFAULT_CHUNK_SIZE   = 256 * 1024
     DEFAULT_CONTENT_TYPE = 'binary/octet-stream'
+    PROTECTED_ATTRS      = [:files_id, :file_length, :client_md5, :server_md5]
 
     attr_reader :content_type, :chunk_size, :upload_date, :files_id, :filename,
       :metadata, :server_md5, :client_md5, :file_length
@@ -52,15 +53,16 @@ module Mongo
     # @options opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
     #   will be validated using an md5 hash. If validation fails, an exception will be raised.
     def initialize(files, chunks, filename, mode, opts={})
-      @files      = files
-      @chunks     = chunks
-      @filename   = filename
-      @mode       = mode
-      @query      = opts[:query] || {}
-      @query_opts = opts[:query_opts] || {}
-      @fs_name    = opts[:fs_name] || Grid::DEFAULT_FS_NAME
-      @safe       = opts[:safe] || false
-      @local_md5  = Digest::MD5.new if @safe
+      @files        = files
+      @chunks       = chunks
+      @filename     = filename
+      @mode         = mode
+      @query        = opts.delete(:query) || {}
+      @query_opts   = opts.delete(:query_opts) || {}
+      @fs_name      = opts.delete(:fs_name) || Grid::DEFAULT_FS_NAME
+      @safe         = opts.delete(:safe) || false
+      @local_md5    = Digest::MD5.new if @safe
+      @custom_attrs = {}
 
       case @mode
         when 'r' then init_read
@@ -70,6 +72,19 @@ module Mongo
       end
     end
 
+    def [](key)
+      @custom_attrs[key] || instance_variable_get("@#{key.to_s}")
+    end
+
+    def []=(key, value)
+      if PROTECTED_ATTRS.include?(key.to_sym)
+        warn "Attempting to overwrite protected value."
+        return nil
+      else
+        @custom_attrs[key] = value
+      end
+    end
+
     # Read the data from the file. If a length if specified, will read from the
     # current file position.
     #
@@ -163,16 +178,16 @@ module Mongo
     # This method will be invoked automatically when
     # on GridIO#open is passed a block. Otherwise, it must be called manually.
     #
-    # @return [True]
+    # @return [BSON::ObjectID]
     def close
       if @mode[0] == ?w
         if @current_chunk['n'].zero? && @chunk_position.zero?
           warn "Warning: Storing a file with zero length."
         end
         @upload_date = Time.now.utc
-        @files.insert(to_mongo_object)
+        id = @files.insert(to_mongo_object)
       end
-      true
+      id
     end
 
     def inspect
@@ -183,7 +198,7 @@ module Mongo
 
     def create_chunk(n)
       chunk = OrderedHash.new
-      chunk['_id']      = Mongo::ObjectID.new
+      chunk['_id']      = BSON::ObjectID.new
       chunk['n']        = n
       chunk['files_id'] = @files_id
       chunk['data']     = ''
@@ -261,7 +276,7 @@ module Mongo
         end
         chunk_available = @chunk_size - @chunk_position
         step_size = (to_write > chunk_available) ? chunk_available : to_write
-        @current_chunk['data'] = Binary.new((@current_chunk['data'].to_s << string[-to_write, step_size]).unpack("c*"))
+        @current_chunk['data'] = BSON::Binary.new((@current_chunk['data'].to_s << string[-to_write, step_size]).unpack("c*"))
         @chunk_position += step_size
         to_write -= step_size
         save_chunk(@current_chunk)
@@ -272,7 +287,7 @@ module Mongo
     # Initialize the class for reading a file.
     def init_read
       doc = @files.find(@query, @query_opts).next_document
-      raise GridError, "Could not open file matching #{@query.inspect} #{@query_opts.inspect}" unless doc
+      raise GridFileNotFound, "Could not open file matching #{@query.inspect} #{@query_opts.inspect}" unless doc
 
       @files_id     = doc['_id']
       @content_type = doc['contentType']
@@ -283,6 +298,7 @@ module Mongo
       @metadata     = doc['metadata']
       @md5          = doc['md5']
       @filename     = doc['filename']
+      @custom_attrs = doc
 
       @current_chunk = get_chunk(0)
       @file_position = 0
@@ -290,12 +306,13 @@ module Mongo
 
     # Initialize the class for writing a file.
     def init_write(opts)
-      @files_id      = opts[:_id] || Mongo::ObjectID.new
-      @content_type  = opts[:content_type] || (defined? MIME) && get_content_type || DEFAULT_CONTENT_TYPE
-      @chunk_size    = opts[:chunk_size] || DEFAULT_CHUNK_SIZE
-      @metadata      = opts[:metadata] if opts[:metadata]
-      @aliases       = opts[:aliases] if opts[:aliases]
+      @files_id      = opts.delete(:_id) || BSON::ObjectID.new
+      @content_type  = opts.delete(:content_type) || (defined? MIME) && get_content_type || DEFAULT_CONTENT_TYPE
+      @chunk_size    = opts.delete(:chunk_size) || DEFAULT_CHUNK_SIZE
+      @metadata      = opts.delete(:metadata) if opts[:metadata]
+      @aliases       = opts.delete(:aliases) if opts[:aliases]
       @file_length   = 0
+      opts.each {|k, v| self[k] = v}
 
       @current_chunk = create_chunk(0)
       @file_position = 0
@@ -304,14 +321,15 @@ module Mongo
     def to_mongo_object
       h                = OrderedHash.new
       h['_id']         = @files_id
-      h['filename']    = @filename
+      h['filename']    = @filename if @filename
       h['contentType'] = @content_type
       h['length']      = @current_chunk ? @current_chunk['n'] * @chunk_size + @chunk_position : 0
       h['chunkSize']   = @chunk_size
       h['uploadDate']  = @upload_date
-      h['aliases']     = @aliases
-      h['metadata']    = @metadata
+      h['aliases']     = @aliases if @aliases
+      h['metadata']    = @metadata if @metadata
       h['md5']         = get_md5
+      h.merge!(@custom_attrs)
       h
     end
 
@@ -324,7 +342,7 @@ module Mongo
       if @safe
         @client_md5 = @local_md5.hexdigest
         if @local_md5 != @server_md5
-          raise GridError, "File on server failed MD5 check"
+          raise GridMD5Failure, "File on server failed MD5 check"
         end
       else
         @server_md5