mongo_scope 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,7 +1,46 @@
-= mongo_scope
+= MongoScope
 
 Hacking on some scope methods for MongoDB in Ruby.  Inspired by Searchlogic.  
 
+Adds a scope method, as well as helper methods for MongoDB operators.  
+
+= Installation
+
+Hosted on Gemcutter
+
+  $ gem install mongo_scope
+
+= Example 
+
+From the examples dir
+
+  # Mongod should be running locally
+  
+  require 'rubygems'
+  require 'mongo'
+  require 'mongo_scope'
+
+  # get a collection
+  connection = Mongo::Connection.new
+  db   = connection.db('ruby-mongo-test')
+  coll = db.collection("test")
+
+  # Add some data
+  coll.remove
+  coll.save({:first_name => 'Mike', :last_name => 'Harris', :age => 27})
+  coll.save({:first_name => 'Lowell', :age => 28})
+  coll.save({:first_name => 'Lou', :age => 27})
+
+  # using a scope helper method (find works just like the normal Mongo::Collection find)
+  puts coll.scope_in(:first_name => ['Mike','Lowell']).find.count # 2
+  puts coll.scope_gt(:age => 27).find.count # 1
+
+  # chained scopes
+  puts coll.scope_eq(:first_name => /^L/).scope_eq(:age => 27).find.count # 1
+
+  # the raw scope method (this is wrapped by the helper methods)
+  puts coll.scope(:op => '$in', :field => :first_name, :val => ['Mike','Lowell']).find.count # 2
+
 == Copyright
 
 Copyright (c) 2009 Mike Harris. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/the_lonely_example.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'mongo'
+require 'mongo_scope'
+
+# taken from the spec
+# Mongod should be running locally
+
+# get a collection
+connection = Mongo::Connection.new
+db   = connection.db('ruby-mongo-test')
+coll = db.collection("test")
+
+# Add some data
+coll.remove
+coll.save({:first_name => 'Mike', :last_name => 'Harris', :age => 27})
+coll.save({:first_name => 'Lowell', :age => 28})
+coll.save({:first_name => 'Lou', :age => 27})
+
+# using a scope helper method (find works just like the normal Mongo::Collection find)
+puts coll.scope_in(:first_name => ['Mike','Lowell']).find.count # 2
+puts coll.scope_gt(:age => 27).find.count # 1
+
+# chained scopes
+puts coll.scope_eq(:first_name => /^L/).scope_eq(:age => 27).find.count # 1
+
+# the raw scope method (this is wrapped by the helper methods)
+puts coll.scope(:op => '$in', :field => :first_name, :val => ['Mike','Lowell']).find.count # 2

data/lib/mongo_scope.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'fattr'
 require File.join(File.dirname(__FILE__),'mongo_scope','util')
 
 module MongoScope
@@ -11,7 +10,7 @@ module MongoScope
       scope_ops = {:field => ops.keys.first, :val => ops.values.first}
       ScopedCollection.new(EqScope.new(scope_ops),self)
     end
-    %w(in gt nin).each do |op|
+    %w(in nin gt lt gte lte ne mod all size exists).each do |op|
       define_method("scope_#{op}") do |ops|
         scope(:op => "$#{op}", :field => ops.keys.first, :val => ops.values.first)
       end
@@ -33,12 +32,18 @@ module MongoScope
       self.coll = coll
     end
     def scoped_ops(ops)
+      ops = {'_id' => ops} unless ops.kind_of?(Hash)
       ops.merge(scope_obj.find_ops)
     end
-    def find(ops={})
-      coll.find(scoped_ops(ops))
+    def find(selector={},options={})
+      coll.find(scoped_ops(selector),options)
+    end
+    def find_one(selector={},options={})
+      coll.find_one(scoped_ops(selector),options)
+    end
+    def method_missing(sym,*args,&b)
+      coll.send(sym,*args,&b)
     end
-
   end
 
   class Scope

data/spec/mongo_scope_spec.rb

@@ -1,5 +1,18 @@
 require 'spec_helper'
 
+class Object
+  def to_sym_keys
+    h = {}
+    each { |k,v| h[k.to_sym] = v }
+    h
+  end
+  def to_subset(h)
+    h = h.to_sym_keys
+    keys.each { |k| delete(k) unless h.keys.include?(k) }
+    self
+  end
+end
+
 describe "MongoScope" do
   before(:all) do
     @connection = Mongo::Connection.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost', ENV['MONGO_RUBY_DRIVER_PORT'] || Mongo::Connection::DEFAULT_PORT)
@@ -37,4 +50,19 @@ describe "MongoScope" do
     scope = MongoScope::Scope.new(:op => '$in', :field => :first_name, :val => ['Mike','Dave'])
     scope.find_ops.should == {:first_name => {'$in' => ['Mike','Dave']}}
   end
+  it 'scoped find_one' do
+    @coll.find_one(:age => 27)['first_name'].should == 'Mike'
+    @coll.scope_eq(:first_name => /^L/).find_one(:age => 27)['first_name'].should == 'Lou'
+  end
+  it 'scoped find_one with id' do
+    mike_id = @coll.find_one(:first_name => 'Mike')['_id']
+    lou_id = @coll.find_one(:first_name => 'Lou')['_id']
+    @coll.find_one(mike_id)['first_name'].should == 'Mike'
+    @coll.scope_eq(:first_name => /^L/).find_one(lou_id)['first_name'].should == 'Lou'
+    @coll.scope_eq(:first_name => 'Mike').find_one(lou_id).should_not be
+  end
+  it 'should save' do
+    @coll.scope_eq(:first_name => 'Mike').save(:abc => 42)
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_scope
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Harris
@@ -28,6 +28,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/the_lonely_example.rb
 - lib/mongo_scope.rb
 - lib/mongo_scope/util.rb
 - spec/mongo_scope_spec.rb
@@ -67,3 +68,4 @@ test_files:
 - spec/spec_helper.rb
 - test/mongo_scope_test.rb
 - test/test_helper.rb
+- examples/the_lonely_example.rb