bson 4.11.0 → 4.13.0

data/lib/bson/timestamp.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,12 +27,12 @@ module BSON
     # A timestamp is type 0x11 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 17.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(17.chr, encoding: BINARY).freeze
 
     # Error message if an object other than a Timestamp is compared with this object.
     #
     # @since 4.3.0
-    COMPARISON_ERROR_MESSAGE = 'comparison of %s with Timestamp failed'.freeze
+    COMPARISON_ERROR_MESSAGE = 'comparison of %s with Timestamp failed'
 
     # @!attribute seconds
     #   @return [ Integer ] The number of seconds.

data/lib/bson/true_class.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +26,7 @@ module BSON
     # A true value in the BSON spec is 0x01.
     #
     # @since 2.0.0
-    TRUE_BYTE = 1.chr.force_encoding(BINARY).freeze
+    TRUE_BYTE = ::String.new(1.chr, encoding: BINARY).freeze
 
     # The BSON type for true values is the general boolean type of 0x08.
     #

data/lib/bson/undefined.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +26,7 @@ module BSON
     # Undefined is type 0x06 in the BSON spec.
     #
     # @since 2.0.0
-    BSON_TYPE = 6.chr.force_encoding(BINARY).freeze
+    BSON_TYPE = ::String.new(6.chr, encoding: BINARY).freeze
 
     # Determine if undefined is equal to another object.
     #

data/lib/bson/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,5 +14,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.11.0".freeze
+  VERSION = "4.13.0"
 end

data/lib/bson.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,22 +39,22 @@ module BSON
   # Constant for binary string encoding.
   #
   # @since 2.0.0
-  BINARY = "BINARY".freeze
+  BINARY = "BINARY"
 
   # Constant for bson types that don't actually serialize a value.
   #
   # @since 2.0.0
-  NO_VALUE = "".force_encoding(BINARY).freeze
+  NO_VALUE = ::String.new(encoding: BINARY).freeze
 
   # Constant for a null byte (0x00).
   #
   # @since 2.0.0
-  NULL_BYTE = 0.chr.force_encoding(BINARY).freeze
+  NULL_BYTE = ::String.new(0.chr, encoding: BINARY).freeze
 
   # Constant for UTF-8 string encoding.
   #
   # @since 2.0.0
-  UTF8 = "UTF-8".freeze
+  UTF8 = "UTF-8"
 end
 
 require "bson/config"
@@ -78,6 +79,7 @@ require "bson/ext_json"
 require "bson/false_class"
 require "bson/float"
 require "bson/hash"
+require "bson/dbref"
 require "bson/open_struct"
 require "bson/max_key"
 require "bson/min_key"

data/spec/README.md

@@ -0,0 +1,14 @@
+# Running BSON Ruby Tests
+
+## Quick Start
+
+The test suite requires shared tooling that is stored in a separate repository
+and is referenced as a submodule. After checking out the desired bson-ruby
+branch, check out the matching submodules:
+
+    git submodule init
+    git submodule update
+
+Then, to run the test suite:
+
+    rake

data/spec/bson/binary_spec.rb

@@ -255,7 +255,7 @@ describe BSON::Binary do
     let(:obj) { described_class.new("\x00" * 16, :uuid) }
 
     it 'accepts symbol representation' do
-      expect(obj.to_uuid(:standard)).to eq('00000000-0000-0000-0000000000000000')
+      expect(obj.to_uuid(:standard)).to eq('00000000-0000-0000-0000-000000000000')
     end
 
     it 'rejects string representation' do

data/spec/bson/binary_uuid_spec.rb

@@ -136,6 +136,10 @@ describe "BSON::Binary - UUID spec tests" do
       it 'decodes as python legacy' do
         expect(binary.to_uuid(:python_legacy).gsub('-', '').upcase).not_to eq("00112233445566778899AABBCCDDEEFF")
       end
