mongo 2.15.1 → 2.16.0.alpha1

data/lib/mongo/collection/view/builder/find_command.rb

@@ -1,173 +0,0 @@
-# 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
-  class Collection
-    class View
-      module Builder
-
-        # Builds a find command specification from options.
-        #
-        # @since 2.2.0
-        class FindCommand
-          extend Forwardable
-
-          # The mappings from ruby options to the find command.
-          #
-          # @since 2.2.0
-          MAPPINGS = BSON::Document.new(
-            sort: 'sort',
-            projection: 'projection',
-            hint: 'hint',
-            skip: 'skip',
-            limit: 'limit',
-            batch_size: 'batchSize',
-            single_batch: 'singleBatch',
-            comment: 'comment',
-            max_scan: 'maxScan',
-            max_time_ms: 'maxTimeMS',
-            max_value: 'max',
-            min_value: 'min',
-            return_key: 'returnKey',
-            show_disk_loc: 'showRecordId',
-            snapshot: 'snapshot',
-            tailable: 'tailable',
-            tailable_cursor: 'tailable',
-            oplog_replay: 'oplogReplay',
-            no_cursor_timeout: 'noCursorTimeout',
-            await_data: 'awaitData',
-            allow_partial_results: 'allowPartialResults',
-            allow_disk_use: 'allowDiskUse',
-            collation: 'collation'
-          ).freeze
-
-          # Create the find command builder.
-          #
-          # @example Create the find command builder.
-          #   FindCommandBuilder.new(view)
-          #
-          # @param [ Collection::View ] view The collection view.
-          # @param [ Session ] session The session.
-          #
-          # @since 2.2.2
-          def initialize(view, session)
-            @view = view
-            @session = session
-          end
-
-          def_delegators :@view, :collection, :database, :filter, :options, :read
-
-          # Get the specification to pass to the find command operation.
-          #
-          # @example Get the specification.
-          #   builder.specification
-          #
-          # @return [ Hash ] The specification.
-          #
-          # @since 2.2.0
-          def specification
-            {
-              selector: find_command,
-              db_name: database.name,
-              read: read,
-              session: @session,
-            }
-          end
-
-          # Get the specification for an explain command that wraps the find
-          # command.
-          #
-          # @example Get the explain spec.
-          #   builder.explain_specification
-          #
-          # @return [ Hash ] The specification.
-          #
-          # @since 2.2.0
-          def explain_specification
-            {
-              selector: {
-                explain: find_command,
-              },
-              db_name: database.name,
-              read: read,
-              session: @session,
-              # We should always have options{:explain] set if we are explaining.
-              # The explain field is not sent to the server, it will be
-              # processed in the operation layer.
-              explain: options[:explain],
-            }
-          end
-
-          private
-
-          def find_command
-            document = BSON::Document.new(
-              find: collection.name,
-              filter: filter,
-            )
-            if collection.read_concern
-              document[:readConcern] = Options::Mapper.transform_values_to_strings(
-                collection.read_concern)
-            end
-            command = Options::Mapper.transform_documents(
-              convert_flags(options), MAPPINGS, document)
-            if command['oplogReplay']
-              log_warn("oplogReplay is deprecated and ignored by MongoDB 4.4 and later")
-            end
-            convert_limit_and_batch_size(command)
-            command
-          end
-
-          def convert_limit_and_batch_size(command)
-            if command[:limit] && command[:limit] < 0 &&
-                command[:batchSize] && command[:batchSize] < 0
-
-              command[:limit] = command[:limit].abs
-              command[:batchSize] = command[:limit].abs
-              command[:singleBatch] = true
-
-            else
-              [:limit, :batchSize].each do |opt|
-                if command[opt]
-                  if command[opt] < 0
-                    command[opt] = command[opt].abs
-                    command[:singleBatch] = true
-                  elsif command[opt] == 0
-                    command.delete(opt)
-                  end
-                end
-              end
-            end
-          end
-
-          def convert_flags(options)
-            return options if options.empty?
-            opts = options.dup
-            opts.delete(:cursor_type)
-            Flags.map_flags(options).reduce(opts) do |o, key|
-              o.merge!(key => true)
-            end
-          end
-
-          def log_warn(*args)
-            database.client.log_warn(*args)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongo/collection/view/builder/op_query.rb

