mongoid_geo 0.4.3 → 0.5.0

data/README.textile

@@ -123,9 +123,9 @@ With the new @:geo@ option supplied by _mongoid-geo_ :
   Mongoid::Geo.spherical = true
 </pre>
 
-h2. News update (March 2)
+h2. News update (May 9, 2011)
 
-* Added support for geoNear queries!!!
+The geoNear queries can now convert the result into a Mongoid::Criteria, where distance from a given location is sorted in either descending or ascending (default) order
 
 <pre>
 class Address
@@ -145,18 +145,40 @@ class Position
   field :pos, :type => Array, :geo => true
   ...
 end
+</pre>
+
+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@
+
+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
+
+You can also use the :unit option instead like this (supports :feet, :meters, :kms, :miles)
+
+results = Address.geoNear @center.location, :location, :unit => :km
+
+The query result is returned as an Array of Hashies
+
+The result can be then converted to a Mongoid::Criteria if needed
+
+pp results.as_criteria.to_a.map(&:distance)
+pp results.as_criteria(:desc).to_a.map(&:distance)
+
+Or converted to an array of Model instances
 
-# Find all positions sorted nearest to the address loation
-nearest_positions = Position.geoNear(another_address.location, :pos)
+pp results.to_models.map(&:distance) 
 
-# perform distance locations in Speherical mode inside Mongo DB (default is :plane)
-nearest_positions = Position.geoNear(another_address.location, :pos, :mode => :sphere)
+Note that the :fromLocation field, stores the location the distance was last calculated as a hash of the Point it was calculated from
 
-# other options supported are: :num, :maxDistance, :distanceMultiplier, :query
+@[23.5, -47].hash@ 
 
-# 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

data/lib/mongoid/geo/fields.rb

@@ -26,6 +26,11 @@ module Mongoid #:nodoc
           end
 
           define_method("#{meth}=") do |value|
+            if options[:geo]
+              self.class.send :field, :distance, :type => Float
+              self.class.send :field, :fromLocation, :type => String
+            end
+
             if options[:type] == Array && options[:geo]
               value = case value
               when String
@@ -37,7 +42,7 @@ module Mongoid #:nodoc
               end
               value = value[0..1] if !value.nil?
             end
-            value.reverse! if Mongoid::Geo.spherical && value
+            value.reverse! if Mongoid::Geo.spherical && value && !value.kind_of?(BSON::ObjectId)
             write_attribute(name, value) 
           end
 

data/lib/mongoid/geo/geo_near.rb

@@ -25,39 +25,38 @@ module Mongoid
       end
     end
 
-    module Distance
-      attr_reader :distance
-
-      def set_distance dist
-        @distance = dist
-      end
-    end
-
     module Model
       def to_model
         m = klass.where(:_id => _id).first.extend(Mongoid::Geo::Distance)
-        m.set_distance distance
+        m.distance = distance
         m
       end
     end
 
     module Models
-      def to_models
+      def to_models mode = nil
         distance_hash = Hash[ self.map {|item| [item._id, item.distance] } ]
+        from_hash = Hash[ self.map { |item| [item._id, item.fromLocation] } ]
 
         ret = to_criteria.to_a.map do |m|
-          m.extend(Mongoid::Geo::Distance)
-          m.set_distance distance_hash[m._id.to_s]
+          m.distance = distance_hash[m._id.to_s]
+          m.fromLocation = from_hash[m._id.to_s]
+          m.save if mode == :save
           m
         end
-
         ret.sort {|a,b| a.distance <=> b.distance}
       end
+
+      def as_criteria direction = :asc
+        to_models(:save)
+        ids = first.klass.where().map(&:_id)
+        Mongoid::Criteria.new(first.klass).where(:_id.in => ids, :fromLocation => first.fromLocation).send(direction, :distance)
+      end      
       
       def to_criteria
-        ids = map(&:_id)
-        first.klass.where(:_id.in => ids)
-      end
+        ids = map(&:_id)  
+        Mongoid::Criteria.new(first.klass).where(:_id.in => ids).desc(:distance)
+      end      
     end
 
     module Near
@@ -97,6 +96,7 @@ module Mongoid
           # Calculate distance in KM or Miles if mongodb < 1.7
           r[distance_meth] ||= calc_distance(r, center, location_attribute, options) if Mongoid::Geo.mongo_db_version < 1.7
           r['klass'] = klass
+          r['from'] = center.hash
         end
         query_result
       end
@@ -105,10 +105,11 @@ module Mongoid
         qres.map do |qr|
           res = Hashie::Mash.new(qr['obj'].to_hash).extend(Mongoid::Geo::Model)
           res.klass = qr['klass']
+          res.fromLocation = qr['from']
           res.distance = qr[distance_meth]
           res._id = qr['obj']['_id'].to_s
           res
-        end
+        end          
       end
       
       private
