shiplog 0.3.1 → 0.4.0

data/app/models/shiplog/rewriter.rb

@@ -4,6 +4,8 @@ module Shiplog
     PARSE_ERROR = "Could not parse rewriter output".freeze
     MAX_TITLE_CHARS = 120
     MAX_BODY_CHARS = 2_000
+    # An announcement's Markdown body covers a whole month.
+    MAX_ANNOUNCEMENT_BODY_CHARS = 10_000
     MAX_ROADMAP_BODY_CHARS = 220
     # A period after a common abbreviation ("e.g.", "i.e.", "approx.", "etc.") does not end a sentence.
     SENTENCE_END = /(?<!\be\.g)(?<!\bi\.e)(?<!\bapprox)(?<!\betc)(?<!\bvs)(?<!\bcf)[.!?](?=\s|\z)/i
@@ -38,6 +40,9 @@ module Shiplog
 
     def self.sanitize(text) = text.tr("\t", " ").gsub(CONTROL_CHARS, "")
 
+    # The longest body an entry of this kind may have.
+    def self.max_body_chars(entry) = entry.announcement? ? MAX_ANNOUNCEMENT_BODY_CHARS : MAX_BODY_CHARS
+
     def initialize(entry)
       @entry = entry
     end
@@ -46,6 +51,7 @@ module Shiplog
     # call replaces the text of an approved entry but returns it to draft for re-approval.
     def call(force: false)
       return @entry if @entry.approved? && !force
+      return write_skeleton(force) if @entry.announcement? && Shiplog.config.rewriter.nil?
 
       result = parse(request)
       locked(force) { result ? apply(result) : fail_with(PARSE_ERROR) }
@@ -56,6 +62,19 @@ module Shiplog
     end
 
     private
+      # Without a rewriter, an announcement's draft is its month's skeleton (Period#title and #body), written fresh
+      # so that regenerating it picks up the month's current entries. Not an error: it is the documented draft.
+      def write_skeleton(force)
+        locked(force) do
+          period = @entry.subject
+          @entry.assign_attributes(title: period.title, body: period.body, rewritten_at: Time.current, rewrite_error: nil,
+            source_digest: Entry.digest_for(period))
+          @entry.assign_attributes(status: "draft", approved_at: nil, approved_by: nil) if @entry.approved?
+          @entry.save!
+        end
+        @entry
+      end
+
       # Re-checks state under a row lock: the entry may have been approved or edited during the LLM call.
       def locked(force)
         @entry.with_lock do
@@ -68,7 +87,8 @@ module Shiplog
         rewriter = Shiplog.config.rewriter
         raise "No rewriter configured" unless rewriter
 
-        rewriter.call(Prompt.new(@entry).to_s).to_s
+        prompt = @entry.announcement? ? AnnouncementPrompt.new(@entry) : Prompt.new(@entry)
+        rewriter.call(prompt.to_s).to_s
       end
 
       def parse(reply) = self.class.first_valid_object(reply) { |data| validate(data) }
@@ -85,7 +105,7 @@ module Shiplog
       end
 
       def limit_body(body)
-        return body.truncate(MAX_BODY_CHARS, separator: " ", omission: "…") unless @entry.roadmap?
+        return body.truncate(self.class.max_body_chars(@entry), separator: " ", omission: "…") unless @entry.roadmap?
 
         shorten_roadmap(body)
       end
@@ -108,7 +128,7 @@ module Shiplog
       # nothing (cap reached, invalid) keeps the entry's current area: only an explicit valid name changes it. No
       # area in the reply keeps it too, and one an admin chose is never changed.
       def assign_area(name)
-        return if name.nil? || @entry.area_set_by_admin?
+        return if name.nil? || @entry.area_set_by_admin? || @entry.announcement?
 
         area = Area.resolve_or_create(name)
         @entry.area = area if area

data/app/models/shiplog/translator/prompt.rb

@@ -8,7 +8,7 @@ module Shiplog
       TEMPLATE = <<~PROMPT.freeze
         You translate release notes%<product>s into %<language>s (locale %<locale>s).%<audience>s
         Tone to keep: %<tone>s
-        Translate the title and the body inside <source>. Keep the meaning, the tone, product names, numbers, links, line breaks and formatting; do not add, remove or explain anything.
+        Translate the title and the body inside <source>. Keep the meaning, the tone, product names, numbers, links, line breaks and formatting (Markdown stays Markdown, link URLs unchanged); do not add, remove or explain anything.
         Leave product names, code and anything in backticks untranslated. Write the way a native speaker would, with no word-for-word calques.
         %<length_rule>s
         Reply with JSON only: {"title": "...", "body": "..."}
@@ -33,7 +33,7 @@ module Shiplog
         format(TEMPLATE, product: config.product_name.present? ? " for #{config.product_name}" : "", language: Translator.language_name(@locale),
           locale: @locale, audience: config.audience.present? ? " The readers are #{config.audience}." : "", tone: config.tone,
           length_rule: @entry.roadmap? ? ROADMAP_LENGTH_RULE : LENGTH_RULE,
-          title: Rewriter::Prompt.clean(@entry.title, MAX_TITLE_CHARS), body: Rewriter::Prompt.clean(@entry.body, Rewriter::MAX_BODY_CHARS))
+          title: Rewriter::Prompt.clean(@entry.title, MAX_TITLE_CHARS), body: Rewriter::Prompt.clean(@entry.body, Rewriter.max_body_chars(@entry)))
       end
     end
   end

