bson 4.7.1 → 4.9.1

data/lib/bson/open_struct.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB Inc.
+# Copyright (C) 2016-2020 MongoDB 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/bson/regexp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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/registry.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB 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/bson/specialized.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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

data/lib/bson/symbol.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -89,19 +89,108 @@ module BSON
       to_s
     end
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option options [ true | false ] :relaxed Whether to produce relaxed
+    #   extended JSON representation.
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
+      { "$symbol" => to_s }
+    end
+
+    class Raw
+      # Create a BSON Symbol
+      #
+      # @param [ String | Symbol ] str_or_sym The symbol represented by this
+      #   object. Can be specified as a Symbol or a String.
+      #
+      # @see http://bsonspec.org/#/specification
+      def initialize(str_or_sym)
+        unless str_or_sym.is_a?(String) || str_or_sym.is_a?(Symbol)
+          raise ArgumentError, "BSON::Symbol::Raw must be given a symbol or a string, not #{str_or_sym}"
+        end
+
+        @symbol = str_or_sym.to_sym
+      end
+
+      # Get the underlying symbol as a Ruby symbol.
+      #
+      # @return [ Symbol ] The symbol represented by this BSON object.
+      def to_sym
+        @symbol
+      end
+
+      # Get the underlying symbol as a Ruby string.
+      #
+      # @return [ String ] The symbol as a string.
+      def to_s
+        @symbol.to_s
+      end
+
+      # Check equality of the raw bson symbol against another.
+      #
+      # @param [ Object ] other The object to check against.
+      #
+      # @return [ true, false ] If the objects are equal.
+      def ==(other)
+        return false unless other.is_a?(Raw)
+        to_sym == other.to_sym
+      end
+      alias :eql? :==
+
+      # Get the symbol as encoded BSON.
+      #
+      # @raise [ EncodingError ] If the symbol is not UTF-8.
+      #
+      # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
+      #
+      # @see http://bsonspec.org/#/specification
+      def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+        buffer.put_string(to_s)
+      end
+
+      def bson_type
+        Symbol::BSON_TYPE
+      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 value if relaxed representation is
+      # requested, otherwise a $numberLong hash.
+      #
+      # @option options [ true | false ] :relaxed Whether to produce relaxed
+      #   extended JSON representation.
+      #
+      # @return [ Hash | Integer ] The extended json representation.
+      def as_extended_json(**options)
+        {'$symbol' => to_s}
+      end
+    end
+
     module ClassMethods
 
       # Deserialize a symbol from BSON.
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
-      # @return [ Regexp ] The decoded symbol.
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
+      # @return [ Symbol | BSON::Symbol::Raw ] The decoded symbol.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
-        buffer.get_string.intern
+      def from_bson(buffer, **options)
+        sym = buffer.get_string.intern
+
+        if options[:mode] == :bson
+          Raw.new(sym)
+        else
+          sym
+        end
       end
     end
 

data/lib/bson/time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,6 +17,20 @@ module BSON
   # Injects behaviour for encoding and decoding time values to
   # and from raw bytes as specified by the BSON spec.
   #
+  # @note
+  #   Ruby time can have nanosecond precision:
+  #   +Time.utc(2020, 1, 1, 0, 0, 0, 999_999_999/1000r)+
+  #   +Time#usec+ returns the number of microseconds in the time, and
+  #   if the time has nanosecond precision the sub-microsecond part is
+  #   truncated (the value is floored to the nearest millisecond).
+  #   MongoDB only supports millisecond precision; we truncate the
+  #   sub-millisecond part of microseconds (floor to the nearest millisecond).
+  #   Note that if a time is constructed from a floating point value,
+  #   the microsecond value may round to the starting floating point value
+  #   but due to flooring, the time after serialization may end up to
+  #   be different than the starting floating point value.
+  #   It is recommended that time calculations use integer math only.
+  #
   # @see http://bsonspec.org/#/specification
   #
   # @since 2.0.0
@@ -29,6 +43,8 @@ module BSON
 
     # Get the time as encoded BSON.
     #
+    # @note The time is floored to the nearest millisecond.
+    #
     # @example Get the time as encoded BSON.
     #   Time.new(2012, 1, 1, 0, 0, 0).to_bson
     #
@@ -38,7 +54,48 @@ module BSON
     #
     # @since 2.0.0
     def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
