bson 4.1.1 → 5.2.0

data/spec/bson/int32_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# rubocop:todo all
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,6 +17,52 @@ require "spec_helper"
 
 describe BSON::Int32 do
 
+  describe "#intiialize" do
+
+    let(:obj) { described_class.new(integer) }
+
+    context "when the integer is 32-bit" do
+
+      let(:integer) { Integer::MAX_32BIT }
+
+      it "wraps the integer" do
+        expect(obj.value).to be(integer)
+      end
+    end
+
+    context "when the integer is too large" do
+
+      let(:integer) { Integer::MAX_32BIT + 1 }
+
+      it "raises an out of range error" do
+        expect do
+          obj
+        end.to raise_error(RangeError, /#{integer} cannot be stored in 32 bits/)
+      end
+    end
+
+    context "when the integer is too small" do
+
+      let(:integer) { Integer::MIN_32BIT - 1 }
+
+      it "raises an out of range error" do
+        expect {
+          obj
+        }.to raise_error(RangeError)
+      end
+    end
+
+    context 'when argument is an Int32' do
+      let(:integer) do
+        described_class.new(described_class.new(50))
+      end
+
+      it 'works' do
+        expect(integer.value).to be 50
+      end
+    end
+  end
+
   describe "#from_bson" do
 
     let(:type) { 16.chr }
@@ -41,4 +88,204 @@ describe BSON::Int32 do
       expect(BSON::Int32.from_bson(encoded_2)).to eq(decoded_2)
     end
   end
+
+  describe "#to_bson" do
+
+    context "when the integer is 32 bit" do
+
+      let(:type) { 16.chr }
+      let(:obj)  { BSON::Int32.new(Integer::MAX_32BIT - 1) }
+      let(:bson) { [ Integer::MAX_32BIT - 1 ].pack(BSON::Int32::PACK) }
+
+      it_behaves_like "a serializable bson element"
+    end
+  end
+
+  describe "#to_bson_key" do
+
+    let(:obj)  {  BSON::Int32.new(Integer::MAX_32BIT - 1) }
+    let(:encoded) { (Integer::MAX_32BIT - 1) }
+
+    it "returns the key as an integer" do
+      expect(obj.to_bson_key).to eq(encoded)
+    end
+  end
+
+  describe "#==" do
+
+    let(:object) do
+      described_class.new(1)
+    end
+
+    context "when data is identical" do
+
+      let(:other_object) do
+        described_class.new(1)
+      end
+
+      it "returns true" do
+        expect(object).to eq(other_object)
+      end
+
+      context "other object is of another integer type" do
+
+        let(:other_object) do
+          BSON::Int64.new(1)
+        end
+
+        it "returns false" do
+          expect(object).not_to eq(other_object)
+        end
+      end
+    end
+
+    context "when the data is different" do
+
+      let(:other_object) do
+        described_class.new(2)
+      end
+
+      it "returns false" do
+        expect(object).not_to eq(other_object)
+      end
+    end
+
+    context "when other is not a BSON integer" do
+
+      it "returns false" do
+        expect(described_class.new(1)).to_not eq('1')
+      end
+    end
+  end
+
+  describe "#===" do
+
+    let(:object) do
+      described_class.new(1)
+    end
+
+    context "when comparing with another BSON int32" do
+
+      context "when the data is equal" do
+
+        let(:other_object) do
+          described_class.new(1)
+        end
+
+        it "returns true" do
+          expect(object === other_object).to be true
+        end
+
+        context "other object is of another integer type" do
+
+          let(:other_object) do
+            BSON::Int64.new(1)
+          end
+
+          it "returns false" do
+            expect(object === other_object).to be false
+          end
+        end
+      end
+
+      context "when the data is not equal" do
+
+        let(:other_object) do
+          described_class.new(2)
+        end
+
+        it "returns false" do
+          expect(object === other_object).to be false
+        end
+      end
+    end
+
+    context "when comparing to an object id class" do
+
+      it "returns false" do
+        expect(described_class.new(1) === described_class).to be false
+      end
+    end
+
+    context "when comparing with a string" do
+
+      context "when the data is equal" do
+
+        let(:other) do
+          '1'
+        end
+
+        it "returns false" do
+          expect(object === other).to be false
+        end
+      end
+
+      context "when the data is not equal" do
+
+        let(:other) do
+          '2'
+        end
+
+        it "returns false" do
+          expect(object === other).to be false
+        end
+      end
+    end
+
+    context "when comparing with a non-bson integer object" do
+
+      it "returns false" do
+        expect(object === []).to be false
+      end
+    end
+
+    context "when comparing with a non int64 class" do
+
+      it "returns false" do
+        expect(object === String).to be false
+      end
+    end
+  end
+
+  describe '#value' do
+    let(:obj) { described_class.new(12345) }
+
+    it 'returns value passed to initializer' do
+      expect(obj.value).to eq(12345)
+    end
+  end
+
+  describe '#as_json' do
+    let(:object) { described_class.new(42) }
+
+    it 'returns an Integer' do
+      expect(object.as_json).to eq 42
+    end
+
+    it_behaves_like "a JSON serializable object"
+  end
+
+  describe '#as_extended_json' do
+    let(:object) { described_class.new(42) }
+
+    context 'canonical mode' do
+      it 'returns a Hash with key $numberInt' do
+        expect(object.as_extended_json).to eq({ '$numberInt' => '42' })
+      end
+    end
+
+    context 'relaxed mode' do
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :relaxed)).to eq 42
+      end
+    end
+
+    context 'legacy mode' do
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :legacy)).to eq 42
+      end
+    end
+
+    it_behaves_like "an Extended JSON serializable object"
+  end
 end

