mongo 0.1.0 → 0.15

data/lib/mongo/message/query_message.rb

@@ -1,58 +1,78 @@
+# --
+# Copyright (C) 2008-2009 10gen 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/message/message'
 require 'mongo/message/opcodes'
 require 'mongo/util/ordered_hash'
 
-module XGen
-  module Mongo
-    module Driver
+module Mongo
 
-      class QueryMessage < Message
+  class QueryMessage < Message
 
-        attr_reader :query
+    attr_reader :query
 
-        def initialize(db_name, collection_name, query)
-          super(OP_QUERY)
-          @query = query
-          write_int(0)
-          write_string("#{db_name}.#{collection_name}")
-          write_int(query.number_to_skip)
-          write_int(query.number_to_return)
-          sel = query.selector
-          if query.contains_special_fields
-            sel = OrderedHash.new
-            sel['query'] = query.selector
-            if query.order_by && query.order_by.length > 0
-              sel['orderby'] = case query.order_by
+    def initialize(db_name, collection_name, query)
+      super(OP_QUERY)
+      @query = query
+      @collection_name = collection_name
+      write_int(0)
+      write_string("#{db_name}.#{collection_name}")
+      write_int(query.number_to_skip)
+      write_int(query.number_to_return)
+      sel = query.selector
+      if query.contains_special_fields
+        sel = OrderedHash.new
+        sel['query'] = query.selector
+        if query.order_by && query.order_by.length > 0
+          sel['orderby'] = case query.order_by
+                           when String
+                             {query.order_by => 1}
+                           when Array
+                             h = OrderedHash.new
+                             query.order_by.each { |ob|
+                               case ob
                                when String
-                                 {query.order_by => 1}
-                               when Array
-                                 h = OrderedHash.new
-                                 query.order_by.each { |ob| h[ob] = 1 }
-                                 h
-                               when Hash # Should be an ordered hash, but this message doesn't care
-                                 query.order_by
+                                 h[ob] = 1
+                               when Hash # should have one entry; will handle all
+                                 ob.each { |k,v| h[k] = v }
                                else
-                                 raise "illegal order_by: is a #{query.order_by.class.name}, must be String, Array, Hash, or OrderedHash"
+                                 raise "illegal query order_by value #{query.order_by.inspect}"
                                end
-            end
-            if query.hint_fields && query.hint_fields.length > 0
-              hints = OrderedHash.new
-              query.hint_fields.each { |hf| hints[hf] = 1 }
-              sel['$hint'] = hints
-            end
-            if query.explain
-              sel['$explain'] = true
-            end
-                               
-          end
-          write_doc(sel)
-          write_doc(query.fields) if query.fields
-        end
-
-        def first_key(key)
-          @first_key = key
+                             }
+                             h
+                           when Hash # Should be an ordered hash, but this message doesn't care
+                             query.order_by
+                           else
+                             raise "illegal order_by: is a #{query.order_by.class.name}, must be String, Array, Hash, or OrderedHash"
+                           end
         end
+        sel['$hint'] = query.hint if query.hint && query.hint.length > 0
+        sel['$explain'] = true if query.explain
+        sel['$snapshot'] = true if query.snapshot
       end
+      write_doc(sel)
+      write_doc(query.fields) if query.fields
+    end
+
+    def first_key(key)
+      @first_key = key
+    end
+
+    def to_s
+      "db.#{@collection_name}.#{@query}"
     end
   end
 end

data/lib/mongo/message/remove_message.rb

@@ -1,20 +1,37 @@
+# --
+# Copyright (C) 2008-2009 10gen 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/message/message'
 require 'mongo/message/opcodes'
 
-module XGen
-  module Mongo
-    module Driver
+module Mongo
+
+  class RemoveMessage < Message
 
-      class RemoveMessage < Message
+    def initialize(db_name, collection_name, sel)
+      @collection_name = collection_name
+      super(OP_DELETE)
+      write_int(0)
+      write_string("#{db_name}.#{collection_name}")
+      write_int(0)              # flags?
+      write_doc(sel)
+    end
 
-        def initialize(db_name, collection_name, sel)
-          super(OP_DELETE)
-          write_int(0)
-          write_string("#{db_name}.#{collection_name}")
-          write_int(0)              # flags?
-          write_doc(sel)
-        end
-      end
+    def to_s
+      "#{@collection_name}.clear()"
     end
   end
 end

data/lib/mongo/message/update_message.rb

@@ -1,21 +1,38 @@
+# --
+# Copyright (C) 2008-2009 10gen 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/message/message'
 require 'mongo/message/opcodes'
 
