bson 4.15.0 → 5.0.2

data/lib/bson/code_with_scope.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -52,21 +53,18 @@ module BSON
       javascript == other.javascript && scope == other.scope
     end
 
-    # Get the code with scope as JSON hash data.
+    # Return a representation of the object for use in
+    # application-level JSON serialization. Since BSON::CodeWithScope
+    # is used exclusively in BSON-related contexts, this
+    # method returns the canonical Extended JSON representation.
     #
-    # @example Get the code with scope as a JSON hash.
-    #   code_with_scope.as_json
-    #
-    # @return [ Hash ] The code with scope as a JSON hash.
-    #
-    # @since 2.0.0
-    # @deprecated Use as_extended_json instead.
-    def as_json(*args)
+    # @return [ Hash ] The extended json representation.
+    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).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)
@@ -100,7 +98,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       position = buffer.length
       buffer.put_int32(0)
       buffer.put_string(javascript)

data/lib/bson/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,32 +22,5 @@ module BSON
   module Config
     extend self
 
-    # Set the configuration option for BSON to validate keys or not.
-    #
-    # @example Set the config option.
-    #   BSON::Config.validating_keys = true
-    #
-    # @param [ true, false ] value The value to set.
-    #
-    # @return [ true, false ] The value.
-    #
-    # @since 4.1.0
-    def validating_keys=(value)
-      @validating_keys = value
-    end
-
-    # Returns true if BSON will validate the document keys on serialization to
-    # determine if they contain invalid MongoDB values. Invalid keys start with
-    # '$' or contain a '.' in them.
-    #
-    # @example Is BSON validating keys?
-    #   BSON::Config.validating_keys?
-    #
-    # @return [ true, false ] If BSON is validating keys?
-    #
-    # @since 4.1.0
-    def validating_keys?
-      !!(@validating_keys||=nil)
-    end
   end
 end

data/lib/bson/date.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -45,7 +46,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.1.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       buffer.put_int64((jd - DATE_REFERENCE) * MILLISECONDS_IN_DAY)
     end
 

data/lib/bson/date_time.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,7 +36,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.1.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       gregorian.to_time.to_bson(buffer)
     end
   end

data/lib/bson/db_pointer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -54,24 +55,22 @@ module BSON
       ref == other.ref && id == other.id
     end
 
-    # Get the DBPointer as JSON hash data
+    # Return a representation of the object for use in
+    # application-level JSON serialization. Since BSON::DbPointer
+    # is used exclusively in BSON-related contexts, this
+    # method returns the canonical Extended JSON representation.
     #
-    # @return [ Hash ] The DBPointer as a JSON hash.
-    #
-    # @deprecated Use as_extended_json instead.
-    def as_json(*args)
+    # @return [ Hash ] The extended json representation.
+    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 options [ true | false ] :relaxed Whether to produce relaxed
-    #   extended JSON representation.
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @return [ Hash ] The extended json representation.
-    def as_extended_json(**options)
-      {'$dbPointer' => { "$ref" => ref, '$id' => id.as_extended_json }}
+    def as_extended_json(**_options)
+      { '$dbPointer' => { "$ref" => ref, '$id' => id.as_extended_json } }
     end
 
     # Encode the DBPointer.
@@ -79,9 +78,9 @@ module 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?)
+    def to_bson(buffer = ByteBuffer.new)
       buffer.put_string(ref)
-      id.to_bson(buffer, validating_keys)
+      id.to_bson(buffer)
       buffer
     end
 

data/lib/bson/dbref.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2021 MongoDB Inc.
 #
@@ -74,18 +74,21 @@ module BSON
     #   this parameter must be a String containing the collection name.
     # @param [ Object ] id The object id, when using the legacy API.
     # @param [ String ] database The database name, when using the legacy API.
+    #
+    # @raise [ BSON::Error::InvalidDBRefArgument ] if giving invalid arguments
+    #   to the constructor.
     def initialize(hash_or_collection, id = nil, database = nil)
       if hash_or_collection.is_a?(Hash)
         hash = hash_or_collection
 
         unless id.nil? && database.nil?
