bible270 0.17.1 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70091a35da0211de345d0a946f8fe25aea94c7656d7f9fb7b305aa63c6a1b7e6
-  data.tar.gz: 98e6db18fb16bdb784b7b2ad095b05860a43a81cb3111279f33b7285345bcbd0
+  metadata.gz: 9e3c27f2336f3e2a809205242bbc42c46d241e49b9ea2b1bf49ca288523d7c88
+  data.tar.gz: 8e8c25b59eafde481a17546ac14b563527dd591ca64d9cf7541d95a01dd1f36c
 SHA512:
-  metadata.gz: e03f11e9596c52e59413478a3c5c615ce5bc9f4289ecbed3a037906d51d70e515d56767d18324ba331dded40de502d0d6b7c741c603836d7e351d147375187df
-  data.tar.gz: f2496c1342b3be1625927fdbbecd333c1792d96c8c52742359bdfc9cb66e9de7ac0f3617b20b291ee081811e4d937a92e3dbbecc9c5ee29a3c3d0788db9f473a
+  metadata.gz: 06af092550c30ded960e3611301d941e10fdea25e79fcfcab8aa97c4d68fee7b3780961f22bc4f81be4ba3f065ebe57642386ba318c69f80e2f1bd1e07ce0dec
+  data.tar.gz: ed69c75af0e88e8dfeb347b756c6c10692f46b6e90196e96851aecc026a664752ce6f2fbb3de3b324734eff316555c229d19aa15270d26061b370b4db643f3ae

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks' # provides build / install / release
 require 'rake/testtask'
+require 'coveralls/rake/task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test' << 'lib'
@@ -9,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.warning = false
 end
 
+Coveralls::RakeTask.new
+
 task default: :test

data/app/controllers/bible270/admin_controller.rb

@@ -8,6 +8,9 @@ module Bible270
   # neither set the panel is unreachable, and every action 404s rather than 403s
   # so its existence isn't advertised.
   class AdminController < ApplicationController
+    LAST_BROADCAST_AT = 'last_broadcast_at'
+    LAST_BROADCAST_SUBJECT = 'last_broadcast_subject'
+
     before_action :require_admin!
     before_action :load_reader,
                   only: %i[show destroy update_start update_profile remove_avatar complete_through toggle_day]
@@ -32,6 +35,9 @@ module Bible270
       counts = Checkoff.group(:reader_id, :day).count
       @days_completed = Hash.new(0)
       counts.each { |(rid, day), n| @days_completed[rid] += 1 if n >= Plan.total_parts(day) }
+      @reachable = Reader.where.not(email: [nil, '']).count
+      @last_broadcast_at = parsed_time(Setting.read(LAST_BROADCAST_AT))
+      @last_broadcast_subject = Setting.read(LAST_BROADCAST_SUBJECT)
     end
 
     def show
@@ -75,6 +81,47 @@ module Bible270
     end
 
     # Put the reader on a given day as of today, or set an explicit start date.
+    def broadcast
+      subject = params[:subject].to_s.strip
+      body = params[:body].to_s.strip
+
+      if subject.empty? || body.empty?
+        return redirect_to(admin_path, alert: 'A message needs both a subject and something to say.')
+      end
+
+      recipients = Reader.where.not(email: [nil, '']).order(:id)
+      return redirect_to(admin_path, alert: 'Nobody has an email address.') if recipients.empty?
+
+      sent = deliver_broadcast(recipients, subject, body)
+      Setting.write(LAST_BROADCAST_AT, Time.current.iso8601)
+      Setting.write(LAST_BROADCAST_SUBJECT, subject)
+
+      redirect_to admin_path,
+                  notice: "Sent to #{sent} #{'reader'.pluralize(sent)}."
+    end
+
+    def update_bible_version
+      reader = Reader.find_by(id: params[:id])
+      return redirect_to(admin_path, alert: 'No such reader.') if reader.nil?
+
+      code = params[:bible_version].to_s
+      # Blank means "no preference": the reader follows the site default, which is
+      # not the same as choosing whichever translation the site happens to use now.
+      if code.empty?
+        reader.update(bible_version: nil)
+        return redirect_to admin_reader_path(reader),
+                           notice: "#{reader.display_name} now follows the site default " \
+                                   "(#{Bible270.config.bible_version})."
+      end
+
+      if reader.update_bible_version(code)
+        redirect_to admin_reader_path(reader),
+                    notice: "#{reader.display_name} now reads the #{reader.bible_version_label}."
+      else
+        redirect_to admin_reader_path(reader), alert: 'That is not a translation on the list.'
+      end
+    end
+
     def update_start
       if params[:start_date].present?
         # set_start_date!, not update_start_date!: an admin is not subject to
