Add notification to valuators when a proposal is assigned (decidim#13022

) * Add notification to valuators when a proposal is assigned to them. Also adds a new notifications setting to disable this notification * Update decidim-core/spec/commands/decidim/update_notifications_settings_spec.rb Co-authored-by: Eduardo Martínez <[email protected]> --------- Co-authored-by: Eduardo Martínez <[email protected]>
AjuntamentdeBarcelona · Oct 31, 2024 · 09d0799 · 09d0799
1 parent bd07656
commit 09d0799
Show file tree

Hide file tree

Showing 12 changed files with 88 additions and 1 deletion.
diff --git a/decidim-core/app/commands/decidim/update_notifications_settings.rb b/decidim-core/app/commands/decidim/update_notifications_settings.rb
@@ -28,6 +28,7 @@ def update_notifications_settings
       @user.notification_types = @form.notification_types
       @user.direct_message_types = @form.direct_message_types
       @user.email_on_moderations = @form.email_on_moderations
+      @user.email_on_assigned_proposals = @form.email_on_assigned_proposals
       @user.notification_settings = @user.notification_settings.merge(@form.notification_settings)
       @user.notifications_sending_frequency = @form.notifications_sending_frequency
     end

diff --git a/decidim-core/app/forms/decidim/notifications_settings_form.rb b/decidim-core/app/forms/decidim/notifications_settings_form.rb
@@ -7,6 +7,7 @@ class NotificationsSettingsForm < Form
     mimic :user
 
     attribute :email_on_moderations, Boolean
+    attribute :email_on_assigned_proposals, Boolean
     attribute :newsletter_notifications, Boolean
     attribute :notifications_from_followed, Boolean
     attribute :notifications_from_own_activity, Boolean

diff --git a/decidim-core/app/views/decidim/notifications_settings/show.html.erb b/decidim-core/app/views/decidim/notifications_settings/show.html.erb
@@ -99,6 +99,28 @@
         </label>
       </div>
 
+      <label>
+        <%= t("valuators", scope: "decidim.notifications_settings.show") %>
+      </label>
+      <div class="toggle__switch-trigger">
+        <label for="email_on_assigned_proposals" class="toggle__switch-toggle">
+          <span>
+            <input
+              <%== %(checked="checked") if @notifications_settings.email_on_assigned_proposals %>
+              id="email_on_assigned_proposals"
+              type="checkbox"
+              name="email_on_assigned_proposals">
+            <span class="toggle__switch-toggle-content">
+            </span>
+            <%= icon "check-line", class: "toggle__switch-toggle-icon" %>
+            <%= icon "close-line", class: "toggle__switch-toggle-icon" %>
+          </span>
+          <span class="toggle__switch-trigger-text">
+            <%= t("assigned_to_proposal", scope: "decidim.notifications_settings.show") %>
+          </span>
+        </label>
+      </div>
+
       <% if current_user.moderator? %>
         <label>
           <%= t("administrators", scope: "decidim.notifications_settings.show") %>

diff --git a/decidim-core/config/locales/en.yml b/decidim-core/config/locales/en.yml
@@ -1260,6 +1260,7 @@ en:
         administrators: Administrators
         allow_public_contact: Allow anyone to send me a direct message, even if I do not follow them.
         allow_push_notifications: Get push notifications to find out what is going on when you are not on the platform. You can turn them off anytime.
+        assigned_to_proposal: I want to receive an email when someone assigns me a proposal to evaluate
         direct_messages: Receive direct messages from anyone
         email_on_moderations: I want to receive an email every time something or someone is reported for moderation.
         everything_followed: Everything I follow
@@ -1278,6 +1279,7 @@ en:
         push_notifications_reminder: To get notifications from the platform, you will need to allow them in your browser settings first.
         receive_notifications_about: I want to get notifications about
         update_notifications_settings: Save changes
+        valuators: Evaluators
       update:
         error: There was a problem updating your notifications settings.
         success: Your notifications settings were successfully updated.

diff --git a/decidim-core/lib/decidim/core/test/factories.rb b/decidim-core/lib/decidim/core/test/factories.rb
@@ -187,6 +187,7 @@ def generate_localized_title(field = nil, skip_injection: false)
     accepted_tos_version { organization.tos_version }
     notifications_sending_frequency { "real_time" }
     email_on_moderations { true }
+    email_on_assigned_proposals { true }
     password_updated_at { Time.current }
     previous_passwords { [] }
     extended_data { {} }

