mongo 1.12.5 → 2.0.0

data/lib/mongo/operation/write/drop_index.rb

@@ -0,0 +1,62 @@
+# Copyright (C) 2014-2015 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
+
+      # A MongoDB drop index operation.
+      #
+      # @example Create the drop index operation.
+      #   Write::DropIndex.new({
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :index_name => 'name_1_age_-1'
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the drop.
+      #
+      # @option spec :index [ Hash ] The index spec to create.
+      # @option spec :db_name [ String ] The name of the database.
+      # @option spec :coll_name [ String ] The name of the collection.
+      # @option spec :index_name [ String ] The name of the index.
+      #
+      # @since 2.0.0
+      class DropIndex
+        include Executable
+        include Specifiable
+
+        # Execute the drop index operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The result of the operation.
+        #
+        # @since 2.0.0
+        def execute(context)
+          execute_write_command(context)
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::DropIndex.new(spec).execute(context)).validate!
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{utils/thread_local_variable_manager.rb → operation/write/insert/result.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# Copyright (C) 2014-2015 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,14 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#:nodoc:
 module Mongo
-  module ThreadLocalVariableManager
-    def thread_local
-      Thread.current[:mongo_thread_locals] ||= Hash.new do |hash, key|
-        hash[key] = Hash.new unless hash.key? key
-        hash[key]
+  module Operation
+    module Write
+      class Insert
+
+        # Defines custom behaviour of results for an insert.
+        #
+        # According to the CRUD spec, reporting the inserted ids
+        # is optional. It can be added to this class later, if needed.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+        end
       end
     end
   end
-end
+end

data/lib/mongo/operation/write/insert.rb

@@ -0,0 +1,90 @@
+# Copyright (C) 2014-2015 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.
+
+require 'mongo/operation/write/insert/result'
+
+module Mongo
+  module Operation
+    module Write
+
+      # A MongoDB insert operation.
+      #
+      # @note If a server with version >= 2.5.5 is being used, a write command
+      #   operation will be created and sent instead.
+      #
+      # @example Create the new insert operation.
+      #   Write::Insert.new({
+      #     :documents => [{ :foo => 1 }],
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :write_concern => write_concern
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the insert.
+      #
+      # @option spec :documents [ Array ] The documents to insert.
+      # @option spec :db_name [ String ] The name of the database.
+      # @option spec :coll_name [ String ] The name of the collection.
+      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern.
+      # @option spec :options [ Hash ] Options for the command, if it ends up being a
+      #   write command.
+      #
+      # @since 2.0.0
+      class Insert
+        include Executable
+        include Specifiable
+
+        # Execute the insert operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The operation result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::Insert.new(spec).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def initialize_copy(original)
+          @spec = original.spec.dup
+          @spec[:documents] = original.spec[:documents].dup
+        end
+
+        def message
+          opts = !!options[:continue_on_error] ? { :flags => [:continue_on_error] } : {}
+          Protocol::Insert.new(db_name, coll_name, documents, opts)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/remove_user.rb

@@ -0,0 +1,70 @@
+# Copyright (C) 2014-2015 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
+
+      # A MongoDB remove user operation.
+      #
+      # @example Create the remove user operation.
+      #   Write::RemoveUser.new(:db_name => 'test', :name => name)
+      #
+      # @param [ Hash ] spec The specifications for the remove.
+      #
+      # @option spec :name [ String ] The user name.
+      # @option spec :db_name [ String ] The name of the database.
+      #
+      # @since 2.0.0
+      class RemoveUser
+        include Executable
+        include Specifiable
+
+        # Execute the remove user operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The operation result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::RemoveUser.new(spec).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def message
+          Protocol::Delete.new(db_name, Auth::User::COLLECTION, { user: user_name })
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/update/result.rb

@@ -0,0 +1,160 @@
+# Copyright (C) 2014-2015 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
+
+          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 [ Integer ] The modified count.
+          #
+          # @since 2.0.0
+          def modified_count
+            return 0 unless acknowledged?
+            return n if updated_existing?
+            return 0 if upsert?
+            n
+          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
+
+          private
+
+          def upsert?
+            !updated_existing? && n == 1
+          end
+
+          def updated_existing?
+            first[UPDATED_EXISTING]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/update.rb

@@ -0,0 +1,103 @@
+# Copyright (C) 2014-2015 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.
+
+require 'mongo/operation/write/update/result'
+
+module Mongo
+  module Operation
+    module Write
+
+      # A MongoDB update operation.
+      #
+      # @note If the server version is >= 2.5.5, a write command operation
+      #   will be created and sent instead.
+      #
+      # @example Create the update operation.
+      #   Write::Update.new({
+      #     :update =>
+      #       {
+      #         :q => { :foo => 1 },
+      #         :u => { :$set => { :bar => 1 }},
+      #         :multi  => true,
+      #         :upsert => false
+      #       },
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :write_concern => write_concern
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the update.
+      #
+      # @option spec :update [ Hash ] The update document.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the query should be run.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the query should be run.
+      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern.
+      # @option spec :options [ Hash ] Options for the command, if it ends up being a
+      #   write command.
+      #
+      # @since 2.0.0
+      class Update
+        include Executable
+        include Specifiable
+
+        # Execute the update operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The operation result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          s = spec.merge(:updates => [ update ])
+          s.delete(:update)
+          Result.new(Command::Update.new(s).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            LegacyResult.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def initialize_copy(original)
+          @spec = original.spec.dup
+          @spec[:updates] = original.spec[:updates].dup
+        end
+
+        def message
+          flags = []
+          flags << :multi_update if update[:multi]
+          flags << :upsert if update[:upsert]
+          Protocol::Update.new(db_name, coll_name, update[:q], update[:u],
+                               flags.empty? ? {} : { flags: flags })
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{connection/socket/socket_util.rb → operation/write.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# Copyright (C) 2014-2015 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,26 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'socket'
-require 'timeout'
-
-module SocketUtil
-
-  attr_accessor :pool, :pid, :auths
-
-  def checkout
-    @pool.checkout if @pool
-  end
-
-  def checkin
-    @pool.checkin(self) if @pool
-  end
-
-  def close
-    @socket.close unless closed?
-  end
-
-  def closed?
-    @socket.closed?
-  end
-end
+require 'mongo/operation/write/bulk'
+require 'mongo/operation/write/delete'
+require 'mongo/operation/write/insert'
+require 'mongo/operation/write/update'
+require 'mongo/operation/write/create_index'
+require 'mongo/operation/write/drop_index'
+require 'mongo/operation/write/create_user'
+require 'mongo/operation/write/remove_user'
+require 'mongo/operation/write/command'

data/lib/mongo/operation.rb

@@ -0,0 +1,25 @@
+# Copyright (C) 2014-2015 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.
+
+require 'mongo/operation/result'
+require 'mongo/operation/executable'
+require 'mongo/operation/specifiable'
+require 'mongo/operation/limited'
+require 'mongo/operation/read_preferrable'
+require 'mongo/operation/read'
+require 'mongo/operation/write'
+require 'mongo/operation/aggregate'
+require 'mongo/operation/command'
+require 'mongo/operation/kill_cursors'
+require 'mongo/operation/map_reduce'

data/lib/mongo/options/mapper.rb

@@ -0,0 +1,78 @@
+# Copyright (C) 2015 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 Options
+
+    # Utility class for various options mapping behaviour.
+    #
+    # @since 2.0.0
+    module Mapper
+      extend self
+
+      # Transforms the provided options to a new set of options given the
+      # provided mapping.
+      #
+      # @example Transform the options.
+      #   Mapper.transform({ name: 1 }, { :name => :nombre })
+      #
+      # @param [ Hash ] options The options to transform
+      # @param [ Hash ] mappings The key mappings.
+      #
+      # @return [ Hash ] The transformed options.
+      #
+      # @since 2.0.0
+      def transform(options, mappings)
+        options.reduce({}) do |transformed, (key, value)|
+          transformed[mappings[key] || key] = value
+          transformed
+        end
+      end
+
+      # Coverts all the keys of the options to strings.
+      #
+      # @example Convert all option keys to strings.
+      #   Mapper.transform({ :name => 1 })
+      #
+      # @param [ Hash ] options The options to transform.
+      #
+      # @return [ Hash ] The transformed options.
+      #
+      # @since 2.0.0
+      def transform_keys_to_strings(options)
+        options.reduce({}) do |transformed, (key, value)|
+          transformed[key.to_s] = value
+          transformed
+        end
+      end
+
+      # Coverts all the symbol values to strings.
+      #
+      # @example Convert all option symbol values to strings.
+      #   Mapper.transform({ :name => 1 })
+      #
+      # @param [ Hash ] options The options to transform.
+      #
+      # @return [ Hash ] The transformed options.
+      #
+      # @since 2.0.0
+      def transform_values_to_strings(options)
+        options.reduce({}) do |transformed, (key, value)|
+          transformed[key] = value.is_a?(Symbol) ? value.to_s : value
+          transformed
+        end
+      end
+    end
+  end
+end

data/lib/mongo/options.rb

@@ -0,0 +1,15 @@
+# Copyright (C) 2015 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.
+
+require 'mongo/options/mapper'