data/app/models/shiplog/translator.rb

@@ -71,7 +71,7 @@ module Shiplog
       def limit_body(body)
         return Rewriter.shorten_roadmap(body) if @entry.roadmap?
 
-        body.truncate(Rewriter::MAX_BODY_CHARS, separator: " ", omission: "…")
+        body.truncate(Rewriter.max_body_chars(@entry), separator: " ", omission: "…")
       end
 
       # Writes under the entry's row lock, after checking again: the entry may have been unpublished, edited or

data/app/views/shiplog/admin/_nav.html.erb

@@ -5,6 +5,9 @@
     <li><%= link_to t("shiplog.admin.nav.drafts"), root_path, class: "shiplog-admin-nav__link" %></li>
     <li><%= link_to t("shiplog.admin.nav.board"), board_path, class: "shiplog-admin-nav__link" %></li>
     <li><%= link_to t("shiplog.admin.nav.areas", default: "Areas"), areas_path, class: "shiplog-admin-nav__link" %></li>
+    <% if Shiplog.newsletter? %>
+      <li><%= link_to t("shiplog.admin.nav.newsletter", default: "Newsletter"), newsletter_subscribers_path, class: "shiplog-admin-nav__link" %></li>
+    <% end %>
     <li><%= link_to t("shiplog.admin.nav.sync"), sync_path, class: "shiplog-admin-nav__link" %></li>
   </ul>
 </nav>

data/app/views/shiplog/admin/entries/_announcement.html.erb

@@ -0,0 +1,52 @@
+<%# locals: (entry:) %>
+<%# An announcement's preview (its Markdown rendered as on the public page), where it is published, whether the
+    host was told (config.on_announcement_approved), the export links and, with config.newsletter, the newsletter. %>
+<section class="shiplog-admin-panel">
+  <h2><%= t("shiplog.admin.announcements.publishing") %></h2>
+  <% if entry.approved? %>
+    <p>
+      <% if Shiplog.announcement_pages? && entry.public_url %>
+        <%= link_to t("shiplog.admin.announcements.view_page"), entry.public_url, target: "_blank", rel: "noopener" %>
+      <% elsif Shiplog.config.announcements == :external %>
+        <%= t("shiplog.admin.announcements.external") %>
+      <% end %>
+    </p>
+    <p class="shiplog-admin__muted">
+      <% if entry.announced_at %>
+        <%= t("shiplog.admin.announcements.announced", time: l(entry.announced_at, format: :short)) %>
+      <% elsif !entry.translations_ready? %>
+        <%= t("shiplog.admin.announcements.waiting_for_translations") %>
+      <% else %>
+        <%= t("shiplog.admin.announcements.announcing") %>
+      <% end %>
+    </p>
+    <% if entry.announced_at.nil? && Shiplog.announcements? %>
+      <%= button_to t("shiplog.admin.announcements.notify_now"), entry_announcement_notification_path(entry, inbox_filter_params), class: "shiplog-button" %>
+      <p class="shiplog-admin__muted"><%= t("shiplog.admin.announcements.notify_now_hint") %></p>
+    <% end %>
+  <% else %>
+    <p class="shiplog-admin__muted"><%= t("shiplog.admin.announcements.not_approved") %></p>
+  <% end %>
+
+  <p>
+    <%= t("shiplog.admin.announcements.export") %>
+    <% [ I18n.default_locale.to_s, *Shiplog.config.locales.map(&:to_s) ].each do |locale| %>
+      <span class="shiplog-admin-export">
+        <% if Shiplog.config.locales.any? %><strong><%= locale %></strong><% end %>
+        <% { "markdown" => "Markdown", "html" => "HTML", "text" => t("shiplog.admin.announcements.plain_text") }.each do |format, label| %>
+          <%= link_to label, entry_export_path(entry, as: format, export_locale: (locale unless locale == I18n.default_locale.to_s)) %>
+        <% end %>
+      </span>
+    <% end %>
+  </p>
+
+  <% if Shiplog.newsletter? %>
+    <%= render "shiplog/admin/entries/newsletter", entry: %>
+  <% end %>
+
+  <h3><%= t("shiplog.admin.announcements.preview") %></h3>
+  <div class="shiplog-admin-preview">
+    <h2><%= entry.title %></h2>
+    <%= Shiplog::Markdown.to_html(entry.body, heading_offset: 1) %>
+  </div>
+</section>

data/app/views/shiplog/admin/entries/_badges.html.erb

@@ -1,5 +1,5 @@
 <% if entry.source_changed? %>
-  <span class="shiplog-badge shiplog-badge--warning"><%= t("shiplog.admin.entries.source_changed") %></span>
+  <span class="shiplog-badge shiplog-badge--warning"><%= t(entry.announcement? ? "shiplog.admin.entries.entries_changed" : "shiplog.admin.entries.source_changed") %></span>
 <% end %>
 <% if entry.draft? && entry.rewritten_at.nil? && entry.rewrite_error.blank? %>
   <span class="shiplog-badge"><%= t("shiplog.admin.entries.not_rewritten") %></span>