-module XGen
-  module Mongo
-    module Driver
+module Mongo
+
+  class UpdateMessage < Message
 
-      class UpdateMessage < Message
+    def initialize(db_name, collection_name, sel, obj, repsert)
+      @collection_name = collection_name
+      super(OP_UPDATE)
+      write_int(0)
+      write_string("#{db_name}.#{collection_name}")
+      write_int(repsert ? 1 : 0) # 1 if a repsert operation (upsert)
+      write_doc(sel)
+      write_doc(obj)
+    end
 
-        def initialize(db_name, collection_name, sel, obj, repsert)
-          super(OP_UPDATE)
-          write_int(0)
-          write_string("#{db_name}.#{collection_name}")
-          write_int(repsert ? 1 : 0) # 1 if a repsert operation (upsert)
-          write_doc(sel)
-          write_doc(obj)
-        end
-      end
+    def to_s
+      "db.#{@collection_name}.update(#{@sel.inspect}, #{@obj.inspect})"
     end
   end
 end

data/lib/mongo/query.rb

@@ -1,110 +1,118 @@
 # --
 # Copyright (C) 2008-2009 10gen Inc.
 #
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Affero General Public License, version 3, as
-# published by the Free Software Foundation.
+# 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
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
-# for more details.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 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/collection'
 require 'mongo/message'
+require 'mongo/types/code'
 
-module XGen
-  module Mongo
-    module Driver
+module Mongo
 
-      # A query against a collection. A query's selector is a hash. See the
-      # Mongo documentation for query details.
-      class Query
+  # A query against a collection. A query's selector is a hash. See the
+  # Mongo documentation for query details.
+  class Query
 
-        attr_accessor :number_to_skip, :number_to_return, :order_by
-        # If true, $explain will be set in QueryMessage that uses this query.
-        attr_accessor :explain
-        # Either +nil+ or an array of hint field names.
-        attr_accessor :hint_fields
-        attr_reader :selector   # writer defined below
+    attr_accessor :number_to_skip, :number_to_return, :order_by, :snapshot
+    # If true, $explain will be set in QueryMessage that uses this query.
+    attr_accessor :explain
+    # Either +nil+ or a hash (preferably an OrderedHash).
+    attr_accessor :hint
+    attr_reader :selector   # writer defined below
 
-        # sel :: A hash describing the query. See the Mongo docs for details.
-        #
-        # return_fields :: If not +nil+, a single field name or an array of
-        #                  field names. Only those fields will be returned.
-        #                  (Called :fields in calls to Collection#find.)
-        #
-        # number_to_skip :: Number of records to skip before returning
-        #                   records. (Called :offset in calls to
-        #                   Collection#find.) Default is 0.
-        #
-        # number_to_return :: Max number of records to return. (Called :limit
-        #                     in calls to Collection#find.) Default is 0 (all
-        #                     records).
-        #
-        # order_by :: If not +nil+, specifies record sort order. May be a
-        #             String, Hash, OrderedHash, or Array. If a string, the
-        #             results will be ordered by that field in ascending
-        #             order. If an array, it should be an array of field names
-        #             which will all be sorted in ascending order. If a hash,
-        #             it may be either a regular Hash or an OrderedHash. The
-        #             keys should be field names, and the values should be 1
-        #             (ascending) or -1 (descending). Note that if it is a
-        #             regular Hash then sorting by more than one field
-        #             probably will not be what you intend because key order
-        #             is not preserved. (order_by is called :sort in calls to
-        #             Collection#find.)
-        def initialize(sel={}, return_fields=nil, number_to_skip=0, number_to_return=0, order_by=nil)
-          @number_to_skip, @number_to_return, @order_by = number_to_skip, number_to_return, order_by
-          self.selector = sel
-          self.fields = return_fields
-        end
-
-        # Set query selector hash. If sel is a string, it will be used as a
-        # $where clause. (See Mongo docs for details.)
-        def selector=(sel)
-          @selector = case sel
-                      when nil
-                        {}
-                      when String
-                        {"$where" => sel}
-                      when Hash
-                        sel
-                      end
-        end
+    # sel :: A hash describing the query. See the Mongo docs for details.
+    #
+    # return_fields :: If not +nil+, a single field name or an array of
+    #                  field names. Only those fields will be returned.
+    #                  (Called :fields in calls to Collection#find.)
+    #
+    # number_to_skip :: Number of records to skip before returning
+    #                   records. Default is 0.
+    #
+    # number_to_return :: Max number of records to return. (Called :limit
+    #                     in calls to Collection#find.) Default is 0 (all
+    #                     records).
+    #
+    # order_by :: If not +nil+, specifies record sort order. May be a
+    #             String, Hash, OrderedHash, or Array. If a string, the
+    #             results will be ordered by that field in ascending
+    #             order. If an array, it should be an array of field names
+    #             which will all be sorted in ascending order. If a hash,
+    #             it may be either a regular Hash or an OrderedHash. The
+    #             keys should be field names, and the values should be 1
+    #             (ascending) or -1 (descending). Note that if it is a
+    #             regular Hash then sorting by more than one field
+    #             probably will not be what you intend because key order
+    #             is not preserved. (order_by is called :sort in calls to
+    #             Collection#find.)
+    #
+    # hint :: If not +nil+, specifies query hint fields. Must be either
+    #                +nil+ or a hash (preferably an OrderedHash). See
+    #                Collection#hint.
+    def initialize(sel={}, return_fields=nil, number_to_skip=0, number_to_return=0, order_by=nil, hint=nil, snapshot=nil)
+      @number_to_skip, @number_to_return, @order_by, @hint, @snapshot =
+        number_to_skip, number_to_return, order_by, hint, snapshot
+      @explain = nil
+      self.selector = sel
+      self.fields = return_fields
+    end
 
