bible270 0.9.0 → 0.11.0

data/app/controllers/bible270/days_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   class DaysController < ApplicationController
     def index
@@ -19,9 +20,7 @@ module Bible270
 
     def show
       @day = params[:day].to_i
-      unless Plan.valid_day?(@day)
-        redirect_to(root_path, alert: "That day is outside the plan.") and return
-      end
+      redirect_to(root_path, alert: 'That day is outside the plan.') and return unless Plan.valid_day?(@day)
 
       @readings   = Plan.readings_for(@day)
       @comments   = Comment.for_day(@day).includes(:reader)
@@ -30,9 +29,9 @@ module Bible270
 
       req = Plan.required_track_count(@day)
       completer_ids = Checkoff.where(day: @day)
-                              .group(:reader_id)
-                              .having("COUNT(*) >= ?", req)
-                              .pluck(:reader_id)
+        .group(:reader_id)
+        .having('COUNT(*) >= ?', req)
+        .pluck(:reader_id)
       @completers = Reader.where(id: completer_ids).order(:display_name)
 
       @prev_day = @day > 1 ? @day - 1 : nil

data/app/controllers/bible270/profiles_controller.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Bible270
+  # A reader editing their own name — the one thing about themselves they can
+  # change. Everything else about a reader comes from how they signed in.
+  class ProfilesController < ApplicationController
+    before_action :require_signed_in_reader
+
+    def edit
+      @names = current_reader.suggested_names
+    end
+
+    def update
+      problems = []
+      problems << 'both a first and last name' unless current_reader.update_names(params[:first_name],
+                                                                                  params[:last_name])
+      if params[:avatar].present? && !current_reader.attach_avatar(params[:avatar])
+        problems << (current_reader.errors[:avatar].first || 'a valid image')
+      end
+
+      if problems.empty?
+        redirect_to reader_path(current_reader), notice: 'Your profile has been updated.'
+      else
+        @names = { first_name: params[:first_name], last_name: params[:last_name] }
+        flash.now[:alert] = "Please give #{problems.to_sentence}."
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    def remove_avatar
+      current_reader.remove_avatar!
+      redirect_to profile_path, notice: 'Your picture has been removed.'
+    end
+
+  private
+
+    # Unlike checking off a reading, there is nothing sensible to do here for a
+    # visitor who isn't signed in, so send them to sign in rather than 404.
+    def require_signed_in_reader
+      return if signed_in?
+
+      redirect_to sign_in_path(origin: request.fullpath), alert: 'Please sign in first.'
+    end
+  end
+end

data/app/controllers/bible270/readers_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   class ReadersController < ApplicationController
     def index
@@ -11,7 +12,7 @@ module Bible270
 
     def show
       @reader = Reader.find_by(id: params[:id])
-      redirect_to(community_path, alert: "Reader not found.") and return unless @reader
+      redirect_to(community_path, alert: 'Reader not found.') and return unless @reader
 
       @days_completed = @reader.days_completed
       @recent_comments = @reader.comments.recent.limit(20)
@@ -21,7 +22,7 @@ module Bible270
       return unless require_reader!
 
       unless Bible270.config.allow_reader_start_date
-        redirect_to(root_path, alert: "The start date is set for the whole community.") and return
+        redirect_to(root_path, alert: 'The start date is set for the whole community.') and return
       end
 
       if current_reader.update_start_date!(params[:start_date])
@@ -37,9 +38,9 @@ module Bible270
 
       if Bible270.config.allow_reader_start_date
         current_reader.clear_start_date!
-        redirect_to root_path, notice: "Start date cleared — the plan is now undated for you."
+        redirect_to root_path, notice: 'Start date cleared — the plan is now undated for you.'
       else
-        redirect_to root_path, alert: "The start date is set for the whole community."
+        redirect_to root_path, alert: 'The start date is set for the whole community.'
       end
     end
   end

data/app/controllers/bible270/sessions_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   # Built-in OmniAuth sign-in.
   #
@@ -17,17 +18,17 @@ module Bible270
     end
 
     def create
