mongoid_geo 0.5.1 → 0.5.2

data/README.textile

@@ -4,13 +4,16 @@ 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 Mongo DB 1.7+ sphere distance calculations
 * 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.
+* Calculate locations near a given point (geoNear)
 
 h2. Mongoid 2 geo features
 
+The following summarized what geo functionality is already provided by Mongoid 2.0 (as far as I could tell, May 9th, 2011)
+
 h3. Find addresses near a point
 
 <pre>
@@ -38,26 +41,29 @@ h3. Create geo-spatial index
   autocreate_indexes: true
 </pre>
 
-These are the only geo features I could find are currently built-in for Mongoid 2.
-_Mongoid Geo_ implements the following extra features...
+These are the only geo features I could find that are currently built-in for Mongoid 2.
+
+_Mongoid Geo_ implements some nice extra geo features:
 
 h1. Mongoid Geo features
 
-The following briefly demonstrates all the features that Mongoid Geo currently provides
+The following briefly demonstrates all the features that *mongoid-geo* provides:
 
 h2. Geo index
 
-Old/Manual way: @index [[ :location, Mongo::GEO2D ]], :min => -180, :max => 180@
+A new _geo_index_ class method 
 
-Using new _geo_index_ class method : @geo_index :location@
+Usage example:
+
+@geo_index :location@
 
 Note: For embedded documents, you must define the index in the root collection class. (davemitchell)
 
-h2. Special geo-array attribute writer
+h2. Geo option for Array GPS location field
 
-When setting a geo-location array, the setter should try to convert the value to an array of floats
+Objective: When setting a geo GPS location array, the setter should try to convert the value to an array of floats
 
-Old/Manual way:
+The "old" manual way:
 
 <pre>
   class Person
@@ -69,7 +75,9 @@ Old/Manual way:
   end
 </pre>
 
-With the new @:geo@ option supplied by _mongoid-geo_ :
+*mongoid-geo* provides a new @:geo@ option that can be used with any Array field:
+
+Usage example:
 
 <pre>
   class Person
@@ -121,11 +129,12 @@ With the new @:geo@ option supplied by _mongoid-geo_ :
 
   # or alternatively 
   Mongoid::Geo.spherical = true
+  
+  address.location = "23.5, -47"
+  address.location.should == [23.5, -47].reverse  
 </pre>
 
-h2. News update (May 9, 2011)
-
-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
+h2. geoNear
 
 <pre>
 class Address
@@ -148,46 +157,42 @@ 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 returns each distance calculated in degrees. Use the :distanceMultiplier or :unit option to return in the unit of your choice (see unit.rb).
 
-Set :distanceMultiplier to 6371 to get distance in KM
-Set :distanceMultiplier to 3963.19 to get distance in Miles
+Set @:distanceMultiplier = 6371@ to get distance in KMs
+Set @@:distanceMultiplier = @3963.19@ to get distance in Miles
 
-You can also use the :unit option instead like this (supports :feet, :meters, :kms, :miles)
+You can also use the :unit option instead like this (supports :feet, :meters, :kms, :miles):
 
-@results = Address.geoNear @center.location, :location, :unit => :km, :dist_order => :desc@
+@results = Address.geoNear @center.location, :location, :unit => :feet, :dist_order => :desc@
 
-The geoNear query result is returned as Mongoid::Criteria
+The _geoNear_ query result is returned as a _Mongoid::Criteria_
 
 @results.desc(:distance).map(&:distance)@
 
-Note that the :fromLocation field, stores the location the distance was last calculated as a hash of the Point it was calculated from
+Note that the @:fromLocation@ field, stores the location the distance was last calculated as a Hash of the GPS location point it was calculated from:
 
 @[23.5, -47].hash@ 
 
-</pre>
-
-If you need to operate on the Mongoid models referenced by the query result, simply call #to_models on it
-Fx to get the city of the first model instance from the query result:
+This hash can be retrieved (and used for comparison?) using the @fromHash@ field 
 
-@nearest_city = Position.geoNear(another_address.location, :pos).to_models.first.city@
+@from = results.first.fromHash@
 
-You can also use a #to_model method on an individual query result like this:
+You can also at any time get the GPS location point which the distance of any result instance was calculated from, using the @fromPoint field
 
-@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
-
-@nearest_distance = Position.geoNear(another_address.location, :pos).first.to_model.distance@
+@from = results.first.fromPoint@
+</pre>
 
-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.
+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 Mongo DB version is set to 1.8 (as of May 9, 2011) . See _geo_near_ specs for more details/info on this.
 
 @Mongoid::Geo.mongo_db_version = 1.7@
 

data/lib/mongoid/geo/fields.rb

@@ -28,7 +28,8 @@ module Mongoid #:nodoc
           define_method("#{meth}=") do |value|
             if options[:geo]
               self.class.send :field, :distance, :type => Float
-              self.class.send :field, :fromLocation, :type => String
+              self.class.send :field, :fromHash, :type => String
+              self.class.send :field, :fromPoint, :type => Array
             end
 
             if options[:type] == Array && options[:geo]

data/lib/mongoid/geo/geo_near.rb

@@ -36,11 +36,12 @@ module Mongoid
     module 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] } ]
+        from_hash = Hash[ self.map { |item| [item._id, item.fromPoint] } ]
 
         ret = to_criteria.to_a.map do |m|
           m.distance = distance_hash[m._id.to_s]
-          m.fromLocation = from_hash[m._id.to_s]
+          m.fromPoint = from_hash[m._id.to_s]
+          m.fromHash = from_hash[m._id.to_s].hash
           m.save if mode == :save
           m
         end
@@ -50,7 +51,7 @@ module Mongoid
       def as_criteria direction = nil
         to_models(:save) 
         ids = first.klass.all.map(&:_id)
-        crit = Mongoid::Criteria.new(first.klass).where(:_id.in => ids, :fromLocation => first.fromLocation)
+        crit = Mongoid::Criteria.new(first.klass).where(:_id.in => ids, :fromHash => first.fromPoint.hash) 
         crit = crit.send(direction, :distance) if direction
         crit
       end      
@@ -98,7 +99,8 @@ 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
+          r['fromPoint'] = center
+          # r['fromHash'] = center.hash
         end
         query_result
       end
@@ -107,7 +109,8 @@ 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.fromPoint = qr['fromPoint']
+          # res.fromHash = qr['fromHash']          
           res.distance = qr[distance_meth]
           res._id = qr['obj']['_id'].to_s
           res

data/lib/mongoid_geo.rb

@@ -1,4 +1,4 @@
 require 'mongoid/geo'
 
-Mongoid::Geo.mongo_db_version = 1.5
+Mongoid::Geo.mongo_db_version = 1.8
 Mongoid::Geo.spherical = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geo
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-05-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157028960 !ruby/object:Gem::Requirement
+  requirement: &2152549140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *2157028960
+  version_requirements: *2152549140
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2157044860 !ruby/object:Gem::Requirement
+  requirement: &2152548680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2157044860
+  version_requirements: *2152548680
 - !ruby/object:Gem::Dependency
   name: bson
-  requirement: &2157044400 !ruby/object:Gem::Requirement
+  requirement: &2152548220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2157044400
+  version_requirements: *2152548220
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2157043940 !ruby/object:Gem::Requirement
+  requirement: &2152547760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 3.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2157043940
+  version_requirements: *2152547760
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2157043480 !ruby/object:Gem::Requirement
+  requirement: &2152547300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2157043480
+  version_requirements: *2152547300
 description: Geo spatial extension on Mongoid 2, to add more geo-spatial capabilities
 email:
 - kmandrup@gmail.com