tinymongo 0.1.4 → 0.1.5

data/README.rdoc

@@ -2,6 +2,10 @@
 
 Simple MongoDB wrapper
 
+== Notice
+
+This gem is not yet ready for production use.
+
 == Install
 
   gem install tinymongo
@@ -20,18 +24,18 @@ To create TinyMongo config file (config/tinymongo.yml) and initializer file (con
 == Example
 
   class Person < TinyMongo::Model
-    mongo_collection :people  # optional if using Rails
+    mongo_collection :people          # optional if using Rails
     mongo_key :name
     mongo_key :age
     mongo_key :children
   
     def make_child
       child = Person.create(:name => 'Baby', :age => 0)
-      push({:children => child})
+      push({:children => child})      # push child into children array
     end
   
     def grow_up
-      inc({:age => 1})
+      inc({:age => 1})                # increments age by 1
     end
     
     def set_stuff(n,a,c)
@@ -43,6 +47,26 @@ To create TinyMongo config file (config/tinymongo.yml) and initializer file (con
     end
   end
   
+  Person.drop                         # empty drop collection
+  
+  p = Person.create(:name => 'John', :age => 20)  # create John
+  p.make_child                        # make Baby and set it as John's child
+  p.grow_up                           # increment age by 1 = 21
+  
+  Person.find.each do |person|
+    puts person.name                  # print Baby and John
+  end
+  
+  puts Person.find_one(:name => 'John').age  # print 21
+  
+  Person.create(:name => 'Jim')
+  Person.create(:name => 'Pam')
+
+  puts Person.find.to_a.map { |person| person.name } # print Baby; John; Jim; Pam
+  
+  # Sort by name (ascending), Skip Baby and Jim, limit result by 1, print => John
+  puts Person.find.sort({:name => 1}).skip(2).limit(1).next_document.name 
+  
 == Copyright
 
 Copyright (c) 2010 Peter Jihoon Kim. See LICENSE for details.

data/Rakefile

@@ -11,8 +11,8 @@ begin
     s.homepage          = "http://github.com/petejkim/tinymongo"
     s.authors           = ["Peter Jihoon Kim"]
     s.email             = "raingrove@gmail.com"
-    s.add_dependency 'mongo'
-    s.add_dependency 'bson'
+    s.add_dependency(%q<mongo>, [">= 1.0.5"])
+    s.add_dependency(%q<bson>, [">= 1.0.4"])
   end
 
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/tinymongo.rb

@@ -49,4 +49,5 @@ end
 
 require 'tinymongo/errors'
 require 'tinymongo/helper'
+require 'tinymongo/cursor'
 require 'tinymongo/model'

data/lib/tinymongo/cursor.rb

@@ -0,0 +1,146 @@
+module TinyMongo
+  class Cursor
+    include Mongo::Conversions
+    include Enumerable
+    
+    # instance attributes in Mongo::Cursor
+    
+    def initialize(cursor, model_class)
+      @_tinymongo_cursor = cursor
+      @_tinymongo_model_class = model_class
+    end
+    
+    def mongo_cursor
+      @_tinymongo_cursor
+    end
+    
+    def batch_size
+      @_tinymongo_cursor.batch_size
+    end
+    
+    def collection
+      @_tinymongo_cursor.collection
+    end
+    
+    def fields 
+      @_tinymongo_cursor.fields
+    end
+    
+    def full_collection_name
+      @_tinymongo_cursor.full_collection_name
+    end
+    
+    def hint
+      @_tinymongo_cursor.hint
+    end 
+    
+    def order
+      @_tinymongo_cursor.order
+    end
+    
+    def selector
+      @_tinymongo_cursor.selector
+    end
+    
+    def snapshot
+      @_tinymongo_cursor.snapshot
+    end
+    
+    def timeout
+      @_tinymongo_cursor.timeout
+    end
+    
+    # instance methods in Mongo::Cursor
+    
+    def close
+      @_tinymongo_cursor.close
+    end
+    
+    def closed?
+      @_tinymongo_cursor.closed?
+    end
+    
+    def count
+      @_tinymongo_cursor.count
+    end
+    
+    def each
+      num_returned = 0
+      while(has_next? && (@_tinymongo_cursor.instance_variable_get(:@limit) <= 0 ||
+        num_returned < @_tinymongo_cursor.instance_variable_get(:@limit)))
+        yield next_document
+        num_returned += 1
+      end
+    end
+    
+    def explain
+      @_tinymongo_cursor.explain
+    end
+    
+    def has_next?
+      @_tinymongo_cursor.has_next?
+    end
+    
+    def limit(*args)
+      call_and_wrap_retval_in_tinymongo_cursor(:limit, args)
+    end
+    
+    def next_document
+      doc = @_tinymongo_cursor.next_document
+      @_tinymongo_model_class.new(doc)
+    end
+    
+    def query_options_hash
+      @_tinymongo_cursor.query_options_hash
+    end
+    
+    def query_opts
+      @_tinymongo_cursor.query_opts
+    end
+    
+    def skip(*args)
+      call_and_wrap_retval_in_tinymongo_cursor(:skip, args)
+    end
+    
+    def sort(*args)
+      if(args.length > 0 && (args[0].instance_of? Hash))
+        sort_array = []
+        
+        args[0].each_pair do |key, value|
+          sort_array << [key, convert_ascending_descending_to_numeric(value)]
+        end
+        
+        args[0] = sort_array
+      end
+        
+      call_and_wrap_retval_in_tinymongo_cursor(:sort, args)
+    end
+    
+    def to_a
+      return [] if @_tinymongo_cursor.nil?
+      
+      hashes = @_tinymongo_cursor.to_a
+      hashes.map { |hash| @_tinymongo_model_class.new(hash) }
+    end
+    
+    protected
+    def call_and_wrap_retval_in_tinymongo_cursor(method_name, args)
+      result = @_tinymongo_cursor.send(method_name, *args)
+      if(result.kind_of? Mongo::Cursor)
+        @_tinymongo_cursor = result
+        self
+      else
+        result
+      end
+    end
+    
+    def convert_ascending_descending_to_numeric(val)
+      case(val)
+      when 'ascending', 'asc', 1
+        'ascending'
+      when 'descending', 'desc', -1
+        'descending'
+      end
+    end
+  end
+end

data/lib/tinymongo/model.rb

@@ -1,5 +1,3 @@
-require 'tinymongo/modifiers'
-
 module TinyMongo
   class Model
     class << self
@@ -9,13 +7,8 @@ module TinyMongo
             key_name_s = key_name.to_s
             key_name_sym = key_name.to_sym
 
-            define_method(key_name_sym) do
-              instance_variable_get("@_tinymongo_hash")[key_name_s]
-            end
-
-            define_method("#{key_name_s}=".to_sym) do |val|
-              instance_variable_get("@_tinymongo_hash")[key_name_s] = val
-            end
+            define_method(key_name_sym) { instance_variable_get(:@_tinymongo_hash)[key_name_s] }
+            define_method("#{key_name_s}=") { |val| instance_variable_get(:@_tinymongo_hash)[key_name_s] = val }
           end
         end
       end
@@ -39,23 +32,14 @@ module TinyMongo
       end
       
       def find(*args)
-        return [] if((args.size > 0) && (args.compact.size == 0))
-        
         new_args = args.map {|arg| Helper.hashify_models_in(arg) }
-        cursor = collection.find(*new_args)
-        
-        if(cursor)
-          hashes = cursor.to_a
-          objs = hashes.map { |hash| self.new(hash) }
-        end
-        
-        cursor ? objs : []
+        Cursor.new(collection.find(*new_args), self)
       end
 
       def find_one(*args)
-        if((args.size > 0) && (args.compact.size == 0))
+        if((args.length > 0) && (args.compact.length == 0))
           return nil
-        elsif((args.size == 1) && ([BSON::ObjectID, String].include? args[0].class))
+        elsif((args.length == 1) && ([BSON::ObjectID, String].include? args[0].class))
           hash = collection.find_one({'_id' => Helper.bson_object_id(args[0])})
         else
           new_args = args.map {|arg| Helper.hashify_models_in(arg) }
@@ -95,7 +79,7 @@ module TinyMongo
     end
     
     def initialize(hash={})
-      @_tinymongo_hash = Helper.stringify_keys_in_hash(hash)
+      @_tinymongo_hash = Helper.stringify_keys_in_hash(hash) || {}
     end
 
     def _id
@@ -163,6 +147,47 @@ module TinyMongo
       delete
     end
       
-    include Modifiers
+    def inc(hash={})
+      do_modifier_operation_and_reload('$inc', hash)
+    end
+
+    def set(hash={})
+      do_modifier_operation_and_reload('$set', hash)
+    end
+
+    def unset(hash={})
+      do_modifier_operation_and_reload('$unset', hash)
+    end
+
+    def push(hash={})
+      do_modifier_operation_and_reload('$push', hash)
+    end
+
+    def push_all(hash={})
+      do_modifier_operation_and_reload('$pushAll', hash)
+    end
+
+    def add_to_set(hash={})
+      do_modifier_operation_and_reload('$addToSet', hash)
+    end
+
+    def pop(hash={})
+      do_modifier_operation_and_reload('$pop', hash)
+    end
+
+    def pull(hash={})
+      do_modifier_operation_and_reload('$pull', hash)
+    end
+
+    def pull_all(hash={})
+      do_modifier_operation_and_reload('$pullAll', hash)
+    end
+  
+    protected
+    def do_modifier_operation_and_reload(operator, hash)
+      raise ModifierOperationError unless self._id
+      collection.update({ '_id' => self._id }, { operator => Helper.hashify_models_in_hash(hash) })
+      reload
+    end
   end
 end

data/test/test_tinymongo.rb

@@ -104,20 +104,20 @@ class TinyMongoTest < Test::Unit::TestCase
   end
   
   def test_find_nothing
-    found = Dummy.find()
+    found = Dummy.find().to_a
     assert_equal [], found
   end
     
   def test_find_all_one
     obj = Dummy.create('foo' => 'hello') 
-    found = Dummy.find()
+    found = Dummy.find().to_a
     assert_equal [obj], found
   end
   
   def test_find_all_many
     obj = Dummy.create('foo' => 'hello') 
     obj2 = Dummy.create('foo' => 'hello') 
-    found = Dummy.find()
+    found = Dummy.find().to_a
     assert_equal [obj, obj2], found
   end
   
@@ -125,12 +125,121 @@ class TinyMongoTest < Test::Unit::TestCase
     obj = Dummy.create('foo' => 'hello') 
     obj2 = Dummy.create('foo' => 'hello') 
     obj3 = Dummy.create('foo' => 'bye') 
-    found1 = Dummy.find({'foo' => 'hello'})
-    found2 = Dummy.find({'foo' => 'bye'})
+    found1 = Dummy.find({'foo' => 'hello'}).to_a
+    found2 = Dummy.find({'foo' => 'bye'}).to_a
     assert_equal [obj, obj2], found1
     assert_equal [obj3], found2
   end
   
+  def test_cursor_close
+    Dummy.create
+    cursor = Dummy.find
+    assert_equal true, cursor.close
+  end
+
+  def test_cursor_closed?
+    Dummy.create
+    cursor = Dummy.find
+    cursor.close
+    assert_equal true, cursor.closed?
+  end
+
+
+  def test_cursor_count
+    Dummy.create
+    Dummy.create
+    Dummy.create
+    cursor = Dummy.find
+    assert_equal 3, cursor.count
+  end
+  
+  def test_cursor_limit
+    Dummy.create
+    Dummy.create
+    Dummy.create
+    cursor = Dummy.find.limit(1)
+    assert_equal 1, cursor.to_a.size
+  end
+  
+  def test_cursor_limit_count
+    Dummy.create
+    Dummy.create
+    Dummy.create
+    cursor = Dummy.find.limit(2)
+    assert_equal 2, cursor.limit
+  end
+
+  def test_cursor_each
+    Dummy.create('foo' => 1) 
+    Dummy.create('foo' => 2) 
+    Dummy.create('foo' => 3) 
+    
+    cursor = Dummy.find
+    num = 0
+    cursor.each do |x|
+      num += x.foo
+    end
+    
+    assert_equal 6, num
+  end
+
+  def test_cursor_has_next?
+    Dummy.create
+    cursor = Dummy.find
+    assert_equal true, cursor.has_next?
+  end
+
+  def test_cursor_next_document
+    obj = Dummy.create
+    cursor = Dummy.find
+    assert_equal obj, cursor.next_document
+  end
+  
+  def test_cursor_skip
+    Dummy.create('foo' => 1) 
+    Dummy.create('foo' => 2) 
+    obj = Dummy.create('foo' => 3) 
+    
+    cursor = Dummy.find.skip(2)
+    assert_equal obj, cursor.next_document
+  end
+  
+  def test_cursor_skip_count
+    Dummy.create('foo' => 1) 
+    Dummy.create('foo' => 2) 
+    obj = Dummy.create('foo' => 3) 
+    
+    cursor = Dummy.find.skip(2)
+    assert_equal 2, cursor.skip
+  end
+
+  def test_cursor_to_a
+    obj1 = Dummy.create
+    obj2 = Dummy.create
+    obj3 = Dummy.create
+
+    cursor = Dummy.find
+    assert_equal [obj1, obj2, obj3], cursor.to_a
+  end
+  
+  def test_cursor_sort
+    obj1 = Dummy.create('foo' => 3) 
+    obj2 = Dummy.create('foo' => 2) 
+    obj3 = Dummy.create('foo' => 1) 
+    
+    cursor = Dummy.find.sort(['foo', 'ascending'])
+    assert_equal [obj3, obj2, obj1], cursor.to_a
+  end
+
+  def test_cursor_sort_hash
+    obj1 = Dummy.create('foo' => 3) 
+    obj2 = Dummy.create('foo' => 2) 
+    obj3 = Dummy.create('foo' => 1) 
+    
+    cursor = Dummy.find.sort({'foo' => 1})
+    assert_equal [obj3, obj2, obj1], cursor.to_a
+  end
+  
   def test_find_one
     obj = Dummy.create('foo' => 'hello') 
     found = Dummy.find_one()

data/tinymongo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tinymongo}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Jihoon Kim"]
-  s.date = %q{2010-07-22}
+  s.date = %q{2010-07-23}
   s.description = %q{Simple MongoDB wrapper}
   s.email = %q{raingrove@gmail.com}
   s.extra_rdoc_files = [
@@ -28,10 +28,10 @@ Gem::Specification.new do |s|
      "lib/generators/templates/tinymongo.yml.erb",
      "lib/generators/tinymongo_generator.rb",
      "lib/tinymongo.rb",
+     "lib/tinymongo/cursor.rb",
      "lib/tinymongo/errors.rb",
      "lib/tinymongo/helper.rb",
      "lib/tinymongo/model.rb",
-     "lib/tinymongo/modifiers.rb",
      "test/test_helper.rb",
      "test/test_tinymongo.rb",
      "tinymongo.gemspec"
@@ -51,15 +51,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongo>, [">= 0"])
-      s.add_runtime_dependency(%q<bson>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo>, [">= 1.0.5"])
+      s.add_runtime_dependency(%q<bson>, [">= 1.0.4"])
     else
-      s.add_dependency(%q<mongo>, [">= 0"])
-      s.add_dependency(%q<bson>, [">= 0"])
+      s.add_dependency(%q<mongo>, [">= 1.0.5"])
+      s.add_dependency(%q<bson>, [">= 1.0.4"])
     end
   else
-    s.add_dependency(%q<mongo>, [">= 0"])
-    s.add_dependency(%q<bson>, [">= 0"])
+    s.add_dependency(%q<mongo>, [">= 1.0.5"])
+    s.add_dependency(%q<bson>, [">= 1.0.4"])
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Peter Jihoon Kim
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 +09:00
+date: 2010-07-23 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,8 +26,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        version: "0"
+        - 5
+        version: 1.0.5
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -39,8 +41,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        version: "0"
+        - 4
+        version: 1.0.4
   type: :runtime
   version_requirements: *id002
 description: Simple MongoDB wrapper
@@ -64,10 +68,10 @@ files:
 - lib/generators/templates/tinymongo.yml.erb
 - lib/generators/tinymongo_generator.rb
 - lib/tinymongo.rb
+- lib/tinymongo/cursor.rb
 - lib/tinymongo/errors.rb
 - lib/tinymongo/helper.rb
 - lib/tinymongo/model.rb
-- lib/tinymongo/modifiers.rb
 - test/test_helper.rb
 - test/test_tinymongo.rb
 - tinymongo.gemspec

data/lib/tinymongo/modifiers.rb

@@ -1,46 +0,0 @@
-module TinyMongo
-  module Modifiers
-    def inc(hash={})
-      do_modifier_operation_and_reload('$inc', hash)
-    end
-  
-    def set(hash={})
-      do_modifier_operation_and_reload('$set', hash)
-    end
-  
-    def unset(hash={})
-      do_modifier_operation_and_reload('$unset', hash)
-    end
-  
-    def push(hash={})
-      do_modifier_operation_and_reload('$push', hash)
-    end
-  
-    def push_all(hash={})
-      do_modifier_operation_and_reload('$pushAll', hash)
-    end
-  
-    def add_to_set(hash={})
-      do_modifier_operation_and_reload('$addToSet', hash)
-    end
-  
-    def pop(hash={})
-      do_modifier_operation_and_reload('$pop', hash)
-    end
-  
-    def pull(hash={})
-      do_modifier_operation_and_reload('$pull', hash)
-    end
-  
-    def pull_all(hash={})
-      do_modifier_operation_and_reload('$pullAll', hash)
-    end
-    
-    protected
-    def do_modifier_operation_and_reload(operator, hash)
-      raise ModifierOperationError unless self._id
-      collection.update({ '_id' => self._id }, { operator => Helper.hashify_models_in_hash(hash) })
-      reload
-    end
-  end
-end