bson 4.1.1-java → 4.2.0-java

data/lib/bson/environment.rb

@@ -30,7 +30,19 @@ module BSON
     #
     # @since 2.0.0
     def jruby?
-      defined?(JRUBY_VERSION)
+      @jruby ||= defined?(JRUBY_VERSION)
+    end
+
+    # Determine if we are using Ruby version 1.9.
+    #
+    # @example Are we running with Ruby version 1.9?
+    #   Environment.ruby_1_9?
+    #
+    # @return [ true, false ] If the Ruby version is 1.9.
+    #
+    # @since 4.2.0
+    def ruby_1_9?
+      @ruby_1_9 ||= RUBY_VERSION < '2.0.0'
     end
   end
 end

data/lib/bson/false_class.rb

@@ -44,7 +44,7 @@ module BSON
     # @example Get the false boolean as encoded BSON.
     #   false.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/float.rb

@@ -37,7 +37,7 @@ module BSON
     # @example Get the floating point as encoded BSON.
     #   1.221311.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/hash.rb

@@ -32,7 +32,7 @@ module BSON
     # @example Get the hash as encoded BSON.
     #   { "field" => "value" }.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/int32.rb

@@ -50,6 +50,52 @@ module BSON
       buffer.get_int32
     end
 
+    # Instantiate a BSON Int32.
+    #
+    # @param [ Integer ] integer The 32-bit integer.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 4.2.0
+    def initialize(integer)
+      out_of_range! unless integer.bson_int32?
+      @integer = integer.freeze
+    end
+
+    # Append the integer as encoded BSON to a ByteBuffer.
+    #
+    # @example Encoded the integer and append to a ByteBuffer.
+    #   int32.to_bson
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded integer.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 4.2.0
+    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+      buffer.put_int32(@integer)
+    end
+
+    # Convert the integer to a BSON string key.
+    #
+    # @example Convert the integer to a BSON key string.
+    #   int.to_bson_key
+    #
+    # @param [ true, false ] validating_keys If BSON should validate the key.
+    #
+    # @return [ String ] The string key.
+    #
+    # @since 4.2.0
+    def to_bson_key(validating_keys = Config.validating_keys?)
+      @integer.to_bson_key(validating_keys)
+    end
+
+    private
+
+    def out_of_range!
+      raise RangeError.new("#{self} is not a valid 4 byte integer value.")
+    end
+
     # Register this type when the module is loaded.
     #
     # @since 2.0.0

data/lib/bson/int64.rb

@@ -45,6 +45,52 @@ module BSON
       buffer.get_int64
     end
 
+    # Instantiate a BSON Int64.
+    #
+    # @param [ Integer ] integer The 64-bit integer.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 4.2.0
+    def initialize(integer)
+      out_of_range! unless integer.bson_int64?
+      @integer = integer.freeze
+    end
+
+    # Append the integer as encoded BSON to a ByteBuffer.
+    #
+    # @example Encoded the integer and append to a ByteBuffer.
+    #   int64.to_bson
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded integer.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 4.2.0
+    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+      buffer.put_int64(@integer)
+    end
+
+    # Convert the integer to a BSON string key.
+    #
+    # @example Convert the integer to a BSON key string.
+    #   int.to_bson_key
+    #
+    # @param [ true, false ] validating_keys If BSON should validate the key.
+    #
+    # @return [ String ] The string key.
+    #
+    # @since 4.2.0
+    def to_bson_key(validating_keys = Config.validating_keys?)
+      @integer.to_bson_key(validating_keys)
+    end
+
+    private
+
+    def out_of_range!
+      raise RangeError.new("#{self} is not a valid 8 byte integer value.")
+    end
+
     # Register this type when the module is loaded.
     #
     # @since 2.0.0

data/lib/bson/integer.rb

@@ -98,7 +98,7 @@ module BSON
     # @example Get the integer as encoded BSON.
     #   1024.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/max_key.rb

@@ -41,7 +41,7 @@ module BSON
     # @example Compare with another object.
     #   max_key <=> 1000
     #
-    # @param [ Object ] The object to compare against.
+    # @param [ Object ] other The object to compare against.
     #
     # @return [ Integer ] Always 1.
     #

