bson 4.7.1 → 4.8.0

data/lib/bson/float.rb

@@ -46,18 +46,64 @@ module BSON
       buffer.put_double(self)
     end
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # This method returns the float itself if relaxed representation is
+    # requested and the value is finite, otherwise a $numberDouble hash.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash | Float ] The extended json representation.
+    def as_extended_json(**options)
+      case infinite?
+      when 1
+        {'$numberDouble' => 'Infinity'}
+      when -1
+        {'$numberDouble' => '-Infinity'}
+      else
+        if nan?
+          {'$numberDouble' => 'NaN'}
+        else
+          if options[:mode] == :relaxed || options[:mode] == :legacy
+            self
+          else
+            value = if BSON::Environment.jruby?
+              # Hack to make bson corpus spec tests pass.
+              # JRuby serializes -1.2345678901234568e+18 as
+              # -1234567890123456770.0, which is valid but differs from MRI
+              # serialization. Extended JSON spec does not define precise
+              # stringification of floats.
+              # https://jira.mongodb.org/browse/SPEC-1536
+              if abs > 1e15
+                '%.17g' % to_s
+              else
+                to_s
+              end
+            else
+              to_s
+            end
+            {'$numberDouble' => value.upcase}
+          end
+        end
+      end
+    end
+
     module ClassMethods
 
       # Deserialize an instance of a Float from a BSON double.
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Float ] The decoded Float.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         buffer.get_double
       end
     end

data/lib/bson/hash.rb

@@ -74,26 +74,46 @@ module BSON
       Document.new(self)
     end
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # This method recursively invokes +as_extended_json+ with the provided
+    # options on each hash value.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] This hash converted to extended json representation.
+    def as_extended_json(**options)
+      ::Hash[map do |key, value|
+        [key, value.as_extended_json(**options)]
+      end]
+    end
+
     module ClassMethods
 
       # Deserialize the hash from BSON.
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Array ] The decoded hash.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         if buffer.respond_to?(:get_hash)
-          buffer.get_hash
+          buffer.get_hash(**options)
         else
           hash = Document.allocate
           buffer.get_int32 # Throw away the size.
           while (type = buffer.get_byte) != NULL_BYTE
             field = buffer.get_cstring
-            hash.store(field, BSON::Registry.get(type, field).from_bson(buffer))
+            cls = BSON::Registry.get(type, field)
+            value = cls.from_bson(buffer, **options)
+            hash.store(field, value)
           end
           hash
         end

data/lib/bson/int32.rb

@@ -40,12 +40,14 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
     # @return [ Integer ] The decoded Integer.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
+    def self.from_bson(buffer, **options)
       buffer.get_int32
     end
 
@@ -115,6 +117,24 @@ module BSON
     alias :eql? :==
     alias :=== :==
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # This method returns the integer value if relaxed representation is
+    # requested, otherwise a $numberInt hash.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash | Integer ] The extended json representation.
+    def as_extended_json(**options)
+      if options[:mode] == :relaxed || options[:mode] == :legacy
+        value
+      else
+        {'$numberInt' => value.to_s}
+      end
+    end
+
     # Register this type when the module is loaded.
     #
     # @since 2.0.0

data/lib/bson/int64.rb

@@ -35,13 +35,20 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
-    # @return [ Integer ] The decoded Integer.
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
+    # @return [ Integer | BSON::Int64 ] The decoded Integer.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
-      buffer.get_int64
+    def self.from_bson(buffer, **options)
+      value = buffer.get_int64
+      if options[:mode] == :bson
+        new(value)
+      else
+        value
+      end
     end
 
     # Instantiate a BSON Int64.
@@ -110,6 +117,24 @@ module BSON
     alias :eql? :==
     alias :=== :==
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # This method returns the integer value if relaxed representation is
+    # requested, otherwise a $numberLong hash.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash | Integer ] The extended json representation.
+    def as_extended_json(**options)
+      if options[:mode] == :relaxed || options[:mode] == :legacy
+        value
+      else
+        {'$numberLong' => value.to_s}
+      end
+    end
+
     # Register this type when the module is loaded.
     #
     # @since 2.0.0

data/lib/bson/integer.rb

