bson 4.5.0 → 4.6.0

data/spec/bson/corpus_spec.rb

@@ -2,11 +2,14 @@ require 'spec_helper'
 
 describe 'Driver BSON Corpus spec tests' do
 
-  specs = BSON_CORPUS_TESTS.map { |file| BSON::Corpus::Spec.new(file) }
+  BSON_CORPUS_TESTS.each do |path|
+    basename = File.basename(path)
+    # All of the tests in the failures subdir are failing apparently
+    #basename = path.sub(/.*corpus-tests\//, '')
 
-  specs.each do |spec|
+    spec = BSON::Corpus::Spec.new(path)
 
-    context(spec.description) do
+    context("(#{basename}): #{spec.description}") do
 
       spec.valid_tests.each do |test|
 
@@ -57,9 +60,9 @@ describe 'Driver BSON Corpus spec tests' do
 
           it 'raises an error' do
             skip 'This test case does not raise and error but should' unless error
-            expect {
+            expect do
               test.reencoded_bson
-            }.to raise_error
+            end.to raise_error(error.class)
           end
         end
       end

data/spec/bson/document_spec.rb

@@ -163,6 +163,26 @@ describe BSON::Document do
     it "sets the value" do
       expect(doc[key]).to eq(val)
     end
+
+    context 'when value is a hash' do
+      let(:val) do
+        {'foo' => {'bar' => 'baz'}}
+      end
+
+      it 'converts value to indifferent access' do
+        expect(doc[key][:foo][:bar]).to eq('baz')
+      end
+    end
+
+    context 'when value is an array with hash element' do
+      let(:val) do
+        [42, {'foo' => {'bar' => 'baz'}}]
+      end
+
+      it 'converts hash element to indifferent access' do
+        expect(doc[key][1][:foo][:bar]).to eq('baz')
+      end
+    end
   end
 
   if described_class.instance_methods.include?(:dig)
@@ -998,51 +1018,31 @@ describe BSON::Document do
       it_behaves_like "a document able to handle utf-8"
     end
 
-    context "when utf-8 values exist in wrong encoding" do
+    context "given a utf-8-encodable string in another encoding" do
 
       let(:string) { "gültig" }
       let(:document) do
         described_class["type", string.encode("iso-8859-1")]
       end
 
-      it "raises an exception", unless: BSON::Environment.jruby? do
-        expect {
-          document.to_bson
-        }.to raise_error(ArgumentError)
-      end
-
-      it 'converts the values', if: BSON::Environment.jruby? do
-        expect(
-          BSON::Document.from_bson(BSON::ByteBuffer.new(document.to_bson.to_s))
-        ).to eq({ "type" => string })
-      end
-    end
-
-    context "when binary strings with utf-8 values exist", if: BSON::Environment.jruby? && (JRUBY_VERSION < '9') do
-
-      let(:string) { "europäisch" }
-      let(:document) do
-        described_class["type", string.encode("binary")]
-      end
-
-      it "encodes and decodes the document properly" do
+      it 'converts the values to utf-8' do
         expect(
           BSON::Document.from_bson(BSON::ByteBuffer.new(document.to_bson.to_s))
         ).to eq({ "type" => string })
       end
     end
 
-    context "when binary strings with utf-8 values exist", unless: BSON::Environment.jruby? do
+    context "given a binary string with utf-8 values" do
 
-      let(:string) { "europäisch" }
+      let(:string) { "europäisch".force_encoding('binary') }
       let(:document) do
-        described_class["type", string.encode("binary", "binary")]
+        described_class["type", string]
       end
 
-      it "encodes and decodes the document properly" do
-        expect(
-          BSON::Document.from_bson(BSON::ByteBuffer.new(document.to_bson.to_s))
-        ).to eq({ "type" => string })
+      it "raises encoding error" do
+        expect do
+          document.to_bson
+        end.to raise_error(Encoding::UndefinedConversionError, /from ASCII-8BIT to UTF-8/)
       end
     end
   end

data/spec/bson/hash_spec.rb

@@ -158,4 +158,69 @@ describe Hash do
       it_behaves_like "a deserializable bson element"
     end
   end