@@ -1,94 +0,0 @@
-# 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
-  class Collection
-    class View
-      module Builder
-
-        # Builds a legacy OP_QUERY specification from options.
-        #
-        # @since 2.2.0
-        class OpQuery
-          extend Forwardable
-
-          def_delegators :@view, :cluster, :collection, :database, :filter, :options, :read
-
-          # @return [ BSON::Document ] modifiers The server modifiers.
-          attr_reader :modifiers
-
-          # Create the new legacy query builder.
-          #
-          # @example Create the query builder.
-          #   QueryBuilder.new(view)
-          #
-          # @param [ Collection::View ] view The collection view.
-          #
-          # @since 2.2.2
-          def initialize(view)
-            @view = view
-            @modifiers = Modifiers.map_server_modifiers(options)
-          end
-
-          def specification
-            {
-              :selector  => requires_special_filter? ? special_filter : filter,
-              :read      => read,
-              :options   => query_options,
-              :db_name   => database.name,
-              :coll_name => collection.name
-            }
-          end
-
-          private
-
-          def query_options
-            BSON::Document.new(
-              project: options[:projection],
-              skip: options[:skip],
-              limit: options[:limit],
-              flags: Flags.map_flags(options),
-              batch_size: options[:batch_size]
-            )
-          end
-
-          def requires_special_filter?
-            !modifiers.empty? || cluster.sharded?
-          end
-
-          def read_pref_formatted
-            @read_formatted ||= begin
-              if read
-                read_pref = ServerSelector.get(read).to_mongos
-                Mongo::Lint.validate_camel_case_read_preference(read_pref)
-                read_pref
-              else
-                nil
-              end
-            end
-          end
-
-          def special_filter
-            sel = BSON::Document.new(:$query => filter).merge!(modifiers)
-            sel[:$readPreference] = read_pref_formatted unless read_pref_formatted.nil?
-            sel
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongo/cursor/builder/get_more_command.rb

@@ -1,80 +0,0 @@
-# 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
-  class Cursor
-    module Builder
-
-      # Generates a specification for a get more command.
-      #
-      # @since 2.2.0
-      class GetMoreCommand
-        extend Forwardable
-
-        # @return [ Cursor ] cursor The cursor.
-        attr_reader :cursor
-
-        def_delegators :@cursor, :collection_name, :database, :view
-        def_delegators :view, :batch_size
-
-        # Create the new builder.
-        #
-        # @example Create the builder.
-        #   GetMoreCommand.new(cursor)
-        #
-        # @param [ Cursor ] cursor The cursor.
-        # @param [ Session ] session The session.
-        #
-        # @since 2.2.0
-        def initialize(cursor, session = nil)
-          @cursor = cursor
-          @session = session
-        end
-
-        # Get the specification.
-        #
-        # @example Get the specification.
-        #   get_more_command.specification
-        #
-        # @return [ Hash ] The spec.
-        #
-        # @since 2.2.0
-        def specification
-          { selector: get_more_command, db_name: database.name, session: @session }
-        end
-
-        private
-
-        def get_more_command
-          command = {
-            :getMore => BSON::Int64.new(cursor.id),
-            :collection => collection_name,
-          }
-          command[:batchSize] = batch_size.abs if batch_size && batch_size != 0
-          # If the max_await_time_ms option is set, then we set maxTimeMS on
-          # the get more command.
-          if view.respond_to?(:max_await_time_ms)
-            if view.max_await_time_ms && view.options[:await_data]
-              command[:maxTimeMS] = view.max_await_time_ms
-            end
-          end
-          command
-        end
-      end
-    end
-  end
-end

