bson 4.15.0 → 5.0.2

data/spec/bson/object_id_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");
@@ -220,13 +221,24 @@ describe BSON::ObjectId do
       described_class.new
     end
 
-    it "returns the object id with $oid key" do
-      expect(object.as_json).to eq({ "$oid" => object.to_s })
+    it "returns the object id as a string" do
+      expect(object.as_json).to eq(object.to_s)
     end
 
     it_behaves_like "a JSON serializable object"
   end
 
+  describe "#as_extended_json" do
+
+    let(:object) do
+      described_class.new
+    end
+
+    it "returns the object id with $oid key" do
+      expect(object.as_extended_json).to eq({ "$oid" => object.to_s })
+    end
+  end
+
   describe "::BSON_TYPE" do
 
     it "returns 0x07" do
@@ -311,7 +323,7 @@ describe BSON::ObjectId do
       it "raises an error" do
         expect {
           described_class.from_string("asadsf")
-        }.to raise_error(BSON::ObjectId::Invalid)
+        }.to raise_error(BSON::Error::InvalidObjectId)
       end
     end
   end
@@ -592,7 +604,48 @@ describe BSON::ObjectId do
     it "raises an exception on serialization" do
       expect {
         hash.to_bson
-      }.to raise_error(BSON::InvalidKey)
+      }.to raise_error(BSON::Error::InvalidKey)
+    end
+  end
+
+  context 'when the counter wraps' do
+    before do
+      BSON::ObjectId._generator.reset_counter(0xFFFFFF)
+    end
+
+    let(:before) { BSON::ObjectId.new }
+    let(:after) { BSON::ObjectId.new }
+
+    it 'resets the counter portion to 0' do
+      expect(before._counter_part).to be == "ffffff"
+      expect(after._counter_part).to be == "000000"
+    end
+  end
+
+  context 'when the timestamp is larger than a 32-bit integer' do
+    let(:distant_future) { Time.at(2 ** 32) }
+
+    before do
+      allow(Time).to receive(:now).and_return(distant_future)
+    end
+
+    let(:object_id) { BSON::ObjectId.new }
+
+    it 'wraps the timestamp to 0' do
+      expect(object_id.to_time).to be == Time.at(0)
+    end
+  end
+
+  context 'when fork changes the pid' do
+    before do
+      skip 'requires Process.fork' unless Process.respond_to?(:fork)
+    end
+
+    let(:parent_id) { BSON::ObjectId.new }
+    let(:child_id) { Utils.perform_in_child { BSON::ObjectId.new } }
+
+    it 'changes the process portion of the object-id' do
+      expect(child_id._process_part).not_to be == parent_id._process_part
     end
   end
 end

data/spec/bson/object_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");
@@ -25,7 +26,7 @@ describe BSON::Object do
     it "raises an exception" do
       expect {
         object.to_bson_key
-      }.to raise_error(BSON::InvalidKey)
+      }.to raise_error(BSON::Error::InvalidKey)
     end
   end
 end

data/spec/bson/open_struct_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -36,93 +37,35 @@ describe OpenStruct do
       it_behaves_like "a serializable bson element"
     end
 
