bson 1.12.5-java → 2.0.0-java

data/lib/bson/encodable.rb

@@ -0,0 +1,86 @@
+# 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
+
+  # Defines behaviour around objects that can be encoded.
+  #
+  # @since 2.0.0
+  module Encodable
+
+    # A 4 byte placeholder that would be replaced by a length at a later point.
+    #
+    # @since 2.0.0
+    PLACEHOLDER = 0.to_bson.freeze
+
+    # Adjustment value for total number of document bytes.
+    #
+    # @since 2.0.0
+    BSON_ADJUST = 0.freeze
+
+    # Adjustment value for total number of string bytes.
+    #
+    # @since 2.0.0
+    STRING_ADJUST = -4.freeze
+
+    # Encodes BSON to raw bytes, for types that require the length of the
+    # entire bytes to be present as the first word of the encoded string. This
+    # includes Hash, CodeWithScope.
+    #
+    # @example Encode the BSON with placeholder bytes.
+    #   hash.encode_with_placeholder_and_null(BSON_ADJUST, encoded) do |encoded|
+    #     each do |field, value|
+    #       value.to_bson(encoded)
+    #     end
+    #   end
+    #
+    # @param [ Integer ] adjust The number of bytes to adjust with.
+    # @param [ String ] encoded The string to encode.
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @since 2.0.0
+    def encode_with_placeholder_and_null(adjust, encoded = ''.force_encoding(BINARY))
+      pos = encoded.bytesize
+      encoded << PLACEHOLDER
+      yield(encoded)
+      encoded << NULL_BYTE
+      encoded.set_int32(pos, encoded.bytesize - pos + adjust)
+      encoded
+    end
+
+    # Encodes binary data with a generic placeholder value to be written later
+    # once all bytes have been written.
+    #
+    # @example Encode the BSON with placeholder bytes.
+    #   string.encode_binary_data_with_placeholder(encoded) do |encoded|
+    #     each do |field, value|
+    #       value.to_bson(encoded)
+    #     end
+    #   end
+    #
+    # @param [ String ] encoded The string to encode.
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @since 2.0.0
+    def encode_binary_data_with_placeholder(encoded = ''.force_encoding(BINARY))
+      pos = encoded.bytesize
+      encoded << PLACEHOLDER
+      yield(encoded)
+      encoded.set_int32(pos, encoded.bytesize - pos - 5)
+      encoded
+    end
+  end
+end

data/lib/bson/environment.rb

@@ -0,0 +1,98 @@
+# 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
+
+  # Provides static helper methods around determining what environment is
+  # running without polluting the global namespace.
+  #
+  # @since 2.0.0
+  module Environment
+    extend self
+
+    # Determine if we are using JRuby or not.
+    #
+    # @example Are we running with JRuby?
+    #   Environment.jruby?
+    #
+    # @return [ true, false ] If JRuby is our vm.
+    #
+    # @since 2.0.0
+    def jruby?
+      defined?(JRUBY_VERSION)
+    end
+
+    # Does the Ruby runtime we are using support ordered hashes?
+    #
+    # @example Does the runtime support ordered hashes?
+    #   Environment.retaining_hash_order?
+    #
+    # @return [ true, false ] If the runtime has ordered hashes.
+    #
+    # @since 2.0.0
+    def retaining_hash_order?
+      jruby? || RUBY_VERSION > "1.9.1"
+    end
+
+    # Are we running in a ruby runtime that is version 1.8.x?
+    #
+    # @example Is the ruby runtime in 1.8 mode?
+    #   Environment.ruby_18?
+    #
+    # @return [ true, false ] If we are running in 1.8.
+    #
+    # @since 2.0.0
+    def ruby_18?
+      RUBY_VERSION < "1.9"
+    end
+  end
+end
+
+# In the case where we don't have encoding, we need to monkey
+# patch string to ignore the encoding directives.
+#
+# @since 2.0.0
+if BSON::Environment.ruby_18?
+
+  # Making string in 1.8 respond like a 1.9 string, without any modifications.
+  #
+  # @since 2.0.0
+  class String
+
+    # Simply return the string when asking for it's character.
+    #
+    # @since 2.0.0
+    def chr; self; end
+
+    # Force the string to the provided encoding. NOOP.
+    #
+    # @since 2.0.0
+    def force_encoding(*); self; end
+
+    # Encode the string as the provided type. NOOP.
+    #
+    # @since 2.0.0
+    def encode(*); self; end
+
+    # Encode the string in place. NOOP.
+    #
+    # @since 2.0.0
+    def encode!(*); self; end
+  end
+
+  # No encoding error is defined in 1.8.
+  #
+  # @since 2.0.0
+  class EncodingError < RuntimeError; end
+end

