bson 2.2.4 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33f503f9418e54b133f0115a51c642a1413de120
-  data.tar.gz: e2ad2a8903b3a672328ebaad368e6d6e24b33579
+  metadata.gz: 4fd6495323d94fea442f4e61c9338529f5164418
+  data.tar.gz: ab4f5d9674132ecced648aa3e4470660ecd2f900
 SHA512:
-  metadata.gz: 5cb2f4d67d4eed6883435e9c0411f3fb9f8169fd90db9606b61b48e69ade2d6ecda1ec6e15bcd87ec7dee7c071a34a2dff610dee4547f52adbe5ac040691366a
-  data.tar.gz: c8b362f0718d233c8a3cacc32c52034b8eac59c74c08b0847994f263a653715af424b1621e8e973c33325152f78265a45b66f3fd09f4354240f1e673ff6f1e29
+  metadata.gz: 0738c3815003a964d0e5e8ce8bb1837dc64d73393dffc9478a3cb9cfe03e22aac8b77431ba7da361281ac747ef0bd1bd832b6f322d21a219c5e83622aaee956b
+  data.tar.gz: 975f07b5635d3dd4899c020e4fcb0e3bfc5a51fd56ce042af0af1e50f7cb55be2ab46d89ad8fc7d42f51c4a50aa9925ebb73952135329eaaf77bf3a0aba13691

data.tar.gz.sig

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

data/README.md

@@ -15,7 +15,7 @@ With bundler, add the `bson` gem to your `Gemfile`. As of 2.0.0 native extension
 are bundled with the `bson` gem and `bson_ext` is no longer needed.
 
 ```ruby
-gem "bson", "~> 2.2"
+gem "bson", "~> 2.3"
 ```
 
 Require the `bson` gem in your application.