data/lib/bson/min_key.rb

@@ -41,7 +41,7 @@ module BSON
     # @example Compare with another object.
     #   min_key <=> 1000
     #
-    # @param [ Object ] The object to compare against.
+    # @param [ Object ] other The object to compare against.
     #
     # @return [ Integer ] Always -1.
     #

data/lib/bson/object_id.rb

@@ -102,6 +102,7 @@ module BSON
     def generation_time
       ::Time.at(generate_data.unpack("N")[0]).utc
     end
+    alias :to_time :generation_time
 
     # Get the hash value for the object id.
     #
@@ -163,7 +164,7 @@ module BSON
     #   where the object was instantiated in a non-standard way. (Like a
     #   Marshal.load)
     #
-    # @return [ String ] The raw bytes.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #
@@ -279,7 +280,7 @@ module BSON
       # @example Is the string a legal object id?
       #   BSON::ObjectId.legal?(string)
       #
-      # @param [ String ] The string to check.
+      # @param [ String ] string The string to check.
       #
       # @return [ true, false ] If the string is legal.
       #

data/lib/bson/open_struct.rb

@@ -0,0 +1,57 @@
+# Copyright (C) 2016 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 OpenStruct objects using hashes
+  # to raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 4.2.0
+  module OpenStruct
+
+    # Get the OpenStruct as encoded BSON.
+    #
+    # @example Get the OpenStruct object as encoded BSON.
+    #   OpenStruct.new({ "field" => "value" }).to_bson
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 4.2.0
+    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+      if Environment.ruby_1_9?
+        marshal_dump.dup
+      else
+        to_h
+      end.to_bson(buffer, validating_keys)
+    end
+
+    # The BSON type for OpenStruct objects is the Hash type of 0x03.
+    #
+    # @example Get the bson type.
+    #   struct.bson_type
+    #
+    # @return [ String ] The character 0x03.
+    #
+    # @since 4.2.0
+    def bson_type
+      ::Hash::BSON_TYPE
+    end
+  end
+
+  ::OpenStruct.send(:include, OpenStruct) if defined?(::OpenStruct)
+end

data/lib/bson/regexp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2015 MongoDB Inc.
+# Copyright (C) 2009-2016 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -51,6 +51,8 @@ module BSON
     # Ruby multiline constant.
     #
     # @since 3.2.6
+    #
+    # @deprecated Will be removed in 5.0
     RUBY_MULTILINE_VALUE = 'ms'.freeze
 
     # Get the regexp as JSON hash data.
@@ -79,7 +81,10 @@ module BSON
     #   's' for dotall mode ('.' matches everything),
     #   and 'u' to make \w, \W, etc. match unicode.
     #
-    # @return [ String ] The encoded string.
+    # @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.
+    # @param [ true, false ] validating_keys
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #
@@ -92,7 +97,8 @@ module BSON
     private
 
     def bson_options
-      bson_ignorecase + bson_multiline + bson_extended
+      # Ruby's Regexp always has BSON's equivalent of 'm' on, so always add it
+      bson_ignorecase + MULTILINE_VALUE + bson_dotall + bson_extended
     end
 
     def bson_extended
@@ -103,8 +109,9 @@ module BSON
       (options & ::Regexp::IGNORECASE != 0) ? IGNORECASE_VALUE : NO_VALUE
     end
 
-    def bson_multiline
-      (options & ::Regexp::MULTILINE != 0) ? RUBY_MULTILINE_VALUE : NO_VALUE
+    def bson_dotall
+      # Ruby Regexp's MULTILINE is equivalent to BSON's dotall value
+      (options & ::Regexp::MULTILINE != 0) ? NEWLINE_VALUE : NO_VALUE
     end
 
     # Represents the raw values for the regular expression.
@@ -113,6 +120,7 @@ module BSON
     #
     # @since 3.0.0
     class Raw
+      include JSON
 
       # @return [ String ] pattern The regex pattern.
       attr_reader :pattern
@@ -129,7 +137,7 @@ module BSON
       #
       # @since 3.0.0
       def compile
-        @compiled ||= ::Regexp.new(pattern, options)
+        @compiled ||= ::Regexp.new(pattern, options_to_int)
       end
 
       # Initialize the new raw regular expression.
