notey 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7610a3ba662e8faccd42819f0422ba19dd6b23f65619de246b28b89b201d7cbd
-  data.tar.gz: ce7e9b0e188efd5790e8b2d9a8545d0fdfc418133db9f7fca3f78cf529eb2e71
+  metadata.gz: 2ace1eb52d62353acc618570451eade8a1736dd225b8ce899c68eec551c51355
+  data.tar.gz: 4752a3d42bab1851769adaa9bf11fdfb730ceb1ce80f0371a7835af6c837761e
 SHA512:
-  metadata.gz: 961ec39375572d803830b55c13bc140c44a2a999d7ce6bdc55ee5124ef5bf9f059adb46bbb87fce89af72b6a9bfb61ce5617bdd513fb0be725d48df2cbf88e4e
-  data.tar.gz: cf7398efa6cd3d2a7f8afe4ff6a7dd83076db6cc4929f3ca80506c590d5ab86aadf5fea04ec6cb3cac8119d4d00ec34c7e3112dc2c25ecc4e8dde29f44b44125
+  metadata.gz: 2422c9b8fbe31ee6ac5907eb6f61a4f85ad46404c6c8fba15207923db5069e0886bb6ecf8c0fa52c65f2491cc506cda42f59f3964d7bf56b2be988d9b36b0332
+  data.tar.gz: fbccb4c605399312f12a45f0e15cf512f9542e794aa2fd582c45e6c731fb851d52a770ca7d194274ff1fde173ed62f475e1a13b767dc7bfdae0888357bc53ffd

data/README.md

@@ -207,6 +207,42 @@ from anywhere else does nothing.
 and `values:`, and answer with an object responding to `ok?` and `message`. The
 engine's own pages call the same two actions.
 
+## Live updates
+
+An open inbox can show a new notification the moment it is delivered, without a
+reload. It is off until you turn it on, because it needs Turbo and a running
+Action Cable server in production.
+
+```ruby
+# config/initializers/notey.rb
+Notey.live_updates = true
+Notey.mark_read_url = ->(notification) { Rails.application.routes.url_helpers.notifications_path }
+```
+
+`mark_read_url` is the url a pushed row's Mark read button posts to. A push is
+rendered in a background job, which has no request to read that url from, so
+you name it here. It is usually the same url you pass the inbox as `submit_url`.
+
+With it on, the inbox and the engine's notifications page subscribe to one
+stream per person per account, and:
+
+- a notification delivered in-app appears at the top of that person's open
+  inbox in that account,
+- marking one read shows it as read in the person's other open tabs,
+- the unread count changes in every open tab of that person in that account.
+
+Show the unread count anywhere on your page, and a push keeps it current:
+
+```erb
+<%= render "notey/unread_count", person: current_user, account: current_account.id %>
+```
+
+Notey does not install Turbo for you. Add `turbo-rails` to your Gemfile and load
+its JavaScript. With live updates on and Turbo or `mark_read_url` missing, the
+app refuses to boot and names what is missing. A push that fails, such as when
+the cable server is down, is logged, and the read or delivery it came from still
+goes through.
+
 ## Sending digests
 
 A type set to daily or weekly sends nothing when it happens. Run the window on a

data/app/controllers/notey/notifications_controller.rb

@@ -6,13 +6,12 @@ module Notey
 
     def index
       @notifications = inbox.includes(:event).order(created_at: :desc).limit(PER_PAGE)
-      @unread_count = inbox.unread.count
 
       Noticed::Notification.where(id: @notifications.map(&:id)).unseen.mark_as_seen
     end
 
     def update
-      inbox.find(params[:id]).mark_as_read!
+      MarkRead.new(person: Current.member, account: Current.account_id, values: { read: params[:id] }).call
 
       redirect_to notifications_path
     end

data/app/delivery_methods/notey/in_app.rb

@@ -3,6 +3,7 @@
 module Notey
   class InApp < Noticed::DeliveryMethod
     def deliver
+      LiveInbox.deliver(notification) if Notey.live_updates
     end
 
     def outbound?

data/app/models/notey/mark_read.rb

@@ -9,15 +9,20 @@ module Notey
     end
 
     def call
