List changeset comment notifications

Author: pablobm

.rubocop_todo.yml

@@ -56,7 +56,7 @@ Metrics/BlockNesting:
 # Offense count: 23
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 345
+  Max: 340
 
 # Offense count: 72
 # Configuration parameters: AllowedMethods, AllowedPatterns.

app/controllers/notifications_controller.rb

@@ -9,4 +9,8 @@ class NotificationsController < ApplicationController
   authorize_resource :class => false
 
   before_action :check_database_readable
+
+  def index
+    @notifications = UserNotifications.new(current_user).visible
+  end
 end

app/models/user.rb

@@ -91,6 +91,8 @@ class User < ApplicationRecord
 
   has_many :reports
 
+  has_many :notifications, :as => :recipient, :class_name => "Noticed::Notification"
+
   has_many :social_links
   accepts_nested_attributes_for :social_links, :allow_destroy => true
 

app/models/user_notifications.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+class UserNotifications
+  class Notification
+    def self.from(notification)
+      partial_classname = notification.class.name.sub("Notifier::Notification", "")
+      klass = "UserNotifications::#{partial_classname}Notification".constantize
+      klass.new(notification)
+    end
+
+    def initialize(notification)
+      @notification = notification
+    end
+
+    def visible?
+      true
+    end
+
+    def to_partial_path
+      partial_basename = @notification.class.name.sub("Notifier::Notification", "").underscore
+      "notifications/#{partial_basename}"
+    end
+
+    def timestamp
+      record.created_at
+    end
+
+    private
+
+    def record
+      @notification.record
+    end
+  end
+
+  class ChangesetCommentNotification < Notification
+    delegate :changeset, :to => :record
+    delegate :visible?, :to => :record
+
+    def commenter
+      record.author
+    end
+
+    def comment_id
+      record.id
+    end
+
+    def comment_body
+      record.body
+    end
+  end
+
+  include Enumerable
+
+  LISTABLE_NOTIFICATIONS = %w[
+    ChangesetCommentNotifier::Notification
+  ].freeze
+
+  def initialize(user)
+    @user = user
+  end
+
+  def visible
+    select(&:visible?)
+  end
+
+  def each(&)
+    @user
+      .notifications
+      .where(:type => LISTABLE_NOTIFICATIONS)
+      .newest_first
+      .map { |record| Notification.from(record) }
+      .each(&)
+  end
+end

app/views/notifications/_changeset_comment.html.erb

@@ -0,0 +1,26 @@
+<%# locals: (notification:) %>
+
+<article class="user-notification">
+  <p class="text-body-secondary mb-1">
+    <%= t(
+          ".notification_header_html",
+          :changeset_comment_link => link_to(
+            t(".changeset_comment"),
+            changeset_path(
+              notification.changeset,
+              :anchor => "c#{notification.comment_id}"
+            )
+          ),
+          :commenter_name_link => link_to(
+            notification.commenter.display_name,
+            notification.commenter
+          ),
+          :time_ago => friendly_date_ago(notification.timestamp)
+        ) %>
+  </p>
+  <blockquote class="mx-2 fst-italic">
+    <p class="text-truncate"><%= notification.comment_body.truncate(200, :separator => " ") %></p>
+  </blockquote>
+</article>
+
+<hr>

app/views/notifications/index.html.erb

@@ -1,3 +1,7 @@
 <% content_for :heading do %>
   <h1><%= t ".title" %></h1>
 <% end %>
+
+<% @notifications.each do |notification| %>
+  <%= render :partial => notification.to_partial_path, :object => notification, :as => :notification %>
+<% end %>

test/controllers/notifications/changeset_comment_view_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Notifications
+  class ChangesetCommentViewTest < ActionView::TestCase
+    def test_basic
+      comment_author = build_stubbed(
+        :user,
+        :display_name => "Helpful Commenter"
+      )
+      changeset = build_stubbed(:changeset)
+      changeset_comment = build_stubbed(
+        :changeset_comment,
+        :author => comment_author,
+        :changeset => changeset
+      )
+      notification = Struct.new(:record).new(changeset_comment)
+      notification_wrapper = UserNotifications::ChangesetCommentNotification.new(notification)
+
+      render "notifications/changeset_comment", :notification => notification_wrapper
+
+      assert_dom ".user-notification p", "Changeset comment from Helpful Commenter less than 1 minute ago"
+      assert_dom ".user-notification blockquote", changeset.comment
+    end
+  end
+end

test/factories/notifications.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :changeset_comment_notification, :class => "ChangesetCommentNotifier::Notification" do
+    event :factory => :changeset_comment_notifier
+    recipient :factory => :user
+  end
+
+  factory :changeset_comment_notifier, :class => "ChangesetCommentNotifier" do
+    record :factory => :changeset_comment
+  end
+end

test/models/user_notifications_test.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class UserNotificationsTest < ActiveSupport::TestCase
+  def test_visible_skips_hidden_changeset_comments
+    create(:language, :code => "en")
+    changeset_author = create(:user)
+    changeset = create(:changeset, :user => changeset_author)
+    comments = create_list(:changeset_comment, 3, :changeset => changeset)
+    comments.each do |comment|
+      event = create(:changeset_comment_notifier, :record => comment)
+      create(:changeset_comment_notification, :event => event, :recipient => changeset_author)
+    end
+
+    assert_equal 3, UserNotifications.new(changeset_author).visible.count
+
+    comments.first.update(:visible => false)
+    assert_equal 2, UserNotifications.new(changeset_author).visible.count
+  end
+end

test/system/onsite_notifications_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "application_system_test_case"
+
+class OnsiteNotificationsTest < ApplicationSystemTestCase
+  test "read latest notifications" do
+    changeset_author = create(:user)
+    commenter = create(:user, :display_name => "Commenter")
+    setup_changeset_comment(
+      :changeset_author => changeset_author,
+      :commenter => commenter
+    )
+
+    sign_in_as(changeset_author)
+
+    click_on changeset_author.display_name
+    click_on "My Notifications"
+
+    assert_text "Notifications"
+    assert_text "Changeset comment from Commenter"
+  end
+
+  private
+
+  def setup_changeset_comment(changeset_author:, commenter:)
+    changeset = create(:changeset, :user => changeset_author)
+    create(:changeset_subscription, :changeset => changeset, :subscriber => changeset_author)
+
+    comment = create(:changeset_comment, :changeset => changeset, :author => commenter)
+    create(:changeset_subscription, :changeset => changeset, :subscriber => commenter)
+    ChangesetCommentNotifier.with(:record => comment).deliver
+  end
+end