bson 4.11.0 → 4.13.0

data/lib/bson/document.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -269,27 +270,69 @@ module BSON
       end
     end
 
-    if instance_methods.include?(:slice)
-      # Slices a document to include only the given keys.
-      # Will normalize symbol keys into strings.
-      # (this method is backported from ActiveSupport::Hash)
-      #
-      # @example Get a document/hash with only the `name` and `age` fields present
-      #   document # => { _id: <ObjectId>, :name => 'John', :age => 30, :location => 'Earth' }
-      #   document.slice(:name, 'age') # => { name: 'John', age: 30 }
-      #   document.slice('name') # => { name: 'John' }
-      #   document.slice(:foo) # => nil
-      #
-      # @param [ Array<String, Symbol> ] *keys Keys, that will be kept in the resulting document
-      #
-      # @return [ BSON::Document ] The document with only the selected keys
-      #
-      # @since 4.3.1
-      def slice(*keys)
-        super(*keys.map{|key| convert_key(key)})
+    # Slices a document to include only the given keys.
+    # Will normalize symbol keys into strings.
+    # (this method is backported from ActiveSupport::Hash)
+    #
+    # @example Get a document/hash with only the `name` and `age` fields present
+    #   document # => { _id: <ObjectId>, :name => "John", :age => 30, :location => "Earth" }
+    #   document.slice(:name, 'age') # => { "name": "John", "age" => 30 }
+    #   document.slice('name') # => { "name" => "John" }
+    #   document.slice(:foo) # => {}
+    #
+    # @param [ Array<String, Symbol> ] *keys Keys, that will be kept in the resulting document
+    #
+    # @return [ BSON::Document ] The document with only the selected keys
+    #
+    # @since 4.3.1
+    def slice(*keys)
+      keys.each_with_object(self.class.new) do |key, hash|
+        if key?(key)
+          hash[key] = self[key]
+        end
       end
     end
 
+    # Returns a new document consisting of the current document minus the
+    # specified keys.
+    #
+    # The keys to be removed can be specified as either strings or symbols.
+    #
+    # @example Get a document/hash with only the `name` and `age` fields removed
+    #   document # => { _id: <ObjectId>, :name => 'John', :age => 30, :location => 'Earth' }
+    #   document.except(:name, 'age') # => { _id: <ObjectId>, location: 'Earth' }
+    #
+    # @param [ Array<String, Symbol> ] *keys Keys, that will be removed in the resulting document
+    #
+    # @return [ BSON::Document ] The document with the specified keys removed.
+    #
+    # @note This method is always defined, even if Hash already contains a
+    #   definition of #except, because ActiveSupport unconditionally defines
+    #   its version of #except which doesn't work for BSON::Document which
+    #   causes problems if ActiveSupport is loaded after bson-ruby is.
+    def except(*keys)
+      copy = dup
+      keys.each {|key| copy.delete(key)}
+      copy
+    end
+
+    def symbolize_keys!
+      raise ArgumentError, 'symbolize_keys! is not supported on BSON::Document instances. Please convert the document to hash first (using #to_h), then call #symbolize_keys! on the Hash instance'
+    end
+
+    # Override the Hash implementation of to_bson_normalized_value.
+    #
+    # BSON::Document is already of the correct type and already provides
+    # indifferent access to keys, hence no further conversions are necessary.
+    #
+    # Attempting to perform Hash's conversion on Document instances converts
+    # DBRefs to Documents which is wrong.
+    #
+    # @return [ BSON::Document ] The normalized hash.
+    def to_bson_normalized_value
+      self
+    end
+
     private
 
     def convert_key(key)

data/lib/bson/environment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module BSON
   # Base exception class for all BSON-related errors.
   #
@@ -23,5 +24,11 @@ module BSON
     # itself to BSON.
     class UnserializableClass < Error
     end
+
+    # Exception raised when there is an invalid argument passed into the
+    # constructor of regexp object. This includes when the argument contains
+    # a null byte.
+    class InvalidRegexpPattern < Error
+    end
   end
 end

data/lib/bson/ext_json.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -138,7 +139,7 @@ module BSON
         return {}
       end
 
