bson 4.1.1 → 4.2.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31e82028a4dbdd0ee59ad09a19bc8d1dac7c3fcd
-  data.tar.gz: 9773de56e955e3b0545804de618692bcd9bd74b7
+  metadata.gz: 6d09affc4bd194e0800ec1b21bc130b760ce0a34
+  data.tar.gz: d084710b111c72364781cfebb6492b51abd22f91
 SHA512:
-  metadata.gz: 8fb4637938de67b08963c79e02aef0e32050e27229c17cd09bb1d0c69072f528f861fdd0759b46ec9ed70353ebcc6f55e32530b30e8cba5f76445338ab8f0903
-  data.tar.gz: cdac6674f943e86cfe45e5742a9a361a3cc83ba5222ca82c5bf4b5ac50c7a43f8e70aa2804c63d233c6c2c2461627f116c63aee9c6c37e7a26ce9c67dcccf282
+  metadata.gz: 6db9a4decef8b08a8d16dcbbd16c299027209ae4e25c43edc67e8a629da779df2df144f875775ed9ffd7974d081d744d61926168207e3275fdb2dde25922f65e
+  data.tar.gz: 425e006755d2ea79ec961717e736f6cdac44b230364874815bafd056deef5dcbe4e7adc13e8fc2861ce95ae299292cb4fbff577612b3130018c7e8cbb83ba58f

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/ext/bson/{native.c → bson_native.c}

@@ -1,5 +1,5 @@
 /*
- * 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.
@@ -56,6 +56,7 @@ static VALUE rb_bson_byte_buffer_length(VALUE self);
 static VALUE rb_bson_byte_buffer_get_byte(VALUE self);
 static VALUE rb_bson_byte_buffer_get_bytes(VALUE self, VALUE i);
 static VALUE rb_bson_byte_buffer_get_cstring(VALUE self);
+static VALUE rb_bson_byte_buffer_get_decimal128_bytes(VALUE self);
 static VALUE rb_bson_byte_buffer_get_double(VALUE self);
 static VALUE rb_bson_byte_buffer_get_int32(VALUE self);
 static VALUE rb_bson_byte_buffer_get_int64(VALUE self);
@@ -63,6 +64,7 @@ static VALUE rb_bson_byte_buffer_get_string(VALUE self);
 static VALUE rb_bson_byte_buffer_put_byte(VALUE self, VALUE byte);
 static VALUE rb_bson_byte_buffer_put_bytes(VALUE self, VALUE bytes);
 static VALUE rb_bson_byte_buffer_put_cstring(VALUE self, VALUE string);
+static VALUE rb_bson_byte_buffer_put_decimal128(VALUE self, VALUE low, VALUE high);
 static VALUE rb_bson_byte_buffer_put_double(VALUE self, VALUE f);
 static VALUE rb_bson_byte_buffer_put_int32(VALUE self, VALUE i);
 static VALUE rb_bson_byte_buffer_put_int64(VALUE self, VALUE i);
@@ -96,9 +98,9 @@ static char rb_bson_machine_id_hash[HOST_NAME_HASH_MAX];
 static uint32_t rb_bson_object_id_counter;
 
 /**
- * Initialize the native extension.
+ * Initialize the bson_native extension.
  */
-void Init_native()
+void Init_bson_native()
 {
   char rb_bson_machine_id[256];
 
@@ -115,6 +117,7 @@ void Init_native()
   rb_define_method(rb_byte_buffer_class, "get_byte", rb_bson_byte_buffer_get_byte, 0);
   rb_define_method(rb_byte_buffer_class, "get_bytes", rb_bson_byte_buffer_get_bytes, 1);
   rb_define_method(rb_byte_buffer_class, "get_cstring", rb_bson_byte_buffer_get_cstring, 0);
+  rb_define_method(rb_byte_buffer_class, "get_decimal128_bytes", rb_bson_byte_buffer_get_decimal128_bytes, 0);
   rb_define_method(rb_byte_buffer_class, "get_double", rb_bson_byte_buffer_get_double, 0);
   rb_define_method(rb_byte_buffer_class, "get_int32", rb_bson_byte_buffer_get_int32, 0);
   rb_define_method(rb_byte_buffer_class, "get_int64", rb_bson_byte_buffer_get_int64, 0);
@@ -122,6 +125,7 @@ void Init_native()
   rb_define_method(rb_byte_buffer_class, "put_byte", rb_bson_byte_buffer_put_byte, 1);
   rb_define_method(rb_byte_buffer_class, "put_bytes", rb_bson_byte_buffer_put_bytes, 1);
   rb_define_method(rb_byte_buffer_class, "put_cstring", rb_bson_byte_buffer_put_cstring, 1);
+  rb_define_method(rb_byte_buffer_class, "put_decimal128", rb_bson_byte_buffer_put_decimal128, 2);
   rb_define_method(rb_byte_buffer_class, "put_double", rb_bson_byte_buffer_put_double, 1);
   rb_define_method(rb_byte_buffer_class, "put_int32", rb_bson_byte_buffer_put_int32, 1);
   rb_define_method(rb_byte_buffer_class, "put_int64", rb_bson_byte_buffer_put_int64, 1);
@@ -234,6 +238,21 @@ VALUE rb_bson_byte_buffer_get_cstring(VALUE self)
   return string;
 }
 
