mongo 2.22.0 → 2.24.0

data/lib/mongo/crypt/binding.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -34,9 +33,9 @@ unless ENV['LIBMONGOCRYPT_PATH']
     # JRuby 9.3.2.0 replaces a LoadError with our custom message with a
     # generic NameError, when this load is attempted as part of autoloading
     # process. JRuby 9.2.20.0 propagates LoadError as expected.
-    raise LoadError, "Cannot load Mongo::Crypt::Binding because there is no path " +
-        "to libmongocrypt specified in the LIBMONGOCRYPT_PATH environment variable " +
-        "and libmongocrypt-helper is not installed: #{e.class}: #{e}"
+    raise LoadError, 'Cannot load Mongo::Crypt::Binding because there is no path ' +
+                     'to libmongocrypt specified in the LIBMONGOCRYPT_PATH environment variable ' +
+                     "and libmongocrypt-helper is not installed: #{e.class}: #{e}"
   end
 end
 
@@ -44,7 +43,6 @@ require 'ffi'
 
 module Mongo
   module Crypt
-
     # @api private
     def reset_autoload
       remove_const(:Binding)
@@ -63,18 +61,18 @@ module Mongo
           ffi_lib ENV['LIBMONGOCRYPT_PATH']
         rescue LoadError => e
           Crypt.reset_autoload
-          raise LoadError, "Cannot load Mongo::Crypt::Binding because the path to " +
-            "libmongocrypt specified in the LIBMONGOCRYPT_PATH environment variable " +
-            "is invalid: #{ENV['LIBMONGOCRYPT_PATH']}\n\n#{e.class}: #{e.message}"
+          raise LoadError, 'Cannot load Mongo::Crypt::Binding because the path to ' +
+                           'libmongocrypt specified in the LIBMONGOCRYPT_PATH environment variable ' +
+                           "is invalid: #{ENV['LIBMONGOCRYPT_PATH']}\n\n#{e.class}: #{e.message}"
         end
       else
         begin
           ffi_lib LibmongocryptHelper.libmongocrypt_path
         rescue LoadError => e
           Crypt.reset_autoload
-          raise LoadError, "Cannot load Mongo::Crypt::Binding because the path to " +
-            "libmongocrypt specified in libmongocrypt-helper " +
-            "is invalid: #{LibmongocryptHelper.libmongocrypt_path}\n\n#{e.class}: #{e.message}"
+          raise LoadError, 'Cannot load Mongo::Crypt::Binding because the path to ' +
+                           'libmongocrypt specified in libmongocrypt-helper ' +
+                           "is invalid: #{LibmongocryptHelper.libmongocrypt_path}\n\n#{e.class}: #{e.message}"
         end
       end
 
@@ -83,7 +81,7 @@ module Mongo
       # will cause a `LoadError`.
       #
       # @api private
-      MIN_LIBMONGOCRYPT_VERSION = Gem::Version.new("1.12.0")
+      MIN_LIBMONGOCRYPT_VERSION = Gem::Version.new('1.12.0')
 
       # @!method self.mongocrypt_version(len)
       #   @api private
@@ -92,7 +90,7 @@ module Mongo
       #   @param [ FFI::Pointer | nil ] len (out param) An optional pointer to a
       #     uint8 that will reference the length of the returned string.
       #   @return [ String ] A version string for libmongocrypt.
-      attach_function :mongocrypt_version, [:pointer], :string
+      attach_function :mongocrypt_version, [ :pointer ], :string
 
       # Given a string representing a version number, parses it into a
       # Gem::Version object. This handles the case where the string is not
@@ -108,7 +106,7 @@ module Mongo
       def self.parse_version(version)
         Gem::Version.new(version)
       rescue ArgumentError
