moped 1.0.0.rc → 1.0.0

data/lib/moped/protocol/command.rb

@@ -13,16 +13,13 @@ module Moped
       # @param [Hash] command the command to run
       # @param [Hash] additional query options
       def initialize(database, command, options = {})
-        super database, :$cmd, command, options.merge(limit: -1)
+        super database, '$cmd', command, options.merge(limit: -1)
       end
 
       def log_inspect
         type = "COMMAND"
-
         "%-12s database=%s command=%s" % [type, database, selector.inspect]
       end
-
     end
-
   end
 end

data/lib/moped/protocol/delete.rb

@@ -45,6 +45,8 @@ module Moped
       # @return [Hash] the query to use when deleting documents
       document :selector
 
+      finalize
+
       # @return [String, Symbol] the database to delete from
       attr_reader :database
 

data/lib/moped/protocol/get_more.rb

@@ -43,6 +43,8 @@ module Moped
       # @return [Number] the id of the cursor to get more documents from
       int64    :cursor_id
 
+      finalize
+
       undef op_code
       # @return [Number] OP_GETMORE operation code (2005)
       def op_code
@@ -72,9 +74,22 @@ module Moped
 
       def log_inspect
         type = "GET_MORE"
-
         "%-12s database=%s collection=%s limit=%s cursor_id=%s" % [type, database, collection, limit, cursor_id]
       end
+
+      # Receive replies to the message.
+      #
+      # @example Receive replies.
+      #   message.receive_replies(connection)
+      #
+      # @param [ Connection ] connection The connection.
+      #
+      # @return [ Protocol::Reply ] The reply.
+      #
+      # @since 1.0.0
+      def receive_replies(connection)
+        connection.read
+      end
     end
   end
 end

data/lib/moped/protocol/insert.rb

@@ -46,6 +46,8 @@ module Moped
       # @return [Array<Hash>] the documents to insert
       document :documents, type: :array
 
+      finalize
+
       undef op_code
       # @return [Number] OP_INSERT operation code (2002)
       def op_code

data/lib/moped/protocol/kill_cursors.rb

@@ -35,6 +35,8 @@ module Moped
       # @return [Array] the cursor ids to kill
       int64    :cursor_ids, type: :array
 
+      finalize
+
       undef op_code
       # @return [Number] OP_KILL_CURSORS operation code (2007)
       def op_code

data/lib/moped/protocol/message.rb

@@ -271,6 +271,23 @@ module Moped
           fields << name
         end
 
+        # Declares the message class as complete, and defines its serialization
+        # method from the declared fields.
+        def finalize
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def serialize(buffer = "")
+              start = buffer.bytesize
+
+              #{fields.map { |f| "serialize_#{f}(buffer)" }.join("\n")}
+
+              self.length = buffer.bytesize - start
+              buffer[start, 4] = serialize_length ""
+              buffer
+            end
+            alias to_s serialize
+          EOS
+        end
+
         private
 
         # This ensures that subclasses of the primary wire message classes have
@@ -283,25 +300,27 @@ module Moped
 
       end
 
+      # Default implementation for a message is to do nothing when receiving
+      # replies.
+      #
+      # @example Receive replies.
+      #   message.receive_replies(connection)
+      #
+      # @param [ Connection ] connection The connection.
+      #
+      # @since 1.0.0
+      #
+      # @return [ nil ] nil.
+      def receive_replies(connection); end
+
       # Serializes the message and all of its fields to a new buffer or to the
       # provided buffer.
       #
       # @param [String] buffer a buffer to serialize to
       # @return [String] the result of serliazing this message
       def serialize(buffer = "")
-        buffer.tap do
-          start = buffer.length
-
-          self.class.fields.each do |field|
-            __send__ :"serialize_#{field}", buffer
-          end
-
-          self.length = buffer.length - start
-
-          buffer[start, 4] = serialize_length("")
-        end
+        raise NotImplementedError, "This method is generated after calling #finalize on a message class"
       end
-
       alias to_s serialize
 
       # @return [String] the nicely formatted version of the message

data/lib/moped/protocol/query.rb

