bson 4.11.0-java → 4.13.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7adb7902f9a5a688e440c021e8db54f373cd49930f1ca26e4be4242978c86dd8
-  data.tar.gz: f4e42673b1d7becb9d069b5837026b171d3d1884d5548c7a04dc90fbc4e255b1
+  metadata.gz: ec2d89585c800c0c61b58f6902381b36273854a1c2a7f8064bfdc50b838cf123
+  data.tar.gz: be36daad51a87d3e7fd2d783c8a1e7b5d83ab2c4ea6fe515fd02012d5ad996ec
 SHA512:
-  metadata.gz: 97b70aad52dc56049c3776b2348d5f8bf9cea1053fa7dbbad4b05a43677cff6ad0ea6be227601270cc260de21e0d082b3cf950211078b23f16f813779d53e2e0
-  data.tar.gz: a4b983b9900bdf88d9fab2e188cad8819ba9738a4a8c0da937d42123455b703c3bd03317e248ec18254e407d28ab4c21aac3cf9fd0cfdea4e61d5aa00d165093
+  metadata.gz: 79b8c0aa172f5fe850d6b8de145b2e0439a5b07544cfa994a22df322c8f6c88da09b6ca9db7352d0c01fbe9db03546bd9c34a7736a8305d06be992cd68508d9d
+  data.tar.gz: 64d250ddbf130ccc8db0405dd251f23277666bab3900a1b685f574757cf05788c88437d8de02d501e117dec951abec5a0a9d457a64209dbff1e0d8c9ab3519a9

data/README.md

@@ -1,7 +1,6 @@
 BSON
 [![Gem Version][rubygems-img]][rubygems-url]
-[![Build Status][travis-img]][travis-url]
-[![Build status Windows][appveyor-img]][appveyor-url]
+[![Build Status][ghactions-img]][ghactions-url]
 [![Coverage Status][coveralls-img]][coveralls-url]
 [![Inline docs][inch-img]][inch-url]
 ====
@@ -11,7 +10,7 @@ An implementation of the BSON specification in Ruby.
 Compatibility
 -------------
 
-BSON is tested against MRI (2.3+) and JRuby (9.2+).
+BSON is tested against MRI (2.5) and JRuby (9.2+).
 
 Documentation
 -------------
@@ -55,10 +54,8 @@ limitations under the License.
 
 [rubygems-img]: https://badge.fury.io/rb/bson.svg
 [rubygems-url]: http://badge.fury.io/rb/bson
-[travis-img]: https://secure.travis-ci.org/mongodb/bson-ruby.svg?branch=master
-[travis-url]: http://travis-ci.org/mongodb/bson-ruby
-[appveyor-img]: https://ci.appveyor.com/api/projects/status/p5aqko7umsx351nm?svg=true
-[appveyor-url]: https://ci.appveyor.com/project/p-mongo/bson-ruby/branch/master
+[ghactions-img]: https://github.com/mongodb/bson-ruby/actions/workflows/bson-ruby.yml/badge.svg?query=branch%3Amaster
+[ghactions-url]: https://github.com/mongodb/bson-ruby/actions/workflows/bson-ruby.yml?query=branch%3Amaster
 [coveralls-img]: https://coveralls.io/repos/mongodb/bson-ruby/badge.svg?branch=master
 [coveralls-url]: https://coveralls.io/r/mongodb/bson-ruby?branch=master
 [inch-img]: http://inch-ci.org/github/mongodb/bson-ruby.svg?branch=master

data/lib/bson/active_support.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");

data/lib/bson/array.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
     # An array is type 0x04 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 4.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(4.chr, encoding: BINARY).freeze
 
     # Get the array as encoded BSON.
     #

data/lib/bson/binary.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");
@@ -27,7 +28,7 @@ module BSON
     # A binary is type 0x05 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 5.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(5.chr, encoding: BINARY).freeze
 
     # The mappings of subtypes to their single byte identifiers.
     #
@@ -46,7 +47,8 @@ module BSON
       :uuid => 4.chr,
       :md5 => 5.chr,
       :ciphertext => 6.chr,
-      :user => 128.chr
+      :column => 7.chr,
+      :user => 128.chr,
     }.freeze
 
     # The mappings of single byte subtypes to their symbol counterparts.