data/app/views/shiplog/admin/entries/_newsletter.html.erb

@@ -0,0 +1,42 @@
+<%# locals: (entry:) %>
+<%# The newsletter section of an announcement's panel: how the send is going, "Send test" to the admin's address
+    in a chosen locale, and "Send" (the confirmation step) when nothing blocks it, else why it is disabled. %>
+<% blockers = Shiplog::Newsletter.blockers(entry) %>
+<% progress = Shiplog::NewsletterDelivery.progress(entry) %>
+<% admin_email = current_admin_name.to_s.strip %>
+<% admin_email = nil unless URI::MailTo::EMAIL_REGEXP.match?(admin_email) %>
+<% locales = Shiplog::NewsletterSubscriber.allowed_locales %>
+<h3><%= t("shiplog.admin.newsletter.heading") %></h3>
+<p class="shiplog-admin__muted shiplog-admin-newsletter__progress">
+  <% if progress.values_at(:sent, :failed, :pending).sum.zero? %>
+    <%= t("shiplog.admin.newsletter.not_sent") %>
+  <% else %>
+    <%= t("shiplog.admin.newsletter.progress", **progress.slice(:sent, :failed, :pending)) %>
+    <% if progress[:stalled].positive? %>
+      <%= t("shiplog.admin.newsletter.stalled", count: progress[:stalled]) %>
+    <% end %>
+  <% end %>
+</p>
+<div class="shiplog-admin-actions">
+  <%= shiplog_javascript_tag "once" %>
+  <%= form_with url: entry_newsletter_test_path(entry, inbox_filter_params), class: "shiplog-admin-inline-form", data: { shiplog_once: true } do |form| %>
+    <%# test_locale, not locale: a host's around_action that switches the locale from params[:locale] must not read it %>
+    <%= form.label :test_locale, t("shiplog.admin.newsletter.test_locale") %>
+    <%= form.select :test_locale, locales.map { |locale| [ translation_language_label(locale), locale ] } %>
+    <%= form.submit t("shiplog.admin.newsletter.test", email: admin_email || "?"), class: "shiplog-button", disabled: admin_email.nil? %>
+    <% if admin_email.nil? %>
+      <span class="shiplog-admin__muted"><%= t("shiplog.admin.newsletter.test_no_email") %></span>
+    <% end %>
+  <% end %>
+  <div class="shiplog-admin-inline-form">
+    <% if blockers.any? %>
+      <button type="button" class="shiplog-button shiplog-button--primary" disabled><%= t("shiplog.admin.newsletter.send") %></button>
+      <span class="shiplog-admin__muted"><%= t("shiplog.admin.newsletter.send_blocked", reasons: blockers.map { |blocker| t("shiplog.admin.newsletter.blockers.#{blocker}", locales: Shiplog::Newsletter.missing_locales(entry).join(", ")) }.join(", ")) %></span>
+    <% else %>
+      <%= link_to t("shiplog.admin.newsletter.send"), entry_newsletter_path(entry, inbox_filter_params), class: "shiplog-button shiplog-button--primary" %>
+    <% end %>
+    <% if progress[:failed].positive? || progress[:stalled].positive? %>
+      <%= button_to t("shiplog.admin.newsletter.retry"), entry_newsletter_retry_path(entry, inbox_filter_params), class: "shiplog-button", form: { data: { shiplog_once: true } } %>
+    <% end %>
+  </div>
+</div>

data/app/views/shiplog/admin/entries/edit.html.erb

@@ -20,7 +20,7 @@
         </p>
         <p>
           <%= form.label :body, t("shiplog.admin.entries.fields.body") %>
-          <%= form.text_area :body, rows: 8 %>
+          <%= form.text_area :body, rows: (@entry.announcement? ? 24 : 8) %>
         </p>
         <% if Shiplog::Entry::CHANGELOG_KINDS.include?(@entry.kind) %>
           <p>
@@ -28,6 +28,7 @@
             <%= form.select :changelog_kind, Shiplog::Entry::CHANGELOG_KINDS.map { |kind| [ t("shiplog.admin.entries.category_options.#{kind}"), kind ] } %>
           </p>
         <% end %>
+        <% unless @entry.announcement? %>
         <p>
           <%= form.label :area_id, t("shiplog.admin.entries.fields.area", default: "Area") %>
           <%= form.collection_select :area_id, Shiplog::Area.ordered, :id, :name, include_blank: t("shiplog.admin.entries.no_area", default: "None") %>
@@ -36,6 +37,7 @@
           <%= form.label :released_on, t("shiplog.admin.entries.fields.released_on") %>
           <%= form.date_field :released_on %>
         </p>
+        <% end %>
         <%= form.submit t("shiplog.admin.entries.save"), class: "shiplog-button shiplog-button--primary" %>
       <% end %>
 
@@ -67,11 +69,15 @@
     </aside>
   </div>
 