-      if hash.key?('$ref')
+      if dbref?(hash)
         # Legacy dbref handling.
         # Note that according to extended json spec, only hash values (but
         # not the top-level BSON document itself) may be of type "dbref".
@@ -147,10 +148,6 @@ module BSON
         # logic to top level hashes doesn't cause harm.
         hash = hash.dup
         ref = hash.delete('$ref')
-        # $ref can be a string value or an ObjectId
-        unless ref.is_a?(String)
-          raise Error::ExtJSONParseError, "Invalid $ref value: #{ref}"
-        end
         # $id, if present, can be anything
         id = hash.delete('$id')
         if id.is_a?(Hash)
@@ -163,13 +160,9 @@ module BSON
         out = {'$ref' => ref, '$id' => id}
         if hash.key?('$db')
           # $db must always be a string, if provided
-          db = hash.delete('$db')
-          unless db.is_a?(String)
-            raise Error::ExtJSONParseError, "Invalid $db value: #{db}"
-          end
-          out['$db'] = db
+          out['$db'] = hash.delete('$db')
         end
-        return out.update(hash)
+        return out.update(parse_hash(hash))
       end
 
       if hash.length == 1
@@ -219,6 +212,14 @@ module BSON
             raise Error::ExtJSONParseError, "Invalid subType value in $binary: #{value}"
           end
           create_binary(encoded_value, subtype)