-          raise ArgumentError, 'When using the hash API, DBRef constructor accepts only one argument'
+          raise Error::InvalidDBRefArgument, 'When using the hash API, DBRef constructor accepts only one argument'
         end
       else
         warn("BSON::DBRef constructor called with the legacy API - please use the hash API instead")
 
         if id.nil?
-          raise ArgumentError, 'When using the legacy constructor API, id must be provided'
+          raise Error::InvalidDBRefArgument, 'When using the legacy constructor API, id must be provided'
         end
 
         hash = {
@@ -98,17 +101,17 @@ module BSON
       hash = reorder_fields(hash)
       %w($ref $id).each do |key|
         unless hash[key]
-          raise ArgumentError, "DBRef must have #{key}: #{hash}"
+          raise Error::InvalidDBRefArgument, "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']}"
+        raise Error::InvalidDBRefArgument, "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']}"
+          raise Error::InvalidDBRefArgument, "The value for key $db must be a string, got: #{hash['$db']}"
         end
       end
 
@@ -121,11 +124,10 @@ module 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)
+    def to_bson(buffer = ByteBuffer.new)
+      as_json.to_bson(buffer)
     end
 
     private

data/lib/bson/decimal128/builder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -86,11 +87,11 @@ module BSON
 
       def validate_range!(exponent, significand)
         unless valid_exponent?(exponent)
-          raise Decimal128::InvalidRange.new
+          raise Error::InvalidDecimal128Range.new
         end
 
         unless valid_significand?(significand)
-          raise Decimal128::UnrepresentablePrecision.new
+          raise Error::UnrepresentablePrecision.new
         end
       end
 
@@ -155,7 +156,7 @@ module BSON
         # @return [ Regex ] The regex for a valid decimal128 string.
         #
         # @since 4.2.0
-        VALID_DECIMAL128_STRING_REGEX = /^[\-\+]?(\d+(\.\d*)?|\.\d+)(E[\-\+]?\d+)?$/i
+        VALID_DECIMAL128_STRING_REGEX = /\A[\-\+]?(\d+(\.\d*)?|\.\d+)(E[\-\+]?\d+)?\Z/i
 
         # Initialize the FromString Builder object.
         #
@@ -189,9 +190,9 @@ module BSON
         private
 
         def to_bits
-          original, sign, digits_str = SIGN_AND_DIGITS_REGEX.match(@string).to_a
-          digits, e, scientific_exp = digits_str.partition(SCIENTIFIC_EXPONENT_REGEX)
-          before_decimal, decimal, after_decimal = digits.partition('.')
+          _, sign, digits_str = SIGN_AND_DIGITS_REGEX.match(@string).to_a
+          digits, _, scientific_exp = digits_str.partition(SCIENTIFIC_EXPONENT_REGEX)
+          before_decimal, _, after_decimal = digits.partition('.')
 
           significand_str = before_decimal << after_decimal
           significand_str = SIGNIFICAND_WITH_LEADING_ZEROS_REGEX.match(significand_str).to_a[2]
@@ -262,7 +263,7 @@ module BSON
         end
 
         def validate_format!
-          raise BSON::Decimal128::InvalidString.new unless @string =~ VALID_DECIMAL128_STRING_REGEX
+          raise Error::InvalidDecimal128String.new unless @string =~ VALID_DECIMAL128_STRING_REGEX
         end
       end
 
@@ -317,7 +318,7 @@ module BSON
         end
 
         def to_bits