@@ -138,7 +146,11 @@ module BSON
       #   Raw.new(pattern, options)
       #
       # @param [ String ] pattern The regular expression pattern.
-      # @param [ Integer ] options The options.
+      # @param [ String, Integer ] options The options.
+      #
+      # @note The ability to specify options as an Integer is deprecated.
+      #  Please specify options as a String. The ability to pass options as
+      #  as Integer will be removed in version 5.0.0.
       #
       # @since 3.0.0
       def initialize(pattern, options)
@@ -153,15 +165,81 @@ module BSON
       #
       # @since 3.1.0
       def respond_to?(method, include_private = false)
-        compile.respond_to?(method, include_private = false) || super
+        compile.respond_to?(method, include_private) || super
       end
 
+      # Encode the Raw Regexp object to BSON.
+      #
+      # @example Get the raw regular expression as encoded BSON.
+      #   raw_regexp.to_bson
+      #
+      # @note From the BSON spec: The first cstring is the regex pattern,
+      #   the second is the regex options string. Options are identified
+      #   by characters, which must be stored in alphabetical order.
+      #   Valid options are 'i' for case insensitive matching,
+      #   'm' for multiline matching, 'x' for verbose mode,
+      #   'l' to make \w, \W, etc. locale dependent,
+      #   's' for dotall mode ('.' matches everything),
+      #   and 'u' to make \w, \W, etc. match unicode.
+      #
+      # @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.
+      # @param [ true, false ] validating_keys
+      #
+      # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 4.2.0
+      def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+        return compile.to_bson(buffer, validating_keys) if options.is_a?(Integer)
+        buffer.put_cstring(source)
+        buffer.put_cstring(options.chars.sort.join)
+      end
+
+      # Get the raw BSON regexp as JSON hash data.
+      #
+      # @example Get the raw regexp as a JSON hash.
+      #   raw_regexp.as_json
+      #
+      # @return [ Hash ] The raw regexp as a JSON hash.
+      #
+      # @since 4.2.0
+      def as_json(*args)
+        { "$regex" => source, "$options" => options }
+      end
+
+      # Check equality of the raw bson regexp against another.
+      #
+      # @example Check if the raw bson regexp is equal to the other.
+      #   raw_regexp == other
+      #
+      # @param [ Object ] other The object to check against.
+      #
+      # @return [ true, false ] If the objects are equal.
+      #
+      # @since 4.2.0
+      def ==(other)
+        return false unless other.is_a?(::Regexp::Raw)
+        pattern == other.pattern &&
+          options == other.options
+      end
+      alias :eql? :==
+
       private
 
       def method_missing(method, *arguments)
         return super unless respond_to?(method)
         compile.send(method, *arguments)
       end
+
+      def options_to_int
+        return options if options.is_a?(Integer)
+        opts = 0
+        opts |= ::Regexp::IGNORECASE if options.include?(IGNORECASE_VALUE)
+        opts |= ::Regexp::MULTILINE if options.include?(NEWLINE_VALUE)
+        opts |= ::Regexp::EXTENDED if options.include?(EXTENDED_VALUE)
+        opts
+      end
     end
 
     module ClassMethods
@@ -177,17 +255,7 @@ module BSON
       # @since 2.0.0
       def from_bson(buffer)
         pattern = buffer.get_cstring
-        options = 0
-        while (option = buffer.get_byte) != NULL_BYTE
-          case option
-          when IGNORECASE_VALUE
-            options |= ::Regexp::IGNORECASE
-          when MULTILINE_VALUE, NEWLINE_VALUE
-            options |= ::Regexp::MULTILINE
-          when EXTENDED_VALUE
-            options |= ::Regexp::EXTENDED
-          end
-        end
+        options = buffer.get_cstring
         Raw.new(pattern, options)
       end
     end

data/lib/bson/registry.rb

@@ -53,7 +53,7 @@ module BSON
     #   BSON::Registry.register("\x01", Float)
     #
     # @param [ String ] byte The single byte.
-    # @param [ Class ] The class the byte maps to.
+    # @param [ Class ] type The class the byte maps to.
     #
     # @return [ Class ] The class.
     #