bson 4.2.2 → 4.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e76c5872004b8c218e35db5ae4db7e2a0f69449
-  data.tar.gz: 40dc1aac62c0f7a59eed2a6a9619743927a66ae6
+SHA256:
+  metadata.gz: 18f69f1d0f65a2c4883500061a6637f6fb314e7758a15cda3941432a7e6fbd0a
+  data.tar.gz: b26789d1b2da697b6113897040ecd297d88367267fd28411609f23229ec8be2e
 SHA512:
-  metadata.gz: 5e820f483f475073365955ec222c92771ca5ed5bc2547c82eeabc353a1dd9153e1a5fff8a878428ba0e781e8f2c8f2d341b858423407469d7d6947324f3ff3b8
-  data.tar.gz: c0fdd409db1055211502f7f2b3527d298d6e0e6ece5bde64418b0291e709e50eda0471951ccc10c57a86f9cdcd7e2ee9353bda19c7fd02f61fcc593612db65c0
+  metadata.gz: 7f90cd2d60cb0904d80ec6a3d75ba7d88af3872b5b1fdd27f9a283026f7c27ffbe84ad5331e571ebe120c7cd8c94d06190da8f1dc9fc783c349667f0ee963de1
+  data.tar.gz: da4c4edb81e99a804789c3914555376db3510a65437cc7b80829ae1f38f3c0f5a45894c8b4d8b24127367d0a9d1f46c9094a7b4f0f18633dbd4c4a8890675b02

data/README.md

@@ -1,4 +1,9 @@
-BSON [![Build Status](https://secure.travis-ci.org/mongodb/bson-ruby.png?branch=master&.png)](http://travis-ci.org/mongodb/bson-ruby)  [![Code Climate](https://codeclimate.com/github/mongodb/bson-ruby.png)](https://codeclimate.com/github/mongodb/bson-ruby) [![Coverage Status](https://coveralls.io/repos/mongodb/bson-ruby/badge.png?branch=master)](https://coveralls.io/r/mongodb/bson-ruby?branch=master) [![Inline docs](http://inch-ci.org/github/mongodb/bson-ruby.svg?branch=master)](http://inch-ci.org/github/mongodb/bson-ruby)
+BSON
+[![Gem Version][rubygems-img]][rubygems-url]
+[![Build Status][travis-img]][travis-url]
+[![Build status Windows][appveyor-img]][appveyor-url]
+[![Coverage Status][coveralls-img]][coveralls-url]
+[![Inline docs][inch-img]][inch-url]
 ====
 
 An implementation of the BSON specification in Ruby.
@@ -6,18 +11,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,12 +33,13 @@ 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
 -------
 
-Copyright (C) 2009-2016 MongoDB Inc.
+Copyright (C) 2009-2020 MongoDB Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -45,3 +52,14 @@ 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.
+
+[rubygems-img]: https://badge.fury.io/rb/bson.svg
+[rubygems-url]: http://badge.fury.io/rb/bson
+[travis-img]: https://secure.travis-ci.org/mongodb/bson-ruby.svg?branch=master
+[travis-url]: http://travis-ci.org/mongodb/bson-ruby
+[appveyor-img]: https://ci.appveyor.com/api/projects/status/p5aqko7umsx351nm?svg=true
+[appveyor-url]: https://ci.appveyor.com/project/p-mongo/bson-ruby/branch/master
+[coveralls-img]: https://coveralls.io/repos/mongodb/bson-ruby/badge.svg?branch=master
+[coveralls-url]: https://coveralls.io/r/mongodb/bson-ruby?branch=master
+[inch-img]: http://inch-ci.org/github/mongodb/bson-ruby.svg?branch=master
+[inch-url]: http://inch-ci.org/github/mongodb/bson-ruby

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/{native-endian.h → bson-endian.h}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2016 MongoDB, Inc.
+ * Copyright (C) 2015-2020 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,125 @@
+/*
+ * Copyright (C) 2009-2020 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 <stdint.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
+
+/* See the type list in http://bsonspec.org/spec.html. */
+#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_SYMBOL        0x0E
+#define BSON_TYPE_INT32         0x10
+#define BSON_TYPE_INT64         0x12
+
+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_uint32(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(int argc, VALUE *argv, VALUE self);
+VALUE rb_bson_byte_buffer_get_array(int argc, VALUE *argv, 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_uint32(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);
+
+VALUE pvt_const_get_2(const char *c1, const char *c2);
+VALUE pvt_const_get_3(const char *c1, const char *c2, const char *c3);
+
+#define BSON_MODE_DEFAULT       0
+#define BSON_MODE_BSON          1
+
+int pvt_get_mode_option(int argc, VALUE *argv);
+
+/**
+ * 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-2020 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;
+}