bson 3.2.7 → 4.0.0.beta

data/lib/bson.rb

@@ -62,7 +62,6 @@ require "bson/json"
 require "bson/int32"
 require "bson/int64"
 require "bson/integer"
-require "bson/encodable"
 require "bson/array"
 require "bson/binary"
 require "bson/boolean"

data/lib/bson/array.rb

@@ -21,7 +21,6 @@ module BSON
   #
   # @since 2.0.0
   module Array
-    include Encodable
 
     # An array is type 0x04 in the BSON spec.
     #
@@ -41,14 +40,16 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encode_with_placeholder_and_null(BSON_ADJUST, encoded) do |encoded|
-        each_with_index do |value, index|
-          encoded << value.bson_type
-          index.to_bson_key(encoded)
-          value.to_bson(encoded)
-        end
+    def to_bson(buffer = ByteBuffer.new)
+      position = buffer.length
+      buffer.put_int32(0)
+      each_with_index do |value, index|
+        buffer.put_byte(value.bson_type)
+        buffer.put_cstring(index.to_s)
+        value.to_bson(buffer)
       end
+      buffer.put_byte(NULL_BYTE)
+      buffer.replace_int32(position, buffer.length - position)
     end
 
     # Convert the array to an object id. This will only work for arrays of size
@@ -84,19 +85,19 @@ module BSON
 
       # Deserialize the array from BSON.
       #
-      # @param [ BSON ] bson The bson representing an array.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ Array ] The decoded array.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
+      def from_bson(buffer)
         array = new
-        bson.read(4) # throw away the length
-        while (type = bson.readbyte.chr) != NULL_BYTE
-          bson.gets(NULL_BYTE)
-          array << BSON::Registry.get(type).from_bson(bson)
+        buffer.get_int32 # throw away the length
+        while (type = buffer.get_byte) != NULL_BYTE
+          buffer.get_cstring
+          array << BSON::Registry.get(type).from_bson(buffer)
         end
         array
       end

data/lib/bson/binary.rb

@@ -21,7 +21,6 @@ module BSON
   # @since 2.0.0
   class Binary
     include JSON
-    include Encodable
 
     # A binary is type 0x05 in the BSON spec.
     #
@@ -130,28 +129,29 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encode_binary_data_with_placeholder(encoded) do |encoded|
-        encoded << SUBTYPES.fetch(type)
-        encoded << data.bytesize.to_bson if type == :old
-        encoded << data.force_encoding(BINARY)
-      end
+    def to_bson(buffer = ByteBuffer.new)
+      position = buffer.length
+      buffer.put_int32(0)
+      buffer.put_byte(SUBTYPES.fetch(type))
+      buffer.put_int32(data.bytesize) if type == :old
+      buffer.put_bytes(data.force_encoding(BINARY))
+      buffer.replace_int32(position, buffer.length - position - 5)
     end
 
     # Deserialize the binary data from BSON.
     #
-    # @param [ BSON ] bson The bson representing binary data.
+    # @param [ ByteBuffer ] buffer The byte buffer.
     #
     # @return [ Binary ] The decoded binary data.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(bson)
-      length = Int32.from_bson(bson)
-      type = TYPES[bson.read(1)]
-      length = Int32.from_bson(bson) if type == :old
-      data = bson.read(length)
+    def self.from_bson(buffer)
+      length = buffer.get_int32
+      type = TYPES[buffer.get_byte]
+      length = buffer.get_int32 if type == :old
+      data = buffer.get_bytes(length)
       new(data, type)
     end
 

data/lib/bson/boolean.rb

@@ -29,15 +29,15 @@ module BSON
 
     # Deserialize a boolean from BSON.
     #
-    # @param [ BSON ] bson The encoded boolean.
+    # @param [ ByteBuffer ] buffer The byte buffer.
     #
     # @return [ TrueClass, FalseClass ] The decoded boolean.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(bson)
-      bson.readbyte.chr == TrueClass::TRUE_BYTE
+    def self.from_bson(buffer)
+      buffer.get_byte == TrueClass::TRUE_BYTE
     end
 
     # Register this type when the module is loaded.

data/lib/bson/code.rb