+  <% if @entry.announcement? %>
+    <%= render "shiplog/admin/entries/announcement", entry: @entry %>
+  <% end %>
+
   <% if Shiplog.config.locales.any? %>
     <%= render "shiplog/admin/entries/translations", entry: @entry %>
   <% end %>
 
-  <% if Shiplog.images? %>
+  <% if Shiplog.images? && !@entry.announcement? %>
     <%= render "shiplog/admin/entries/images", entry: @entry %>
   <% end %>
 

data/app/views/shiplog/admin/entries/index.html.erb

@@ -1,6 +1,14 @@
 <%= render layout: "shiplog/admin/page" do %>
   <h1 class="shiplog-admin__title"><%= t("shiplog.admin.entries.title") %></h1>
 
+  <% if Shiplog.announcements? %>
+    <div class="shiplog-admin-actions">
+      <% Shiplog::Announcements.draftable_months.each do |month| %>
+        <%= button_to t("shiplog.admin.announcements.draft", month: l(month, format: "%B %Y")), announcements_path(month: month.strftime("%Y-%m"), **inbox_filter_params), class: "shiplog-button" %>
+      <% end %>
+    </div>
+  <% end %>
+
   <nav class="shiplog-admin-filters" aria-label="<%= t("shiplog.admin.entries.filters") %>">
     <ul class="shiplog-admin-filters__list">
       <% Shiplog::Entry.statuses.each_key do |status| %>
@@ -12,6 +20,7 @@
       <li><%= link_to t("shiplog.admin.entries.all_kinds"), entries_filter_path(status: @status),
             class: "shiplog-admin-filters__link", "aria-current": (@kind.nil? ? "true" : nil) %></li>
       <% Shiplog::Entry.kinds.each_key do |kind| %>
+        <% next if kind == "announcement" && !Shiplog.announcements? %>
         <li><%= link_to t("shiplog.admin.entries.kinds.#{kind}"), entries_filter_path(status: @status, kind:),
               class: "shiplog-admin-filters__link", "aria-current": (kind == @kind ? "true" : nil) %></li>
       <% end %>

data/app/views/shiplog/admin/entries/newsletters/show.html.erb

@@ -0,0 +1,46 @@
+<%# The confirmation step before sending: the recipients per locale (after deduplication), what was sent already, and the Send button %>
+<%= render layout: "shiplog/admin/page" do %>
+  <h1 class="shiplog-admin__title"><%= t("shiplog.admin.newsletter.confirm_title", title: @entry.title) %></h1>
+
+  <% if @blockers.any? %>
+    <div class="shiplog-admin__flash shiplog-admin__flash--alert" role="alert">
+      <%= t("shiplog.admin.newsletter.send_blocked", reasons: @blockers.map { |blocker| t("shiplog.admin.newsletter.blockers.#{blocker}", locales: Shiplog::Newsletter.missing_locales(@entry).join(", ")) }.join(", ")) %>
+    </div>
+  <% end %>
+
+  <section class="shiplog-admin-panel">
+    <h2><%= t("shiplog.admin.newsletter.recipients") %></h2>
+    <% if @recipients_error %>
+      <p class="shiplog-admin__flash shiplog-admin__flash--alert" role="alert"><%= t("shiplog.admin.newsletter.recipients_error", error: @recipients_error) %></p>
+    <% elsif @counts.empty? %>
+      <p class="shiplog-admin__muted"><%= t("shiplog.admin.newsletter.recipients_none") %></p>
+    <% else %>
+      <table class="shiplog-admin-table shiplog-admin-counts">
+        <thead>
+          <tr>
+            <th scope="col"><%= t("shiplog.admin.newsletter.columns.locale") %></th>
+            <th scope="col"><%= t("shiplog.admin.newsletter.columns.recipients") %></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @counts.each do |locale, count| %>
+            <tr><td><%= locale %></td><td class="shiplog-admin-counts__number"><%= count %></td></tr>
+          <% end %>
+          <tr><th scope="row"><%= t("shiplog.admin.newsletter.total") %></th><td class="shiplog-admin-counts__number"><%= @counts.values.sum %></td></tr>
+        </tbody>
+      </table>
+    <% end %>
+    <% total = @counts.values.sum %>
+    <% if @progress.values_at(:sent, :failed, :pending).sum.positive? %>
+      <p class="shiplog-admin__muted"><%= t("shiplog.admin.newsletter.progress", **@progress.slice(:sent, :failed, :pending)) %> <%= t("shiplog.admin.newsletter.confirm_resend_help") %></p>
+    <% end %>
+    <p class="shiplog-admin__muted"><%= t("shiplog.admin.newsletter.confirm_help") %></p>
+    <div class="shiplog-admin-actions">
+      <%= shiplog_javascript_tag "once" %>
+      <%= button_to t("shiplog.admin.newsletter.confirm_button", count: total), entry_newsletter_path(@entry, inbox_filter_params), method: :post,
+            class: "shiplog-button shiplog-button--primary", disabled: @blockers.any? || total.zero?, form: { data: { shiplog_once: true } } %>
+    </div>
+  </section>
+
+  <p><%= link_to t("shiplog.admin.newsletter.back"), edit_entry_path(@entry, inbox_filter_params) %></p>
+<% end %>

