bson 4.15.0 → 5.0.2

data/lib/bson/regexp.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# The top-level BSON module.
 module BSON
-
   # Injects behaviour for encoding and decoding regular expression values to
   # and from raw bytes as specified by the BSON spec.
   #
@@ -62,10 +63,8 @@ module BSON
     #   regexp.as_json
     #
     # @return [ Hash ] The regexp as a JSON hash.
-    #
-    # @since 2.0.0
-    def as_json(*args)
-      { "$regex" => source, "$options" => bson_options }
+    def as_json(*)
+      { '$regex' => source, '$options' => bson_options }
     end
 
     # Get the regular expression as encoded BSON.
@@ -83,14 +82,11 @@ module BSON
     #   and 'u' to make \w, \W, etc. match unicode.
     #
     # @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.
-    # @param [ true, false ] validating_keys
     #
     # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @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)
       buffer.put_cstring(source)
       buffer.put_cstring(bson_options)
     end
@@ -103,30 +99,28 @@ module BSON
     end
 
     def bson_extended
-      (options & ::Regexp::EXTENDED != 0) ? EXTENDED_VALUE : NO_VALUE
+      (options & ::Regexp::EXTENDED).zero? ? NO_VALUE : EXTENDED_VALUE
     end
 
     def bson_ignorecase
-      (options & ::Regexp::IGNORECASE != 0) ? IGNORECASE_VALUE : NO_VALUE
+      (options & ::Regexp::IGNORECASE).zero? ? NO_VALUE : IGNORECASE_VALUE
     end
 
     def bson_dotall
       # Ruby Regexp's MULTILINE is equivalent to BSON's dotall value
-      (options & ::Regexp::MULTILINE != 0) ? NEWLINE_VALUE : NO_VALUE
+      (options & ::Regexp::MULTILINE).zero? ? NO_VALUE : NEWLINE_VALUE
     end
 
     # Represents the raw values for the regular expression.
     #
     # @see https://jira.mongodb.org/browse/RUBY-698
-    #
-    # @since 3.0.0
     class Raw
       include JSON
 
       # @return [ String ] pattern The regex pattern.
       attr_reader :pattern
 
-      # @return [ Integer ] options The options.
+      # @return [ String ] options The options.
       attr_reader :options
 
       # Compile the Regular expression into the native type.
@@ -135,10 +129,8 @@ module BSON
       #   raw.compile
       #
       # @return [ ::Regexp ] The compiled regular expression.
-      #
-      # @since 3.0.0
       def compile
-        @compiled ||= ::Regexp.new(pattern, options_to_int)
+        @compile ||= ::Regexp.new(pattern, options_to_int)
       end
 
       # Initialize the new raw regular expression.
@@ -147,13 +139,7 @@ module BSON
       #   Raw.new(pattern, options)
       #
       # @param [ String ] pattern The regular expression pattern.
-      # @param [ String, Integer ] options The options.
-      #
-      # @note The ability to specify options as an Integer is deprecated.
-      #  Please specify options as a String. The ability to pass options as
-      #  as Integer will be removed in version 5.0.0.
-      #
-      # @since 3.0.0
+      # @param [ String | Symbol ] options The options.
       def initialize(pattern, options = '')
         if pattern.include?(NULL_BYTE)
           raise Error::InvalidRegexpPattern, "Regexp pattern cannot contain a null byte: #{pattern}"
@@ -161,28 +147,22 @@ module BSON
           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"
+        else
+          raise ArgumentError, 'Regexp options must be a String or Symbol'
         end
 
         @pattern = pattern
-        @options = options
+        @options = options.to_s
       end
 
       # Allow automatic delegation of methods to the Regexp object
       # returned by +compile+.
       #
       # @param [ String] method The name of a method.
-      #
-      # @since 3.1.0
-      def respond_to?(method, include_private = false)
-        if defined?(@pattern)
-          compile.respond_to?(method, include_private) || super
-        else
-          # YAML calls #respond_to? during deserialization, before the object
-          # is initialized.
-          super
-        end
+      def respond_to_missing?(method, include_private = false)
+        # YAML calls #respond_to? during deserialization, before the object
+        # is initialized.
+        defined?(@pattern) && compile.respond_to?(method, include_private)
       end
 
       # Encode the Raw Regexp object to BSON.
@@ -200,15 +180,11 @@ module BSON
       #   and 'u' to make \w, \W, etc. match unicode.
       #
       # @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.
-      # @param [ true, false ] validating_keys
       #
       # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
       #
       # @see http://bsonspec.org/#/specification
-      #
-      # @since 4.2.0
-      def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
-        return compile.to_bson(buffer, validating_keys) if options.is_a?(Integer)
+      def to_bson(buffer = ByteBuffer.new)
         buffer.put_cstring(source)
         buffer.put_cstring(options.chars.sort.join)
       end
