bson 3.2.7 → 4.0.0.beta

data/lib/bson/integer.rb

@@ -22,16 +22,6 @@ module BSON
   # @since 2.0.0
   module Integer
 
-    # A 32bit integer is type 0x10 in the BSON spec.
-    #
-    # @since 2.0.0
-    INT32_TYPE = 16.chr.force_encoding(BINARY).freeze
-
-    # A 64bit integer is type 0x12 in the BSON spec.
-    #
-    # @since 2.0.0
-    INT64_TYPE = 18.chr.force_encoding(BINARY).freeze
-
     # The maximum 32 bit integer value.
     #
     # @since 2.0.0
@@ -100,7 +90,7 @@ module BSON
     #
     # @since 2.0.0
     def bson_type
-      bson_int32? ? INT32_TYPE : (bson_int64? ? INT64_TYPE : out_of_range!)
+      bson_int32? ? Int32::BSON_TYPE : (bson_int64? ? Int64::BSON_TYPE : out_of_range!)
     end
 
     # Get the integer as encoded BSON.
@@ -113,11 +103,11 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
+    def to_bson(buffer = ByteBuffer.new)
       if bson_int32?
-        to_bson_int32(encoded)
+        buffer.put_int32(self)
       elsif bson_int64?
-        to_bson_int64(encoded)
+        buffer.put_int64(self)
       else
         out_of_range!
       end
@@ -155,12 +145,8 @@ module BSON
       encoded << ((self >> 56) & 255)
     end
 
-    def to_bson_key(encoded = ''.force_encoding(BINARY))
-      if self < BSON_INDEX_SIZE
-        encoded << BSON_ARRAY_INDEXES[self]
-      else
-        self.to_s.to_bson_cstring(encoded)
-      end
+    def to_bson_key(buffer = ByteBuffer.new)
+      buffer.put_cstring(to_s)
     end
 
     private

data/lib/bson/nil_class.rb

@@ -21,37 +21,25 @@ module BSON
   #
   # @since 2.0.0
   module NilClass
+    include Specialized
 
     # A nil is type 0x0A in the BSON spec.
     #
     # @since 2.0.0
     BSON_TYPE = 10.chr.force_encoding(BINARY).freeze
 
-    # Get the nil as encoded BSON.
-    #
-    # @example Get the nil as encoded BSON.
-    #   nil.to_bson
-    #
-    # @return [ String ] An empty string.
-    #
-    # @see http://bsonspec.org/#/specification
-    #
-    # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encoded
-    end
-
     module ClassMethods
+
       # Deserialize NilClass from BSON.
       #
-      # @param [ BSON ] bson The encoded Null value.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ nil ] The decoded nil value.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
+      def from_bson(buffer)
         nil
       end
     end

data/lib/bson/object.rb

@@ -31,7 +31,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.2.4
-    def to_bson_key(encoded = ''.force_encoding(BINARY))
+    def to_bson_key(buffer = ByteBuffer.new)
       raise InvalidKey.new(self)
     end
 

data/lib/bson/object_id.rb

@@ -44,7 +44,7 @@ module BSON
     # @since 2.0.0
     def ==(other)
       return false unless other.is_a?(ObjectId)
-      to_bson == other.to_bson
+      generate_data == other.send(:generate_data)
     end
     alias :eql? :==
 
@@ -86,7 +86,7 @@ module BSON
     #
     # @since 2.0.0
     def <=>(other)
-      to_bson <=> other.to_bson
+      generate_data <=> other.to_bson.to_s
     end
 
     # Return the UTC time at which this ObjectId was generated. This may
@@ -100,7 +100,7 @@ module BSON
     #
     # @since 2.0.0
     def generation_time
-      ::Time.at(to_bson.unpack("N")[0]).utc
+      ::Time.at(generate_data.unpack("N")[0]).utc
     end
 
     # Get the hash value for the object id.
@@ -112,7 +112,7 @@ module BSON
     #
     # @since 2.0.0
     def hash
-      to_bson.hash
+      generate_data.hash
     end
 
     # Get a nice string for use with object inspection.
