Extend geocoder to support additional lat/lon formats
authorEric Theise <erictheise@gmail.com>
Sun, 3 Mar 2013 19:33:15 +0000 (19:33 +0000)
committerTom Hughes <tom@compton.nu>
Sun, 3 Mar 2013 19:39:53 +0000 (19:39 +0000)
app/controllers/geocoder_controller.rb
test/functional/geocoder_controller_test.rb

index ced95dc..7f5065b 100644 (file)
@@ -1,3 +1,5 @@
+# coding: utf-8
+
 class GeocoderController < ApplicationController
   require 'uri'
   require 'net/http'
@@ -5,6 +7,7 @@ class GeocoderController < ApplicationController
 
   before_filter :authorize_web
   before_filter :set_locale
+  before_filter :convert_latlon, :only => [:search]
 
   def search
     @query = params[:query]
@@ -312,4 +315,63 @@ private
   def escape_query(query)
     return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
   end
+
+  def convert_latlon
+    @query = params[:query]
+
+    if latlon = @query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) # [NSEW] decimal degrees
+      params[:query] = nsew_to_decdeg(latlon)
+    elsif latlon = @query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures) # decimal degrees [NSEW]
+      params[:query] = nsew_to_decdeg(latlon)
+
+    elsif latlon = @query.match(/^([NS])\s*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\W*([EW])\s*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?$/).try(:captures) # [NSEW] degrees, decimal minutes
+      params[:query] = ddm_to_decdeg(latlon)
+    elsif latlon = @query.match(/^(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\s*([NS])\W*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\s*([EW])$/).try(:captures) # degrees, decimal minutes [NSEW]
+      params[:query] = ddm_to_decdeg(latlon)
+
+    elsif latlon = @query.match(/^([NS])\s*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?\W*([EW])\s*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?$/).try(:captures) # [NSEW] degrees, minutes, decimal seconds
+      params[:query] = dms_to_decdeg(latlon)
+    elsif latlon = @query.match(/^(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]\s*([NS])\W*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?\s*([EW])$/).try(:captures) # degrees, minutes, decimal seconds [NSEW]
+      params[:query] = dms_to_decdeg(latlon)
+    else
+      return
+    end
+  end
+
+  def nsew_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      captures[1].downcase != 's' ? lat = captures[0].to_f : lat = -(captures[0].to_f)
+      captures[4].downcase != 'w' ? lon = captures[3].to_f : lon = -(captures[3].to_f)
+    rescue
+      captures[0].downcase != 's' ? lat = captures[1].to_f : lat = -(captures[1].to_f)
+      captures[3].downcase != 'w' ? lon = captures[4].to_f : lon = -(captures[4].to_f)
+    end
+    return "#{lat}, #{lon}"
+  end
+
+  def ddm_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      captures[3].downcase != 's' ? lat = captures[0].to_f + captures[1].to_f/60 : lat = -(captures[0].to_f + captures[1].to_f/60)
+      captures[7].downcase != 'w' ? lon = captures[4].to_f + captures[5].to_f/60 : lon = -(captures[4].to_f + captures[5].to_f/60)
+    rescue
+      captures[0].downcase != 's' ? lat = captures[1].to_f + captures[2].to_f/60 : lat = -(captures[1].to_f + captures[2].to_f/60)
+      captures[4].downcase != 'w' ? lon = captures[5].to_f + captures[6].to_f/60 : lon = -(captures[5].to_f + captures[6].to_f/60)
+    end
+    return "#{lat}, #{lon}"
+  end
+
+  def dms_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      captures[4].downcase != 's' ? lat = captures[0].to_f + (captures[1].to_f + captures[2].to_f/60)/60 : lat = -(captures[0].to_f + (captures[1].to_f + captures[2].to_f/60)/60)
+      captures[9].downcase != 'w' ? lon = captures[5].to_f + (captures[6].to_f + captures[7].to_f/60)/60 : lon = -(captures[5].to_f + (captures[6].to_f + captures[7].to_f/60)/60)
+    rescue
+      captures[0].downcase != 's' ? lat = captures[1].to_f + (captures[2].to_f + captures[3].to_f/60)/60 : lat = -(captures[1].to_f + (captures[2].to_f + captures[3].to_f/60)/60)
+      captures[5].downcase != 'w' ? lon = captures[6].to_f + (captures[7].to_f + captures[8].to_f/60)/60 : lon = -(captures[6].to_f + (captures[7].to_f + captures[8].to_f/60)/60)
+    end
+    return "#{lat}, #{lon}"
+  end
+
 end
index b678125..3d80b03 100644 (file)
@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require File.dirname(__FILE__) + '/../test_helper'
 require 'geocoder_controller'
 
@@ -55,4 +57,174 @@ class GeocoderControllerTest < ActionController::TestCase
       { :controller => "geocoder", :action => "description_geonames" }
     )
   end