+/**
+ * Get the 16 bytes representing the decimal128 from the buffer.
+ */
+VALUE rb_bson_byte_buffer_get_decimal128_bytes(VALUE self)
+{
+  byte_buffer_t *b;
+  VALUE bytes;
+
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  ENSURE_BSON_READ(b, 16);
+  bytes = rb_str_new(READ_PTR(b), 16);
+  b->read_position += 16;
+  return bytes;
+}
+
 /**
  * Get a double from the buffer.
  */
@@ -352,6 +371,27 @@ VALUE rb_bson_byte_buffer_put_cstring(VALUE self, VALUE string)
   return self;
 }
 
+/**
+ * Writes a 128 bit decimal to the byte buffer.
+ */
+VALUE rb_bson_byte_buffer_put_decimal128(VALUE self, VALUE low, VALUE high)
+{
+  byte_buffer_t *b;
+  const int64_t low64 = BSON_UINT64_TO_LE(NUM2ULL(low));
+  const int64_t high64 = BSON_UINT64_TO_LE(NUM2ULL(high));
+
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  ENSURE_BSON_WRITE(b, 8);
+  memcpy(WRITE_PTR(b), &low64, 8);
+  b->write_position += 8;
+
+  ENSURE_BSON_WRITE(b, 8);
+  memcpy(WRITE_PTR(b), &high64, 8);
+  b->write_position += 8;
+
+  return self;
+}
+
 /**
  * Writes a 64 bit double to the buffer.
  */
@@ -361,7 +401,7 @@ VALUE rb_bson_byte_buffer_put_double(VALUE self, VALUE f)
   const double d = BSON_DOUBLE_TO_LE(NUM2DBL(f));
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
   ENSURE_BSON_WRITE(b, 8);
-  memcpy(WRITE_PTR(b), (char*)&d, 8);
+  memcpy(WRITE_PTR(b), &d, 8);
   b->write_position += 8;
 
   return self;
@@ -377,7 +417,7 @@ VALUE rb_bson_byte_buffer_put_int32(VALUE self, VALUE i)
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
   ENSURE_BSON_WRITE(b, 4);
-  memcpy(WRITE_PTR(b), (char*)&i32, 4);
+  memcpy(WRITE_PTR(b), &i32, 4);
   b->write_position += 4;
 
   return self;
@@ -393,7 +433,7 @@ VALUE rb_bson_byte_buffer_put_int64(VALUE self, VALUE i)
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
   ENSURE_BSON_WRITE(b, 8);
-  memcpy(WRITE_PTR(b), (char*)&i64, 8);
+  memcpy(WRITE_PTR(b), &i64, 8);
   b->write_position += 8;
 
   return self;
@@ -417,7 +457,7 @@ VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string)
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
   ENSURE_BSON_WRITE(b, length + 4);
-  memcpy(WRITE_PTR(b), (char*)&length_le, 4);
+  memcpy(WRITE_PTR(b), &length_le, 4);
   b->write_position += 4;
   memcpy(WRITE_PTR(b), str, length);
   b->write_position += length;
@@ -550,7 +590,7 @@ VALUE rb_bson_object_id_generator_next(int argc, VALUE* args, VALUE self)
   memcpy(&bytes, &t, 4);
   memcpy(&bytes[4], rb_bson_machine_id_hash, 3);
   memcpy(&bytes[7], &pid, 2);
-  memcpy(&bytes[9], (unsigned char*) &c, 3);
+  memcpy(&bytes[9], &c, 3);
   rb_bson_object_id_counter++;
   return rb_str_new(bytes, 12);
 }

data/ext/bson/extconf.rb

@@ -1,3 +1,3 @@
 require "mkmf"
 $CFLAGS << " -Wall -g -std=c99"
-create_makefile("native")
+create_makefile("bson_native")

data/ext/bson/native-endian.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 MongoDB, Inc.
+ * Copyright 2015-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.

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"
@@ -98,7 +100,7 @@ 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.")

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/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.freeze
+
+    # 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 raw bytes in a buffer.
+    #
+    # @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