-      auth = request.env["omniauth.auth"]
-      unless auth
-        redirect_to(sign_in_path, alert: "Sign in didn't complete. Please try again.") and return
+      auth = request.env['omniauth.auth']
+      redirect_to(sign_in_path, alert: "Sign in didn't complete. Please try again.") and return unless auth
+
+      if enrollment_closed? && !Reader.omniauth_reader_exists?(auth['provider'], auth['uid'])
+        redirect_to(sign_in_path, alert: enrollment_closed_message) and return
       end
 
       reader = Reader.from_omniauth(auth)
-      unless reader&.persisted?
-        redirect_to(sign_in_path, alert: "We couldn't set up your reader profile.") and return
-      end
+      redirect_to(sign_in_path, alert: "We couldn't set up your reader profile.") and return unless reader&.persisted?
 
-      destination = safe_origin(request.env["omniauth.origin"]) || after_sign_in_path
+      destination = safe_origin(request.env['omniauth.origin']) || after_sign_in_path
 
       # Rotate the session id to avoid session fixation, then sign in.
       reset_session
@@ -40,11 +41,11 @@ module Bible270
     def destroy
       reset_session
       @current_reader = nil
-      redirect_to(after_sign_out_path, notice: "Signed out.")
+      redirect_to(after_sign_out_path, notice: 'Signed out.')
     end
 
     def failure
-      message = params[:message].presence || "unknown error"
+      message = params[:message].presence || 'unknown error'
       redirect_to sign_in_path, alert: "Sign in failed (#{message.to_s.tr('_', ' ')})."
     end
 
@@ -63,14 +64,23 @@ module Bible270
                     alert: "That doesn't look like an email address — please check and try again.") and return
       end
 
-      name = Bible270.config.email_sign_in_ask_name ? params[:display_name].to_s.strip : nil
-      _record, raw = SignInToken.issue!(address, display_name: name)
-
-      if raw
-        url = email_sign_in_url(token: raw, origin: origin)
-        minutes = (Bible270.config.email_sign_in_ttl / 60.0).round
-        mail = SignInMailer.magic_link(email: address, url: url, expires_in_minutes: minutes)
-        Bible270.config.email_sign_in_deliver_later ? mail.deliver_later : mail.deliver_now
+      # Names are optional here. Requiring them only for unknown addresses would
+      # make the response differ, which tells a stranger whether an address
+      # already has an account. A new reader is asked for their name after they
+      # click the link instead (see email_callback).
+      names = Names.normalize(params[:first_name], params[:last_name])
+
+      _record, raw = SignInToken.issue!(address, first_name: names&.dig(:first_name),
+                                                last_name: names&.dig(:last_name))
+
+      if raw && enrollment_closed? && !Reader.email_reader_exists?(address)
+        Rails.logger.info("[bible270] enrolment closed; no link sent to #{address}")
+      elsif raw
+        deliver_sign_in_link(address, email_sign_in_url(token: raw, origin: origin))
+      else
+        # Silent to the reader by design; say so in the log or this is undebuggable.
+        Rails.logger.warn("[bible270] no sign-in link issued for #{address} " \
+                          '(rate limited — see config.email_sign_in_max_per_window)')
       end
 
       # Deliberately identical whether or not a link was actually sent, so this
@@ -84,33 +94,86 @@ module Bible270
       token = SignInToken.claim!(params[:token])
       if token.nil?
         redirect_to(sign_in_path,
-                    alert: "That link has expired or was already used. Please request a new one.") and return
+                    alert: 'That link has expired or was already used. Please request a new one.') and return
       end
 
-      reader = Reader.from_email(token.email, display_name: token.display_name)
-      unless reader&.persisted?
-        redirect_to(sign_in_path, alert: "We couldn't set up your reader profile.") and return
+      if enrollment_closed? && !Reader.email_reader_exists?(token.email)
+        redirect_to(sign_in_path, alert: enrollment_closed_message) and return
       end
 
