mongo_geo 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Parrish
+
+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.markdown

@@ -0,0 +1,38 @@
+# mongo_geo
+
+mongo_geo is a plugin for MongoMapper that exposes the [GeoSpatial indexing features](http://www.mongodb.org/display/DOCS/Geospatial+Indexing) in MongoDb.
+
+Currently, I'm only developing against Ruby 1.9.1 so other versions may be flakey.
+
+## Usage
+### On the model
+		class TestAsset
+		  include MongoMapper::Document
+		  plugin GeoSpatial
+
+		  geo_key :coords, Array
+		end
+
+### [Plucky](http://github.com/jnunemaker/plucky) style queries:
+		TestAsset.where(:coords.near => [50, 50]).limit(10).to_a
+		TestAsset.where(:coords.within => { "$center" => [[50, 50], 10] }).to_a			# "$center" => [center, radius]
+		TestAsset.where(:coords.within => { "$box" => [ [45, 45], [55, 55] ] }).to_a		# [lower_left, top_right]
+
+N.B. bounds queries are syntactically ugly at the moment and are likely to change soon
+
+### geoNear and convenience methods
+		nearby = TestAsset.near([50, 50], :num => 15, :query => { ... })
+		nearby.average_distance						# average distance of all results from the target point
+		nearby.first.distance						# distance of this result from the target
+		TestAsset.first.distance_from([50, 50])		# distance from any point
+Queries can be specified with the [ruby driver style finders](http://github.com/mongodb/mongo-ruby-driver/blob/master/examples/queries.rb)
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_geo"
+    gem.summary = %Q{A MongoMapper plugin that adds geospatial functionality.}
+    gem.description = %Q{A MongoMapper plugin that adds geospatial functionality.}
+    gem.email = "mtparrish@gmail.com"
+    gem.homepage = "http://github.com/parrish/mongo_geo"
+    gem.authors = ["Michael Parrish"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "mongo_mapper", ">= 0.8.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongo_geo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongo_geo.rb

@@ -0,0 +1,81 @@
+require 'mongo_mapper'
+
+module Plucky
+  module Extensions
+    module Symbol
+      def near
+        SymbolOperator.new(self, 'near')
+      end
+
+      def within
+        SymbolOperator.new(self, 'within')
+      end
+    end
+  end
+end
+
+module GeoSpatial
+  module ClassMethods
+    def geo_key(name, klass)
+      unless [Array, Hash].include?(klass)
+        raise(ArgumentError, "#{klass} is not a valid type for a geo_key\nUse either an Array(recommended) or a Hash")
+      end
+      
+      if @geo_key_name.nil?
+        key name.to_sym, klass
+        ensure_index([[name, Mongo::GEO2D]])
+        @geo_key_name = name
+      else
+        error = "MongoDB is currently limited to only one geospatial index per collection.\n"
+        error += "geo_key #{name} was NOT added to #{self.name}"
+        raise(RuntimeError, error)
+      end
+    end
+    
+    def geo_key_name
+      @geo_key_name
+    end
+    
+    def near(location, params = {})
+      args = BSON::OrderedHash.new
+      args[:geoNear] = self.collection.name
+      args[:near] = location
+      params.each_pair{ |key, value| args[key.to_sym] = value }
+      
+      raw = database.command(args)
+      objects = raw["results"].collect{ |r| self.load(r["obj"]) }
+      objects.instance_variable_set(:@raw, raw)
+      
+      objects.each.with_index do |obj, index|
+        obj.instance_variable_set(:@distance, raw["results"][index]["dis"])
+        def obj.distance
+          @distance
+        end
+      end
+      
+      def objects.average_distance
+        @raw["stats"]["avgDistance"]
+      end
+      
+      objects
+    end
+  end
+
+  module InstanceMethods
+    def distance_from(pt)
+      name = self.class.geo_key_name
+      return nil if name.nil?
+      raise(ArgumentError) unless [Array, Hash].include?(pt.class)
+      
+      loc = self.send(name)
+      loc = loc.values if loc.is_a?(Hash)
+      pt = pt.values if pt.is_a?(Hash)
+      
+      dx = loc[0] - pt[0]
+      dy = loc[1] - pt[1]
+      Math.sqrt((dx ** 2) + (dy ** 2))
+    end
+  end
+end
+
+MongoMapper::Plugins.send :include, GeoSpatial

data/mongo_geo.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongo_geo}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Parrish"]
+  s.date = %q{2010-07-19}
+  s.description = %q{A MongoMapper plugin that adds geospatial functionality.}
+  s.email = %q{mtparrish@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/mongo_geo.rb",
+     "mongo_geo.gemspec",
+     "test/helper.rb",
+     "test/test_mongo_geo.rb",
+     "test/test_plucky_extensions.rb"
+  ]
+  s.homepage = %q{http://github.com/parrish/mongo_geo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A MongoMapper plugin that adds geospatial functionality.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_mongo_geo.rb",
+     "test/test_plucky_extensions.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0.8.2"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0.8.2"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0.8.2"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mongo_mapper'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mongo_geo'
+
+connection = Mongo::Connection.new('127.0.0.1', 27017)
+DB = connection.db('mongo-geo')
+MongoMapper.database = "mongo-geo"
+
+class TestAsset
+  include MongoMapper::Document
+  plugin GeoSpatial
+
+  geo_key :coords, Array
+end
+
+class Test::Unit::TestCase
+  def setup
+    DB['assets'].remove
+  end
+end

data/test/test_mongo_geo.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestMongoGeo < Test::Unit::TestCase
+  context "Initializing a model" do
+    setup do
+      @asset1 = TestAsset.create(:coords => [50, 50])
+      @asset2 = TestAsset.create(:coords => [60, 60])
+      @asset3 = TestAsset.create(:coords => [70, 70])
+    end
+
+    should "create the 2d index" do
+      assert_equal(TestAsset.geo_key_name, :coords)
+      assert(TestAsset.collection.index_information['coords_2d'], "geo_key did not define the 2d index")
+    end
+    
+    should "validate #geo_key type" do
+      assert_raise(ArgumentError) { TestAsset.geo_key(:blah, Float) }
+      assert_raise(RuntimeError) { TestAsset.geo_key(:no_more, Array) }
+    end
+    
+    should "allow plucky queries using #near" do
+      nearby = TestAsset.where(:coords.near => [45, 45]).to_a
+      assert_equal(nearby.first, @asset1)
+      assert_equal(nearby.last, @asset3)
+    end
+    
+    should "allow plucky queries using #within" do
+      nearby = TestAsset.where(:coords.within => { "$center" => [[45, 45], 10] }).to_a
+      assert_equal(nearby, [@asset1])
+    end
+    
+    should "allow geoNear style queries with #near" do
+      nearby = TestAsset.near([45, 45], :num => 2)
+      assert_equal(2, nearby.count)
+      assert_equal(@asset1, nearby.first)
+      
+      assert(nearby.methods.include?(:average_distance), "#near did not define average_distance")
+      assert_equal(nearby.average_distance.class, Float)
+      
+      assert(nearby.first.methods.include?(:distance), "#near did not define distance on each record")
+      assert_equal(nearby.first.distance.class, Float)
+    end
+    
+    should "perform a simple #distance_from calculation" do
+      assert(@asset1.methods.include?(:distance_from), "GeoSpatial::InstanceMethods were not included")
+      assert_equal(Math.sqrt(2), @asset1.distance_from([51, 51]))
+      assert_raise(ArgumentError) { @asset1.distance_from(51) }
+      
+      TestAsset.collection.drop_indexes
+      TestAsset.collection.remove
+    end
+  end
+end

data/test/test_plucky_extensions.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestMongoGeo < Test::Unit::TestCase
+  context "Extending Plucky symbols" do
+    should "add #near" do
+      assert Plucky::Extensions::Symbol.instance_methods.include?(:near), "near symbol operator not created"
+    end
+    
+    should "add #within" do
+      assert Plucky::Extensions::Symbol.instance_methods.include?(:within), "within symbol operator not created"
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_geo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Parrish
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id002
+description: A MongoMapper plugin that adds geospatial functionality.
+email: mtparrish@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/mongo_geo.rb
+- mongo_geo.gemspec
+- test/helper.rb
+- test/test_mongo_geo.rb
+- test/test_plucky_extensions.rb
+has_rdoc: true
+homepage: http://github.com/parrish/mongo_geo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A MongoMapper plugin that adds geospatial functionality.
+test_files: 
+- test/helper.rb
+- test/test_mongo_geo.rb
+- test/test_plucky_extensions.rb