mongoid_geo 0.1.3 → 0.1.4

data/README.textile

@@ -27,8 +27,8 @@ h3. Create geo-spatial index
 
 <pre>
   class Person
-    field :locations, :type => Array
-    index [[ :locations, Mongo::GEO2D ]], :min => -180, :max => 180      
+    field :location, :type => Array
+    index [[ :location, Mongo::GEO2D ]], :min => -180, :max => 180      
   end
 
   # to ensure indexes are created, either:
@@ -47,9 +47,9 @@ The following briefly demonstrates all the features that Mongoid Geo currently p
 
 h2. Geo index
 
-Old/Manual way: @index [[ :locations, Mongo::GEO2D ]], :min => -180, :max => 180@
+Old/Manual way: @index [[ :location, Mongo::GEO2D ]], :min => -180, :max => 180@
 
-Using new _geo_index_ class method : @geo_index :locations@
+Using new _geo_index_ class method : @geo_index :location@
 
 h2. Special geo-array attribute writer 
 
@@ -71,17 +71,27 @@ With the new @:geo@ option supplied by _mongoid-geo_ :
 
 <pre>
   class Person
-    field :locations, :type => Array, :geo => true
+    field :location, :type => Array, :geo => true
     
-    geo_index :locations
+    geo_index :location
   end  
   
    p = Person.new
-   # set via String or Strings
-   p.locations = "45.1, -3.4"
-   p.locations = "45.1", "-3.4"   
 
-   assert([45.1, -3.4], p.locations)   
+   # 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 = [{:lat => 45.1, :lng => -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)   
 </pre>
 
 
@@ -90,7 +100,7 @@ h2. Mongoid Geo extra inclusions
 Find addresses near a point using spherical distance calculation
 
 <pre>
-  Address.nearSphere(:locations => [ 72, -44 ])
+  Address.nearSphere(:location => [ 72, -44 ])
 </pre>
 
 
@@ -99,8 +109,8 @@ h2. Mongoid Geo extra inflections
 h3. nearSphere
 
 <pre>
-  base.where(:locations.nearSphere => [ 72, -44 ])
-  # => :locations => { "$nearSphere" : [ 72, -44 ] }
+  base.where(:location.nearSphere => [ 72, -44 ])
+  # => :location => { "$nearSphere" : [ 72, -44 ] }
 </pre>
 
 h3. nearMax
@@ -108,13 +118,13 @@ h3. nearMax
 Find points near a given point within a maximum distance
 
 <pre>
-  base.where(:locations.nearMax => [[ 72, -44 ], 5])
+  base.where(:location.nearMax => [[ 72, -44 ], 5])
   # => { $near: [50, 40] , $maxDistance: 3 }
 
-  base.where(:locations.nearMax(:sphere) => [[ 72, -44 ], 5])
+  base.where(:location.nearMax(:sphere) => [[ 72, -44 ], 5])
   # => { $nearSphere: [50, 40] , $maxDistanceSphere: 3 }
 
-  base.where(:locations.nearMax(:sphere, :flat) => [[ 72, -44 ], 5])
+  base.where(:location.nearMax(:sphere, :flat) => [[ 72, -44 ], 5])
   # => { $nearSphere: [50, 40] , $maxDistance: 3 }
 </pre>
 
@@ -124,7 +134,7 @@ You can also use a Hash to define the nearMax
   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)
+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
@@ -134,7 +144,7 @@ Or use an Object (which must have the methods #point and #distance that return t
   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
+Note: For the points, you can also use a hash or an object with the methods/keys, either @:lat, :lng@ or @:latitude, :longitude@
 
 Example:
 
@@ -153,10 +163,10 @@ h3. withinBox
 
 <pre>
   box = [[50, 40], [30,55]]
-  base.where(:locations.withinBox => box)
+  base.where(:location.withinBox => box)
   # => locations: {"$within" : {"$box" : [[50, 40], [30,55]]}
 
-  base.where(:locations.withinBox(:sphere) => box)
+  base.where(:location.withinBox(:sphere) => box)
   # => locations: {"$within" : {"$boxSphere" : [[50, 40], [30,55]]}
 </pre>
 
@@ -170,7 +180,7 @@ You can also use a Hash to define the box
   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)
+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
@@ -193,13 +203,13 @@ h3. withinCenter
   # => places: {"$within" : {"$centerSphere" : [[50, 40], 4]}  
 </pre>
 
