mongoid_geo 0.2.6 → 0.3.0

data/README.textile

@@ -1,10 +1,10 @@
 h1. Mongoid geo
 
-A Geo extension for Mongoid. 
+A Geo extension for Mongoid.
 
 "MongoDB Geospatial Indexing":http://www.mongodb.org/display/DOCS/Geospatial+Indexing
 
-* Supports Mongoid 1.7 sphere distance calculations and 
+* Supports Mongoid 1.7 sphere distance calculations and
 * Adds nearSphere inclusion method
 * Adds a set of geo related inflections
 * Adds an exta option for defining a "geo" field, to have the generated attr_writer parse and convert strings etc. to float arrays.
@@ -20,7 +20,7 @@ h3. Find addresses near a point
 h3. Find locations within a circle
 
 <pre>
-  base.where(:location.within => { "$center" => [ [ 50, -40 ], 1 ] })  
+  base.where(:location.within => { "$center" => [ [ 50, -40 ], 1 ] })
 </pre>
 
 h3. Create geo-spatial index
@@ -28,17 +28,17 @@ h3. Create geo-spatial index
 <pre>
   class Person
     field :location, :type => Array
-    index [[ :location, Mongo::GEO2D ]], :min => -180, :max => 180      
+    index [[ :location, Mongo::GEO2D ]], :min => -180, :max => 180
   end
 
   # to ensure indexes are created, either:
   Mongoid.autocreate_indexes = true
 
   # or in the mongoid.yml
-  autocreate_indexes: true  
+  autocreate_indexes: true
 </pre>
 
-These are the only geo features I could find are currently built-in for Mongoid 2. 
+These are the only geo features I could find are currently built-in for Mongoid 2.
 _Mongoid Geo_ implements the following extra features...
 
 h1. Mongoid Geo features
@@ -51,9 +51,9 @@ Old/Manual way: @index [[ :location, Mongo::GEO2D ]], :min => -180, :max => 180@
 
 Using new _geo_index_ class method : @geo_index :location@
 
-h2. Special geo-array attribute writer 
+h2. Special geo-array attribute writer
 
-When setting a geo-location array, the setter should try to convert the value to an array of floats 
+When setting a geo-location array, the setter should try to convert the value to an array of floats
 
 Old/Manual way:
 
@@ -64,7 +64,7 @@ Old/Manual way:
     def locations= args
       @locations = args.kind_of?(String) ? args.split(",").map(&:to_f) : args
     end
-  end  
+  end
 </pre>
 
 With the new @:geo@ option supplied by _mongoid-geo_ :
@@ -72,29 +72,29 @@ With the new @:geo@ option supplied by _mongoid-geo_ :
 <pre>
   class Person
     field :location, :type => Array, :geo => true
-    
+
     geo_index :location
-  end  
-  
+  end
+
    p = Person.new
 
    # A Geo array can now be set via String or Strings, Hash or Object, here a few examples...
    # Please see geo_fields_spec.rb for more options!
 
    p.location = "45.1, -3.4"
-   p.location = "45.1", "-3.4"   
-   p.location = {:lat => 45.1, :lng => -3.4}   
+   p.location = "45.1", "-3.4"
+   p.location = {:lat => 45.1, :lng => -3.4}
    p.location = [{:lat => 45.1, :lng => -3.4}]
-   p.location = {:latitude => 45.1, :longitude => -3.4}   
-   
+   p.location = {:latitude => 45.1, :longitude => -3.4}
+
    my_location  = Location.new :latitude => 45.1, :longitude => -3.4
    p.location   = my_location
 
    # for each of the above, the following holds
-   assert([45.1, -3.4], p.location)   
+   assert([45.1, -3.4], p.location)
 
    # also by default adds #lat and #lng convenience methods (thanks to TeuF)
-   
+
    assert(45.1 , p.lat)
    assert(-3.4 , p.lng)
 
@@ -102,12 +102,12 @@ With the new @:geo@ option supplied by _mongoid-geo_ :
   field :location, :type => Array, :geo => true, :lat => :latitude, :lng => :longitude
 
   assert(45.1 , p.latitude)
