bson 2.0.0.rc-java → 2.1.0-java

data/lib/bson/false_class.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/float.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/hash.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@ module BSON
     # Get the hash as encoded BSON.
     #
     # @example Get the hash as encoded BSON.
-    #   { field: "value" }.to_bson
+    #   { "field" => "value" }.to_bson
     #
     # @return [ String ] The encoded string.
     #
@@ -52,7 +52,7 @@ module BSON
 
       # Deserialize the hash from BSON.
       #
-      # @param [ String ] bson The bson representing a hash.
+      # @param [ IO ] bson The bson representing a hash.
       #
       # @return [ Array ] The decoded hash.
       #

data/lib/bson/int32.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/int64.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/integer.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/json.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "json"
-
 module BSON
 
   # Provides common behaviour for JSON serialization of objects.

data/lib/bson/max_key.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/min_key.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/nil_class.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/object_id.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -46,6 +46,7 @@ module BSON
       return false unless other.is_a?(ObjectId)
       to_bson == other.to_bson
     end
+    alias :eql? :==
 
     # Check case equality on the object id.
     #
@@ -102,12 +103,62 @@ module BSON
       ::Time.at(to_bson.unpack("N")[0]).utc
     end
 
+    # Get the hash value for the object id.
+    #
+    # @example Get the hash value.
+    #   object_id.hash
+    #
+    # @return [ Integer ] The hash value.
+    #
+    # @since 2.0.0
+    def hash
+      to_bson.hash
+    end
+
+    # Get a nice string for use with object inspection.
+    #
+    # @example Inspect the object id.
+    #   obhect_id.inspect
+    #
+    # @return [ String ] The object id in form BSON::ObjectId('id')
+    #
+    # @since 2.0.0
+    def inspect
+      "BSON::ObjectId('#{to_s}')"
+    end
+
+    # Dump the raw bson when calling Marshal.dump.
+    #
+    # @example Dump the raw bson.
+    #   Marshal.dump(object_id)
+    #
+    # @return [ String ] The raw bson bytes.
+    #
+    # @since 2.0.0
+    def marshal_dump
+      to_bson
+    end
+
+    # Unmarshal the data into an object id.
+    #
+    # @example Unmarshal the data.
+    #   Marshal.load(data)
+    #
+    # @param [ String ] data The raw bson bytes.
+    #
+    # @return [ String ] The raw bson bytes.
+    #
+    # @since 2.0.0
+    def marshal_load(data)
+      @raw_data = data
+    end
+
     # Get the object id as it's raw BSON data.
     #
     # @example Get the raw bson bytes.
     #   object_id.to_bson
     #
-    # @note Since Moped's BSON and 10gen BSON before 2.0.0 have different
+    # @note Since Moped's BSON and MongoDB BSON before 2.0.0 have different
     #   internal representations, we will attempt to repair the data for cases
     #   where the object was instantiated in a non-standard way. (Like a
     #   Marshal.load)
@@ -118,7 +169,7 @@ module BSON
     #
     # @since 2.0.0
     def to_bson(encoded = ''.force_encoding(BINARY))
-      repair!(@data) if defined?(@data)
+      repair if defined?(@data)
       @raw_data ||= @@generator.next
       encoded << @raw_data
     end
@@ -143,8 +194,9 @@ module BSON
 
     private
 
-    def data=(data)
-      @raw_data = data
+    def repair
+      @raw_data = @data.to_bson_object_id
+      remove_instance_variable(:@data)
     end
 
     class << self
@@ -175,7 +227,7 @@ module BSON
       # @since 2.0.0
       def from_data(data)
         object_id = allocate
-        object_id.send(:data=, data)
+        object_id.instance_variable_set(:@raw_data, data)
         object_id
       end
 
@@ -232,6 +284,27 @@ module BSON
       def legal?(string)
         string.to_s =~ /^[0-9a-f]{24}$/i ? true : false
       end
+
+      # Executes the provided block only if the size of the provided object is
+      # 12. Used in legacy id repairs.
+      #
+      # @example Execute in a repairing block.
+      #   BSON::ObjectId.repair("test") { obj }
+      #
+      # @param [ String, Array ] object The object to repair.
+      #
+      # @raise [ Invalid ] If the array is not 12 elements.
+      #
+      # @return [ String ] The result of the block.
+      #
+      # @since 2.0.0
+      def repair(object)
+        if object.size == 12
+          block_given? ? yield(object) : object
+        else
+          raise Invalid.new("#{object.inspect} is not a valid object id.")
+        end
+      end
     end
 
     # Inner class that encapsulates the behaviour of actually generating each

data/lib/bson/regexp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/registry.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/specialized.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/string.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2013 10gen Inc.
+# -*- coding: utf-8 -*-
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -59,7 +60,6 @@ module BSON
     #
     # @since 2.0.0
     def to_bson_key(encoded = ''.force_encoding(BINARY))