diff --git a/decidim-core/spec/commands/decidim/update_notifications_settings_spec.rb b/decidim-core/spec/commands/decidim/update_notifications_settings_spec.rb
@@ -9,7 +9,8 @@ module Decidim
     let(:valid) { true }
     let(:data) do
       {
-        email_on_moderations: true,
+        email_on_moderations: false,
+        email_on_assigned_proposals: false,
         newsletter_notifications_at: Time.current,
         direct_message_types: "followed-only",
         notification_settings: { close_meeting_reminder: "0" },
@@ -21,6 +22,7 @@ module Decidim
       double(
         notification_types: "none",
         email_on_moderations: data[:email_on_moderations],
+        email_on_assigned_proposals: data[:email_on_assigned_proposals],
         newsletter_notifications_at: data[:newsletter_notifications_at],
         direct_message_types: data[:direct_message_types],
         notification_settings: data[:notification_settings],
@@ -48,6 +50,8 @@ module Decidim
         expect(user.direct_message_types).to eq "followed-only"
         expect(user.notification_settings["close_meeting_reminder"]).to eq "0"
         expect(user.notifications_sending_frequency).to eq "weekly"
+        expect(user.email_on_moderations).to be(false)
+        expect(user.email_on_assigned_proposals).to be(false)
       end
     end
   end

diff --git a/decidim-core/spec/forms/notifications_settings_form_spec.rb b/decidim-core/spec/forms/notifications_settings_form_spec.rb
@@ -10,6 +10,7 @@ module Decidim
         notifications_from_own_activity:,
         notifications_sending_frequency:,
         email_on_moderations:,
+        email_on_assigned_proposals:,
         newsletter_notifications:,
         allow_public_contact:
       ).with_context(
@@ -22,6 +23,7 @@ module Decidim
     let(:notifications_from_followed) { "1" }
     let(:notifications_from_own_activity) { "1" }
     let(:email_on_moderations) { "1" }
+    let(:email_on_assigned_proposals) { "1" }
     let(:newsletter_notifications) { "1" }
     let(:allow_public_contact) { "1" }
     let(:notifications_sending_frequency) { "real_time" }

diff --git a/decidim-core/spec/system/account_spec.rb b/decidim-core/spec/system/account_spec.rb
@@ -242,6 +242,7 @@
 
         it "updates the administrator's notifications" do
           page.find("[for='email_on_moderations']").click
+          page.find("[for='email_on_assigned_proposals']").click
           page.find("[for='user_notification_settings[close_meeting_reminder]']").click
 
           within "form.edit_user" do

diff --git a/decidim-proposals/app/commands/decidim/proposals/admin/assign_proposals_to_valuator.rb b/decidim-proposals/app/commands/decidim/proposals/admin/assign_proposals_to_valuator.rb
@@ -37,6 +37,7 @@ def assign_proposals
             form.proposals.flat_map do |proposal|
               form.valuator_roles.each do |valuator_role|
                 find_assignment(proposal, valuator_role) || assign_proposal(proposal, valuator_role)
+                notify_valuator(proposal, valuator_role)
               end
             end
           end
@@ -57,6 +58,19 @@ def assign_proposal(proposal, valuator_role)
             valuator_role:
           )
         end
+
+        def notify_valuator(proposal, valuator_role)
+          return unless valuator_role.user.email_on_assigned_proposals?
+
+          data = {
+            event: "decidim.events.proposals.admin.proposal_assigned_to_valuator",
+            event_class: Decidim::Proposals::Admin::ProposalAssignedToValuatorEvent,
+            resource: proposal,
+            affected_users: [valuator_role.user]
+          }
+
+          Decidim::EventsManager.publish(**data)
+        end
       end
     end
   end

diff --git a/decidim-proposals/app/events/decidim/proposals/admin/proposal_assigned_to_valuator_event.rb b/decidim-proposals/app/events/decidim/proposals/admin/proposal_assigned_to_valuator_event.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      class ProposalAssignedToValuatorEvent < Decidim::Events::SimpleEvent
+        include Rails.application.routes.mounted_helpers
+
+        i18n_attributes :admin_proposal_info_url, :admin_proposal_info_path
+
+        def admin_proposal_info_path
+          ResourceLocatorPresenter.new(resource).show
+        end
+
+        def admin_proposal_info_url
+          send(resource.component.mounted_admin_engine).proposal_url(resource, resource.component.mounted_params)
+        end
+
+        private
+
+        def organization
+          @organization ||= component.participatory_space.organization
+        end
+      end
+    end
+  end
+end
diff --git a/decidim-proposals/config/locales/en.yml b/decidim-proposals/config/locales/en.yml
@@ -235,6 +235,11 @@ en:
     events:
       proposals:
         admin:
+          proposal_assigned_to_valuator:
+            email_intro: You have been assigned as a valuator to the proposal "%{resource_title}". This means you have been trusted to give them feedback and a proper response in the next coming days. Check it out at <a href="%{admin_proposal_info_url}">the admin panel</a>.
+            email_outro: You have received this notification because you can valuate the proposal.
+            email_subject: You have been assigned as a valuator to the proposal %{resource_title}.
+            notification_title: You have been assigned as a valuator to the proposal <a href="%{resource_path}">%{resource_title}</a>. Check it out at <a href="%{admin_proposal_info_path}">the admin panel</a>.
           proposal_note_created:
             email_intro: Someone has left a note on the proposal "%{resource_title}". Check it out at <a href="%{admin_proposal_info_url}">the admin panel</a>.
             email_outro: You have received this notification because you can valuate the proposal.

diff --git a/decidim-proposals/db/migrate/20240617091140_add_email_on_assigned_proposals_to_users.rb b/decidim-proposals/db/migrate/20240617091140_add_email_on_assigned_proposals_to_users.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddEmailOnAssignedProposalsToUsers < ActiveRecord::Migration[6.1]
+  def change
+    add_column :decidim_users, :email_on_assigned_proposals, :boolean, default: true
+  end
+end