bson 4.3.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b2cdf98517b40720fa4e2cdfaae83903ac8d1907
-  data.tar.gz: 821e69506dcde2eca70b737a97a8d0f3f4cce3f3
+SHA256:
+  metadata.gz: 84427d100a7c6e64e513b120537d2347cae31bcb08f2d9270d46946f0cecab6f
+  data.tar.gz: 9bfb6408d1c44c3ff4cc25de3beaeb37cbd5ff18d271c44af989b37f050760f6
 SHA512:
-  metadata.gz: 285a6ba405445c535fc2157c81bee4ce48825716d2048acd3060221371b1cecd6081c5e1c487f67e373292ed97841d6e45b78abdb98cf3f81bf854d10c5f4473
-  data.tar.gz: 194eed21affeaf868a337ba758034f11496c077f02945a403c923a29de0c1f1e11f8da2a9318ecc5aefd3964b56b4aafd3ea167ee24edde962e580ac08f4f3ce
+  metadata.gz: fb891b58d7763ad8a26858941a8067fa601db56cdef379f5a56fb59de1c25851d98cbf4653fb592bba985717d1e06f85681138979e9a061ab91cb1ea186dd4c2
+  data.tar.gz: b33f84f1c0b06b0c5c1095bf6fa047d066ba3be9ca2f1cb7860bfab3c8a36066b84be74a61cc539500f0eeb30bba441ec4ba213e24fb004379f47b918d133a14

data/Rakefile

@@ -20,6 +20,7 @@ $LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
 require "rake"
 require "rake/extensiontask"
 require "rspec/core/rake_task"
+require 'fileutils'
 
 def jruby?
   defined?(JRUBY_VERSION)
@@ -62,15 +63,9 @@ else
 end
 
 task :clean_all => :clean do
-  begin
-    Dir.chdir(Pathname(__FILE__).dirname + "lib") do
-      `rm bson_native.#{extension}`
-      `rm bson_native.o`
-      `rm bson-ruby.jar`
-    end
-  rescue Exception => e
-    puts e.message
-  end
+  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.#{extension}"))
+  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.o"))
+  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson-ruby.jar"))
 end
 
 task :spec => :compile do
@@ -126,3 +121,15 @@ namespace :benchmark do
 end
 
 task :default => [ :clean_all, :spec ]
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('yard-docs', BSON::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title bson-#{BSON::VERSION}"
+  end
+end

data/ext/bson/bson_native.c

@@ -73,12 +73,15 @@ static VALUE rb_bson_byte_buffer_get_hash(VALUE self);
 static VALUE rb_bson_byte_buffer_get_array(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_bson_partial_string(VALUE self, const char *str, int32_t length);
 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);
+static VALUE rb_bson_byte_buffer_put_bson_string(VALUE self, const char *str, int32_t length);
 static VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string);
+static VALUE rb_bson_byte_buffer_put_symbol(VALUE self, VALUE symbol);
 static VALUE rb_bson_byte_buffer_put_hash(VALUE self, VALUE hash, VALUE validating_keys);
 static VALUE rb_bson_byte_buffer_put_array(VALUE self, VALUE array, VALUE validating_keys);
 static VALUE rb_bson_byte_buffer_read_position(VALUE self);
@@ -118,7 +121,7 @@ static void pvt_put_byte(byte_buffer_t *b, const char byte);
 static void pvt_put_int32(byte_buffer_t *b, const int32_t i32);
 static void pvt_put_int64(byte_buffer_t *b, const int64_t i);
 static void pvt_put_double(byte_buffer_t *b, double f);
