bible270 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7867bb4de49fe177447a5f7b1cfa9fa031e1926cdb8c4c73f2071eb8a7620c82
-  data.tar.gz: '0499e0931abdd3890f07945f7fc82f6de8dc5da1a156fbb8147e1b5b2be79596'
+  metadata.gz: f8c170757c087fab1698cb43ef5251e28c4e7c4f08187cb33b0ac3962f41fc28
+  data.tar.gz: 5e803ddf4f8d77b56c2c7c91859b7ea0f8222341162790f39fb2cc7abbc1f517
 SHA512:
-  metadata.gz: 422848afb4e96f1a94cbfc26078f7c343afdb519e431c25aa6f2de10be0578d51fa65aa6d04683490b792685d5888474b8f711f0e1839ccd6ccaeb45c52c26d0
-  data.tar.gz: 81cd1f5df1028fa4064bc77ec5ee20866406d21c1ae5d4d992e8137bde59e5c6d6c505c7fc92b85111c931b7450da60b125692cb0bacbe63652e63012f9257da
+  metadata.gz: 3ff3dcde674bf0be28d1baec700a39d8db3a26a199c72fc467dd6864020d1608a1667e9feecb2e530706cf1a92b3a653cd7b904dd883cc4f495dc9027145c6c8
+  data.tar.gz: 4e3566d9c90076d1a9c4c46ee99e9d2415320fcfeb8be0d2acc1a03ac9168278362a8cfe1dd93b108e4db312c292f3436a4061e24b5cb211ec217445a942a254

data/CHANGELOG.md

@@ -7,6 +7,12 @@ All notable changes to bible270. Format follows [Keep a Changelog](https://keepa
 ### Added
 
 - add an on-demand Markdown formatting drawer and separate server-rendered Preview control for reflections and replies, with safe rendering, formatted notification emails, mention and browser-draft compatibility, and literal display of existing plain-text reflections; upgrading hosts must copy and run the new `body_format` comment migration
+- add `bible270:notifications:enable_all` to opt every existing reader into emails for each new reflection and reply
+- add `bible270:readers:list` to print an aligned, progress-sorted reader report with schedule status
+
+### Changed
+
+- default new readers to emails for every new reflection and reply; existing reader preferences remain unchanged by the migration
 
 ### Fixed
 

data/README.md

@@ -295,7 +295,8 @@ plain text or Markdown; until then, the composer safely falls back to plain text
 When `config.mention_notifications` is enabled, each reader can request email for every new reflection
 and reply, only replies to their reflections and mentions of them, or none. Administrators can change
 the same preference from the reader's Admin page. Migration
-`20260101000018` adds the broad opt-in without changing any existing reader's choice. Migration
+`20260101000018` adds the broad opt-in without changing any existing reader's choice, while migration
+`20260101000022` makes that broad option the default for readers created afterward. Migration
 `20260101000017` stores each reader's last visit to the Reflections page. After upgrading, install and
 run the current migrations:
 
@@ -304,6 +305,27 @@ bin/rails bible270:install:migrations
 bin/rails db:migrate
 ```
 
+To change every existing reader to **Every new reflection and reply**, run:
+
+```bash
+bin/rails bible270:notifications:enable_all
+```
+
+With Docker Compose:
+
+```bash
+docker compose exec -e RAILS_ENV=production rails bin/rails bible270:notifications:enable_all
+```
+
+To print an aligned progress report ordered by completed days, run:
+
+```bash
+docker compose exec -e RAILS_ENV=production rails bin/rails bible270:readers:list
+```
+
+The report compares completed days with the calendar day implied by each reader's effective start date
+and shows `on track`, days ahead or behind, or `undated` when no calendar applies.
+
 Break points can also live in your app rather than the gem, and be changed without a restart:
 
 ```ruby

data/db/migrate/20260101000022_change_all_comment_notices_default_to_true.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ChangeAllCommentNoticesDefaultToTrue < ActiveRecord::Migration[7.0]
+  def up
+    change_column_default :bible270_readers, :notify_on_all_comments, from: false, to: true
+  end
+
+  def down
+    change_column_default :bible270_readers, :notify_on_all_comments, from: true, to: false
+  end
+end

data/lib/bible270/migration_reconciler.rb

@@ -31,6 +31,7 @@ module Bible270
       'ChangePassageSourceDefaultToBibleCom' => :check_passage_source_default,
       'AddCompletionDoveDisabledToBible270Readers' => :check_completion_dove_disabled,
       'AddBodyFormatToBible270Comments' => :check_comment_body_format,
+      'ChangeAllCommentNoticesDefaultToTrue' => :check_all_comment_notices_default,
       'CreateActiveStorageTables' => :check_active_storage
     }.freeze
 
@@ -221,6 +222,14 @@ module Bible270
       missing
     end
 
+    def check_all_comment_notices_default
+      missing = table_missing(:bible270_readers, columns: %i[notify_on_all_comments])
+      return missing if missing.any?
+
+      column = connection.columns(:bible270_readers).find { |candidate| candidate.name == 'notify_on_all_comments' }
+      column&.default == true ? [] : ['column bible270_readers.notify_on_all_comments default true']
+    end
+
     # The Bible270 installer can install Active Storage for reader avatars. A
     # copied database can therefore have the same timestamp mismatch for Rails'
     # generated Active Storage migration as it has for the engine migrations.

