bson 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fd6495323d94fea442f4e61c9338529f5164418
-  data.tar.gz: ab4f5d9674132ecced648aa3e4470660ecd2f900
+  metadata.gz: 5e51b7ae94371082cd621f26b85adbe629665bd0
+  data.tar.gz: 4073b003473247e42ebaeb1036d478a4390688f5
 SHA512:
-  metadata.gz: 0738c3815003a964d0e5e8ce8bb1837dc64d73393dffc9478a3cb9cfe03e22aac8b77431ba7da361281ac747ef0bd1bd832b6f322d21a219c5e83622aaee956b
-  data.tar.gz: 975f07b5635d3dd4899c020e4fcb0e3bfc5a51fd56ce042af0af1e50f7cb55be2ab46d89ad8fc7d42f51c4a50aa9925ebb73952135329eaaf77bf3a0aba13691
+  metadata.gz: 8fdcaa1935708f0444225be5c8d27e74d5b2e8ef7e42a87ef0c9a228ffe6422e83dbb9ed2857208304772168d09b4b8f4c7a6f4e34b788cbd88b3bda685db9ef
+  data.tar.gz: 70d353c0099e3a1df936f08bc2cbe5439661f64e441422db79d04c2664e33fe66d30bef0e992481c49097eb1bca5f30f292d5e69691dba3f6e09f3955f59a955

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 BSON Changelog
 ==============
 
