mongo 0.18.3 → 0.19

data/lib/mongo/gridfs/grid_store.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -46,12 +46,16 @@ module GridFS
   #  GridStore.open(database, 'filename', 'r') do |f|
   #    puts f.read
   #  end
+  #
+  # @deprecated
   class GridStore
+    include Enumerable
 
     DEFAULT_ROOT_COLLECTION = 'fs'
+
     DEFAULT_CONTENT_TYPE = 'text/plain'
 
-    include Enumerable
+    DEPRECATION_WARNING = "GridFS::GridStore is deprecated. Use either Grid or GridFileSystem."
 
     attr_accessor :filename
 
@@ -77,6 +81,14 @@ module GridFS
 
     attr_reader :md5
 
+    def self.default_root_collection
+      @@default_root_collection ||= DEFAULT_ROOT_COLLECTION
+    end
+
+    def self.default_root_collection=(name)
+      @@default_root_collection = name
+    end
+
     # Determine whether a given file exists in the GridStore.
     #
     # @param [Mongo::DB] a MongoDB database.
@@ -84,7 +96,9 @@ module GridFS
     # @param [String] root_collection the name of the gridfs root collection.
     #
     # @return [Boolean]
-    def self.exist?(db, name, root_collection=DEFAULT_ROOT_COLLECTION)
+    # @deprecated
+    def self.exist?(db, name, root_collection=GridStore.default_root_collection)
+      warn DEPRECATION_WARNING
       db.collection("#{root_collection}.files").find({'filename' => name}).next_document != nil
     end
 
@@ -93,13 +107,14 @@ module GridFS
     #
     # @param [Mongo::DB] a MongoDB database.
     # @param [String] name the filename.
-    # @param [String] mode one of 'r', 'w', or 'w+' for reading, writing, 
+    # @param [String] mode one of 'r', 'w', or 'w+' for reading, writing,
     #   and appending, respectively.
-    # @param [Hash] options any of the options available on 
+    # @param [Hash] options any of the options available on
     #   GridStore initialization.
     #
     # @see GridStore#initialize.
     # @see The various GridStore class methods, e.g., GridStore.open, GridStore.read etc.
+    # @deprecated
     def self.open(db, name, mode, options={})
       gs = self.new(db, name, mode, options)
       result = nil
@@ -120,6 +135,7 @@ module GridFS
     #   beginning of the file to start reading.
     #
     # @return [String] the file data
+    # @deprecated
     def self.read(db, name, length=nil, offset=nil)
       GridStore.open(db, name, 'r') do |gs|
         gs.seek(offset) if offset
@@ -134,13 +150,15 @@ module GridFS
     # @param [String] root_collection the name of the root collection.
     #
     # @return [Array]
-    def self.list(db, root_collection=DEFAULT_ROOT_COLLECTION)
+    # @deprecated
+    def self.list(db, root_collection=GridStore.default_root_collection)
+      warn DEPRECATION_WARNING
       db.collection("#{root_collection}.files").find().map do |f|
         f['filename']
       end
     end
 
-    # Get each line of data from the specified file 
+    # Get each line of data from the specified file
     # as an array of strings.
     #
     # @param [Mongo::DB] db a MongoDB database.
@@ -148,6 +166,7 @@ module GridFS
     # @param [String, Reg] separator
     #
     # @return [Array]
+    # @deprecated
     def self.readlines(db, name, separator=$/)
       GridStore.open(db, name, 'r') do |gs|
         gs.readlines(separator)
@@ -160,10 +179,11 @@ module GridFS
     # @param [Array<String>] names the filenames to remove
     #
     # @return [True]
+    # @deprecated
     def self.unlink(db, *names)
       names.each do |name|
         gs = GridStore.new(db, name)
-        gs.send(:delete_chunks)
+        gs.delete_chunks
         gs.collection.remove('_id' => gs.files_id)
       end
     end
@@ -172,13 +192,16 @@ module GridFS
     end
 
     # Rename a file in this collection. Note that this method uses
-    # Collection#update, which means that you will not be notified 
+    # Collection#update, which means that you will not be notified of the
+    # success of the operation.
     #
     # @param [Mongo::DB] a MongoDB database.
     # @param [String] src the name of the source file.
     # @param [String] dest the name of the destination file.
     # @param [String] root_collection the name of the default root collection.
-    def self.mv(db, src, dest, root_collection=DEFAULT_ROOT_COLLECTION)
+    # @deprecated
+    def self.mv(db, src, dest, root_collection=GridStore.default_root_collection)
+      warn DEPRECATION_WARNING
       db.collection("#{root_collection}.files").update({ :filename => src }, { '$set' => { :filename => dest } })
     end
 
@@ -197,11 +220,13 @@ module GridFS
     # @option options [Integer] :chunk_size (Chunk::DEFAULT_CHUNK_SIZE) (w) Sets chunk size for files opened for writing.
     #   See also GridStore#chunk_size=.
     #
