mongo 2.0.6 → 2.1.0

data/lib/mongo/grid/stream/write.rb

@@ -0,0 +1,187 @@
+# 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 Grid
+    class FSBucket
+
+      module Stream
+        # A stream that writes files to the FSBucket.
+        #
+        # @since 2.1.0
+        class Write
+
+          # @return [ FSBucket ] fs The fs bucket to which this stream writes.
+          #
+          # @since 2.1.0
+          attr_reader :fs
+
+          # @return [ BSON::ObjectId ] file_id The id of the file being uploaded.
+          #
+          # @since 2.1.0
+          attr_reader :file_id
+
+          # @return [ String ] filename The name of the file being uploaded.
+          #
+          # @since 2.1.0
+          attr_reader :filename
+
+          # @return [ Hash ] options The write stream options.
+          #
+          # @since 2.1.0
+          attr_reader :options
+
+          # Create a stream for writing files to the FSBucket.
+          #
+          # @example Create the stream.
+          #   Stream::Write.new(fs, options)
+          #
+          # @param [ FSBucket ] fs The GridFS bucket object.
+          # @param [ Hash ] options The write stream options.
+          #
+          # @option opts [ Integer ] :chunk_size Override the default chunk size.
+          # @option opts [ Hash ] :write The write concern.
+          # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files collection document.
+          # @option opts [ String ] :content_type The content type of the file.
+          #   Deprecated, please use the metadata document instead.
+          # @option opts [ Array<String> ] :aliases A list of aliases.
+          #   Deprecated, please use the metadata document instead.
+          #
+          # @since 2.1.0
+          def initialize(fs, options)
+            @fs = fs
+            @length = 0
+            @n = 0
+            @file_id = BSON::ObjectId.new
+            @options = options
+            @filename = @options[:filename]
+            @open = true
+          end
+
+          # Write to the GridFS bucket from the source stream.
+          #
+          # @example Write to GridFS.
+          #   stream.write(io)
+          #
+          # @param [ IO ] io The source io stream to upload from.
+          #
+          # @return [ Stream::Write ] self The write stream itself.
+          #
+          # @since 2.1.0
+          def write(io)
+            ensure_open!
+            @indexes ||= ensure_indexes!
+            data = io.read
+            @length += data.length
+            chunks = File::Chunk.split(data, file_info, @n)
+            @n += chunks.size
+            chunks_collection.insert_many(chunks) unless chunks.empty?
+            self
+          end
+
+          # Close the write stream.
+          #
+          # @example Close the stream.
+          #   stream.close
+          #
+          # @return [ BSON::ObjectId, Object ] The file id.
+          #
+          # @raise [ Error::ClosedStream ] If the stream is already closed.
+          #
+          # @since 2.1.0
+          def close
+            ensure_open!
+            update_length
+            files_collection.insert_one(file_info)
+            @open = false
+            file_id
+          end
+
+          # Get the write concern used when uploading.
+          #
+          # @example Get the write concern.
+          #   stream.write_concern
+          #
+          # @return [ Mongo::WriteConcern ] The write concern.
+          #
+          # @since 2.1.0
+          def write_concern
+            @write_concern ||= @options[:write] ? WriteConcern.get(@options[:write]) :
+              fs.write_concern
+          end
+
+          # Is the stream closed.
+          #
+          # @example Is the stream closed.
+          #   stream.closed?
+          #
+          # @return [ true, false ] Whether the stream is closed.
+          #
+          # @since 2.1.0
+          def closed?
+            !@open
+          end
+
+          # Abort the upload by deleting all chunks already inserted.
+          #
+          # @example Abort the write operation.
+          #   stream.abort
+          #
+          # @return [ true ] True if the operation was aborted and the stream is closed.
+          #
+          # @since 2.1.0
+          def abort
+            fs.chunks_collection.find(:files_id => file_id).delete_many
+            @open = false || true
+          end
+
+          private
+
+          def chunks_collection
+            with_write_concern(fs.chunks_collection)
+          end
+
+          def files_collection
+            with_write_concern(fs.files_collection)
+          end
+
+          def with_write_concern(collection)
+            if collection.write_concern.options == write_concern.options
+              collection
+            else
+              collection.client.with(write: write_concern.options)[collection.name]
+            end
+          end
+
+          def update_length
+            file_info.document[:length] = @length
+          end
+
+          def file_info
+            doc = { length: @length, _id: file_id, filename: filename }
+            @file_info ||= File::Info.new(options.merge(doc))
+          end
+
+          def ensure_indexes!
+            fs.send(:ensure_indexes!)
+          end
+
+          def ensure_open!
+            raise Error::ClosedStream.new if closed?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/grid/stream.rb

