bson 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c74b9a6da9615b1f9f48025f39568793a2622fa7adff3ee14554788fb91308
-  data.tar.gz: d7e06bb28d5bce5bbb85b06e200550a49bc1bc345a6923726567142edf93d434
+  metadata.gz: 7e49b6acc5ef1fcd05a0a246bd4c7c03682840f952f265de4b98cbc82137cb94
+  data.tar.gz: 2002ec01d574018844a22afa695b08e876ba7e5dfbeeaa8fd6c12632c5f357e7
 SHA512:
-  metadata.gz: 6c7853d7cf7eae94b107580e48d8ac6ace417623871bd9025d84d28eb22e55befca512d68b43abdcc585077aac44175508d6a7af3e851afb90a8af6fe0924865
-  data.tar.gz: 3cc376a7acb1cd4d605ea0c89eaa8dfe3682b392f137c94d626b8deae2ff29b5310a8d603b60e54af23b35fd5015e115d8289987a0369372a213eb758cc68200
+  metadata.gz: a6ba14998b5902fd6f69c555dd78775c9818731102cbd4fb16bf9ee94697c81a223ddc250eec6720693d89cc7eb19163d011c69158e419d062fc0bd184c98f90
+  data.tar.gz: 2c0418f4761c196bac99e787fe7216aa4c5905fadccbadc1206ba6d86902ed28c52609ffd60ef21e0b54388ec1a7fd44e147a42b4217e4e605aa26735f0be968

data/README.md

@@ -6,18 +6,19 @@ An implementation of the BSON specification in Ruby.
 Compatibility
 -------------
 
-BSON is tested against MRI (1.9.2+), JRuby (1.7.0+) and Rubinius (2.0.0+).
+BSON is tested against MRI (2.3+) and JRuby (9.2+).
 
 Documentation
 -------------
 