+
+  describe '#to_bson' do
+    context 'when a key is not valid utf-8' do
+      let(:key) { Utils.make_byte_string([254, 253, 255]) }
+      let(:hash) do
+        {key => 'foo'}
+      end
+
+      let(:expected_message) do
+        if BSON::Environment.jruby?
+          # Uses JRE conversion to another encoding
+          /Error serializing key.*Encoding::UndefinedConversionError/
+        else
+          # Uses our validator
+          /Key.*is not valid UTF-8/
+        end
+      end
+
+      it 'raises EncodingError' do
+        expect do
+          hash.to_bson
+        end.to raise_error(EncodingError, expected_message)
+      end
+    end
+
+    context 'when a key contains null bytes' do
+      let(:hash) do
+        {"\x00".force_encoding('BINARY') => 'foo'}
+      end
+
+      it 'raises ArgumentError' do
+        expect do
+          hash.to_bson
+        end.to raise_error(ArgumentError, /[Kk]ey.*contains null bytes/)
+      end
+    end
+
+    context 'when a value is not valid utf-8' do
+      let(:hash) do
+        {'foo' => [254, 253, 255].map(&:chr).join.force_encoding('BINARY')}
+      end
+
+      let(:expected_message) do
+        /from ASCII-8BIT to UTF-8/
+      end
+
+      it 'raises EncodingError' do
+        expect do
+          hash.to_bson
+        end.to raise_error(EncodingError, expected_message)
+      end
+    end
+
+    context 'when a value contains null bytes' do
+      let(:hash) do
+        {'foo' => "\x00".force_encoding('BINARY')}
+      end
+
+      it 'works' do
+        expect do
+          hash.to_bson
+        end.not_to raise_error
+      end
+    end
+  end
 end

data/spec/bson/int32_spec.rb

@@ -25,7 +25,7 @@ describe BSON::Int32 do
       let(:integer) { Integer::MAX_32BIT }
 
       it "wraps the integer" do
-        expect(obj.instance_variable_get(:@integer)).to be(integer)
+        expect(obj.value).to be(integer)
       end
     end
 
@@ -34,9 +34,9 @@ describe BSON::Int32 do
       let(:integer) { Integer::MAX_32BIT + 1 }
 
       it "raises an out of range error" do
-        expect {
+        expect do
           obj
-        }.to raise_error(RangeError)
+        end.to raise_error(RangeError, /#{integer} cannot be stored in 32 bits/)
       end
     end
 
@@ -50,6 +50,16 @@ describe BSON::Int32 do
         }.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
@@ -235,4 +245,12 @@ describe BSON::Int32 do
       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
 end

data/spec/bson/int64_spec.rb

@@ -25,7 +25,7 @@ describe BSON::Int64 do
       let(:integer) { Integer::MAX_64BIT - 1 }
 
       it "wraps the integer" do
-        expect(obj.instance_variable_get(:@integer)).to be(integer)
+        expect(obj.value).to be(integer)
       end
     end
 
@@ -34,9 +34,9 @@ describe BSON::Int64 do
       let(:integer) { Integer::MAX_64BIT + 1 }
 
       it "raises an out of range error" do
-        expect {
+        expect do
           obj
-        }.to raise_error(RangeError)
+        end.to raise_error(RangeError, /#{integer} cannot be stored in 64 bits/)
       end
     end
 
@@ -50,6 +50,16 @@ describe BSON::Int64 do
         }.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
@@ -280,4 +290,13 @@ describe BSON::Int64 do
       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
+
 end

data/spec/bson/string_spec.rb

@@ -130,4 +130,22 @@ describe String do
       end
     end
   end
+
+  describe '#to_bson' do
+    context 'when string is not valid utf-8' do
+      let(:string) do
+        "\xfe\x00\xff".force_encoding('BINARY')
+      end
+
+      let(:expected_message) do
+        /from ASCII-8BIT to UTF-8/
+      end
+
+      it 'raises EncodingError' do
+        expect do
+          string.to_bson
+        end.to raise_error(EncodingError, expected_message)
+      end
+    end
+  end
 end

data/spec/support/corpus-tests/array.json