@@ -64,6 +64,8 @@ module Moped
       # @return [Hash, nil] the fields to include in the reply
       document :fields, :optional => true
 
+      finalize
+
       undef op_code
       # @return [Number] OP_QUERY operation code (2004)
       def op_code
@@ -111,7 +113,6 @@ module Moped
 
       def log_inspect
         type = "QUERY"
-
         fields = []
         fields << ["%-12s", type]
         fields << ["database=%s", database]
@@ -121,12 +122,23 @@ module Moped
         fields << ["limit=%s", limit.inspect]
         fields << ["skip=%s", skip.inspect]
         fields << ["fields=%s", self.fields.inspect]
-
         f, v = fields.transpose
-
         f.join(" ") % v
       end
 
+      # Receive replies to the message.
+      #
+      # @example Receive replies.
+      #   message.receive_replies(connection)
+      #
+      # @param [ Connection ] connection The connection.
+      #
+      # @return [ Protocol::Reply ] The reply.
+      #
+      # @since 1.0.0
+      def receive_replies(connection)
+        connection.read
+      end
     end
   end
 end

data/lib/moped/protocol/reply.rb

@@ -51,6 +51,8 @@ module Moped
       # @return [Array] the returned documents
       document :documents, type: :array
 
+      finalize
+
       class << self
 
         # Consumes a buffer, returning the deserialized Reply message.
@@ -65,11 +67,11 @@ module Moped
         # reply from.
         # @return [Reply] the deserialized reply
         def deserialize(buffer)
-          allocate.tap do |reply|
-            fields.each do |field|
-              reply.__send__ :"deserialize_#{field}", buffer
-            end
+          reply = allocate
+          fields.each do |field|
+            reply.__send__ :"deserialize_#{field}", buffer
           end
+          reply
         end
       end
 

data/lib/moped/protocol/update.rb

@@ -56,6 +56,8 @@ module Moped
       # @return [Hash] the updates to apply
       document :update
 
+      finalize
+
       undef op_code
       # @return [Number] OP_UPDATE operation code (2001)
       def op_code

data/lib/moped/query.rb

@@ -73,11 +73,11 @@ module Moped
     # @yieldparam [ Hash ] document each matching document
     def each
       cursor = Cursor.new(session, operation)
-      cursor.to_enum.tap do |enum|
-        enum.each do |document|
-          yield document
-        end if block_given?
-      end
+      enum = cursor.to_enum
+      enum.each do |document|
+        yield document
+      end if block_given?
+      enum
     end
 
     # Explain the current query.
@@ -118,6 +118,22 @@ module Moped
     end
     alias :one :first
 
+    # Apply an index hint to the query.
+    #
+    # @example Apply an index hint.
+    #   db[:people].find.hint("$natural" => 1)
+    #
+    # @param [ Hash ] hint The index hint.
+    #
+    # @return [ Query ] self
+    #
+    # @since 1.0.0
+    def hint(hint)
+      operation.selector = { "$query" => selector } unless operation.selector["$query"]
+      operation.selector["$hint"] = hint
+      self
+    end
+
     # Initialize the query.
     #
     # @example Initialize the query.
@@ -151,6 +167,45 @@ module Moped
       self
     end
 
+    # Execute a $findAndModify on the query.
+    #
+    # @example Find and modify a document, returning the original.
+    #   db[:bands].find.modify({ "$inc" => { likes: 1 }})
+    #
+    # @example Find and modify a document, returning the updated document.
+    #   db[:bands].find.modify({ "$inc" => { likes: 1 }}, new: true)
+    #
+    # @example Find and return a document, removing it from the database.
+    #   db[:bands].find.modify({}, remove: true)
+    #
+    # @example Find and return a document, upserting if no match found.
+    #   db[:bands].find.modify({}, upsert: true, new: true)
+    #
+    # @param [ Hash ] change The changes to make to the document.
+    # @param [ Hash ] options The options.
+    #
+    # @option options :new Set to true if you want to return the updated document.
+    # @option options :remove Set to true if the document should be deleted.
+    # @option options :upsert Set to true if you want to upsert
+    #
+    # @return [ Hash ] The document.
+    #
+    # @since 1.0.0
+    def modify(change, options = {})
+      command = {
+        findAndModify: collection.name,
+        query: selector
+      }.merge(options)
+
+      command[:sort] = operation.selector["$orderby"] if operation.selector["$orderby"]
+      command[:fields] = operation.fields if operation.fields
+      command[:update] = change unless options[:remove]
+
+      session.with(consistency: :strong) do |sess|
+        sess.command(command)["value"]
+      end
+    end
+
     # Remove a single document matching the query's selector.
     #
     # @example Remove a single document.