-      notification&.mark_as_read!
+      mark(notification) if notification
 
       Kept.new
     end
 
     private
 
+    def mark(notification)
+      notification.mark_as_read!
+      LiveInbox.read(notification) if Notey.live_updates
+    end
+
     def notification
-      Inbox.for(@person, account_id: @account_id).find_by(id: @values[:read])
+      @notification ||= Inbox.for(@person, account_id: @account_id).find_by(id: @values[:read])
     end
   end
 end

data/app/views/notey/_inbox.html.erb

@@ -1,16 +1,7 @@
 <% notifications = Notey::Inbox.for(person, account_id: account).includes(:event).order(created_at: :desc) %>
 
-<% notifications.each do |notification| %>
-  <%= ui_panel do %>
-    <div data-notification-id="<%= notification.id %>">
-      <%= notification.event.title %>
-      <%= ui_badge(label: notification.read? ? "Read" : "Unread") %>
-      <% unless notification.read? %>
-        <%= ui_form(action: submit_url, method: :patch) do %>
-          <%= hidden_field_tag "read", notification.id, id: nil %>
-          <%= ui_button(label: "Mark read") %>
-        <% end %>
-      <% end %>
-    </div>
-  <% end %>
-<% end %>
+<%= render "notey/live_stream", person: person, account: account %>
+
+<div id="notey_inbox">
+  <%= render partial: "notey/notification", collection: notifications, locals: { submit_url: submit_url } %>
+</div>

data/app/views/notey/_live_stream.html.erb

@@ -0,0 +1 @@
+<%= turbo_stream_from(*Notey::LiveInbox.stream(person, account)) if Notey.live_updates && account.present? %>

data/app/views/notey/_notification.html.erb

@@ -0,0 +1,14 @@
+<div id="notey_notification_<%= notification.id %>">
+  <%= ui_panel do %>
+    <div data-notification-id="<%= notification.id %>">
+      <%= notification.event.title %>
+      <%= ui_badge(label: notification.read? ? "Read" : "Unread") %>
+      <% unless notification.read? %>
+        <%= ui_form(action: submit_url, method: :patch) do %>
+          <%= hidden_field_tag "read", notification.id, id: nil %>
+          <%= ui_button(label: "Mark read") %>
+        <% end %>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/views/notey/_unread_count.html.erb

@@ -0,0 +1 @@
+<span id="notey_unread_count"><%= Notey::Inbox.for(person, account_id: account).unread.count %></span>

data/app/views/notey/notifications/index.html.erb

@@ -1,17 +1,11 @@
+<%= render "notey/live_stream", person: Notey::Current.member, account: Notey::Current.account_id %>
+
 <%= ui_page(max_width: :lg) do %>
-  <%= ui_section(title: "Notifications", subtitle: "#{@unread_count} unread") do %>
-    <% @notifications.each do |notification| %>
-      <%= ui_panel do %>
-        <div data-notification-id="<%= notification.id %>">
-          <%= notification.event.class.name %>
-          <%= ui_badge(label: notification.read? ? "Read" : "Unread") %>
-          <% unless notification.read? %>
-            <%= ui_form(action: notification_path(notification), method: :patch) do %>
-              <%= ui_button(label: "Mark read") %>
-            <% end %>
-          <% end %>
-        </div>
+  <%= ui_section(title: "Notifications", subtitle: safe_join([ render("notey/unread_count", person: Notey::Current.member, account: Notey::Current.account_id), " unread" ])) do %>
+    <div id="notey_inbox">
+      <% @notifications.each do |notification| %>
+        <%= render "notey/notification", notification: notification, submit_url: notification_path(notification) %>
       <% end %>
-    <% end %>
+    </div>
   <% end %>
 <% end %>