-    # @option options [String] :content_type ('text/plain') Set the content type stored as the 
+    # @option options [String] :content_type ('text/plain') Set the content type stored as the
     #   file's metadata. See also GridStore#content_type=.
+    # @deprecated
     def initialize(db, name, mode='r', options={})
+      warn DEPRECATION_WARNING
       @db, @filename, @mode = db, name, mode
-      @root = options[:root] || DEFAULT_ROOT_COLLECTION
+      @root = options[:root] || GridStore.default_root_collection
 
       doc = collection.find({'filename' => @filename}).next_document
       if doc
@@ -488,6 +513,11 @@ module GridFS
       @db == nil
     end
 
+    def delete_chunks
+      chunk_collection.remove({'files_id' => @files_id}) if @files_id
+      @curr_chunk = nil
+    end
+
     #---
     # ================ protected ================
     #+++
@@ -537,12 +567,7 @@ module GridFS
       buf
     end
 
-    def delete_chunks
-      chunk_collection.remove({'files_id' => @files_id}) if @files_id
-      @curr_chunk = nil
-    end
-
-    def nth_chunk(n)
+   def nth_chunk(n)
       mongo_chunk = chunk_collection.find({'files_id' => @files_id, 'n' => n}).next_document
       Chunk.new(self, mongo_chunk || {})
     end

data/lib/mongo/types/binary.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -44,5 +44,9 @@ module Mongo
       @subtype = subtype
     end
 
+    def inspect
+      "<Mongo::Binary:#{object_id}>"
+    end
+
   end
 end

data/lib/mongo/types/code.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/types/dbref.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,6 +25,8 @@ module Mongo
     #
     # @param [String] a collection name
     # @param [ObjectID] an object id
+    #
+    # @core dbrefs constructor_details
     def initialize(namespace, object_id)
       @namespace = namespace
       @object_id = object_id

data/lib/mongo/types/min_max_keys.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/types/objectid.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,21 +20,15 @@ require 'digest/md5'
 
 module Mongo
 
-  # ObjectID class for documents in MongoDB.
+  # Generates MongoDB object ids.
+  #
+  # @core objectids
   class ObjectID
-    # This is the legacy byte ordering for Babble. Versions of the Ruby
-    # driver prior to 0.14 used this byte ordering when converting ObjectID
-    # instances to and from strings. If you have string representations of
-    # ObjectIDs using the legacy byte ordering make sure to use the
-    # to_s_legacy and from_string_legacy methods, or convert your strings
-    # with ObjectID#legacy_string_convert
-    BYTE_ORDER = [7, 6, 5, 4, 3, 2, 1, 0, 11, 10, 9, 8]
-
     @@lock  = Mutex.new
     @@index = 0
 
     # Create a new object id. If no parameter is given, an id corresponding
-    # to the ObjectID BSON data type will be created. This is a 12-byte value 
+    # to the ObjectID BSON data type will be created. This is a 12-byte value
     # consisting of a 4-byte timestamp, a 3-byte machine id, a 2-byte process id,
     # and a 3-byte counter.
     #
@@ -44,8 +38,14 @@ module Mongo
       @data = data || generate
     end
 
+    # Determine if the supplied string is legal. Legal strings will
+    # consist of 24 hexadecimal characters.
+    #
+    # @param [String] str
+    #
+    # @return [Boolean]
     def self.legal?(str)
-      len = BYTE_ORDER.length * 2
+      len = 24
       str =~ /([0-9a-f]+)/i
       match = $1
       str && str.length == len && match == str
@@ -115,21 +115,6 @@ module Mongo
       self.new(data)
     end
 
-    # @deprecated
-    # Create a new ObjectID given a string representation of an ObjectID
-    # using the legacy byte ordering. This method may eventually be
-    # removed. If you are not sure that you need this method you should be
-    # using the regular from_string.
-    def self.from_string_legacy(str)
-      warn "Support for legacy object ids has been DEPRECATED."
-      raise InvalidObjectID, "illegal ObjectID format" unless legal?(str)
-      data = []
-      BYTE_ORDER.each_with_index { |string_position, data_index|
-        data[data_index] = str[string_position * 2, 2].to_i(16)
-      }
-      self.new(data)
-    end
-
     # Get a string representation of this object id.
     #
     # @return [String]
@@ -140,7 +125,10 @@ module Mongo
       end
       str
     end
-    alias_method :inspect, :to_s
+
+    def inspect
+      "ObjectID('#{to_s}')"
+    end
 
     # Convert to MongoDB extended JSON format. Since JSON includes type information,
     # but lacks an ObjectID type, this JSON format encodes the type using an $id key.
@@ -150,33 +138,6 @@ module Mongo
       "{\"$oid\": \"#{to_s}\"}"
     end
 