@@ -14,16 +14,22 @@
             "extjson": "{\"a\" : [10]}"
         },
         {
-            "description": "Single Element Array with index set incorrectly",
+            "description": "Single Element Array with index set incorrectly to empty string",
             "bson": "130000000461000B00000010000A0000000000",
             "canonical_bson": "140000000461000C0000001030000A0000000000",
             "extjson": "{\"a\" : [10]}"
         },
         {
-            "description": "Single Element Array with index set incorrectly",
+            "description": "Single Element Array with index set incorrectly to ab",
             "bson": "150000000461000D000000106162000A0000000000",
             "canonical_bson": "140000000461000C0000001030000A0000000000",
             "extjson": "{\"a\" : [10]}"
+        },
+        {
+            "description": "Multi Element Array with duplicate indexes",
+            "bson": "1b000000046100130000001030000a000000103000140000000000",
+            "canonical_bson": "1b000000046100130000001030000a000000103100140000000000",
+            "extjson": "{\"a\" : [10, 20]}"
         }
     ],
     "decodeErrors": [

data/spec/support/shared_examples.rb

@@ -18,10 +18,8 @@ shared_examples_for "a binary encoded string" do
     Encoding.find(BSON::BINARY)
   end
 
-  unless RUBY_VERSION < "1.9"
-    it "returns the string with binary encoding" do
-      expect(encoded.encoding).to eq(binary_encoding)
-    end
+  it "returns the string with binary encoding" do
+    expect(encoded.encoding).to eq(binary_encoding)
   end
 end
 

data/spec/support/utils.rb

@@ -0,0 +1,10 @@
+module Utils
+  # JRuby chokes when strings like "\xfe\x00\xff", which are not valid UTF-8,
+  # appear in the source. Use this method to build such strings.
+  # char_array is an array of byte values to use for the string.
+  module_function def make_byte_string(char_array, encoding = 'BINARY')
+    char_array.map do |char|
+      char.chr.force_encoding('BINARY')
+    end.join.force_encoding(encoding)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Tyler Brock
@@ -33,9 +33,9 @@ cert_chain:
   bMYVwXXhV8czdzgkQB/ZPWHSbEWXnmkze1mzvqWBCPOVXYrcnL9cnEl/RoxtS1hr
   Db6Ac6mCUSYfYHBWpWqxjc45n70i5Xi1
   -----END CERTIFICATE-----
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies: []
-description: A full featured BSON specification implementation, in Ruby
+description: A fully featured BSON specification implementation in Ruby
 email:
 - mongodb-dev@googlegroups.com
 executables: []
@@ -49,9 +49,16 @@ files:
 - NOTICE
 - README.md
 - Rakefile
-- ext/bson/bson_native.c
+- ext/bson/bson-endian.h
+- ext/bson/bson-native.h
+- ext/bson/bytebuf.c
+- ext/bson/endian.c
 - ext/bson/extconf.rb
-- ext/bson/native-endian.h
+- ext/bson/init.c
+- ext/bson/libbson-utf8.c
+- ext/bson/read.c
+- ext/bson/util.c
+- ext/bson/write.c
 - lib/bson.rb
 - lib/bson/active_support.rb
 - lib/bson/array.rb
@@ -93,7 +100,9 @@ files:
 - spec/bson/array_spec.rb
 - spec/bson/binary_spec.rb
 - spec/bson/boolean_spec.rb
+- spec/bson/byte_buffer_read_spec.rb
 - spec/bson/byte_buffer_spec.rb
+- spec/bson/byte_buffer_write_spec.rb
 - spec/bson/code_spec.rb
 - spec/bson/code_with_scope_spec.rb
 - spec/bson/config_spec.rb
@@ -160,10 +169,17 @@ files:
 - spec/support/driver-spec-tests/decimal128/decimal128-7.json
 - spec/support/shared_examples.rb
 - spec/support/spec_config.rb
-homepage: http://bsonspec.org
+- spec/support/utils.rb
+homepage: https://docs.mongodb.com/ruby-driver/current/tutorials/bson-v4/
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://jira.mongodb.org/projects/RUBY
+  changelog_uri: https://github.com/mongodb/bson-ruby/releases
+  documentation_uri: https://docs.mongodb.com/ruby-driver/current/tutorials/bson-v4/
+  homepage_uri: https://docs.mongodb.com/ruby-driver/current/tutorials/bson-v4/
+  mailing_list_uri: https://groups.google.com/group/mongodb-user
+  source_code_uri: https://github.com/mongodb/bson-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -172,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -182,75 +198,78 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: Ruby Implementation of the BSON specification
+summary: Ruby implementation of the BSON specification
 test_files:
-- spec/bson/date_spec.rb
-- spec/bson/config_spec.rb
-- spec/bson/int64_spec.rb
+- spec/bson/min_key_spec.rb
 - spec/bson/undefined_spec.rb
-- spec/bson/corpus_spec.rb
+- spec/bson/regexp_spec.rb
+- spec/bson/decimal128_spec.rb
 - spec/bson/code_spec.rb
-- spec/bson/driver_bson_spec.rb
-- spec/bson/object_spec.rb
-- spec/bson/date_time_spec.rb
-- spec/bson/raw_spec.rb
-- spec/bson/min_key_spec.rb
-- spec/bson/time_with_zone_spec.rb
 - spec/bson/time_spec.rb
-- spec/bson/hash_spec.rb
-- spec/bson/timestamp_spec.rb
-- spec/bson/int32_spec.rb
-- spec/bson/byte_buffer_spec.rb
-- spec/bson/registry_spec.rb
-- spec/bson/regexp_spec.rb
-- spec/bson/symbol_spec.rb
+- spec/bson/object_spec.rb
+- spec/bson/integer_spec.rb
 - spec/bson/string_spec.rb
+- spec/bson/byte_buffer_read_spec.rb
+- spec/bson/config_spec.rb
+- spec/bson/json_spec.rb
 - spec/bson/boolean_spec.rb
+- spec/bson/corpus_spec.rb
+- spec/bson/hash_spec.rb
 - spec/bson/open_struct_spec.rb
-- spec/bson/decimal128_spec.rb
-- spec/bson/json_spec.rb
+- spec/bson/nil_class_spec.rb
 - spec/bson/array_spec.rb
 - spec/bson/false_class_spec.rb
 - spec/bson/true_class_spec.rb
-- spec/bson/binary_spec.rb
-- spec/bson/object_id_spec.rb
-- spec/bson/code_with_scope_spec.rb
-- spec/bson/nil_class_spec.rb
-- spec/bson/integer_spec.rb
-- spec/bson/document_spec.rb
+- spec/bson/date_spec.rb
+- spec/bson/byte_buffer_write_spec.rb
+- spec/bson/int64_spec.rb
+- spec/bson/timestamp_spec.rb
 - spec/bson/max_key_spec.rb
+- spec/bson/raw_spec.rb
+- spec/bson/byte_buffer_spec.rb
+- spec/bson/document_spec.rb
+- spec/bson/code_with_scope_spec.rb
 - spec/bson/float_spec.rb
+- spec/bson/time_with_zone_spec.rb
+- spec/bson/binary_spec.rb
+- spec/bson/registry_spec.rb
+- spec/bson/symbol_spec.rb
+- spec/bson/driver_bson_spec.rb
+- spec/bson/date_time_spec.rb
+- spec/bson/object_id_spec.rb
+- spec/bson/int32_spec.rb
+- spec/support/utils.rb
+- spec/support/common_driver.rb
+- spec/support/corpus-tests/code_w_scope.json
+- spec/support/corpus-tests/code.json
+- spec/support/corpus-tests/oid.json
+- spec/support/corpus-tests/timestamp.json
 - spec/support/corpus-tests/string.json
 - spec/support/corpus-tests/null.json
 - spec/support/corpus-tests/int32.json
 - spec/support/corpus-tests/maxkey.json
-- spec/support/corpus-tests/timestamp.json
+- spec/support/corpus-tests/array.json
+- spec/support/corpus-tests/regex.json
+- spec/support/corpus-tests/minkey.json
+- spec/support/corpus-tests/top.json
+- spec/support/corpus-tests/failures/undefined.json
 - spec/support/corpus-tests/failures/binary.json
-- spec/support/corpus-tests/failures/dbpointer.json
 - spec/support/corpus-tests/failures/symbol.json
-- spec/support/corpus-tests/failures/undefined.json
-- spec/support/corpus-tests/failures/datetime.json
 - spec/support/corpus-tests/failures/int64.json
-- spec/support/corpus-tests/code.json
-- spec/support/corpus-tests/document.json
-- spec/support/corpus-tests/double.json
-- spec/support/corpus-tests/regex.json
-- spec/support/corpus-tests/oid.json
-- spec/support/corpus-tests/top.json
+- spec/support/corpus-tests/failures/dbpointer.json
+- spec/support/corpus-tests/failures/datetime.json
 - spec/support/corpus-tests/boolean.json
-- spec/support/corpus-tests/array.json
-- spec/support/corpus-tests/code_w_scope.json
-- spec/support/corpus-tests/minkey.json
-- spec/support/corpus.rb
+- spec/support/corpus-tests/double.json
+- spec/support/corpus-tests/document.json
 - spec/support/shared_examples.rb
-- spec/support/driver-spec-tests/decimal128/decimal128-4.json
-- spec/support/driver-spec-tests/decimal128/decimal128-2.json
-- spec/support/driver-spec-tests/decimal128/decimal128-5.json
-- spec/support/driver-spec-tests/decimal128/decimal128-3.json
+- spec/support/spec_config.rb
 - spec/support/driver-spec-tests/decimal128/decimal128-6.json
+- spec/support/driver-spec-tests/decimal128/decimal128-3.json
 - spec/support/driver-spec-tests/decimal128/decimal128-1.json
+- spec/support/driver-spec-tests/decimal128/decimal128-4.json
 - spec/support/driver-spec-tests/decimal128/decimal128-7.json
-- spec/support/spec_config.rb
-- spec/support/common_driver.rb
-- spec/spec_helper.rb
+- spec/support/driver-spec-tests/decimal128/decimal128-5.json
+- spec/support/driver-spec-tests/decimal128/decimal128-2.json
+- spec/support/corpus.rb
 - spec/bson_spec.rb
+- spec/spec_helper.rb