@@ -219,14 +195,12 @@ module BSON
       #   raw_regexp.as_json
       #
       # @return [ Hash ] The raw regexp as a JSON hash.
-      #
-      # @since 4.2.0
-      def as_json(*args)
+      def as_json(*)
         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).
+      # 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)
@@ -234,9 +208,9 @@ module BSON
       # @return [ Hash ] The extended json representation.
       def as_extended_json(**opts)
         if opts[:mode] == :legacy
-          { "$regex" => source, "$options" => options }
+          { '$regex' => source, '$options' => options }
         else
-          {"$regularExpression" => {'pattern' => source, "options" => options}}
+          { '$regularExpression' => { 'pattern' => source, 'options' => options } }
         end
       end
 
@@ -248,24 +222,22 @@ module BSON
       # @param [ Object ] other The object to check against.
       #
       # @return [ true, false ] If the objects are equal.
-      #
-      # @since 4.2.0
       def ==(other)
         return false unless other.is_a?(::Regexp::Raw)
-        pattern == other.pattern &&
-          options == other.options
+
+        pattern == other.pattern && options == other.options
       end
-      alias :eql? :==
+      alias eql? ==
 
       private
 
       def method_missing(method, *arguments)
         return super unless respond_to?(method)
+
         compile.send(method, *arguments)
       end
 
       def options_to_int
-        return options if options.is_a?(Integer)
         opts = 0
         opts |= ::Regexp::IGNORECASE if options.include?(IGNORECASE_VALUE)
         opts |= ::Regexp::MULTILINE if options.include?(NEWLINE_VALUE)
@@ -274,10 +246,15 @@ module BSON
       end
     end
 
+    # Class-level methods to be added to the Regexp class.
     module ClassMethods
-
       # Deserialize the regular expression from BSON.
       #
+      # @note If the argument cannot be parsed, an exception will be raised
+      #   and the argument will be left in an undefined state. The caller
+      #   must explicitly call `rewind` on the buffer before trying to parse
+      #   it again.
+      #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @option opts [ nil | :bson ] :mode Decoding mode to use.
@@ -285,9 +262,7 @@ module BSON
       # @return [ Regexp ] The decoded regular expression.
       #
       # @see http://bsonspec.org/#/specification
-      #
-      # @since 2.0.0
-      def from_bson(buffer, **opts)
+      def from_bson(buffer, **_)
         pattern = buffer.get_cstring
         options = buffer.get_cstring
         Raw.new(pattern, options)
@@ -295,14 +270,10 @@ module BSON
     end
 
     # Register this type when the module is loaded.
-    #
-    # @since 2.0.0
     Registry.register(BSON_TYPE, ::Regexp)
   end
 
   # Enrich the core Regexp class with this module.
-  #
-  # @since 2.0.0
-  ::Regexp.send(:include, Regexp)
-  ::Regexp.send(:extend, Regexp::ClassMethods)
+  ::Regexp.include Regexp
+  ::Regexp.extend Regexp::ClassMethods
 end

data/lib/bson/registry.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");
@@ -64,11 +65,6 @@ module BSON
       define_type_reader(type)
     end
 
-    # Raised when trying to get a type from the registry that doesn't exist.
-    #
-    # @since 4.1.0
-    class UnsupportedType < RuntimeError; end
-
     private
 
     def define_type_reader(type)
@@ -81,7 +77,7 @@ module BSON
       message = "Detected unknown BSON type #{byte.inspect} "
       message += (field ? "for fieldname \"#{field}\". " : "in array. ")
       message +="Are you using the latest BSON version?"
-      raise UnsupportedType.new(message)
+      raise Error::UnsupportedType.new(message)
     end
   end
 end

data/lib/bson/specialized.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");
@@ -46,7 +47,7 @@ module BSON
     # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @since 2.0.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       buffer
     end
 

data/lib/bson/string.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
@@ -46,7 +47,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)
       buffer.put_string(self)
     end
 
@@ -57,18 +58,12 @@ module BSON
     #
     # @raise [ EncodingError ] If the string is not UTF-8.
     #
-    # @raise [ IllegalKey ] If validating keys and it contains a '.' or starts
-    #   with '$'.
-    #
     # @return [ String ] The encoded string.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson_key(validating_keys = Config.validating_keys?)
-      if validating_keys
-        raise IllegalKey.new(self) if ILLEGAL_KEY =~ self
-      end
+    def to_bson_key
       self
     end
 
@@ -80,7 +75,7 @@ module BSON
     #
     # @note This is used for repairing legacy bson data.
     #
-    # @raise [ BSON::ObjectId::Invalid ] If the string is not 12 elements.
+    # @raise [ BSON::Error::InvalidObjectId ] If the string is not 12 elements.
     #
     # @return [ String ] The raw object id bytes.
     #
