bson 2.0.0.beta → 2.0.0.rc

data/spec/bson/registry_spec.rb

@@ -0,0 +1,55 @@
+# Copyright (C) 2013 10gen 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::Registry do
+
+  describe ".get" do
+
+    context "when the type has a correspoding class" do
+
+      before do
+        described_class.register(BSON::MinKey::BSON_TYPE, BSON::MinKey)
+      end
+
+      let(:klass) do
+        described_class.get(BSON::MinKey::BSON_TYPE)
+      end
+
+      it "returns the class" do
+        expect(klass).to eq(BSON::MinKey)
+      end
+    end
+
+    context "when the type has no corresponding class" do
+
+      unless BSON::Environment.ruby_18?
+
+        it "raises an error" do
+          expect {
+            described_class.get("test")
+          }.to raise_error(KeyError)
+        end
+      else
+
+        it "raises an error" do
+          expect {
+            described_class.get("test")
+          }.to raise_error(IndexError)
+        end
+      end
+    end
+  end
+end

data/spec/bson/string_spec.rb

@@ -0,0 +1,271 @@
+# encoding: utf-8
+
+# Copyright (C) 2013 10gen 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 String do
+
+  describe "#to_bson/#from_bson" do
+
+    let(:type) { 2.chr }
+    let(:obj) { "test" }
+    let(:bson) { "#{5.to_bson}test#{BSON::NULL_BYTE}" }
+
+    it_behaves_like "a bson element"
+    it_behaves_like "a serializable bson element"
+    it_behaves_like "a deserializable bson element"
+  end
+
+  describe "#to_bson_cstring" do
+
+    context "when the string is valid" do
+
+      let(:string) do
+        "test"
+      end
+
+      let(:encoded) do
+        string.to_bson_cstring
+      end
+
+      let(:previous_content) do
+        'previous_content'.force_encoding(BSON::BINARY)
+      end
+
+      it "returns the encoded string" do
+        expect(encoded).to eq("test#{BSON::NULL_BYTE}")
+      end
+
+      it_behaves_like "a binary encoded string"
+
+      it "appends to optional previous content" do
+        expect(string.to_bson_cstring(previous_content)).to eq(previous_content << encoded)
+      end
+    end
+
+    context "when the string contains a null byte" do
+
+      let(:string) do
+        "test#{BSON::NULL_BYTE}ing"
+      end
+
+      it "raises an error" do
+        expect {
+          string.to_bson_cstring
+        }.to raise_error(RuntimeError)
+      end
+    end
+
+    context "when the string contains utf-8 characters" do
+
+      let(:string) do
+        "Straße"
+      end
+
+      let(:encoded) do
+        string.to_bson_cstring
+      end
+
+      let(:char) do
+        "ß".chr.force_encoding(BSON::BINARY)
+      end
+
+      it "returns the encoded string" do
+        expect(encoded).to eq("Stra#{char}e#{BSON::NULL_BYTE}")
+      end
+
+      it_behaves_like "a binary encoded string"
+    end
+
+    context "when the string is encoded in non utf-8" do
+
+      let(:string) do
+        "Straße".encode("iso-8859-1")
+      end
+
+      let(:encoded) do
+        string.to_bson_cstring
+      end
+
+      let(:char) do
+        "ß".chr.force_encoding(BSON::BINARY)
+      end
+
+      it "returns the encoded string" do
+        expect(encoded).to eq("Stra#{char}e#{BSON::NULL_BYTE}")
+      end
+
+      it_behaves_like "a binary encoded string"
+    end
+
+    unless BSON::Environment.ruby_18?
+
+      context "when the string contains non utf-8 characters" do
+
+        let(:string) do
+          255.chr
+        end
+
+        it "raises an error" do
+          expect {
+            string.to_bson_cstring
+          }.to raise_error(EncodingError)
+        end
+      end
+    end
+  end
+
+  describe "#to_bson_string" do
+
+    context "when the string is valid" do
+
+      let(:string) do
+        "test"
+      end
+
+      let(:encoded) do
+        string.to_bson_string
+      end
+
+      let(:previous_content) do
+        'previous_content'.force_encoding(BSON::BINARY)
+      end
+
+      it "returns the string" do
+        expect(encoded).to eq(string)
+      end
+
+      it_behaves_like "a binary encoded string"
+
+      it "appends to optional previous content" do
+        expect(string.to_bson_string(previous_content)).to eq(previous_content << encoded)
+      end
+
+    end
+
+    context "when the string contains a null byte" do
+
+      let(:string) do
+        "test#{BSON::NULL_BYTE}ing"
+      end
+
+      let(:encoded) do
+        string.to_bson_string
+      end
+
+      it "retains the null byte" do
+        expect(encoded).to eq(string)
+      end
+
+      it_behaves_like "a binary encoded string"
+    end
+
+    context "when the string contains utf-8 characters" do
+
+      let(:string) do
+        "Straße"
+      end
+
+      let(:encoded) do
+        string.to_bson_string
+      end
+
+      let(:char) do
+        "ß".chr.force_encoding(BSON::BINARY)
+      end
+
+      it "returns the encoded string" do
+        expect(encoded).to eq("Stra#{char}e")
+      end
+
+      it_behaves_like "a binary encoded string"
+    end
+
+    context "when the string is encoded in non utf-8" do
+
+      let(:string) do
+        "Straße".encode("iso-8859-1")
+      end
+
+      let(:encoded) do
+        string.to_bson_string
+      end
+
+      let(:char) do
+        "ß".chr.force_encoding(BSON::BINARY)
+      end
+
+      it "returns the encoded string" do
+        expect(encoded).to eq("Stra#{char}e")
+      end
+
+      it_behaves_like "a binary encoded string"
+    end
+
+    unless BSON::Environment.ruby_18?
+
+      context "when the string contains non utf-8 characters" do
+
+        let(:string) do
+          255.chr
+        end
+
+        it "raises an error" do
+          expect {
+            string.to_bson_string
+          }.to raise_error(EncodingError)
+        end
+      end
+    end
+  end
+
+  context "when the class is loaded" do
+
+    let(:registered) do
+      BSON::Registry.get(String::BSON_TYPE)
+    end
+
+    it "registers the type" do
+      expect(registered).to eq(String)
+    end
+  end
+
+  describe "#to_bson_key" do
+
+    let(:string) { "test" }
+    let(:encoded) { string.to_s + BSON::NULL_BYTE }
+    let(:previous_content) { 'previous_content'.force_encoding(BSON::BINARY) }
+
+    it "returns the encoded string" do
+      expect(string.to_bson_key).to eq(encoded)
+    end
+
+    it "appends to optional previous content" do
+      expect(string.to_bson_key(previous_content)).to eq(previous_content << encoded)
+    end
+  end
+
+  describe "#to_hex_string" do
+
+    let(:string) do
+      "testing123"
+    end
+
+    it "converts the string to hex" do
+      expect(string.to_hex_string).to eq("74657374696e67313233")
+    end
+  end
+end