-        # Set fields to return. If +val+ is +nil+ or empty, all fields will be
-        # returned.
-        def fields=(val)
-          @fields = val
-          @fields = nil if @fields && @fields.empty?
-        end
+    # Set query selector hash. If sel is Code/string, it will be used as a
+    # $where clause. (See Mongo docs for details.)
+    def selector=(sel)
+      @selector = case sel
+                  when nil
+                    {}
+                  when Code
+                    {"$where" => sel}
+                  when String
+                    {"$where" => Code.new(sel)}
+                  when Hash
+                    sel
+                  end
+    end
 
-        def fields
-          case @fields
-          when String
-            {@fields => 1}
-          when Array
-            if @fields.length == 0
-              nil
-            else
-              h = {}
-              @fields.each { |field| h[field] = 1 }
-              h
-            end
-          else                  # nil, anything else
-            nil
-          end
-        end
+    # Set fields to return. If +val+ is +nil+ or empty, all fields will be
+    # returned.
+    def fields=(val)
+      @fields = val
+      @fields = nil if @fields && @fields.empty?
+    end
 
-        def contains_special_fields
-          (@order_by != nil && @order_by.length > 0) || @explain || @hint_fields
+    def fields
+      case @fields
+      when String
+        {@fields => 1}
+      when Array
+        if @fields.length == 0
+          nil
+        else
+          h = {}
+          @fields.each { |field| h[field] = 1 }
+          h
         end
+      else                  # nil, anything else
+        nil
       end
     end
+
+    def contains_special_fields
+      (@order_by != nil && @order_by.length > 0) || @explain || @hint || @snapshot
+    end
+
+    def to_s
+      "find(#{@selector.inspect})" + (@order_by ? ".sort(#{@order_by.inspect})" : "")
+    end
   end
 end

data/lib/mongo/types/binary.rb

@@ -1,34 +1,38 @@
 # --
 # Copyright (C) 2008-2009 10gen Inc.
 #
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Affero General Public License, version 3, as
-# published by the Free Software Foundation.
+# 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
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
-# for more details.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 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 XGen
-  module Mongo
-    module Driver
+require 'mongo/util/byte_buffer'
 
-      # An array of binary bytes. The only reason this exists is so that the
-      # BSON encoder will know to output the Mongo BINARY type.
-      class Binary < String; end
+module Mongo
 
+  # An array of binary bytes with a Mongo subtype value.
+  class Binary < ByteBuffer
+
+    SUBTYPE_BYTES = 0x02
+    SUBTYPE_UUID = 0x03
+    SUBTYPE_MD5 = 0x05
+    SUBTYPE_USER_DEFINED = 0x80
+
+    # One of the SUBTYPE_* constants. Default is SUBTYPE_BYTES.
+    attr_accessor :subtype
+
+    def initialize(initial_data=[], subtype=SUBTYPE_BYTES)
+      super(initial_data)
+      @subtype = subtype
     end
-  end
-end
 
-class String
-  # Convert a string into a XGen::Mongo::Driver::Binary
-  def to_mongo_binary
-    XGen::Mongo::Driver::Binary.new(self)
   end
 end