mongodb/mongo-ruby-driver

View on GitHub
lib/mongo/operation/shared/object_id_generator.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true
# encoding: utf-8

# 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.
# 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.

module Mongo
  module Operation

    # The default generator of ids for documents.
    #
    # @since 2.2.0
    # @api private
    class ObjectIdGenerator

      # Generate a new id.
      #
      # @example Generate the id.
      #   object_id_generator.generate
      #
      # @return [ BSON::ObjectId ] The new id.
      #
      # @since 2.2.0
      def generate
        BSON::ObjectId.new
      end
    end
  end
end