@@ -169,7 +171,7 @@ module BSON
     #
     # @since 2.3.0
     def inspect
-      "<BSON::Binary:0x#{object_id} type=#{type} data=0x#{data[0, 8].unpack('H*').first}...>"
+      "<BSON::Binary:0x#{object_id} type=#{type} data=0x#{data[0, 8].unpack1('H*')}...>"
     end
 
     # Returns a string representation of the UUID stored in this Binary.
@@ -207,7 +209,8 @@ module BSON
         if representation && representation != :standard
           raise ArgumentError, "Binary of type :uuid can only be stringified to :standard representation, requested: #{representation.inspect}"
         end
-        data.split('').map { |n| '%02x' % n.ord }.join.sub(/(.{8})(.{4})(.{4})(.{12})/, '\1-\2-\3-\4')
+
+        data.split('').map { |n| '%02x' % n.ord }.join.sub(/\A(.{8})(.{4})(.{4})(.{4})(.{12})\z/, '\1-\2-\3-\4-\5')
       when :uuid_old
         if representation.nil?
           raise ArgumentError, 'Representation must be specified for BSON::Binary objects of type :uuid_old'
@@ -229,7 +232,7 @@ module BSON
           hex
         else
           raise ArgumentError, "Invalid representation: #{representation}"
-        end.sub(/(.{8})(.{4})(.{4})(.{12})/, '\1-\2-\3-\4')
+        end.sub(/\A(.{8})(.{4})(.{4})(.{4})(.{12})\z/, '\1-\2-\3-\4-\5')
       else
         raise TypeError, "The type of Binary must be :uuid or :uuid_old, this object is: #{type.inspect}"
       end

data/lib/bson/boolean.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 boolean is type 0x08 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 8.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(8.chr, encoding: BINARY).freeze
 
     # Deserialize a boolean from BSON.
     #

data/lib/bson/code.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 code is type 0x0D in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 13.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(13.chr, encoding: BINARY).freeze
 
     # @!attribute javascript
     #   @return [ String ] The javascript code.

data/lib/bson/code_with_scope.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 code with scope is type 0x0F in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 15.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(15.chr, encoding: BINARY).freeze
 
     # @!attribute javascript
     #   @return [ String ] The javascript code.

data/lib/bson/config.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/date.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/date_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");

data/lib/bson/db_pointer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,7 +23,7 @@ module BSON
     include JSON
 
     # A DBPointer is type 0x0C in the BSON spec.
-    BSON_TYPE = 0x0C.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(0x0C.chr, encoding: BINARY).freeze
 
     # Create a new DBPointer object.
     #

data/lib/bson/dbref.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2015-2021 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+
+  # Represents a DBRef document in the database.
+  class DBRef < Document
+    include JSON
+
+    # The constant for the collection reference field.
+    #
+    # @deprecated
+    COLLECTION = '$ref'.freeze
+
+    # The constant for the id field.
+    #
+    # @deprecated
+    ID = '$id'.freeze
+
+    # The constant for the database field.
+    #
+    # @deprecated
+    DATABASE = '$db'.freeze
+
+    # @return [ String ] collection The collection name.
+    def collection
+      self['$ref']
+    end
+
+    # @return [ BSON::ObjectId ] id The referenced document id.
+    def id
+      self['$id']
+    end
+
+    # @return [ String ] database The database name.
+    def database
+      self['$db']
+    end
+
+    # Get the DBRef as a JSON document
+    #
+    # @example Get the DBRef as a JSON hash.
+    #   dbref.as_json
+    #
+    # @return [ Hash ] The max key as a JSON hash.
+    def as_json(*args)
+      {}.update(self)
+    end
+
+    # Instantiate a new DBRef.
+    #
+    # @example Create the DBRef.
+    #   BSON::DBRef.new({'$ref' => 'users', '$id' => id, '$db' => 'database'})
+    #
+    # @param [ Hash ] hash the DBRef hash. It must contain $ref and $id.
+    def initialize(hash)
+      hash = reorder_fields(hash)
+      %w($ref $id).each do |key|
+        unless hash[key]
+          raise ArgumentError, "DBRef must have #{key}: #{hash}"
+        end
+      end
+
+      unless hash['$ref'].is_a?(String)
+        raise ArgumentError, "The value for key $ref must be a string, got: #{hash['$ref']}"
+      end
+
+      if db = hash['$db']
+        unless db.is_a?(String)
+          raise ArgumentError, "The value for key $db must be a string, got: #{hash['$db']}"
+        end
+      end
+
+      super
+    end
+
+    # Converts the DBRef to raw BSON.
+    #
+    # @example Convert the DBRef to raw BSON.
+    #   dbref.to_bson
+    #
+    # @param [ BSON::ByteBuffer ] buffer The encoded BSON buffer to append to.
+    # @param [ true, false ] validating_keys Whether keys should be validated when serializing.
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
+    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+      as_json.to_bson(buffer, validating_keys)
+    end
+
+    private
+
+    # Reorder the fields of the given Hash to have $ref first, $id second,
+    # and $db third. The rest of the fields in the hash can come in any
+    # order after that.
+    #
+    # @param [ Hash ] hash The input hash. Must be a valid dbref.
+    #
+    # @return [ Hash ] The hash with it's fields reordered.
+    def reorder_fields(hash)
+      hash = BSON::Document.new(hash)
+      reordered = {}
+      reordered['$ref'] = hash.delete('$ref')
+      reordered['$id'] = hash.delete('$id')
+      if db = hash.delete('$db')
+        reordered['$db'] = db
+      end
+
+      reordered.update(hash)
+    end
+  end
+end

