bson 4.2.0.rc1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7d7c6cc6a8abff094af51c1a8432494d09c1f72
-  data.tar.gz: f9994f21778f1c9e15e42c668df5321ceab814e5
+  metadata.gz: cb696b32143262aff3587deb025217f4e35278f0
+  data.tar.gz: 98b45e1fad06f918e2f12ca974714e96ad07ddc5
 SHA512:
-  metadata.gz: 41d44df3cbad351bbc8eb9108d71c2052ce9dc7a54af97c2663f60e92f860408e6d393bbe8f16ed0d62b3c8d183e7edf011de518b479840b4df749a080837ea5
-  data.tar.gz: baa1976590ed70238de71cb312db9252cbe47bbc95ba6bd407a85989d84df03f01788a5f3cee4de204af2f4e7f35cdeaea037aec601f2ebb475f7e87d8fc5d35
+  metadata.gz: 583135decf330bf180f8600fb8ff976f4bc548778fc176ff4cfe62f07c434f18cc80fd2887308495ecef9eee626922cb26ae34e3b4603e846f131f3a03cbffb3
+  data.tar.gz: b0446ddea4855a3c0e7b0ec5afc7b5a5b9e0b2aa897539bb4e29bc75be733bf16e12283c6c4bfb840377c1773ab3dbe2ae115a4ce6e706a8f8dfc7019e1e6b42

checksums.yaml.gz.sig