@@ -0,0 +1,64 @@
+# 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/grid/stream/read'
+require 'mongo/grid/stream/write'
+
+module Mongo
+  module Grid
+    class FSBucket
+
+      # A stream that reads and writes files from/to the FSBucket.
+      #
+      # @since 2.1.0
+      module Stream
+        extend self
+
+        # The symbol for opening a read stream.
+        #
+        # @since 2.1.0
+        READ_MODE = :r
+
+        # The symbol for opening a write stream.
+        #
+        # @since 2.1.0
+        WRITE_MODE = :w
+
+        # Mapping from mode to stream class.
+        #
+        # @since 2.1.0
+        MODE_MAP = {
+            READ_MODE => Read,
+            WRITE_MODE => Write
+        }.freeze
+
+        # Get a stream for reading/writing files from/to the FSBucket.
+        #
+        # @example Get a stream.
+        #   FSBucket::Stream.get(fs, FSBucket::READ_MODE, options)
+        #
+        # @param [ FSBucket ] fs The GridFS bucket object.
+        # @param [ FSBucket::READ_MODE, FSBucket::WRITE_MODE ] mode The stream mode.
+        # @param [ Hash ] options The stream options.
+        #
+        # @return [ Stream::Read, Stream::Write ] The stream object.
+        #
+        # @since 2.1.0
+        def get(fs, mode, options = {})
+          MODE_MAP[mode].new(fs, options)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/grid.rb

@@ -13,4 +13,5 @@
 # limitations under the License.
 
 require 'mongo/grid/file'
-require 'mongo/grid/fs'
+require 'mongo/grid/fs_bucket'
+require 'mongo/grid/stream'

data/lib/mongo/index/view.rb

@@ -76,7 +76,7 @@ module Mongo
       #
       # @since 2.0.0
       def drop_one(name)
-        raise Error::MultiIndexDrop.new if name == '*'
+        raise Error::MultiIndexDrop.new if name == Index::ALL
         drop_by_name(name)
       end
 
@@ -89,7 +89,7 @@ module Mongo
       #
       # @since 2.0.0
       def drop_all
-        drop_by_name('*')
+        drop_by_name(Index::ALL)
       end
 
       # Creates an index on the collection.
@@ -229,7 +229,7 @@ module Mongo
       end
 
       def initial_query_op
-        Operation::Read::Indexes.new(indexes_spec)
+        Operation::Indexes.new(indexes_spec)
       end
 
       def limit; -1; end

data/lib/mongo/index.rb

@@ -21,6 +21,11 @@ module Mongo
   # @since 2.0.0
   module Index
 
+    # Wildcard constant for all.
+    #
+    # @since 2.1.0
+    ALL = '*'.freeze
+
     # Specify ascending order for an index.
     #
     # @since 2.0.0

data/lib/mongo/loggable.rb

@@ -24,105 +24,82 @@ module Mongo
     # @since 2.0.0
     PREFIX = 'MONGODB'.freeze
 
-    # Log the operations. If a block is provided it will be yielded to,
-    # otherwise only the logging will take place.
-    #
-    # @example Log a query operation.
-    #   loggable.log(:debug, "MONGO.query", operations)
-    #
-    # @param [ Symbol ] level The log level.
-    # @param [ String ] prefix The prefix for the log line.
-    # @param [ Array<Object> ] operations The operations to log. The must
-    #   respond to #log_message.
-    #
-    # @return [ Object ] The result of the block or nil if no block given.
-    #
-    # @since 2.0.0
-    def log(level, prefix, operations)
-      started = Time.new
-      begin
-        yield(operations) if block_given?
-      rescue Exception => e
-        raise e
-      ensure
-        if Logger.allow?(level)
-          runtime = format("%.4fms", (Time.now.to_f - started.to_f) * 1000.0)
-          operations.each do |operation|
-            Logger.log(level, prefix, log_inspect(operation), runtime)
-          end
-        end
-      end
-    end
-
     # Convenience method to log debug messages with the standard prefix.
     #
     # @example Log a debug message.