data/app/views/shiplog/admin/newsletter_subscribers/index.html.erb

@@ -0,0 +1,83 @@
+<%= render layout: "shiplog/admin/page" do %>
+  <h1 class="shiplog-admin__title"><%= t("shiplog.admin.newsletter.title") %></h1>
+  <p class="shiplog-admin__muted"><%= t("shiplog.admin.newsletter.help") %></p>
+
+  <table class="shiplog-admin-table shiplog-admin-counts">
+    <thead>
+      <tr>
+        <th scope="col"><%= t("shiplog.admin.newsletter.columns.locale") %></th>
+        <% Shiplog::NewsletterSubscriber::STATUSES.each do |status| %>
+          <th scope="col"><%= t("shiplog.admin.newsletter.statuses.#{status}") %></th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody>
+      <% @counts.sort_by { |locale, _| locale }.each do |locale, counts| %>
+        <tr>
+          <td><%= locale %></td>
+          <% Shiplog::NewsletterSubscriber::STATUSES.each do |status| %>
+            <td class="shiplog-admin-counts__number"><%= counts[status] %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      <tr>
+        <th scope="row"><%= t("shiplog.admin.newsletter.total") %></th>
+        <% Shiplog::NewsletterSubscriber::STATUSES.each do |status| %>
+          <td class="shiplog-admin-counts__number"><%= @counts.values.sum { |counts| counts[status] } %></td>
+        <% end %>
+      </tr>
+    </tbody>
+  </table>
+
+  <div class="shiplog-admin-actions">
+    <%= form_with url: newsletter_subscribers_path, method: :get, class: "shiplog-admin-inline-form" do |form| %>
+      <%= form.label :q, t("shiplog.admin.newsletter.search"), class: "shiplog-admin__visually-hidden" %>
+      <%= form.search_field :q, value: @query, placeholder: t("shiplog.admin.newsletter.search_placeholder") %>
+      <%= form.submit t("shiplog.admin.newsletter.search"), class: "shiplog-button" %>
+      <% if @query.present? %>
+        <%= link_to t("shiplog.admin.newsletter.clear"), newsletter_subscribers_path, class: "shiplog-button" %>
+      <% end %>
+    <% end %>
+    <p><%= link_to t("shiplog.admin.newsletter.export"), newsletter_subscribers_path(format: :csv, q: @query.presence), class: "shiplog-button" %></p>
+  </div>
+
+  <% if @subscribers.empty? %>
+    <p class="shiplog-admin__empty"><%= @query.present? ? t("shiplog.admin.newsletter.no_match", query: @query) : t("shiplog.admin.newsletter.empty") %></p>
+  <% else %>
+    <table class="shiplog-admin-table">
+      <thead>
+        <tr>
+          <th scope="col"><%= t("shiplog.admin.newsletter.columns.email") %></th>
+          <th scope="col"><%= t("shiplog.admin.newsletter.columns.locale") %></th>
+          <th scope="col"><%= t("shiplog.admin.newsletter.columns.status") %></th>
+          <th scope="col"><%= t("shiplog.admin.newsletter.columns.source") %></th>
+          <th scope="col"><%= t("shiplog.admin.newsletter.columns.subscribed_at") %></th>
+          <th scope="col"><%= t("shiplog.admin.entries.columns.actions") %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @subscribers.each do |subscriber| %>
+          <tr id="shiplog-subscriber-<%= subscriber.id %>">
+            <td><%= subscriber.email %></td>
+            <td><%= subscriber.locale %></td>
+            <td><%= t("shiplog.admin.newsletter.statuses.#{subscriber.status}") %></td>
+            <td><%= subscriber.source %></td>
+            <td><%= l(subscriber.created_at, format: :short) %></td>
+            <td class="shiplog-admin-table__actions">
+              <%= button_to t("shiplog.admin.newsletter.remove"), newsletter_subscriber_path(subscriber, q: @query.presence), method: :delete, class: "shiplog-button" %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% end %>
+
+  <nav class="shiplog-admin-pagination" aria-label="<%= t("shiplog.admin.entries.pagination") %>">
+    <% if @page > 1 %>
+      <%= link_to t("shiplog.admin.entries.newer"), newsletter_subscribers_path(q: @query.presence, page: (@page - 1 if @page > 2)), class: "shiplog-admin-pagination__prev" %>
+    <% end %>
+    <% if @more %>
+      <%= link_to t("shiplog.admin.entries.older"), newsletter_subscribers_path(q: @query.presence, page: @page + 1), class: "shiplog-admin-pagination__next" %>
+    <% end %>
+  </nav>
+<% end %>

data/app/views/shiplog/changelog_entries/announcement.html.erb