@@ -116,39 +117,8 @@ module Mongoid
       def distance_multiplier options
         distanceMultiplier  = options[:distanceMultiplier]
         return distanceMultiplier if distanceMultiplier && Mongoid::Geo.mongo_db_version >= 1.7
-
-        return radian_multiplier[options[:unit]] if options[:unit] && Mongoid::Geo.mongo_db_version >= 1.7      
-        unit_multiplier[options[:unit]] if options[:unit]
-      end
-
-      def unit_multiplier
-        {
-          :feet => 0.305,
-          :ft => 0.305,
-          :m => 1,
-          :meters => 1,
-          :meter => 1,
-          :km => 6371,
-          :kms => 6371,
-          :mil => 3959,
-          :mile => 3959,
-          :miles => 3959
-        }
-      end
-
-      def radian_multiplier
-        { 
-          :feet => 364491.8,
-          :ft => 364491.8,
-          :m => 111170,
-          :meter => 111170,
-          :meters => 111170,
-          :km => 111.17,
-          :kms => 111.17,
-          :mil => 69.407,
-          :mile => 69.407,
-          :miles => 69.407
-        }
+        return Mongoid::Geo::Unit.distMultiplier(options[:unit]) if options[:unit]
+        1
       end
       
       def query_results klass, query 

data/lib/mongoid/geo/unit.rb

@@ -0,0 +1,83 @@
+module Mongoid
+  module Geo
+    class Unit
+      class << self
+        def key unit = :km
+          unit = unit.to_sym
+          methods.grep(/_unit/).each do |meth|
+            return meth.to_s.chomp('_unit').to_sym if send(meth).include? unit
+          end
+          raise ArgumentError, "Unknown unit key: #{unit}"
+        end
+
+        def distMultiplier unit = :km
+          unit_key = key(unit)
+          return radian_multiplier[unit_key] if unit_key && Mongoid::Geo.mongo_db_version >= 1.7      
+          unit_multiplier[unit_key] if unit_key
+        end
+
+        def precision
+          {
+            :feet => 0,
+            :meters => 2,
+            :kms => 4,
+            :miles => 4,
+            :radians => 4
+          }
+        end
+
+        # from mongoid-geo, as suggested by niedhui :)
+        def radian_multiplier
+          { 
+            :feet => 364491.8,
+            :meters => 111170,
+            :kms => 111.17,
+            :miles => 69.407,
+            :radians => 1
+          }
+        end
+
+        def unit_multiplier
+          {
+            :feet => 0.305,
+            :meters => 1,
+            :kms => 6371,
+            :miles => 3959
+          }
+        end
+
+        def meters_map
+          {
+           :feet => 3.2808,
+           :meters => 1,
+           :kms => 0.001,
+           :miles => 0.00062137,
+           :radians => 111170
+          }
+        end
+      
+        protected
+
+        def feet_unit 
+          [:ft, :feet, :foot]
+        end
+      
+        def meters_unit 
+          [:m, :meter, :meters]
+        end
+
+        def kms_unit 
+          [:km, :kms, :kilometer, :kilometers]
+        end
+
+        def miles_unit 
+          [:mil, :mile, :miles]
+        end
+
+        def radians_unit 
+          [:rad, :radians]
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/geo.rb

@@ -4,6 +4,7 @@ module Mongoid
 end
 
 require 'mongoid/geo/point'
+require 'mongoid/geo/unit'
 require 'mongoid/geo/fields'
 require 'mongoid/geo/criteria'
 require 'mongoid/geo/index'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geo
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-04 00:00:00.000000000Z
+date: 2011-05-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152917100 !ruby/object:Gem::Requirement
+  requirement: &2152937900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *2152917100
+  version_requirements: *2152937900
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2152916640 !ruby/object:Gem::Requirement
+  requirement: &2152965320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152916640
+  version_requirements: *2152965320
 - !ruby/object:Gem::Dependency
   name: bson
-  requirement: &2152916180 !ruby/object:Gem::Requirement
+  requirement: &2152964860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2152916180
+  version_requirements: *2152964860
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152915720 !ruby/object:Gem::Requirement
+  requirement: &2152964400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 3.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152915720
+  version_requirements: *2152964400
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2152931640 !ruby/object:Gem::Requirement
+  requirement: &2152963940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152931640
+  version_requirements: *2152963940
 description: Geo spatial extension on Mongoid 2, to add more geo-spatial capabilities
 email:
 - kmandrup@gmail.com
@@ -85,6 +85,7 @@ files:
 - lib/mongoid/geo/index.rb
 - lib/mongoid/geo/inflections.rb
 - lib/mongoid/geo/point.rb
+- lib/mongoid/geo/unit.rb
 - lib/mongoid/geo.rb
 - lib/mongoid_geo.rb
 - MIT-LICENSE
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.0
 signing_key: 
 specification_version: 3
 summary: Adds extra convenience methods for geo-spatial operations etc.