Add profile location

openstreetmap · Jan 27, 2025 · ea0667a · ea0667a
1 parent d76b7a5
commit ea0667a
Show file tree

Hide file tree

Showing 11 changed files with 158 additions and 18 deletions.
diff --git a/app/assets/javascripts/user.js b/app/assets/javascripts/user.js
@@ -8,9 +8,19 @@
 
 $(document).ready(function () {
   var defaultHomeZoom = 12;
-  var map, marker, deleted_lat, deleted_lon;
+  var map, marker, deleted_lat, deleted_lon, savedLat, savedLon, locationInput;
 
   if ($("#map").length) {
+    savedLat = $("#home_lat").val();
+    savedLon = $("#home_lon").val();
+    locationInput = {
+      dirty: false,
+      request: null,
+      countryName: $("#location_name").val().trim(),
+      deletedText: null,
+      checkLocation: savedLat && savedLon && $("#location_name").val().trim()
+    };
+
     map = L.map("map", {
       attributionControl: false,
       zoomControl: false
@@ -71,8 +81,7 @@ $(document).ready(function () {
         $("#home_lat").val(location.lat.toFixed(precision));
         $("#home_lon").val(location.lng.toFixed(precision));
 
-        deleted_lat = null;
-        deleted_lon = null;
+        clearDeletedText();
         respondToHomeUpdate();
       }).on("moveend", function () {
         var lat = $("#home_lat").val().trim(),
@@ -91,11 +100,17 @@ $(document).ready(function () {
       });
 
       $("#home_lat, #home_lon").on("input", function () {
-        deleted_lat = null;
-        deleted_lon = null;
+        clearDeletedText();
         respondToHomeUpdate();
       });
 
+      $("#location_name").on("input", function () {
+        locationInput.dirty = true;
+        clearDeletedText();
+
+        respondToHomeUpdate(false);
+      });
+
       $("#home_show").click(function () {
         var lat = $("#home_lat").val(),
             lon = $("#home_lon").val();
@@ -104,22 +119,26 @@ $(document).ready(function () {
       });
 
       $("#home_delete").click(function () {
-        var lat = $("#home_lat").val(),
-            lon = $("#home_lon").val();
+        const lat = $("#home_lat").val(),
+              lon = $("#home_lon").val(),
+              locationName = $("#location_name").val();
 
-        $("#home_lat, #home_lon").val("");
+        $("#home_lat, #home_lon, #location_name").val("");
         deleted_lat = lat;
         deleted_lon = lon;
-        respondToHomeUpdate();
+        locationInput.deletedText = locationName;
+
+        respondToHomeUpdate(false);
         $("#home_undelete").trigger("focus");
       });
 
       $("#home_undelete").click(function () {
         $("#home_lat").val(deleted_lat);
         $("#home_lon").val(deleted_lon);
-        deleted_lat = null;
-        deleted_lon = null;
-        respondToHomeUpdate();
+        $("#location_name").val(locationInput.deletedText);
+        clearDeletedText();
+
+        respondToHomeUpdate(false);
         $("#home_delete").trigger("focus");
       });
     } else {
@@ -133,14 +152,22 @@ $(document).ready(function () {
     }
   }
 
-  function respondToHomeUpdate() {
-    var lat = $("#home_lat").val().trim(),
+  function respondToHomeUpdate(updateLocationName = true) {
+    let lat = $("#home_lat").val().trim(),
         lon = $("#home_lon").val().trim(),
+        locationName = $("#location_name").val().trim(),
         location;
 
     try {
       if (lat && lon) {
         location = L.latLng(lat, lon);
+        if (updateLocationName) {
+          if (locationInput.checkLocation) {
+            updateHomeLocation(false, savedLat, savedLon, updateHomeLocation);
+          } else {
+            updateHomeLocation();
+          }
+        }
       }
       $("#home_lat, #home_lon").removeClass("is-invalid");
     } catch (error) {
@@ -150,8 +177,11 @@ $(document).ready(function () {
 
     $("#home_message").toggleClass("invisible", Boolean(location));
     $("#home_show").prop("hidden", !location);
-    $("#home_delete").prop("hidden", !location);
-    $("#home_undelete").prop("hidden", !(!location && deleted_lat && deleted_lon));
+    $("#home_delete").prop("hidden", !location && !locationName);
+    $("#home_undelete").prop("hidden", !(
+      (!location || !locationName) &&
+      ((deleted_lat && deleted_lon) || locationInput.deletedText)
+    ));
     if (location) {
       marker.setLatLng([lat, lon]);
       marker.addTo(map);
@@ -178,6 +208,52 @@ $(document).ready(function () {
     }
   }
 
+  function updateHomeLocation(updateInput = true, lat = $("#home_lat").val().trim(), lon = $("#home_lon").val().trim(), successFn) {
+    if (!lat || !lon || locationInput.dirty) {
+      return;
+    }
+
+    const geocodeUrl = "/geocoder/search_osm_nominatim_reverse";
+    const params = {
+      format: "json",
+      lat,
+      lon,
+      zoom: 3
+    };
+
+    if (locationInput.request) {
+      locationInput.request.abort();
+    }
+
+    locationInput.request = $.ajax({
+      url: geocodeUrl,
+      method: "POST",
+      data: params,
+      success: function (country) {
+        if (updateInput) {
+          locationInput.request = null;
+          $("#location_name").val(country);
+        } else {
+          locationInput.checkLocation = false;
+          if (locationInput.countryName !== country) {
+            locationInput.dirty = true;
+          }
+        }
+        locationInput.countryName = country;
+
+        if (successFn) {
+          successFn();
+        }
+      }
+    });
+  }
+
+  function clearDeletedText() {
+    deleted_lat = null;
+    deleted_lon = null;
+    locationInput.deletedText = null;
+  }
+
   updateAuthUID();
 
   $("select#user_auth_provider").on("change", updateAuthUID);

diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb
@@ -148,7 +148,11 @@ def search_osm_nominatim_reverse
                     :type => object_type, :id => object_id)
     end
 
-    render :action => "results"
+    if params[:format] == "json"
+      render :html => @results.pluck(:name).join(", ")
+    else
+      render :action => "results"
+    end
   rescue StandardError => e
     host = URI(Settings.nominatim_url).host
     @error = "Error contacting #{host}: #{e}"

diff --git a/app/controllers/profiles_controller.rb b/app/controllers/profiles_controller.rb
@@ -31,6 +31,7 @@ def update
 
     current_user.home_lat = params[:user][:home_lat]
     current_user.home_lon = params[:user][:home_lon]
+    current_user.location_name = params[:user][:location_name]
 
     if current_user.save
       flash[:notice] = t ".success"

diff --git a/app/models/user.rb b/app/models/user.rb
@@ -12,6 +12,7 @@
 #  home_lat             :float
 #  home_lon             :float
 #  home_zoom            :integer          default(3)
+#  location_name        :string
 #  pass_salt            :string
 #  email_valid          :boolean          default(FALSE), not null
 #  new_email            :string

diff --git a/app/views/profiles/edit.html.erb b/app/views/profiles/edit.html.erb
@@ -52,6 +52,7 @@
         <button type="button" id="home_undelete" class="btn btn-outline-primary" hidden><%= t ".undelete" %></button>
       </div>
     </div>
+    <%= f.text_field :location_name, :wrapper_class => "my-2 col-sm-4 pe-3", :class => "mt-auto", :id => "location_name" %>
     <div class="form-check">
       <input class="form-check-input" type="checkbox" name="updatehome" value="1" <% unless current_user.home_location? %> checked <% end %> id="updatehome" />
       <label class="form-check-label" for="updatehome"><%= t ".update home location on click" %></label>

diff --git a/app/views/users/show.html.erb b/app/views/users/show.html.erb
@@ -139,6 +139,16 @@
       <div class='text-body-secondary'>
         <small>
           <dl class="list-inline">
+            <% if @user.location_name && @user.location_name.strip.present? %>
+              <dt class="list-inline-item m-0">
+                <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-geo-alt-fill" viewBox="0 0 16 16">
+                  <path d="M8 16s6-5.686 6-10A6 6 0 0 0 2 6c0 4.314 6 10 6 10m0-7a3 3 0 1 1 0-6 3 3 0 0 1 0 6">
+                    <title><%= t ".home location" %></title>
+                  </path>
+                </svg>
+              </dt>
+              <dd class="list-inline-item"><%= @user.location_name %></dd>
+            <% end %>
             <dt class="list-inline-item m-0"><%= t ".mapper since" %></dt>
             <dd class="list-inline-item"><%= l @user.created_at.to_date, :format => :long %></dd>
             <dt class="list-inline-item m-0"><%= t ".last map edit" %></dt>

diff --git a/config/locales/en.yml b/config/locales/en.yml
@@ -2810,6 +2810,7 @@ en:
       follow: Follow
       mapper since: "Mapper since:"
       last map edit: "Last map edit:"
+      home location: "Home location"
       no activity yet: "No activity yet"
       uid: "User id:"
       ct status: "Contributor terms:"

diff --git a/db/migrate/20241030090336_add_user_location_name.rb b/db/migrate/20241030090336_add_user_location_name.rb
@@ -0,0 +1,5 @@
+class AddUserLocationName < ActiveRecord::Migration[7.2]
+  def change
+    add_column :users, :location_name, :string
+  end
+end
diff --git a/db/structure.sql b/db/structure.sql
@@ -1512,7 +1512,8 @@ CREATE TABLE public.users (
     tou_agreed timestamp without time zone,
     diary_comments_count integer DEFAULT 0,
     note_comments_count integer DEFAULT 0,
-    creation_address inet
+    creation_address inet,
+    location_name character varying
 );
 
 
@@ -3425,6 +3426,7 @@ INSERT INTO "schema_migrations" (version) VALUES
 ('20250121191749'),
 ('20250105154621'),
 ('20250104140952'),
+('20241030090336'),
 ('20241023004427'),
 ('20241022141247'),
 ('20240913171951'),

diff --git a/test/controllers/geocoder_controller_test.rb b/test/controllers/geocoder_controller_test.rb
@@ -420,6 +420,24 @@ def test_search_osm_nominatim_reverse
     end
   end
 
+  ##
+  # Test the nominatim reverse JSON search
+  def test_search_osm_nominatim_reverse_json
+    with_http_stubs "nominatim" do
+      post geocoder_search_osm_nominatim_reverse_path(:lat => 51.7632, :lon => -0.0076, :zoom => 15, :format => "json"), :xhr => true
+      assert_response :success
+      assert_select "body", :text => "Broxbourne, Hertfordshire, East of England, England, United Kingdom"
+
+      post geocoder_search_osm_nominatim_reverse_path(:lat => 51.7632, :lon => -0.0076, :zoom => 17, :format => "json"), :xhr => true
+      assert_response :success
+      assert_select "body", :text => "Dinant Link Road, Broxbourne, Hertfordshire, East of England, England, EN11 8HX, United Kingdom"
+
+      post geocoder_search_osm_nominatim_reverse_path(:lat => 13.7709, :lon => 100.50507, :zoom => 19, :format => "json"), :xhr => true
+      assert_response :success
+      assert_select "body", :text => "MM Steak&Grill, ถนนศรีอยุธยา, บางขุนพรหม, กรุงเทพมหานคร, เขตดุสิต, กรุงเทพมหานคร, 10300, ประเทศไทย"
+    end
+  end
+
   private
 
   def latlon_check(query, lat, lon)

diff --git a/test/system/user_location_change_test.rb b/test/system/user_location_change_test.rb
@@ -0,0 +1,21 @@
+require "application_system_test_case"
+
+class UserLocationChangeTest < ApplicationSystemTestCase
+  def setup
+    stub_request(:get, /.*gravatar.com.*d=404/).to_return(:status => 404)
+  end
+
+  test "User can change their location" do
+    user = create(:user)
+    sign_in_as(user)
+
+    visit user_path(user)
+    assert_no_selector ".bi.bi-geo-alt-fill"
+
+    visit edit_profile_path
+    fill_in "Location name", :with => "Test Location"
+    click_on "Update Profile"
+
+    assert_text "Test Location"
+  end
+end