-          sign, significand_str, base, exp = @big_decimal.split
+          sign, significand_str, _, 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)
           Builder.parts_to_bits(significand_str.to_i,
@@ -452,4 +453,4 @@ module BSON
       end
     end
   end
-end
+end

data/lib/bson/decimal128.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,27 +58,28 @@ module BSON
     # @since 4.2.0
     NATIVE_TYPE = BigDecimal
 
-    # Get the Decimal128 as JSON hash data.
+    # Return a string representation of the Decimal128 use in standard
+    # application-level JSON serialization. Returns nil for non-real
+    # numbers such as NaN and Infinity to be compatible with ActiveSupport.
+    # This method is intentionally different from #as_extended_json.
     #
-    # @example Get the Decimal128 as a JSON hash.
+    # @example Get the Decimal128 as a JSON-serializable object.
     #   decimal.as_json
     #
-    # @return [ Hash ] The number as a JSON hash.
-    #
-    # @since 4.2.0
-    # @deprecated Use as_extended_json instead.
+    # @return [ String | nil ] The decimal128 as a String or nil for non-representable numbers.
     def as_json(*args)
-      as_extended_json
+      value = to_s
+      value unless %w[NaN Infinity -Infinity].include?(value)
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)
     #
     # @return [ Hash ] The extended json representation.
-    def as_extended_json(**options)
+    def as_extended_json(**_options)
       { EXTENDED_JSON_KEY => to_s }
     end
 
@@ -99,9 +101,9 @@ module BSON
     alias :eql? :==
 
     def <=>(other)
-      to_big_decimal <=> case other
+      to_d <=> case other
         when Decimal128
-          other.to_big_decimal
+          other.to_d
         else
           other
         end
@@ -115,7 +117,7 @@ module BSON
     # @param [ String, BigDecimal ] object The BigDecimal or String to use for
     #   instantiating a Decimal128.
     #
-    # @raise [ InvalidArgument ] When argument is not a String or BigDecimal.
+    # @raise [ BSON::Error::InvalidDecimal128Argument ] When argument is not a String or BigDecimal.
     #
     # @since 4.2.0
     def initialize(object)
@@ -124,10 +126,15 @@ module BSON
       elsif object.is_a?(BigDecimal)
         set_bits(*Builder::FromBigDecimal.new(object).bits)
       else
-        raise InvalidArgument.new
+        raise Error::InvalidDecimal128Argument.new
       end
     end
 
+    # Get the BSON type for Decimal128.
+    def bson_type
+      BSON_TYPE
+    end
+
     # Get the decimal128 as its raw BSON data.
     #
     # @example Get the raw bson bytes in a buffer.
@@ -138,7 +145,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 4.2.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       buffer.put_decimal128(@low, @high)
     end
 
@@ -189,7 +196,7 @@ module BSON
     # @example
     #  decimal128 = BSON::Decimal128.new("0.200")
     #    => BSON::Decimal128('0.200')
-    #  big_decimal = decimal128.to_big_decimal
+    #  big_decimal = decimal128.to_d
     #    => #<BigDecimal:7fc619c95388,'0.2E0',9(18)>
     #  big_decimal.to_s
     #    => "0.2E0"
@@ -198,11 +205,10 @@ module BSON
     # and -sNaN while Ruby's BigDecimal cannot.
     #
     # @return [ BigDecimal ] The decimal as a BigDecimal.
-    #
-    # @since 4.2.0
-    def to_big_decimal
+    def to_d
       @big_decimal ||= BigDecimal(to_s)
     end
+    alias :to_big_decimal :to_d
 
     private
 
@@ -236,7 +242,7 @@ module BSON
       #
       # @param [ String ] string The string to parse.
       #
-      # @raise [ BSON::Decimal128::InvalidString ] If the provided string is invalid.
+      # @raise [ BSON::Error:InvalidDecimal128String ] If the provided string is invalid.
       #
       # @return [ BSON::Decimal128 ] The new decimal128.
       #
@@ -262,97 +268,5 @@ module BSON
         decimal
       end
     end
