Use render_map to render the admin settings map

This way we remove duplication.

Note that to check whether to render the button to remove a marker,
we're checking whether the map location belongs to a mappable. This
means we're changing the code that renders the map in the "new proposal"
and "new investment" forms so the map location belongs to a proposal or
investment. We're association the map location to a new record because
writing something like:

```
def map_location
  proposal.map_location || MapLocation.new(proposal: proposal)
end
```

Would change the `proposal` object because of the way Rails treats
non-persisted `has_one` associations. Although probably safe in this
case, changing an object when rendering a view could have side effects.

Also note that we're changing the HTML ID of the map element from
`admin-map` to `new_map_location` (the latter is returned by the
`dom_id` method).  We were only using this ID in tests since commit
289426c1c, so changing it doesn't really affect us.
This commit is contained in:
Javi Martín
2025-11-17 00:44:51 +01:00
parent 8a575ae83c
commit 1693aa5d9c
13 changed files with 107 additions and 31 deletions

View File

@@ -1,24 +1,10 @@
<div class="row">
<div class="small-12 column">
<%= form_tag admin_update_map_path, method: :put, id: "map-form" do |f| %>
<div id="admin-map" class="map"
data-map
data-map-center-latitude="<%= Setting["map.latitude"] %>"
data-map-center-longitude="<%= Setting["map.longitude"] %>"
data-map-zoom="<%= Setting["map.zoom"] %>"
data-map-tiles-provider="<%= Rails.application.secrets.map_tiles_provider %>"
data-map-tiles-provider-attribution="<%= Rails.application.secrets.map_tiles_provider_attribution %>"
data-marker-editable="true"
data-marker-latitude="<%= Setting["map.latitude"] %>"
data-marker-longitude="<%= Setting["map.longitude"] %>"
data-latitude-input-selector="#latitude"
data-longitude-input-selector="#longitude"
data-zoom-input-selector="#zoom">
</div>
<%= hidden_field_tag :latitude, Setting["map.latitude"] %>
<%= hidden_field_tag :longitude, Setting["map.longitude"] %>
<%= hidden_field_tag :zoom, Setting["map.zoom"] %>
<%= form_for map_location, url: admin_update_map_path, method: :put, html: { id: "map-form" } do |f| %>
<%= render_map(map_location, form: f) %>
<%= f.hidden_field :latitude %>
<%= f.hidden_field :longitude %>
<%= f.hidden_field :zoom %>
<%= hidden_field_tag :tab, tab if tab %>
<div class="small-12 medium-6 large-4 margin-top">

View File

@@ -1,7 +1,18 @@
class Admin::Settings::MapFormComponent < ApplicationComponent
attr_reader :tab
use_helpers :render_map
def initialize(tab: nil)
@tab = tab
end
private
def map_location
MapLocation.new(
latitude: Setting["map.latitude"],
longitude: Setting["map.longitude"],
zoom: Setting["map.zoom"]
)
end
end

View File

@@ -21,6 +21,6 @@ class Budgets::Investments::FormComponent < ApplicationComponent
end
def map_location
investment.map_location || MapLocation.new
investment.map_location || MapLocation.new(investment: Budget::Investment.new)
end
end

View File

@@ -17,6 +17,6 @@ class Proposals::FormComponent < ApplicationComponent
end
def map_location
proposal.map_location || MapLocation.new
proposal.map_location || MapLocation.new(proposal: Proposal.new)
end
end

View File

@@ -1,5 +1,5 @@
<%= tag.div(id: dom_id(map_location), class: "map-location map", data: data) %>
<% if editable? %>
<% if show_remove_marker_button? %>
<%= remove_marker %>
<% end %>

View File

@@ -18,6 +18,10 @@ class Shared::MapLocationComponent < ApplicationComponent
form.present?
end
def show_remove_marker_button?
editable? && map_location.mappable.present?
end
def latitude
map_location.latitude.presence || Setting["map.latitude"]
end

View File