+
+        when '$uuid'
+          unless /\A[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\z/.match(value)
+            raise Error::ExtJSONParseError, "Invalid $uuid value: #{value}"
+          end
+
+          return Binary.from_uuid(value)
+
         when '$code'
           unless value.is_a?(String)
             raise Error::ExtJSONParseError, "Invalid $code value: #{value}"
@@ -354,6 +355,9 @@ module BSON
 
     module_function def map_hash(hash, **options)
       ::Hash[hash.map do |key, value|
+        if (key.is_a?(String) || key.is_a?(Symbol)) && key.to_s.include?(NULL_BYTE)
+          raise Error::ExtJSONParseError, "Hash key cannot contain a null byte: #{key}"
+        end
         [key, parse_obj(value, **options)]
       end]
     end
@@ -371,5 +375,14 @@ module BSON
     module_function def create_regexp(pattern, options)
       Regexp::Raw.new(pattern, options)
     end
+
+    module_function def dbref?(hash)
+      if db = hash.key?('$db')
+        unless db.is_a?(String)
+          return false
+        end
+      end
+      return hash['$ref']&.is_a?(String) && hash.key?('$id')
+    end
   end
 end

data/lib/bson/false_class.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +26,7 @@ module BSON
     # A false value in the BSON spec is 0x00.
     #
     # @since 2.0.0
-    FALSE_BYTE = 0.chr.force_encoding(BINARY).freeze
+    FALSE_BYTE = String.new(0.chr, encoding: BINARY).freeze
 
     # The BSON type for false values is the general boolean type of 0x08.
     #

data/lib/bson/float.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,12 +26,12 @@ module BSON
     # A floating point is type 0x01 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 1.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(1.chr, encoding: BINARY).freeze
 
     # The pack directive is for 8 byte floating points.
     #
     # @since 2.0.0
-    PACK = "E".freeze
+    PACK = "E"
 
     # Get the floating point as encoded BSON.
     #
@@ -57,36 +58,24 @@ module BSON
     #
     # @return [ Hash | Float ] The extended json representation.
     def as_extended_json(**options)
-      case infinite?
-      when 1
-        {'$numberDouble' => 'Infinity'}
-      when -1
-        {'$numberDouble' => '-Infinity'}
+      if infinite? == 1
+        { '$numberDouble' => 'Infinity' }
+      elsif infinite? == -1
+        { '$numberDouble' => '-Infinity' }
+      elsif nan?
+        { '$numberDouble' => 'NaN' }
+      elsif options[:mode] == :relaxed || options[:mode] == :legacy
+        self
+      elsif BSON::Environment.jruby? && abs > 1e15
+        # 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
+        { '$numberDouble' => ('%.17g' % to_s).upcase }
       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
+        { '$numberDouble' => to_s.upcase }
       end
     end
 

data/lib/bson/hash.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +26,7 @@ module BSON
     # A hash, also called an embedded document, is type 0x03 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 3.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(3.chr, encoding: BINARY).freeze
 
     # Get the hash as encoded BSON.
     #
@@ -70,7 +71,7 @@ module BSON
     # @example Convert the hash to a normalized value.
     #   hash.to_bson_normalized_value
     #
-    # @return [ BSON::Document ] The normazlied hash.
+    # @return [ BSON::Document ] The normalized hash.
     #
     # @since 3.0.0
     def to_bson_normalized_value
@@ -88,9 +89,7 @@ module BSON
     #
     # @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]
+      transform_values { |value| value.as_extended_json(**options) }
     end
 
     module ClassMethods
@@ -101,7 +100,7 @@ module BSON
       #
       # @option options [ nil | :bson ] :mode Decoding mode to use.
       #
-      # @return [ Array ] The decoded hash.
+      # @return [ Hash ] The decoded hash.
       #
       # @see http://bsonspec.org/#/specification
       #
@@ -129,6 +128,16 @@ module BSON
           if actual_byte_size != expected_byte_size
             raise Error::BSONDecodeError, "Expected hash to take #{expected_byte_size} bytes but it took #{actual_byte_size} bytes"
           end
+
+          if hash['$ref'] && hash['$id']
+            # We're doing implicit decoding here. If the document is an invalid
+            # dbref, we should decode it as a BSON::Document.
+            begin
+              hash = DBRef.new(hash)
+            rescue ArgumentError
+            end
+          end
+
           hash
         end
       end

data/lib/bson/int32.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,7 +25,7 @@ module BSON
     # A boolean is type 0x08 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 16.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(16.chr, encoding: BINARY).freeze
 
     # The number of bytes constant.
     #
@@ -34,7 +35,7 @@ module BSON
     # Constant for the int 32 pack directive.
     #
     # @since 2.0.0
-    PACK = "l<".freeze
+    PACK = "l<"
 
     # Deserialize an Integer from BSON.
     #

data/lib/bson/int64.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,12 +25,12 @@ module BSON
     # A boolean is type 0x08 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 18.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(18.chr, encoding: BINARY).freeze
 
     # Constant for the int 64 pack directive.
     #
     # @since 2.0.0
-    PACK = "q<".freeze
+    PACK = "q<"
 
     # Deserialize an Integer from BSON.
     #

data/lib/bson/integer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -45,13 +46,13 @@ module BSON
     # The BSON index size.
     #
     # @since 2.0.0
-    BSON_INDEX_SIZE = 1024.freeze
+    BSON_INDEX_SIZE = 1024
 
     # A hash of index values for array optimization.
     #
     # @since 2.0.0
     BSON_ARRAY_INDEXES = ::Array.new(BSON_INDEX_SIZE) do |i|
-      (i.to_s.force_encoding(BINARY) << NULL_BYTE).freeze
+      (i.to_s.b << NULL_BYTE).freeze
     end.freeze
 
     # Is this integer a valid BSON 32 bit value?

data/lib/bson/json.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/max_key.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,12 +29,12 @@ module BSON
     # A $maxKey is type 0x7F in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 127.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(127.chr, encoding: BINARY).freeze
 
     # Constant for always evaluating greater in a comparison.
     #
     # @since 2.0.0
-    GREATER = 1.freeze
+    GREATER = 1
 
     # When comparing a max key with any other object, the max key will always
     # be greater.

data/lib/bson/min_key.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,12 +29,12 @@ module BSON
     # A $minKey is type 0xFF in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 255.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(255.chr, encoding: BINARY).freeze
 
     # Constant for always evaluating lesser in a comparison.
     #
     # @since 2.0.0
-    LESSER = -1.freeze
+    LESSER = -1
 
     # When comparing a min key with any other object, the min key will always
     # be lesser.

data/lib/bson/nil_class.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,7 +27,7 @@ module BSON
     # A nil is type 0x0A in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 10.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(10.chr, encoding: BINARY).freeze
 
     module ClassMethods
 

data/lib/bson/object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/object_id.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,7 +31,7 @@ module BSON
     # A object_id is type 0x07 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 7.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(7.chr, encoding: BINARY).freeze
 
     # Check equality of the object id with another object.
     #
@@ -112,7 +113,7 @@ module BSON
     #
     # @since 2.0.0
     def generation_time
-      ::Time.at(generate_data.unpack("N")[0]).utc
+      ::Time.at(generate_data.unpack1("N")).utc
     end
     alias :to_time :generation_time
 
@@ -352,7 +353,7 @@ module BSON
       # @since 2.0.0
       def initialize
         @counter = rand(0x1000000)
-        @machine_id = Digest::MD5.digest(Socket.gethostname).unpack("N")[0]
+        @machine_id = Digest::MD5.digest(Socket.gethostname).unpack1("N")
         @mutex = Mutex.new
       end
 

data/lib/bson/open_struct.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/regexp.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,34 +27,34 @@ module BSON
     # A regular expression is type 0x0B in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 11.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(11.chr, encoding: BINARY).freeze
 
     # Extended value constant.
     #
     # @since 3.2.6
-    EXTENDED_VALUE = 'x'.freeze
+    EXTENDED_VALUE = 'x'
 
     # Ignore case constant.
     #
     # @since 3.2.6
-    IGNORECASE_VALUE = 'i'.freeze
+    IGNORECASE_VALUE = 'i'
 
     # Multiline constant.
     #
     # @since 3.2.6
-    MULTILINE_VALUE = 'm'.freeze
+    MULTILINE_VALUE = 'm'
 
     # Newline constant.
     #
     # @since 3.2.6
-    NEWLINE_VALUE = 's'.freeze
+    NEWLINE_VALUE = 's'
 
     # Ruby multiline constant.
     #
     # @since 3.2.6
     #
     # @deprecated Will be removed in 5.0
-    RUBY_MULTILINE_VALUE = 'ms'.freeze
+    RUBY_MULTILINE_VALUE = 'ms'
 
     # Get the regexp as JSON hash data.
     #
@@ -154,6 +155,16 @@ module BSON
       #
       # @since 3.0.0
       def initialize(pattern, options = '')
+        if pattern.include?(NULL_BYTE)
+          raise Error::InvalidRegexpPattern, "Regexp pattern cannot contain a null byte: #{pattern}"
+        elsif options.is_a?(String) || options.is_a?(Symbol)
+          if options.to_s.include?(NULL_BYTE)
+            raise Error::InvalidRegexpPattern, "Regexp options cannot contain a null byte: #{options}"
+          end
+        elsif !options.is_a?(Integer)
+          raise ArgumentError, "Regexp options must be a String, Symbol, or Integer"
+        end
+
         @pattern = pattern
         @options = options
       end

data/lib/bson/registry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/specialized.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/string.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,12 +27,12 @@ module BSON
     # A string is type 0x02 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 2.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(2.chr, encoding: BINARY).freeze
 
     # Regex for matching illegal BSON keys.
     #
     # @since 4.1.0
-    ILLEGAL_KEY = /(\A[$])|(\.)/.freeze
+    ILLEGAL_KEY = /(\A[$])|(\.)/
 
     # Get the string as encoded BSON.
     #

data/lib/bson/symbol.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,7 +29,7 @@ module BSON
     # A symbol is type 0x0E in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 14.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(14.chr, encoding: BINARY).freeze
 
     # Symbols are serialized as strings as symbols are now removed from the
     # BSON specification. Therefore the bson_type when serializing must be a

data/lib/bson/time.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,7 +40,7 @@ module BSON
     # A time is type 0x09 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 9.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(9.chr, encoding: BINARY).freeze
 
     # Get the time as encoded BSON.
     #
@@ -63,8 +64,8 @@ module BSON
     #
     # @note The time is floored to the nearest millisecond.
     #
-    # @option options [ true | false ] :relaxed Whether to produce relaxed
-    #   extended JSON representation.
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
     #
     # @return [ Hash ] The extended json representation.
     def as_extended_json(**options)

data/lib/bson/time_with_zone.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");