data/lib/mongo/cursor/builder/kill_cursors_command.rb

@@ -1,111 +0,0 @@
-# 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
-  class Cursor
-    module Builder
-
-      # Generates a specification for a kill cursors command.
-      #
-      # @since 2.2.0
-      class KillCursorsCommand
-        extend Forwardable
-
-        # @return [ Cursor ] cursor The cursor.
-        attr_reader :cursor
-
-        def_delegators :@cursor, :collection_name, :database
-
-        # Create the new builder.
-        #
-        # @example Create the builder.
-        #   KillCursorsCommand.new(cursor)
-        #
-        # @param [ Cursor ] cursor The cursor.
-        #
-        # @since 2.2.0
-        def initialize(cursor)
-          @cursor = cursor
-        end
-
-        # Get the specification.
-        #
-        # @example Get the specification.
-        #   kill_cursors_command.specification
-        #
-        # @return [ Hash ] The spec.
-        #
-        # @since 2.2.0
-        def specification
-          { selector: kill_cursors_command, db_name: database.name }
-        end
-
-        private
-
-        def kill_cursors_command
-          {
-            killCursors: collection_name,
-            cursors: [ BSON::Int64.new(cursor.id) ],
-          }
-        end
-
-        class << self
-
-          # Update a specification's list of cursor ids.
-          #
-          # @example Update a specification's list of cursor ids.
-          #   KillCursorsCommand.update_cursors(spec, ids)
-          #
-          # @return [ Hash ] The specification.
-          # @return [ Array<Integer> ] The ids to update with.
-          #
-          # @since 2.3.0
-          def update_cursors(spec, ids)
-            # Ruby 2.5+ can & BSON::Int64 instances.
-            # Ruby 2.4 and earlier cannot.
-            # Convert stored ids to Ruby integers for compatibility with
-            # older Rubies.
-            ids = get_cursors_list(spec) & ids
-            ids = ids.map do |cursor_id|
-              BSON::Int64.new(cursor_id)
-            end
-            spec[:selector].merge!(cursors: ids)
-          end
-
-          # Get the list of cursor ids from a spec generated by this Builder.
-          #
-          # @example Get the list of cursor ids.
-          #   KillCursorsCommand.cursors(spec)
-          #
-          # @return [ Array<Integer> ] The cursor ids.
-          #
-          # @since 2.3.0
-          def get_cursors_list(spec)
-            spec[:selector][:cursors].map do |value|
-              if value.respond_to?(:value)
-                # bson-ruby >= 4.6.0
-                value = value.value
-              else
-                value = value.instance_variable_get('@integer')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongo/cursor/builder/op_get_more.rb

@@ -1,64 +0,0 @@
-# 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
-  class Cursor
-    module Builder
-
-      # Encapsulates behavior around generating an OP_GET_MORE specification.
-      #
-      # @since 2.2.0
-      class OpGetMore
-        extend Forwardable
-
-        # @return [ Cursor ] cursor The cursor.
-        attr_reader :cursor
-
-        def_delegators :@cursor, :collection_name, :database, :to_return
-
-        # Create the new builder.
-        #
-        # @example Create the builder.
-        #   OpGetMore.new(cursor)
-        #
-        # @param [ Cursor ] cursor The cursor.
-        #
-        # @since 2.2.0
-        def initialize(cursor)
-          @cursor = cursor
-        end
-
-        # Get the specification.
-        #
-        # @example Get the specification.
-        #   op_get_more.specification
-        #
-        # @return [ Hash ] The specification.
-        #
-        # @since 2.2.0
-        def specification
-          {
-            :to_return => to_return,
-            :cursor_id => BSON::Int64.new(cursor.id),
-            :db_name   => database.name,
-            :coll_name => collection_name,
-          }
-        end
-      end
-    end
-  end
-end