@@ -101,24 +96,6 @@ module BSON
       unpack("H*")[0]
     end
 
-    # Raised when validating keys and a key is illegal in MongoDB
-    #
-    # @since 4.1.0
-    class IllegalKey < RuntimeError
-
-      # Instantiate the exception.
-      #
-      # @example Instantiate the exception.
-      #   BSON::Object::IllegalKey.new(string)
-      #
-      # @param [ String ] string The illegal string.
-      #
-      # @since 4.1.0
-      def initialize(string)
-        super("'#{string}' is an illegal key in MongoDB. Keys may not start with '$' or contain a '.'.")
-      end
-    end
-
     module ClassMethods
 
       # Deserialize a string from BSON.

data/lib/bson/symbol.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");
@@ -57,7 +58,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)
       buffer.put_symbol(self)
     end
 
@@ -71,10 +72,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson_key(validating_keys = Config.validating_keys?)
-      if validating_keys
-        raise BSON::String::IllegalKey.new(self) if BSON::String::ILLEGAL_KEY =~ self
-      end
+    def to_bson_key
       self
     end
 
@@ -91,17 +89,16 @@ module BSON
     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)
+    def as_extended_json(**_options)
       { "$symbol" => to_s }
     end
 
     class Raw
+      include JSON
+
       # Create a BSON Symbol
       #
       # @param [ String | Symbol ] str_or_sym The symbol represented by this
@@ -148,7 +145,7 @@ 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(to_s)
       end
 
@@ -156,18 +153,24 @@ module BSON
         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).
+      # Return a string representation of the raw symbol for use in
+      # application-level JSON serialization. This method is intentionally
+      # different from #as_extended_json.
       #
-      # This method returns the integer value if relaxed representation is
-      # requested, otherwise a $numberLong hash.
+      # @example Get the raw symbol as a JSON-serializable object.
+      #   raw_symbol.as_json
       #
-      # @option options [ true | false ] :relaxed Whether to produce relaxed
-      #   extended JSON representation.
+      # @return [ String ] The raw symbol as a String.
+      def as_json(*args)
+        to_s
+      end
+
+      # Converts this object to a representation directly serializable to
+      # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
       #
-      # @return [ Hash | Integer ] The extended json representation.
-      def as_extended_json(**options)
-        {'$symbol' => to_s}
+      # @return [ Hash ] The extended json representation.
+      def as_extended_json(**_options)
+        { '$symbol' => to_s }
       end
     end
 

data/lib/bson/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");
@@ -54,13 +55,13 @@ 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)
       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).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @note The time is floored to the nearest millisecond.
     #

data/lib/bson/time_with_zone.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2018-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 4.4.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       buffer.put_int64((to_i * 1000) + (usec / 1000))
     end
 
@@ -46,6 +47,17 @@ module BSON
     def bson_type
       ::Time::BSON_TYPE
     end
+
+    # @api private
+    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
   end
 
   # Enrich the ActiveSupport::TimeWithZone class with this module.

data/lib/bson/timestamp.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");
@@ -91,7 +92,7 @@ module BSON
     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)
@@ -124,7 +125,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)
       buffer.put_uint32(increment)
       buffer.put_uint32(seconds)
     end

data/lib/bson/true_class.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");
@@ -50,7 +51,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)
       buffer.put_byte(TRUE_BYTE)
     end
   end

data/lib/bson/undefined.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");
@@ -21,6 +22,7 @@ module BSON
   #
   # @since 2.0.0
   class Undefined
+    include JSON
     include Specialized
 
     # Undefined is type 0x06 in the BSON spec.
@@ -42,8 +44,20 @@ module BSON
       self.class == other.class
     end
 
+    # Return a string representation of the BSON::Undefined for use in
+    # application-level JSON serialization. This method is intentionally
+    # different from #as_extended_json.
+    #
+    # @example Get the undefined as a JSON-serializable object.
+    #   undefined.as_json
+    #
+    # @return [ nil ] The undefined as nil.
+    def as_json(*args)
+      nil
+    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)

data/lib/bson/version.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+# rubocop:todo all
+
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,5 +16,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.15.0"
+  VERSION = "5.0.2"
 end

data/lib/bson.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");
@@ -27,7 +28,7 @@ module BSON
   #
   # @param [ String ] string The string to create the id from.
   #
-  # @raise [ BSON::ObjectId::Invalid ] If the provided string is invalid.
+  # @raise [ BSON::Error::InvalidObjectId ] If the provided string is invalid.
   #
   # @return [ BSON::ObjectId ] The new object id.
   #
@@ -103,7 +104,7 @@ require "bson/version"
 begin
   if BSON::Environment.jruby?
     require "bson-ruby.jar"
-    JRuby::Util.load_ext("org.bson.NativeService")
+    JRuby::Util.load_ext("org.bson_ruby.NativeService")
   else
     require "bson_native"
   end