bible270 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1371e2f082f0d627cd177afcb78aef1f9b396b76c307a4b901e66a3e4ce16f56
-  data.tar.gz: 380d7774095d789cb125baa69fa72a7ee34d4c888a399c444415ed2a3da71446
+  metadata.gz: 54e58fbb0af2af30cb7cdfd8f47c2d57526d464ece9c987365cec2dcb2331d43
+  data.tar.gz: b508bbb3ea2cd450cade1173173c680a4fcb34ad41fd3a498bef32cb2b2d9fe5
 SHA512:
-  metadata.gz: 8da758eedfe495574fccd33037c18233c3b1f58fdb0515799dce22573bbf3f0d7023bfd3387087efc0f5af9783073681278e76d620a3925546b917957c5ad1b6
-  data.tar.gz: f8533f349e9571a7fbd37a991cc592823be96d42764fdc69ece284bfc3ee35368f6f8678e7325beb69377eb588af7532aeae7c2958cbb8f5c11d1497265777dc
+  metadata.gz: b7880113db1ceb742f5857e004279ce00674b2adb385f2b3ebfaa16a5eaf910c31f2d452e29db91211f77d622d207a3bff3df64091c1d3b7908a4de93f72674c
+  data.tar.gz: a7b080c48d3072eab3554ac4fe4696bf2d8bd0ad69ef202fb7248c134a2b8685597d950222e72b80ba15f7c9449f8007c45bf1f9ec99be38d0228007ddfa23bb

data/CHANGELOG.md

@@ -6,11 +6,52 @@ All notable changes to bible270. Format follows [Keep a Changelog](https://keepa
 
 See the changes since the last release:
 
-**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.12.0...main)**
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.14.0...main)**
+
+
+## [0.14.0] - 2026-07-30
+
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.13.1...v0.14.0)**
+
+### Added
+
+- **Registration notices.** `config.registration_notice_emails` takes an explicit list or `:admins`
+  (following `admin_emails`); off unless set. The notice names the reader, their email, how they
+  signed in, when they joined and the running total, and links to their admin page when
+  `config.mailer_host` is set. Hooked to reader creation rather than to a controller, so email
+  sign-in, OmniAuth and bridged host users are all covered. Failures are logged, never raised —
+  nobody is blocked from joining by an SMTP problem. `registration_notice_deliver_later` moves
+  delivery off the request.
+
+### Fixed
+
+- The installer's `bible270.rb` template was missing its closing `end`, so `generate bible270:install`
+  wrote an initializer that crashed the host app on boot. A test now renders every generator template
+  and compiles the result, across three mount points.
+
+## [0.13.1] — 2026-07-29
+
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.13.0...v0.13.1)**
+
+Nothing consequential.
+
+## [0.13.0] — 2026-07-29
+
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.12.0...v0.13.0)**
+
+### Added
+
+- favicon support
+- admin ability to update any user's profile, including avatar
+- custom footer options, to replace standard footer, or append to it
+
+### Fixed
+
+- Correct verb for reading prompt: 'Start' and 'Continue
 
 ## [0.12.0] — 2026-07-29
 
-**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.11.0...v0.12.0)** 
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.11.0...v0.12.0)**
 
 ### Added
 
@@ -249,6 +290,8 @@ This is the initial public release.
 
 * Email sign-in requires working Action Mailer delivery in the host application. Set `config.mailer_from`; delivery is inline by default, or set `email_sign_in_deliver_later` when a queue backend is available.
 
+[0.13.1]: https://github.com/avonderluft/bible270/releases/tag/v0.13.1
+[0.13.0]: https://github.com/avonderluft/bible270/releases/tag/v0.13.0
 [0.12.0]: https://github.com/avonderluft/bible270/releases/tag/v0.12.0
 [0.11.0]: https://github.com/avonderluft/bible270/releases/tag/v0.11.0
 [0.10.0]: https://github.com/avonderluft/bible270/releases/tag/v0.10.0

data/README.md

@@ -49,9 +49,10 @@ That's the whole install. The generator is interactive and walks you through it:
 
 1. asks where to mount the plan;
 2. asks which sign-in methods you want — email link, OmniAuth, or both — and adds any OmniAuth strategy gems to your `Gemfile`;