-      buffer.put_int64((to_i * 1000) + (usec / 1000))
+      value = _bson_to_i * 1000 + usec.divmod(1000).first
+      buffer.put_int64(value)
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @note The time is floored to the nearest millisecond.
+    #
+    # @option options [ true | false ] :relaxed Whether to produce relaxed
+    #   extended JSON representation.
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
+      utc_time = utc
+      if options[:mode] == :relaxed && (1970..9999).include?(utc_time.year)
+        if utc_time.usec != 0
+          if utc_time.respond_to?(:floor)
+            # Ruby 2.7+
+            utc_time = utc_time.floor(3)
+          else
+            utc_time -= utc_time.usec.divmod(1000).last.to_r / 1000000
+          end
+          {'$date' => utc_time.strftime('%Y-%m-%dT%H:%M:%S.%LZ')}
+        else
+          {'$date' => utc_time.strftime('%Y-%m-%dT%H:%M:%SZ')}
+        end
+      else
+        sec = utc_time._bson_to_i
+        msec = utc_time.usec.divmod(1000).first
+        {'$date' => {'$numberLong' => (sec * 1000 + msec).to_s}}
+      end
+    end
+
+    def _bson_to_i
+      # Workaround for JRuby's #to_i rounding negative timestamps up
+      # rather than down (https://github.com/jruby/jruby/issues/6104)
+      if BSON::Environment.jruby?
+        (self - usec.to_r/1000000).to_i
+      else
+        to_i
+      end
     end
 
     module ClassMethods
@@ -47,13 +104,15 @@ module BSON
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Time ] The decoded UTC datetime.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
-        seconds, fragment = Int64.from_bson(buffer).divmod(1000)
+      def from_bson(buffer, **options)
+        seconds, fragment = Int64.from_bson(buffer, mode: nil).divmod(1000)
         at(seconds, fragment * 1000).utc
       end
     end

data/lib/bson/time_with_zone.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB Inc.
+# Copyright (C) 2018-2020 MongoDB 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/bson/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -84,7 +84,19 @@ module BSON
     # @return [ Hash ] The timestamp 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)
       { "$timestamp" => { "t" => seconds, "i" => increment } }
     end
 
@@ -120,12 +132,14 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
     # @return [ Timestamp ] The decoded timestamp.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
+    def self.from_bson(buffer, **options)
       increment = buffer.get_int32
       seconds = buffer.get_int32
       new(seconds, increment)

data/lib/bson/true_class.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB 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/bson/undefined.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -41,6 +41,17 @@ module BSON
       self.class == other.class
     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)
+      { "$undefined" => true }
+    end
+
     # Register this type when the module is loaded.
     #
     # @since 2.0.0

data/lib/bson/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.7.1".freeze
+  VERSION = "4.9.1".freeze
 end

data/spec/bson/array_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/spec/bson/binary_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -63,7 +63,7 @@ describe BSON::Binary do
 
     it "returns the binary data plus type" do
       expect(object.as_json).to eq(
-        { "$binary" => Base64.encode64("testing"), "$type" => :user }
+        { "$binary" => {'base64' => Base64.encode64("testing").strip, "subType" => '80' }}
       )
     end
 
@@ -126,12 +126,34 @@ describe BSON::Binary do
   end
 
   describe '#from_bson' do
-    let(:bson) { BSON::ByteBuffer.new("#{5.to_bson}#{0.chr}hello".force_encoding('BINARY')) }
-    let(:obj) { described_class.from_bson(bson) }
+    let(:buffer) { BSON::ByteBuffer.new(bson) }
+    let(:obj) { described_class.from_bson(buffer) }
+
+    let(:bson) { "#{5.to_bson}#{0.chr}hello".force_encoding('BINARY') }
 
     it 'sets data encoding to binary' do
       expect(obj.data.encoding).to eq(Encoding.find('BINARY'))
     end
+
+    context 'when binary subtype is supported' do
+      let(:bson) { [3, 0, 0, 0, 1].map(&:chr).join.force_encoding('BINARY') + 'foo' }
+
+      it 'works' do
+        obj.should be_a(described_class)
+        obj.type.should be :function
+      end
+    end
+
+    context 'when binary subtype is not supported' do
+      let(:bson) { [3, 0, 0, 0, 16].map(&:chr).join.force_encoding('BINARY') + 'foo' }
+
+      it 'raises an exception' do
+        lambda do
+          obj
+        end.should raise_error(BSON::Error::UnsupportedBinarySubtype,
+          /BSON data contains unsupported binary subtype 0x10/)
+      end
+    end
   end
 
   describe "#to_bson/#from_bson" do
@@ -203,6 +225,14 @@ describe BSON::Binary do
       it_behaves_like "a deserializable bson element"
     end
 
+    context "when the type is :cyphertext" do
+      let(:obj)  { described_class.new("testing", :ciphertext) }
+      let(:bson) { "#{7.to_bson}#{6.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
     context 'when given binary string' do
       let(:obj) { described_class.new("\x00\xfe\xff".force_encoding('BINARY')) }
       let(:bson) { "#{3.to_bson}#{0.chr}\x00\xfe\xff".force_encoding('BINARY') }