@@ -1,4 +1 @@
-������ة�����D&;�2�!]�[�������
-���"s�!x�^������z�y�<84C#��"`����;yl�cN�(��5.ۘ�����v+���]`?3d�>�|�Hc=�h?�@U��t���*�?�W����/��|ϵyN��yn���M.� ��R����ZHq����sv�ô�r�0�,Y�Q
-)�!
-�m����2��֨�%{�`��&��Ntw�w�-�$���:�ڈK.���>�/���
+�R�K`	�k{�{�g����Dg���v���\�W���"J7
y\*�<o�ҩ�"��^پ��&K$�؛��CP\}�3��G�����Te�<F��ɴs��%���գ�0������;�{�-��=e�@����fY*�ň��gǽ���|�p�OhIw��!�a�Q)�ퟫsJ�^HM��*�#{�G��$���U���jݚ��P+vBgܛG��Uُ�7��3*5�gM^�
�9'���0:���VoL��\�{���p�

data/lib/bson/array.rb

@@ -35,7 +35,7 @@ module BSON
     # @note Arrays are encoded as documents, where the index of the value in
     #   the array is the actual key.
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/binary.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'base64'
+
 module BSON
 
   # Represents binary data.
@@ -89,7 +91,7 @@ module BSON
     #
     # @since 2.0.0
     def as_json(*args)
-      { "$binary" => data, "$type" => type }
+      { "$binary" => Base64.encode64(data), "$type" => type }
     end
 
     # Instantiate the new binary object.
@@ -124,7 +126,7 @@ module BSON
     # @example Encode the binary.
     #   binary.to_bson
     #
-    # @return [ String ] The encoded binary.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/code.rb

@@ -76,7 +76,7 @@ module BSON
     # @example Encode the code.
     #   code.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/code_with_scope.rb

@@ -82,7 +82,7 @@ module BSON
     # @example Encode the code with scope.
     #   code_with_scope.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/date.rb

@@ -29,7 +29,7 @@ module BSON
     # @example Get the date as encoded BSON.
     #   Date.new(2012, 1, 1).to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/date_time.rb

@@ -29,7 +29,7 @@ module BSON
     # @example Get the date time as encoded BSON.
     #   DateTime.new(2012, 1, 1, 0, 0, 0).to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/decimal128.rb

@@ -109,7 +109,7 @@ module BSON
     # @example Get the raw bson bytes in a buffer.
     #   decimal.to_bson
     #
-    # @return [ BSON::ByteBuffer ] The raw bytes in a buffer.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/false_class.rb

@@ -44,7 +44,7 @@ module BSON
     # @example Get the false boolean as encoded BSON.
     #   false.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/float.rb

@@ -37,7 +37,7 @@ module BSON
     # @example Get the floating point as encoded BSON.
     #   1.221311.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/hash.rb

@@ -32,7 +32,7 @@ module BSON
     # @example Get the hash as encoded BSON.
     #   { "field" => "value" }.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/integer.rb

@@ -98,7 +98,7 @@ module BSON
     # @example Get the integer as encoded BSON.
     #   1024.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/object_id.rb

@@ -164,7 +164,7 @@ module BSON
     #   where the object was instantiated in a non-standard way. (Like a
     #   Marshal.load)
     #
-    # @return [ String ] The raw bytes.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/open_struct.rb

@@ -27,7 +27,7 @@ module BSON
     # @example Get the OpenStruct object as encoded BSON.
     #   OpenStruct.new({ "field" => "value" }).to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/regexp.rb

@@ -51,6 +51,8 @@ module BSON
     # Ruby multiline constant.
     #
     # @since 3.2.6
+    #
+    # @deprecated Will be removed in 5.0
     RUBY_MULTILINE_VALUE = 'ms'.freeze
 
     # Get the regexp as JSON hash data.
@@ -79,7 +81,10 @@ module BSON
     #   's' for dotall mode ('.' matches everything),
     #   and 'u' to make \w, \W, etc. match unicode.
     #
-    # @return [ String ] The encoded string.
+    # @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.
+    # @param [ true, false ] validating_keys
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #
@@ -92,7 +97,8 @@ module BSON
     private
 
     def bson_options
-      bson_ignorecase + bson_multiline + bson_extended
+      # Ruby's Regexp always has BSON's equivalent of 'm' on, so always add it
+      bson_ignorecase + MULTILINE_VALUE + bson_dotall + bson_extended
     end
 
     def bson_extended
@@ -103,8 +109,9 @@ module BSON
       (options & ::Regexp::IGNORECASE != 0) ? IGNORECASE_VALUE : NO_VALUE
     end
 
-    def bson_multiline
-      (options & ::Regexp::MULTILINE != 0) ? RUBY_MULTILINE_VALUE : NO_VALUE
+    def bson_dotall
+      # Ruby Regexp's MULTILINE is equivalent to BSON's dotall value
+      (options & ::Regexp::MULTILINE != 0) ? NEWLINE_VALUE : NO_VALUE
     end
 
     # Represents the raw values for the regular expression.
@@ -113,6 +120,7 @@ module BSON
     #
     # @since 3.0.0
     class Raw
+      include JSON
 
       # @return [ String ] pattern The regex pattern.
       attr_reader :pattern
@@ -129,7 +137,7 @@ module BSON
       #
       # @since 3.0.0
       def compile
-        @compiled ||= ::Regexp.new(pattern, options)
+        @compiled ||= ::Regexp.new(pattern, options_to_int)
       end
 
       # Initialize the new raw regular expression.
@@ -138,7 +146,11 @@ module BSON
       #   Raw.new(pattern, options)
       #
       # @param [ String ] pattern The regular expression pattern.
-      # @param [ Integer ] options The options.
+      # @param [ String, Integer ] options The options.
+      #
+      # @note The ability to specify options as an Integer is deprecated.
+      #  Please specify options as a String. The ability to pass options as
+      #  as Integer will be removed in version 5.0.0.
       #
       # @since 3.0.0
       def initialize(pattern, options)
@@ -153,15 +165,81 @@ module BSON
       #
       # @since 3.1.0
       def respond_to?(method, include_private = false)
-        compile.respond_to?(method, include_private = false) || super
+        compile.respond_to?(method, include_private) || super
       end
 
+      # Encode the Raw Regexp object to BSON.
+      #
+      # @example Get the raw regular expression as encoded BSON.
+      #   raw_regexp.to_bson
+      #
+      # @note From the BSON spec: The first cstring is the regex pattern,
+      #   the second is the regex options string. Options are identified
+      #   by characters, which must be stored in alphabetical order.
+      #   Valid options are 'i' for case insensitive matching,
+      #   'm' for multiline matching, 'x' for verbose mode,
+      #   'l' to make \w, \W, etc. locale dependent,
+      #   's' for dotall mode ('.' matches everything),
+      #   and 'u' to make \w, \W, etc. match unicode.
+      #
+      # @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.
+      # @param [ true, false ] validating_keys
+      #
+      # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 4.2.0
+      def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+        return compile.to_bson(buffer, validating_keys) if options.is_a?(Integer)
+        buffer.put_cstring(source)
+        buffer.put_cstring(options.chars.sort.join)
+      end
+
+      # Get the raw BSON regexp as JSON hash data.
+      #
+      # @example Get the raw regexp as a JSON hash.
+      #   raw_regexp.as_json
+      #
+      # @return [ Hash ] The raw regexp as a JSON hash.
+      #
+      # @since 4.2.0
+      def as_json(*args)
+        { "$regex" => source, "$options" => options }
+      end
+
+      # Check equality of the raw bson regexp against another.
+      #
+      # @example Check if the raw bson regexp is equal to the other.
+      #   raw_regexp == other
+      #
+      # @param [ Object ] other The object to check against.
+      #
+      # @return [ true, false ] If the objects are equal.
+      #
+      # @since 4.2.0
+      def ==(other)
+        return false unless other.is_a?(::Regexp::Raw)
+        pattern == other.pattern &&
+          options == other.options
+      end
+      alias :eql? :==
+
       private
 
       def method_missing(method, *arguments)
         return super unless respond_to?(method)
         compile.send(method, *arguments)
       end
+
+      def options_to_int
+        return options if options.is_a?(Integer)
+        opts = 0
+        opts |= ::Regexp::IGNORECASE if options.include?(IGNORECASE_VALUE)
+        opts |= ::Regexp::MULTILINE if options.include?(NEWLINE_VALUE)
+        opts |= ::Regexp::EXTENDED if options.include?(EXTENDED_VALUE)
+        opts
+      end
     end
 
     module ClassMethods
@@ -177,17 +255,7 @@ module BSON
       # @since 2.0.0
       def from_bson(buffer)
         pattern = buffer.get_cstring
-        options = 0
-        while (option = buffer.get_byte) != NULL_BYTE
-          case option
-          when IGNORECASE_VALUE
-            options |= ::Regexp::IGNORECASE
-          when MULTILINE_VALUE, NEWLINE_VALUE
-            options |= ::Regexp::MULTILINE
-          when EXTENDED_VALUE
-            options |= ::Regexp::EXTENDED
-          end
-        end
+        options = buffer.get_cstring
         Raw.new(pattern, options)
       end
     end

data/lib/bson/specialized.rb

@@ -42,7 +42,7 @@ module BSON
     # @example Encode the min key value.
     #   min_key.to_bson
     #
-    # @return [ String ] An empty string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @since 2.0.0
     def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)

data/lib/bson/string.rb

@@ -40,7 +40,7 @@ module BSON
     #
     # @raise [ EncodingError ] If the string is not UTF-8.
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/symbol.rb

@@ -51,7 +51,7 @@ module BSON
     # @example Get the symbol as encoded BSON.
     #   :test.to_bson
     #
-    # @return [ Symbol ] The encoded symbol.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/time.rb

@@ -32,7 +32,7 @@ module BSON
     # @example Get the time as encoded BSON.
     #   Time.new(2012, 1, 1, 0, 0, 0).to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/timestamp.rb

@@ -82,7 +82,7 @@ module BSON
     # @example Get the timestamp as BSON.
     #   timestamp.to_bson
     #
-    # @return [ String ] The raw BSON bytes.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/true_class.rb

@@ -44,7 +44,7 @@ module BSON
     # @example Get the true boolean as encoded BSON.
     #   true.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.2.0.rc1".freeze
+  VERSION = "4.2.0".freeze
 end

data/spec/bson/array_spec.rb

@@ -127,7 +127,7 @@ describe Array do
           end
 
           it "serializes the hash" do
-            expect(obj.to_bson.length).to eq(251)
+            expect(obj.to_bson.length).to eq(252)
           end
         end
       end

data/spec/bson/binary_spec.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require "spec_helper"
+require "base64"
 
 describe BSON::Binary do
   let(:testing1)  { described_class.new("testing") }
@@ -62,7 +63,7 @@ describe BSON::Binary do
 
     it "returns the binary data plus type" do
       expect(object.as_json).to eq(
-        { "$binary" => "testing", "$type" => :user }
+        { "$binary" => Base64.encode64("testing"), "$type" => :user }
       )
     end
 

data/spec/bson/corpus_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe 'Driver BSON Corpus spec tests' do
+
+  specs = BSON_CORPUS_TESTS.map { |file| BSON::Corpus::Spec.new(file) }
+
+  specs.each do |spec|
+
+    context(spec.description) do
+
+      spec.valid_tests.each do |test|
+
+        context("VALID CASE: #{test.description}") do
+
+          it 'roundtrips the given bson correctly' do
+            expect(test.reencoded_bson).to eq(test.correct_bson)
+          end
+
+          context 'when the canonical bson is roundtripped', if: test.test_canonical_bson? do
+
+            it 'encodes the canonical bson correctly' do
+              expect(test.reencoded_canonical_bson).to eq(test.correct_bson)
+            end
+          end
+
+          context 'when the document can be represented as extended json', if: test.test_extjson? do
+
+            it 'decodes from the given bson, then encodes the document as extended json correctly' do
+              skip 'The extended json in this test case does not match' unless (test.extjson_from_bson == test.correct_extjson)
+              expect(test.extjson_from_bson).to eq(test.correct_extjson)
+              expect(test.extjson_from_bson[test.test_key]).to eq(test.correct_extjson[test.test_key])
+            end
+
+            it 'decodes from extended json, then encodes the document as extended json correctly' do
+              expect(test.extjson_from_encoded_extjson).to eq(test.correct_extjson)
+              expect(test.extjson_from_encoded_extjson[test.test_key]).to eq(test.correct_extjson[test.test_key])
+            end
+
+            context 'when the canonical bson can be represented as extended json', if: (test.test_canonical_bson? && test.test_extjson?) do
+
+              it 'encodes the canonical bson correctly as extended json' do
+                expect(test.extjson_from_canonical_bson).to eq(test.correct_extjson)
+                expect(test.extjson_from_canonical_bson[test.test_key]).to eq(test.correct_extjson[test.test_key])
+              end
+            end
+          end
+        end
+      end
+
+      spec.invalid_tests.each do |test|
+
+        context("INVALID CASE: #{test.description}") do
+
+          let(:error) do
+            begin; test.reencoded_bson; false; rescue => e; e; end
+          end
+
+          it 'raises an error' do
+            skip 'This test case does not raise and error but should' unless error
+            expect {
+              test.reencoded_bson
+            }.to raise_error
+          end
+        end
+      end
+    end
+  end
+end