-
-    # Raised when trying to create a Decimal128 from an object that is neither a String nor a BigDecimal.
-    #
-    # @api private
-    #
-    # @since 4.2.0
-    class InvalidArgument < ArgumentError
-
-      # The custom error message for this error.
-      #
-      # @since 4.2.0
-      MESSAGE = 'A Decimal128 can only be created from a String or BigDecimal.'
-
-      # Get the custom error message for the exception.
-      #
-      # @example Get the message.
-      #   error.message
-      #
-      # @return [ String ] The error message.
-      #
-      # @since 4.2.0
-      def message
-        MESSAGE
-      end
-    end
-
-    # Raised when trying to create a Decimal128 from a string with
-    #   an invalid format.
-    #
-    # @api private
-    #
-    # @since 4.2.0
-    class InvalidString < RuntimeError
-
-      # The custom error message for this error.
-      #
-      # @since 4.2.0
-      MESSAGE = 'Invalid string format for creating a Decimal128 object.'
-
-      # Get the custom error message for the exception.
-      #
-      # @example Get the message.
-      #   error.message
-      #
-      # @return [ String ] The error message.
-      #
-      # @since 4.2.0
-      def message
-        MESSAGE
-      end
-    end
-
-    # Raised when the exponent is outside the valid range.
-    #
-    # @since 4.2.0
-    class InvalidRange < RuntimeError
-
-      # The custom error message for this error.
-      #
-      # @since 4.2.0
-      # @deprecated
-      MESSAGE = 'Value out of range for Decimal128 representation.'
-
-      # Get the custom error message for the exception.
-      #
-      # @example Get the message.
-      #   error.message
-      #
-      # @return [ String ] The error message.
-      #
-      # @since 4.2.0
-      def message
-        MESSAGE
-      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

data/lib/bson/document.rb

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

data/lib/bson/environment.rb

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

data/lib/bson/error/bson_decode_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+
+    # Exception raised when BSON decoding fails.
+    class BSONDecodeError < Error
+    end
+  end
+end

data/lib/bson/error/ext_json_parse_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+
+    # Exception raised when Extended JSON parsing fails.
+    class ExtJSONParseError < Error
+    end
+  end
+end

data/lib/bson/error/illegal_key.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+
+    # Raised when validating keys and a key is illegal in MongoDB
+    class IllegalKey < Error
+
+      # Instantiate the exception.
+      #
+      # @example Instantiate the exception.
+      #   BSON::Error::IllegalKey.new(string)
+      #
+      # @param [ String ] string The illegal string.
+      #
+      # @api private
+      def initialize(string)
+        super("'#{string}' is an illegal key in MongoDB. Keys may not start with '$' or contain a '.'.")
+      end
+    end
+  end
+end

data/lib/bson/error/invalid_binary_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+
+    # Raised when providing an invalid type to the Binary.
+    class InvalidBinaryType < Error
+
+      # @return [ Object ] The invalid type.
+      attr_reader :type
+
+      # Instantiate the new error.
+      #
+      # @example Instantiate the error.
+      #   InvalidBinaryType.new(:error)
+      #
+      # @param [ Object ] type The invalid type.
+      #
+      # @api private
+      def initialize(type)
+        @type = type
+      end
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      def message
+        "#{type.inspect} is not a valid binary type. " +
+          "Please use one of #{BSON::Binary::SUBTYPES.keys.map(&:inspect).join(", ")}."
+      end
+    end
+  end
+end

data/lib/bson/error/invalid_dbref_argument.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+    
+    # Raised when trying to create a BSON::DBRef from an object that is an invalid DBRef.
+    class InvalidDBRefArgument < Error
+    end
+  end
+end
+

data/lib/bson/error/invalid_decimal128_argument.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+
+    # Raised when trying to create a Decimal128 from an object that is neither a String nor a BigDecimal.
+    class InvalidDecimal128Argument < Error
+
+      # The custom error message for this error.
+      MESSAGE = 'A Decimal128 can only be created from a String or BigDecimal.'
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      def message
+        MESSAGE
+      end
+    end
+  end
+end
+

data/lib/bson/error/invalid_decimal128_range.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module BSON
+  class Error
+
+    # Raised when the exponent is outside the valid range.
+    class InvalidDecimal128Range < Error
+
+      # The custom error message for this error.
+      #
+      # @deprecated
+      MESSAGE = 'Value out of range for Decimal128 representation.'
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      def message
+        MESSAGE
+      end
+    end
+  end
+end
+