mongo_scope 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Harris
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= mongo_scope
+
+Hacking on some scope methods for MongoDB in Ruby.  Inspired by Searchlogic.  
+
+== Copyright
+
+Copyright (c) 2009 Mike Harris. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_scope"
+    gem.summary = "Adds scope methods to Mongo::Collection.  Inspired by Searchlogic."
+    gem.email = "mharris717@gmail.com"
+    gem.homepage = "http://github.com/mharris717/mongo_scope"
+    gem.authors = ["Mike Harris"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'mongo_scope'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+Jeweler::GemcutterTasks.new
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/mongo_scope.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'fattr'
+require File.join(File.dirname(__FILE__),'mongo_scope','util')
+
+module MongoScope
+  module ScopeMethods
+    def scope(ops)
+      ScopedCollection.new(ops,self)
+    end
+    def scope_eq(ops)
+      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|
+      define_method("scope_#{op}") do |ops|
+        scope(:op => "$#{op}", :field => ops.keys.first, :val => ops.values.first)
+      end
+    end
+  end
+
+  module CollMethods
+    def count
+      find.count
+    end
+  end
+
+  class ScopedCollection
+    include ScopeMethods
+    include CollMethods
+    attr_accessor :scope_obj, :coll
+    def initialize(scope_ops,coll)
+      self.scope_obj = Scope.new(scope_ops)
+      self.coll = coll
+    end
+    def scoped_ops(ops)
+      ops.merge(scope_obj.find_ops)
+    end
+    def find(ops={})
+      coll.find(scoped_ops(ops))
+    end
+
+  end
+
+  class Scope
+    def self.new(ops)
+      ops.respond_to?(:find_ops) ? ops : super(ops)
+    end
+    attr_accessor :field, :op, :val
+    include FromHash
+    def find_ops
+      {field => {op => val}}
+    end
+  end
+
+  class EqScope
+    attr_accessor :field, :val
+    include FromHash
+    def find_ops
+      {field => val}
+    end
+  end
+  
+  def self.use!
+    [CollMethods,ScopeMethods].each { |mod| ::Mongo::Collection.send(:include,mod) }
+  end
+  
+  use!
+end
+

data/lib/mongo_scope/util.rb

@@ -0,0 +1,11 @@
+module FromHash
+  def from_hash(ops)
+    ops.each do |k,v|
+      send("#{k}=",v)
+    end
+    self
+  end
+  def initialize(ops={})
+    from_hash(ops)
+  end
+end

data/spec/mongo_scope_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+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)
+    @db   = @connection.db('ruby-mongo-test')
+    @coll = @db.collection("test")
+  end
+  before(:each) do
+    @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})
+  end
+  it 'scope method' do
+    @coll.scope(:op => '$in', :field => :first_name, :val => ['Mike','Dave']).find.count.should == 1
+  end
+  it 'helper method - in' do
+    @coll.scope_in(:first_name => ['Mike','Dave']).find.count.should == 1
+  end
+  it 'helper method - nin' do
+    @coll.scope_nin(:first_name => ['Mike','Dave']).find.count.should == 2
+  end
+  it 'helper method - eq' do
+    @coll.scope_eq(:first_name => 'Mike').find.count.should == 1
+  end
+  it 'helper method - gt' do
+    @coll.scope_gt(:age => 26).find.count.should == 3
+    @coll.scope_gt(:age => 27).find.count.should == 1
+  end
+  it 'chained scopes' do
+    @coll.scope_eq(:age => 27).count.should == 2 
+    @coll.scope_eq(:age => 27).scope_eq(:first_name => 'Mike').count.should == 1
+    @coll.scope_eq(:first_name => /^L/).scope_gt(:age => 27).count.should == 1
+  end
+  it 'scope find ops' do
+    scope = MongoScope::Scope.new(:op => '$in', :field => :first_name, :val => ['Mike','Dave'])
+    scope.find_ops.should == {:first_name => {'$in' => ['Mike','Dave']}}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'spec'
+require 'rubygems'
+require 'mongo'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongo_scope'
+
+Spec::Runner.configure do |config|
+  
+end

data/test/mongo_scope_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class MongoScopeTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mongo_scope'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_scope
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-11 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mharris717@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo_scope.rb
+- lib/mongo_scope/util.rb
+- spec/mongo_scope_spec.rb
+- spec/spec_helper.rb
+- test/mongo_scope_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mharris717/mongo_scope
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adds scope methods to Mongo::Collection.  Inspired by Searchlogic.
+test_files: 
+- spec/mongo_scope_spec.rb
+- spec/spec_helper.rb
+- test/mongo_scope_test.rb
+- test/test_helper.rb