-      check_for_illegal_characters!
       to_bson_cstring(encoded)
     end
 
@@ -80,6 +80,23 @@ module BSON
       to_bson_string(encoded) << NULL_BYTE
     end
 
+    # Convert the string to an object id. This will only work for strings of size
+    # 12.
+    #
+    # @example Convert the string to an object id.
+    #   string.to_bson_object_id
+    #
+    # @note This is used for repairing legacy bson data.
+    #
+    # @raise [ InvalidObjectId ] If the string is not 12 elements.
+    #
+    # @return [ String ] The raw object id bytes.
+    #
+    # @since 2.0.0
+    def to_bson_object_id
+      ObjectId.repair(self)
+    end
+
     # Convert the string to a UTF-8 string then force to binary. This is so
     # we get errors for strings that are not UTF-8 encoded.
     #
@@ -168,7 +185,7 @@ module BSON
 
     def check_for_illegal_characters!
       if include?(NULL_BYTE)
-        raise RuntimeError.new("Illegal C-String '#{self}' contains a null byte.")
+        raise(ArgumentError, "Illegal C-String '#{self}' contains a null byte.")
       end
     end
 

data/lib/bson/symbol.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@ module BSON
     #
     # @since 2.0.0
     def to_bson_key(encoded = ''.force_encoding(BINARY))
-      to_s.to_bson_cstring(encoded)
+      to_s.to_bson_key(encoded)
     end
 
     module ClassMethods

data/lib/bson/time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/true_class.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/undefined.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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.0.0.rc"
+  VERSION = "2.1.0"
 end

data/spec/bson/array_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,4 +28,31 @@ describe Array do
     it_behaves_like "a serializable bson element"
     it_behaves_like "a deserializable bson element"
   end
+
+  describe "#to_bson_object_id" do
+
+    context "when the array has 12 elements" do
+
+      let(:array) do
+        [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
+      end
+
+      let(:converted) do
+        array.to_bson_object_id
+      end
+
+      it "returns the array as a string" do
+        expect(converted).to eq(array.pack("C*"))
+      end
+    end
+
+    context "when the array does not have 12 elements" do
+
+      it "raises an exception" do
+        expect {
+          [ 1 ].to_bson_object_id
+        }.to raise_error(BSON::ObjectId::Invalid)
+      end
+    end
+  end
 end

data/spec/bson/binary_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -31,6 +31,21 @@ describe BSON::Binary do
     it_behaves_like "a JSON serializable object"
   end
 
+  describe "#initialize" do
+
+    context "when he type is invalid" do
+
+      it "raises an error" 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/
+        }
+      end
+    end
+  end
+
   describe "#to_bson/#from_bson" do
 
     let(:type) { 5.chr }

data/spec/bson/boolean_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/spec/bson/code_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 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/spec/bson/code_with_scope_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,6 +16,29 @@ require "spec_helper"
 
 describe BSON::CodeWithScope do
 
+  describe "#==" do
+
+    let(:object) do
+      BSON::CodeWithScope.new("this.value = val", "test")
+    end
+
+    context "when the objects are equal" do
+      let(:other) { described_class.new("this.value = val", "test") }
+
+      it "returns true" do
+        expect(object).to eq(other)
+      end
+    end
+
+    context "when the other object is not equal" do
+      let(:other) { described_class.new("this.value = otherVal", "test") }
+
+      it "returns false" do
+        expect(object).to_not eq(other)
+      end
+    end
+  end
+
   describe "#as_json" do
 
     let(:object) do
@@ -40,8 +63,8 @@ describe BSON::CodeWithScope do
     end
     let(:obj) { described_class.new(code, scope) }
     let(:bson) do
-      "#{48.to_bson}#{(code.length + 1).to_bson}#{code}#{BSON::NULL_BYTE}" +
-      "#{scope.to_bson}#{BSON::NULL_BYTE}"
+      "#{47.to_bson}#{(code.length + 1).to_bson}#{code}#{BSON::NULL_BYTE}" +
+      "#{scope.to_bson}"
     end
 
     it_behaves_like "a bson element"
@@ -53,18 +76,22 @@ describe BSON::CodeWithScope do
     let(:type) { 15.chr }
     let(:code) { "this.value == name" }
     let(:scope) do
-      { :name => "test" }
+      { "name" => "test" }
     end
     let(:obj) { described_class.new(code, scope) }
     let(:bson) { StringIO.new(obj.to_bson) }
-    let(:deserialized) { described_class.from_bson(bson) }
+    let!(:deserialized) { described_class.from_bson(bson) }
 
     it "deserializes the javascript" do
       expect(deserialized.javascript).to eq(code)
     end
 
-    it "does not deserialize a scope" do
-      expect(deserialized.scope).to be_empty
+    it "deserializes the scope" do
+      expect(deserialized.scope).to eq(scope)
+    end
+
+    it "does not leave any extra bytes" do
+      expect(bson.read(1)).to be_nil
     end
   end
 end