-3. copies the four migrations into your `db/migrate` and offers to run them;
-4. writes `config/initializers/bible270.rb` (and `omniauth.rb` if you chose social sign-in); and
-5. adds `mount Bible270::Engine, at: Bible270.config.mount_at` to `config/routes.rb`.
+3. Prompts to install ActiveStorage for user avatars
+4. copies migrations into your `db/migrate` and offers to run them;
+5. writes `config/initializers/bible270.rb` (and `omniauth.rb` if you chose social sign-in); and
+6. adds `mount Bible270::Engine, at: Bible270.config.mount_at` to `config/routes.rb`.
 
 (Migrations run before the config is written, so a problem in a generated initializer can't block the database work.)
 
@@ -76,6 +77,7 @@ bin/rails generate bible270:install --defaults \
 | `--mailer-from=ADDR` | From: address for sign-in emails |
 | `--bundle` / `--no-bundle` | Run `bundle install` after adding strategy gems |
 | `--migrate` / `--no-migrate` | Run `db:migrate` at the end |
+| `--active-storage` / `--no-active-storage` | Install Active Storage if missing (for picture uploads) |
 
 The installer is safe to re-run: it leaves an existing `mount` line alone, skips strategy gems already in your Gemfile, and Rails prompts before overwriting an initializer.
 

data/app/mailers/bible270/notice_mailer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Bible270
+  # Notices to whoever runs the plan, as opposed to mail sent to readers.
+  class NoticeMailer < ApplicationMailer
+    def new_reader(reader_id:, recipients:)
+      @reader = Reader.find_by(id: reader_id)
+      return message.perform_deliveries = false if @reader.nil? || recipients.blank?
+
+      @app_name = Bible270.config.app_name
+      @total = Reader.count
+      @admin_url = admin_url_for(@reader)
+
+      mail to: recipients, subject: "#{@app_name}: #{@reader.display_name} has joined"
+    end
+
+  private
+
+    # A mailer has no request, so the host is config.mailer_host or nothing. No
+    # link is better than a broken one.
+    def admin_url_for(reader)
+      host = Bible270.config.mailer_host
+      return nil if host.blank?
+
+      Bible270::Engine.routes.url_helpers.admin_reader_url(
+        reader, host: host, protocol: host.start_with?('localhost') ? 'http' : 'https'
+      )
+    rescue StandardError
+      nil
+    end
+  end
+end

data/app/models/bible270/reader.rb

@@ -18,6 +18,12 @@ module Bible270
 
     def self.avatar_uploads? = AVATAR_UPLOADS
 
+    # Fires for every way a reader comes into existence — email sign-in, OmniAuth,
+    # or a bridged host user — rather than in each controller, so no path can
+    # quietly skip it. after_create_commit, so nothing is sent for a reader whose
+    # transaction rolls back.
+    after_create_commit :notify_of_registration
+
     validates :display_name, presence: true
     validates :uid, uniqueness: { scope: :provider }, allow_nil: true
 
@@ -276,6 +282,25 @@ module Bible270
       update!(started_on: Plan.to_date(on) - (day - 1))
     end
 
+    # Delivery problems must never stop someone joining, so this logs rather than
+    # raises. Registration happens mid-request, hence the deliver_later option.
+    def notify_of_registration
+      recipients = Bible270.config.registration_notice_recipients
+      return if recipients.empty?
+
+      notice = NoticeMailer.new_reader(reader_id: id, recipients: recipients)
+      if Bible270.config.registration_notice_deliver_later
+        notice.deliver_later
+      else
+        notice.deliver_now
+      end
+    rescue StandardError => e
+      Rails.logger.error("[bible270] could not send the registration notice for #{id}: #{e.class}: #{e.message}")
+    end
+    # Private, but declared this way rather than with a `private` section: methods
+    # defined below here are called from controllers and views.
+    private :notify_of_registration
+
     def reload_progress
       @checked_counts = nil
       self

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

@@ -51,7 +51,8 @@
         <%= b270_avatar(r) %>
         <div>
           <div class="name"><%= link_to r.display_name, reader_path(r), style: "text-decoration:none" %></div>
-          <div class="sub"><%= @days_completed[r.id] %> days read</div>
+          <% @day_number = @days_completed[r.id] == 1 ? "day" : "days" %>
+          <div class="sub"><%= @days_completed[r.id] %> <%= @day_number %> read</div>
         </div>
         <div class="stat"><span class="big"><%= (@days_completed[r.id].to_f / Bible270::Plan::DAYS * 100).round %>%</span></div>
       </div>

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

@@ -0,0 +1,28 @@
+<!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">
+      <h1 style="margin:0 0 6px;font-family:Georgia,serif;font-size:20px;font-weight:600">
+        <%= @reader.display_name %> has joined
+      </h1>
+      <p style="margin:0 0 18px;font-size:14px;color:#6d6558"><%= @app_name %></p>
+
+      <table style="font-size:14px;border-collapse:collapse">
+        <tr><td style="padding:3px 12px 3px 0;color:#6d6558">Name</td><td><%= @reader.display_name %></td></tr>
+        <tr><td style="padding:3px 12px 3px 0;color:#6d6558">Email</td><td><%= @reader.email.presence || '(none given)' %></td></tr>
+        <tr><td style="padding:3px 12px 3px 0;color:#6d6558">Signed in with</td><td><%= @reader.provider.presence || 'the host application' %></td></tr>
+        <tr><td style="padding:3px 12px 3px 0;color:#6d6558">Joined</td><td><%= @reader.created_at.strftime('%B %-d, %Y at %-I:%M %p') %></td></tr>
+      </table>
+
+      <p style="margin:18px 0 0;font-size:14px;color:#6d6558">
+        That makes <%= @total %> reader<%= 's' unless @total == 1 %> taking part.
+      </p>
+
+      <% if @admin_url %>
+        <p style="margin:18px 0 0">
+          <a href="<%= @admin_url %>" style="display:inline-block;background:#231f18;color:#ece6da;text-decoration:none;padding:10px 18px;border-radius:10px;font-weight:600;font-size:14px">Manage this reader</a>
+        </p>
+      <% end %>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,11 @@
+<%= @reader.display_name %> has joined <%= @app_name %>.
+
+  Name:        <%= @reader.display_name %>
+  Email:       <%= @reader.email.presence || '(none given)' %>
+  Signed in with: <%= @reader.provider.presence || 'the host application' %>
+  Joined:      <%= @reader.created_at.strftime('%B %-d, %Y at %-I:%M %p') %>
+
+That makes <%= @total %> reader<%= 's' unless @total == 1 %> taking part.
+<% if @admin_url %>
+Manage them: <%= @admin_url %>
+<% end %>

data/lib/bible270/configuration.rb

@@ -211,6 +211,20 @@ module Bible270
       Array(admin_emails).map { |e| e.to_s.downcase }.include?(reader.email.to_s.downcase)
     end
 
+    # The addresses to notify, normalised and de-duplicated. :admins follows
+    # admin_emails, the common case — but an explicit list wins, so a secretary
+    # who isn't an admin can still be told.
+    def registration_notice_recipients
+      requested = registration_notice_emails
+      requested = admin_emails if requested.to_s == 'admins'
+
+      Array(requested).map { |address| EmailSignIn.normalize_email(address) }.compact.uniq
+    end
+
+    def notify_on_registration?
+      registration_notice_recipients.any?
+    end
+
     def admin_configured?
       admin_resolver.respond_to?(:call) || Array(admin_emails).any?
     end
@@ -261,6 +275,23 @@ module Bible270
     # Bible270::Translations::VERSIONS; narrow it to offer fewer.
     attr_accessor :bible_versions
 
+    # Who to email when someone new joins. Three forms:
+    #
+    #   config.registration_notice_emails = %w[andrew@example.org]  # an explicit list
+    #   config.registration_notice_emails = :admins                 # everyone in admin_emails
+    #   config.registration_notice_emails = []                      # off (default)
+    #
+    # An explicit list is used as given, so you can notify someone who isn't an admin.
+    attr_accessor :registration_notice_emails
+
+    # Send the notice through Active Job rather than inline: registration happens
+    # during a request, so inline delivery makes the new reader wait for SMTP.
+    attr_accessor :registration_notice_deliver_later
+
+    # Host for links in notification mail. A mailer has no request to derive it
+    # from, so without this the notice names the reader but cannot link to them.
+    attr_accessor :mailer_host
+
     attr_accessor :after_sign_out_path, :email_sign_in_max_per_window, :passage_url_builder, :tagline, :footer_html, :footer, :favicon, :avatar_max_bytes, :chapter_breaks, :admin_emails, :admin_resolver, :bible_version
 
     # Public labels.
@@ -321,6 +352,9 @@ module Bible270
       @avatar_max_bytes = Avatars::DEFAULT_MAX_BYTES
       @chapter_breaks = {}
       @chapter_breaks_path = nil
+      @registration_notice_emails = []
+      @registration_notice_deliver_later = false
+      @mailer_host = nil
       @admin_emails = []
       @admin_resolver = nil
       @email_sign_in_deliver_later = false

data/lib/bible270/names.rb

@@ -56,7 +56,13 @@ module Bible270
     # Best effort at splitting a single name, for readers who arrived through
     # OmniAuth with only a display name. Everything after the first word is the
     # surname, so "Andrew von der Luft" keeps its particles together.
-    def split(display_name)
+    #
+    # Deliberately not called `split`: a module method with the same name as
+    # String#split invites a bare `split(...)` inside this module to resolve here
+    # instead, and RuboCop's Style/StringChars autocorrect has been known to
+    # rewrite `split` calls into a receiverless `chars`, which then resolves
+    # against the module and fails confusingly.
+    def split_display_name(display_name)
       parts = squish(display_name).split
       return nil if parts.size < 2
 

data/lib/bible270/version.rb

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

data/lib/generators/bible270/install/install_generator.rb

@@ -39,6 +39,8 @@ module Bible270
       class_option :email,       type: :boolean, desc: 'Enable passwordless email sign-in'
       class_option :mailer_from, type: :string,  desc: 'From: address for sign-in emails'
       class_option :migrate,     type: :boolean, desc: 'Run db:migrate at the end'
+      class_option :active_storage, type: :boolean,
+                                    desc: 'Install Active Storage if missing (needed for picture uploads)'
       class_option :bundle,      type: :boolean, desc: 'Run bundle install after adding strategy gems'
       class_option :defaults,    type: :boolean, default: false, desc: 'Accept all defaults, ask nothing'
 
@@ -112,7 +114,41 @@ module Bible270
         run 'bundle install' if @bundled
       end
 
-      # ---- 5. migrations ----------------------------------------------------
+      # ---- 5. Active Storage ------------------------------------------------
+      #
+      # Picture uploads need it. `rails new` enables the framework but the tables
+      # come from a migration that must be installed, so check for that migration
+      # rather than assuming a fresh app has it.
+
+      def ensure_active_storage
+        return if skip_rails_commands?
+
+        unless active_storage_enabled?
+          @active_storage = :unavailable
+          say ''
+          say '  Active Storage is not enabled here, so picture uploads will be off.', :yellow
+          say '  (Was this app generated with --skip-active-storage?)'
+          return
+        end
+
+        if active_storage_installed?
+          @active_storage = :present
+          say '  Active Storage already installed.', :green
+          return
+        end
+
+        unless decide(:active_storage, 'Install Active Storage, so readers can upload a picture?', true)
+          @active_storage = :declined
+          return
+        end
+
+        say ''
+        say 'Installing Active Storage', :yellow
+        rails_command 'active_storage:install'
+        @active_storage = :installed
+      end
+
+      # ---- 6. migrations ----------------------------------------------------
 
       # Migrations run before the initializers are written, so a problem in the
       # generated config can never block the database work.
@@ -139,7 +175,7 @@ module Bible270
         end
       end
 
-      # ---- 6. initializers ---------------------------------------------------
+      # ---- 7. initializers ---------------------------------------------------
 
       def create_engine_initializer
         create_file 'config/initializers/bible270.rb', engine_initializer
@@ -151,7 +187,7 @@ module Bible270
         create_file 'config/initializers/omniauth.rb', omniauth_initializer
       end
 
-      # ---- 7. routing -------------------------------------------------------
+      # ---- 8. routing -------------------------------------------------------
 
       def add_route
         if routes_mounted?
@@ -175,7 +211,7 @@ module Bible270
         end
       end
 
-      # ---- 8. what is left to do -------------------------------------------
+      # ---- 9. what is left to do -------------------------------------------
 
       def summary
         say ''
@@ -185,6 +221,7 @@ module Bible270
         say "  Sign-in           #{auth_summary}"
         say "  Initializers      #{initializer_summary}"
         say "  Migrations        #{@migrated ? 'copied and run' : 'copied (not yet run)'}"
+        say "  Picture uploads   #{active_storage_summary}"
         say ''
 
         remaining = outstanding_steps
@@ -217,6 +254,20 @@ module Bible270
         true
       end
 
+      # config/storage.yml is written by `rails new` unless --skip-active-storage.
+      def active_storage_enabled?
+        return true if File.exist?(File.join(destination_root, 'config', 'storage.yml'))
+
+        application = File.join(destination_root, 'config', 'application.rb')
+        File.exist?(application) && File.read(application).include?('active_storage')
+      rescue StandardError
+        false
+      end
+
+      def active_storage_installed?
+        Dir.glob(File.join(destination_root, 'db', 'migrate', '*create_active_storage_tables*')).any?
+      end
+
       # ---- prompting --------------------------------------------------------
 
       def quiet? = options[:defaults]
@@ -383,6 +434,16 @@ module Bible270
         body.include?('path_prefix') && !body.include?('Bible270.config.auth_path_prefix')
       end
 
+      def active_storage_summary
+        case @active_storage
+        when :installed then 'Active Storage installed'
+        when :present then 'Active Storage already present'
+        when :declined then 'off — Active Storage not installed'
+        when :unavailable then 'off — Active Storage not enabled in this app'
+        else 'unchanged'
+        end
+      end
+
       def outstanding_steps
         steps = []
         steps << "Add to config/routes.rb: #{MOUNT_LINE}" if @route_failed
@@ -395,6 +456,9 @@ module Bible270
         steps << 'bundle install' if @providers.any? && !@bundled
         steps << 'bin/rails bible270:install:migrations' if skip_rails_commands?
         steps << 'bin/rails db:migrate' unless @migrated
+        if @active_storage == :declined
+          steps << 'bin/rails active_storage:install && bin/rails db:migrate — for picture uploads'
+        end
 
         if @providers.any?
           steps << 'Set each provider\'s client id/secret in credentials or ENV'

data/lib/generators/bible270/install/templates/bible270.rb.tt

@@ -37,6 +37,19 @@ Bible270.configure do |config|
   # config.after_sign_in_path  = "<%= mount_at %>"
   # config.after_sign_out_path = "/"
 
+  # --- Admin ----------------------------------------------------------------
+  # config.admin_emails = %w[andrew@example.org]
+  # or
+  # config.admin_resolver = ->(reader) { reader.email.to_s.end_with?('@example.org') }
+  #
+  # --- Notify admin of new user sign-ins -------------------------------------
+  # Who to email when someone new joins. :admins follows admin_emails, or give an
+  # explicit list. Leave empty for no notices.
+  # config.registration_notice_emails = :admins              # everyone in admin_emails
+  # config.registration_notice_emails = %w[admin@example.com]  # or an explicit list
+  # config.mailer_host = 'example.com'                          # lets the notice link to the reader
+  # config.registration_notice_deliver_later = true          # needs Active Job
+
   # --- Start date ------------------------------------------------------------
   # Community-wide start date (Date, Time, or "YYYY-MM-DD"), or nil for undated.
   # config.start_date = Date.new(2026, 9, 6)
@@ -44,4 +57,23 @@ Bible270.configure do |config|
 
   # --- Reading links ---------------------------------------------------------
   config.bible_version = "NKJV"
-end
+
+  # --- Custom chapter breaks -------------------------------------------------
+  # config.chapter_breaks = { 'Psalm 78' => [20, 39, 55] }
+  #
+  # or YAML file:
+  # config.chapter_breaks_path = Rails.root.join('config/bible270_breaks.yml')
+  # config/bible270_breaks.yml — re-read whenever it changes
+  # Psalm 35: []
+  # Psalm 78: [20, 39, 55]
+
+  # --- Custom footer options -------------------------------------------------
+  # The engine's pages end with a short note about how the plan works. Replace it with your own
+  # - a partial in your app at /app/views/layouts/_bible270_footer.html.erb
+  # config.footer_partial = 'layouts/bible270_footer'  
+  # config.footer_html    = '<p>&copy; 2026 …</p>'
+  # config.footer         = false                # no footer at all
+  #_
+  # config.footer_placement = :after    # engine's note, then yours
+  # config.footer_placement = :before   # yours, then the engine's note
+  # config.footer_placement = :replace  # default

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bible270
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Andrew vonderLuft
@@ -76,6 +76,7 @@ files:
 - app/controllers/bible270/sessions_controller.rb
 - app/helpers/bible270/plan_helper.rb
 - app/mailers/bible270/application_mailer.rb
+- app/mailers/bible270/notice_mailer.rb
 - app/mailers/bible270/sign_in_mailer.rb
 - app/models/bible270/application_record.rb
 - app/models/bible270/checkoff.rb
@@ -95,6 +96,8 @@ files:
 - app/views/bible270/days/_start_date.html.erb
 - app/views/bible270/days/index.html.erb
 - app/views/bible270/days/show.html.erb
+- app/views/bible270/notice_mailer/new_reader.html.erb
+- app/views/bible270/notice_mailer/new_reader.text.erb
 - app/views/bible270/profiles/edit.html.erb
 - app/views/bible270/readers/index.html.erb
 - app/views/bible270/readers/show.html.erb