data/lib/moped/session.rb

@@ -28,47 +28,88 @@ module Moped
   #   session.with(database: "admin").login("admin", "s3cr3t")
   #
   class Session
-    extend Forwardable
 
     # @attribute [r] cluster The session cluster.
     # @attribute [r] context The session context.
     # @attribute [r] options The session options.
     attr_reader :cluster, :context, :options
 
-    # @method [](collection)
     # Return +collection+ from the current database.
     #
     # @param (see Moped::Database#[])
+    #
     # @return (see Moped::Database#[])
-    delegate :"[]" => :current_database
+    #
+    # @since 1.0.0
+    def [](name)
+      current_database[name]
+    end
+
+    # Return non system collection name from the current database.
+    #
+    # @param (see Moped::Database#collection_names)
+    #
+    # @return (see Moped::Database#collection_names)
+    #
+    # @since 1.0.0
+    def collection_names
+      current_database.collection_names
+    end
+
+    # Return non system collection name from the current database.
+    #
+    # @param (see Moped::Database#collections)
+    #
+    # @return (see Moped::Database#collections)
+    #
+    # @since 1.0.0
+    def collections
+      current_database.collections
+    end
 
-    # @method command(command)
     # Run +command+ on the current database.
     #
     # @param (see Moped::Database#command)
+    #
     # @return (see Moped::Database#command)
-    delegate :command => :current_database
+    #
+    # @since 1.0.0
+    def command(op)
+      current_database.command(op)
+    end
 
-    # @method drop
     # Drop the current database.
     #
     # @param (see Moped::Database#drop)
+    #
     # @return (see Moped::Database#drop)
-    delegate :drop => :current_database
+    #
+    # @since 1.0.0
+    def drop
+      current_database.drop
+    end
 
-    # @method login(username, password)
     # Log in with +username+ and +password+ on the current database.
     #
     # @param (see Moped::Database#login)
+    #
     # @raise (see Moped::Database#login)
-    delegate :login => :current_database
+    #
+    # @since 1.0.0
+    def login(username, password)
+      current_database.login(username, password)
+    end
 
-    # @method logout
     # Log out from the current database.
     #
     # @param (see Moped::Database#logout)
+    #
     # @raise (see Moped::Database#login)
-    delegate :logout => :current_database
+    #
+    # @since 1.0.0
+    def logout
+      current_database.logout
+    end
 
     # Get the session's consistency.
     #
@@ -168,12 +209,7 @@ module Moped
     #
     # @since 1.0.0
     def safety
-      safe = options[:safe]
-      case safe
-      when false then false
-      when true then { safe: true }
-      else safe
-      end
+      options[:safe].__safe_options__
     end
 
     # Switch the session's current database.

data/lib/moped/session/context.rb

@@ -3,16 +3,28 @@ module Moped
 
     # @api private
     class Context
-      extend Forwardable
+
+      attr_reader :session
 
       def initialize(session)
         @session = session
       end
 
-      delegate :safety => :@session
-      delegate :safe?  => :@session
-      delegate :consistency  => :@session
-      delegate :cluster  => :@session
+      def safety
+        session.safety
+      end
+
+      def safe?
+        session.safe?
+      end
+
+      def consistency
+        session.consistency
+      end
+
+      def cluster
+        session.cluster
+      end
 
       def login(database, username, password)
         cluster.auth[database.to_s] = [username, password]
@@ -98,8 +110,6 @@ module Moped
           end
         end
       end
-
     end
-
   end
 end