+
+      it 'expects four dashes when output as String' do
+        expect(binary.to_uuid(:csharp_legacy)).to eq("00112233-4455-6677-8899-aabbccddeeff")
+      end
     end
 
     context ':uuid_old, java legacy encoded' do
@@ -154,6 +158,10 @@ describe "BSON::Binary - UUID spec tests" do
       it 'decodes as python legacy' do
         expect(binary.to_uuid(:python_legacy).gsub('-', '').upcase).not_to eq("00112233445566778899AABBCCDDEEFF")
       end
+
+      it 'expects four dashes when output as String' do
+        expect(binary.to_uuid(:java_legacy)).to eq("00112233-4455-6677-8899-aabbccddeeff")
+      end
     end
 
     context ':uuid_old, python legacy encoded' do
@@ -172,6 +180,10 @@ describe "BSON::Binary - UUID spec tests" do
       it 'decodes as python legacy' do
         expect(binary.to_uuid(:python_legacy).gsub('-', '').upcase).to eq("00112233445566778899AABBCCDDEEFF")
       end
+
+      it 'expects four dashes when output as String' do
+        expect(binary.to_uuid(:python_legacy)).to eq("00112233-4455-6677-8899-aabbccddeeff")
+      end
     end
   end
 end

data/spec/bson/byte_buffer_spec.rb

@@ -42,7 +42,6 @@ describe BSON::ByteBuffer do
       end
     end
 
-
     context 'when the byte buffer is initialized with some bytes' do
 
       let(:buffer) do
@@ -53,6 +52,50 @@ describe BSON::ByteBuffer do
         expect(buffer.length).to eq(2)
       end
     end
+
+    context 'after the byte buffer was read from' do
+
+      let(:buffer) do
+        described_class.new({}.to_bson.to_s)
+      end
+
+      it 'returns the number of bytes remaining in the buffer' do
+        expect(buffer.length).to eq(5)
+        buffer.get_int32
+        expect(buffer.length).to eq(1)
+      end
+    end
+
+    context 'after the byte buffer was converted to string' do
+
+      shared_examples 'returns the total buffer length' do
+        it 'returns the total buffer length' do
+          expect(buffer.length).to eq(5)
+          buffer.to_s.length.should == 5
+          expect(buffer.length).to eq(5)
+        end
+      end
+
+      context 'read buffer' do
+
+        let(:buffer) do
+          described_class.new({}.to_bson.to_s)
+        end
+
+        include_examples 'returns the total buffer length'
+      end
+
+      context 'write buffer' do
+
+        let(:buffer) do
+          described_class.new.tap do |buffer|
+            buffer.put_bytes('hello')
+          end
+        end
+
+        include_examples 'returns the total buffer length'
+      end
+    end
   end
 
   describe '#rewind!' do
@@ -148,4 +191,40 @@ describe BSON::ByteBuffer do
       end
     end
   end
+
+  describe '#to_s' do
+    context 'read buffer' do
+      let(:buffer) do
+        described_class.new("\x18\x00\x00\x00*\x00\x00\x00")
+      end
+
+      it 'returns the data' do
+        buffer.to_s.should == "\x18\x00\x00\x00*\x00\x00\x00"
+      end
+
+      it 'returns the remaining buffer contents after a read' do
+        buffer.to_s.should == "\x18\x00\x00\x00*\x00\x00\x00"
+        buffer.get_int32.should == 24
+        buffer.to_s.should == "*\x00\x00\x00"
+      end
+    end
+
+    context 'write buffer' do
+      let(:buffer) do
+        described_class.new.tap do |buffer|
+          buffer.put_int32(24)
+        end
+      end
+
+      it 'returns the data' do
+        buffer.to_s.should == "\x18\x00\x00\x00".force_encoding('binary')
+      end
+
+      it 'returns the complete buffer contents after a write' do
+        buffer.to_s.should == "\x18\x00\x00\x00".force_encoding('binary')
+        buffer.put_int32(42)
+        buffer.to_s.should == "\x18\x00\x00\x00*\x00\x00\x00".force_encoding('binary')
+      end
+    end
+  end
 end