@@ -138,6 +185,33 @@ module Bible270
       end
     end
 
+    # Failures are counted rather than raised: one bad address must not stop the
+    # rest of the message going out, and the admin is told how many were sent.
+    # A stored timestamp that cannot be read is treated as absent rather than
+    # blowing up the admin page.
+    def parsed_time(value)
+      return nil if value.blank?
+
+      Time.parse(value.to_s)
+    rescue ArgumentError, TypeError
+      nil
+    end
+
+    def deliver_broadcast(recipients, subject, body)
+      later = Bible270.config.registration_notice_deliver_later
+      sent = 0
+
+      recipients.find_each do |reader|
+        mail = NoticeMailer.broadcast(reader_id: reader.id, subject: subject, body: body)
+        later ? mail.deliver_later : mail.deliver_now
+        sent += 1
+      rescue StandardError => e
+        Rails.logger.error("[bible270] broadcast to reader #{reader.id} failed: #{e.class}: #{e.message}")
+      end
+
+      sent
+    end
+
   private
 
     def require_admin!

data/app/controllers/bible270/sessions_controller.rb

@@ -36,7 +36,9 @@ module Bible270
       remember_reader!(reader)
       @current_reader = reader
 
-      redirect_to destination, notice: "Welcome #{reader.first_name}."
+      # first_name is filled in for every route now, but a bridged host user may
+      # still arrive without one.
+      redirect_to destination, notice: "Welcome #{reader.first_name.presence || reader.display_name}."
     end
 
     def destroy

data/app/mailers/bible270/broadcast.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <body style="margin:0;padding:24px;background:#ece6da;font-family:-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif;color:#231f18">
+    <div style="max-width:520px;margin:0 auto;background:#f4efe6;border:1px solid #d7cfbf;border-radius:14px;padding:28px">
+      <p style="margin:0 0 16px;font-size:15px">
+        <%= @reader.first_name.presence || @reader.display_name %>,
+      </p>
+
+      <div style="font-size:15px;line-height:1.6"><%= simple_format(@body) %></div>
+
+      <p style="margin:24px 0 0;padding-top:16px;border-top:1px solid #d7cfbf;font-size:12px;color:#9a9082">
+        <%= @app_name %><% if @plan_url %> ·
+        <a href="<%= @plan_url %>" style="color:#a5812c"><%= @plan_url %></a><% end %>
+      </p>
+    </div>
+  </body>
+</html>

data/app/mailers/bible270/broadcast.text.erb

@@ -0,0 +1,7 @@
+<%= @reader.first_name.presence || @reader.display_name %>,
+
+<%= @body %>
+
+--
+<%= @app_name %><% if @plan_url %>
+<%= @plan_url %><% end %>

data/app/mailers/bible270/notice_mailer.rb

@@ -31,6 +31,22 @@ module Bible270
            subject: "#{@app_name}: #{@author.display_name} mentioned you on day #{@comment.day}"
     end
 
+    # A message from whoever runs the plan to one reader. Sent individually rather
+    # than as one email with everyone in bcc: a bcc list of a hundred addresses is
+    # a spam signal, and it means nobody can be greeted by name or unsubscribe
+    # meaningfully.
+    def broadcast(reader_id:, subject:, body:)
+      @reader = Reader.find_by(id: reader_id)
+      return message.perform_deliveries = false if @reader.nil? || @reader.email.blank?
+      return message.perform_deliveries = false if subject.to_s.strip.empty? || body.to_s.strip.empty?
+
+      @body = body.to_s
+      @app_name = Bible270.config.app_name
+      @plan_url = plan_url
+
+      mail to: @reader.email, subject: subject.to_s.strip
+    end
+
   private
 
     # A mailer has no request, so the host is config.mailer_host or nothing. No
@@ -41,6 +57,10 @@ module Bible270
     # config.mount_at was worse than useless — ignored when blank, and overriding
     # the true prefix when not, so a config that disagreed with routes.rb would
     # have produced links to nowhere.
+    def plan_url
+      engine_url(:root_url)
+    end
+
     def day_url_for(day)
       engine_url(:day_url, day)
     end

data/app/models/bible270/reader.rb

@@ -45,10 +45,37 @@ module Bible270
       image = first_present(dig_auth(info, :image), dig_auth(info, :avatar_url))
       reader.email      = email if email.present?
       reader.avatar_url = image if image.present?
