mongoid_geo 0.1.2 → 0.1.3

data/README.textile

@@ -105,7 +105,7 @@ h3. nearSphere
 
 h3. nearMax
 
-Find all addresses near a point using spherical distance calculation
+Find points near a given point within a maximum distance
 
 <pre>
   base.where(:locations.nearMax => [[ 72, -44 ], 5])
@@ -113,6 +113,40 @@ Find all addresses near a point using spherical distance calculation
 
   base.where(:locations.nearMax(:sphere) => [[ 72, -44 ], 5])
   # => { $nearSphere: [50, 40] , $maxDistanceSphere: 3 }
+
+  base.where(:locations.nearMax(:sphere, :flat) => [[ 72, -44 ], 5])
+  # => { $nearSphere: [50, 40] , $maxDistance: 3 }
+</pre>
+
+You can also use a Hash to define the nearMax
+
+<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)
+
+<pre>
+  near_max_ = (Struct.new :point, :distance).new
+  near_max.point = [50, 40]
+  near_max.distance = [30,55]
+    
+  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
+
+Example:
+
+<pre>
+  center = (Struct.new :lat, :lng).new
+  center.lat = 72
+  center.lng = -44  
+  places.where(:location.withinCenter => [center, radius])    
+  
+  # OR
+  
+  places.where(:location.withinCenter => [{:lat => 72, :lng => -44}, radius])      
 </pre>
 
 h3. withinBox
@@ -120,24 +154,29 @@ h3. withinBox
 <pre>
   box = [[50, 40], [30,55]]
   base.where(:locations.withinBox => box)
-  # => locations: {"$within" : {"$box" : box}
+  # => locations: {"$within" : {"$box" : [[50, 40], [30,55]]}
 
   base.where(:locations.withinBox(:sphere) => box)
-  # => locations: {"$within" : {"$boxSphere" : box}
+  # => locations: {"$within" : {"$boxSphere" : [[50, 40], [30,55]]}
 </pre>
 
 You can also use a Hash to define the box
 
 <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] } )      
 </pre>
 
 Or use an Object (which must have the methods #lower_left and #upper_right that return the points of the bounding box)
 
 <pre>
   box = (Struct.new :lower_left, :upper_right).new
-  box.lower_left = [50, 40]
-  box.upper_right = [30,55]  
+  box.lower_left =  [50, 40]
+  box.upper_right = [30, 55]
+    
   places.where(:location.withinBox => box)  
 </pre>
 
@@ -146,15 +185,15 @@ h3. withinCenter
 <pre>
   center = [50, 40]
   radius = 4
-  
-  # places: {"$within" : {"$centerSphere" : [center, radius]}  
-  places.where(:location.withinCenter(:sphere) => [center, radius])  
 
-  # places: {"$within" : {"$center" : [center, radius]}
   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]}  
 </pre>
 
-You can also use a Hash to define the box
+You can also use a Hash to define the circle
 
 <pre> 
   places.where(:location.withinCenter => {:center => [50, 40], :radius => 4})  
@@ -166,5 +205,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)  
 </pre>

data/lib/mongoid/geo/criterion/outer_operator.rb

@@ -18,10 +18,14 @@ module Mongoid #:nodoc:
         @outer_op = opts[:outer_op]        
       end
 
-      def make_hash v
-        v = extract_box(v) if !v.kind_of?(Array) && operator =~ /box/
+      def make_hash v                               
+        if operator =~ /box/
+          v = extract_box(v) if !v.kind_of?(Array)
+          v = [to_points(v.first), to_points(v.last)]
+        end
+        
         v = extract_circle(v) if !v.kind_of?(Array) && operator =~ /center/
-        {"$#{outer_op}" => {"$#{operator}" => v } }
+        {"$#{outer_op}" => {"$#{operator}" => to_points(v) } }
       end
 
       def hash
@@ -39,6 +43,10 @@ module Mongoid #:nodoc:
       
       protected
 
+      def to_points v
+        v.extend(Mongoid::Geo::Point).to_points
+      end
+
       def extract_circle(v)
         case v
         when Hash
@@ -49,12 +57,12 @@ module Mongoid #:nodoc:
       end
       
       def extract_box v
-        case v
+        box = case v
         when Hash
           [v[:lower_left], v[:upper_right]]
         else
           v.respond_to?(:lower_left) ? [v.lower_left, v.upper_right] : raise("Can't extract box from: #{v}, must have :lower_left and :upper_right methods or equivalent hash keys in Hash")
-        end
+        end        
       end
     end
   end

data/lib/mongoid/geo/criterion/twin_operators.rb

@@ -20,7 +20,7 @@ module Mongoid #:nodoc:
 
       def make_hash v     
         v = extract_nearMax(v) if !v.kind_of?(Array) && op_b =~ /max/i
-        {"$#{op_a}" => v.first, "$#{op_b}" => v.last }
+        {"$#{op_a}" => to_points(v.first), "$#{op_b}" => to_points(v.last) }
       end
 
       def hash
@@ -35,10 +35,13 @@ module Mongoid #:nodoc:
         return false unless other.is_a?(self.class)        
         self.op_a == other.op_a && self.op_b == other.op_b && self.key == other.key 
       end
-      
+            
       protected
       
-      protected
+      def to_points v
+        return v if v.kind_of? Fixnum 
+        v.extend(Mongoid::Geo::Point).to_points
+      end
 
       def extract_nearMax(v)
         case v

data/lib/mongoid/geo/point.rb

@@ -0,0 +1,18 @@
+module Mongoid::Geo
+  module Point
+    # convert hash or object to [x, y] of floats
+    def to_points
+      case self
+      when Hash
+        return [self[:lat], self[:lng]] if self[:lat]
+        return [self[:latitude], self[:longitude]] if self[:latitude]
+        raise "Hash must contain either :lat, :lng or :latitude, :longitude keys to be converted to a geo point"
+      else
+        return [self.lat, self.lng] if self.respond_to? :lat
+        return [self.latitude, self.longitude] if self.respond_to? :latitude
+        self
+        # raise 'Object must contain either #lat, #lng or #latitude, #longitude methods to be converted to a geo point'
+      end
+    end
+  end
+end

data/lib/mongoid/geo.rb

@@ -1,3 +1,9 @@
+module Mongoid
+  module Geo
+  end
+end
+
+require 'mongoid/geo/point'
 require 'mongoid/geo/criteria'
 require 'mongoid/geo/fields'
 require 'mongoid/geo/index'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: !!null 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable: !!null
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156734180 !ruby/object:Gem::Requirement
+  requirement: &2156985600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156734180
+  version_requirements: *2156985600
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2156733620 !ruby/object:Gem::Requirement
+  requirement: &2156984940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 2.0.0.rc.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156733620
+  version_requirements: *2156984940
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &2156733100 !ruby/object:Gem::Requirement
+  requirement: &2156984320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156733100
+  version_requirements: *2156984320
 description: Geo spatial extension on Mongoid 2, to add more geo-spatial capabilities
 email:
 - kmandrup@gmail.com
@@ -61,6 +61,7 @@ files:
 - lib/mongoid/geo/fields.rb
 - lib/mongoid/geo/index.rb
 - lib/mongoid/geo/inflections.rb
+- lib/mongoid/geo/point.rb
 - lib/mongoid/geo.rb
 - lib/mongoid_geo.rb
 - MIT-LICENSE