@@ -159,6 +159,40 @@ module BSON
       self
     end
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # This method returns the integer itself if relaxed representation is
+    # requested, otherwise a $numberInt hash if the value fits in 32 bits
+    # and a $numberLong otherwise. Regardless of which representation is
+    # requested, a value that does not fit in 64 bits raises RangeError.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash | Integer ] The extended json representation.
+    def as_extended_json(**options)
+      # The behavior of native integers' serialization to extended json is
+      # not specified. Following our bson serialization logic in this file,
+      # produce explicit $numberInt or $numberLong, choosing $numberInt if
+      # the integer fits in 32 bits. In Ruby integers can be arbitrarily
+      # big; integers that do not fit into 64 bits raise an error as we do not
+      # want to silently perform an effective type conversion of integer ->
+      # decimal.
+
+      unless bson_int64?
+        raise RangeError, "Integer #{self} is too big to be represented as a MongoDB integer"
+      end
+
+      if options[:mode] == :relaxed || options[:mode] == :legacy
+        self
+      elsif bson_int32?
+        {'$numberInt' => to_s}
+      else
+        {'$numberLong' => to_s}
+      end
+    end
+
     private
 
     def append_bson_int32(encoded)

data/lib/bson/max_key.rb

@@ -58,7 +58,19 @@ module BSON
     # @return [ Hash ] The max key as a JSON hash.
     #
     # @since 2.0.0
+    # @deprecated Use as_extended_json instead.
     def as_json(*args)
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
       { "$maxKey" => 1 }
     end
 

data/lib/bson/min_key.rb

@@ -58,7 +58,19 @@ module BSON
     # @return [ Hash ] The min key as a JSON hash.
     #
     # @since 2.0.0
+    # @deprecated Use as_extended_json instead.
     def as_json(*args)
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
       { "$minKey" => 1 }
     end
 

data/lib/bson/nil_class.rb

@@ -34,12 +34,14 @@ module BSON
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ nil ] The decoded nil value.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         nil
       end
     end

data/lib/bson/object.rb

@@ -58,6 +58,33 @@ module BSON
     def to_bson_normalized_value
       self
     end
+
+    # Serializes this object to Extended JSON
+    # (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # Subclasses should override +as_extended_json+ rather than this method.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ String ] The extended json serialization.
+    def to_extended_json(**options)
+      as_extended_json(**options).to_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # Subclasses should override this method to provide custom serialization
+    # to Extended JSON.
+    #
+    # @option options [ true | false ] :relaxed Whether to produce relaxed
+    #   extended JSON representation.
+    #
+    # @return [ Object ] The extended json representation.
+    def as_extended_json(**options)
+      self
+    end
   end
 
   # Raised when trying to serialize an object into a key.

data/lib/bson/object_id.rb

@@ -71,7 +71,19 @@ module BSON
     # @return [ Hash ] The object id as a JSON hash.
     #
     # @since 2.0.0
+    # @deprecated Use as_extended_json instead.
     def as_json(*args)
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
       { "$oid" => to_s }
     end
 
@@ -217,10 +229,12 @@ module BSON
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ BSON::ObjectId ] The object id.
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         from_data(buffer.get_bytes(12))
       end
 

data/lib/bson/regexp.rb

@@ -205,7 +205,22 @@ module BSON
       #
       # @since 4.2.0
       def as_json(*args)
-        { "$regex" => source, "$options" => options }
+        as_extended_json(mode: :legacy)
+      end
+
+      # Converts this object to a representation directly serializable to
+      # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+      #
+      # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+      #   (default is canonical extended JSON)
+      #
+      # @return [ Hash ] The extended json representation.
+      def as_extended_json(**opts)
+        if opts[:mode] == :legacy
+          { "$regex" => source, "$options" => options }
+        else
+          {"$regularExpression" => {'pattern' => source, "options" => options}}
+        end
       end
 
       # Check equality of the raw bson regexp against another.
@@ -248,12 +263,14 @@ module BSON
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option opts [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Regexp ] The decoded regular expression.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **opts)
         pattern = buffer.get_cstring
         options = buffer.get_cstring
         Raw.new(pattern, options)

data/lib/bson/specialized.rb

@@ -61,12 +61,14 @@ module BSON
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Specialized ] The decoded specialized class.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         new
       end
     end

data/lib/bson/string.rb

@@ -124,12 +124,14 @@ module BSON
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Regexp ] The decoded string.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         buffer.get_string
       end
     end