@@ -0,0 +1,16 @@
+<%# A month's announcement: its title and Markdown body (Shiplog::Markdown, which escapes everything it does not build) %>
+<% content_for :title, t("shiplog.permalink.title", title: @entry.display_title, changelog: t("shiplog.changelog.title", default: "Changelog"), default: "%{title} · %{changelog}") %>
+<% shiplog_head_page :permalink, title: @entry.display_title, entry: @entry, url: shiplog_entry_url(@entry), json_ld: shiplog_article_json_ld(@entry) %>
+<%= render layout: "shiplog/page", locals: { name: "announcement" } do %>
+  <%= render "shiplog/page_header", title: t("shiplog.changelog.title", default: "Changelog"), lede: nil %>
+  <article class="<%= shiplog_class(:announcement) %>">
+    <span class="<%= shiplog_class(:entry_category) %>"><%= t("shiplog.categories.announcement", default: "Monthly update") %></span>
+    <time class="<%= shiplog_class(:entry_date) %>" datetime="<%= @entry.released_on.beginning_of_month.strftime("%Y-%m") %>"><%= l(@entry.released_on, format: "%B %Y") %></time>
+    <h2 class="<%= shiplog_class(:announcement_title) %>"><%= @entry.display_title %></h2>
+    <div class="<%= shiplog_class(:announcement_body) %>"><%= Shiplog::Markdown.to_html(@entry.display_body, heading_offset: 1) %></div>
+  </article>
+  <% if Shiplog.newsletter? %>
+    <%= render "shiplog/newsletter/form", source: request.path %>
+  <% end %>
+  <%= link_to t("shiplog.announcements.back", default: "← Back to the changelog"), changelog_path(anchor: shiplog_month_anchor(@entry.released_on)), class: shiplog_class(:permalink_back) %>
+<% end %>

data/app/views/shiplog/changelogs/_month.html.erb

@@ -1,8 +1,15 @@
-<%# locals: (month:, entries:) %>
-<%# one month of the changelog (month is its first day) and its entries, newest first %>
+<%# locals: (month:, entries:, announcement: nil) %>
+<%# one month of the changelog (month is its first day) and its entries, newest first; a link to the month's
+    announcement under the heading when it has one (see shiplog_announcement_href) %>
 <% heading_id = "shiplog-month-#{month.strftime("%Y-%m")}" %>
+<% month_name = l(month, format: "%B %Y") %>
 <section class="<%= shiplog_class(:month) %>" aria-labelledby="<%= heading_id %>">
-  <h2 class="<%= shiplog_class(:month_title) %>" id="<%= heading_id %>"><%= l(month, format: "%B %Y") %></h2>
+  <h2 class="<%= shiplog_class(:month_title) %>" id="<%= heading_id %>"><%= month_name %></h2>
+  <% if announcement && (href = shiplog_announcement_href(announcement)) %>
+    <p class="<%= shiplog_class(:month_announcement) %>">
+      <%= link_to t("shiplog.announcements.read", month: month_name, default: "Read the %{month} summary"), href, class: shiplog_class(:month_announcement_link) %>
+    </p>
+  <% end %>
   <ul class="<%= shiplog_class(:entries) %>">
     <%= render partial: "shiplog/changelogs/entry", collection: entries, as: :entry %>
   </ul>

data/app/views/shiplog/changelogs/show.html.erb

@@ -17,13 +17,16 @@
   <% else %>
     <div class="<%= shiplog_class(:months) %>">
       <% @months.each do |month, entries| %>
-        <%= render "shiplog/changelogs/month", month:, entries: %>
+        <%= render "shiplog/changelogs/month", month:, entries:, announcement: @announcements[month] %>
       <% end %>
     </div>
   <% end %>
   <%= render "shiplog/pagination",
         newer_path: (changelog_path(area: @area&.slug, page: (@page - 1 if @page > 2), q: @query) if @page > 1),
         older_path: (changelog_path(area: @area&.slug, page: @page + 1, q: @query) if @older) %>
+  <% if Shiplog.newsletter? %>
+    <%= render "shiplog/newsletter/form", source: request.path %>
+  <% end %>
   <p class="<%= shiplog_class(:footnote) %>">
     <%= link_to t("shiplog.feed.subscribe", default: "Subscribe (Atom)"), changelog_feed_path, class: shiplog_class(:footnote_link, :feed) %>
   </p>

data/app/views/shiplog/newsletter/_form.html.erb