@@ -136,7 +136,7 @@ module BSON
     #
     # @since 2.0.0
     def marshal_dump
-      to_bson
+      generate_data
     end
 
     # Unmarshal the data into an object id.
@@ -168,10 +168,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      repair if defined?(@data)
-      @raw_data ||= @@generator.next_object_id
-      encoded << @raw_data
+    def to_bson(buffer = ByteBuffer.new)
+      buffer.put_bytes(generate_data)
     end
 
     # Get the string representation of the object id.
@@ -183,7 +181,7 @@ module BSON
     #
     # @since 2.0.0
     def to_s
-      to_bson.to_hex_string.force_encoding(UTF8)
+      generate_data.to_hex_string.force_encoding(UTF8)
     end
     alias :to_str :to_s
 
@@ -194,9 +192,9 @@ module BSON
 
     private
 
-    def initialize_copy(other)
-      to_bson
-      other.instance_variable_set(:@raw_data, @raw_data)
+    def generate_data
+      repair if defined?(@data)
+      @raw_data ||= @@generator.next_object_id
     end
 
     def repair
@@ -211,13 +209,13 @@ module BSON
       # @example Get the object id from BSON.
       #   ObjectId.from_bson(bson)
       #
-      # @param [ String ] bson The raw BSON bytes.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ BSON::ObjectId ] The object id.
       #
       # @since 2.0.0
-      def from_bson(bson)
-        from_data(bson.read(12))
+      def from_bson(buffer)
+        from_data(buffer.get_bytes(12))
       end
 
       # Create a new object id from raw bytes.

data/lib/bson/regexp.rb

@@ -84,9 +84,9 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      source.to_bson_cstring(encoded)
-      bson_options.to_bson_cstring(encoded)
+    def to_bson(buffer = ByteBuffer.new)
+      buffer.put_cstring(source)
+      buffer.put_cstring(bson_options)
     end
 
     private
@@ -168,17 +168,17 @@ module BSON
 
       # Deserialize the regular expression from BSON.
       #
-      # @param [ BSON ] bson The bson representing a regular expression.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ Regexp ] The decoded regular expression.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
-        pattern = bson.gets(NULL_BYTE).from_bson_string.chop!
+      def from_bson(buffer)
+        pattern = buffer.get_cstring
         options = 0
-        while (option = bson.readbyte.chr) != NULL_BYTE
+        while (option = buffer.get_byte) != NULL_BYTE
           case option
           when IGNORECASE_VALUE
             options |= ::Regexp::IGNORECASE

data/lib/bson/specialized.rb

@@ -45,8 +45,8 @@ module BSON
     # @return [ String ] An empty string.
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      encoded
+    def to_bson(buffer = ByteBuffer.new)
+      buffer
     end
 
     private
@@ -57,16 +57,16 @@ module BSON
 
     module ClassMethods
 
-      # Deserialize MinKey from BSON.
+      # Deserialize from BSON.
       #
-      # @param [ BSON ] bson The encoded MinKey.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
-      # @return [ MinKey ] The decoded MinKey.
+      # @return [ Specialized ] The decoded specialized class.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
+      def from_bson(buffer)
         new
       end
     end

data/lib/bson/string.rb

@@ -22,7 +22,6 @@ module BSON
   #
   # @since 2.0.0
   module String
-    include Encodable
 
     # A string is type 0x02 in the BSON spec.
     #
@@ -41,10 +40,8 @@ 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|
-        to_bson_string(encoded)
-      end
+    def to_bson(buffer = ByteBuffer.new)
+      buffer.put_string(self)
     end
 
     # Get the string as a BSON key name encoded C string with checking for special characters.