-You can also use a Hash to define the circle
+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>
 
-Or use an Object (which must have the methods #lower_left and #upper_right that return the points of the bounding box)
+Or use an object (which must have the methods #lower_left and #upper_right that return the points of the bounding box)
 
 <pre>
   circle = (Struct.new :center, :radius).new

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

@@ -21,11 +21,11 @@ module Mongoid #:nodoc:
       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)]
+          v = [to_point(v.first), to_point(v.last)]
         end
         
         v = extract_circle(v) if !v.kind_of?(Array) && operator =~ /center/
-        {"$#{outer_op}" => {"$#{operator}" => to_points(v) } }
+        {"$#{outer_op}" => {"$#{operator}" => v } }
       end
 
       def hash
@@ -42,11 +42,9 @@ module Mongoid #:nodoc:
       end
       
       protected
-
-      def to_points v
-        v.extend(Mongoid::Geo::Point).to_points
-      end
-
+      
+      include Mongoid::Geo::PointConversion
+      
       def extract_circle(v)
         case v
         when Hash

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}" => to_points(v.first), "$#{op_b}" => to_points(v.last) }
+        {"$#{op_a}" => to_point(v.first), "$#{op_b}" => to_point(v.last) }
       end
 
       def hash
@@ -37,12 +37,9 @@ module Mongoid #:nodoc:
       end
             
       protected
-      
-      def to_points v
-        return v if v.kind_of? Fixnum 
-        v.extend(Mongoid::Geo::Point).to_points
-      end
 
+      include Mongoid::Geo::PointConversion
+      
       def extract_nearMax(v)
         case v
         when Hash

data/lib/mongoid/geo/fields.rb

@@ -8,11 +8,15 @@ module Mongoid #:nodoc
           define_method("#{meth}=") do |value| 
             if options[:type] == Array && options[:geo]
               value = case value
-                when String then value.split(",").map(&:to_f)
-                when Array then value.map(&:to_f)
-                else value
+              when String 
+                value.split(",").map(&:to_f)
+              when Array 
+                value.compact.extend(Mongoid::Geo::Point).to_points
+              else
+                !value.nil? ? value.extend(Mongoid::Geo::Point).to_point : value
               end
             end
+            value = value[0..1] if !value.nil?
             write_attribute(name, value) 
           end
           define_method("#{meth}?") do

data/lib/mongoid/geo/point.rb

@@ -2,17 +2,42 @@ module Mongoid::Geo
   module Point
     # convert hash or object to [x, y] of floats
     def to_points
+      v = self.kind_of?(Array) ? self.map {|p| p.kind_of?(Fixnum) ? p.to_f : p.extend(Mongoid::Geo::Point).to_point } : self
+      v.flatten
+    end
+
+    def to_point
       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"
+      when nil
+        nil
+      when Array
+        self.map(&:to_f)
       else
         return [self.lat, self.lng] if self.respond_to? :lat
         return [self.latitude, self.longitude] if self.respond_to? :latitude
-        self
+        self.to_f
         # raise 'Object must contain either #lat, #lng or #latitude, #longitude methods to be converted to a geo point'
       end
     end
   end
 end
+         
+module Mongoid::Geo
+  module PointConversion
+    protected
+
+    def to_point v
+      return v if v.kind_of? Fixnum
+      v.extend(Mongoid::Geo::Point).to_point
+    end
+
+    def to_points v
+      return v if v.kind_of? Fixnum 
+      v.extend(Mongoid::Geo::Point).to_points
+    end
+  end
+end  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geo
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: !!null 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: !!null 
 bindir: bin
 cert_chain: []
-date: 2011-02-05 00:00:00.000000000 +01:00
+date: 2011-02-06 00:00:00.000000000 +01:00
 default_executable: !!null 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156985600 !ruby/object:Gem::Requirement
+  requirement: &2156349680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156985600
+  version_requirements: *2156349680
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2156984940 !ruby/object:Gem::Requirement
+  requirement: &2156349140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 2.0.0.rc.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156984940
+  version_requirements: *2156349140
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &2156984320 !ruby/object:Gem::Requirement
+  requirement: &2156348440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156984320
+  version_requirements: *2156348440
 description: Geo spatial extension on Mongoid 2, to add more geo-spatial capabilities
 email:
 - kmandrup@gmail.com