data/lib/bson/decimal128/builder.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");
@@ -26,27 +27,27 @@ module BSON
       # Infinity mask.
       #
       # @since 4.2.0
-      INFINITY_MASK = 0x7800000000000000.freeze
+      INFINITY_MASK = 0x7800000000000000
 
       # NaN mask.
       #
       # @since 4.2.0
-      NAN_MASK = 0x7c00000000000000.freeze
+      NAN_MASK = 0x7c00000000000000
 
       # SNaN mask.
       #
       # @since 4.2.0
-      SNAN_MASK = (1 << 57).freeze
+      SNAN_MASK = (1 << 57)
 
       # Signed bit mask.
       #
       # @since 4.2.0
-      SIGN_BIT_MASK = (1 << 63).freeze
+      SIGN_BIT_MASK = (1 << 63)
 
       # The two highest bits of the 64 high order bits.
       #
       # @since 4.2.0
-      TWO_HIGHEST_BITS_SET = (3 << 61).freeze
+      TWO_HIGHEST_BITS_SET = (3 << 61)
 
       extend self
 
@@ -109,14 +110,14 @@ module BSON
         # @return [ Regex ] A regex matching a NaN string.
         #
         # @since 4.2.0
-        NAN_REGEX = /^(\-)?(S)?NaN$/i.freeze
+        NAN_REGEX = /^(\-)?(S)?NaN$/i
 
         # Regex matching a string representing positive or negative Infinity.
         #
         # @return [ Regex ] A regex matching a positive or negative Infinity string.
         #
         # @since 4.2.0
-        INFINITY_REGEX = /^(\+|\-)?Inf(inity)?$/i.freeze
+        INFINITY_REGEX = /^(\+|\-)?Inf(inity)?$/i
 
         # Regex for the fraction, including leading zeros.
         #
@@ -124,33 +125,33 @@ module BSON
         #   including leading zeros.
         #
         # @since 4.2.0
-        SIGNIFICAND_WITH_LEADING_ZEROS_REGEX = /(0*)(\d+)/.freeze
+        SIGNIFICAND_WITH_LEADING_ZEROS_REGEX = /(0*)(\d+)/
 
         # Regex for separating a negative sign from the significands.
         #
         # @return [ Regex ] The regex for separating a sign from significands.
         #
         # @since 4.2.0
-        SIGN_AND_DIGITS_REGEX = /^(\-)?(\S+)/.freeze
+        SIGN_AND_DIGITS_REGEX = /^(\-)?(\S+)/
 
         # Regex matching a scientific exponent.
         #
         # @return [ Regex ] A regex matching E, e, E+, e+.
         #
         # @since 4.2.0