-    #   log_debug([ 'Message' ])
+    #   log_debug('Message')
     #
-    # @param [ Array<Operation, String> ] operations The operations or messages
-    #   to log.
+    # @param [ String ] message The message to log.
     #
     # @since 2.0.0
-    def log_debug(operations, &block)
-      log(:debug, PREFIX, operations, &block)
+    def log_debug(message)
+      logger.debug(format_message(message)) if logger.debug?
     end
 
     # Convenience method to log error messages with the standard prefix.
     #
     # @example Log a error message.
-    #   log_error([ 'Message' ])
+    #   log_error('Message')
     #
-    # @param [ Array<Operation, String> ] operations The operations or messages
-    #   to log.
+    # @param [ String ] message The message to log.
     #
     # @since 2.0.0
-    def log_error(operations, &block)
-      log(:error, PREFIX, operations, &block)
+    def log_error(message)
+      logger.error(format_message(message)) if logger.error?
     end
 
     # Convenience method to log fatal messages with the standard prefix.
     #
     # @example Log a fatal message.
-    #   log_fatal([ 'Message' ])
+    #   log_fatal('Message')
     #
-    # @param [ Array<Operation, String> ] operations The operations or messages
-    #   to log.
+    # @param [ String ] message The message to log.
     #
     # @since 2.0.0
-    def log_fatal(operations, &block)
-      log(:fatal, PREFIX, operations, &block)
+    def log_fatal(message)
+      logger.fatal(format_message(message)) if logger.fatal?
     end
 
     # Convenience method to log info messages with the standard prefix.
     #
     # @example Log a info message.
-    #   log_info([ 'Message' ])
+    #   log_info('Message')
     #
-    # @param [ Array<Operation, String> ] operations The operations or messages
-    #   to log.
+    # @param [ String ] message The message to log.
     #
     # @since 2.0.0
-    def log_info(operations, &block)
-      log(:info, PREFIX, operations, &block)
+    def log_info(message)
+      logger.info(format_message(message)) if logger.info?
     end
 
     # Convenience method to log warn messages with the standard prefix.
     #
     # @example Log a warn message.
-    #   log_warn([ 'Message' ])
+    #   log_warn('Message')
     #
-    # @param [ Array<Operation, String> ] operations The operations or messages
-    #   to log.
+    # @param [ String ] message The message to log.
     #
     # @since 2.0.0
-    def log_warn(operations, &block)
-      log(:warn, PREFIX, operations, &block)
+    def log_warn(message)
+      logger.warn(format_message(message)) if logger.warn?
+    end
+
+    # Get the logger instance.
+    #
+    # @example Get the logger instance.
+    #   loggable.logger
+    #
+    # @return [ Logger ] The logger.
+    #
+    # @since 2.1.0
+    def logger
+      (options[:logger] || Logger.logger)
     end
 
     private
 
-    def log_inspect(operation)
-      operation.respond_to?(:log_message) ? operation.log_message : operation
+    def format_message(message)
+      format("%s | %s".freeze, PREFIX, message)
     end
   end
 end

data/lib/mongo/logger.rb

@@ -23,76 +23,6 @@ module Mongo
 
     class << self
 
-      # Log a debug level message.
-      #
-      # @example Log a debug level message.
-      #   Logger.debug('mongo', 'message', '10ms')
-      #
-      # @param [ String ] prefix The category prefix.
-      # @param [ String ] message The log message.
-      # @param [ String ] runtime The time of the operation.
-      #
-      # @since 2.0.0
-      def debug(prefix, message, runtime)
-        self.log(:debug, prefix, message, runtime)
-      end
-
-      # Log a error level message.
-      #
-      # @example Log a error level message.
-      #   Logger.error('mongo', 'message', '10ms')
-      #
-      # @param [ String ] prefix The category prefix.
-      # @param [ String ] message The log message.
-      # @param [ String ] runtime The time of the operation.
-      #
-      # @since 2.0.0
-      def error(prefix, message, runtime)
-        self.log(:error, prefix, message, runtime)
-      end
-
-      # Log a fatal level message.
-      #
-      # @example Log a fatal level message.
-      #   Logger.fatal('mongo', 'message', '10ms')
-      #
-      # @param [ String ] prefix The category prefix.
-      # @param [ String ] message The log message.
-      # @param [ String ] runtime The time of the operation.
-      #
-      # @since 2.0.0
-      def fatal(prefix, message, runtime)
-        self.log(:fatal, prefix, message, runtime)
-      end
-
-      # Log a info level message.
-      #
-      # @example Log a info level message.
-      #   Logger.info('mongo', 'message', '10ms')
-      #
-      # @param [ String ] prefix The category prefix.
-      # @param [ String ] message The log message.
-      # @param [ String ] runtime The time of the operation.
-      #
-      # @since 2.0.0
-      def info(prefix, message, runtime)
-        self.log(:info, prefix, message, runtime)
-      end
-
-      # Log a warn level message.
-      #
-      # @example Log a warn level message.
-      #   Logger.warn('mongo', 'message', '10ms')
-      #
-      # @param [ String ] prefix The category prefix.
-      # @param [ String ] message The log message.
-      # @param [ String ] runtime The time of the operation.
-      #
-      # @since 2.0.0
-      def warn(prefix, message, runtime)
-        self.log(:warn, prefix, message, runtime)
-      end
-
       # Get the wrapped logger. If none was set will return a default debug
       # level logger.
       #