@@ -21,7 +21,6 @@ module BSON
   # @since 2.0.0
   class Code
     include JSON
-    include Encodable
 
     # A code is type 0x0D in the BSON spec.
     #
@@ -82,23 +81,21 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encode_with_placeholder_and_null(STRING_ADJUST, encoded) do |encoded|
-        javascript.to_bson_string(encoded)
-      end
+    def to_bson(buffer = ByteBuffer.new)
+      buffer.put_string(javascript) # @todo: was formerly to_bson_string
     end
 
     # Deserialize code from BSON.
     #
-    # @param [ BSON ] bson The encoded code.
+    # @param [ ByteBuffer ] buffer The byte buffer.
     #
     # @return [ TrueClass, FalseClass ] The decoded code.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(bson)
-      new(bson.read(Int32.from_bson(bson)).from_bson_string.chop!)
+    def self.from_bson(buffer)
+      new(buffer.get_string)
     end
 
     # Register this type when the module is loaded.

data/lib/bson/code_with_scope.rb

@@ -21,7 +21,6 @@ module BSON
   #
   # @since 2.0.0
   class CodeWithScope
-    include Encodable
     include JSON
 
     # A code with scope is type 0x0F in the BSON spec.
@@ -88,28 +87,26 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      # -1 because we are removing an extra byte
-      out = encode_with_placeholder_and_null(BSON_ADJUST - 1, encoded) do |encoded|
-        javascript.to_bson(encoded)
-        scope.to_bson(encoded)
-      end
-      # an extra null byte has been added; we must remove it
-      out.chop!
+    def to_bson(buffer = ByteBuffer.new)
+      position = buffer.length
+      buffer.put_int32(0)
+      buffer.put_string(javascript)
+      scope.to_bson(buffer)
+      buffer.replace_int32(position, buffer.length - position)
     end
 
     # Deserialize a code with scope from BSON.
     #
-    # @param [ BSON ] bson The encoded code with scope.
+    # @param [ ByteBuffer ] buffer The byte buffer.
     #
     # @return [ TrueClass, FalseClass ] The decoded code with scope.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(bson)
-      bson.read(4) # Throw away the total length.
-      new(bson.read(Int32.from_bson(bson)).from_bson_string.chop!, ::Hash.from_bson(bson))
+    def self.from_bson(buffer)
+      buffer.get_int32 # Throw away the total length.
+      new(buffer.get_string, ::Hash.from_bson(buffer))
     end
 
     # Register this type when the module is loaded.

data/lib/bson/date.rb

@@ -34,8 +34,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.1.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      ::Time.utc(year, month, day).to_bson(encoded)
+    def to_bson(buffer = ByteBuffer.new)
+      ::Time.utc(year, month, day).to_bson(buffer)
     end
 
     # Get the BSON type for the date.

data/lib/bson/date_time.rb

@@ -34,8 +34,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.1.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      to_time.to_bson(encoded)
+    def to_bson(buffer = ByteBuffer.new)
+      to_time.to_bson(buffer)
     end
   end
 

data/lib/bson/document.rb

@@ -68,6 +68,39 @@ module BSON
       super(convert_key(key), convert_value(value))
     end
 
+    # Returns true if the given key is present in the document.  Will normalize
+    # symbol keys into strings.
+    #
+    # @example Test if a key exists using a symbol
+    #   document.has_key?(:test)
+    #
+    # @return [ true, false]
+    #
+    # @since 3.2.7
+    def has_key?(key)
+      super(convert_key(key))
+    end
+
+    alias :include? :has_key?
+    alias :key?     :has_key?
+    alias :member?  :has_key?
+
+
+    # Returns true if the given value is present in the document.  Will normalize
+    # symbols into strings.
+    #
+    # @example Test if a key exists using a symbol
+    #   document.has_value?(:test)
+    #
+    # @return [ true, false]
+    #
+    # @since 3.2.7
+    def has_value?(value)
+      super(convert_value(value))
+    end
+
+    alias :value :has_value?
+
     # Instantiate a new Document. Valid parameters for instantiation is a hash
     # only or nothing.
     #

data/lib/bson/false_class.rb