-  assert(-3.4 , p.longitude) 
-  
+  assert(-3.4 , p.longitude)
+
   # or set the array attributes using symmetric setter convenience methods!
   p.latitude   = 44
-  assert(44 , p.latitude)   
-  
+  assert(44 , p.latitude)
+
   # PURE MAGIC!!!
 </pre>
 
@@ -122,9 +122,9 @@ class Address
 
   field :location, :type => Array, :geo => true
   ...
-end  
+end
 
-# Find all addresses sorted nearest to a specific address loation 
+# Find all addresses sorted nearest to a specific address loation
 nearest_addresses = Address.geoNear(another_address, :location)
 
 class Position
@@ -132,16 +132,19 @@ class Position
 
   field :pos, :type => Array, :geo => true
   ...
-end  
+end
 
-# Find all positions sorted nearest to the address loation 
+# Find all positions sorted nearest to the address loation
 nearest_positions = Position.geoNear(another_address.location, :pos)
 
 # perform distance locations in Speherical mode inside Mongo DB (default is :plane)
 nearest_positions = Position.geoNear(another_address.location, :pos, :mode => :sphere)
 
-# other options supported are: :num, :maxDistance, distanceMultiplier, :query
+# other options supported are: :num, :maxDistance, :distanceMultiplier, :query
 
+# GeoNear distance returns distance in degrees. Use distanceMultiplier to return in Miles or KM.
+# set distanceMultiplier to 6371 to get distance in KM
+# set distanceMultiplier to 3963.19 to get distance in Miles
 </pre>
 
 If you need to operate on the Mongoid models referenced by the query result, simply call #to_models on it
@@ -153,9 +156,9 @@ You can also use a #to_model method on an individual query result like this:
 
 @nearest_city = Position.geoNear(another_address.location, :pos).first.to_model.city@
 
-# the model returned also has a distance accessor populated with the distance calculated by running the geoNear query 
+# the model returned also has a distance accessor populated with the distance calculated by running the geoNear query
 
-@nearest_distance = Position.geoNear(another_address.location, :pos).first.to_model.distance@  
+@nearest_distance = Position.geoNear(another_address.location, :pos).first.to_model.distance@
 
 You can now explicitly set/configure the Mongo DB version used. This will affect whether built-in Mongo DB distance calculation will be used or using standalone Ruby Haversine algorithm. By default the version is set to 1.5. See _geo_near_ specs for more details/info on this.
 
@@ -196,8 +199,8 @@ Find points near a given point within a maximum distance
 
 You can also use a Hash to define the nearMax
 
