moped 1.3.2 → 1.4.0

data/lib/moped/bson/extensions/boolean.rb

@@ -1,9 +1,11 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module Boolean
+
         module ClassMethods
+
           def __bson_load__(io)
             io.readbyte == 1
           end

data/lib/moped/bson/extensions/false_class.rb

@@ -1,8 +1,9 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module FalseClass
+
         def __bson_dump__(io, key)
           io << Types::BOOLEAN
           io << key.to_bson_cstring

data/lib/moped/bson/extensions/float.rb

@@ -1,14 +1,8 @@
 module Moped
   module BSON
-    # @private
     module Extensions
-      module Float
 
-        module ClassMethods
-          def __bson_load__(io)
-            io.read(8).unpack(FLOAT_PACK)[0]
-          end
-        end
+      module Float
 
         def __bson_dump__(io, key)
           io << Types::FLOAT
@@ -16,6 +10,12 @@ module Moped
           io << [self].pack(FLOAT_PACK)
         end
 
+        module ClassMethods
+
+          def __bson_load__(io)
+            io.read(8).unpack(FLOAT_PACK)[0]
+          end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/hash.rb

@@ -1,47 +1,38 @@
 module Moped
   module BSON
-    # @private
     module Extensions
-      module Hash
 
-        module ClassMethods
-          def __bson_load__(io, doc = new)
-            # Swallow the first four (length) bytes
-            io.read 4
-
-            while (buf = io.readbyte) != 0
-              key = io.gets(NULL_BYTE).from_utf8_binary.chop!
-
-              if native_class = Types::MAP[buf]
-                doc[key] = native_class.__bson_load__(io)
-              end
-            end
-
-            doc
-          end
-        end
+      module Hash
 
         def __bson_dump__(io = "", key = nil)
           if key
             io << Types::HASH
             io << key.to_bson_cstring
           end
-
           start = io.bytesize
-
-          # write dummy length
-          io << START_LENGTH
-
+          io << START_LENGTH # write dummy length
           each do |k, v|
             v.__bson_dump__(io, k.to_s)
           end
           io << EOD
-
           stop = io.bytesize
           io[start, 4] = [stop - start].pack INT32_PACK
-
           io
         end
+
+        module ClassMethods
+
+          def __bson_load__(io, doc = new)
+            io.read(4) # Swallow the first four (length) bytes
+            while (buf = io.readbyte) != 0
+              key = io.gets(NULL_BYTE).from_utf8_binary.chop!
+              if native_class = Types::MAP[buf]
+                doc[key] = native_class.__bson_load__(io)
+              end
+            end
+            doc
+          end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/integer.rb

@@ -1,20 +1,15 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module Integer
+
         INT32_MIN = (-(1 << 31)+1)
         INT32_MAX = ((1<<31)-1)
 
         INT64_MIN = (-2**64 / 2)
         INT64_MAX = (2**64 / 2 - 1)
 
-        module ClassMethods
-          def __bson_load__(io, bignum=false)
-            io.read(4).unpack(INT32_PACK)[0]
-          end
-        end
-
         def __bson_dump__(io, key)
           if self >= INT32_MIN && self <= INT32_MAX
             io << Types::INT32
@@ -29,6 +24,12 @@ module Moped
           end
         end
 
+        module ClassMethods
+
+          def __bson_load__(io, bignum=false)
+            io.read(4).unpack(INT32_PACK)[0]
+          end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/nil_class.rb

@@ -1,18 +1,18 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module NilClass
-        module ClassMethods
-          def __bson_load__(io)
-            nil
-          end
-        end
 
         def __bson_dump__(io, key)
           io << Types::NULL
           io << key.to_bson_cstring
         end
+
+        module ClassMethods
+
+          def __bson_load__(io); nil; end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/object.rb

@@ -1,12 +1,10 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module Object
 
-        def __safe_options__
-          self
-        end
+        def __safe_options__; self; end
       end
     end
   end

data/lib/moped/bson/extensions/regexp.rb

@@ -1,9 +1,21 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module Regexp
+
+        def __bson_dump__(io, key)
+          io << Types::REGEX
+          io << key.to_bson_cstring
+          io << source.to_bson_cstring
+          io << 'i'  if (options & ::Regexp::IGNORECASE) != 0
+          io << 'ms' if (options & ::Regexp::MULTILINE) != 0
+          io << 'x'  if (options & ::Regexp::EXTENDED) != 0
+          io << NULL_BYTE
+        end
+
         module ClassMethods
+
           def __bson_load__(io)
             source = io.gets(NULL_BYTE).from_utf8_binary.chop!
             options = 0
@@ -17,22 +29,9 @@ module Moped
                 options |= ::Regexp::EXTENDED
               end
             end
-
             new(source, options)
           end
         end
-
-        def __bson_dump__(io, key)
-          io << Types::REGEX
-          io << key.to_bson_cstring
-
-          io << source.to_bson_cstring
-
-          io << 'i'  if (options & ::Regexp::IGNORECASE) != 0
-          io << 'ms' if (options & ::Regexp::MULTILINE) != 0
-          io << 'x'  if (options & ::Regexp::EXTENDED) != 0
-          io << NULL_BYTE
-        end
       end
     end
   end

data/lib/moped/bson/extensions/string.rb