+      reader = Reader.from_email(token.email, first_name: token.first_name,
+                                 last_name: token.last_name, display_name: token.display_name)
+      redirect_to(sign_in_path, alert: "We couldn't set up your reader profile.") and return unless reader&.persisted?
+
       destination = safe_origin(params[:origin]) || after_sign_in_path
 
       reset_session
       session[:bible270_reader_id] = reader.id
       @current_reader = reader
 
+      if name_needed?(reader)
+        redirect_to(profile_path,
+                    notice: 'Welcome. Please add your name, so others know who they are reading with.')
+        return
+      end
+
       redirect_to destination, notice: "Welcome, #{reader.display_name}."
     end
 
-    private
+  private
+
+    # Delivery problems must not leak through the UI (the response is deliberately
+    # identical either way), so they are logged rather than raised. Without this a
+    # misconfigured mailer either 500s the request or fails silently, depending on
+    # config.action_mailer.raise_delivery_errors.
+    def deliver_sign_in_link(address, url)
+      minutes = (Bible270.config.email_sign_in_ttl / 60.0).round
+      mail = SignInMailer.magic_link(email: address, url: url, expires_in_minutes: minutes)
+      Bible270.config.email_sign_in_deliver_later ? mail.deliver_later : mail.deliver_now
+      Rails.logger.info("[bible270] sign-in email handed to Action Mailer for #{address}")
+    rescue StandardError => e
+      Rails.logger.error("[bible270] could not deliver the sign-in email to #{address}: #{e.class}: #{e.message}")
+    ensure
+      log_sign_in_link(address, url)
+    end
+
+    # In development and test, put the link in the log so you can sign in without
+    # working mail delivery. Never in production — the link is a bearer token.
+    def log_sign_in_link(address, url)
+      return unless log_sign_in_link?
+
+      Rails.logger.info("[bible270] sign-in link for #{address}: #{url}")
+    end
+
+    def log_sign_in_link?
+      flag = Bible270.config.email_sign_in_log_link
+      return flag unless flag.nil?
+
+      Rails.env.development? || Rails.env.test?
+    end
+
+    # A reader who signed in by email and still has no first/last name. Applies
+    # only to email sign-in: an OmniAuth reader carries whatever name their
+    # provider gave.
+    def name_needed?(reader)
+      Bible270.config.email_sign_in_require_name &&
+        reader.provider == 'email' &&
+        reader.full_name.nil?
+    end
+
+    def enrollment_closed_message
+      'This run of the plan is closed to new readers. If you have taken part before, ' \
+        'sign in with the same email or account.'
+    end
 
     # Only ever redirect within this app, and never back into an auth route.
     def safe_origin(value)
       value = value.to_s
       return nil if value.empty?
-      return nil unless value.start_with?("/")
-      return nil if value.include?("//")   # protocol-relative URL
-      return nil if value.include?("\\")   # browsers may normalise \ to /
-      return nil if value.include?("/auth/")
+      return nil unless value.start_with?('/')
+      return nil if value.include?('//')   # protocol-relative URL
+      return nil if value.include?('\\')   # browsers may normalise \ to /
+      return nil if value.include?('/auth/')
 
       value
     end

data/app/helpers/bible270/plan_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   module PlanHelper
     def b270_track(track)
@@ -18,27 +19,36 @@ module Bible270
     end
 
     def b270_passage_url(reference)
-      return "#" if reference.blank?
+      return '#' if reference.blank?
+
       Bible270.config.passage_url_builder.call(reference, Bible270.config.bible_version)
     end
 
+    # An uploaded avatar wins over whatever the sign-in provider gave us.
+    # Active Storage routes live in the host app, hence main_app.
+    def b270_avatar_src(reader)
+      return main_app.rails_blob_path(reader.avatar, only_path: true) if reader.avatar_uploaded?
+
+      reader.avatar_url.presence
+    end
+
     def b270_avatar(reader, size: 34)
-      if reader.avatar_url.present?
-        image_tag reader.avatar_url, class: "b270-avatar", width: size, height: size, alt: reader.display_name
+      src = b270_avatar_src(reader)
+      if src
+        image_tag src, class: 'b270-avatar', width: size, height: size, alt: reader.display_name
       else