-    # @deprecated
-    # Get a string representation of this ObjectID using the legacy byte
-    # ordering. This method may eventually be removed. If you are not sure
-    # that you need this method you should be using the regular to_s.
-    def to_s_legacy
-      warn "Support for legacy object ids has been DEPRECATED."
-      str = ' ' * 24
-      BYTE_ORDER.each_with_index { |string_position, data_index|
-        str[string_position * 2, 2] = '%02x' % @data[data_index]
-      }
-      str
-    end
-
-    # @deprecated
-    # Convert a string representation of an ObjectID using the legacy byte
-    # ordering to the proper byte ordering. This method may eventually be
-    # removed. If you are not sure that you need this method it is probably
-    # unnecessary.
-    def self.legacy_string_convert(str)
-      warn "Support for legacy object ids has been DEPRECATED."
-      legacy = ' ' * 24
-      BYTE_ORDER.each_with_index do |legacy_pos, pos|
-        legacy[legacy_pos * 2, 2] = str[pos * 2, 2]
-      end
-      legacy
-    end
-
     # Return the UTC time at which this ObjectID was generated. This may
     # be used in lieu of a created_at timestamp since this information
     # is always encoded in the object id.

data/lib/mongo/types/regexp_of_holding.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/util/bson_c.rb

@@ -1,8 +1,8 @@
 # A thin wrapper for the CBson class
 class BSON_C
 
-  def self.serialize(obj, check_keys=false)
-    ByteBuffer.new(CBson.serialize(obj, check_keys))
+  def self.serialize(obj, check_keys=false, move_id=false)
+    ByteBuffer.new(CBson.serialize(obj, check_keys, move_id))
   end
 
   def self.deserialize(buf=nil)

data/lib/mongo/util/bson_ruby.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License, version 3, as
@@ -87,15 +87,15 @@ class BSON_RUBY
 
   # Serializes an object.
   # Implemented to ensure an API compatible with BSON extension.
-  def self.serialize(obj, check_keys=false)
-    new.serialize(obj, check_keys)
+  def self.serialize(obj, check_keys=false, move_id=false)
+    new.serialize(obj, check_keys, move_id)
   end
 
   def self.deserialize(buf=nil)
     new.deserialize(buf)
   end
 
-  def serialize(obj, check_keys=false)
+  def serialize(obj, check_keys=false, move_id=false)
     raise "Document is null" unless obj
 
     @buf.rewind
@@ -103,14 +103,20 @@ class BSON_RUBY
     @buf.put_int(0)
 
     # Write key/value pairs. Always write _id first if it exists.
-    if obj.has_key? '_id'
-      serialize_key_value('_id', obj['_id'], check_keys)
-    elsif obj.has_key? :_id
-      serialize_key_value('_id', obj[:_id], check_keys)
+    if move_id
+      if obj.has_key? '_id'
+        serialize_key_value('_id', obj['_id'], false)
+      elsif obj.has_key? :_id
+        serialize_key_value('_id', obj[:_id], false)
+      end
+      obj.each {|k, v| serialize_key_value(k, v, check_keys) unless k == '_id' || k == :_id }
+    else
+      if obj.has_key?('_id') && obj.has_key?(:_id)
+        obj['_id'] = obj.delete(:_id)
+      end
+      obj.each {|k, v| serialize_key_value(k, v, check_keys) }
     end
 
-    obj.each {|k, v| serialize_key_value(k, v, check_keys) unless k == '_id' || k == :_id }
-
     serialize_eoo_element(@buf)
     if @buf.size > 4 * 1024 * 1024
       raise InvalidDocument, "Document is too large (#{@buf.size}). BSON documents are limited to 4MB (#{4 * 1024 * 1024})."
@@ -323,7 +329,12 @@ class BSON_RUBY
     options |= Regexp::MULTILINE if options_str.include?('m')
     options |= Regexp::EXTENDED if options_str.include?('x')
     options_str.gsub!(/[imx]/, '') # Now remove the three we understand
-    RegexpOfHolding.new(str, options, options_str)
+    if options_str == ''
+      Regexp.new(str, options)
+    else
+      warn("Using deprecated Regexp options #{options_str}; future versions of this MongoDB driver will support only i, m, and x. See deprecated class RegexpOfHolding for more info.")
+      RegexpOfHolding.new(str, options, options_str)
+    end
   end
 
   def deserialize_string_data(buf)

data/lib/mongo/util/byte_buffer.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/util/conversions.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/util/ordered_hash.rb

@@ -1,5 +1,5 @@
 # --
-# Copyright (C) 2008-2009 10gen Inc.
+# Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -71,6 +71,11 @@ class OrderedHash < Hash
     end
     alias :each_pair :each
 
+    def to_a
+      @ordered_keys ||= []
+      @ordered_keys.map { |k| [k, self[k]] }      
+    end
+    
     def values
       collect { |k, v| v }
     end