bson 4.15.0 → 5.0.0

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
 
@@ -93,15 +91,14 @@ module BSON
     # 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.
-    #
     # @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.rst).
       #
-      # @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,7 +55,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)
       value = _bson_to_i * 1000 + usec.divmod(1000).first
       buffer.put_int64(value)
     end

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");
@@ -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,6 +44,18 @@ 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).
     #

data/lib/bson/version.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");
@@ -14,5 +15,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.15.0"
+  VERSION = "5.0.0"
 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

data/spec/bson/array_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -34,65 +35,6 @@ describe Array do
         [ { "$testing" => "value" } ]
       end
 
-      context "when validating keys" do
-
-        context "when validating globally" do
-
-          before do
-            BSON::Config.validating_keys = true
-          end
-
-          after do
-            BSON::Config.validating_keys = false
-          end
-
-          it "raises an error" do
-            expect {
-              obj.to_bson
-            }.to raise_error(BSON::String::IllegalKey)
-          end
-        end
-
-        context "when validating locally" do
-
-          it "raises an error" do
-            expect {
-              obj.to_bson(BSON::ByteBuffer.new, true)
-            }.to raise_error(BSON::String::IllegalKey)
-          end
-
-          context "when serializing different types" do
-
-            let(:obj) do
-              [ BSON::Binary.new("testing", :generic),
-                BSON::Code.new("this.value = 5"),
-                BSON::CodeWithScope.new("this.value = val", "test"),
-                Date.new(2012, 1, 1),
-                Time.utc(2012, 1, 1),
-                DateTime.new(2012, 1, 1, 0, 0, 0),
-                false,
-                1.2332,
-                Integer::MAX_32BIT - 1,
-                BSON::ObjectId.new,
-                /\W+/i,
-                'a string',
-                :a_symbol,
-                Time.utc(2012, 1, 1, 0, 0, 0),
-                BSON::Timestamp.new(1, 10),
-                true,
-                { "$testing" => "value" }
-              ]
-            end
-
-            it "raises an error" do
-              expect {
-                obj.to_bson(BSON::ByteBuffer.new, true)
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          end
-        end
-      end
-
       context "when not validating keys" do
 
         let(:bson) do
@@ -186,8 +128,25 @@ describe Array do
       it "raises an exception" do
         expect {
           [ 1 ].to_bson_object_id
-        }.to raise_error(BSON::ObjectId::Invalid)
+        }.to raise_error(BSON::Error::InvalidObjectId)
       end
     end
   end
+
+  describe '#as_extended_json' do
+
+    let(:object) do
+      ['one', :two, 3, 4.0, nil]
+    end
+
+    let(:expected) do
+      ["one", { "$symbol" => "two" }, { "$numberInt" => "3" }, { "$numberDouble"=> "4.0" }, nil]
+    end
+
+    it 'returns the extended serialization' do
+      expect(object.as_extended_json).to eq(expected)
+    end
+
+    it_behaves_like 'an Extended JSON serializable object'
+  end
 end

data/spec/bson/big_decimal_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2016-2021 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,7 +15,7 @@
 
 require "spec_helper"
 
-describe BSON::BigDecimal do
+describe BigDecimal do
 
   describe '#from_bson' do
     shared_examples_for 'a BSON::BigDecimal deserializer' do
@@ -35,7 +36,7 @@ describe BSON::BigDecimal do
         if deserialized_decimal128.to_s == "NaN"
           expect(deserialized_big_decimal.nan?).to be true
         else
-          expect(deserialized_big_decimal).to eq(deserialized_decimal128.to_big_decimal)
+          expect(deserialized_big_decimal).to eq(deserialized_decimal128.to_d)
         end
       end
     end
@@ -211,7 +212,7 @@ describe BSON::BigDecimal do
       it "raises an error" do
         expect do
           BigDecimal(argument).to_bson
-        end.to raise_error(BSON::Decimal128::InvalidRange)
+        end.to raise_error(BSON::Error::InvalidDecimal128Range)
       end
     end
 
@@ -221,7 +222,7 @@ describe BSON::BigDecimal do
       it "raises an error" do
         expect do
           BigDecimal(argument).to_bson
-        end.to raise_error(BSON::Decimal128::UnrepresentablePrecision)
+        end.to raise_error(BSON::Error::UnrepresentablePrecision)
       end
     end
   end
@@ -313,4 +314,15 @@ describe BSON::BigDecimal do
       it_behaves_like 'a BSON::BigDecimal round trip'
     end
   end
+
+  context "when the class is loaded" do
+
+    let(:registered) do
+      BSON::Registry.get(described_class::BSON_TYPE, 'field')
+    end
+
+    it "registers the type" do
+      expect(registered).to eq(described_class)
+    end
+  end
 end

data/spec/bson/binary_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -55,19 +56,20 @@ describe BSON::Binary do
     expect(hash[not_testing]).to be_nil
   end
 
-  describe "#as_json" do
+  describe "#as_extended_json" do
 
     let(:object) do
       described_class.new("testing", :user)
     end
 
     it "returns the binary data plus type" do