-static void pvt_put_cstring(byte_buffer_t *b, VALUE string);
+static void pvt_put_cstring(byte_buffer_t *b, const char *str, int32_t length);
 static void pvt_put_bson_key(byte_buffer_t *b, VALUE string, VALUE validating_keys);
 
 /**
@@ -173,6 +176,7 @@ void Init_bson_native()
   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);
   rb_define_method(rb_byte_buffer_class, "put_string", rb_bson_byte_buffer_put_string, 1);
+  rb_define_method(rb_byte_buffer_class, "put_symbol", rb_bson_byte_buffer_put_symbol, 1);
   rb_define_method(rb_byte_buffer_class, "read_position", rb_bson_byte_buffer_read_position, 0);
   rb_define_method(rb_byte_buffer_class, "replace_int32", rb_bson_byte_buffer_replace_int32, 2);
   rb_define_method(rb_byte_buffer_class, "rewind!", rb_bson_byte_buffer_rewind, 0);
@@ -461,6 +465,7 @@ void pvt_put_array_index(byte_buffer_t *b, int32_t index)
 {
   char buffer[16];
   const char *c_str = NULL;
+  size_t length;
 
   if (index < 1000) {
     c_str = index_strings[index];
@@ -468,7 +473,7 @@ void pvt_put_array_index(byte_buffer_t *b, int32_t index)
     c_str = buffer;
     snprintf(buffer, sizeof(buffer), "%d", index);
   }
-  size_t length = strlen(c_str) + 1;
+  length = strlen(c_str) + 1;
   ENSURE_BSON_WRITE(b, length);
   memcpy(WRITE_PTR(b), c_str, length);
   b->write_position += length;
@@ -533,8 +538,9 @@ VALUE rb_bson_byte_buffer_get_byte(VALUE self)
 }
 
 uint8_t pvt_get_type_byte(byte_buffer_t *b){
+  int8_t byte;
   ENSURE_BSON_READ(b, 1);
-  int8_t byte = *READ_PTR(b);
+  byte = *READ_PTR(b);
   b->read_position += 1;
   return (uint8_t)byte;
 }
@@ -759,7 +765,12 @@ VALUE pvt_read_field(byte_buffer_t *b, VALUE rb_buffer, uint8_t type){
 VALUE rb_bson_byte_buffer_put_byte(VALUE self, VALUE byte)
 {
   byte_buffer_t *b;
-  const char *str = RSTRING_PTR(byte);
+  const char *str;
+
+  if (!RB_TYPE_P(byte, T_STRING))
+    rb_raise(rb_eArgError, "Invalid input");
+
+  str = RSTRING_PTR(byte);
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
   ENSURE_BSON_WRITE(b, 1);
@@ -782,8 +793,14 @@ void pvt_put_byte( byte_buffer_t *b, const char byte)
 VALUE rb_bson_byte_buffer_put_bytes(VALUE self, VALUE bytes)
 {
   byte_buffer_t *b;
-  const char *str = RSTRING_PTR(bytes);
-  const size_t length = RSTRING_LEN(bytes);
+  const char *str;
+  size_t length;
+
+  if (!RB_TYPE_P(bytes, T_STRING) && !RB_TYPE_P(bytes, RUBY_T_DATA))
+    rb_raise(rb_eArgError, "Invalid input");
+
+  str = RSTRING_PTR(bytes);
+  length = RSTRING_LEN(bytes);
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
   ENSURE_BSON_WRITE(b, length);
@@ -793,42 +810,74 @@ VALUE rb_bson_byte_buffer_put_bytes(VALUE self, VALUE bytes)
 }
 
 /**
- * Writes a cstring to the byte buffer.
+ * Writes a string (which may form part of a BSON object) to the byte buffer.
+ * length does not include the null terminator.
  */
-VALUE rb_bson_byte_buffer_put_cstring(VALUE self, VALUE string)
+VALUE rb_bson_byte_buffer_put_bson_partial_string(VALUE self, const char *str, int32_t length)
 {
   byte_buffer_t *b;
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
-  pvt_put_cstring(b, string);
+  pvt_put_cstring(b, str, length);
   return self;
 }
 