+      assign_names_from(reader, info)
       reader.save
       reader
     end
 
+    # Providers hand back one display name far more often than two fields, so the
+    # name is split when they do not. Without this an OmniAuth reader had no
+    # first_name — which made the greeting read "Welcome ." and, more seriously,
+    # made them unmentionable: Reader.mentioned_in only considers readers who have
+    # one.
+    #
+    # Only filled in when empty, so a reader who has since corrected their name on
+    # their profile does not have it overwritten at every sign-in.
+    def self.assign_names_from(reader, info)
+      return if reader.first_name.present?
+
+      given = dig_auth(info, :first_name)
+      family = dig_auth(info, :last_name)
+
+      if given.present?
+        reader.first_name = given
+        reader.last_name = family
+        return
+      end
+
+      split = Names.split_display_name(reader.display_name)
+      reader.first_name = split ? split[:first_name] : reader.display_name.to_s.split.first
+      reader.last_name = split ? split[:last_name] : nil
+    end
+    private_class_method :assign_names_from
+
     # Find or create the reader behind a verified email address. Uses the same
     # provider/uid identity columns as OmniAuth, with provider "email", so an
     # email reader is indistinguishable from any other downstream.

data/app/views/bible270/admin/index.html.erb

@@ -47,4 +47,31 @@
   <p style="color:var(--faint)">No readers yet.</p>
 <% end %>
 
+<div class="b270-panel">
+  <h2 class="b270-subhead">Write to everyone</h2>
+
+  <% if @reachable.zero? %>
+    <p class="b270-hint" style="margin-top:0">No reader has an email address yet.</p>
+  <% else %>
+    <p class="b270-hint" style="margin-top:0">
+      Goes to <strong><%= @reachable %></strong>
+      <%= @reachable == 1 ? 'reader' : 'readers' %> individually, not as one message with
+      everyone in bcc — so each is greeted by name.
+      <% if @last_broadcast_at.present? %>
+        <br>Last sent <%= b270_datetime(@last_broadcast_at) %><%
+          %><% if @last_broadcast_subject.present? %>: <em><%= @last_broadcast_subject %></em><% end %>.
+      <% end %>
+    </p>
+
+    <%= form_with url: admin_broadcast_path, method: :post, class: "b270-form",
+          data: { turbo_confirm: "Send this to #{@reachable} #{@reachable == 1 ? 'reader' : 'readers'}?" } do %>
+      <%= text_field_tag :subject, params[:subject], placeholder: "Subject", class: "b270-input" %>
+      <%= text_area_tag :body, params[:body], placeholder: "What would you like to say?", rows: 6 %>
+      <div class="row">
+        <%= submit_tag "Send", class: "b270-btn" %>
+      </div>
+    <% end %>
+  <% end %>
+</div>
+
 <p style="margin-top:18px"><%= link_to '← Back to the plan', root_path %></p>

data/app/views/bible270/admin/show.html.erb

@@ -92,6 +92,28 @@
   <%= render "bible270/shared/reflections", comments: @comments, moderate: true %>
 </div>
 
+<div class="b270-panel">
+  <h2 class="b270-subhead">Which translation they read</h2>
+  <p class="b270-hint" style="margin-top:0">
+    Reading links open in this translation.
+    <% if @reader.bible_version.blank? %>
+      They have expressed no preference, so they follow the site default
+      (<%= Bible270.config.bible_version %>).
+    <% end %>
+  </p>
+
+  <%= form_with url: admin_reader_version_path(@reader), method: :patch, class: "b270-form" do %>
+    <div class="row">
+      <%= select_tag :bible_version,
+            options_for_select([["Site default (#{Bible270.config.bible_version})", ""]] +
+                               Bible270::Translations.options,
+                               @reader.bible_version.to_s),
+            class: "b270-select", style: "width:auto" %>
+      <%= submit_tag "Save", class: "b270-btn" %>
+    </div>
+  <% end %>
+</div>
+
 <div class="b270-panel">
   <h2 class="b270-subhead">Remove</h2>
   <p class="b270-hint" style="margin-top:0">Deletes the reader together with every check-off and