data/spec/bson/int64_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# rubocop:todo all
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,6 +17,52 @@ require "spec_helper"
 
 describe BSON::Int64 do
 
+  describe "#intiialize" do
+
+    let(:obj) { described_class.new(integer) }
+
+    context "when the integer is 64-bit" do
+
+      let(:integer) { Integer::MAX_64BIT - 1 }
+
+      it "wraps the integer" do
+        expect(obj.value).to be(integer)
+      end
+    end
+
+    context "when the integer is too large" do
+
+      let(:integer) { Integer::MAX_64BIT + 1 }
+
+      it "raises an out of range error" do
+        expect do
+          obj
+        end.to raise_error(RangeError, /#{integer} cannot be stored in 64 bits/)
+      end
+    end
+
+    context "when the integer is too small" do
+
+      let(:integer) { Integer::MIN_64BIT - 1 }
+
+      it "raises an out of range error" do
+        expect {
+          obj
+        }.to raise_error(RangeError)
+      end
+    end
+
+    context 'when argument is an Int64' do
+      let(:integer) do
+        described_class.new(described_class.new(50))
+      end
+
+      it 'works' do
+        expect(integer.value).to be 50
+      end
+    end
+  end
+
   describe "#from_bson" do
 
     let(:type) { 18.chr }
@@ -24,5 +71,265 @@ describe BSON::Int64 do
 
     it_behaves_like "a bson element"
     it_behaves_like "a deserializable bson element"
+
+    context 'canonical deserialization' do
+      let(:integer) { 42 }
+
+      let(:bson) do
+        BSON::ByteBuffer.new(BSON::Int64.new(integer).to_bson.to_s)
+      end
+
+      let(:deserialized) do
+        described_class.from_bson(bson, mode: :bson)
+      end
+
+      it 'deserializes to BSON::Int64' do
+        deserialized.class.should be BSON::Int64
+      end
+
+      it 'has the correct value' do
+        deserialized.value.should == 42
+      end
+    end
+
+    context "when the integer is within the MRI Fixnum range" do
+
+      let(:integer) { 2**30 - 1 }
+
+      let(:bson) do
+        BSON::ByteBuffer.new(BSON::Int64.new(integer).to_bson.to_s)
+      end
+
+      context "when on JRuby", if: BSON::Environment.jruby? && RUBY_VERSION < '3.0.0' do
+
+        it "deserializes to a Fixnum object" do
+          expect(described_class.from_bson(bson).class).to be(Fixnum)
+        end
+      end
+
+      it "deserializes to an Integer object" do
+        expect(described_class.from_bson(bson).class).to be(Integer)
+      end
+    end
+
+    context "when the 64-bit integer is the BSON max and thus larger than the MRI Fixnum range on all architectures" do
+
+      let(:integer) { Integer::MAX_64BIT }
+
+      let(:bson) do
+        BSON::ByteBuffer.new(integer.to_bson.to_s)
+      end
+
+      context "when on JRuby", if: BSON::Environment.jruby? && RUBY_VERSION < '3.0.0' do
+
+        it "deserializes to a Fixnum object" do
+          expect(described_class.from_bson(bson).class).to be(Fixnum)
+        end
+      end
+
+      it "deserializes to an Integer object" do
+        expect(described_class.from_bson(bson).class).to be(Integer)
+      end
+    end
+  end
+
+  describe "#to_bson" do
+
+    context "when the integer is 64 bit" do
+
+      let(:type) { 18.chr }
+      let(:obj)  { BSON::Int64.new(Integer::MAX_64BIT - 1) }
+      let(:bson) { [ Integer::MAX_64BIT - 1 ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+    end
+  end
+
+  describe "#to_bson_key" do
+
+    let(:obj)  {  BSON::Int64.new(Integer::MAX_64BIT - 1) }
+    let(:encoded) { (Integer::MAX_64BIT - 1) }
+
+    it "returns the key as an integer" do
+      expect(obj.to_bson_key).to eq(encoded)
+    end
+  end
+
+  describe "#==" do
+
+    let(:object) do
+      described_class.new(1)
+    end
+
+    context "when data is identical" do
+
+      let(:other_object) do
+        described_class.new(1)
+      end
+
+      it "returns true" do
+        expect(object).to eq(other_object)
+      end
+
+      context "other object is of another integer type" do
+
+        let(:other_object) do
+          BSON::Int32.new(1)
+        end
+
+        it "returns false" do
+          expect(object).not_to eq(other_object)
+        end
+      end
+    end
+
+    context "when the data is different" do
+
+      let(:other_object) do
+        described_class.new(2)
+      end
+
+      it "returns false" do
+        expect(object).not_to eq(other_object)
+      end
+    end
+
+    context "when other is not a BSON integer" do
+
+      it "returns false" do
+        expect(described_class.new(1)).to_not eq('1')
+      end
+    end
+  end
+
+  describe "#===" do
+
+    let(:object) do
+      described_class.new(1)
+    end
+
+    context "when comparing with another BSON int64" do
+
+      context "when the data is equal" do
+
+        let(:other_object) do
+          described_class.new(1)
+        end
+
+        it "returns true" do
+          expect(object === other_object).to be true
+        end
+
+        context "other object is of another integer type" do
+
+          let(:other_object) do
+            BSON::Int32.new(1)
+          end
+
+          it "returns false" do
+            expect(object === other_object).to be false
+          end
+        end
+      end
+
+      context "when the data is not equal" do
+
+        let(:other_object) do
+          described_class.new(2)
+        end
+
+        it "returns false" do
+          expect(object === other_object).to be false
+        end
+      end
+    end
+
+    context "when comparing to an object id class" do
+
+      it "returns false" do
+        expect(described_class.new(1) === described_class).to be false
+      end
+    end
+
+    context "when comparing with a string" do
+
+      context "when the data is equal" do
+
+        let(:other) do
+          '1'
+        end
+
+        it "returns false" do
+          expect(object === other).to be false
+        end
+      end
+
+      context "when the data is not equal" do
+
+        let(:other) do
+          '2'
+        end
+
+        it "returns false" do
+          expect(object === other).to be false
+        end
+      end
+    end
+
+    context "when comparing with a non-bson integer object" do
+
+      it "returns false" do
+        expect(object === []).to be false
+      end
+    end
+
+    context "when comparing with a non int64 class" do
+
+      it "returns false" do
+        expect(object === String).to be false
+      end
+    end
+  end
+
+  describe '#value' do
+    let(:obj) { described_class.new(12345) }
+
+    it 'returns value passed to initializer' do
+      expect(obj.value).to eq(12345)
+    end
+  end
+
+  describe '#as_json' do
+    let(:object) { described_class.new(42) }
+
+    it 'returns an Integer' do
+      expect(object.as_json).to eq 42
+    end
+
+    it_behaves_like "a JSON serializable object"
+  end
+
+  describe '#as_extended_json' do
+    let(:object) { described_class.new(42) }
+
+    context 'canonical mode' do
+      it 'returns a Hash with key $numberLong' do
+        expect(object.as_extended_json).to eq({ '$numberLong' => '42' })
+      end
+    end
+
+    context 'relaxed mode' do
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :relaxed)).to eq 42
+      end
+    end
+
+    context 'legacy mode' do
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :legacy)).to eq 42
+      end
+    end
+
+    it_behaves_like "an Extended JSON serializable object"
   end
 end