@@ -49,8 +49,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encoded << FALSE_BYTE
+    def to_bson(buffer = ByteBuffer.new)
+      buffer.put_byte(FALSE_BYTE)
     end
   end
 

data/lib/bson/float.rb

@@ -42,29 +42,23 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encoded << [ self ].pack(PACK)
+    def to_bson(buffer = ByteBuffer.new)
+      buffer.put_double(self)
     end
 
     module ClassMethods
 
       # Deserialize an instance of a Float from a BSON double.
       #
-      # @param [ BSON ] bson The encoded double.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ Float ] The decoded Float.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
-        from_bson_double(bson.read(8))
-      end
-
-      private
-
-      def from_bson_double(double)
-        double.unpack(PACK).first
+      def from_bson(buffer)
+        buffer.get_double
       end
     end
 

data/lib/bson/hash.rb

@@ -21,7 +21,6 @@ module BSON
   #
   # @since 2.0.0
   module Hash
-    include Encodable
 
     # An hash (embedded document) is type 0x03 in the BSON spec.
     #
@@ -38,14 +37,16 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encode_with_placeholder_and_null(BSON_ADJUST, encoded) do |encoded|
-        each do |field, value|
-          encoded << value.bson_type
-          field.to_bson_key(encoded)
-          value.to_bson(encoded)
-        end
+    def to_bson(buffer = ByteBuffer.new)
+      position = buffer.length
+      buffer.put_int32(0)
+      each do |field, value|
+        buffer.put_byte(value.bson_type)
+        buffer.put_cstring(field.to_bson_key)
+        value.to_bson(buffer)
       end
+      buffer.put_byte(NULL_BYTE)
+      buffer.replace_int32(position, buffer.length - position)
     end
 
     # Converts the hash to a normalized value in a BSON document.
@@ -64,19 +65,19 @@ module BSON
 
       # Deserialize the hash from BSON.
       #
-      # @param [ IO ] bson The bson representing a hash.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ Array ] The decoded hash.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
+      def from_bson(buffer)
         hash = Document.allocate
-        bson.read(4) # Swallow the first four bytes.
-        while (type = bson.readbyte.chr) != NULL_BYTE
-          field = bson.gets(NULL_BYTE).from_bson_string.chop!
-          hash.store(field, BSON::Registry.get(type).from_bson(bson))
+        buffer.get_int32 # Throw away the size - todo: just move read position?
+        while (type = buffer.get_byte) != NULL_BYTE
+          field = buffer.get_cstring
+          hash.store(field, BSON::Registry.get(type).from_bson(buffer))
         end
         hash
       end

data/lib/bson/int32.rb

@@ -27,6 +27,11 @@ module BSON
     # @since 2.0.0
     BSON_TYPE = 16.chr.force_encoding(BINARY).freeze
 
+    # The number of bytes constant.
+    #
+    # @since 4.0.0
+    BYTES_LENGTH = 4
+
     # Constant for the int 32 pack directive.
     #
     # @since 2.0.0
@@ -34,21 +39,15 @@ module BSON
 
     # Deserialize an Integer from BSON.
     #
-    # @param [ BSON ] bson The encoded int32.
+    # @param [ ByteBuffer ] buffer The byte buffer.
     #
     # @return [ Integer ] The decoded Integer.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(bson)
-      from_bson_int32(bson.read(4))
-    end
-
-    private
-
-    def self.from_bson_int32(bytes)
-      bytes.unpack(PACK).first
+    def self.from_bson(buffer)
+      buffer.get_int32
     end
 
     # Register this type when the module is loaded.

data/lib/bson/int64.rb

@@ -34,21 +34,15 @@ module BSON
 
     # Deserialize an Integer from BSON.
     #
-    # @param [ BSON ] bson The encoded int64.
+    # @param [ ByteBuffer ] buffer The byte buffer.
     #
     # @return [ Integer ] The decoded Integer.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(bson)
-      from_bson_int64(bson.read(8))
-    end
-
-    private
-
-    def self.from_bson_int64(bytes)
-      bytes.unpack(PACK).first
+    def self.from_bson(buffer)
+      buffer.get_int64
     end
 
     # Register this type when the module is loaded.