-Current documentation can be found [here](http://docs.mongodb.org/ecosystem/tutorial/ruby-bson-tutorial/#ruby-bson-tutorial)
+Current documentation can be found
+[here](http://docs.mongodb.org/ecosystem/tutorial/ruby-bson-tutorial/#ruby-bson-tutorial).
 
 API Documentation
 -----------------
 
-The [API Documentation](http://rdoc.info/github/mongodb/bson-ruby/master/frames) is
-located at rdoc.info.
+The [API Documentation](https://api.mongodb.com/bson-ruby/current/) is
+located at api.mongodb.com.
 
 BSON Specification
 ------------------
@@ -27,7 +28,8 @@ The [BSON specification](http://bsonspec.org) is at bsonspec.org.
 Versioning
 ----------
 
-As of 2.0.0, this project adheres to the [Semantic Versioning Specification](http://semver.org/).
+As of 2.0.0, this project adheres to the
+[Semantic Versioning Specification](http://semver.org/).
 
 License
 -------

data/ext/bson/{native-endian.h → bson-endian.h}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 MongoDB, Inc.
+ * Copyright (C) 2015-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.
@@ -106,101 +106,7 @@
 # error "The endianness of target architecture is unknown."
 #endif
 
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_uint16_swap_slow --
- *
- *       Fallback endianness conversion for 16-bit integers.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static uint16_t __bson_uint16_swap_slow(uint16_t v)
-{
-   return ((v & 0x00FF) << 8) |
-          ((v & 0xFF00) >> 8);
-}
-
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_uint32_swap_slow --
- *
- *       Fallback endianness conversion for 32-bit integers.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static uint32_t __bson_uint32_swap_slow(uint32_t v)
-{
-   return ((v & 0x000000FFU) << 24) |
-          ((v & 0x0000FF00U) <<  8) |
-          ((v & 0x00FF0000U) >>  8) |
-          ((v & 0xFF000000U) >> 24);
-}
-
-
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_uint64_swap_slow --
- *
- *       Fallback endianness conversion for 64-bit integers.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static uint64_t __bson_uint64_swap_slow(uint64_t v)
-{
-   return ((v & 0x00000000000000FFULL) << 56) |
-          ((v & 0x000000000000FF00ULL) << 40) |
-          ((v & 0x0000000000FF0000ULL) << 24) |
-          ((v & 0x00000000FF000000ULL) <<  8) |
-          ((v & 0x000000FF00000000ULL) >>  8) |
-          ((v & 0x0000FF0000000000ULL) >> 24) |
-          ((v & 0x00FF000000000000ULL) >> 40) |
-          ((v & 0xFF00000000000000ULL) >> 56);
-}
-
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_double_swap_slow --
- *
- *       Fallback endianness conversion for double floating point.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static double __bson_double_swap_slow(double v)
-{
-   uint64_t uv;
-
-   memcpy(&uv, &v, sizeof(v));
-   uv = BSON_UINT64_SWAP_LE_BE(uv);
-   memcpy(&v, &uv, sizeof(v));
-
-   return v;
-}
-
+uint16_t __bson_uint16_swap_slow(uint16_t v);
+uint32_t __bson_uint32_swap_slow(uint32_t v);
+uint64_t __bson_uint64_swap_slow(uint64_t v);
+double __bson_double_swap_slow(double v);

data/ext/bson/bson-native.h

@@ -0,0 +1,112 @@
+/*
+ * 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.
+ * 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.
+ */
+
+#include <ruby.h>
+#include <stdbool.h>
+#include <unistd.h>
+#include <time.h>
+#include "bson-endian.h"
+
+void
+rb_bson_utf8_validate (const char *utf8, /* IN */
+                    size_t utf8_len,  /* IN */
+                    bool allow_null, /* IN */
+                    const char *data_type);  /* IN */
+
+#define BSON_BYTE_BUFFER_SIZE 1024
+
+#ifndef HOST_NAME_HASH_MAX
+#define HOST_NAME_HASH_MAX 256
+#endif
+
+#define BSON_TYPE_DOUBLE        1
+#define BSON_TYPE_STRING        2
+#define BSON_TYPE_DOCUMENT      3
+#define BSON_TYPE_ARRAY         4
+#define BSON_TYPE_BOOLEAN       8
+#define BSON_TYPE_INT32         16
+#define BSON_TYPE_INT64         18
+
+typedef struct {
+  size_t size;
+  size_t write_position;
+  size_t read_position;
+  char   buffer[BSON_BYTE_BUFFER_SIZE];
+  char   *b_ptr;
+} byte_buffer_t;
+
+#define READ_PTR(byte_buffer_ptr) \
+  (byte_buffer_ptr->b_ptr + byte_buffer_ptr->read_position)
+
+#define READ_SIZE(byte_buffer_ptr) \
+  (byte_buffer_ptr->write_position - byte_buffer_ptr->read_position)
+
+#define WRITE_PTR(byte_buffer_ptr) \
+  (byte_buffer_ptr->b_ptr + byte_buffer_ptr->write_position)
+
+#define ENSURE_BSON_WRITE(buffer_ptr, length) \
+  { if (buffer_ptr->write_position + length > buffer_ptr->size) rb_bson_expand_buffer(buffer_ptr, length); }
+
+#define ENSURE_BSON_READ(buffer_ptr, length) \
+  { if (buffer_ptr->read_position + length > buffer_ptr->write_position) \
+    rb_raise(rb_eRangeError, "Attempted to read %zu bytes, but only %zu bytes remain", (size_t)length, READ_SIZE(buffer_ptr)); }
+
+VALUE rb_bson_byte_buffer_allocate(VALUE klass);
+VALUE rb_bson_byte_buffer_initialize(int argc, VALUE *argv, VALUE self);
+VALUE rb_bson_byte_buffer_length(VALUE self);
+VALUE rb_bson_byte_buffer_get_byte(VALUE self);
+VALUE rb_bson_byte_buffer_get_bytes(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_get_cstring(VALUE self);
+VALUE rb_bson_byte_buffer_get_decimal128_bytes(VALUE self);
+VALUE rb_bson_byte_buffer_get_double(VALUE self);
+VALUE rb_bson_byte_buffer_get_int32(VALUE self);
+VALUE rb_bson_byte_buffer_get_int64(VALUE self);
+VALUE rb_bson_byte_buffer_get_string(VALUE self);
+VALUE rb_bson_byte_buffer_get_hash(VALUE self);
+VALUE rb_bson_byte_buffer_get_array(VALUE self);
+VALUE rb_bson_byte_buffer_put_byte(VALUE self, VALUE byte);
+VALUE rb_bson_byte_buffer_put_bytes(VALUE self, VALUE bytes);
+VALUE rb_bson_byte_buffer_put_cstring(VALUE self, VALUE string);
+VALUE rb_bson_byte_buffer_put_decimal128(VALUE self, VALUE low, VALUE high);
+VALUE rb_bson_byte_buffer_put_double(VALUE self, VALUE f);
+VALUE rb_bson_byte_buffer_put_int32(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_put_int64(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string);
+VALUE rb_bson_byte_buffer_put_symbol(VALUE self, VALUE symbol);
+VALUE rb_bson_byte_buffer_put_hash(VALUE self, VALUE hash, VALUE validating_keys);
+VALUE rb_bson_byte_buffer_put_array(VALUE self, VALUE array, VALUE validating_keys);
+VALUE rb_bson_byte_buffer_read_position(VALUE self);
+VALUE rb_bson_byte_buffer_replace_int32(VALUE self, VALUE index, VALUE i);
+VALUE rb_bson_byte_buffer_rewind(VALUE self);
+VALUE rb_bson_byte_buffer_write_position(VALUE self);
+VALUE rb_bson_byte_buffer_to_s(VALUE self);
+VALUE rb_bson_object_id_generator_next(int argc, VALUE* args, VALUE self);
+
+size_t rb_bson_byte_buffer_memsize(const void *ptr);
+void rb_bson_byte_buffer_free(void *ptr);
+void rb_bson_expand_buffer(byte_buffer_t* buffer_ptr, size_t length);
+void rb_bson_generate_machine_id(VALUE rb_md5_class, char *rb_bson_machine_id);
+
+/**
+ * The counter for incrementing object ids.
+ */
+extern uint32_t rb_bson_object_id_counter;
+
+extern VALUE rb_bson_registry;
+
+extern VALUE rb_bson_illegal_key;
+
+extern const rb_data_type_t rb_byte_buffer_data_type;

data/ext/bson/bytebuf.c

@@ -0,0 +1,133 @@
+/*
+ * 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.
+ * 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.
+ */
+
+#include "bson-native.h"
+
+/**
+ * Allocates a bson byte buffer that wraps a byte_buffer_t.
+ */
+VALUE rb_bson_byte_buffer_allocate(VALUE klass)
+{
+  byte_buffer_t *b;
+  VALUE obj = TypedData_Make_Struct(klass, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  b->b_ptr = b->buffer;
+  b->size = BSON_BYTE_BUFFER_SIZE;
+  return obj;
+}
+
+/**
+ * Initialize a byte buffer.
+ */
+VALUE rb_bson_byte_buffer_initialize(int argc, VALUE *argv, VALUE self)
+{
+  VALUE bytes;
+  rb_scan_args(argc, argv, "01", &bytes);
+
+  if (!NIL_P(bytes)) {
+    rb_bson_byte_buffer_put_bytes(self, bytes);
+  }
+
+  return self;
+}
+
+/**
+ * Expand the byte buffer linearly.
+ */
+void rb_bson_expand_buffer(byte_buffer_t* buffer_ptr, size_t length)
+{
+  const size_t required_size = buffer_ptr->write_position - buffer_ptr->read_position + length;
+  if (required_size <= buffer_ptr->size) {
+    memmove(buffer_ptr->b_ptr, READ_PTR(buffer_ptr), READ_SIZE(buffer_ptr));
+    buffer_ptr->write_position -= buffer_ptr->read_position;
+    buffer_ptr->read_position = 0;
+  } else {
+    char *new_b_ptr;
+    const size_t new_size = required_size * 2;
+    new_b_ptr = ALLOC_N(char, new_size);
+    memcpy(new_b_ptr, READ_PTR(buffer_ptr), READ_SIZE(buffer_ptr));
+    if (buffer_ptr->b_ptr != buffer_ptr->buffer) {
+      xfree(buffer_ptr->b_ptr);
+    }
+    buffer_ptr->b_ptr = new_b_ptr;
+    buffer_ptr->size = new_size;
+    buffer_ptr->write_position -= buffer_ptr->read_position;
+    buffer_ptr->read_position = 0;
+  }
+}
+
+/**
+ * Free the memory for the byte buffer.
+ */
+void rb_bson_byte_buffer_free(void *ptr)
+{
+  byte_buffer_t *b = ptr;
+  if (b->b_ptr != b->buffer) {
+    xfree(b->b_ptr);
+  }
+  xfree(b);
+}
+
+/**
+ * Get the length of the buffer.
+ */
+VALUE rb_bson_byte_buffer_length(VALUE self)
+{
+  byte_buffer_t *b;
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  return UINT2NUM(READ_SIZE(b));
+}
+
+/* The docstring is in init.c. */
+VALUE rb_bson_byte_buffer_read_position(VALUE self)
+{
+  byte_buffer_t *b;
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  return INT2NUM(b->read_position);
+}
+
+/* The docstring is in init.c. */
+VALUE rb_bson_byte_buffer_rewind(VALUE self)
+{
+  byte_buffer_t *b;
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  b->read_position = 0;
+
+  return self;
+}
+
+/* The docstring is in init.c. */
+VALUE rb_bson_byte_buffer_write_position(VALUE self)
+{
+  byte_buffer_t *b;
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  return INT2NUM(b->write_position);
+}
+
+/* The docstring is in init.c. */
+VALUE rb_bson_byte_buffer_to_s(VALUE self)
+{
+  byte_buffer_t *b;
+  TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
+  return rb_str_new(READ_PTR(b), READ_SIZE(b));
+}
+
+/**
+ * Get the size of the byte_buffer_t in memory.
+ */
+size_t rb_bson_byte_buffer_memsize(const void *ptr)
+{
+  return ptr ? sizeof(byte_buffer_t) : 0;
+}

data/ext/bson/endian.c

@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2015-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.
+ */
+
+#include <string.h>
+#include "bson-endian.h"
+
+/*
+ *--------------------------------------------------------------------------
+ *
+ * __bson_uint16_swap_slow --
+ *
+ *       Fallback endianness conversion for 16-bit integers.
+ *
+ * Returns:
+ *       The endian swapped version.
+ *
+ * Side effects:
+ *       None.
+ *
+ *--------------------------------------------------------------------------
+ */
+uint16_t __bson_uint16_swap_slow(uint16_t v)
+{
+   return ((v & 0x00FF) << 8) |
+          ((v & 0xFF00) >> 8);
+}
+
+/*
+ *--------------------------------------------------------------------------
+ *
+ * __bson_uint32_swap_slow --
+ *
+ *       Fallback endianness conversion for 32-bit integers.
+ *
+ * Returns:
+ *       The endian swapped version.
+ *
+ * Side effects:
+ *       None.
+ *
+ *--------------------------------------------------------------------------
+ */
+uint32_t __bson_uint32_swap_slow(uint32_t v)
+{
+   return ((v & 0x000000FFU) << 24) |
+          ((v & 0x0000FF00U) <<  8) |
+          ((v & 0x00FF0000U) >>  8) |
+          ((v & 0xFF000000U) >> 24);
+}
+
+
+/*
+ *--------------------------------------------------------------------------
+ *
+ * __bson_uint64_swap_slow --
+ *
+ *       Fallback endianness conversion for 64-bit integers.
+ *
+ * Returns:
+ *       The endian swapped version.
+ *
+ * Side effects:
+ *       None.
+ *
+ *--------------------------------------------------------------------------
+ */
+uint64_t __bson_uint64_swap_slow(uint64_t v)
+{
+   return ((v & 0x00000000000000FFULL) << 56) |
+          ((v & 0x000000000000FF00ULL) << 40) |
+          ((v & 0x0000000000FF0000ULL) << 24) |
+          ((v & 0x00000000FF000000ULL) <<  8) |
+          ((v & 0x000000FF00000000ULL) >>  8) |
+          ((v & 0x0000FF0000000000ULL) >> 24) |
+          ((v & 0x00FF000000000000ULL) >> 40) |
+          ((v & 0xFF00000000000000ULL) >> 56);
+}
+
+/*
+ *--------------------------------------------------------------------------
+ *
+ * __bson_double_swap_slow --
+ *
+ *       Fallback endianness conversion for double floating point.
+ *
+ * Returns:
+ *       The endian swapped version.
+ *
+ * Side effects:
+ *       None.
+ *
+ *--------------------------------------------------------------------------
+ */
+double __bson_double_swap_slow(double v)
+{
+   uint64_t uv;
+
+   memcpy(&uv, &v, sizeof(v));
+   uv = BSON_UINT64_SWAP_LE_BE(uv);
+   memcpy(&v, &uv, sizeof(v));
+
+   return v;
+}