data/spec/bson/integer_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# rubocop:todo all
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -62,10 +63,67 @@ describe Integer do
   describe "#to_bson_key" do
 
     let(:obj)  { Integer::MAX_32BIT - 1 }
-    let(:encoded) { obj.to_s }
+    let(:encoded) { obj }
 
-    it "returns the key as a string" do
+    it "returns the key as an integer" do
       expect(obj.to_bson_key).to eq(encoded)
     end
   end
+
+  describe '#as_json' do
+    it 'returns an integer string' do
+      expect(42.to_json).to eq '42'
+    end
+  end
+
+  describe '#as_extended_json' do
+
+    context 'when 32-bit representable' do
+      let(:object) { 42 }
+
+      context 'canonical mode' do
+        it 'returns $numberInt when small' do
+          expect(object.as_extended_json).to eq({ '$numberInt' => '42' })
+        end
+      end
+
+      context 'relaxed mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :relaxed)).to eq 42
+        end
+      end
+
+      context 'legacy mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :legacy)).to eq 42
+        end
+      end
+
+      it_behaves_like "an Extended JSON serializable object"
+    end
+
+    context 'when not 32-bit representable' do
+      let(:object) { 18014398241046527 }
+
+      context 'canonical mode' do
+        it 'returns $numberInt when small' do
+          expect(object.as_extended_json).to eq({ '$numberLong' => '18014398241046527' })
+        end
+      end
+
+      context 'relaxed mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :relaxed)).to eq 18014398241046527
+        end
+      end
+
+      context 'legacy mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :legacy)).to eq 18014398241046527
+        end
+      end
+
+      it_behaves_like "an Extended JSON serializable object"
+    end
+  end
 end

data/spec/bson/json_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# rubocop:todo all
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/spec/bson/max_key_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# rubocop:todo all
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -49,17 +50,18 @@ describe BSON::MaxKey do
     end
   end
 
-  describe "#as_json" do
+  describe "#as_extended_json" do
 
     let(:object) do
       described_class.new
     end
 
     it "returns the binary data plus type" do
-      expect(object.as_json).to eq({ "$maxKey" => 1 })
+      expect(object.as_extended_json).to eq({ "$maxKey" => 1 })
     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