Merge lp:~max-rabkin/ibid/coords-892484 into lp:ibid

[Max Rabkin]

Add lookup for coordinates of places

[lp:~max-rabkin/ibid/coords-892484]

1045. By Max Rabkin on 2011-11-19

Allow 'coords'

1046. By Max Rabkin on 2011-11-19

More (needless) precision

1047. By Max Rabkin on 2011-11-19

Add names for zones

[Stefano Rivera (stefanor)]

review: Approve

[lp:~max-rabkin/ibid/coords-892484]

1048. By Max Rabkin on 2011-11-20

handle non-existent places

[Keegan Carruthers-Smith (keegan-csmith)]

review: Approve

=== modified file 'ibid/plugins/geography.py'
--- ibid/plugins/geography.py	2011-06-26 22:44:41 +0000
+++ ibid/plugins/geography.py	2011-11-20 15:02:24 +0000
@@ -1,7 +1,9 @@
+# -*- coding: utf-8 -*-
 # Copyright (c) 2009-2010, Jonathan Hitchcock, Michael Gorven, Stefano Rivera
 # Released under terms of the MIT/X/Expat Licence. See COPYING for details.
+from __future__ import division
 
-from math import acos, sin, cos, radians
+from math import acos, sin, cos, degrees, radians
 from urllib import quote, urlencode
 from urlparse import urljoin
 import re
@@ -29,15 +31,20 @@
     'description': u'Returns the distance between two places',
     'categories': ('lookup', 'calculate',),
 }
+features['coordinates'] = {
+    'description': u'Gives the coordinates of a place',
+    'categories': ('lookup',),
+}
 class Distance(Processor):
     usage = u"""distance [in <unit>] between <source> and <destination>
-    place search for <placename>"""
+    place search for <place>
+    coordinates for <place>"""
 
     # For Mathematics, see:
     # http://www.mathforum.com/library/drmath/view/51711.html
     # http://mathworld.wolfram.com/GreatCircle.html
 
-    features = ('distance',)
+    features = ('distance', 'coordinates')
 
     default_unit_names = {
             'km': "kilometres",
@@ -59,10 +66,19 @@
         if js['totalResultsCount'] == 0:
             return None
         info = js['geonames'][0]
-        return {'name': "%s, %s, %s" % (info['name'], info['adminName1'], info['countryName']),
+        return {'name': self.format_name(info),
                 'lng': radians(info['lng']),
                 'lat': radians(info['lat'])}
 
+    def format_name(self, info):
+        parts = info['name'], info['adminName1'], info['countryName']
+        parts = filter(None, parts)
+        uniq_parts = [parts[0]]
+        for part in parts[1:]:
+            if part != uniq_parts[-1]:
+                uniq_parts.append(part)
+        return ', '.join(uniq_parts)
+
     @match(r'^(?:(?:search\s+for\s+place)|(?:place\s+search\s+for)|(?:places\s+for))\s+(\S.+?)\s*$')
     def placesearch(self, event, place):
         js = self.get_place_data(place, 10)
@@ -110,6 +126,83 @@
                 conjunction=u'or'),
         })
 
+    def degrees_minutes_seconds(self, degrees, kind):
+        degs = int(degrees)
+        minutes = abs(degrees - degs)*60
+        mins = int(minutes)
+        secs = int((minutes-mins)*60)
+
+        dirn = ''
+        if kind == 'lat':
+            if degs > 0:
+                dirn = ' N'
+            elif degs < 0:
+                dirn = ' S'
+        else:
+            if degs > 0:
+                dirn = ' E'
+            elif degs < 0:
+                dirn = ' W'
+        degs = abs(degs)
+        return u'%i° %iʹ %iʺ%s' % (degs, mins, secs, dirn)
+
+    @match(r"coord(?:inate)?s (?:for|of|to) (.*)")
+    def coordinates(self, event, place):
+        place_data = self.get_place(place)
+        if not place_data:
+            event.addresponse("I've never heard of %s", place)
+            return
+
+        lat_deg = degrees(place_data['lat'])
+        lng_deg = degrees(place_data['lng'])
+        place_data.update({
+            'lat_deg': lat_deg,
+            'lng_deg': lng_deg,
+            'lat_dms': self.degrees_minutes_seconds(lat_deg, 'lat'),
+            'lng_dms': self.degrees_minutes_seconds(lng_deg, 'lng'),
+            })
+
+        latitudes = [('North Pole', 90, 'back of beyond'),
+                     ('Arctic Circle', 66+33/60+39/3600,
+                        'Arctic'),
+                     ('Tropic of Cancer', 23+26/30+21/3600,
+                        'north temperate zone'),
+                     ('Equator', 0,
+                        'northern tropics'),
+                     ('Tropic of Capricorn', -(23+26/30+21/3600),
+                        'southern tropics'),
+                     ('Antarctic Circle', -(66+33/60+39/3600),
+                        'south temperate zone'),
+                     ('South Pole', -90,
+                        'Antarctic'),
+                    ]
+        for name, lat, zone in latitudes:
+            if abs(lat-lat_deg) <= 1/60:
+                if name.endswith('Pole'):
+                    place_data['lat_desc'] = 'at the ' + name
+                else:
+                    place_data['lat_desc'] = 'on the ' + name
+                break
+            elif abs(lat-lat_deg) <= 2:
+                place_data['lat_desc'] = 'near the ' + name
+                break
+        else:
+            for (name1, lat1, _), (name2, lat2, zone) in zip(latitudes, latitudes[1:]):
+                if lat1 > lat_deg > lat2:
+                    place_data['lat_desc'] = 'in the ' + zone
+                    break
+            else:
+                place_data['lat_desc'] = 'beyond the fields we know'
+
+        place_data['tz'] = round(lng_deg/15)
+
+        event.addresponse("%(name)s is at %(lat_dms)s, %(lng_dms)s "
+                          u"(%(lat_deg)0.4f°, %(lng_deg)0.4f°). "
+                          "That's in nautical time zone GMT%(tz)+i, "
+                          "%(lat_desc)s.",
+                          place_data)
+
+
 features['weather'] = {
     'description': u'Retrieves current weather and forecasts for cities.',
     'categories': ('lookup', 'web',),