bson 4.1.1-java → 4.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 937c39adeba926daec9cda4e1a3f33ed95d409df
-  data.tar.gz: 16b8d33f71e2a25762fb10489115dad09ac16b02
+  metadata.gz: 2727f24e105392aa4228203a0a7cc793f3ce2a0a
+  data.tar.gz: 56c958876a31969a663c72084ab0873c0e83eb6a
 SHA512:
-  metadata.gz: 6b4734870f5a0111a4129295f8e851cd65578d0b2b54aae09e15965a8b0408ec6e61f583c7b47798b10c2f3997c11b8db48fa8861a53f4db8499cbb121d047f2
-  data.tar.gz: 9f6f660b38963ce96184acaa73f6ac4906fb8b9df2318aa093004e56ed48132801c8c650996c232299ae16e78442a8a4ea6c890170bf429f317eb977e4eb6027
+  metadata.gz: b7596f9b4b167a80f286b4d90350a117e044dc265ec463d9d9cedf0624eaffd3a2eba5dddfa66727f20bd0f9251ff064cd26fd69e07a542a4a61c5c6a4a05691
+  data.tar.gz: b3b6527d51fd6f14eff888aecf7aed9e7e46202f293448eea3a22c0823901c7922b7c85e099a6038306b0c8bf6d723745c767b2dca5d7467eb0ed61f5ed74845

data/Rakefile

@@ -35,7 +35,7 @@ if jruby?
 else
   require "rake/extensiontask"
   Rake::ExtensionTask.new do |ext|
-    ext.name = "native"
+    ext.name = "bson_native"
     ext.ext_dir = "ext/bson"
     ext.lib_dir = "lib"
   end
@@ -64,8 +64,8 @@ end
 task :clean_all => :clean do
   begin
     Dir.chdir(Pathname(__FILE__).dirname + "lib") do
-      `rm native.#{extension}`
-      `rm native.o`
+      `rm bson_native.#{extension}`
+      `rm bson_native.o`
       `rm bson-ruby.jar`
     end
   rescue Exception => e
@@ -108,6 +108,21 @@ namespace :benchmark do
     require "bson"
     benchmark!
   end
+
+  namespace :decimal128 do
+
+    task :from_string do
+      puts "Benchmarking creating Decimal128 objects from a string"
+      require 'bson'
+      benchmark_decimal128_from_string!
+    end
+
+    task :to_string do
+      puts "Benchmarking getting a string representation of a Decimal128"
+      require 'bson'
+      benchmark_decimal128_to_string!
+    end
+  end
 end
 
 task :default => [ :clean_all, :spec ]

data/lib/bson.rb

@@ -70,10 +70,12 @@ require "bson/code"
 require "bson/code_with_scope"
 require "bson/date"
 require "bson/date_time"
+require "bson/decimal128"
 require "bson/document"
 require "bson/false_class"
 require "bson/float"
 require "bson/hash"
+require "bson/open_struct"
 require "bson/max_key"
 require "bson/min_key"
 require "bson/nil_class"
@@ -89,8 +91,7 @@ require "bson/undefined"
 require "bson/version"
 
 # If we are using JRuby, attempt to load the Java extensions, if we are using
-# MRI or Rubinius, attempt to load the C extenstions. If either of these fail,
-# we revert back to a pure Ruby implementation of the Buffer class.
+# MRI or Rubinius, attempt to load the C extensions.
 #
 # @since 2.0.0
 begin
@@ -98,8 +99,9 @@ begin
     require "bson-ruby.jar"
     org.bson.NativeService.new.basicLoad(JRuby.runtime)
   else
-    require "native"
+    require "bson_native"
   end
 rescue LoadError
-  $stderr.puts("BSON is using the pure Ruby implementation.")
+  $stderr.puts("Failed to load the necessary extensions.")
+  raise
 end

data/lib/bson/array.rb

@@ -35,7 +35,7 @@ module BSON
     # @note Arrays are encoded as documents, where the index of the value in
     #   the array is the actual key.
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/binary.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'base64'
+
 module BSON
 
   # Represents binary data.
@@ -89,7 +91,7 @@ module BSON
     #
     # @since 2.0.0
     def as_json(*args)
-      { "$binary" => data, "$type" => type }
+      { "$binary" => Base64.encode64(data), "$type" => type }
     end
 
     # Instantiate the new binary object.
@@ -124,7 +126,7 @@ module BSON
     # @example Encode the binary.
     #   binary.to_bson
     #