-void pvt_put_cstring(byte_buffer_t *b, VALUE string)
+/**
+ * length does not include the null terminator.
+ */
+void pvt_put_cstring(byte_buffer_t *b, const char *str, int32_t length)
 {
-  char *c_str = RSTRING_PTR(string);
-  size_t length = RSTRING_LEN(string) + 1;
-
-  if (!rb_bson_utf8_validate(c_str, length - 1, false)) {
-    rb_raise(rb_eArgError, "String %s is not a valid UTF-8 CString.", c_str);
+  int bytes_to_write;
+  if (!rb_bson_utf8_validate(str, length, false)) {
+    rb_raise(rb_eArgError, "String %s is not a valid UTF-8 CString.", str);
   }
-  ENSURE_BSON_WRITE(b, length);
-  memcpy(WRITE_PTR(b), c_str, length);
-  b->write_position += length;
+  bytes_to_write = length + 1;
+  ENSURE_BSON_WRITE(b, bytes_to_write);
+  memcpy(WRITE_PTR(b), str, bytes_to_write);
+  b->write_position += bytes_to_write;
 }
 
 /**
  * Write a hash key to the byte buffer, validating it if requested
  */
 void pvt_put_bson_key(byte_buffer_t *b, VALUE string, VALUE validating_keys){
-  if(RTEST(validating_keys)){
-    char *c_str = RSTRING_PTR(string);
-    size_t length = RSTRING_LEN(string);
-    if(length > 0 && (c_str[0] == '$' || memchr(c_str, '.', length))){
-      rb_exc_raise(rb_funcall(rb_bson_illegal_key, rb_intern("new"),1, string));
+  char *c_str = RSTRING_PTR(string);
+  size_t length = RSTRING_LEN(string);
+  
+  if (RTEST(validating_keys)) {
+    if (length > 0 && (c_str[0] == '$' || memchr(c_str, '.', length))) {
+      rb_exc_raise(rb_funcall(rb_bson_illegal_key, rb_intern("new"), 1, string));
     }
   }
 
-  pvt_put_cstring(b, string);
+  pvt_put_cstring(b, c_str, length);
+}
+
+/**
+ * Writes a cstring to the byte buffer.
+ * This magically supports both Ruby symbols and strings.
+ */
+VALUE rb_bson_byte_buffer_put_cstring(VALUE self, VALUE string)
+{
+  int32_t length;
+
+  if (TYPE(string) == T_SYMBOL) {
+    const char *sym = rb_id2name(SYM2ID(string));
+    length = strlen(sym);
+
+    return rb_bson_byte_buffer_put_bson_partial_string(self, sym, length);
+  } else if (TYPE(string) == T_STRING) {
+    const char *str = RSTRING_PTR(string);
+    length = RSTRING_LEN(string);
+
+    return rb_bson_byte_buffer_put_bson_partial_string(self, str, length);
+  } else if (TYPE(string) == T_FIXNUM) {
+    const char *str = RSTRING_PTR(rb_fix2str(string, 10));
+    length = strlen(str);
+
+    return rb_bson_byte_buffer_put_bson_partial_string(self, str, length);
+  } else {
+    rb_raise(rb_eTypeError, "Invalid type for string");
+  }
 }
 
 /**
@@ -945,15 +994,18 @@ void pvt_validate_length(byte_buffer_t *b)
 }
 
 /**
- * Writes a string to the byte buffer.
+ * Write BSON string to byte buffer given a C string.
+ * length is inclusive of the NULL terminator in the C string.
  */
-VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string)
+static VALUE rb_bson_byte_buffer_put_bson_string(VALUE self, const char *str, int32_t length)
 {
   byte_buffer_t *b;
   int32_t length_le;
 
-  char *str = RSTRING_PTR(string);
-  const int32_t length = RSTRING_LEN(string) + 1;
+  if (length <= 0) {
+    rb_raise(rb_eArgError, "The length must include the NULL terminator, and thus be at least 1");
+  }
+
   length_le = BSON_UINT32_TO_LE(length);
 
   if (!rb_bson_utf8_validate(str, length - 1, true)) {
@@ -970,6 +1022,28 @@ VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string)
   return self;
 }
 
+/**
+ * Writes a string to the byte buffer.
+ */
+VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string)
+{
+  const char *str = RSTRING_PTR(string);
+  const int32_t length = RSTRING_LEN(string) + 1;
+
+  return rb_bson_byte_buffer_put_bson_string(self, str, length);
+}
+
+/**
+ * Writes a symbol to the byte buffer.
+ */
+VALUE rb_bson_byte_buffer_put_symbol(VALUE self, VALUE symbol)
+{
+  const char *sym = rb_id2name(SYM2ID(symbol));
+  const int32_t length = strlen(sym) + 1;
+
+  return rb_bson_byte_buffer_put_bson_string(self, sym, length);
+}
+
 /**
  * Get the read position.
  */

data/lib/bson.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/active_support.rb

@@ -0,0 +1,17 @@
+# Copyright (C) 2018-2019 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 this file if using BSON with ActiveSupport.
+
+require "bson/time_with_zone"

data/lib/bson/array.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/binary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/boolean.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/code.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/code_with_scope.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/config.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB Inc.
+# Copyright (C) 2016-2019 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/date.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/date_time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 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/decimal128.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB Inc.
+# Copyright (C) 2016-2019 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/decimal128/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB Inc.
+# Copyright (C) 2016-2019 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/document.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# Copyright (C) 2009-2019 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -35,8 +35,25 @@ module BSON
   class Document < ::Hash
 
     # Get a value from the document for the provided key. Can use string or
-    # symbol access, but the fastest will be to always provide a key that is of
-    # the same type as the stored keys.
+    # symbol access, with string access being the faster of the two.
+    #
+    # @example Get an element for the key.
+    #   document.fetch("field")
+    #
+    # @example Get an element for the key by symbol.
+    #   document.fetch(:field)
+    #
+    # @param [ String, Symbol ] key The key to look up.
+    #
+    # @return [ Object ] The found value. Raises KeyError if none found.
+    #
+    # @since 4.4.0
+    def fetch(key)
+      super(convert_key(key))
+    end
+
+    # Get a value from the document for the provided key. Can use string or
+    # symbol access, with string access being the faster of the two.
     #
     # @example Get an element for the key.
     #   document["field"]
@@ -44,7 +61,7 @@ module BSON
     # @example Get an element for the key by symbol.
     #   document[:field]
     #
-    # @param [ String, Symbol ] key The key to lookup.
+    # @param [ String, Symbol ] key The key to look up.
     #
     # @return [ Object ] The found value, or nil if none found.
     #
@@ -192,6 +209,27 @@ module BSON
       end
     end
 
+    if instance_methods.include?(:slice)
+      # Slices a document to include only the given keys.
+      # Will normalize symbol keys into strings.
+      # (this method is backported from ActiveSupport::Hash)
+      #
+      # @example Get a document/hash with only the `name` and `age` fields present
+      #   document # => { _id: <ObjectId>, :name => 'John', :age => 30, :location => 'Earth' }
+      #   document.slice(:name, 'age') # => { name: 'John', age: 30 }
+      #   document.slice('name') # => { name: 'John' }
+      #   document.slice(:foo) # => nil
+      #
+      # @param [ Array<String, Symbol> ] *keys Keys, that will be kept in the resulting document
+      #
+      # @return [ BSON::Document ] The document with only the selected keys
+      #
+      # @since 4.3.1
+      def slice(*keys)
+        super(*keys.map{|key| convert_key(key)})
+      end
+    end
+
     private
 
     def convert_key(key)