@@ -0,0 +1,25 @@
+<%# locals: (source: nil, email: nil, error: nil) %>
+<%# The subscribe form: one email field, a honeypot (bots fill it, people never see it), a plain POST that works
+    without JavaScript. No CSRF token on purpose: the pages carrying it are cached with ETags (see
+    Shiplog::Newsletter::SubscriptionsController). `source` is recorded as the page the visitor subscribed on. %>
+<% if Shiplog.newsletter? %>
+  <section class="<%= shiplog_class(:newsletter) %>" aria-labelledby="shiplog-newsletter-title">
+    <h2 class="<%= shiplog_class(:newsletter_title) %>" id="shiplog-newsletter-title"><%= t("shiplog.newsletter.form.title", default: "Get the monthly summary by email") %></h2>
+    <p class="<%= shiplog_class(:newsletter_hint) %>"><%= t("shiplog.newsletter.form.hint", default: "One email a month, no more. Unsubscribe any time.") %></p>
+    <% if error %>
+      <p class="<%= shiplog_class(:newsletter_notice, :error) %>" role="alert"><%= error %></p>
+    <% end %>
+    <%= form_with url: shiplog_newsletter_subscription_path, method: :post, authenticity_token: false, class: shiplog_class(:newsletter_form), data: { turbo: false } do |form| %>
+      <%= form.hidden_field :source, value: shiplog_newsletter_source(source) %>
+      <%# the honeypot: a name no browser autofills, out of the tab order and of autofill %>
+      <div class="shiplog-newsletter__trap" aria-hidden="true">
+        <%= form.label Shiplog::Newsletter::SubscriptionsController::HONEYPOT, t("shiplog.newsletter.form.trap_label", default: "Leave this field empty"), tabindex: -1 %>
+        <%= form.text_field Shiplog::Newsletter::SubscriptionsController::HONEYPOT, tabindex: -1, autocomplete: "off", "data-1p-ignore": "", "data-lpignore": "true" %>
+      </div>
+      <%= form.label :email, t("shiplog.newsletter.form.email_label", default: "Email address"), class: shiplog_class(:newsletter_label) %>
+      <%= form.email_field :email, value: email, required: true, autocomplete: "email", maxlength: Shiplog::NewsletterSubscriber::EMAIL_MAX_LENGTH,
+            placeholder: t("shiplog.newsletter.form.email_placeholder", default: "you@example.com"), class: shiplog_class(:newsletter_input) %>
+      <%= form.button t("shiplog.newsletter.form.submit", default: "Subscribe"), type: "submit", class: shiplog_class(:newsletter_button) %>
+    <% end %>
+  </section>
+<% end %>

data/app/views/shiplog/newsletter/_page.html.erb

@@ -0,0 +1,14 @@
+<%# locals: (heading:) %>
+<%# rendered with `render layout:`; a newsletter page: the changelog's page chrome, a heading and the block's text %>
+<% content_for :title, t("shiplog.newsletter.title", default: "Newsletter") %>
+<%= render layout: "shiplog/page", locals: { name: "newsletter" } do %>
+  <%= render "shiplog/page_header", title: t("shiplog.newsletter.title", default: "Newsletter"), lede: nil %>
+  <section class="<%= shiplog_class(:newsletter, :page) %>" aria-labelledby="shiplog-newsletter-heading">
+    <h2 class="<%= shiplog_class(:newsletter_title) %>" id="shiplog-newsletter-heading"><%= heading %></h2>
+    <% if notice.present? %><p class="<%= shiplog_class(:newsletter_notice) %>" role="status"><%= notice %></p><% end %>
+    <%= yield %>
+  </section>
+  <p class="<%= shiplog_class(:footnote) %>">
+    <%= link_to t("shiplog.newsletter.back", default: "← Back to the changelog"), changelog_path, class: shiplog_class(:footnote_link) %>
+  </p>
+<% end %>

data/app/views/shiplog/newsletter/confirmations/create.html.erb

@@ -0,0 +1,5 @@
+<%# Rendered by the confirming POST: subscribed, with the way to the preferences page %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.confirm.done_heading", default: "You're subscribed") } do %>
+  <p><%= t("shiplog.newsletter.confirm.done_text", email: @subscriber.email, default: "The monthly summary will arrive at %{email}. You can change the language or unsubscribe any time from your preferences.") %></p>
+  <p><%= link_to t("shiplog.newsletter.preferences.heading", default: "Your subscription"), newsletter_preferences_path(@subscriber.token), class: shiplog_class(:footnote_link) %></p>
+<% end %>

data/app/views/shiplog/newsletter/confirmations/show.html.erb

@@ -0,0 +1,5 @@
+<%# The confirmation link's page: a button that POSTs (a GET confirms nothing, link scanners prefetch) %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.confirm.heading", default: "Confirm your subscription") } do %>
+  <p><%= t("shiplog.newsletter.confirm.text", email: @subscriber.email, default: "Click the button to receive the monthly summary at %{email}.") %></p>
+  <%= button_to t("shiplog.newsletter.confirm.button", default: "Confirm"), newsletter_confirmation_path(params[:token]), method: :post, class: shiplog_class(:newsletter_button), form: { data: { turbo: false } } %>
+<% end %>

data/app/views/shiplog/newsletter/invalid.html.erb

@@ -0,0 +1,4 @@
+<%# A link that does not verify: tampered, expired, or its subscriber was deleted (status 404) %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.invalid.heading", default: "This link is not valid") } do %>
+  <p><%= t("shiplog.newsletter.invalid.text", default: "It may have expired or already been used. Subscribe again from the changelog to get a new one.") %></p>
+<% end %>

data/app/views/shiplog/newsletter/preferences/destroy.html.erb

@@ -0,0 +1,4 @@
+<%# Rendered by "Delete my data": the row is gone %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.preferences.deleted_heading", default: "Your data was deleted") } do %>
+  <p><%= t("shiplog.newsletter.preferences.deleted_text", default: "Your email address is no longer stored. You can subscribe again from the changelog at any time.") %></p>
+<% end %>

data/app/views/shiplog/newsletter/preferences/show.html.erb