-        content_tag :span, reader.initials, class: "b270-avatar b270-avatar-fallback",
-                    style: "width:#{size}px;height:#{size}px;line-height:#{size}px"
+        content_tag :span, reader.initials, class: 'b270-avatar b270-avatar-fallback',
+                                            style: "width:#{size}px;height:#{size}px;line-height:#{size}px"
       end
     end
 
     def b270_day_status_class(reader, day)
-      return "" unless reader
-      if reader.day_complete?(day)
-        "complete"
-      elsif reader.read_tracks_for(day).any?
-        "partial"
-      else
-        ""
+      return '' unless reader
+
+      case reader.day_status(day)
+      when :complete then 'complete'
+      when :partial  then 'partial'
+      else ''
       end
     end
   end

data/app/mailers/bible270/application_mailer.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+
 module Bible270
   class ApplicationMailer < ActionMailer::Base
     default from: -> { Bible270.config.mailer_from }
-    layout nil
+    # `layout nil` means "normal lookup", which finds the host app's mailer layout and
+    # nests our complete HTML document inside theirs. Only `false` disables it.
+    layout false
   end
 end

data/app/mailers/bible270/sign_in_mailer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   class SignInMailer < ApplicationMailer
     # The URL is built by the controller (which has the request context), so the

data/app/models/bible270/application_record.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/app/models/bible270/checkoff.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
+
 module Bible270
   # A single reader marking one track (ot / nt / pp) read on one day.
   class Checkoff < ApplicationRecord
-    self.table_name = "bible270_checkoffs"
+    self.table_name = 'bible270_checkoffs'
 
-    belongs_to :reader, class_name: "Bible270::Reader"
+    belongs_to :reader, class_name: 'Bible270::Reader'
 
     validates :day, inclusion: { in: 1..Plan::DAYS }
     validates :track, inclusion: { in: Plan::TRACKS.keys }
     validates :track, uniqueness: { scope: %i[reader_id day] }
     validate  :track_present_on_day
 
-    private
+  private
 
     def track_present_on_day
       return if day.nil? || track.nil?

data/app/models/bible270/comment.rb

@@ -1,16 +1,37 @@
 # frozen_string_literal: true
+
 module Bible270
   # A publicly visible reflection attached to a plan day (optionally a track).
   class Comment < ApplicationRecord
-    self.table_name = "bible270_comments"
+    self.table_name = 'bible270_comments'
 
-    belongs_to :reader, class_name: "Bible270::Reader"
+    belongs_to :reader, class_name: 'Bible270::Reader'
 
     validates :day, inclusion: { in: 1..Plan::DAYS }
     validates :body, presence: true, length: { maximum: 4000 }
-    validates :track, inclusion: { in: Plan::TRACKS.keys }, allow_nil: true
+    # A reflection can be about one track or about the whole day. The form's
+    # "The whole day" option submits an empty string, so normalise it to NULL
+    # before validating — allow_nil alone rejects "" with
+    # "Track is not included in the list".
+    before_validation :normalize_track
+
+    validates :track, inclusion: { in: Plan::TRACKS.keys }, allow_blank: true
+
+    scope :approved, -> { where(approved: true) }
+    scope :hidden,   -> { where(approved: false) }
+    scope :for_day,  ->(d) { approved.where(day: d).order(created_at: :asc) }
+    scope :recent,   -> { approved.order(created_at: :desc) }
+
+    # Every reflection is visible when written; these are the moderation actions.
+    def hide!    = update!(approved: false, moderated_at: Time.current)
+    def unhide!  = update!(approved: true,  moderated_at: Time.current)
+    def hidden?  = !approved
+    def moderated? = moderated_at.present?
+
+  private
 
-    scope :for_day, ->(d) { where(day: d).order(created_at: :asc) }
-    scope :recent,  -> { order(created_at: :desc) }
+    def normalize_track
+      self.track = Plan.normalize_track(track)
+    end
   end
 end