-    # @return [ String ] The encoded binary.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/code.rb

@@ -76,7 +76,7 @@ module BSON
     # @example Encode the code.
     #   code.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/code_with_scope.rb

@@ -82,7 +82,7 @@ module BSON
     # @example Encode the code with scope.
     #   code_with_scope.to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/config.rb

@@ -45,7 +45,7 @@ module BSON
     #
     # @since 4.1.0
     def validating_keys?
-      !!@validating_keys
+      !!(@validating_keys||=nil)
     end
   end
 end

data/lib/bson/date.rb

@@ -29,7 +29,7 @@ module BSON
     # @example Get the date as encoded BSON.
     #   Date.new(2012, 1, 1).to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/date_time.rb

@@ -29,7 +29,7 @@ module BSON
     # @example Get the date time as encoded BSON.
     #   DateTime.new(2012, 1, 1, 0, 0, 0).to_bson
     #
-    # @return [ String ] The encoded string.
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
     #

data/lib/bson/decimal128.rb

@@ -0,0 +1,318 @@
+# 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.
+
+require 'bigdecimal'
+require 'bson/decimal128/builder'
+
+module BSON
+
+  class Decimal128
+
+    # A Decimal128 is type 0x13 in the BSON spec.
+    #
+    # @since 4.2.0
+    BSON_TYPE = 19.chr.force_encoding(BINARY).freeze
+
+    # Exponent offset.
+    #
+    # @since 4.2.0
+    EXPONENT_OFFSET = 6176.freeze
+
+    # Minimum exponent.
+    #
+    # @since 4.2.0
+    MIN_EXPONENT = -6176.freeze
+
+    # Maximum exponent.
+    #
+    # @since 4.2.0
+    MAX_EXPONENT = 6111.freeze
+
+    # Maximum digits of precision.
+    #
+    # @since 4.2.0
+    MAX_DIGITS_OF_PRECISION = 34.freeze
+
+    # Key for this type when converted to extended json.
+    #
+    # @since 4.2.0
+    EXTENDED_JSON_KEY = "$numberDecimal".freeze
+
+    # The native type to which this object can be converted.
+    #
+    # @since 4.2.0
+    NATIVE_TYPE = BigDecimal
+
+    # Get the Decimal128 as JSON hash data.
+    #
+    # @example Get the Decimal128 as a JSON hash.
+    #   decimal.as_json
+    #
+    # @return [ Hash ] The number as a JSON hash.
+    #
+    # @since 4.2.0
+    def as_json(*args)
+      { EXTENDED_JSON_KEY => to_s }
+    end
+
+    # Check equality of the decimal128 object with another object.
+    #
+    # @example Check if the decimal128 object is equal to the other.
+    #   decimal == 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?(Decimal128)
+      @high == other.instance_variable_get(:@high) &&
+          @low == other.instance_variable_get(:@low)
+    end
+    alias :eql? :==
+
+    # Create a new Decimal128 from a BigDecimal.
+    #
+    # @example Create a Decimal128 from a BigDecimal.
+    #   Decimal128.new(big_decimal)
+    #
+    # @param [ String, BigDecimal ] object The BigDecimal or String to use for
+    #   instantiating a Decimal128.
+    #
+    # @raise [ InvalidBigDecimal ] Raise error unless object argument is a BigDecimal.
+    #
+    # @since 4.2.0
+    def initialize(object)
+      if object.is_a?(String)
+        set_bits(*Builder::FromString.new(object).bits)
+      elsif object.is_a?(BigDecimal)
+        set_bits(*Builder::FromBigDecimal.new(object).bits)
+      else
+        raise InvalidArgument.new
+      end
+    end
+
+    # Get the decimal128 as its raw BSON data.
+    #
+    # @example Get the raw bson bytes in a buffer.
+    #   decimal.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?)
+      buffer.put_decimal128(@low, @high)
+    end
+
+    # Get the hash value for the decimal128.
+    #
+    # @example Get the hash value.
+    #   decimal.hash
+    #
+    # @return [ Integer ] The hash value.
+    #
+    # @since 4.2.0
+    def hash
+      num = @high << 64
+      num |= @low
+      num.hash
+    end
+
+    # Get a nice string for use with object inspection.
+    #
+    # @example Inspect the decimal128 object.
+    #   decimal128.inspect
+    #
+    # @return [ String ] The decimal as a string.
+    #
+    # @since 4.2.0
+    def inspect
+      "BSON::Decimal128('#{to_s}')"
+    end
+
+    # Get the string representation of the decimal128.
+    #
+    # @example Get the decimal128 as a string.
+    #   decimal128.to_s
+    #
+    # @return [ String ] The decimal128 as a string.
+    #
+    # @since 4.2.0
+    def to_s
+      @string ||= Builder::ToString.new(self).string
+    end
+    alias :to_str :to_s
+
+    # Get a Ruby BigDecimal object corresponding to this Decimal128.
+    # Note that, when converting to a Ruby BigDecimal, non-zero significant digits
+    # are preserved but trailing zeroes may be lost.
+    # See the following example:
+    #
+    # @example
+    #  decimal128 = BSON::Decimal128.new("0.200")
+    #    => BSON::Decimal128('0.200')
+    #  big_decimal = decimal128.to_big_decimal
+    #    => #<BigDecimal:7fc619c95388,'0.2E0',9(18)>
+    #  big_decimal.to_s
+    #    => "0.2E0"
+    #
+    # Note that the the BSON::Decimal128 object can represent -NaN, sNaN,
+    # and -sNaN while Ruby's BigDecimal cannot.
+    #
+    # @return [ BigDecimal ] The decimal as a BigDecimal.
+    #
+    # @since 4.2.0
+    def to_big_decimal
+      @big_decimal ||= BigDecimal.new(to_s)
+    end
+
+    private
+
+    def set_bits(low, high)
+      @low = low
+      @high = high
+    end
+
+    class << self
+
+      # Deserialize the decimal128 from raw BSON bytes.
+      #
+      # @example Get the decimal128 from BSON.
+      #   Decimal128.from_bson(bson)
+      #
+      # @param [ ByteBuffer ] buffer The byte buffer.
+      #
+      # @return [ BSON::Decimal128 ] The decimal object.
+      #
+      # @since 4.2.0
+      def from_bson(buffer)
+        from_bits(*buffer.get_decimal128_bytes.unpack('Q*'))
+      end
+
+      # Instantiate a Decimal128 from a string.
+      #
+      # @example Create a Decimal128 from a string.
+      #   BSON::Decimal128.from_string("1.05E+3")
+      #
+      # @param [ String ] string The string to parse.
+      #
+      # @raise [ BSON::Decimal128::InvalidString ] If the provided string is invalid.
+      #
+      # @return [ BSON::Decimal128 ] The new decimal128.
+      #
+      # @since 4.2.0
+      def from_string(string)
+        from_bits(*Builder::FromString.new(string).bits)
+      end
+
+      # Instantiate a Decimal128 from high and low bits.
+      #
+      # @example Create a Decimal128 from high and low bits.
+      #   BSON::Decimal128.from_bits(high, low)
+      #
+      # @param [ Integer ] high The high order bits.
+      # @param [ Integer ] low The low order bits.
+      #
+      # @return [ BSON::Decimal128 ] The new decimal128.
+      #
+      # @since 4.2.0
+      def from_bits(low, high)
+        decimal = allocate
+        decimal.send(:set_bits, low, high)
+        decimal
+      end
+    end
+
+    # Raised when trying to create a Decimal128 from an object that is neither a String nor a BigDecimal.
+    #
+    # @api private
+    #
+    # @since 4.2.0
+    class InvalidArgument < ArgumentError
+
+      # The custom error message for this error.
+      #
+      # @since 4.2.0
+      MESSAGE = 'A Decimal128 can only be created from a String or BigDecimal.'.freeze
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      #
+      # @since 4.2.0
+      def message
+        MESSAGE
+      end
+    end
+
+    # Raised when trying to create a Decimal128 from a string with
+    #   an invalid format.
+    #
+    # @api private
+    #
+    # @since 4.2.0
+    class InvalidString < RuntimeError
+
+      # The custom error message for this error.
+      #
+      # @since 4.2.0
+      MESSAGE = 'Invalid string format for creating a Decimal128 object.'.freeze
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      #
+      # @since 4.2.0
+      def message
+        MESSAGE
+      end
+    end
+
+    # Raised when the exponent or significand provided is outside the valid range.
+    #
+    # @api private
+    #
+    # @since 4.2.0
+    class InvalidRange < RuntimeError
+
+      # The custom error message for this error.
+      #
+      # @since 4.2.0
+      MESSAGE = 'Value out of range for Decimal128 representation.'.freeze
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      #
+      # @since 4.2.0
+      def message
+        MESSAGE
+      end
+    end
+
+    Registry.register(BSON_TYPE, self)
+  end
+end