File: result.rb

package info (click to toggle)
ruby-mongo 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,332 kB
  • sloc: ruby: 45,579; makefile: 5
file content (179 lines) | stat: -rw-r--r-- 4,748 bytes parent folder | download | duplicates (3)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# Copyright (C) 2014-2017 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
    module Write
      class Update

        # Defines custom behaviour of results for an update.
        #
        # @since 2.0.0
        class Result < Operation::Result

          # The number of modified docs field in the result.
          #
          # @since 2.0.0
          MODIFIED = 'nModified'.freeze

          # The upserted docs field in the result.
          #
          # @since 2.0.0
          UPSERTED = 'upserted'.freeze

          # Get the number of documents matched.
          #
          # @example Get the matched count.
          #   result.matched_count
          #
          # @return [ Integer ] The matched count.
          #
          # @since 2.0.0
          def matched_count
            return 0 unless acknowledged?
            if upsert?
              0
            else
              n
            end
          end

          # Get the number of documents modified.
          #
          # @example Get the modified count.
          #   result.modified_count
          #
          # @return [ Integer ] The modified count.
          #
          # @since 2.0.0
          def modified_count
            return 0 unless acknowledged?
            first[MODIFIED]
          end

          # The identifier of the inserted document if an upsert
          #   took place.
          #
          # @example Get the upserted document's identifier.
          #   result.upserted_id
          #
          # @return [ Object ] The upserted id.
          #
          # @since 2.0.0
          def upserted_id
            return nil unless upsert?
            upsert?.first['_id']
          end

          # Returns the number of documents upserted.
          #
          # @example Get the number of upserted documents.
          #   result.upserted_count
          #
          # @return [ Integer ] The number upserted.
          #
          # @since 2.4.2
          def upserted_count
            upsert? ? n : 0
          end

          private

          def upsert?
            first[UPSERTED]
          end
        end

        # Defines custom behaviour of results for an update on server
        # version <= 2.4.
        #
        # @since 2.0.0
        class LegacyResult < Operation::Result

          # Whether an existing document was updated.
          #
          # @since 2.0.0
          UPDATED_EXISTING = 'updatedExisting'.freeze

          # The upserted docs field in the result.
          #
          # @since 2.0.0
          UPSERTED = 'upserted'.freeze

          # Get the number of documents matched.
          #
          # @example Get the matched count.
          #   result.matched_count
          #
          # @return [ Integer ] The matched count.
          #
          # @since 2.0.0
          def matched_count
            return 0 unless acknowledged?
            if upsert?
              0
            else
              n
            end
          end

          # Get the number of documents modified.
          #
          # @example Get the modified count.
          #   result.modified_count
          #
          # @return [ nil ] Always omitted for legacy versions.
          #
          # @since 2.0.0
          def modified_count; end

          # The identifier of the inserted document if an upsert
          #   took place.
          #
          # @example Get the upserted document's identifier.
          #   result.upserted_id
          #
          # @return [ Object ] The upserted id.
          #
          # @since 2.0.0
          def upserted_id
            first[UPSERTED] if upsert?
          end

          # Returns the number of documents upserted.
          #
          # @example Get the number of upserted documents.
          #   result.upserted_count
          #
          # @return [ Integer ] The number upserted.
          #
          # @since 2.4.2
          def upserted_count
            upsert? ? n : 0
          end

          private

          def upsert?
            !updated_existing? && n == 1
          end

          def updated_existing?
            first[UPDATED_EXISTING]
          end
        end
      end
    end
  end
end