@@ -13,9 +13,9 @@ class Admin::SettingsController < Admin::BaseController
end
def update_map
Setting["map.latitude"] = params[:latitude].to_f
Setting["map.longitude"] = params[:longitude].to_f
Setting["map.zoom"] = params[:zoom].to_i
Setting["map.latitude"] = params[:map_location][:latitude].to_f
Setting["map.longitude"] = params[:map_location][:longitude].to_f
Setting["map.zoom"] = params[:map_location][:zoom].to_i
redirect_to request_referer, notice: t("admin.settings.index.map.flash.update")
end

View File

@@ -8,8 +8,12 @@ class MapLocation < ApplicationRecord
latitude.present? && longitude.present? && zoom.present?
end
def mappable
proposal || investment
end
def title
(proposal || investment)&.title
mappable&.title
end
def json_data

View File

@@ -0,0 +1,10 @@
require "rails_helper"
describe Admin::Settings::MapFormComponent do
it "does not render a button to remove the marker" do
render_inline Admin::Settings::MapFormComponent.new
expect(page).to have_css ".map-location"
expect(page).not_to have_button "Remove map marker"
end
end

View File

@@ -33,4 +33,17 @@ describe Budgets::Investments::FormComponent do
expect(page).not_to have_field "I agree to the Privacy Policy and the Terms and conditions of use"
end
end
describe "map" do
it "renders a button to remove the map marker" do
Setting["feature.map"] = true
render_inline Budgets::Investments::FormComponent.new(
budget.investments.new,
url: budget_investments_path(budget)
)
expect(page).to have_button "Remove map marker"
end
end
end

View File

@@ -0,0 +1,17 @@
require "rails_helper"
describe Proposals::FormComponent do
include Rails.application.routes.url_helpers
before { sign_in(create(:user)) }
describe "map" do
it "renders a button to remove the map marker" do
Setting["feature.map"] = true
render_inline Proposals::FormComponent.new(Proposal.new, url: proposals_path)
expect(page).to have_button "Remove map marker"
end
end
end

View File

@@ -0,0 +1,31 @@
require "rails_helper"
describe Shared::MapLocationComponent do
describe "remove marker button" do
it "is not rendered when there's no form" do
map_location = build(:map_location, proposal: Proposal.new)
render_inline Shared::MapLocationComponent.new(map_location)
expect(page).not_to have_button "Remove map marker"
end
it "is not rendered when there's no mappable" do
map_location = build(:map_location)
form = ConsulFormBuilder.new(:map_location, map_location, ApplicationController.new.view_context, {})
render_inline Shared::MapLocationComponent.new(map_location, form: form)
expect(page).not_to have_button "Remove map marker"
end
it "is rendered when there's a form and a mappable" do
map_location = build(:map_location, proposal: Proposal.new)
form = ConsulFormBuilder.new(:map_location, map_location, ApplicationController.new.view_context, {})
render_inline Shared::MapLocationComponent.new(map_location, form: form)
expect(page).to have_button "Remove map marker"
end
end
end

View File

@@ -26,11 +26,11 @@ describe "Admin settings", :admin do
visit admin_settings_path
expect(page).not_to have_css "#admin-map.leaflet-container", visible: :all
expect(page).not_to have_css ".map-location.leaflet-container", visible: :all
click_link "Map configuration"
expect(page).to have_css "#admin-map.leaflet-container"
expect(page).to have_css ".map-location.leaflet-container"
end
end
@@ -44,7 +44,7 @@ describe "Admin settings", :admin do
expect(page).to have_content "To show the map to users you must enable " \
'"Proposals and budget investments geolocation" ' \
'on "Features" tab.'
expect(page).not_to have_css("#admin-map")
expect(page).not_to have_css ".map-location"
end
scenario "Should update marker" do
@@ -53,7 +53,7 @@ describe "Admin settings", :admin do
visit admin_settings_path
click_link "Map configuration"
expect(page).to have_css("#admin-map")
expect(page).to have_css ".map-location"
expect(page).not_to have_content "To show the map to users you must enable " \
'"Proposals and budget investments geolocation" ' \
'on "Features" tab.'
@@ -62,7 +62,7 @@ describe "Admin settings", :admin do
expect(page).to have_field "Longitude", with: "0.0"
within "#map-form" do
find("#admin-map").click
find(".map-location").click
click_button "Update"
end