@@ -1,20 +1,13 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module String
-        module ClassMethods
-          def __bson_load__(io)
-            io.read(*io.read(4).unpack(INT32_PACK)).from_utf8_binary.chop!
-          end
-        end
 
         def __bson_dump__(io, key)
           io << Types::STRING
           io << key.to_bson_cstring
-
           data = to_utf8_binary
-
           io << [ data.bytesize + 1 ].pack(INT32_PACK)
           io << data
           io << NULL_BYTE
@@ -25,7 +18,6 @@ module Moped
             raise EncodingError, "#{inspect} cannot be converted to a BSON " \
               "cstring because it contains a null byte"
           end
-
           to_utf8_binary << NULL_BYTE
         end
 
@@ -40,6 +32,13 @@ module Moped
         def from_utf8_binary
           force_encoding(UTF8_ENCODING).encode!
         end
+
+        module ClassMethods
+
+          def __bson_load__(io)
+            io.read(*io.read(4).unpack(INT32_PACK)).from_utf8_binary.chop!
+          end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/symbol.rb

@@ -1,20 +1,13 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module Symbol
-        module ClassMethods
-          def __bson_load__(io)
-            io.read(*io.read(4).unpack(INT32_PACK)).from_utf8_binary.chop!.intern
-          end
-        end
 
         def __bson_dump__(io, key)
           io << Types::SYMBOL
           io << key.to_bson_cstring
-
           data = to_utf8_binary
-
           io << [ data.bytesize + 1 ].pack(INT32_PACK)
           io << data
           io << NULL_BYTE
@@ -27,6 +20,13 @@ module Moped
         def to_utf8_binary
           to_s.to_utf8_binary
         end
+
+        module ClassMethods
+
+          def __bson_load__(io)
+            io.read(*io.read(4).unpack(INT32_PACK)).from_utf8_binary.chop!.intern
+          end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/time.rb

@@ -1,20 +1,22 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module Time
-        module ClassMethods
-          def __bson_load__(io)
-            seconds, fragment = io.read(8).unpack(INT64_PACK)[0].divmod 1000
-            at(seconds, fragment * 1000).utc
-          end
-        end
 
         def __bson_dump__(io, key)
           io << Types::TIME
           io << key.to_bson_cstring
           io << [(to_i * 1000) + (usec / 1000)].pack(INT64_PACK)
         end
+
+        module ClassMethods
+
+          def __bson_load__(io)
+            seconds, fragment = io.read(8).unpack(INT64_PACK)[0].divmod 1000
+            at(seconds, fragment * 1000).utc
+          end
+        end
       end
     end
   end

data/lib/moped/bson/extensions/true_class.rb

@@ -1,8 +1,9 @@
 module Moped
   module BSON
-    # @private
     module Extensions
+
       module TrueClass
+
         def __bson_dump__(io, key)
           io << Types::BOOLEAN
           io << key.to_bson_cstring

data/lib/moped/bson/max_key.rb

@@ -1,15 +1,46 @@
 module Moped
   module BSON
+
+    # Represents the maximum key value in the database.
     class MaxKey
+
       class << self
+
+        # Check equality on the object.
+        #
+        # @example Check equality.
+        #   object == other
+        #
+        # @param [ Object ] other The object to check against.
+        #
+        # @return [ true, false ] If the objects are equal.
+        #
+        # @since 1.0.0
         def ===(other)
           other == self
         end
 
-        def __bson_load__(io)
-          self
-        end
+        # Load the max key from the raw data.
+        #
+        # @example Load the max key.
+        #   Moped::BSON::MaxKey.__bson_load("")
+        #
+        # @param [ String ] io The raw bytes.
+        #
+        # @return [ Class ] The Moped::BSON::MaxKey class.
+        #
+        # @since 1.0.0
+        def __bson_load__(io); self; end
 
+        # Dump the max key to the raw bytes.
+        #
+        # @example Dump the max key.
+        #   Moped::BSON::MaxKey.__bson_dump__("", "max")
+        #
+        # @param [ String ] io The raw bytes to write to.
+        # @param [ String ] key The field name.
+        #
+        # @since 1.0.0
         def __bson_dump__(io, key)
           io << Types::MAX_KEY
           io << key.to_bson_cstring

data/lib/moped/bson/min_key.rb

@@ -1,15 +1,46 @@
 module Moped
   module BSON
+
+    # Represents the minimum key value in the database.
     class MinKey
+
       class << self
+
+        # Check equality on the object.
+        #
+        # @example Check equality.
+        #   object == other
+        #
+        # @param [ Object ] other The object to check against.
+        #
+        # @return [ true, false ] If the objects are equal.
+        #
+        # @since 1.0.0
         def ===(other)
           other == self
         end
 
-        def __bson_load__(io)
-          self
-        end
+        # Load the min key from the raw data.
+        #
+        # @example Load the min key.
+        #   Moped::BSON::MinKey.__bson_load("")
+        #
+        # @param [ String ] io The raw bytes.
+        #
+        # @return [ Class ] The Moped::BSON::MinKey class.
+        #
+        # @since 1.0.0
+        def __bson_load__(io); self; end
 
+        # Dump the min key to the raw bytes.
+        #
+        # @example Dump the min key.
+        #   Moped::BSON::MinKey.__bson_dump__("", "min")
+        #
+        # @param [ String ] io The raw bytes to write to.
+        # @param [ String ] key The field name.
+        #
+        # @since 1.0.0
         def __bson_dump__(io, key)
           io << Types::MIN_KEY
           io << key.to_bson_cstring