data/lib/bson/false_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 false values to and from
+  # raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  module FalseClass
+
+    # A false value in the BSON spec is 0x00.
+    #
+    # @since 2.0.0
+    FALSE_BYTE = 0.chr.force_encoding(BINARY).freeze
+
+    # The BSON type for false 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 false boolean as encoded BSON.
+    #
+    # @example Get the false boolean as encoded BSON.
+    #   false.to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded << FALSE_BYTE
+    end
+  end
+
+  # Enrich the core FalseClass class with this module.
+  #
+  # @since 2.0.0
+  ::FalseClass.send(:include, FalseClass)
+end

data/lib/bson/float.rb

@@ -0,0 +1,82 @@
+# 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 floating point values
+  # to and from # raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  module Float
+
+    # A floating point is type 0x01 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 1.chr.force_encoding(BINARY).freeze
+
+    # The pack directive is for 8 byte floating points.
+    #
+    # @since 2.0.0
+    PACK = "E".freeze
+
+    # Get the floating point as encoded BSON.
+    #
+    # @example Get the floating point as encoded BSON.
+    #   1.221311.to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded << [ self ].pack(PACK)
+    end
+
+    module ClassMethods
+
+      # Deserialize an instance of a Float from a BSON double.
+      #
+      # @param [ BSON ] bson The encoded double.
+      #
+      # @return [ Float ] The decoded Float.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 2.0.0
+      def from_bson(bson)
+        from_bson_double(bson.read(8))
+      end
+
+      private
+
+      def from_bson_double(double)
+        double.unpack(PACK).first
+      end
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, ::Float)
+  end
+
+  # Enrich the core Float class with this module.
+  #
+  # @since 2.0.0
+  ::Float.send(:include, Float)
+  ::Float.send(:extend, Float::ClassMethods)
+end

data/lib/bson/hash.rb

@@ -0,0 +1,84 @@
+# 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 hashes to
+  # and from raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  module Hash
+    include Encodable
+
+    # An hash (embedded document) is type 0x03 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 3.chr.force_encoding(BINARY).freeze
+
+    # Get the hash as encoded BSON.
+    #
+    # @example Get the hash as encoded BSON.
+    #   { "field" => "value" }.to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encode_with_placeholder_and_null(BSON_ADJUST, encoded) do |encoded|
+        each do |field, value|
+          encoded << value.bson_type
+          field.to_bson_key(encoded)
+          value.to_bson(encoded)
+        end
+      end
+    end
+
+    module ClassMethods
+
+      # Deserialize the hash from BSON.
+      #
+      # @param [ IO ] bson The bson representing a hash.
+      #
+      # @return [ Array ] The decoded hash.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 2.0.0
+      def from_bson(bson)
+        hash = new
+        bson.read(4) # Swallow the first four bytes.
+        while (type = bson.readbyte.chr) != NULL_BYTE
+          field = bson.gets(NULL_BYTE).from_bson_string.chop!
+          hash[field] = BSON::Registry.get(type).from_bson(bson)
+        end
+        hash
+      end
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, ::Hash)
+  end
+
+  # Enrich the core Hash class with this module.
+  #
+  # @since 2.0.0
+  ::Hash.send(:include, Hash)
+  ::Hash.send(:extend, Hash::ClassMethods)
+end

data/lib/bson/int32.rb

@@ -0,0 +1,59 @@
+# 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 $maxKey type, which compares less than any other value in the
+  # specification.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  class Int32
+
+    # A boolean is type 0x08 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 16.chr.force_encoding(BINARY).freeze
+
+    # Constant for the int 32 pack directive.
+    #
+    # @since 2.0.0
+    PACK = Environment.ruby_18? ? "l".freeze : "l<".freeze
+
+    # Deserialize an Integer from BSON.
+    #
+    # @param [ BSON ] bson The encoded int32.
+    #
+    # @return [ Integer ] The decoded Integer.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def self.from_bson(bson)
+      from_bson_int32(bson.read(4))
+    end
+
+    private
+
+    def self.from_bson_int32(bytes)
+      bytes.unpack(PACK).first
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, self)
+  end
+end