data/lib/notey/live_inbox.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Notey
+  class LiveInbox
+    def self.stream(person, account_id)
+      [ person, :notey_inbox, account_id ]
+    end
+
+    def self.deliver(notification)
+      return if notification.account_id.blank?
+
+      pushing(notification) do
+        Turbo::StreamsChannel.broadcast_prepend_to(
+          *stream_of(notification), target: "notey_inbox", html: row(notification)
+        )
+        push_unread_count(notification)
+      end
+    end
+
+    def self.read(notification)
+      pushing(notification) do
+        Turbo::StreamsChannel.broadcast_replace_to(
+          *stream_of(notification), target: "notey_notification_#{notification.id}", html: row(notification)
+        )
+        push_unread_count(notification)
+      end
+    end
+
+    def self.pushing(notification)
+      yield
+    rescue StandardError => error
+      Rails.logger.error("notey could not push notification #{notification.id}: #{error.message}")
+    end
+
+    def self.push_unread_count(notification)
+      Turbo::StreamsChannel.broadcast_replace_to(
+        *stream_of(notification), target: "notey_unread_count", html: unread_count(notification)
+      )
+    end
+
+    def self.stream_of(notification)
+      stream(notification.recipient, notification.account_id)
+    end
+
+    def self.row(notification)
+      Notey::ApplicationController.render(
+        partial: "notey/notification",
+        locals: { notification: notification, submit_url: Notey.mark_read_url.call(notification) }
+      )
+    end
+
+    def self.unread_count(notification)
+      Notey::ApplicationController.render(
+        partial: "notey/unread_count",
+        locals: { person: notification.recipient, account: notification.account_id }
+      )
+    end
+    private_class_method :pushing, :push_unread_count, :stream_of, :row, :unread_count
+  end
+end

data/lib/notey/version.rb

@@ -1,3 +1,3 @@
 module Notey
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/notey.rb

@@ -3,6 +3,7 @@ require "notey/engine"
 require "notey/channels"
 require "notey/destinations"
 require "notey/inbox"
+require "notey/live_inbox"
 require "notey/digest_run"
 require "notey/records_attempt"
 
@@ -20,10 +21,12 @@ module Notey
   class UnsendableChannel < StandardError; end
   class UnsendableAttempt < StandardError; end
   class MissingRetention < StandardError; end
+  class MissingMarkReadUrl < StandardError; end
+  class MissingTurbo < StandardError; end
 
   class << self
     attr_writer :notification_url, :mailer_sender
-    attr_accessor :attempt_retention
+    attr_accessor :attempt_retention, :live_updates, :mark_read_url
   end
 
   def self.mailer_sender
@@ -87,6 +90,7 @@ module Notey
   def self.check!
     registered_channels.each { |channel| check_channel!(channel) }
     check_sender!
+    check_live_updates! if live_updates
   end
 
   def self.check_channel!(channel)
@@ -116,6 +120,17 @@ module Notey
     raise MissingSender, "notey sends digests by email and no mailer_sender is set"
   end
 
+  def self.check_live_updates!
+    raise MissingTurbo, "notey pushes live updates with turbo-rails, which is not loaded" unless turbo_loaded?
+    return if mark_read_url
+
+    raise MissingMarkReadUrl, "notey pushes rows with a Mark read button and no mark_read_url is set"
+  end
+
+  def self.turbo_loaded?
+    defined?(::Turbo::StreamsChannel).present?
+  end
+
   def self.sends(notification_type, on:, addressed: false, via: nil)
     lambda do
       decision = Channels.decision_for(recipient, notification_type, account_id: event.account_id)
@@ -130,6 +145,8 @@ module Notey
 
   def self.reset!
     @host_channels = nil
+    @live_updates = nil
+    @mark_read_url = nil
     forget_notifiers
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notey
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - tylercschneider
@@ -101,8 +101,11 @@ files:
 - app/models/notey/save_preferences.rb
 - app/views/notey/_destinations.html.erb
 - app/views/notey/_inbox.html.erb
+- app/views/notey/_live_stream.html.erb
 - app/views/notey/_my_destinations.html.erb
+- app/views/notey/_notification.html.erb
 - app/views/notey/_preferences.html.erb
+- app/views/notey/_unread_count.html.erb
 - app/views/notey/destinations/show.html.erb
 - app/views/notey/digest_mailer/digest.html.erb
 - app/views/notey/notification_mailer/notification.html.erb
@@ -122,6 +125,7 @@ files:
 - lib/notey/digest_run.rb
 - lib/notey/engine.rb
 - lib/notey/inbox.rb
+- lib/notey/live_inbox.rb
 - lib/notey/records_attempt.rb
 - lib/notey/version.rb
 - lib/tasks/notey_tasks.rake