@@ -0,0 +1,23 @@
+<%# A subscriber's preferences (reached through the footer's token): language, unsubscribe or resubscribe, delete %>
+<% path = newsletter_preferences_path(@subscriber.token) %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.preferences.heading", default: "Your subscription") } do %>
+  <p>
+    <%= t("shiplog.newsletter.preferences.email", default: "Email") %>: <strong><%= @subscriber.email %></strong><br>
+    <%= t("shiplog.newsletter.preferences.status", default: "Status") %>: <%= t("shiplog.newsletter.preferences.statuses.#{@subscriber.status}", default: @subscriber.status) %>
+  </p>
+  <%= form_with url: path, method: :patch, class: shiplog_class(:newsletter_form), data: { turbo: false } do |form| %>
+    <%= form.label :locale, t("shiplog.newsletter.preferences.language", default: "Language"), class: shiplog_class(:newsletter_label) %>
+    <%= form.select :locale, Shiplog::NewsletterSubscriber.allowed_locales.map { |locale| [ Shiplog::Translator.language_name(locale), locale ] },
+          { selected: @subscriber.locale }, class: shiplog_class(:newsletter_input) %>
+    <%= form.button t("shiplog.newsletter.preferences.save", default: "Save"), type: "submit", class: shiplog_class(:newsletter_button) %>
+  <% end %>
+  <div class="shiplog-newsletter__actions">
+    <% if @subscriber.unsubscribed? %>
+      <%= button_to t("shiplog.newsletter.preferences.resubscribe", default: "Resubscribe"), path, method: :patch, params: { subscribed: "1" }, class: shiplog_class(:newsletter_button), form: { data: { turbo: false } } %>
+    <% else %>
+      <%= button_to t("shiplog.newsletter.preferences.unsubscribe", default: "Unsubscribe"), path, method: :patch, params: { subscribed: "0" }, class: shiplog_class(:newsletter_button), form: { data: { turbo: false } } %>
+    <% end %>
+    <%= button_to t("shiplog.newsletter.preferences.delete", default: "Delete my data"), path, method: :delete, class: shiplog_class(:newsletter_button, :secondary), form: { data: { turbo: false } } %>
+  </div>
+  <p class="<%= shiplog_class(:newsletter_hint) %>"><%= t("shiplog.newsletter.preferences.delete_help", default: "Deleting your data removes your address from our records entirely, including the record that you unsubscribed.") %></p>
+<% end %>

data/app/views/shiplog/newsletter/rate_limited.html.erb

@@ -0,0 +1,4 @@
+<%# Too many subscribe attempts from one address or one IP (status 429) %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.rate_limited.heading", default: "Too many attempts") } do %>
+  <p><%= t("shiplog.newsletter.rate_limited.text", default: "Please try again in an hour.") %></p>
+<% end %>

data/app/views/shiplog/newsletter/subscriptions/show.html.erb

@@ -0,0 +1,16 @@
+<%# "Check your inbox" after the form, the same for every address; with @error (an address that is not an email),
+    the form again (status 422) %>
+<% if @error %>
+  <% content_for :title, t("shiplog.newsletter.title", default: "Newsletter") %>
+  <%= render layout: "shiplog/page", locals: { name: "newsletter" } do %>
+    <%= render "shiplog/page_header", title: t("shiplog.newsletter.title", default: "Newsletter"), lede: nil %>
+    <%= render "shiplog/newsletter/form", email: @email, error: @error, source: params[:source] %>
+    <p class="<%= shiplog_class(:footnote) %>">
+      <%= link_to t("shiplog.newsletter.back", default: "← Back to the changelog"), changelog_path, class: shiplog_class(:footnote_link) %>
+    </p>
+  <% end %>
+<% else %>
+  <%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.sent.heading", default: "Check your inbox") } do %>
+    <p><%= t("shiplog.newsletter.sent.text", default: "We sent you a link to confirm your subscription. Open it to start receiving the monthly summary. If nothing arrives within a few minutes, look in your spam folder.") %></p>
+  <% end %>
+<% end %>

data/app/views/shiplog/newsletter/unsubscriptions/create.html.erb

@@ -0,0 +1,4 @@
+<%# Rendered by the unsubscribing POST (the button, or a mail provider's one-click request) %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.unsubscribe.done_heading", default: "You're unsubscribed") } do %>
+  <p><%= t("shiplog.newsletter.unsubscribe.done_text", email: @email, default: "%{email} will not receive the monthly summary anymore.") %></p>
+<% end %>

data/app/views/shiplog/newsletter/unsubscriptions/show.html.erb

@@ -0,0 +1,5 @@
+<%# The unsubscribe link's page: a button that POSTs (a GET unsubscribes nobody, link scanners prefetch) %>
+<%= render layout: "shiplog/newsletter/page", locals: { heading: t("shiplog.newsletter.unsubscribe.heading", default: "Unsubscribe") } do %>
+  <p><%= t("shiplog.newsletter.unsubscribe.text", email: @email, default: "Stop receiving the monthly summary at %{email}?") %></p>
+  <%= button_to t("shiplog.newsletter.unsubscribe.button", default: "Unsubscribe"), newsletter_unsubscription_path(params[:token]), method: :post, class: shiplog_class(:newsletter_button), form: { data: { turbo: false } } %>
+<% end %>