-      expect(object.as_json).to eq(
+      expect(object.as_extended_json).to eq(
         { "$binary" => {'base64' => Base64.encode64("testing").strip, "subType" => '80' }}
       )
     end
 
-    it_behaves_like "a JSON serializable object"
+    it_behaves_like 'an Extended JSON serializable object'
+    it_behaves_like '#as_json calls #as_extended_json'
   end
 
   describe "#initialize" do
@@ -80,17 +82,26 @@ describe BSON::Binary do
       end
     end
 
-    context "when he type is invalid" do
+    context "when the type is invalid" do
 
       it "raises an error" do
         expect {
           described_class.new("testing", :error)
         }.to raise_error { |error|
-          expect(error).to be_a(BSON::Binary::InvalidType)
+          expect(error).to be_a(BSON::Error::InvalidBinaryType)
           expect(error.message).to match /is not a valid binary type/
         }
       end
     end
+
+    context 'when initialized via legacy YAML' do
+      let(:yaml) { "--- !ruby/object:BSON::Binary\ndata: hello\ntype: :generic\n" }
+      let(:deserialized) { YAML.safe_load(yaml, permitted_classes: [ Symbol, BSON::Binary ]) }
+
+      it 'correctly sets the raw_type' do
+        expect(deserialized.raw_type).to be == BSON::Binary::SUBTYPES[:generic]
+      end
+    end
   end
 
   describe '#inspect' do
@@ -162,75 +173,73 @@ describe BSON::Binary do
 
     it_behaves_like "a bson element"
 
-    context "when the type is :generic" do
-
-      let(:obj)  { described_class.new("testing") }
-      let(:bson) { "#{7.to_bson}#{0.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :function" do
-
-      let(:obj)  { described_class.new("testing", :function) }
-      let(:bson) { "#{7.to_bson}#{1.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :old" do
-
-      let(:obj)  { described_class.new("testing", :old) }
-      let(:bson) { "#{11.to_bson}#{2.chr}#{7.to_bson}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :uuid_old" do
-
-      let(:obj)  { described_class.new("testing", :uuid_old) }
-      let(:bson) { "#{7.to_bson}#{3.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :uuid" do
-
-      let(:obj)  { described_class.new("testing", :uuid) }
-      let(:bson) { "#{7.to_bson}#{4.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :md5" do
-
-      let(:obj)  { described_class.new("testing", :md5) }
-      let(:bson) { "#{7.to_bson}#{5.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :user" do
-
-      let(:obj)  { described_class.new("testing", :user) }
-      let(:bson) { "#{7.to_bson}#{128.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
-    end
-
-    context "when the type is :cyphertext" do
-      let(:obj)  { described_class.new("testing", :ciphertext) }
-      let(:bson) { "#{7.to_bson}#{6.chr}testing" }
-
-      it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
+    [
+      {
+        types: [ nil, 0, 0.chr, :generic, 'generic' ],
+        bson: "#{7.to_bson}#{0.chr}testing",
+        type: :generic,
+      },
+      {
+        types: [ 1, 1.chr, :function, 'function' ],
+        bson: "#{7.to_bson}#{1.chr}testing",
+        type: :function,
+      },
+      {
+        types: [ 2, 2.chr, :old, 'old' ],
+        bson: "#{11.to_bson}#{2.chr}#{7.to_bson}testing",
+        type: :old,
+      },
+      {
+        types: [ 3, 3.chr, :uuid_old, 'uuid_old' ],
+        bson: "#{7.to_bson}#{3.chr}testing",
+        type: :uuid_old,
+      },
+      {
+        types: [ 4, 4.chr, :uuid, 'uuid' ],
+        bson: "#{7.to_bson}#{4.chr}testing",
+        type: :uuid,
+      },
+      {
+        types: [ 5, 5.chr, :md5, 'md5' ],
+        bson: "#{7.to_bson}#{5.chr}testing",
+        type: :md5,
+      },
+      {
+        types: [ 6, 6.chr, :ciphertext, 'ciphertext' ],
+        bson: "#{7.to_bson}#{6.chr}testing",
+        type: :ciphertext,
+      },
+      {
+        types: [ 0x80, 0x80.chr, :user, 'user' ],
+        bson: "#{7.to_bson}#{128.chr}testing",
+        type: :user,
+      },
+      {
+        types: [ 0xFF, 0xFF.chr ],
+        bson: "#{7.to_bson}#{0xFF.chr}testing",
+        type: :user,
+      },
+    ].each do |defn|
+      defn[:types].each do |type|
+        context "when the type is #{type ? type.inspect : 'not provided'}" do
+          let(:obj) do
+            if type
+              described_class.new("testing", type)
+            else
+              described_class.new("testing")
+            end
+          end
+
+          let(:bson) { defn[:bson] }
+
+          it_behaves_like "a serializable bson element"
+          it_behaves_like "a deserializable bson element"
+
+          it "reports its type as #{defn[:type].inspect}" do
+            expect(obj.type).to be == defn[:type]
+          end
+        end
+      end
     end
 
     context 'when given binary string' do

data/spec/bson/binary_uuid_spec.rb

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

data/spec/bson/boolean_spec.rb

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

data/spec/bson/byte_buffer_read_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require 'spec_helper'
 
 describe BSON::ByteBuffer do