-    context "when the struct has invalid keys" do
+    context "when the struct has dollar keys" do
 
       let(:obj) do
         described_class.new({ "$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
-
-          context "when the struct contains an array of documents containing invalid keys" do
-
-            let(:obj) do
-              described_class.new({ "array" =>  [{ "$testing" => "value" }] })
-            end
-
-            it "raises an error" do
-              expect {
-                obj.to_bson
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          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
+      let(:bson) do
+        "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
+        "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+      end
 
-          context "when the struct contains an array of documents containing invalid keys" do
+      it "serializes the struct" do
+        expect(obj.to_bson.to_s).to eq(bson)
+      end
 
-            let(:obj) do
-              described_class.new({ "array" =>  [{ "$testing" => "value" }] })
-            end
+      context "when the struct contains an array of documents containing invalid keys" do
 
-            it "raises an error" do
-              expect {
-                obj.to_bson(BSON::ByteBuffer.new, true)
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          end
+        let(:obj) do
+          described_class.new({ "array" =>  [{ "$testing" => "value" }] })
         end
-      end
-
-      context "when not validating keys" do
 
         let(:bson) do
-          "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
-          "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+          "#{45.to_bson.to_s}#{Array::BSON_TYPE}array#{BSON::NULL_BYTE}" +
+          "#{[{ "$testing" => "value" }].to_bson.to_s}#{BSON::NULL_BYTE}"
         end
 
         it "serializes the struct" do
           expect(obj.to_bson.to_s).to eq(bson)
         end
-
-        context "when the struct contains an array of documents containing invalid keys" do
-
-          let(:obj) do
-            described_class.new({ "array" =>  [{ "$testing" => "value" }] })
-          end
-
-          let(:bson) do
-            "#{45.to_bson.to_s}#{Array::BSON_TYPE}array#{BSON::NULL_BYTE}" +
-              "#{[{ "$testing" => "value" }].to_bson.to_s}#{BSON::NULL_BYTE}"
-          end
-
-          it "serializes the struct" do
-            expect(obj.to_bson.to_s).to eq(bson)
-          end
-        end
       end
     end
 

data/spec/bson/raw_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require 'spec_helper'
 
 describe Regexp::Raw do
@@ -84,19 +85,10 @@ describe Regexp::Raw do
 
         let(:options) { ::Regexp::EXTENDED }
 
-        it "sets the options on the raw regex" do
-          expect(object.options). to eq(options)
-        end
-
-        context "When the raw regexp is compiled" do
-
-          let(:regexp) do
-            object.compile
-          end
-
-          it "sets the options on the compiled regexp object" do
-            expect(regexp.options).to eq(options)
-          end
+        it "raises an error" do
+          expect do
+            object
+          end.to raise_error(ArgumentError, /Regexp options must be a String or Symbol/)
         end
       end
 
@@ -320,8 +312,10 @@ describe Regexp::Raw do
         let(:options) { ::Regexp::EXTENDED }
         let(:bson) { "#{pattern}#{BSON::NULL_BYTE}mx#{BSON::NULL_BYTE}" }
 
-        it "sets the option on the serialized bson object" do
-          expect(serialized).to eq(bson)
+        it "raises an error" do
+          expect do
+            serialized
+          end.to raise_error(ArgumentError, /Regexp options must be a String or Symbol/)
         end
       end
 

data/spec/bson/regexp_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");
@@ -147,10 +148,10 @@ describe Regexp do
           Regexp::Raw.new("pattern", 1)
         end
 
-        it "doesn't raise an error" do
+        it "raises an error" do
           expect do
             regexp
-          end.to_not raise_error
+          end.to raise_error(ArgumentError, /Regexp options must be a String or Symbol/)
         end
       end
 
@@ -163,7 +164,7 @@ describe Regexp do
         it "raises an error" do
           expect do
             regexp
-          end.to raise_error(ArgumentError, /Regexp options must be a String, Symbol, or Integer/)
+          end.to raise_error(ArgumentError, /Regexp options must be a String or Symbol/)
         end
       end
     end

data/spec/bson/registry_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");
@@ -38,7 +39,7 @@ describe BSON::Registry do
       it "raises an error" do
         expect {
           described_class.get(25.chr, "field")
-        }.to raise_error(BSON::Registry::UnsupportedType)
+        }.to raise_error(BSON::Error::UnsupportedType)
       end
     end
   end

data/spec/bson/string_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
@@ -51,7 +51,7 @@ describe String do
       it "raises an exception" do
         expect {
           "test".to_bson_object_id
-        }.to raise_error(BSON::ObjectId::Invalid)
+        }.to raise_error(BSON::Error::InvalidObjectId)
       end
     end
   end
@@ -90,44 +90,12 @@ describe String do
 
   describe "#to_bson_key" do
 
-    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
-
-        let(:validated) do
-          string.to_bson_key
-        end
-
-        it_behaves_like "a validated BSON key"
-      end
-
-      context "when validating locally" do
-
-        let(:validated) do
-          string.to_bson_key(true)
-        end
-
-        it_behaves_like "a validated BSON key"
-      end
+    let(:string) do
+      "$testing.testing"
     end
 
-    context "when allowing invalid keys" do
-
-      let(:string) do
-        "$testing.testing"
-      end
-
-      it "allows invalid keys" do
-        expect(string.to_bson_key).to eq(string)
-      end
+    it "allows dots/dollars keys" do
+      expect(string.to_bson_key).to eq(string)
     end
   end
 
@@ -148,4 +116,11 @@ describe String do
       end
     end
   end
+
+  describe '#as_extended_json' do
+    let(:object) { 'Hello world!' }
+
+    it_behaves_like '#as_extended_json returns self'
+    it_behaves_like 'an Extended JSON serializable object'
+  end
 end

data/spec/bson/symbol_raw_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,4 +43,28 @@ describe BSON::Symbol::Raw do
       one.should_not be_eql(three)
     end
   end
+
+  describe '#as_json' do
+    let(:object) do
+      described_class.new(:foobar)
+    end
+
+    it 'returns a string' do
+      expect(object.as_json).to eq('foobar')
+    end
+
+    it_behaves_like 'a JSON serializable object'
+  end
+
+  describe '#as_extended_json' do
+    let(:object) do
+      described_class.new(:foobar)
+    end
+
+    it 'returns the binary data plus type' do
+      expect(object.as_extended_json).to eq({ '$symbol' => 'foobar' })
+    end
+
+    it_behaves_like 'an Extended JSON serializable object'
+  end
 end

data/spec/bson/symbol_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");
@@ -106,28 +107,24 @@ describe Symbol do
 
   describe "#to_bson_key" do
 
-    context "when validating keys" do
-
-      let(:symbol) do
-        :'$testing.testing'
-      end
-
-      it "raises an exception" do
-        expect {
-          symbol.to_bson_key(true)
-        }.to raise_error(BSON::String::IllegalKey)
-      end
+    let(:symbol) do
+      :'$testing.testing'
     end
 
-    context "when not validating keys" do
+    it "returns the key" do
+      expect(symbol.to_bson_key).to eq(symbol)
+    end
+  end
 
-      let(:symbol) do
-        :'$testing.testing'
-      end
+  describe '#as_extended_json' do
+    let(:object) do
+      :foobar
+    end
 
-      it "allows invalid keys" do
-        expect(symbol.to_bson_key).to eq(symbol)
-      end
+    it 'returns the binary data plus type' do
+      expect(object.as_extended_json).to eq({ '$symbol' => 'foobar' })
     end
+
+    it_behaves_like 'an Extended JSON serializable object'
   end
 end

data/spec/bson/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/time_with_zone_spec.rb

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

data/spec/bson/timestamp_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/true_class_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");
@@ -25,4 +26,11 @@ describe TrueClass do
     it_behaves_like "a bson element"
     it_behaves_like "a serializable bson element"
   end
+
+  describe '#as_extended_json' do
+    let(:object) { true }
+
+    it_behaves_like '#as_extended_json returns self'
+    it_behaves_like 'an Extended JSON serializable object'
+  end
 end

data/spec/bson/undefined_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");
@@ -26,4 +27,30 @@ describe BSON::Undefined do
     it_behaves_like "a serializable bson element"
     it_behaves_like "a deserializable bson element"
   end
+
+  describe "#as_json" do
+
+    let(:object) do
+      described_class.new
+    end
+
+    it "returns nil" do
+      expect(object.as_json).to eq(nil)
+    end
+
+    it_behaves_like 'a JSON serializable object'
+  end
+
+  describe "#as_extended_json" do
+
+    let(:object) do
+      described_class.new
+    end
+
+    it "returns the binary data plus type" do
+      expect(object.as_extended_json).to eq({ "$undefined" => true })
+    end
+
+    it_behaves_like 'an Extended JSON serializable object'
+  end
 end

data/spec/bson_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/runners/common_driver.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -184,13 +185,13 @@ module BSON
       # The object as json, in a document with the test key.
       #
       # @example Get a document with the object at the test key.
-      #   test.document_as_json
+      #   test.document_as_extended_json
       #
-      # @return [ BSON::Document ] The json document.
+      # @return [ Hash ] The extended_json representation of document.
       #
       # @since 4.2.0
-      def document_as_json
-        { @test_key => object.as_json }
+      def document_as_extended_json
+        { @test_key => object.as_extended_json }
       end
 
       # Use the string in the extended json to instantiate the bson object.
@@ -340,7 +341,7 @@ module BSON
       def decoded_document
         @document ||= (data = [ @subject ].pack('H*')
           buffer = BSON::ByteBuffer.new(data)
-          BSON::Document.from_bson(buffer))
+          BSON::Document.from_bson(buffer, mode: :bson))
       end
     end
   end

data/spec/runners/corpus.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,6 +58,10 @@ module BSON
         @spec['test_key']
       end
 
+      def bson_type
+        @bson_type ||= @spec['bson_type'].to_i(16).chr
+      end
+
       def valid_tests
         @valid_tests ||=
           @spec['valid']&.map do |test_spec|
@@ -179,6 +184,7 @@ module BSON
         @string = test_params['string']
       end
 
+      attr_reader :spec
       attr_reader :description, :string
     end
   end

data/spec/runners/corpus_legacy.rb

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

data/spec/spec_helper.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/spec_tests/common_driver_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require 'spec_helper'
 require 'runners/common_driver'
 
@@ -25,8 +26,12 @@ describe 'Driver common bson tests' do
             expect(test.from_json_string).to eq(test.object)
           end
 
+          it 'serializes to a string', if: test.to_ext_json? do
+            expect(test.document_as_extended_json).to eq(test.ext_json)
+          end
+
           it 'creates the correct extended json document from the decoded object', if: test.to_ext_json? do
-            expect(test.document_as_json).to eq(test.ext_json)
+            expect(test.document_as_extended_json).to eq(test.ext_json)
           end
 
           it 'parses the string value to the same value as the decoded document', if: test.from_string? do
@@ -63,9 +68,9 @@ describe 'Driver common bson tests' do
 
           let(:valid_errors) do
             [
-              BSON::Decimal128::InvalidString,
-              BSON::Decimal128::InvalidRange,
-              BSON::Decimal128::UnrepresentablePrecision,
+              BSON::Error::InvalidDecimal128String,
+              BSON::Error::InvalidDecimal128Range,
+              BSON::Error::UnrepresentablePrecision,
             ]
           end
 

data/spec/spec_tests/corpus_legacy_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require 'spec_helper'
 require 'runners/corpus_legacy'
 

data/spec/spec_tests/corpus_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require 'spec_helper'
 require 'runners/corpus'
 
@@ -105,8 +106,17 @@ describe 'BSON Corpus spec tests' do
 
         context("parse error: #{test.description}") do
 
-          let(:parsed_extjson) do
-            BSON::ExtJSON.parse(test.string, mode: :bson)
+          # As per:
+          #   https://github.com/mongodb/specifications/blob/e7ee829329400786e01279b4f37d4e440d1e9cfa/source/bson-corpus/bson-corpus.rst#decimal128-type-0x13
+          #
+          # Values under test must be parsed in a type-specific manner.
+          let(:parsed_value) do
+            case spec.bson_type
+            when BSON::Decimal128::BSON_TYPE
+              BSON::Decimal128.new(test.string)
+            else
+              BSON::ExtJSON.parse(test.string, mode: :bson)
+            end
           end
 
           # Until bson-ruby gets an exception hierarchy, we can only rescue
@@ -114,7 +124,7 @@ describe 'BSON Corpus spec tests' do
           # https://jira.mongodb.org/browse/RUBY-1806
           it 'raises an exception' do
             expect do
-              parsed_extjson
+              parsed_value
             end.to raise_error(Exception)
           end
         end