bson 1.12.5-java → 2.0.0-java

data/lib/bson/timestamp.rb

@@ -0,0 +1,113 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+
+  # Represents a timestamp type, which is predominately used for sharding.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  class Timestamp
+    include JSON
+
+    # A timestamp is type 0x11 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 17.chr.force_encoding(BINARY).freeze
+
+    # @!attribute seconds
+    #   @return [ Integer ] The number of seconds.
+    #   @since 2.0.0
+    #
+    # @!attribute increment
+    #   @return [ Integer ] The incrementing value.
+    #   @since 2.0.0
+    #
+    attr_reader :seconds, :increment
+
+    # Determine if this timestamp is equal to another object.
+    #
+    # @example Check the timestamp equality.
+    #   timestamp == other
+    #
+    # @param [ Object ] other The object to compare against.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Timestamp)
+      seconds == other.seconds && increment == other.increment
+    end
+
+    # Get the timestamp as JSON hash data.
+    #
+    # @example Get the timestamp as a JSON hash.
+    #   timestamp.as_json
+    #
+    # @return [ Hash ] The timestamp as a JSON hash.
+    #
+    # @since 2.0.0
+    def as_json(*args)
+      { "t" => seconds, "i" => increment }
+    end
+
+    # Instantiate the new timestamp.
+    #
+    # @example Instantiate the timestamp.
+    #   BSON::Timestamp.new(5, 30)
+    #
+    # @param [ Integer ] seconds The number of seconds.
+    # @param [ Integer ] increment The increment value.
+    #
+    # @since 2.0.0
+    def initialize(seconds, increment)
+      @seconds, @increment = seconds, increment
+    end
+
+    # Get the timestamp as its encoded raw BSON bytes.
+    #
+    # @example Get the timestamp as BSON.
+    #   timestamp.to_bson
+    #
+    # @return [ String ] The raw BSON bytes.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      increment.to_bson_int32(encoded)
+      seconds.to_bson_int32(encoded)
+    end
+
+    # Deserialize timestamp from BSON.
+    #
+    # @param [ BSON ] bson The bson representing a timestamp.
+    #
+    # @return [ Timestamp ] The decoded timestamp.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def self.from_bson(bson)
+      new(*bson.read(8).unpack(Int32::PACK * 2).reverse)
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, self)
+  end
+end

data/lib/bson/true_class.rb

@@ -0,0 +1,61 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+
+  # Injects behaviour for encoding and decoding true values to and from
+  # raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  module TrueClass
+
+    # A true value in the BSON spec is 0x01.
+    #
+    # @since 2.0.0
+    TRUE_BYTE = 1.chr.force_encoding(BINARY).freeze
+
+    # The BSON type for true values is the general boolean type of 0x08.
+    #
+    # @example Get the bson type.
+    #   false.bson_type
+    #
+    # @return [ String ] The character 0x08.
+    #
+    # @since 2.0.0
+    def bson_type
+      Boolean::BSON_TYPE
+    end
+
+    # Get the true boolean as encoded BSON.
+    #
+    # @example Get the true boolean as encoded BSON.
+    #   true.to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded << TRUE_BYTE
+    end
+  end
+
+  # Enrich the core TrueClass class with this module.
+  #
+  # @since 2.0.0
+  ::TrueClass.send(:include, TrueClass)
+end

data/lib/bson/undefined.rb

@@ -0,0 +1,74 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+
+  # Represents the Undefined BSON type
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  class Undefined
+
+    # Undefined is type 0x06 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 6.chr.force_encoding(BINARY).freeze
+
+    # Determine if undefined is equal to another object.
+    #
+    # @example Check undefined equality.
+    #   BSON::Undefined.new == object
+    #
+    # @param [ Object ] other The object to check against.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      self.class == other.class
+    end
+
+    # Encode the Undefined field - has no value since it only needs the type
+    # and field name when being encoded.
+    #
+    # @example Encode the undefined value.
+    #   Undefined.to_bson
+    #
+    # @return [ String ] An empty string.
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded
+    end
+
+    # Deserialize undefined BSON type from BSON.
+    #
+    # @param [ BSON ] bson The encoded undefined value.
+    #
+    # @return [ Undefined ] The decoded undefined value.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def self.from_bson(bson)
+      new
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, self)
+  end
+end

data/lib/bson/version.rb

@@ -0,0 +1,17 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+  VERSION = "2.0.0"
+end

data/spec/bson/array_spec.rb

@@ -0,0 +1,58 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "spec_helper"
+
+describe Array do
+
+  describe "#to_bson/#from_bson" do
+
+    let(:type) { 4.chr }
+    let(:obj)  {[ "one", "two" ]}
+    let(:bson) do
+      BSON::Document["0", "one", "1", "two"].to_bson
+    end
+
+    it_behaves_like "a bson element"
+    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

@@ -0,0 +1,115 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "spec_helper"
+
+describe BSON::Binary do
+
+  describe "#as_json" do
+
+    let(:object) do
+      described_class.new("testing", :user)
+    end
+
+    it "returns the binary data plus type" do
+      expect(object.as_json).to eq(
+        { "$binary" => "testing", "$type" => :user }
+      )
+    end
+
+    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(BSON::Binary::InvalidType)
+      end
+    end
+  end
+
+  describe "#to_bson/#from_bson" do
+
+    let(:type) { 5.chr }
+
+    it_behaves_like "a bson element"
+
+    context "when the type is :generic" do
+
+      let(:obj)  { described_class.new("testing") }
+      let(:bson) { "#{7.to_bson}#{0.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the type is :function" do
+
+      let(:obj)  { described_class.new("testing", :function) }
+      let(:bson) { "#{7.to_bson}#{1.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the type is :old" do
+
+      let(:obj)  { described_class.new("testing", :old) }
+      let(:bson) { "#{11.to_bson}#{2.chr}#{7.to_bson}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the type is :uuid_old" do
+
+      let(:obj)  { described_class.new("testing", :uuid_old) }
+      let(:bson) { "#{7.to_bson}#{3.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the type is :uuid" do
+
+      let(:obj)  { described_class.new("testing", :uuid) }
+      let(:bson) { "#{7.to_bson}#{4.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the type is :md5" do
+
+      let(:obj)  { described_class.new("testing", :md5) }
+      let(:bson) { "#{7.to_bson}#{5.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the type is :user" do
+
+      let(:obj)  { described_class.new("testing", :user) }
+      let(:bson) { "#{7.to_bson}#{128.chr}testing" }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+  end
+end

data/spec/bson/boolean_spec.rb

@@ -0,0 +1,48 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "spec_helper"
+
+describe BSON::Boolean do
+
+  describe "::BSON_TYPE" do
+
+    it "returns 8" do
+      expect(BSON::Boolean::BSON_TYPE).to eq(8.chr)
+    end
+  end
+
+  describe "#from_bson" do
+
+    let(:type) { 8.chr }
+
+    it_behaves_like "a bson element"
+
+    context "when the boolean is true" do
+
+      let(:obj)  { true }
+      let(:bson) { 1.chr }
+
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the boolean is false" do
+
+      let(:obj)  { false }
+      let(:bson) { 0.chr }
+
+      it_behaves_like "a deserializable bson element"
+    end
+  end
+end