bson 4.15.0 → 5.0.2

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");
@@ -19,17 +20,56 @@ describe BSON::Binary do
   let(:testing1)  { described_class.new("testing") }
   let(:testing2)  { described_class.new("testing") }
   let(:not_testing) { described_class.new("not testing") }
+  let(:testing3) { described_class.new("testing", :user) }
+
+  describe "Comparable" do
+    describe "#eql?" do
+      context "for two equal objects" do
+        it "returns true" do
+          expect(testing1).to eql(testing2)
+        end
+      end
 
-  describe "#eql?" do
-    context "for two equal objects" do
-      it "returns true" do
-        expect(testing1).to eql(testing2)
+      context "for two different objects" do
+        it "returns false" do
+          expect(testing1).not_to eql(not_testing)
+        end
+      end
+
+      context 'for objects with identical data but different types' do
+        it 'returns false' do
+          expect(testing1).not_to eql(testing3)
+        end
       end
     end
 
-    context "for two different objects" do
-      it "returns false" do
-        expect(testing1).not_to eql(not_testing)
+    describe '#<=>' do
+      context 'with a non-Binary object' do
+        it 'returns nil' do
+          expect(testing1 <=> 'bogus').to be_nil
+        end
+      end
+
+      context 'with identical type and data' do
+        it 'returns 0' do
+          expect(testing1 <=> testing2).to be == 0
+        end
+      end
+
+      context 'with mismatched type' do
+        it 'returns nil' do
+          expect(testing1 <=> testing3).to be_nil
+        end
+      end
+
+      context 'with identical type but mismatched data' do
+        it 'returns -1 when a < b' do
+          expect(not_testing <=> testing1).to be == -1
+        end
+
+        it 'returns 1 when a > b' do
+          expect(testing1 <=> not_testing).to be == 1
+        end
       end
     end
   end
@@ -55,19 +95,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 +121,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 +212,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

data/spec/bson/byte_buffer_spec.rb

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

data/spec/bson/byte_buffer_write_spec.rb

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

data/spec/bson/code_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");
@@ -16,17 +17,18 @@ require "spec_helper"
 
 describe BSON::Code do
 
-  describe "#as_json" do
+  describe "#as_extended_json" do
 
     let(:object) do
       described_class.new("this.value = 5")
     end
 
     it "returns the binary data plus type" do
-      expect(object.as_json).to eq({ "$code" => "this.value = 5" })
+      expect(object.as_extended_json).to eq({ "$code" => "this.value = 5" })
     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 "#to_bson/#from_bson" do

data/spec/bson/code_with_scope_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");
@@ -39,19 +40,20 @@ describe BSON::CodeWithScope do
     end
   end
 
-  describe "#as_json" do
+  describe "#as_extended_json" do
 
     let(:object) do
       described_class.new("this.value = val", :val => "test")
     end
 
     it "returns the binary data plus type" do
-      expect(object.as_json).to eq(
+      expect(object.as_extended_json).to eq(
         { "$code" => "this.value = val", "$scope" => { :val => "test" }}
       )
     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 "#to_bson" do

data/spec/bson/config_spec.rb

@@ -1,40 +1,6 @@
+# rubocop:todo all
 require "spec_helper"
 
 describe BSON::Config do
 
-  describe "#validating_keys?" do
-
-    context "when the default is used" do
-
-      it "returns false" do
-        expect(described_class).to_not be_validating_keys
-      end
-    end
-
-    context "when configuring to false" do
-
-      before do
-        BSON::Config.validating_keys = false
-      end
-
-      it "returns false" do
-        expect(described_class).to_not be_validating_keys
-      end
-    end
-
-    context "when configuring to true" do
-
-      before do
-        BSON::Config.validating_keys = true
-      end
-
-      after do
-        BSON::Config.validating_keys = false
-      end
-
-      it "returns true" do
-        expect(described_class).to be_validating_keys
-      end
-    end
-  end
 end

data/spec/bson/date_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/date_time_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/dbref_legacy_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require 'spec_helper'
 require 'json'
@@ -8,7 +8,24 @@ require 'json'
 # class, and are intended to verify that the current DBRef implementation is
 # compatible with the legacy driver DBRef interface.
 
-describe BSON::DBRef do
+# For testing a class that emits warnings, without spamming the terminal
+# with them.
+def silenced_version_of(klass)
+  Class.new(klass) do
+    class <<self
+      def name
+        "#{superclass.name} (silenced)"
+      end
+
+      alias to_s name
+    end
+
+    def warn(*_args)
+    end
+  end
+end
+
+describe silenced_version_of BSON::DBRef do
 
   let(:object_id) do
     BSON::ObjectId.new
@@ -76,7 +93,7 @@ describe BSON::DBRef do
         it 'raises ArgumentError' do
           lambda do
             dbref
-          end.should raise_error(ArgumentError)
+          end.should raise_error(BSON::Error::InvalidDBRefArgument)
         end
       end
     end

data/spec/bson/dbref_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require 'spec_helper'
 require 'json'
@@ -79,10 +79,10 @@ describe BSON::DBRef do
         described_class.new({:$ref => 'users', :$id => object_id}, object_id)
       end
 
-      it 'raises ArgumentError' do
+      it 'raises InvalidDBRefArgument' do
         lambda do
           dbref
-        end.should raise_error(ArgumentError)
+        end.should raise_error(BSON::Error::InvalidDBRefArgument)
       end
     end
 
@@ -92,10 +92,10 @@ describe BSON::DBRef do
         described_class.new({:$ref => 'users', :$id => object_id}, object_id, 'db')
       end
 
-      it 'raises ArgumentError' do
+      it 'raises InvalidDBRefArgument' do
         lambda do
           dbref
-        end.should raise_error(ArgumentError)
+        end.should raise_error(BSON::Error::InvalidDBRefArgument)
       end
     end
 
@@ -118,7 +118,7 @@ describe BSON::DBRef do
       it 'raises an error' do
         expect do
           dbref
-        end.to raise_error(ArgumentError, /DBRef must have \$ref/)
+        end.to raise_error(BSON::Error::InvalidDBRefArgument, /DBRef must have \$ref/)
       end
     end
 
@@ -130,7 +130,7 @@ describe BSON::DBRef do
       it 'raises an error' do
         expect do
           dbref
-        end.to raise_error(ArgumentError, /DBRef must have \$id/)
+        end.to raise_error(BSON::Error::InvalidDBRefArgument, /DBRef must have \$id/)
       end
     end
 
@@ -142,7 +142,7 @@ describe BSON::DBRef do
       it 'raises an error' do
         expect do
           dbref
-        end.to raise_error(ArgumentError, /The value for key \$ref must be a string/)
+        end.to raise_error(BSON::Error::InvalidDBRefArgument, /The value for key \$ref must be a string/)
       end
     end
 
@@ -154,7 +154,7 @@ describe BSON::DBRef do
       it 'raises an error' do
         expect do
           dbref
-        end.to raise_error(ArgumentError, /The value for key \$db must be a string/)
+        end.to raise_error(BSON::Error::InvalidDBRefArgument, /The value for key \$db must be a string/)
       end
     end