@@ -120,18 +50,26 @@ module Mongo
         @logger = other
       end
 
-      def log(level, prefix, message, runtime)
-        logger.send(level, format("%s | %s | runtime: %s".freeze, prefix, message, runtime))
-      end
-
-      def allow?(level)
-        logger.send(:"#{level}?")
-      end
-
+      # Get the global logger level.
+      #
+      # @example Get the global logging level.
+      #   Mongo::Logger.level
+      #
+      # @return [ Integer ] The log level.
+      #
+      # @since 2.0.0
       def level
         logger.level
       end
 
+      # Set the global logger level.
+      #
+      # @example Set the global logging level.
+      #   Mongo::Logger.level == Logger::DEBUG
+      #
+      # @return [ Integer ] The log level.
+      #
+      # @since 2.0.0
       def level=(level)
         logger.level = level
       end

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -0,0 +1,112 @@
+# 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
+  class Monitoring
+
+    # Subscribes to command events and logs them.
+    #
+    # @since 2.1.0
+    class CommandLogSubscriber
+      include Loggable
+
+      # @return [ Hash ] options The options.
+      attr_reader :options
+
+      # Constant for the max number of characters to print when inspecting
+      # a query field.
+      #
+      # @since 2.1.0
+      LOG_STRING_LIMIT = 250
+
+      # Create the new log subscriber.
+      #
+      # @example Create the log subscriber.
+      #   CommandLogSubscriber.new
+      #
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ Logger ] :logger An optional custom logger.
+      #
+      # @since 2.1.0
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Handle the command started event.
+      #
+      # @example Handle the event.
+      #   subscriber.started(event)
+      #
+      # @param [ CommandStartedEvent ] event The event.
+      #
+      # @since 2.1.0
+      def started(event)
+        if logger.debug?
+          log_debug("#{prefix(event)} | STARTED | #{format_command(event.command)}")
+        end
+      end
+
+      # Handle the command succeeded event.
+      #
+      # @example Handle the event.
+      #   subscriber.succeeded(event)
+      #
+      # @param [ CommandSucceededEvent ] event The event.
+      #
+      # @since 2.1.0
+      def succeeded(event)
+        if logger.debug?
+          log_debug("#{prefix(event)} | SUCCEEDED | #{event.duration}s")
+        end
+      end
+
+      # Handle the command failed event.
+      #
+      # @example Handle the event.
+      #   subscriber.failed(event)
+      #
+      # @param [ CommandFailedEvent ] event The event.
+      #
+      # @since 2.1.0
+      def failed(event)
+        if logger.debug?
+          log_debug("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
+        end
+      end
+
+      private
+
+      def format_command(args)
+        begin
+          truncating? ? truncate(args) : args.inspect
+        rescue Exception
+          '<Unable to inspect arguments>'
+        end
+      end
+
+      def prefix(event)
+        "#{event.address.to_s} | #{event.database_name}.#{event.command_name}"
+      end
+
+      def truncate(command)
+        ((s = command.inspect).length > LOG_STRING_LIMIT) ? "#{s[0..LOG_STRING_LIMIT]}..." : s
+      end
+
+      def truncating?
+        @truncating ||= (options[:truncate_logs] != false)
+      end
+    end
+  end
+end