-        match = version.match(/\A(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)?(-[A-Za-z\+\d]+)?\z/)
+        match = version.match(/\A(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)?(-[A-Za-z+\d]+)?\z/)
         raise ArgumentError.new("Malformed version number string #{version}") if match.nil?
 
         Gem::Version.new(
@@ -131,7 +129,7 @@ module Mongo
       def self.validate_version(lmc_version)
         if (actual_version = parse_version(lmc_version)) < MIN_LIBMONGOCRYPT_VERSION
           raise LoadError, "libmongocrypt version #{MIN_LIBMONGOCRYPT_VERSION} or above is required, " +
-            "but version #{actual_version} was found."
+                           "but version #{actual_version} was found."
         end
       end
 
@@ -158,7 +156,7 @@ module Mongo
       #     mongocrypt_binary_t object.
       attach_function(
         :mongocrypt_binary_new_from_data,
-        [:pointer, :int],
+        %i[pointer int],
         :pointer
       )
 
@@ -168,7 +166,7 @@ module Mongo
       #   Get the pointer to the underlying data for the mongocrypt_binary_t.
       #   @param [ FFI::Pointer ] binary A pointer to a mongocrypt_binary_t object.
       #   @return [ FFI::Pointer ] A pointer to the data array.
-      attach_function :mongocrypt_binary_data, [:pointer], :pointer
+      attach_function :mongocrypt_binary_data, [ :pointer ], :pointer
 
       # @!method self.mongocrypt_binary_len(binary)
       #   @api private
@@ -176,7 +174,7 @@ module Mongo
       #   Get the length of the underlying data array.
       #   @param [ FFI::Pointer ] binary A pointer to a mongocrypt_binary_t object.
       #   @return [ Integer ] The length of the data array.
-      attach_function :mongocrypt_binary_len, [:pointer], :int
+      attach_function :mongocrypt_binary_len, [ :pointer ], :int
 
       def self.get_binary_data_direct(mongocrypt_binary_t)
         mongocrypt_binary_t.get_pointer(0)
@@ -192,7 +190,7 @@ module Mongo
       #   Destroy the mongocrypt_binary_t object.
       #   @param [ FFI::Pointer ] binary A pointer to a mongocrypt_binary_t object.
       #   @return [ nil ] Always nil.
-      attach_function :mongocrypt_binary_destroy, [:pointer], :void
+      attach_function :mongocrypt_binary_destroy, [ :pointer ], :void
 
       # Enum labeling different status types
       enum :status_type, [
@@ -222,7 +220,7 @@ module Mongo
       #   @return [ nil ] Always nil.
       attach_function(
         :mongocrypt_status_set,
-        [:pointer, :status_type, :int, :string, :int],
+        %i[pointer status_type int string int],
         :void
       )
 
@@ -232,7 +230,7 @@ module Mongo
       #   Indicates the status type.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t.
       #   @return [ Symbol ] The status type (as defined by the status_type enum).
-      attach_function :mongocrypt_status_type, [:pointer], :status_type
+      attach_function :mongocrypt_status_type, [ :pointer ], :status_type
 
       # @!method self.mongocrypt_status_code(status)
       #   @api private
@@ -240,7 +238,7 @@ module Mongo
       #   Return the status error code.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t.
       #   @return [ Integer ] The status code.
-      attach_function :mongocrypt_status_code, [:pointer], :int
+      attach_function :mongocrypt_status_code, [ :pointer ], :int
 
       # @!method self.mongocrypt_status_message(status, len=nil)
       #   @api private
@@ -248,9 +246,9 @@ module Mongo
       #   Returns the status message.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t.
       #   @param [ FFI::Pointer | nil ] len (out param) An optional pointer to a
-      #     uint32, where the length of the retun string will be written.
+      #     uint32, where the length of the return string will be written.
       #   @return [ String ] The status message.
-      attach_function :mongocrypt_status_message, [:pointer, :pointer], :string
+      attach_function :mongocrypt_status_message, %i[pointer pointer], :string
 
       # @!method self.mongocrypt_status_ok(status)
       #   @api private
@@ -258,7 +256,7 @@ module Mongo
       #   Returns whether the status is ok or an error.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t.
       #   @return [ Boolean ] Whether the status is ok.
-      attach_function :mongocrypt_status_ok, [:pointer], :bool
+      attach_function :mongocrypt_status_ok, [ :pointer ], :bool
 
       # @!method self.mongocrypt_status_destroy(status)
       #   @api private
@@ -266,7 +264,7 @@ module Mongo
       #   Destroys the reference to the mongocrypt_status_t object.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t.
       #   @return [ nil ] Always nil.
-      attach_function :mongocrypt_status_destroy, [:pointer], :void
+      attach_function :mongocrypt_status_destroy, [ :pointer ], :void
 
       # Enum labeling the various log levels
       enum :log_level, [
@@ -293,7 +291,7 @@ module Mongo
       #
       #   @note This defines a method signature for an FFI callback; it is not
       #     an instance method on the Binding class.
-      callback :mongocrypt_log_fn_t, [:log_level, :string, :int, :pointer], :void
+      callback :mongocrypt_log_fn_t, %i[log_level string int pointer], :void
 
       # @!method self.ongocrypt_new
       #   @api private
@@ -314,7 +312,7 @@ module Mongo
       #   @return [ Boolean ] Whether setting the callback was successful.
       attach_function(
         :mongocrypt_setopt_log_handler,
-        [:pointer, :mongocrypt_log_fn_t, :pointer],
+        %i[pointer mongocrypt_log_fn_t pointer],
         :bool
       )
 
@@ -343,7 +341,7 @@ module Mongo
       #   @returns [ true | false ] Returns whether the options was set successfully.
       attach_function(
         :mongocrypt_setopt_kms_providers,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -372,7 +370,7 @@ module Mongo
       #   @param [ FFI::Pointer ] schema_map A pointer to a mongocrypt_binary_t.
       #     object that references the schema map as a BSON binary string.
       #   @return [ Boolean ] Returns whether the option was set successfully.
-      attach_function :mongocrypt_setopt_schema_map, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_setopt_schema_map, %i[pointer pointer], :bool
 
       # Set schema map on the Mongo::Crypt::Handle object
       #
@@ -397,7 +395,7 @@ module Mongo
       #   Initialize the mongocrypt_t object.
       #   @param [ FFI::Pointer ] crypt A pointer to a mongocrypt_t object.
       #   @return [ Boolean ] Returns whether the crypt was initialized successfully.
-      attach_function :mongocrypt_init, [:pointer], :bool
+      attach_function :mongocrypt_init, [ :pointer ], :bool
 
       # Initialize the Mongo::Crypt::Handle object
       #
@@ -418,7 +416,7 @@ module Mongo
       #   @param [ FFI::Pointer ] crypt A pointer to a mongocrypt_t object.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t object.
       #   @return [ Boolean ] Whether the status was successfully set.
-      attach_function :mongocrypt_status, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_status, %i[pointer pointer], :bool
 
       # @!method self.mongocrypt_destroy(crypt)
       #   @api private
@@ -426,7 +424,7 @@ module Mongo
       #   Destroy the reference the mongocrypt_t object.
       #   @param [ FFI::Pointer ] crypt A pointer to a mongocrypt_t object.
       #   @return [ nil ] Always nil.
-      attach_function :mongocrypt_destroy, [:pointer], :void
+      attach_function :mongocrypt_destroy, [ :pointer ], :void
 
       # @!method self.mongocrypt_ctx_new(crypt)
       #   @api private
@@ -435,7 +433,7 @@ module Mongo
       #     state machine).
       #   @param [ FFI::Pointer ] crypt A pointer to a mongocrypt_t object.
       #   @return [ FFI::Pointer ] A new mongocrypt_ctx_t object.
-      attach_function :mongocrypt_ctx_new, [:pointer], :pointer
+      attach_function :mongocrypt_ctx_new, [ :pointer ], :pointer
 
       # @!method self.mongocrypt_ctx_status(ctx, status)
       #   @api private
@@ -445,7 +443,7 @@ module Mongo
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t object.
       #   @return [ Boolean ] Whether the status was successfully set.
-      attach_function :mongocrypt_ctx_status, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_ctx_status, %i[pointer pointer], :bool
 
       # @!method self.mongocrypt_ctx_setopt_key_id(ctx, key_id)
       #   @api private
@@ -456,7 +454,7 @@ module Mongo
       #     that references the 16-byte key-id.
       #   @note Do not initialize ctx before calling this method.
       #   @return [ Boolean ] Whether the option was successfully set.
-      attach_function :mongocrypt_ctx_setopt_key_id, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_ctx_setopt_key_id, %i[pointer pointer], :bool
 
       # Sets the key id option on an explicit encryption context.
       #
@@ -486,7 +484,7 @@ module Mongo
       #   @note Do not initialize ctx before calling this method.
       attach_function(
         :mongocrypt_ctx_setopt_key_alt_name,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -499,7 +497,7 @@ module Mongo
       #   not valid UTF8 strings
       def self.ctx_setopt_key_alt_names(context, key_alt_names)
         key_alt_names.each do |key_alt_name|
-          key_alt_name_bson = { :keyAltName => key_alt_name }.to_bson.to_s
+          key_alt_name_bson = { keyAltName: key_alt_name }.to_bson.to_s
 
           Binary.wrap_string(key_alt_name_bson) do |key_alt_name_p|
             check_ctx_status(context) do
@@ -521,7 +519,7 @@ module Mongo
       #   @note Do not initialize ctx before calling this method.
       attach_function(
         :mongocrypt_ctx_setopt_key_material,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -533,7 +531,7 @@ module Mongo
       #
       # @raise [ Mongo::Error::CryptError ] If the key material is not 96 bytes.
       def self.ctx_setopt_key_material(context, key_material)
-        data = {'keyMaterial' => key_material}.to_bson.to_s
+        data = { 'keyMaterial' => key_material }.to_bson.to_s
         Binary.wrap_string(data) do |data_p|
           check_ctx_status(context) do
             mongocrypt_ctx_setopt_key_material(context.ctx_p, data_p)
@@ -554,7 +552,7 @@ module Mongo
       #   @return [ Boolean ] Whether the option was successfully set.
       attach_function(
         :mongocrypt_ctx_setopt_algorithm,
-        [:pointer, :string, :int],
+        %i[pointer string int],
         :bool
       )
 
@@ -584,7 +582,7 @@ module Mongo
       #   @return [ Boolean ] Whether the option was successfully set.
       attach_function(
         :mongocrypt_ctx_setopt_key_encryption_key,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -615,7 +613,7 @@ module Mongo
       #     and mongocrypt_ctx_setopt_masterkey_aws_endpoint. Set local master
       #     key by calling mongocrypt_ctx_setopt_masterkey_local.
       #   @return [ Boolean ] Whether the initialization was successful.
-      attach_function :mongocrypt_ctx_datakey_init, [:pointer], :bool
+      attach_function :mongocrypt_ctx_datakey_init, [ :pointer ], :bool
 
       # Initialize the Context to create a data key
       #
@@ -641,7 +639,7 @@ module Mongo
       # @return [ Boolean ] Whether the initialization was successful.
       attach_function(
         :mongocrypt_ctx_rewrap_many_datakey_init,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -677,7 +675,7 @@ module Mongo
       #   @return [ Boolean ] Whether the initialization was successful.
       attach_function(
         :mongocrypt_ctx_encrypt_init,
-        [:pointer, :string, :int, :pointer],
+        %i[pointer string int pointer],
         :bool
       )
 
@@ -713,7 +711,7 @@ module Mongo
       #   @return [ Boolean ] Whether the initialization was successful.
       attach_function(
         :mongocrypt_ctx_explicit_encrypt_init,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -747,7 +745,7 @@ module Mongo
       #   @return [ Boolean ] Whether the initialization was successful.
       attach_function(
         :mongocrypt_ctx_explicit_encrypt_expression_init,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -775,7 +773,7 @@ module Mongo
       #   @param [ FFI::Pointer ] doc A pointer to a mongocrypt_binary_t object
       #     that references the document to be decrypted as a BSON binary string.
       #   @return [ Boolean ] Whether the initialization was successful.
-      attach_function :mongocrypt_ctx_decrypt_init, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_ctx_decrypt_init, %i[pointer pointer], :bool
 
       # Initialize the Context for auto-decryption
       #
@@ -803,7 +801,7 @@ module Mongo
       #   @return [ Boolean ] Whether the initialization was successful.
       attach_function(
         :mongocrypt_ctx_explicit_decrypt_init,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :bool
       )
 
@@ -842,7 +840,7 @@ module Mongo
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @return [ Symbol ] The current state, will be one of the values defined
       #     by the mongocrypt_ctx_state enum.
-      attach_function :mongocrypt_ctx_state, [:pointer], :mongocrypt_ctx_state
+      attach_function :mongocrypt_ctx_state, [ :pointer ], :mongocrypt_ctx_state
 
       # @!method self.mongocrypt_ctx_mongo_op(ctx, op_bson)
       #   @api private
@@ -854,7 +852,7 @@ module Mongo
       #     mongocrypt_binary_t object that will have a reference to the
       #     BSON operation written to it by libmongocrypt.
       #   @return [ Boolean ] A boolean indicating the success of the operation.
-      attach_function :mongocrypt_ctx_mongo_op, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_ctx_mongo_op, %i[pointer pointer], :bool
 
       # Returns a BSON::Document representing an operation that the
       # driver must perform on behalf of libmongocrypt to get the
@@ -872,7 +870,7 @@ module Mongo
           mongocrypt_ctx_mongo_op(context.ctx_p, binary.ref)
         end
 
-        # TODO since the binary references a C pointer, and ByteBuffer is
+        # TODO: since the binary references a C pointer, and ByteBuffer is
         # written in C in MRI, we could omit a copy of the data by making
         # ByteBuffer reference the string that is owned by libmongocrypt.
         BSON::Document.from_bson(BSON::ByteBuffer.new(binary.to_s), mode: :bson)
@@ -886,7 +884,7 @@ module Mongo
       #   @param [ FFI::Pointer ] reply A mongocrypt_binary_t object that
       #     references the BSON reply to feed to libmongocrypt.
       #   @return [ Boolean ] A boolean indicating the success of the operation.
-      attach_function :mongocrypt_ctx_mongo_feed, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_ctx_mongo_feed, %i[pointer pointer], :bool
 
       # Feed a response from the driver back to libmongocrypt
       #
@@ -910,7 +908,7 @@ module Mongo
       #   Indicate to libmongocrypt that the driver is done feeding replies.
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @return [ Boolean ] A boolean indicating the success of the operation.
-      attach_function :mongocrypt_ctx_mongo_done, [:pointer], :bool
+      attach_function :mongocrypt_ctx_mongo_done, [ :pointer ], :bool
 
       # @!method self.mongocrypt_ctx_mongo_next_kms_ctx(ctx)
       #   @api private
@@ -918,7 +916,7 @@ module Mongo
       #   Return a pointer to a mongocrypt_kms_ctx_t object or NULL.
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @return [ FFI::Pointer ] A pointer to a mongocrypt_kms_ctx_t object.
-      attach_function :mongocrypt_ctx_next_kms_ctx, [:pointer], :pointer
+      attach_function :mongocrypt_ctx_next_kms_ctx, [ :pointer ], :pointer
 
       # Return a new KmsContext object needed by a Context object.
       #
@@ -954,7 +952,7 @@ module Mongo
       # "kmip".
       attach_function(
         :mongocrypt_kms_ctx_get_kms_provider,
-        [:pointer, :pointer],
+        %i[pointer pointer],
         :pointer
       )
 
@@ -977,13 +975,13 @@ module Mongo
           nil
         else
           len = if BSON::Environment.jruby?
-            # JRuby FFI implementation does not have `read(type)` method, but it
-            # has this `get_uint32`.
-            len_ptr.get_uint32
-          else
-            # For MRI we use a documented `read` method - https://www.rubydoc.info/github/ffi/ffi/FFI%2FPointer:read
-            len_ptr.read(:uint32)
-          end
+                  # JRuby FFI implementation does not have `read(type)` method, but it
+                  # has this `get_uint32`.
+                  len_ptr.get_uint32
+                else
+                  # For MRI we use a documented `read` method - https://www.rubydoc.info/github/ffi/ffi/FFI%2FPointer:read
+                  len_ptr.read(:uint32)
+                end
           provider.read_string(len).to_sym
         end
       end
@@ -997,7 +995,7 @@ module Mongo
       #     object that will have the location of the message written to it by
       #     libmongocrypt.
       #   @return [ Boolean ] Whether the operation is successful.
-      attach_function :mongocrypt_kms_ctx_message, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_kms_ctx_message, %i[pointer pointer], :bool
 
       # Get the HTTP message needed to fetch the AWS KMS master key from a
       # KmsContext object.
@@ -1014,7 +1012,7 @@ module Mongo
           mongocrypt_kms_ctx_message(kms_context.kms_ctx_p, binary.ref)
         end
 
-        return binary.to_s
+        binary.to_s
       end
 
       # @!method self.mongocrypt_kms_ctx_endpoint(kms, endpoint)
@@ -1026,7 +1024,7 @@ module Mongo
       #   @param [ FFI::Pointer ] endpoint (out param) A pointer to which the
       #     endpoint string will be written by libmongocrypt.
       #   @return [ Boolean ] Whether the operation was successful.
-      attach_function :mongocrypt_kms_ctx_endpoint, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_kms_ctx_endpoint, %i[pointer pointer], :bool
 
       # Get the hostname with which to connect over TLS to get information
       # about the AWS master key.
@@ -1053,7 +1051,7 @@ module Mongo
       #   Get the number of bytes needed by the KMS context.
       #   @param [ FFI::Pointer ] kms The mongocrypt_kms_ctx_t object.
       #   @return [ Integer ] The number of bytes needed.
-      attach_function :mongocrypt_kms_ctx_bytes_needed, [:pointer], :int
+      attach_function :mongocrypt_kms_ctx_bytes_needed, [ :pointer ], :int
 
       # Get the number of bytes needed by the KmsContext.
       #
@@ -1072,7 +1070,7 @@ module Mongo
       #   @param [ FFI::Pointer ] bytes A pointer to a mongocrypt_binary_t
       #     object that references the response from the KMS.
       #   @return [ Boolean ] Whether the operation was successful.
-      attach_function :mongocrypt_kms_ctx_feed, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_kms_ctx_feed, %i[pointer pointer], :bool
 
       # Feed replies from the KMS back to libmongocrypt.
       #
@@ -1096,7 +1094,7 @@ module Mongo
       #   @param [ FFI::Pointer ] kms A pointer to the mongocrypt_kms_ctx_t object.
       #   @param [ FFI::Pointer ] status A pointer to a mongocrypt_status_t object.
       #   @return [ Boolean ] Whether the operation was successful.
-      attach_function :mongocrypt_kms_ctx_status, [:pointer, :pointer], :bool
+      attach_function :mongocrypt_kms_ctx_status, %i[pointer pointer], :bool
 
       # If the provided block returns false, raise a CryptError with the
       # status information from the provided KmsContext object.
@@ -1105,12 +1103,12 @@ module Mongo
       #
       # @raise [ Mongo::Error::CryptError ] If the provided block returns false
       def self.check_kms_ctx_status(kms_context)
-        unless yield
-          status = Status.new
+        return if yield
 
-          mongocrypt_kms_ctx_status(kms_context.kms_ctx_p, status.ref)
-          status.raise_crypt_error(kms: true)
-        end
+        status = Status.new
+
+        mongocrypt_kms_ctx_status(kms_context.kms_ctx_p, status.ref)
+        status.raise_crypt_error(kms: true)
       end
 
       # @!method self.mongocrypt_kms_ctx_usleep(ctx)
@@ -1120,7 +1118,7 @@ module Mongo
       #
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @return [ int64 ] A 64-bit encoded number of microseconds of how long to sleep.
-      attach_function :mongocrypt_kms_ctx_usleep, [:pointer], :int64
+      attach_function :mongocrypt_kms_ctx_usleep, [ :pointer ], :int64
 
       # Returns number of milliseconds to sleep before sending KMS request
       # for the given KMS context.
@@ -1139,7 +1137,7 @@ module Mongo
       #
       # @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       # @return [ Boolean ] whether the failed request may be retried.
-      attach_function :mongocrypt_kms_ctx_fail, [:pointer], :bool
+      attach_function :mongocrypt_kms_ctx_fail, [ :pointer ], :bool
 
       # Check whether the last failed request for the KMS context may be retried.
       #
@@ -1157,7 +1155,7 @@ module Mongo
       # @param [ FFI::Pointer ] crypt A pointer to a mongocrypt_t object
       # @param [ Boolean ] enable A boolean indicating whether to retry operations.
       # @return [ Boolean ] indicating success.
-      attach_function :mongocrypt_setopt_retry_kms, [:pointer, :bool], :bool
+      attach_function :mongocrypt_setopt_retry_kms, %i[pointer bool], :bool
 
       # Enable or disable KMS retry behavior.
       #
@@ -1168,7 +1166,6 @@ module Mongo
         mongocrypt_setopt_retry_kms(handle.ref, value)
       end
 
-
       # @!method self.mongocrypt_kms_ctx_done(ctx)
       #   @api private
       #
@@ -1176,7 +1173,7 @@ module Mongo
       #     mongocrypt_kms_ctx_t objects.
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @return [ Boolean ] Whether the operation was successful.
-      attach_function :mongocrypt_ctx_kms_done, [:pointer], :bool
+      attach_function :mongocrypt_ctx_kms_done, [ :pointer ], :bool
 
       # Indicate to libmongocrypt that it will receive no more KMS replies.
       #
@@ -1198,7 +1195,7 @@ module Mongo
       #     mongocrypt_binary_t object that will have a reference to the
       #     final encrypted BSON document.
       #   @return [ Boolean ] A boolean indicating the success of the operation.
-      attach_function :mongocrypt_ctx_finalize, [:pointer, :pointer], :void
+      attach_function :mongocrypt_ctx_finalize, %i[pointer pointer], :void
 
       # Finalize the state machine represented by the Context
       #
@@ -1213,10 +1210,10 @@ module Mongo
           mongocrypt_ctx_finalize(context.ctx_p, binary.ref)
         end
 
-        # TODO since the binary references a C pointer, and ByteBuffer is
+        # TODO: since the binary references a C pointer, and ByteBuffer is
         # written in C in MRI, we could omit a copy of the data by making
         # ByteBuffer reference the string that is owned by libmongocrypt.
-        BSON::Document.from_bson(BSON::ByteBuffer.new(binary.to_s), mode: :bson)
+        BSON::Document.from_bson(BSON::ByteBuffer.new(binary.to_s), mode: context.bson_mode)
       end
 
       # @!method self.mongocrypt_ctx_destroy(ctx)
@@ -1225,7 +1222,7 @@ module Mongo
       #   Destroy the reference to the mongocrypt_ctx_t object.
       #   @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_ctx_t object.
       #   @return [ nil ] Always nil.
-      attach_function :mongocrypt_ctx_destroy, [:pointer], :void
+      attach_function :mongocrypt_ctx_destroy, [ :pointer ], :void
 
       # @!method mongocrypt_crypto_fn(ctx, key, iv, input, output, status)
       #   @api private
@@ -1250,7 +1247,7 @@ module Mongo
       #     an instance method on the Binding class.
       callback(
         :mongocrypt_crypto_fn,
-        [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer, :pointer],
+        %i[pointer pointer pointer pointer pointer pointer pointer],
         :bool
       )
 
@@ -1275,7 +1272,7 @@ module Mongo
       #     an instance method on the Binding class.
       callback(
         :mongocrypt_hmac_fn,
-        [:pointer, :pointer, :pointer, :pointer, :pointer],
+        %i[pointer pointer pointer pointer pointer],
         :bool
       )
 
@@ -1296,7 +1293,7 @@ module Mongo
       #
       #   @note This defines a method signature for an FFI callback; it is not
       #     an instance method on the Binding class.
-      callback :mongocrypt_hash_fn, [:pointer, :pointer, :pointer, :pointer], :bool
+      callback :mongocrypt_hash_fn, %i[pointer pointer pointer pointer], :bool
 
       # @!method mongocrypt_random_fn(ctx, output, count, status)
       #   @api private
@@ -1314,7 +1311,7 @@ module Mongo
       #
       #   @note This defines a method signature for an FFI callback; it is not
       #     an instance method on the Binding class.
-      callback :mongocrypt_random_fn, [:pointer, :pointer, :int, :pointer], :bool
+      callback :mongocrypt_random_fn, %i[pointer pointer int pointer], :bool
 
       # @!method self.mongocrypt_setopt_crypto_hooks(crypt, aes_enc_fn, aes_dec_fn, random_fn, sha_512_fn, sha_256_fn, hash_fn, ctx=nil)
       #   @api private
@@ -1332,15 +1329,15 @@ module Mongo
       #   @return [ Boolean ] Whether setting this option succeeded.
       attach_function(
         :mongocrypt_setopt_crypto_hooks,
-        [
-          :pointer,
-          :mongocrypt_crypto_fn,
-          :mongocrypt_crypto_fn,
-          :mongocrypt_random_fn,
-          :mongocrypt_hmac_fn,
-          :mongocrypt_hmac_fn,
-          :mongocrypt_hash_fn,
-          :pointer
+        %i[
+          pointer
+          mongocrypt_crypto_fn
+          mongocrypt_crypto_fn
+          mongocrypt_random_fn
+          mongocrypt_hmac_fn
+          mongocrypt_hmac_fn
+          mongocrypt_hash_fn
+          pointer
         ],
         :bool
       )
@@ -1357,14 +1354,12 @@ module Mongo
       #
       # @raise [ Mongo::Error::CryptError ] If the callbacks aren't set successfully
       def self.setopt_crypto_hooks(handle,
-        aes_encrypt_cb, aes_decrypt_cb, random_cb,
-        hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb
-      )
+                                   aes_encrypt_cb, aes_decrypt_cb, random_cb,
+                                   hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb)
         check_status(handle) do
           mongocrypt_setopt_crypto_hooks(handle.ref,
-            aes_encrypt_cb, aes_decrypt_cb, random_cb,
-            hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb, nil
-          )
+                                         aes_encrypt_cb, aes_decrypt_cb, random_cb,
+                                         hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb, nil)
         end
       end
 
@@ -1379,10 +1374,10 @@ module Mongo
       #   @return [ Boolean ] Whether setting this option succeeded.
       attach_function(
         :mongocrypt_setopt_crypto_hook_sign_rsaes_pkcs1_v1_5,
-        [
-          :pointer,
-          :mongocrypt_hmac_fn,
-          :pointer
+        %i[
+          pointer
+          mongocrypt_hmac_fn
+          pointer
         ],
         :bool
       )
@@ -1421,9 +1416,9 @@ module Mongo
       # @return [ Boolean ] Whether the operation succeeded.
       attach_function(
         :mongocrypt_setopt_encrypted_field_config_map,
-        [
-          :pointer,
-          :pointer
+        %i[
+          pointer
+          pointer
         ],
         :bool
       )
@@ -1460,7 +1455,7 @@ module Mongo
       # - A mongocrypt_ctx_t will never enter the MONGOCRYPT_CTX_NEED_MARKINGS state.
       #
       # @param [ FFI::Pointer ] crypt A pointer to a mongocrypt_t object.
-      attach_function(:mongocrypt_setopt_bypass_query_analysis, [:pointer], :void)
+      attach_function(:mongocrypt_setopt_bypass_query_analysis, [ :pointer ], :void)
 
       # Opt-into skipping query analysis.
       #
@@ -1486,11 +1481,11 @@ module Mongo
       #   @return [ Boolean ] Whether setting this option succeeded.
       attach_function(
         :mongocrypt_setopt_aes_256_ctr,
-        [
-          :pointer,
-          :mongocrypt_crypto_fn,
-          :mongocrypt_crypto_fn,
-          :pointer
+        %i[
+          pointer
+          mongocrypt_crypto_fn
+          mongocrypt_crypto_fn
+          pointer
         ],
         :bool
       )
@@ -1505,8 +1500,7 @@ module Mongo
       def self.setopt_aes_256_ctr(handle, aes_ctr_encrypt_cb, aes_ctr_decrypt_cb)
         check_status(handle) do
           mongocrypt_setopt_aes_256_ctr(handle.ref,
-            aes_ctr_encrypt_cb, aes_ctr_decrypt_cb, nil
-          )
+                                        aes_ctr_encrypt_cb, aes_ctr_decrypt_cb, nil)
         end
       end
 
@@ -1524,9 +1518,9 @@ module Mongo
       #   system's library resolution mechanism to find the crypt_shared library.
       attach_function(
         :mongocrypt_setopt_append_crypt_shared_lib_search_path,
-        [
-          :pointer,
-          :string,
+        %i[
+          pointer
+          string
         ],
         :void
       )
@@ -1553,9 +1547,9 @@ module Mongo
       #   with the directory path containing the executable libmongocrypt module.
       attach_function(
         :mongocrypt_setopt_set_crypt_shared_lib_path_override,
-        [
-          :pointer,
-          :string,
+        %i[
+          pointer
+          string
         ],
         :void
       )
@@ -1669,7 +1663,7 @@ module Mongo
       # @returns [ true | false ] Returns whether the options was set successfully.
       attach_function(
         :mongocrypt_ctx_provide_kms_providers,
-        [ :pointer, :pointer ],
+        %i[pointer pointer],
         :bool
       )
 
@@ -1707,10 +1701,10 @@ module Mongo
       # @return [ Boolean ] Whether setting this option succeeded.
       attach_function(
         :mongocrypt_ctx_setopt_query_type,
-        [
-          :pointer,
-          :string,
-          :int
+        %i[
+          pointer
+          string
+          int
         ],
         :bool
       )
@@ -1740,9 +1734,9 @@ module Mongo
       # @return [ Boolean ] Whether setting this option succeeded.
       attach_function(
         :mongocrypt_ctx_setopt_contention_factor,
-        [
-          :pointer,
-          :int64
+        %i[
+          pointer
+          int64
         ],
         :bool
       )
@@ -1775,9 +1769,9 @@ module Mongo
       # @return [ Boolean ] Whether setting this option succeeded.
       attach_function(
         :mongocrypt_ctx_setopt_algorithm_range,
-        [
-          :pointer,
-          :pointer
+        %i[
+          pointer
+          pointer
         ],
         :bool
       )
@@ -1806,12 +1800,12 @@ module Mongo
       #
       # @return [ nil ] Always nil.
       def self.check_status(handle)
-        unless yield
-          status = Status.new
+        return if yield
 
-          mongocrypt_status(handle.ref, status.ref)
-          status.raise_crypt_error
-        end
+        status = Status.new
+
+        mongocrypt_status(handle.ref, status.ref)
+        status.raise_crypt_error
       end
 
       # Raise a Mongo::Error::CryptError based on the status of the underlying
@@ -1819,18 +1813,18 @@ module Mongo
       #
       # @return [ nil ] Always nil.
       def self.check_ctx_status(context)
-        if block_given?
-          do_raise = !yield
-        else
-          do_raise = true
-        end
+        do_raise = if block_given?
+                     !yield
+                   else
+                     true
+                   end
 
-        if do_raise
-          status = Status.new
+        return unless do_raise
 
-          mongocrypt_ctx_status(context.ctx_p, status.ref)
-          status.raise_crypt_error
-        end
+        status = Status.new
+
+        mongocrypt_ctx_status(context.ctx_p, status.ref)
+        status.raise_crypt_error
       end
 
       # Checks that the specified data is a Hash before serializing
@@ -1844,13 +1838,13 @@ module Mongo
       def self.validate_document(data)
         return if data.is_a?(Hash)
 
-        if data.nil?
-          message = "Attempted to pass nil data to libmongocrypt. " +
-            "Data must be a Hash"
-        else
-          message = "Attempted to pass invalid data to libmongocrypt: #{data} " +
-            "Data must be a Hash"
-        end
+        message = if data.nil?
+                    'Attempted to pass nil data to libmongocrypt. ' +
+                      'Data must be a Hash'
+                  else
+                    "Attempted to pass invalid data to libmongocrypt: #{data} " +
+                      'Data must be a Hash'
+                  end
 
         raise Error::CryptError.new(message)
       end