-        SCIENTIFIC_EXPONENT_REGEX = /E\+?/i.freeze
+        SCIENTIFIC_EXPONENT_REGEX = /E\+?/i
 
         # Regex for capturing trailing zeros.
         #
         # @since 4.2.0
-        TRAILING_ZEROS_REGEX = /[1-9]*(0+)$/.freeze
+        TRAILING_ZEROS_REGEX = /[1-9]*(0+)$/
 
         # Regex for a valid decimal128 string format.
         #
         # @return [ Regex ] The regex for a valid decimal128 string.
         #
         # @since 4.2.0
-        VALID_DECIMAL128_STRING_REGEX = /^[\-\+]?(\d+(\.\d*)?|\.\d+)(E[\-\+]?\d+)?$/i.freeze
+        VALID_DECIMAL128_STRING_REGEX = /^[\-\+]?(\d+(\.\d*)?|\.\d+)(E[\-\+]?\d+)?$/i
 
         # Initialize the FromString Builder object.
         #
@@ -337,14 +338,14 @@ module BSON
         # @return [ String ] The string representing NaN.
         #
         # @since 4.2.0
-        NAN_STRING = 'NaN'.freeze
+        NAN_STRING = 'NaN'
 
         # String representing an Infinity value.
         #
         # @return [ String ] The string representing Infinity.
         #
         # @since 4.2.0
-        INFINITY_STRING = 'Infinity'.freeze
+        INFINITY_STRING = 'Infinity'
 
         # Initialize the FromBigDecimal Builder object.
         #
@@ -366,11 +367,13 @@ module BSON
         #
         # @return [ String ] The string representing the decimal128 object.
         #
+        # @note The returned string may be frozen.
+        #
         # @since 4.2.0
         def string
           return NAN_STRING if nan?
           str = infinity? ? INFINITY_STRING : create_string
-          negative? ? '-' << str : str
+          negative? ? "-#{str}" : str
         end
 
         private

data/lib/bson/decimal128.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");
@@ -23,32 +24,32 @@ module BSON
     # A Decimal128 is type 0x13 in the BSON spec.
     #
     # @since 4.2.0
-    BSON_TYPE = 19.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(19.chr, encoding: BINARY).freeze
 
     # Exponent offset.
     #
     # @since 4.2.0
-    EXPONENT_OFFSET = 6176.freeze
+    EXPONENT_OFFSET = 6176
 
     # Minimum exponent.
     #
     # @since 4.2.0
-    MIN_EXPONENT = -6176.freeze
+    MIN_EXPONENT = -6176
 
     # Maximum exponent.
     #
     # @since 4.2.0
-    MAX_EXPONENT = 6111.freeze
+    MAX_EXPONENT = 6111
 
     # Maximum digits of precision.
     #
     # @since 4.2.0
-    MAX_DIGITS_OF_PRECISION = 34.freeze
+    MAX_DIGITS_OF_PRECISION = 34
 
     # Key for this type when converted to extended json.
     #
     # @since 4.2.0
-    EXTENDED_JSON_KEY = "$numberDecimal".freeze
+    EXTENDED_JSON_KEY = "$numberDecimal"
 
     # The native type to which this object can be converted.
     #
@@ -262,7 +263,7 @@ module BSON
       # The custom error message for this error.
       #
       # @since 4.2.0
-      MESSAGE = 'A Decimal128 can only be created from a String or BigDecimal.'.freeze
+      MESSAGE = 'A Decimal128 can only be created from a String or BigDecimal.'
 
       # Get the custom error message for the exception.
       #
@@ -288,7 +289,7 @@ module BSON
       # The custom error message for this error.
       #
       # @since 4.2.0
-      MESSAGE = 'Invalid string format for creating a Decimal128 object.'.freeze
+      MESSAGE = 'Invalid string format for creating a Decimal128 object.'
 
       # Get the custom error message for the exception.
       #
@@ -313,7 +314,7 @@ module BSON
       # The custom error message for this error.
       #
       # @since 4.2.0
-      MESSAGE = 'Value out of range for Decimal128 representation.'.freeze
+      MESSAGE = 'Value out of range for Decimal128 representation.'
 
       # Get the custom error message for the exception.
       #

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