data/lib/bible270/reader_progress_report.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Bible270
+  # Builds the plain-text reader progress table used by administrative tasks.
+  class ReaderProgressReport
+    HEADERS = ['Name', 'Days Read', 'Status'].freeze
+    Row = Struct.new(:name, :days_read, :status, keyword_init: true)
+
+    def initialize(readers: Reader.all, completed_days: Reader.completed_days_by_id)
+      @readers = readers
+      @completed_days = completed_days
+    end
+
+    def rows
+      @rows ||= begin
+        report_rows = readers.map do |reader|
+          days_read = completed_days.fetch(reader.id, 0)
+          Row.new(name: reader.display_name, days_read: days_read, status: status(reader, days_read))
+        end
+        report_rows.sort_by { |row| [-row.days_read, row.name.downcase, row.name] }
+      end
+    end
+
+    def empty? = rows.empty?
+
+    def to_table
+      values = rows.map { |row| [row.name, row.days_read.to_s, row.status] }
+      widths = HEADERS.each_index.map do |index|
+        ([HEADERS[index].length] + values.map { |value| value[index].length }).max
+      end
+      format = "%-#{widths[0]}s  %#{widths[1]}s  %-#{widths[2]}s"
+      lines = [format % HEADERS, format % widths.map { |width| '-' * width }].map(&:rstrip)
+      lines.concat(values.map { |value| (format % value).rstrip })
+      lines.join("\n")
+    end
+
+  private
+
+    attr_reader :readers, :completed_days
+
+    def status(reader, days_read)
+      calendar_day = reader.calendar_day
+      return 'undated' unless calendar_day
+
+      difference = days_read - calendar_day
+      return 'on track' if difference.zero?
+
+      amount = difference.abs
+      "#{amount} #{amount == 1 ? 'day' : 'days'} #{difference.positive? ? 'ahead' : 'behind'}"
+    end
+  end
+end

data/lib/bible270/version.rb

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

data/lib/bible270.rb

@@ -13,6 +13,7 @@ require 'bible270/translations'
 require 'bible270/favicon'
 require 'bible270/configuration'
 require 'bible270/daily_reminders'
+require 'bible270/reader_progress_report'
 require 'bible270/engine' if defined?(Rails::Engine)
 
 module Bible270

data/lib/tasks/bible270_notifications.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+namespace :bible270 do
+  namespace :notifications do
+    desc 'Email every existing reader about each new reflection and reply'
+    task enable_all: :environment do
+      unless Bible270::Reader.comment_notification_columns?
+        abort 'Reflection email columns are missing. Run bin/rails bible270:install:migrations and bin/rails db:migrate.'
+      end
+
+      total = Bible270::Reader.count
+      puts "Found #{total} Bible270 #{'reader'.pluralize(total)} in the #{Rails.env} environment."
+      if total.zero?
+        puts 'No reader settings were changed.'
+        puts 'Rerun with RAILS_ENV=production if that is where your readers are stored.' unless Rails.env.production?
+        next
+      end
+
+      readers = Bible270::Reader.where(notify_on_mention: false)
+        .or(Bible270::Reader.where(notify_on_all_comments: false))
+      updated = 0
+
+      Bible270::Reader.transaction do
+        readers.find_each do |reader|
+          reader.update_comment_notification_level!('all')
+          updated += 1
+        end
+      end
+
+      if updated.zero?
+        puts "All #{total} #{'reader'.pluralize(total)} already receive every new reflection and reply."
+      else
+        puts "Updated #{updated} #{'reader'.pluralize(updated)}. " \
+             "All #{total} #{'reader'.pluralize(total)} now receive every new reflection and reply."
+      end
+    end
+  end
+end

data/lib/tasks/bible270_readers.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bible270/reader_progress_report'
+
+namespace :bible270 do
+  namespace :readers do
+    desc 'List readers by completed days with their schedule status'
+    task list: :environment do
+      report = Bible270::ReaderProgressReport.new
+      if report.empty?
+        puts "No Bible270 readers found in the #{Rails.env} environment."
+      else
+        puts report.to_table
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bible270
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Andrew vonderLuft
@@ -214,6 +214,7 @@ files:
 - db/migrate/20260101000019_change_passage_source_default_to_bible_com.rb
 - db/migrate/20260101000020_add_completion_dove_disabled_to_bible270_readers.rb
 - db/migrate/20260101000021_add_body_format_to_bible270_comments.rb
+- db/migrate/20260101000022_change_all_comment_notices_default_to_true.rb
 - lib/bible270.rb
 - lib/bible270/avatars.rb
 - lib/bible270/comment_formatter.rb
@@ -226,6 +227,7 @@ files:
 - lib/bible270/migration_reconciler.rb
 - lib/bible270/names.rb
 - lib/bible270/plan.rb
+- lib/bible270/reader_progress_report.rb
 - lib/bible270/translations.rb
 - lib/bible270/versification.rb
 - lib/bible270/version.rb
@@ -233,6 +235,8 @@ files:
 - lib/generators/bible270/install/templates/bible270.rb.tt
 - lib/generators/bible270/install/templates/omniauth.rb.tt
 - lib/tasks/bible270_migrations.rake
+- lib/tasks/bible270_notifications.rake
+- lib/tasks/bible270_readers.rake
 - lib/tasks/bible270_reminders.rake
 homepage: https://github.com/avonderluft/bible270
 licenses: