notey 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c58921ef29966128ff879a465b658aecc03be72d9854b20e35fcf374bdf227
-  data.tar.gz: f33f53d08767a17f9409255954c1561a9d334e58c8d4e141410a3f1e3af8d429
+  metadata.gz: 7610a3ba662e8faccd42819f0422ba19dd6b23f65619de246b28b89b201d7cbd
+  data.tar.gz: ce7e9b0e188efd5790e8b2d9a8545d0fdfc418133db9f7fca3f78cf529eb2e71
 SHA512:
-  metadata.gz: 679238d4b8f289a4e653a11a86002544d1eabbba16d381e691bbbfc2d8a813c4c86d4a988d2d008f7d88d637bbfd8ab24b9f8b844bae12270d04f63150dbb6b0
-  data.tar.gz: 4a0fe1f0a1f63ce23242147a896c8f45a6acad9bee3118b668a553aa9af68bf565e358d0ecc821511c5fa55b66c60dec7005bc99dd11bc43a9af2d9220608508
+  metadata.gz: 961ec39375572d803830b55c13bc140c44a2a999d7ce6bdc55ee5124ef5bf9f059adb46bbb87fce89af72b6a9bfb61ce5617bdd513fb0be725d48df2cbf88e4e
+  data.tar.gz: cf7398efa6cd3d2a7f8afe4ff6a7dd83076db6cc4929f3ca80506c590d5ab86aadf5fea04ec6cb3cac8119d4d00ec34c7e3112dc2c25ecc4e8dde29f44b44125

data/README.md

@@ -163,8 +163,8 @@ end
 
 ## Settings sections
 
-Notey ships its two pages as partials and their saving as action objects, so a
-settings shell renders them inside its own chrome rather than linking away.
+Notey ships its screens as partials and their saving as action objects, so a
+settings shell renders them inside its own page frame rather than linking away.
 With [`bureau`](https://github.com/DYB-Development/bureau):
 
 ```ruby
@@ -180,6 +180,29 @@ A section registered this way is served by the settings shell, so the shell's
 own capability check guards it. A section that only links to a mounted path is
 not guarded, because the shell never renders it.
 
+## The inbox
+
+The inbox is the same shape and is not a setting, so render it wherever a
+person's notifications belong in your own pages:
+
+```erb
+<%= render "notey/inbox",
+      person: current_user,
+      account: current_account.id,
+      submit_url: notifications_path %>
+```
+
+It lists the notifications that person received in that account, newest first,
+marking the unread ones. Marking one read posts to the url you named, so the
+person stays on your page, and the action behind it runs:
+
+```ruby
+Notey::MarkRead.new(person: current_user, account: current_account.id, values: params).call
+```
+
+It marks only a notification that person received in that account, so an id
+from anywhere else does nothing.
+
 `Notey::SavePreferences` and `Notey::SaveDestination` take `person:`, `account:`
 and `values:`, and answer with an object responding to `ok?` and `message`. The
 engine's own pages call the same two actions.

data/app/models/notey/mark_read.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Notey
+  class MarkRead
+    def initialize(values:, person: nil, account: nil)
+      @person = person
+      @account_id = account.respond_to?(:id) ? account.id : account
+      @values = values
+    end
+
+    def call
+      notification&.mark_as_read!
+
+      Kept.new
+    end
+
+    private
+
+    def notification
+      Inbox.for(@person, account_id: @account_id).find_by(id: @values[:read])
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+<% 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 %>

data/lib/notey/version.rb

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

data/the_local/agents/notey-develop.md

@@ -45,6 +45,11 @@ This local assumes the gem is already hooked into the app; if it is not, that is
   set.
 - `Notey::Inbox.for(member, account_id:)` — returns that person's notifications
   for that account, as a relation.
+- `notey/inbox` — the partial a host renders inside a page of its own to show a
+  person their notifications, taking `person`, `account` and the `submit_url`
+  that marking one read posts to.
+- `Notey::MarkRead` — marks the notification a person picked as read, and marks
+  nothing when the id belongs to another person or another account.
 - `wants?(type, on:, account_id:)` — on the recipient model, true when that
   person wants that type on that channel in that account.
 - `channels_for(type, account_id:)` — on the recipient model, the channels that

data/the_local/interface.yml

@@ -22,6 +22,8 @@ develop:
   - Notey::DigestRun
   - Notey::DeleteOldAttempts
   - Notey::Inbox.for
+  - notey/inbox
+  - Notey::MarkRead
   - wants?
   - channels_for
   - digest_window_for
@@ -43,6 +45,8 @@ sources:
   - app/models/notey/digest.rb
   - app/models/notey/attempt.rb
   - app/models/notey/delete_old_attempts.rb
+  - app/models/notey/mark_read.rb
+  - app/views/notey/_inbox.html.erb
   - app/delivery_methods/notey/email.rb
   - app/delivery_methods/notey/in_app.rb
   - app/jobs/notey/digest_job.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - tylercschneider
@@ -92,6 +92,7 @@ files:
 - app/models/notey/destination.rb
 - app/models/notey/digest.rb
 - app/models/notey/kept.rb
+- app/models/notey/mark_read.rb
 - app/models/notey/notification.rb
 - app/models/notey/preference.rb
 - app/models/notey/refusal.rb
@@ -99,6 +100,7 @@ files:
 - app/models/notey/save_my_destination.rb
 - app/models/notey/save_preferences.rb
 - app/views/notey/_destinations.html.erb
+- app/views/notey/_inbox.html.erb
 - app/views/notey/_my_destinations.html.erb
 - app/views/notey/_preferences.html.erb
 - app/views/notey/destinations/show.html.erb