@@ -181,7 +181,7 @@ As of 2.0.0, this project adheres to the [Semantic Versioning Specification](htt
 License
 -------
 
-Copyright (C) 2009-2013 MongoDB Inc.
+Copyright (C) 2009-2014 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/lib/bson/array.rb

@@ -68,6 +68,18 @@ module BSON
       ObjectId.repair(self) { pack("C*") }
     end
 
+    # Converts the array to a normalized value in a BSON document.
+    #
+    # @example Convert the array to a normalized value.
+    #   array.to_bson_normalized_value
+    #
+    # @return [ Array ] The normazlied array.
+    #
+    # @since 3.0.0
+    def to_bson_normalized_value
+      map!{ |value| value.to_bson_normalized_value }
+    end
+
     module ClassMethods
 
       # Deserialize the array from BSON.

data/lib/bson/document.rb

@@ -50,7 +50,72 @@ module BSON
     #
     # @since 2.0.0
     def [](key)
-      super(key) || super(key.to_s)
+      super(key.to_bson_normalized_key)
     end
+
+    # Set a value on the document. Will normalize symbol keys into strings.
+    #
+    # @example Set a value on the document.
+    #   document[:test] = "value"
+    #
+    # @param [ String, Symbol ] key The key to update.
+    # @param [ Object ] value The value to update.
+    #
+    # @return [ Object ] The updated value.
+    #
+    # @since 3.0.0
+    def []=(key, value)
+      super(key.to_bson_normalized_key, value.to_bson_normalized_value)
+    end
+
+    # Instantiate a new Document. Valid parameters for instantiation is a hash
+    # only or nothing.
+    #
+    # @example Create the new Document.
+    #   BSON::Document.new(name: "Joe", age: 33)
+    #
+    # @param [ Hash ] elements The elements of the document.
+    #
+    # @since 3.0.0
+    def initialize(elements = nil)
+      super()
+      (elements || {}).each_pair{ |key, value| self[key] = value }
+    end
+
+    # Merge this document with another document, returning a new document in
+    # the process.
+    #
+    # @example Merge with another document.
+    #   document.merge(name: "Bob")
+    #
+    # @param [ BSON::Document, Hash ] other The document/hash to merge with.
+    #
+    # @eturn [ BSON::Document ] The result of the merge.
+    #
+    # @since 3.0.0
+    def merge(other, &block)
+      dup.merge!(other, &block)
+    end
+
+    # Merge this document with another document, returning the same document in
+    # the process.
+    #
+    # @example Merge with another document.
+    #   document.merge(name: "Bob")
+    #
+    # @param [ BSON::Document, Hash ] other The document/hash to merge with.
+    #
+    # @eturn [ BSON::Document ] The result of the merge.
+    #
+    # @since 3.0.0
+    def merge!(other)
+      other.each_pair do |key, value|
+        value = yield(key.to_bson_normalized_key, self[key], value.to_bson_normalized_value) if block_given?
+        self[key] = value
+      end
+      self
+    end
+
+    alias :update :merge!
   end
 end

data/lib/bson/hash.rb

@@ -48,6 +48,18 @@ module BSON
       end
     end
 
+    # Converts the hash to a normalized value in a BSON document.
+    #
+    # @example Convert the hash to a normalized value.
+    #   hash.to_bson_normalized_value
+    #
+    # @return [ BSON::Document ] The normazlied hash.
+    #
+    # @since 3.0.0
+    def to_bson_normalized_value
+      Document.new(self)
+    end
+
     module ClassMethods
 
       # Deserialize the hash from BSON.

data/lib/bson/object.rb

@@ -34,6 +34,30 @@ module BSON
     def to_bson_key(encoded = ''.force_encoding(BINARY))
       raise InvalidKey.new(self)
     end
+
+    # Converts the object to a normalized key in a BSON document.
+    #
+    # @example Convert the object to a normalized key.
+    #   object.to_bson_normalized_key
+    #
+    # @return [ Object ] self.
+    #
+    # @since 3.0.0
+    def to_bson_normalized_key
+      self
+    end
+
+    # Converts the object to a normalized value in a BSON document.
+    #
+    # @example Convert the object to a normalized value.
+    #   object.to_bson_normalized_value
+    #
+    # @return [ Object ] self.
+    #
+    # @since 3.0.0
+    def to_bson_normalized_value
+      self
+    end
   end
 
   # Raised when trying to serialize an object into a key.

data/lib/bson/symbol.rb

@@ -58,6 +58,18 @@ module BSON
       to_s.to_bson_key(encoded)
     end
 
+    # Converts the symbol to a normalized key in a BSON document.
+    #
+    # @example Convert the symbol to a normalized key.
+    #   :test.to_bson_normalized_key
+    #
+    # @return [ String ] The symbol as a non interned string.
+    #
+    # @since 3.0.0
+    def to_bson_normalized_key
+      to_s
+    end
+
     module ClassMethods
       # Deserialize a symbol from BSON.
       #

data/lib/bson/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "2.2.4"
+  VERSION = "2.3.0"
 end

data/spec/bson/binary_spec.rb

@@ -39,8 +39,8 @@ describe BSON::Binary do
         expect {
           described_class.new("testing", :error)
         }.to raise_error { |error|
-          error.should be_a(BSON::Binary::InvalidType)
-          error.message.should match /is not a valid binary type/
+          expect(error).to be_a(BSON::Binary::InvalidType)
+          expect(error.message).to match /is not a valid binary type/
         }
       end
     end

data/spec/bson/document_spec.rb

@@ -149,14 +149,14 @@ describe BSON::Document do
       context "when the key exists" do
 
         it "returns true" do
-          expect(doc.send(method, "blue")).to be_true
+          expect(doc.send(method, "blue")).to be true
         end
       end
 
       context "when the key does not exist" do
 
         it "returns false" do
-          expect(doc.send(method, "indigo")).to be_false
+          expect(doc.send(method, "indigo")).to be false
         end
       end
     end
@@ -169,14 +169,14 @@ describe BSON::Document do
       context "when the value exists" do
 
         it "returns true" do
-          expect(doc.send(method, "000099")).to be_true
+          expect(doc.send(method, "000099")).to be true
         end
       end
 
       context "when the value does not exist" do
 
         it "returns false" do
-          expect(doc.send(method, "ABCABC")).to be_false
+          expect(doc.send(method, "ABCABC")).to be false
         end
       end
     end
@@ -439,7 +439,7 @@ describe BSON::Document do
       it "executes the block on each merged element" do
         expect(merged[:a]).to eq(0)
         expect(merged[:b]).to eq(3)
-        expect(merged[:c]).to eq(7)
+        expect(merged[:c]).to eq(8)
       end
     end
   end
@@ -488,7 +488,7 @@ describe BSON::Document do
       it "executes the block on each merged element" do
         expect(other[:a]).to eq(0)
         expect(other[:b]).to eq(3)
-        expect(other[:c]).to eq(7)
+        expect(other[:c]).to eq(8)
       end
     end
   end
@@ -517,60 +517,58 @@ describe BSON::Document do
 
   describe "#initialize" do
 
-    context "when provided for splat args" do
+    context "when providing symbol keys" do
 
-      context "when an even number of args" do
+      let(:document) do
+        described_class.new(:test => 2, :testing => 4)
+      end
 
-        let(:alternate) do
-          described_class[1, 2, 3, 4]
-        end
+      it "converts the symbols to strings" do
+        expect(document).to eq({ "test" => 2, "testing" => 4 })
+      end
+    end
 
-        it "treats the arguments are an array" do
-          expect(alternate.keys).to eq([ 1, 3 ])
-        end
+    context "when providing duplicate symbol and string keys" do
 
-        it "instantiates a document" do
-          expect(alternate).to be_a(BSON::Document)
-        end
+      let(:document) do
+        described_class.new(:test => 2, "test" => 4)
       end
 
-      context "when an odd number of arguments" do
-
-        it "raises an argument error" do
-          expect {
-            described_class[1, 2, 3]
-          }.to raise_error(ArgumentError)
-        end
+      it "uses the last provided string key value" do
+        expect(document[:test]).to eq(4)
       end
     end
 
-    context "when provided an array" do
+    context "when providing a nested hash with symbol keys" do
 
-      let(:alternate) do
-        described_class[[[ 1, 2 ], [ 3, 4 ], [ "missing" ]]]
-      end
-
-      it "sets the keys" do
-        expect(alternate.keys).to eq([ 1, 3, "missing" ])
+      let(:document) do
+        described_class.new(:test => { :test => 4 })
       end
 
-      it "sets the values" do
-        expect(alternate.values).to eq([ 2, 4, nil ])
+      it "converts the nested keys to strings" do
+        expect(document).to eq({ "test" => { "test" => 4 }})
       end
     end
 
-    context "when provided hashes" do
+    context "when providing a nested hash multiple levels deep with symbol keys" do
+
+      let(:document) do
+        described_class.new(:test => { :test => { :test => 4 }})
+      end
 
-      let(:alternate) do
-        described_class[1 => 2, 3 => 4]
+      it "converts the nested keys to strings" do
+        expect(document).to eq({ "test" => { "test" => { "test" => 4 }}})
       end
+    end
+
+    context "when providing an array of nested hashes" do
 
-      it "sets the keys" do
-        expect(alternate.keys).to eq([ 1, 3 ])
+      let(:document) do
+        described_class.new(:test => [{ :test => 4 }])
       end
 
-      it "sets the values" do
-        expect(alternate.values).to eq([ 2, 4 ])
+      it "converts the nested keys to strings" do
+        expect(document).to eq({ "test" => [{ "test" => 4 }]})
       end
     end
   end
@@ -601,12 +599,16 @@ describe BSON::Document do
     end
 
     it "updates the keys" do
-      expect(updated.keys).to eq([ :name ])
+      expect(updated.keys).to eq([ "name" ])
     end
 
     it "updates the values" do
       expect(updated.values).to eq([ "Bob" ])
     end
+
+    it "returns the same document" do
+      expect(updated.update(:name => "Bob")).to equal(updated)
+    end
   end
 
   describe "#invert" do

data/spec/bson/max_key_spec.rb

@@ -38,14 +38,14 @@ describe BSON::MaxKey do
   describe "#>" do
 
     it "always returns true" do
-      expect(subject > Integer::MAX_64BIT).to be_true
+      expect(subject > Integer::MAX_64BIT).to be true
     end
   end
 
   describe "#<" do
 
     it "always returns false" do
-      expect(subject < Integer::MAX_64BIT).to be_false
+      expect(subject < Integer::MAX_64BIT).to be false
     end
   end
 

data/spec/bson/min_key_spec.rb

@@ -51,14 +51,14 @@ describe BSON::MinKey do
   describe "#>" do
 
     it "always returns false" do
-      expect(subject > Integer::MAX_64BIT).to be_false
+      expect(subject > Integer::MAX_64BIT).to be false
     end
   end
 
   describe "#<" do
 
     it "always returns true" do
-      expect(subject < Integer::MAX_64BIT).to be_true
+      expect(subject < Integer::MAX_64BIT).to be true
     end
   end
 

data/spec/bson/object_id_spec.rb

@@ -76,7 +76,7 @@ describe BSON::ObjectId do
         end
 
         it "returns true" do
-          expect(object_id === other).to be_true
+          expect(object_id === other).to be true
         end
       end
 
@@ -87,7 +87,7 @@ describe BSON::ObjectId do
         end
 
         it "returns false" do
-          expect(object_id === other).to be_false
+          expect(object_id === other).to be false
         end
       end
     end
@@ -95,7 +95,7 @@ describe BSON::ObjectId do
     context "when comparing to an object id class" do
 
       it "returns false" do
-        expect(object_id === BSON::ObjectId).to be_false
+        expect(object_id === BSON::ObjectId).to be false
       end
     end
 
@@ -108,7 +108,7 @@ describe BSON::ObjectId do
         end
 
         it "returns true" do
-          expect(object_id === other).to be_true
+          expect(object_id === other).to be true
         end
       end
 
@@ -119,7 +119,7 @@ describe BSON::ObjectId do
         end
 
         it "returns false" do
-          expect(object_id === other).to be_false
+          expect(object_id === other).to be false
         end
       end
     end
@@ -127,14 +127,14 @@ describe BSON::ObjectId do
     context "when comparing with a non string or object id" do
 
       it "returns false" do
-        expect(object_id === "test").to be_false
+        expect(object_id === "test").to be false
       end
     end
 
     context "when comparing with a non object id class" do
 
       it "returns false" do
-        expect(object_id === String).to be_false
+        expect(object_id === String).to be false
       end
     end
   end
@@ -152,14 +152,14 @@ describe BSON::ObjectId do
     context "when the generation time before the other" do
 
       it "returns true" do
-        expect(object_id < other_id).to be_true
+        expect(object_id < other_id).to be true
       end
     end
 
     context "when the generation time is after the other" do
 
       it "returns false" do
-        expect(other_id < object_id).to be_false
+        expect(other_id < object_id).to be false
       end
     end
   end
@@ -177,14 +177,14 @@ describe BSON::ObjectId do
     context "when the generation time before the other" do
 
       it "returns false" do
-        expect(object_id > other_id).to be_false
+        expect(object_id > other_id).to be false
       end
     end
 
     context "when the generation time is after the other" do
 
       it "returns true" do
-        expect(other_id > object_id).to be_true
+        expect(other_id > object_id).to be true
       end
     end
   end
@@ -333,7 +333,7 @@ describe BSON::ObjectId do
       end
 
       it "does not include process or sequence information" do
-        expect(object_id.to_s =~ /\A[0-9a-f]{8}[0]{16}\Z/).to be_true
+        expect(object_id.to_s =~ /\A[0-9a-f]{8}[0]{16}\Z/).to be_truthy
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.3.0
 platform: ruby
 authors:
 - Tyler Brock
@@ -11,8 +11,30 @@ authors:
 - Gary Murakami
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+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
 dependencies: []
 description: A full featured BSON specification implementation, in Ruby
 email: