rails-geocoder 0.8.6 → 0.8.7

data/CHANGELOG.rdoc

@@ -2,6 +2,11 @@
 
 Per-release changes to Geocoder.
 
+== 0.8.7 (2009 Nov 4)
+
+* Added Geocoder.geographic_center method.
+* Replaced _get_coordinates class method with read_coordinates instance method.
+
 == 0.8.6 (2009 Oct 27)
 
 * The fetch_coordinates method now assigns coordinates to attributes (behaves like fetch_coordinates! used to) and fetch_coordinates! both assigns and saves the attributes.

data/README.rdoc

@@ -73,6 +73,9 @@ Some utility methods are also available:
   
   # look up coordinates of some location (like searching Google Maps)
   Geocoder.fetch_coordinates("25 Main St, Cooperstown, NY")
+  
+  # find the geographic center (aka center of gravity) of objects or points
+  Geocoder.geographic_center([ city1, city2, city3, [40.22,-73.99], city4 ])
 
 
 == More On Configuration

data/VERSION

@@ -1 +1 @@
-0.8.6
+0.8.7

data/lib/geocoder.rb

@@ -102,22 +102,21 @@ module Geocoder
         :limit  => limit
       }
     end
+  end
 
-    ##
-    # Get the coordinates [lat,lon] of an object. This is not great but it
-    # seems cleaner than polluting the object method namespace.
-    #
-    def _get_coordinates(object)
-      [object.send(geocoder_options[:latitude]),
-      object.send(geocoder_options[:longitude])]
-    end
+  ##
+  # Read the coordinates [lat,lon] of an object. This is not great but it
+  # seems cleaner than polluting the instance method namespace.
+  #
+  def read_coordinates
+    [:latitude, :longitude].map{ |i| send self.class.geocoder_options[i] }
   end
-  
+
   ##
   # Is this object geocoded? (Does it have latitude and longitude?)
   #
   def geocoded?
-    self.class._get_coordinates(self).compact.size > 0
+    read_coordinates.compact.size > 0
   end
   
   ##
@@ -126,7 +125,7 @@ module Geocoder
   #
   def distance_to(lat, lon, units = :mi)
     return nil unless geocoded?
-    mylat,mylon = self.class._get_coordinates(self)
+    mylat,mylon = read_coordinates
     Geocoder.distance_between(mylat, mylon, lat, lon, :units => units)
   end
   
@@ -137,9 +136,8 @@ module Geocoder
   #
   def nearbys(radius = 20, options = {})
     return [] unless geocoded?
-    coords  = self.class._get_coordinates(self)
     options = {:conditions => ["id != ?", id]}.merge(options)
-    self.class.near(coords, radius, options) - [self]
+    self.class.near(read_coordinates, radius, options) - [self]
   end
   
   ##
@@ -213,6 +211,44 @@ module Geocoder
     c * units[options[:units]]
   end
   
+  ##
+  # Compute the geographic center (aka geographic midpoint, center of
+  # gravity) for an array of geocoded objects and/or [lat,lon] arrays
+  # (can be mixed). Any objects missing coordinates are ignored. Follows
+  # the procedure documented at http://www.geomidpoint.com/calculation.html.
+  #
+  def self.geographic_center(points)
+  
+    # convert objects to [lat,lon] arrays and remove nils
+    points = points.map{ |p|
+      p.is_a?(Array) ? p : (p.geocoded?? p.read_coordinates : nil)
+    }.compact
+    
+    # convert degrees to radians
+    points.map!{ |p| [to_radians(p[0]), to_radians(p[1])] }
+    
+    # convert to Cartesian coordinates
+    x = []; y = []; z = []
+    points.each do |p|
+      x << Math.cos(p[0]) * Math.cos(p[1])
+      y << Math.cos(p[0]) * Math.sin(p[1])
+      z << Math.sin(p[0])
+    end
+
+    # compute average coordinate values
+    xa, ya, za = [x,y,z].map do |c|
+      c.inject(0){ |tot,i| tot += i } / c.size.to_f
+    end
+    
+    # convert back to latitude/longitude
+    lon = Math.atan2(ya, xa)
+    hyp = Math.sqrt(xa**2 + ya**2)
+    lat = Math.atan2(za, hyp)
+    
+    # return answer in degrees
+    [to_degrees(lat), to_degrees(lon)]
+  end
+
   ##
   # Convert degrees to radians.
   #
@@ -220,6 +256,13 @@ module Geocoder
     degrees * (Math::PI / 180)
   end
   
+  ##
+  # Convert radians to degrees.
+  #
+  def self.to_degrees(radians)
+    (radians * 180.0) / Math::PI
+  end
+  
   ##
   # Query Google for geographic information about the given phrase.
   #

data/rails-geocoder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails-geocoder}
-  s.version = "0.8.6"
+  s.version = "0.8.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Reisner"]
-  s.date = %q{2009-10-27}
+  s.date = %q{2009-11-04}
   s.description = %q{Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. It does not rely on proprietary database functions so finding geocoded objects in a given area is easily done using out-of-the-box MySQL or even SQLite.}
   s.email = %q{alex@alexreisner.com}
   s.extra_rdoc_files = [

data/test/geocoder_test.rb

@@ -7,4 +7,17 @@ class GeocoderTest < Test::Unit::TestCase
     assert_equal [40.7495760, -73.9916733], v.fetch_coordinates
     assert_equal [40.7495760, -73.9916733], [v.latitude, v.longitude]
   end
+  
+  # sanity check
+  def test_distance_between
+    assert_equal 69, Geocoder.distance_between(0,0, 0,1).round
+  end
+  
+  # sanity check
+  def test_geographic_center
+    assert_equal [0.0, 0.5],
+      Geocoder.geographic_center([[0,0], [0,1]])
+    assert_equal [0.0, 1.0],
+      Geocoder.geographic_center([[0,0], [0,1], [0,2]])
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails-geocoder
 version: !ruby/object:Gem::Version 
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors: 
 - Alex Reisner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 -04:00
+date: 2009-11-04 00:00:00 -05:00
 default_executable: 
 dependencies: []