+
+  ##
+  # test the regular expressions that split search queries into 'latlon', 'us_postcode', and the like
+
+  # latlon examples/motivation from https://trac.openstreetmap.org/ticket/4730 & https://trac.openstreetmap.org/ticket/4748
+  def test_identify_latlon_degdec
+    ['50.06773 14.37742', '50.06773, 14.37742', '+50.06773 +14.37742', '+50.06773, +14.37742'].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_equal code, assigns(:query)
+    end
+  end
+
+  ##
+  # this is a test helper for rounding latlon strings to a specified precision, e.g., at a precision 
+  # of 5, "50.06773333333334, -14.377416666666667" will become "50.06773, -14.37742"
+  def assert_latlon_equal_round(expected, actual, precision)
+    assert_equal expected.split(',').map {|i| i.to_f.round(precision)}.join(', '), actual.split(',').map {|i| i.to_f.round(precision)}.join(', ')
+  end
+
+  def test_identify_latlon_degdec_nsew
+    target = '50.06773, 14.37742'
+    [
+        'N50.06773 E14.37742',
+        'N50.06773, E14.37742',
+        '50.06773N 14.37742E',
+        '50.06773N, 14.37742E'
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_equal target, assigns(:query)
+    end
+  end
+
+  def test_identify_latlon_ddm
+    target = '50.06773, 14.37742'
+    [
+        'N 50° 04.064 E 014° 22.645',
+        "N 50° 04.064' E 014° 22.645",
+        "N 50° 04.064', E 014° 22.645'",
+        'N50° 04.064 E14° 22.645',
+        'N 50 04.064 E 014 22.645',
+        'N50 4.064 E14 22.645',
+        "50° 04.064' N, 014° 22.645' E"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_latlon_equal_round(target, assigns(:query), 5)
+    end
+  end
+
+  def test_identify_latlon_dms
+    target = '50.06773, 14.37742'
+    [
+        "N 50° 4' 03.828\" E 14° 22' 38.712\"",
+        "N 50° 4' 03.828\", E 14° 22' 38.712\"",
+        'N50 4 03.828 E14 22 38.712',
+        'N50 4 03.828, E14 22 38.712',
+        "50°4'3.828\"N 14°22'38.712\"E"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_equal target, assigns(:query)
+    end
+  end
+
+  def test_identify_us_postcode
+    ['12345', '12345-6789'].each do |code|
+      post :search, query: code
+      assert_response :success
+      assert_equal ['us_postcode', 'osm_nominatim'], assigns(:sources)
+    end
+  end
+
+  def test_identify_uk_postcode
+    # examples from http://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom
+    ['EC1A 1BB', 'W1A 1HQ', 'M1 1AA', 'B33 8TH', 'CR2 6XH', 'DN55 1PT'].each do |code|
+      post :search, query: code
+      assert_response :success
+      assert_equal ['uk_postcode', 'osm_nominatim'], assigns(:sources)
+    end
+  end
+
+  def test_identify_ca_postcode
+    post :search, query: 'A1B 2C3'
+    assert_response :success
+    assert_equal ['ca_postcode', 'osm_nominatim'], assigns(:sources)
+  end
+
+  def test_identify_fall_through_no_geonames
+    post :search, query: 'foo bar baz'
+    assert_response :success
+    assert_equal ['osm_nominatim'], assigns(:sources)
+  end
+
+  def test_ne
+    target = '50.06773, 14.37742'
+    [
+        "N 50° 04.064', E 014° 22.645'",
+        "N 50° 4' 03.828\", E 14° 22' 38.712\"",
+        "50°4'3.828\"N 14°22'38.712\"E",
+        "50° 04.064' N, 014° 22.645' E"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_latlon_equal_round(target, assigns(:query), 5)
+    end
+  end
+
+  def test_nw
+    target = '50.06773, -14.37742'
+    [
+        "N 50° 04.064', W 014° 22.645'",
+        "N 50° 4' 03.828\", W 14° 22' 38.712\"",
+        "50°4'3.828\"N 14°22'38.712\"W",
+        "50° 04.064' N, 014° 22.645' W"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_latlon_equal_round(target, assigns(:query), 5)
+    end
+  end
+
+  def test_se
+    target = '-50.06773, 14.37742'
+    [
+        "S 50° 04.064', E 014° 22.645'",
+        "S 50° 4' 03.828\", E 14° 22' 38.712\"",
+        "50°4'3.828\"S 14°22'38.712\"E",
+        "50° 04.064' S, 014° 22.645' E"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_latlon_equal_round(target, assigns(:query), 5)
+    end
+  end
+
+  def test_sw
+    target = '-50.06773, -14.37742'
+    [
+        "S 50° 04.064', W 014° 22.645'",
+        "S 50° 4' 03.828\", W 14° 22' 38.712\"",
+        "50°4'3.828\"S 14°22'38.712\"W",
+        "50° 04.064' S, 014° 22.645' W"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_latlon_equal_round(target, assigns(:query), 5)
+    end
+  end
+
+  def test_primes_and_double_primes
+    target = '50.06773, -14.37742'
+    [
+        "N 50° 4′ 03.828″, W 14° 22′ 38.712″"
+    ].each do |code|
+      post :search, :query => code
+      assert_response :success
+      assert_equal ['latlon'], assigns(:sources)
+      assert_equal target, assigns(:query)
+    end
+  end
 end