-<pre> 
-  places.where(:location.nearMax => {:point => [ 72, -44 ], :distance => 5})  
+<pre>
+  places.where(:location.nearMax => {:point => [ 72, -44 ], :distance => 5})
 </pre>
 
 Or use an Object (which must have the methods @#point@ and @#distance@ that return the point and max distance from that point)
@@ -206,8 +209,8 @@ Or use an Object (which must have the methods @#point@ and @#distance@ that retu
   near_max_ = (Struct.new :point, :distance).new
   near_max.point = [50, 40]
   near_max.distance = [30,55]
-    
-  places.where(:location.nearMax => near_max)  
+
+  places.where(:location.nearMax => near_max)
 </pre>
 
 Note: For the points, you can also use a hash or an object with the methods/keys, either @:lat, :lng@ or @:latitude, :longitude@
@@ -217,12 +220,12 @@ Example:
 <pre>
   center = (Struct.new :lat, :lng).new
   center.lat = 72
-  center.lng = -44  
-  places.where(:location.withinCenter => [center, radius])    
-  
+  center.lng = -44
+  places.where(:location.withinCenter => [center, radius])
+
   # OR
-  
-  places.where(:location.withinCenter => [{:lat => 72, :lng => -44}, radius])      
+
+  places.where(:location.withinCenter => [{:lat => 72, :lng => -44}, radius])
 </pre>
 
 h3. withinBox
@@ -238,12 +241,12 @@ h3. withinBox
 
 You can also use a Hash to define the box
 
-<pre> 
-  places.where(:location.withinBox => {:lower_left => [50, 40], :upper_right => [30,55]})  
-  
+<pre>
+  places.where(:location.withinBox => {:lower_left => [50, 40], :upper_right => [30,55]})
+
   # or mix and match
-  
-  places.where(:location.withinBox => {:lower_left => {:lat => 50, :lng => 40}, :upper_right => [30,55] } )      
+
+  places.where(:location.withinBox => {:lower_left => {:lat => 50, :lng => 40}, :upper_right => [30,55] } )
 </pre>
 
 Or use an object (which must have the methods @#lower_left@ and @#upper_right@ that return the points of the bounding box)
@@ -252,8 +255,8 @@ Or use an object (which must have the methods @#lower_left@ and @#upper_right@ t
   box = (Struct.new :lower_left, :upper_right).new
   box.lower_left =  [50, 40]
   box.upper_right = [30, 55]
-    
-  places.where(:location.withinBox => box)  
+
+  places.where(:location.withinBox => box)
 </pre>
 
 h3. withinCenter
@@ -262,17 +265,17 @@ h3. withinCenter
   center = [50, 40]
   radius = 4
 
-  places.where(:location.withinCenter => [center, radius])  
-  # => places: {"$within" : {"$center" : [[50, 40], 4]}  
+  places.where(:location.withinCenter => [center, radius])
+  # => places: {"$within" : {"$center" : [[50, 40], 4]}
 
-  places.where(:location.withinCenter(:sphere) => [center, radius])    
-  # => places: {"$within" : {"$centerSphere" : [[50, 40], 4]}  
+  places.where(:location.withinCenter(:sphere) => [center, radius])
+  # => places: {"$within" : {"$centerSphere" : [[50, 40], 4]}
 </pre>
 
 You can also use a hash to define the circle, with @:center@ and @:radius@ keys
 
-<pre> 
-  places.where(:location.withinCenter => {:center => [50, 40], :radius => 4})  
+<pre>
+  places.where(:location.withinCenter => {:center => [50, 40], :radius => 4})
 </pre>
 
 Or use an object (which must have the methods #lower_left and #upper_right that return the points of the bounding box)
@@ -281,6 +284,6 @@ Or use an object (which must have the methods #lower_left and #upper_right that
   circle = (Struct.new :center, :radius).new
   circle.center = [50, 40]
   circle.radius = 4
-  
-  places.where(:location.withinCenter => circle)  
+
+  places.where(:location.withinCenter => circle)
 </pre>

data/lib/mongoid/geo/geo_near.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+#require 'net/http'
 require 'active_support'
 require 'hashie'
 require 'mongoid/geo/haversine'
@@ -8,15 +8,15 @@ module Mongoid
     class << self
       attr_accessor :mongo_db_version
     end
-    
-    module Distance      
+
+    module Distance
       attr_reader :distance
-      
+
       def set_distance dist
         @distance = dist
       end
     end
-    
+
     module Model
       def to_model
         m = clazz.where(:_id => _id).first.extend(Mongoid::Geo::Distance)
@@ -24,37 +24,38 @@ module Mongoid
         m
       end
     end
-    
+
     module Models
       def to_models
         clazz = first.clazz
         ids = map(&:_id)
-        distance_hash = self.inject({}) do |result, item| 
+        distance_hash = self.inject({}) do |result, item|
           result[item._id] = item.distance
           result
         end
-        clazz.where(:_id.in => ids).to_a.map do |m| 
+        ret = clazz.where(:_id.in => ids).to_a.map do |m|
           m.extend(Mongoid::Geo::Distance)
-          m.set_distance distance_hash[m._id]
+          m.set_distance distance_hash[m._id.to_s]
           m
         end
+        ret.sort! {|a,b| a.distance <=> b.distance}
       end
     end
-    
+
     module Near
       def geoNear(center, location_attribute, options = {})
         center = center.respond_to?(:collection) ? center.send(location_attribute) : center
         query = create_query(self, center, options)
-        create_result(query_result(self, query, center, location_attribute)).extend(Mongoid::Geo::Models)
+        create_result(query_result(self, query, center, location_attribute, options)).extend(Mongoid::Geo::Models)
       end
 
       protected
-    
+
       def create_query clazz, center, options = {}
         num                 = options[:num]
         maxDistance         = options[:maxDistance]
         query               = options[:query]
-        distanceMultiplier  = options[:distanceMultiplier]        
+        distanceMultiplier  = options[:distanceMultiplier]
         mode                = options[:mode] || :plane
 
         nq = BSON::OrderedHash.new.tap do |near_query|
@@ -62,20 +63,25 @@ module Mongoid
           near_query["near"]         = center
           near_query["num"]          = num if num
           near_query["maxDistance"]  = maxDistance if maxDistance
-          near_query["distanceMultiplier"]  = distanceMultiplier if distanceMultiplier
+          # mongodb < 1.7 returns degrees but with earth flat. in Mongodb 1.7 you can set sphere and let mongodb calculate the distance in Miles or KM
+          # for mongodb < 1.7 we need to run Haversine first before calculating degrees to Km or Miles. See below.
+          near_query["distanceMultiplier"]  = distanceMultiplier if distanceMultiplier && Mongoid::Geo.mongo_db_version >= 1.7
           near_query["query"]        = query if query
 
           # works in mongodb 1.7 but still in beta and not supported by mongodb
-          near_query["spherical"]  = true if mode == :sphere
+          near_query["spherical"]  = true if mode == :sphere && Mongoid::Geo.mongo_db_version >= 1.7
         end
         nq
-      end      
+      end
 
-      def query_result clazz, query, center, location_attribute
-        lon,lat = center    
+      def query_result clazz, query, center, location_attribute, options = {}
+        distanceMultiplier  = options[:distanceMultiplier]
+        lon,lat = center
         query_result = clazz.collection.db.command(query)['results'].sort_by do |r|
           loc = r['obj'][location_attribute.to_s]
           r['distance'] = Mongoid::Geo::Haversine.distance(lat, lon, loc[1], loc[0]) if Mongoid::Geo.mongo_db_version < 1.7
+          # Calculate distance in KM or Miles if mongodb < 1.7
+          r['distance'] = r['distance'] * distanceMultiplier if distanceMultiplier && Mongoid::Geo.mongo_db_version < 1.7
           r['clazz'] = clazz
         end
       end
@@ -88,7 +94,7 @@ module Mongoid
           res._id = qr['obj']['_id'].to_s
           result.push(res)
         end
-      end    
-    end  
+      end
+    end
   end
 end

data/lib/mongoid/geo/haversine.rb

@@ -2,7 +2,7 @@ module Mongoid
   module Geo
     class Haversine
       #EARTH_RADIUS = 3963.19 # miles
-      EARTH_RADIUS = 6371 # kilometers
+#      EARTH_RADIUS = 6371 # kilometers
       RADIAN_PER_DEGREE = Math::PI / 180.0
 
       def self.distance(lat1, lng1, lat2, lng2)
@@ -14,7 +14,8 @@ module Mongoid
 
          a = Math.sin(distance_lat/2)**2 + Math.cos(lat1_radians) * Math.cos(lat2_radians) * Math.sin(distance_lng/2) ** 2
          c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
-         EARTH_RADIUS * c
+#         EARTH_RADIUS * c #
+         c
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geo
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-03-04 00:00:00.000000000 +01:00
+date: 2011-03-09 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156534080 !ruby/object:Gem::Requirement
+  requirement: &2154623900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *2156534080
+  version_requirements: *2154623900
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2156533620 !ruby/object:Gem::Requirement
+  requirement: &2154623440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 2.0.0.rc.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156533620
+  version_requirements: *2154623440
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &2156533160 !ruby/object:Gem::Requirement
+  requirement: &2154622980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156533160
+  version_requirements: *2154622980
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156532700 !ruby/object:Gem::Requirement
+  requirement: &2154622520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 3.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2156532700
+  version_requirements: *2154622520
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2156532240 !ruby/object:Gem::Requirement
+  requirement: &2154622060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156532240
+  version_requirements: *2154622060
 description: Geo spatial extension on Mongoid 2, to add more geo-spatial capabilities
 email:
 - kmandrup@gmail.com