+## 3.0.0
+
+### Backwards Incompatible Changes
+
+* [RUBY-852](https://jira.mongodb.org/browse/RUBY-852) Regular expressions that
+  are deserialized now return a `BSON::Regexp::Raw` instead of a `Regexp` object.
+  In order to get the regular expression compiled, call `#compile` on the returned object.
+
+    raw.compile
+
+### New Features
+
+* `BSON::Binary` now implements `#inspect` with a truncated view of the data for
+  better readability.
+
+### Bug Fixes
+
+* The native object id generation was fixed to match the raw Ruby. (Conrad Irwin)
+
+* [#23](http://github.com/mongodb/bson-ruby/pull/23):
+  `BSON::Binary` types can be now used as hash keys. (Adam Wróbel)
+
 ## 2.2.3
 
 ### Bug Fixes

data/README.md

@@ -1,4 +1,4 @@
-BSON [![Build Status](https://secure.travis-ci.org/mongodb/bson-ruby.png?branch=master&.png)](http://travis-ci.org/mongodb/bson-ruby) [![Code Climate](https://codeclimate.com/github/mongodb/bson-ruby.png)](https://codeclimate.com/github/mongodb/bson-ruby) [![Coverage Status](https://coveralls.io/repos/mongodb/bson-ruby/badge.png?branch=master)](https://coveralls.io/r/mongodb/bson-ruby?branch=master)
+BSON [![Build Status](https://secure.travis-ci.org/mongodb/bson-ruby.png?branch=master&.png)](http://travis-ci.org/mongodb/bson-ruby)  [![Code Climate](https://codeclimate.com/github/mongodb/bson-ruby.png)](https://codeclimate.com/github/mongodb/bson-ruby) [![Coverage Status](https://coveralls.io/repos/mongodb/bson-ruby/badge.png?branch=master)](https://coveralls.io/r/mongodb/bson-ruby?branch=master) [![Inline docs](http://inch-ci.org/github/mongodb/bson-ruby.svg?branch=master)](http://inch-ci.org/github/mongodb/bson-ruby)
 ====
 
 An implementation of the BSON specification in Ruby.

data/ext/bson/native.c

@@ -242,10 +242,13 @@ static VALUE rb_object_id_generator_next(int argc, VALUE* args, VALUE self)
     t = htonl(NUM2UINT(rb_funcall(*args, rb_intern("to_i"), 0)));
   }
 
+  unsigned long c;
+  c = htonl(rb_bson_object_id_counter << 8);
+
   memcpy(&bytes, &t, 4);
   memcpy(&bytes[4], rb_bson_machine_id, 3);
   memcpy(&bytes[7], &pid, 2);
-  memcpy(&bytes[9], (unsigned char*) &rb_bson_object_id_counter, 3);
+  memcpy(&bytes[9], (unsigned char*) &c, 3);
   rb_bson_object_id_counter++;
   return rb_str_new(bytes, 12);
 }
@@ -356,7 +359,7 @@ static VALUE rb_integer_to_bson_key(int argc, VALUE *argv, VALUE self)
 static VALUE rb_integer_from_bson_int32(VALUE self, VALUE bson)
 {
   const uint8_t *v = (const uint8_t*) RSTRING_PTR(bson);
-  const uint32_t integer = v[0] + (v[1] << 8) + (v[2] << 16) + (v[3] << 24);
+  const int32_t integer = v[0] + (v[1] << 8) + (v[2] << 16) + (v[3] << 24);
   return INT2NUM(integer);
 }
 

data/lib/bson/binary.rb

@@ -68,6 +68,18 @@ module BSON
       return false unless other.is_a?(Binary)
       type == other.type && data == other.data
     end
+    alias eql? ==
+
+    # Generates a Fixnum hash value for this object.
+    #
+    # Allows using Binary as hash keys.
+    #
+    # @return [ Fixnum ]
+    #
+    # @since 2.3.1
+    def hash
+      data.hash + type.hash
+    end
 
     # Get the binary as JSON hash data.
     #
@@ -96,6 +108,18 @@ module BSON
       @type = type
     end
 
+    # Get a nice string for use with object inspection.
+    #
+    # @example Inspect the binary.
+    #   object_id.inspect
+    #
+    # @return [ String ] The binary in form BSON::Binary:object_id
+    #
+    # @since 2.3.0
+    def inspect
+      "<BSON::Binary:0x#{object_id} type=#{type} data=#{data[0, 8]}...>"
+    end
+
     # Encode the binary type
     #
     # @example Encode the binary.

data/lib/bson/boolean.rb

@@ -14,7 +14,7 @@
 
 module BSON
 
-  # Represents a $maxKey type, which compares less than any other value in the
+  # Represents a boolean type, which compares less than any other value in the
   # specification.
   #
   # @see http://bsonspec.org/#/specification

data/lib/bson/object_id.rb

@@ -118,13 +118,13 @@ module BSON
     # Get a nice string for use with object inspection.
     #
     # @example Inspect the object id.
-    #   obhect_id.inspect
+    #   object_id.inspect
     #
     # @return [ String ] The object id in form BSON::ObjectId('id')
     #
     # @since 2.0.0
     def inspect
-      "BSON::ObjectId('#{to_s}')"
+      "<BSON::ObjectId:0x#{object_id} data=#{to_s}>"
     end
 
     # Dump the raw bson when calling Marshal.dump.

data/lib/bson/regexp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2015 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -82,7 +82,48 @@ module BSON
       (options & ::Regexp::MULTILINE != 0) ? "ms" : NO_VALUE
     end
 
+    # Represents the raw values for the regular expression.
+    #
+    # @see https://jira.mongodb.org/browse/RUBY-698
+    #
+    # @since 3.0.0
+    class Raw
+
+      # @return [ String ] pattern The regex pattern.
+      attr_reader :pattern
+
+      # @return [ Integer ] options The options.
+      attr_reader :options
+
+      # Compile the Regular expression into the native type.
+      #
+      # @example Compile the regular expression.
+      #   raw.compile
+      #
+      # @return [ ::Regexp ] The compiled regular expression.
+      #
+      # @since 3.0.0
+      def compile
+        @compiled ||= ::Regexp.new(pattern, options)
+      end
+
+      # Initialize the new raw regular expression.
+      #
+      # @example Initialize the raw regexp.
+      #   Raw.new(pattern, options)
+      #
+      # @param [ String ] pattern The regular expression pattern.
+      # @param [ Integer ] options The options.
+      #
+      # @since 3.0.0
+      def initialize(pattern, options)
+        @pattern = pattern
+        @options = options
+      end
+    end
+
     module ClassMethods
+
       # Deserialize the regular expression from BSON.
       #
       # @param [ BSON ] bson The bson representing a regular expression.
@@ -105,8 +146,7 @@ module BSON
             options |= ::Regexp::EXTENDED
           end
         end
-
-        new(pattern, options)
+        Raw.new(pattern, options)
       end
     end
 

data/lib/bson/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2015 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/spec/bson/binary_spec.rb

@@ -15,6 +15,44 @@
 require "spec_helper"
 
 describe BSON::Binary do
+  let(:testing1)  { described_class.new("testing") }
+  let(:testing2)  { described_class.new("testing") }
+  let(:not_testing) { described_class.new("not testing") }
+
+  describe "#eql?" do
+    context "for two equal objects" do
+      it "returns true" do
+        expect(testing1).to eql(testing2)
+      end
+    end
+
+    context "for two different objects" do
+      it "returns false" do
+        expect(testing1).not_to eql(not_testing)
+      end
+    end
+  end
+
+  describe "#hash" do
+    context "for two equal objects" do
+      it "is the same" do
+        expect(testing1.hash).to eq(testing2.hash)
+      end
+    end
+
+    context "for two different objects" do
+      it "is different" do
+        expect(testing1.hash).not_to eq(not_testing.hash)
+      end
+    end
+  end
+
+  let(:hash) do { testing1 => "my value" } end
+
+  it "can be used as Hash key" do
+    expect(hash[testing2]).to eq("my value")
+    expect(hash[not_testing]).to be_nil
+  end
 
   describe "#as_json" do
 
@@ -46,6 +84,17 @@ describe BSON::Binary do
     end
   end
 
+  describe '#inspect' do
+
+    let(:object) do
+      described_class.new('testing123', :user)
+    end
+
+    it 'returns the truncated data and type' do
+      expect(object.inspect).to eq("<BSON::Binary:0x#{object.object_id} type=user data=testing1...>")
+    end
+  end
+
   describe "#to_bson/#from_bson" do
 
     let(:type) { 5.chr }

data/spec/bson/document_spec.rb

@@ -723,7 +723,13 @@ describe BSON::Document do
         described_class["type", /^gültig/]
       end
 
-      it_behaves_like "a document able to handle utf-8"
+      let(:deserialized) do
+        described_class.from_bson(StringIO.new(document.to_bson))
+      end
+
+      it "serializes and deserializes properly" do
+        expect(deserialized['type'].compile).to eq(/^gültig/)
+      end
     end
 
     context "when the symbols are utf-8" do

data/spec/bson/int32_spec.rb

@@ -25,4 +25,18 @@ describe BSON::Int32 do
     it_behaves_like "a bson element"
     it_behaves_like "a deserializable bson element"
   end
+
+  describe "when the integer is negative" do
+    let(:decoded) { -1 }
+    let(:encoded) {StringIO.new([ -1 ].pack(BSON::Int32::PACK))}
+    let(:decoded_2) { -50 }
+    let(:encoded_2) {StringIO.new([ -50 ].pack(BSON::Int32::PACK))}
+    it "decodes a -1 correctly" do
+      expect(BSON::Int32.from_bson(encoded)).to eq(decoded)
+    end  
+    it "decodes a -50 correctly" do
+      expect(BSON::Int32.from_bson(encoded_2)).to eq(decoded_2)
+    end  
+  end
+  
 end

data/spec/bson/object_id_spec.rb

@@ -390,7 +390,7 @@ describe BSON::ObjectId do
     end
 
     it "returns the inspection with the object id to_s" do
-      expect(object_id.inspect).to eq("BSON::ObjectId('#{object_id.to_s}')")
+      expect(object_id.inspect).to eq("<BSON::ObjectId:0x#{object_id.object_id} data=#{object_id.to_s}>")
     end
   end
 

data/spec/bson/regexp_spec.rb

@@ -36,6 +36,14 @@ describe Regexp do
     let(:type) { 11.chr }
     let(:obj)  { /test/ }
 
+    let(:io) do
+      StringIO.new(bson)
+    end
+
+    let(:result) do
+      described_class.from_bson(io).compile
+    end
+
     it_behaves_like "a bson element"
 
     context "when the regexp has no options" do
@@ -44,7 +52,10 @@ describe Regexp do
       let(:bson) { "#{obj.source}#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}" }
 
       it_behaves_like "a serializable bson element"
-      it_behaves_like "a deserializable bson element"
+
+      it "deserializes from bson" do
+        expect(result).to eq(obj)
+      end
     end
 
     context "when the regexp has options" do
@@ -55,7 +66,10 @@ describe Regexp do
         let(:bson) { "#{obj.source}#{BSON::NULL_BYTE}i#{BSON::NULL_BYTE}" }
 
         it_behaves_like "a serializable bson element"
-        it_behaves_like "a deserializable bson element"
+
+        it "deserializes from bson" do
+          expect(result).to eq(obj)
+        end
       end
 
       context "when matching multiline" do
@@ -64,7 +78,10 @@ describe Regexp do
         let(:bson) { "#{obj.source}#{BSON::NULL_BYTE}ms#{BSON::NULL_BYTE}" }
 
         it_behaves_like "a serializable bson element"
-        it_behaves_like "a deserializable bson element"
+
+        it "deserializes from bson" do
+          expect(result).to eq(obj)
+        end
       end
 
       context "when matching extended" do
@@ -73,7 +90,10 @@ describe Regexp do
         let(:bson) { "#{obj.source}#{BSON::NULL_BYTE}x#{BSON::NULL_BYTE}" }
 
         it_behaves_like "a serializable bson element"
-        it_behaves_like "a deserializable bson element"
+
+        it "deserializes from bson" do
+          expect(result).to eq(obj)
+        end
       end
 
       context "when all options are present" do
@@ -82,7 +102,10 @@ describe Regexp do
         let(:bson) { "#{obj.source}#{BSON::NULL_BYTE}imsx#{BSON::NULL_BYTE}" }
 
         it_behaves_like "a serializable bson element"
-        it_behaves_like "a deserializable bson element"
+
+        it "deserializes from bson" do
+          expect(result).to eq(obj)
+        end
       end
     end
   end

data/spec/support/shared_examples.rb

@@ -57,8 +57,12 @@ shared_examples_for "a deserializable bson element" do
     StringIO.new(bson)
   end
 
+  let(:result) do
+    described_class.from_bson(io)
+  end
+
   it "deserializes from bson" do
-    expect(described_class.from_bson(io)).to eq(obj)
+    expect(result).to eq(obj)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tyler Brock
@@ -11,30 +11,8 @@ authors:
 - Gary Murakami
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRQwEgYDVQQDDAtkcml2
-  ZXItcnVieTEVMBMGCgmSJomT8ixkARkWBTEwZ2VuMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMB4XDTE0MDIxOTE1MTEyNloXDTE1MDIxOTE1MTEyNlowQjEUMBIGA1UEAwwL
-  ZHJpdmVyLXJ1YnkxFTATBgoJkiaJk/IsZAEZFgUxMGdlbjETMBEGCgmSJomT8ixk
-  ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANFdSAa8fRm1
-  bAM9za6Z0fAH4g02bqM1NGnw8zJQrE/PFrFfY6IFCT2AsLfOwr1maVm7iU1+kdVI
-  IQ+iI/9+E+ArJ+rbGV3dDPQ+SLl3mLT+vXjfjcxMqI2IW6UuVtt2U3Rxd4QU0kdT
-  JxmcPYs5fDN6BgYc6XXgUjy3m+Kwha2pGctdciUOwEfOZ4RmNRlEZKCMLRHdFP8j
-  4WTnJSGfXDiuoXICJb5yOPOZPuaapPSNXp93QkUdsqdKC32I+KMpKKYGBQ6yisfA
-  5MyVPPCzLR1lP5qXVGJPnOqUAkvEUfCahg7EP9tI20qxiXrR6TSEraYhIFXL0EGY
-  u8KAcPHm5KkCAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
-  BBYEFFt3WbF+9JpUjAoj62cQBgNb8HzXMCAGA1UdEQQZMBeBFWRyaXZlci1ydWJ5
-  QDEwZ2VuLmNvbTAgBgNVHRIEGTAXgRVkcml2ZXItcnVieUAxMGdlbi5jb20wDQYJ
-  KoZIhvcNAQEFBQADggEBALGvdxHF+CnH6QO4PeIce3S8EHuHsYiGLk4sWgNGZkjD
-  V3C4XjlI8rQZxalwQwcauacOGj9x94flWUXruEF7+rjUtig7OIrQK2+uVg86vl8r
-  xy1n2s1d31KsuazEVExe5o19tnVbI9+30P9qPkS+NgaellXpj5c5qnJUGn5BJtzo
-  3D001zXpVnuZvCcE/A4fQ+BEM0zm0oOmA/gWIAFrufOL9oYg1881dRZ+kQytF/9c
-  JrZM8w8wGbIOeLtoQqa7HB/jOYbTahH7KMNh2LHAbOR93hNIJxVRa4iwxiMQ75tN
-  9WUIAJ4AEtjwRg1Bz0OwDo3aucPCBpx77+/FWhv7JYY=
-  -----END CERTIFICATE-----
-date: 2014-06-02 00:00:00.000000000 Z
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies: []
 description: A full featured BSON specification implementation, in Ruby
 email:

data.tar.gz.sig

@@ -1 +0,0 @@
-�0NU�י[���4�?�2���2<���BL����R����a��/�H�3-����Y��-i��e�z��<�SM���r���k�����*P��&�'����*���}����/e^bIY�Ϟ$����