@@ -59,25 +56,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson_key(encoded = ''.force_encoding(BINARY))
-      to_bson_cstring(encoded)
-    end
-
-    # Get the string as an encoded C string.
-    #
-    # @example Get the string as an encoded C string.
-    #   "test".to_bson_cstring
-    #
-    # @raise [ EncodingError ] If the string is not UTF-8.
-    #
-    # @return [ String ] The encoded string.
-    #
-    # @see http://bsonspec.org/#/specification
-    #
-    # @since 2.0.0
-    def to_bson_cstring(encoded = ''.force_encoding(BINARY))
-      check_for_illegal_characters!
-      to_bson_string(encoded) << NULL_BYTE
+    def to_bson_key
+      self
     end
 
     # Convert the string to an object id. This will only work for strings of size
@@ -97,27 +77,6 @@ module BSON
       ObjectId.repair(self)
     end
 
-    # Convert the string to a UTF-8 string then force to binary. This is so
-    # we get errors for strings that are not UTF-8 encoded.
-    #
-    # @example Convert to valid BSON string.
-    #   "Straße".to_bson_string
-    #
-    # @raise [ EncodingError ] If the string is not UTF-8.
-    #
-    # @return [ String ] The binary string.
-    #
-    # @since 2.0.0
-    def to_bson_string(encoded = ''.force_encoding(BINARY))
-      begin
-        to_utf8_binary(encoded)
-      rescue EncodingError
-        data = dup.force_encoding(UTF8)
-        raise unless data.valid_encoding?
-        encoded << data.force_encoding(BINARY)
-      end
-    end
-
     # Convert the string to a hexidecimal representation.
     #
     # @example Convert the string to hex.
@@ -130,62 +89,19 @@ module BSON
       unpack("H*")[0]
     end
 
-    # Take the binary string and return a UTF-8 encoded string.
-    #
-    # @example Convert from a BSON string.
-    #   "\x00".from_bson_string
-    #
-    # @raise [ EncodingError ] If the string is not UTF-8.
-    #
-    # @return [ String ] The UTF-8 string.
-    #
-    # @since 2.0.0
-    def from_bson_string
-      force_encoding(UTF8)
-    end
-
-    # Set four bytes for int32 in a binary string and return it.
-    #
-    # @example Set int32 in a BSON string.
-    #   "".set_int32(pos, int32)
-    #
-    # @param [ Fixnum ] The position to set.
-    # @param [ Fixnum ] The int32 value.
-    #
-    # @return [ String ] The binary string.
-    #
-    # @since 2.0.0
-    def set_int32(pos, int32)
-      self[pos, 4] = [ int32 ].pack(Int32::PACK)
-    end
-
-    private
-
-    def to_utf8_binary(encoded)
-      encoded << encode(UTF8).force_encoding(BINARY)
-    end
-
     module ClassMethods
 
       # Deserialize a string from BSON.
       #
-      # @param [ BSON ] bson The bson representing a string.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ Regexp ] The decoded string.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
-        bson.read(Int32.from_bson(bson)).from_bson_string.chop!
-      end
-    end
-
-    private
-
-    def check_for_illegal_characters!
-      if include?(NULL_BYTE)
-        raise(ArgumentError, "Illegal C-String '#{self}' contains a null byte.")
+      def from_bson(buffer)
+        buffer.get_string
       end
     end
 

data/lib/bson/symbol.rb

@@ -40,8 +40,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(encoded = ''.force_encoding(BINARY))
-      to_s.to_bson(encoded)
+    def to_bson(buffer = ByteBuffer.new)
+      to_s.to_bson(buffer)
     end
 
     # Get the symbol as a BSON key name encoded C symbol.
@@ -54,8 +54,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson_key(encoded = ''.force_encoding(BINARY))
-      to_s.to_bson_key(encoded)
+    def to_bson_key
+      to_s.to_bson_key
     end
 
     # Converts the symbol to a normalized key in a BSON document.
@@ -71,17 +71,18 @@ module BSON
     end
 
     module ClassMethods
+
       # Deserialize a symbol from BSON.
       #
-      # @param [ BSON ] bson The bson representing a symbol.
+      # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @return [ Regexp ] The decoded symbol.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(bson)
-        bson.read(Int32.from_bson(bson)).from_bson_string.chop!.intern
+      def from_bson(buffer)
+        buffer.get_string.intern
       end
     end