File: outcome.rb

package info (click to toggle)
ruby-mongo 2.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 14,764 kB
  • sloc: ruby: 108,806; makefile: 5; sh: 2
file content (56 lines) | stat: -rw-r--r-- 1,541 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# frozen_string_literal: true
# rubocop:todo all

# 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
  module CRUD
    class Outcome
      def initialize(spec)
        if spec.nil?
          raise ArgumentError, 'Outcome specification cannot be nil'
        end
        @result = spec['result']
        @collection = spec['collection']
        @error = spec['error']
      end

      def error?
        !!@error
      end

      def collection_data?
        !!collection_data
      end

      # The expected data in the collection as an outcome after running an
      # operation.
      #
      # @return [ Array<Hash> ] The list of documents expected to be in the collection.
      def collection_data
        @collection && @collection['data']
      end

      def collection_name
        @collection && @collection['name']
      end

      # The expected result of running an operation.
      #
      # @return [ Array<Hash> ] The expected result.
      attr_reader :result
    end
  end
end