data/lib/mongo/cursor/builder/op_kill_cursors.rb

@@ -1,106 +0,0 @@
-# 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
-  class Cursor
-    module Builder
-
-      # Encapsulates behavior around generating an OP_KILL_CURSORS specification.
-      #
-      # @since 2.2.0
-      class OpKillCursors
-        extend Forwardable
-
-        # @return [ Cursor ] cursor The cursor.
-        attr_reader :cursor
-
-        def_delegators :@cursor, :collection_name, :database
-
-        # Create the new builder.
-        #
-        # @example Create the builder.
-        #   OpKillCursors.new(cursor)
-        #
-        # @param [ Cursor ] cursor The cursor.
-        #
-        # @since 2.2.0
-        def initialize(cursor)
-          @cursor = cursor
-        end
-
-        # Get the specification.
-        #
-        # @example Get the specification.
-        #   op_kill_cursors.specification
-        #
-        # @return [ Hash ] The specification.
-        #
-        # @since 2.2.0
-        def specification
-          {
-            coll_name: collection_name,
-            db_name: database.name,
-            cursor_ids: [ BSON::Int64.new(cursor.id) ],
-          }
-        end
-
-        class << self
-
-          # Update a specification's list of cursor ids.
-          #
-          # @example Update a specification's list of cursor ids.
-          #   OpKillCursors.update_cursors(spec, ids)
-          #
-          # @return [ Hash ] The specification.
-          # @return [ Array<Integer> ] The ids to update with.
-          #
-          # @since 2.3.0
-          def update_cursors(spec, ids)
-            # Ruby 2.5+ can & BSON::Int64 instances.
-            # Ruby 2.4 and earlier cannot.
-            # Convert stored ids to Ruby integers for compatibility with
-            # older Rubies.
-            ids = get_cursors_list(spec) & ids
-            ids = ids.map do |cursor_id|
-              BSON::Int64.new(cursor_id)
-            end
-            spec.merge!(cursor_ids: ids)
-          end
-
-          # Get the list of cursor ids from a spec generated by this Builder.
-          #
-          # @example Get the list of cursor ids.
-          #   OpKillCursors.cursors(spec)
-          #
-          # @return [ Array<Integer> ] The cursor ids.
-          #
-          # @since 2.3.0
-          def get_cursors_list(spec)
-            spec[:cursor_ids].map do |value|
-              if value.respond_to?(:value)
-                # bson-ruby >= 4.6.0
-                value.value
-              else
-                value.instance_variable_get('@integer')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongo/server/context.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-# Copyright (C) 2014-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
-  class Server
-
-    # Represents a context in which messages are sent to the server on a
-    # connection.
-    #
-    # @since 2.0.0
-    #
-    # @deprecated Will be removed in version 3.0
-    class Context
-      extend Forwardable
-
-      # Instantiate a server context.
-      #
-      # @example Instantiate a server context.
-      #   Mongo::Server::Context.new(server)
-      #
-      # @param [ Mongo::Server ] server The server the context is for.
-      #
-      # @since 2.0.0
-      def initialize(server)
-        @server = server
-      end
-
-      # @return [ Mongo::Server ] server The server the context is for.
-      attr_reader :server
-
-      # Delegate state checks to the server.
-      def_delegators :@server,
-                     :cluster,
-                     :features,
-                     :max_wire_version,
-                     :max_write_batch_size,
-                     :mongos?,
-                     :primary?,
-                     :secondary?,
-                     :standalone?
-
-      # Execute a block of code with a connection, that is checked out of the
-      # pool and then checked back in.
-      #
-      # @example Send a message with the connection.
-      #   context.with_connection do |connection|
-      #     connection.dispatch([ command ])
-      #   end
-      #
-      # @return [ Object ] The result of the block execution.
-      #
-      # @since 2.0.0
-      def with_connection(&block)
-        server.pool.with_connection(&block)
-      end
-    end
-  end
-end