data/app/views/bible270/notice_mailer/broadcast.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <body style="margin:0;padding:24px;background:#ece6da;font-family:-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif;color:#231f18">
+    <div style="max-width:520px;margin:0 auto;background:#f4efe6;border:1px solid #d7cfbf;border-radius:14px;padding:28px">
+      <p style="margin:0 0 16px;font-size:15px">
+        <%= @reader.first_name.presence || @reader.display_name %>,
+      </p>
+
+      <div style="font-size:15px;line-height:1.6"><%= simple_format(@body) %></div>
+
+      <p style="margin:24px 0 0;padding-top:16px;border-top:1px solid #d7cfbf;font-size:12px;color:#9a9082">
+        <%= @app_name %><% if @plan_url %> ·
+        <a href="<%= @plan_url %>" style="color:#a5812c"><%= @plan_url %></a><% end %>
+      </p>
+    </div>
+  </body>
+</html>

data/app/views/bible270/notice_mailer/broadcast.text.erb

@@ -0,0 +1,7 @@
+<%= @reader.first_name.presence || @reader.display_name %>,
+
+<%= @body %>
+
+--
+<%= @app_name %><% if @plan_url %>
+<%= @plan_url %><% end %>

data/app/views/bible270/shared/_styles.html.erb

@@ -183,6 +183,7 @@
   .b270-comment.b270-editing{background:rgba(165,129,44,.05);border-radius:10px;padding:12px}
   .b270-editing textarea{min-height:64px}
   .b270-cdel{font-size:12px;color:var(--oxblood);background:none;border:none;cursor:pointer;padding:0;margin-left:8px}
+  .b270-input{width:100%;padding:9px 11px;border:1px solid var(--line);border-radius:9px;background:#fff;font:inherit;font-size:14px;margin-bottom:8px}
   .b270-form textarea{width:100%;font:inherit;font-size:15px;border:1px solid var(--line);border-radius:10px;padding:11px 13px;background:#fff;resize:vertical;min-height:76px}
   .b270-form .row{display:flex;align-items:center;gap:10px;margin-top:10px}
   .b270 .b270-btn{border:none;border-radius:10px;padding:8px 16px;margin-top:4px;font:inherit;font-weight:600;font-size:14px;cursor:pointer;background:var(--ink);color:var(--paper);text-decoration:none;display:inline-block}

data/config/routes.rb

@@ -22,10 +22,12 @@ Bible270::Engine.routes.draw do
   delete 'admin/readers/:id',            to: 'admin#destroy'
   patch  'admin/readers/:id/profile',    to: 'admin#update_profile',   as: :admin_reader_profile
   delete 'admin/readers/:id/avatar',     to: 'admin#remove_avatar',    as: :admin_reader_avatar
+  patch  'admin/readers/:id/version',    to: 'admin#update_bible_version', as: :admin_reader_version
   patch  'admin/readers/:id/start',      to: 'admin#update_start',     as: :admin_reader_start
   patch  'admin/readers/:id/through',    to: 'admin#complete_through', as: :admin_reader_through
   post   'admin/readers/:id/days/:day',  to: 'admin#toggle_day',       as: :admin_reader_day
 
+  post   'admin/broadcast',              to: 'admin#broadcast',        as: :admin_broadcast
   patch  'admin/enrollment',             to: 'admin#update_enrollment', as: :admin_enrollment
   get    'admin/comments',               to: 'admin#comments',         as: :admin_comments
   patch  'admin/comments/:id/hide',      to: 'admin#hide_comment',     as: :admin_hide_comment

data/lib/bible270/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bible270
-  VERSION = '0.17.1'
+  VERSION = '0.17.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bible270
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.17.2
 platform: ruby
 authors:
 - Andrew vonderLuft
@@ -91,6 +91,8 @@ files:
 - app/controllers/bible270/sessions_controller.rb
 - app/helpers/bible270/plan_helper.rb
 - app/mailers/bible270/application_mailer.rb
+- app/mailers/bible270/broadcast.html.erb
+- app/mailers/bible270/broadcast.text.erb
 - app/mailers/bible270/notice_mailer.rb
 - app/mailers/bible270/sign_in_mailer.rb
 - app/models/bible270/application_record.rb
@@ -119,6 +121,8 @@ files:
 - app/views/bible270/days/show.html.erb
 - app/views/bible270/likes/_likes.html.erb
 - app/views/bible270/likes/toggle.turbo_stream.erb
+- app/views/bible270/notice_mailer/broadcast.html.erb
+- app/views/bible270/notice_mailer/broadcast.text.erb
 - app/views/bible270/notice_mailer/mentioned.html.erb
 - app/views/bible270/notice_mailer/mentioned.text.erb
 - app/views/bible270/notice_mailer/new_reader.html.erb