data/spec/bson/symbol_spec.rb

@@ -0,0 +1,45 @@
+# Copyright (C) 2013 10gen 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 Symbol do
+
+  describe "#to_bson/#from_bson" do
+
+    let(:type) { 14.chr }
+    let(:obj)  { :test }
+    let(:bson) { "#{5.to_bson}test#{BSON::NULL_BYTE}" }
+
+    it_behaves_like "a bson element"
+    it_behaves_like "a serializable bson element"
+    it_behaves_like "a deserializable bson element"
+
+  end
+
+  describe "#to_bson_key" do
+
+    let(:symbol) { :test }
+    let(:encoded) { symbol.to_s + BSON::NULL_BYTE }
+    let(:previous_content) { 'previous_content'.force_encoding(BSON::BINARY) }
+
+    it "returns the encoded string" do
+      expect(symbol.to_bson_key).to eq(encoded)
+    end
+
+    it "appends to optional previous content" do
+      expect(symbol.to_bson_key(previous_content)).to eq(previous_content << encoded)
+    end
+  end
+end

data/spec/bson/time_spec.rb

@@ -0,0 +1,43 @@
+# Copyright (C) 2013 10gen 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 Time do
+
+  describe "#to_bson/#from_bson" do
+
+    let(:type) { 9.chr }
+
+    it_behaves_like "a bson element"
+
+    context "when the time is post epoch" do
+
+      let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0) }
+      let(:bson) { [ (obj.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+
+    context "when the time is pre epoch" do
+
+      let(:obj)  { Time.utc(1969, 1, 1, 0, 0, 0) }
+      let(:bson) { [ (obj.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+      it_behaves_like "a deserializable bson element"
+    end
+  end
+end

data/spec/bson/timestamp_spec.rb

@@ -0,0 +1,74 @@
+# Copyright (C) 2013 10gen 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::Timestamp do
+
+  describe "#==" do
+
+    let(:timestamp) do
+      described_class.new(1, 10)
+    end
+
+    context "when the objects are equal" do
+
+      let(:other) { described_class.new(1, 10) }
+
+      it "returns true" do
+        expect(timestamp).to eq(other)
+      end
+    end
+
+    context "when the objects are not equal" do
+
+      let(:other) { described_class.new(1, 15) }
+
+      it "returns false" do
+        expect(timestamp).to_not eq(other)
+      end
+    end
+
+    context "when the other object is not a timestamp" do
+
+      it "returns false" do
+        expect(timestamp).to_not eq("test")
+      end
+    end
+  end
+
+  describe "#as_json" do
+
+    let(:object) do
+      described_class.new(10, 50)
+    end
+
+    it "returns the binary data plus type" do
+      expect(object.as_json).to eq({ "t" => 10, "i" => 50 })
+    end
+
+    it_behaves_like "a JSON serializable object"
+  end
+
+  describe "#to_bson/#from_bson" do
+
+    let(:type) { 17.chr }
+    let(:obj)  { described_class.new(1, 10) }
+    let(:bson) { [ 10, 1 ].pack("l2") }
+
+    it_behaves_like "a bson element"
+    it_behaves_like "a serializable bson element"
+    it_behaves_like "a deserializable bson element"
+  end
+end