bson 4.11.1-java → 4.14.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725cd0cbc7f1ffe6b21db7a0bba75f06004cfe840bdc960ec3e800017b655bcd
-  data.tar.gz: ded62238e5d764555a8325e22832383413923fd794f5f342bc908d97868e1676
+  metadata.gz: a6f6b835c12a713aa18d8d1abeb460dc85fcb837bfefc13453dda3112be439dd
+  data.tar.gz: 8261ec5da2240e161132b2e8c47b5046b17e0d104b9d2c3ce5072b5fa235e0de
 SHA512:
-  metadata.gz: 6d0b0a456f5bf8ac39396cceb105f7ef0f28cf17694583e4da3d9fb4385e8852151b1408ea15e77a27154013602f317f67ab8b2be83cae195fe579c34723ce0b
-  data.tar.gz: c21d38cb8696363b1ddbc87c781e2109b236ba99de9dfb86e9daa8cabacf230b83d84f06d68bbebbe7aafa6598358d77a395a6ee2426fc337b5cbaa07510b10c
+  metadata.gz: 5c77960c493303c90d8744694fca1fd3f8340533d6c4bc54ee2f614cab7fae29889ad3e6c458a83df8d7ea3eb8c3ad4d881c9c29cf58c3f005d95e343cf38228
+  data.tar.gz: 17e42012d096f348562df54bd63d5da2bce881f60be3e8e114dbd2c9e91da219e74aca7660c336aab2297105cb2f3e329e2c161abb3929a4e854c1e0d745f497

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/big_decimal.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# Copyright (C) 2009-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
+
+  # Injects behaviour for encoding and decoding BigDecimals
+  # to and from raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  module BigDecimal
+
+    # BigDecimals are serialized as Decimal128s under the hood. A Decimal128 
+    # is type 0x13 in the BSON spec.
+    BSON_TYPE = ::String.new(19.chr, encoding: BINARY).freeze
+
+    # Get the BigDecimal as encoded BSON.
+    #
+    # @example Get the BigDecimal as encoded BSON.
+    #   BigDecimal("1").to_bson
+    #
+    # @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?)
+      BSON::Decimal128.new(to_s).to_bson(buffer, validating_keys)
+    end
+
+    # Get the BSON type for BigDecimal. This is the same BSON type as
+    # BSON::Decimal128.
+    def bson_type
+      BSON_TYPE
+    end
+
+    module ClassMethods
+
+      # Deserialize the BigDecimal from raw BSON bytes.
+      #
+      # @example Get the BigDecimal from BSON.
+      #   BigDecimal.from_bson(bson)
+      #
+      # @param [ ByteBuffer ] buffer The byte buffer.
+      #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
+      # @return [ BigDecimal ] The decimal object.
+      def from_bson(buffer, **options)
+        Decimal128.from_bson(buffer, **options).to_big_decimal
+      end
+    end
+  end
+
+  # Enrich the core BigDecimal class with this module.
+  ::BigDecimal.send(:include, BigDecimal)
+  ::BigDecimal.send(:extend, BigDecimal::ClassMethods)
+end

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
 
@@ -84,9 +85,13 @@ module BSON
       private
 
       def validate_range!(exponent, significand)
-        unless valid_significand?(significand) && valid_exponent?(exponent)
+        unless valid_exponent?(exponent)
           raise Decimal128::InvalidRange.new
         end
+
+        unless valid_significand?(significand)
+          raise Decimal128::UnrepresentablePrecision.new
+        end
       end
 
       def valid_significand?(significand)
@@ -109,14 +114,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 +129,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.
         #
@@ -301,11 +306,11 @@ module BSON
 
         def to_special_bits
           case @big_decimal.sign
-            when BigDecimal::SIGN_POSITIVE_INFINITE
+            when ::BigDecimal::SIGN_POSITIVE_INFINITE
               high = INFINITY_MASK
-            when BigDecimal::SIGN_NEGATIVE_INFINITE
+            when ::BigDecimal::SIGN_NEGATIVE_INFINITE
               high = INFINITY_MASK | SIGN_BIT_MASK
-            when BigDecimal::SIGN_NaN
+            when ::BigDecimal::SIGN_NaN
               high = NAN_MASK
           end
           [ 0, high ]
@@ -314,7 +319,7 @@ module BSON
         def to_bits
           sign, significand_str, base, exp = @big_decimal.split
           exponent = @big_decimal.zero? ? 0 : exp - significand_str.length
-          is_negative = (sign == BigDecimal::SIGN_NEGATIVE_FINITE || sign == BigDecimal::SIGN_NEGATIVE_ZERO)
+          is_negative = (sign == ::BigDecimal::SIGN_NEGATIVE_FINITE || sign == ::BigDecimal::SIGN_NEGATIVE_ZERO)
           Builder.parts_to_bits(significand_str.to_i,
                                 exponent,
                                 is_negative)
@@ -337,14 +342,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 +371,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.
       #
@@ -303,9 +304,7 @@ module BSON
       end
     end
 
-    # Raised when the exponent or significand provided is outside the valid range.
-    #
-    # @api private
+    # Raised when the exponent is outside the valid range.
     #
     # @since 4.2.0
     class InvalidRange < RuntimeError
@@ -313,7 +312,8 @@ module BSON
       # The custom error message for this error.
       #
       # @since 4.2.0
-      MESSAGE = 'Value out of range for Decimal128 representation.'.freeze
+      # @deprecated
+      MESSAGE = 'Value out of range for Decimal128 representation.'
 
       # Get the custom error message for the exception.
       #
@@ -328,6 +328,21 @@ module BSON
       end
     end
 
+    # Raised when the significand provided is outside the valid range.
+    #
+    # @note This class derives from InvalidRange for backwards compatibility,
+    #   however when RUBY-1806 is implemented it should be changed to derive
+    #   from the base BSON exception class.
+    class UnrepresentablePrecision < InvalidRange
+
+      # Get the custom error message for the exception.
+      #
+      # @return [ String ] The error message.
+      def message
+        'The value contains too much precision for Decimal128 representation'
+      end
+    end
+
     Registry.register(BSON_TYPE, self)
   end
 end