Improvements/authorship notifications (#1048)

Author: rsmithlal

app/controllers/better_together/pages_controller.rb

@@ -32,24 +32,26 @@ def create # rubocop:todo Metrics/MethodLength, Metrics/AbcSize
       @page = resource_class.new(page_params)
       authorize @page
 
-      respond_to do |format|
-        if @page.save
-          format.html do
-            redirect_to edit_page_path(@page), notice: t('flash.generic.created', resource: t('resources.page'))
-          end
-          format.turbo_stream do
-            flash.now[:notice] = t('flash.generic.created', resource: t('resources.page'))
-            render turbo_stream: turbo_stream.redirect_to(edit_page_path(@page))
-          end
-        else
-          format.turbo_stream do
-            render turbo_stream: turbo_stream.update(
-              'form_errors',
-              partial: 'layouts/better_together/errors',
-              locals: { object: @page }
-            )
+      BetterTogether::Authorship.with_creator(helpers.current_person) do
+        respond_to do |format|
+          if @page.save
+            format.html do
+              redirect_to edit_page_path(@page), notice: t('flash.generic.created', resource: t('resources.page'))
+            end
+            format.turbo_stream do
+              flash.now[:notice] = t('flash.generic.created', resource: t('resources.page'))
+              render turbo_stream: turbo_stream.redirect_to(edit_page_path(@page))
+            end
+          else
+            format.turbo_stream do
+              render turbo_stream: turbo_stream.update(
+                'form_errors',
+                partial: 'layouts/better_together/errors',
+                locals: { object: @page }
+              )
+            end
+            format.html { render :new, status: :unprocessable_entity }
           end
-          format.html { render :new, status: :unprocessable_entity }
         end
       end
     end
@@ -61,32 +63,34 @@ def edit
     def update # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       authorize @page
 
-      respond_to do |format| # rubocop:todo Metrics/BlockLength
-        if @page.update(page_params)
-          format.html do
-            flash[:notice] = t('flash.generic.updated', resource: t('resources.page'))
-            redirect_to edit_page_path(@page), notice: t('flash.generic.updated', resource: t('resources.page'))
-          end
-          format.turbo_stream do
-            flash.now[:notice] = t('flash.generic.updated', resource: t('resources.page'))
-            render turbo_stream: [
-              turbo_stream.replace(helpers.dom_id(@page, 'form'), partial: 'form',
-                                                                  locals: { page: @page }),
-              turbo_stream.replace('flash_messages', partial: 'layouts/better_together/flash_messages',
-                                                     locals: { flash: })
-            ]
-          end
-        else
-          format.html { render :edit }
-          format.turbo_stream do
-            render turbo_stream: [
-              turbo_stream.replace(helpers.dom_id(@page, 'form'), partial: 'form', locals: { page: @page }),
-              turbo_stream.update(
-                'form_errors',
-                partial: 'layouts/better_together/errors',
-                locals: { object: @page }
-              )
-            ]
+      BetterTogether::Authorship.with_creator(helpers.current_person) do # rubocop:todo Metrics/BlockLength
+        respond_to do |format| # rubocop:todo Metrics/BlockLength
+          if @page.update(page_params)
+            format.html do
+              flash[:notice] = t('flash.generic.updated', resource: t('resources.page'))
+              redirect_to edit_page_path(@page), notice: t('flash.generic.updated', resource: t('resources.page'))
+            end
+            format.turbo_stream do
+              flash.now[:notice] = t('flash.generic.updated', resource: t('resources.page'))
+              render turbo_stream: [
+                turbo_stream.replace(helpers.dom_id(@page, 'form'), partial: 'form',
+                                                                    locals: { page: @page }),
+                turbo_stream.replace('flash_messages', partial: 'layouts/better_together/flash_messages',
+                                                       locals: { flash: })
+              ]
+            end
+          else
+            format.html { render :edit }
+            format.turbo_stream do
+              render turbo_stream: [
+                turbo_stream.replace(helpers.dom_id(@page, 'form'), partial: 'form', locals: { page: @page }),
+                turbo_stream.update(
+                  'form_errors',
+                  partial: 'layouts/better_together/errors',
+                  locals: { object: @page }
+                )
+              ]
+            end
           end
         end
       end

app/mailers/better_together/authorship_mailer.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module BetterTogether
+  # Sends email notifications for page authorship changes
+  class AuthorshipMailer < ApplicationMailer
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/MethodLength
+    def authorship_changed_notification # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+      @platform = BetterTogether::Platform.find_by(host: true)
+      @page = params[:page]
+      @recipient = params[:recipient]
+      @action = params[:action]
+      @actor_name = params[:actor_name]
+      @actor_name ||= BetterTogether::Person.find_by(id: params[:actor_id])&.name if params[:actor_id]
+
+      subject = if @action == 'removed'
+                  if @actor_name.present?
+                    t('better_together.authorship_mailer.authorship_changed_notification.subject_removed_by',
+                      page: @page.title, actor_name: @actor_name)
+                  else
+                    t('better_together.authorship_mailer.authorship_changed_notification.subject_removed',
+                      page: @page.title)
+                  end
+                elsif @actor_name.present?
+                  t('better_together.authorship_mailer.authorship_changed_notification.subject_added_by',
+                    page: @page.title, actor_name: @actor_name)
+                else
+                  t('better_together.authorship_mailer.authorship_changed_notification.subject_added',
+                    page: @page.title)
+                end
+
+      # Respect locale and time zone preferences
+      self.locale = @recipient.locale
+      self.time_zone = @recipient.time_zone
+
+      mail(to: @recipient.email, subject:)
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
+  end
+end

app/models/better_together/authorship.rb

@@ -4,10 +4,82 @@ module BetterTogether
   # Connects an author (eg: person) to an authorable (eg: post)
   class Authorship < ApplicationRecord
     include Positioned
+    include BetterTogether::Creatable
+
+    # Per-request creator context for assigning creator_id during author adds
+    thread_mattr_accessor :creator_context_id
+
+    before_validation :assign_creator_from_context, on: :create
+
+    # Set creator context for any authorship creations within the block
+    def self.with_creator(person)
+      previous = creator_context_id
+      self.creator_context_id = person&.id
+      yield
+    ensure
+      self.creator_context_id = previous
+    end
 
     belongs_to :author,
                class_name: 'BetterTogether::Person'
     belongs_to :authorable,
                polymorphic: true
+
+    # Notify authors when they are added to or removed from a Page
+    after_commit :notify_added_to_page, on: :create
+    after_commit :notify_removed_from_page, on: :destroy
+
+    private
+
+    def assign_creator_from_context
+      self.creator_id ||= self.class.creator_context_id
+    end
+
+    # rubocop:todo Metrics/AbcSize
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/MethodLength
+    # rubocop:todo Metrics/CyclomaticComplexity
+    def notify_added_to_page # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      return unless authorable.is_a?(BetterTogether::Page)
+      # Skip notifying if the assigned author created this authorship
+      return if creator_id.present? && creator_id == author_id
+
+      # Also skip if the current actor is the same person being added
+      return if defined?(::Current) && ::Current.respond_to?(:person) && (::Current.person&.id == author_id)
+
+      actor = defined?(::Current) && ::Current.respond_to?(:person) ? ::Current.person : nil
+      BetterTogether::PageAuthorshipNotifier
+        .with(record: authorable,
+              page_id: authorable.id,
+              action: 'added',
+              actor_id: actor&.id,
+              actor_name: actor&.name)
+        .deliver_later(author)
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:todo Metrics/MethodLength
+    def notify_removed_from_page # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      return unless authorable.is_a?(BetterTogether::Page)
+
+      # Skip notifying when the acting person equals the removed author.
+      # Prefer creator_context_id (thread-local) when provided, otherwise fall back to Current.person when available.
+      return if self.class.creator_context_id.present? && self.class.creator_context_id == author_id
+      # Skip notifying if the person removing is the same as the removed author
+      return if defined?(::Current) && ::Current.respond_to?(:person) && (::Current.person&.id == author_id)
+
+      actor = defined?(::Current) && ::Current.respond_to?(:person) ? ::Current.person : nil
+      BetterTogether::PageAuthorshipNotifier
+        .with(record: authorable,
+              page_id: authorable.id,
+              action: 'removed',
+              actor_id: actor&.id,
+              actor_name: actor&.name)
+        .deliver_later(author)
+    end
+    # rubocop:enable Metrics/MethodLength
   end
 end

app/models/better_together/page.rb

@@ -4,6 +4,9 @@ module BetterTogether
   # An informational document used to display custom content to the user
   class Page < ApplicationRecord
     include Authorable
+    # When adding authors via `author_ids=` or association ops, controllers can
+    # set BetterTogether::Authorship.creator_context_id = current_person.id
+    # to stamp newly-created authorships with the acting person.
     include Categorizable
     include Identifier
     include Protected

app/notifiers/better_together/page_authorship_notifier.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module BetterTogether
+  # Notifies a person when added to or removed from a Page as an author
+  class PageAuthorshipNotifier < ApplicationNotifier
+    deliver_by :action_cable, channel: 'BetterTogether::NotificationsChannel', message: :build_message
+
+    deliver_by :email,
+               mailer: 'BetterTogether::AuthorshipMailer',
+               method: :authorship_changed_notification,
+               params: :email_params do |config|
+      config.wait = 15.minutes
+      config.if = -> { send_email_notification? }
+    end
+
+    validates :record, presence: true
+
+    # record is the Page; keep naming helpers similar to NewMessageNotifier
+    def page
+      record
+    end
+
+    def action
+      params[:action]
+    end
+
+    def actor_id
+      params[:actor_id]
+    end
+
+    def actor_name
+      params[:actor_name]
+    end
+
+    def actor
+      @actor ||= BetterTogether::Person.find_by(id: actor_id)
+    end
+
+    notification_methods do
+      delegate :page, to: :event
+      delegate :url, to: :event
+      delegate :identifier, to: :event
+      delegate :action, to: :event
+      delegate :actor, to: :event
+      delegate :actor_name, to: :event
+
+      def send_email_notification?
+        recipient.email.present? && recipient.notify_by_email && should_send_email?
+      end
+
+      def should_send_email?
+        # Mirror conversation notifier grouping by related record (page)
+        unread_notifications = recipient.notifications.where(
+          event_id: BetterTogether::PageAuthorshipNotifier.where(params: { page_id: page.id }).select(:id),
+          read_at: nil
+        ).order(created_at: :desc)
+
+        if unread_notifications.none?
+          false
+        else
+          # Only send one email per unread notifications per page
+          page.id == unread_notifications.last.event.record_id
+        end
+      end
+    end
+
+    def identifier
+      page.id
+    end
+
+    def url
+      page.url
+    end
+
+    # rubocop:todo Metrics/MethodLength
+    def title # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      name = actor_name || actor&.name
+      if action == 'removed'
+        if name.present?
+          I18n.t('better_together.page_authorship_notifier.removed_by', page_title: page.title, actor_name: name)
+        else
+          I18n.t('better_together.page_authorship_notifier.removed', page_title: page.title)
+        end
+      elsif name.present?
+        I18n.t('better_together.page_authorship_notifier.added_by', page_title: page.title, actor_name: name)
+      else
+        I18n.t('better_together.page_authorship_notifier.added', page_title: page.title)
+      end
+    end
+
+    # rubocop:enable Metrics/MethodLength
+    def body
+      # Keep body concise; UI partial will display details
+      title
+    end
+
+    def build_message(notification)
+      {
+        title:,
+        body:,
+        identifier:,
+        url:,
+        unread_count: notification.recipient.notifications.unread.count
+      }
+    end
+
+    def email_params(notification)
+      { page: notification.record, action: action, actor_id:, actor_name: }
+    end
+  end
+end

app/views/better_together/authorship_mailer/authorship_changed_notification.html.erb

@@ -0,0 +1,23 @@
+<!-- app/views/better_together/authorship_mailer/authorship_changed_notification.html.erb -->
+
+<p><%= t('.greeting', recipient_name: @recipient.name) %></p>
+
+<% if @action == 'removed' %>
+  <% if @actor_name.present? %>
+    <p><%= t('.intro_removed_by', page: @page.title, actor_name: @actor_name) %></p>
+  <% else %>
+    <p><%= t('.intro_removed', page: @page.title) %></p>
+  <% end %>
+<% else %>
+  <% if @actor_name.present? %>
+    <p><%= t('.intro_added_by', page: @page.title, actor_name: @actor_name) %></p>
+  <% else %>
+    <p><%= t('.intro_added', page: @page.title) %></p>
+  <% end %>
+<% end %>
+
+<p><%= t('.view_page') %></p>
+
+<p><%= link_to t('.view_page_link'), @page.url %></p>
+
+<p><%= t('.signature_html', platform: @platform.name) %></p>