bible270 0.6.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caccb805f18dbe442b8608eabaec724c594c0712aec78fa7a7cbc725ca7829aa
-  data.tar.gz: 2c571bf6ce6812776a464787cada63c732a9fe7a53cc70921f9a4192e7fa14b2
+  metadata.gz: caabc409caaf37d3eeb8a0dd6d0cddba68889fd8deb914e9755c5bb67a571b65
+  data.tar.gz: 0dbe187325f50430c2e689307f521b4c2854980de9e409ffc667aaa30eb0102f
 SHA512:
-  metadata.gz: c70d8f5ec550adf89c2952fd27ec2bc0eaf43ff8c6222d38677bb54ba56838a2af7de974448dbcbf9a1c45116169c90e4e5c2a56bbe72c898953fb3961edb72c
-  data.tar.gz: 2df597fecea51b44334239b82c88eb9e729c51ca11d947dbc41544364e6358f8c1f41cafab3a76c16cfe35f25872ee2bcac122f5c6fd11b2e0f3a8e248eb82e8
+  metadata.gz: 36bcfb1789a6a6248f4cbfb2e30e8b86878535295958720d121837816e2b7eb243c340002b39d189b10f4496dda2ff5da9915d3c55b50eaa0bb0eead710d450e
+  data.tar.gz: c72aaa3f95ab86a4e5139a1d8c7e46e2762c8d9d796b84203fbd8c99ecc153158a1ce6cc1375ac4048025f6c9f93c0f918f3f923677ccaa13d16983ed24e5b70

data/CHANGELOG.md

@@ -1,195 +1,181 @@
 # Changelog
 
 All notable changes to bible270. Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
-this project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html), treating pre-1.0 minor
-bumps as the place breaking changes may land.
-
-## [0.6.3] — 2026-07-25
+this project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html), treating pre-1.0 minor bumps as the place breaking changes may land.
+
+## Unreleased Changes
+
+See the changes since the last release:
+
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.10.0...main)**
+
+## [0.10.0] — 2026-07-26
+
+### Reading plan
+- **Proverbs is read once**, not twice, and its longer chapters are divided — at the discourse
+  boundaries in chapters 1–9 and 30–31, evenly elsewhere, since 10–29 are collections of
+  independent sayings.
+- **A psalm of 25 verses or fewer is never divided** (`PSALM_WHOLE_MAX_VERSES`), which keeps 131 of
+  the 150 psalms whole. Psalms over 25 verses break at their turns of thought.
+- **A divided chapter is always read on consecutive days.** Nothing is inserted between the parts of
+  a split psalm.
+- Psalms and Proverbs are now divided against a single budget, so the two books balance by verse
+  load rather than each being squeezed into a fixed number of days.
+- The New Testament is read once with a reading every day: 260 chapters over 270 days, so the
+  longest are divided (at content boundaries via `CHAPTER_BREAKS`, e.g. Luke 1 at the annunciations,
+  Magnificat and Benedictus).
+- `CHAPTER_BREAKS` lets any chapter's break points be set by hand, or `[]` to force it whole. Break
+  points are validated; a bad entry raises rather than silently overlapping.
+- Break points can also come from the host app and be changed **without restarting**:
+  `config.chapter_breaks`, or a YAML file at `config.chapter_breaks_path` re-read whenever it
+  changes. Precedence: constant < config < file.
+
+### Features
+- **Interactive installer** — `bin/rails generate bible270:install` asks where to mount, which
+  sign-in methods to enable, writes the initializers, adds the `mount` line, copies the migrations
+  and runs them. Scriptable with `--defaults` and friends.
+- **`config.mount_at`** — the mount path in one place; routes and OmniAuth both read it.
+- **Passwordless email sign-in** with single-use magic links; only a SHA-256 digest is stored, and
+  the response never reveals whether an address exists. First and last name are required.
+- **Configurable start dates** — community-wide or per reader, with a Today badge and a pace
+  indicator. Check-offs are keyed to day numbers, so changing a date never moves history.
+- **Admin panel** (`/admin`, gated by `config.admin_emails` or `config.admin_resolver`; unauthorised
+  requests 404 rather than 403). Remove readers, set their progress exactly (mark complete through a
+  day, or toggle individual days), and move them to a given day of the plan — which re-maps the
+  calendar only, since check-offs are keyed to day numbers.
+- **Comment moderation.** Reflections are **visible as soon as they are written** — moderation is for
+  taking something down afterwards, not gatekeeping every post. An admin can hide a reflection
+  (removing it from the day and community pages while keeping the writer's words, reversibly) or
+  delete it outright, from a list filterable by visible/hidden or from the writer's own page.
 
 ### Fixed
-- **`db:migrate` failed with `ActiveRecord::DuplicateMigrationNameError`.** The engine appended its
-  own `db/migrate` to the host application's migration paths *and* exposed
-  `bible270:install:migrations`. Using the task — the documented install step — meant every
-  migration class was defined twice, once in the host's `db/migrate` and once in the gem. The engine
-  no longer touches the host's migration paths; copying via the task is the single supported path,
-  which also means the host owns the migrations and they appear in `schema.rb` normally.
-
-### Added
-- `spec.email` in the gemspec.
-
-## [0.6.2] — 2026-07-24
+- Sign-in was broken: OmniAuth 2.0+ rejects GET on its request phase, so the controls are now POST
+  forms with CSRF tokens. Open-redirect hardening on the return-to path, and `reset_session` on
+  sign-in and sign-out.
+- `db:migrate` failed with `DuplicateMigrationNameError` — the engine both appended its migrations
+  to the host's paths and shipped `install:migrations`.
+- Views raised `uninitialized constant Plan`: a template's lexical scope is `Object`, so engine
+  constants must be fully qualified.
+- Views raised `undefined method 'b270_*'`: Rails only auto-includes an engine's helpers when the
+  controller's superclass is exactly `ActionController::Base`, which it isn't once
+  `config.parent_controller` points at the host.
+- Buttons rendered dark-on-dark: `.b270 a{color:inherit}` outranked `.b270-btn`.
+- The generated OmniAuth initializer called `path_prefix`, which `OmniAuth::Builder` does not
+  define, and read credentials at boot so a bad master key stopped the app starting.
+- The sign-in email was rendered inside the host's mailer layout, nesting one HTML document in
+  another.
+- Ruby 4.0 compatibility: dropped `cgi`, removed from default gems in 4.0.
+- Posting a reflection about the whole day failed with "Track is not included in the list": the
+  form's blank option submits an empty string, which `allow_nil` rejects. Blank tracks are now
+  normalised to NULL before validation.
+
+- `config.email_sign_in_log_link` — tri-state: nil logs the sign-in link in development and test
+  only, true forces it on (for smoke-testing a production build locally before mail is wired up),
+  false disables it. The log also distinguishes sent, rate-limited and failed delivery, which the
+  response deliberately cannot.
+- A test asserts every setting the code calls is actually defined on `Configuration`, so a missing
+  accessor fails the suite instead of raising `NoMethodError` on whichever request touches it.
 
-### Changed
-- Gem metadata now points at the actual repository rather than reusing the homepage:
-  `source_code_uri`, `bug_tracker_uri`, and `changelog_uri` all resolve to
-  <https://github.com/avonderluft/bible270>.
-- `rubygems_mfa_required` is set, so pushes to rubygems.org require MFA.
+### Notes
+- Table names changed from `bible_reading_plan_*` in the 0.9.0 line; this is a fresh install.
 
-### Added
-- This changelog, packaged with the gem.
+## [0.9.0] — 2026-07-25
 
-## [0.6.1] — 2026-07-24
+**[Full Changelog](https://github.com/avonderluft/bible270/compare/v0.6.2...v0.9.0)**
 
 ### Changed
-- Author and copyright now read "Andrew vonderLuft".
-- The display-name-from-email example in the docs and tests uses a neutral address, since the
-  algorithm can't recover internal capitals and shouldn't be shown rendering a real name wrongly.
 
-## [0.6.0] — 2026-07-24
+* **The New Testament now has a reading every day — no days off.** 260 chapters over 270 days is reconciled by dividing the 10 longest chapters in two: Luke 1, Matthew 26 and 27, Mark 14, Luke 9, 12 and 22, John 6 and 8, and Acts 7. Luke 1 reads as 1–40 then 41–80. This drops the longest NT reading from 80 verses to 58 (stdev 14.6 → 11.4) and removes the 10 rest days from 0.8.0, so all three tracks are present on all 270 days and every day needs three check-offs.
+* The daily total is now 76–175 verses (was 76–203), averaging ~119.
 
 ### Added
-- **Passwordless email sign-in**, so readers without a GitHub/Google/etc. account can take part.
-  A reader enters their address, receives a single-use link, and clicks it — no password anywhere
-  in the gem.
-  - Tokens are 256-bit and URL-safe, expire after 20 minutes (`email_sign_in_ttl`), and are stored
-    **only as a SHA-256 digest**, so the table is useless to anyone reading the database.
-  - Claiming a link is a conditional `UPDATE`, so a double-clicked link cannot sign in twice.
-  - The "check your inbox" response is identical for known, unknown, and rate-limited addresses:
-    no account enumeration and no signal that a limit was hit.
-  - Rate limited per address per window (`email_sign_in_max_per_window`, `email_sign_in_window`).
-  - Readers may choose the display name shown beside their reflections
-    (`email_sign_in_ask_name`); otherwise it is derived from the address.
-  - `Bible270::SignInToken.sweep!` clears spent and stale rows from a cron or rake task.
-- `Bible270::EmailSignIn` — Rails-free module holding the normalization and token logic, so the
-  security-relevant parts are unit testable on their own.
-- `Bible270::SignInMailer` with text and HTML magic-link templates. The sign-in URL is built by the
-  controller, so the mailer needs no `default_url_options`.
-- `Bible270::Reader.from_email`, using the same identity columns as OmniAuth with `provider: "email"`,
-  so every reader is treated identically downstream.
-- New table: `bible270_sign_in_tokens` (migration `20260101000004`).
-- `config.any_sign_in_method?`, letting views detect a deployment with no sign-in configured.
 
-### Fixed
-- `display_name_from` raised `ArgumentError` on any address containing an underscore:
-  `tr("._-+", …)` was parsed as a character range. The hyphen now comes last.
-
-### Requirements
-- Email sign-in needs working Action Mailer delivery in the host application. Set
-  `config.mailer_from`. Delivery is inline by default; set `email_sign_in_deliver_later` if a
-  queue backend is available.
+* Shared division machinery used by both the NT and the Psalms: `Plan.divide_to_fill`, `expand_readings`, `segment_length`, `format_segment`, `divided`.
+* `Plan.nt_parts`, `nt_readings`, `nt_chapters`, `divided_nt_chapters`, `psalm_chapters`.
+* `totals` reports `nt_readings` (270) and `nt_divided` (10).
 
-## [0.5.0] — 2026-07-24
+### Removed
 
-### Added
-- Built-in OmniAuth sign-in is now fully wired as the primary auth path.
-- `config.omniauth_providers` accepts symbols or `[provider, label]` pairs, with labels for common
-  providers and titleisation for anything custom.
-- Sign-in page at `GET <mount>/sign_in` listing every configured provider.
-- Sign-in controls carry the current path as `origin`, so a reader who clicks a check-off while
-  signed out returns to that same day. Origins are validated as local paths only.
-- `rails generate bible270:install`, which writes both initializers with OmniAuth's `path_prefix`
-  already aligned to the mount point, adds the `mount` line, and prints the callback URL to register.
-- `omniauth` (>= 2.0) and `omniauth-rails_csrf_protection` (>= 1.0) as runtime dependencies. Provider
-  strategy gems remain the host's choice.
-
-### Fixed
-- **Sign-in was broken.** The header rendered a GET link to `/auth/github`, but OmniAuth 2.0 disabled
-  GET on the request phase (CVE-2015-9284). All sign-in controls are now POST forms with CSRF tokens.
-  The old link also contained a dead ternary and hardcoded the provider.
-- Open-redirect hardening on the `origin` parameter: protocol-relative URLs, backslashes (which
-  browsers may normalise to slashes), and auth routes are all rejected.
-- `reset_session` on sign-in and sign-out, against session fixation.
-- `Reader.from_omniauth` no longer assumes an `OmniAuth::AuthHash`; it tolerates plain hashes and
-  missing `info`, and returns `nil` rather than raising on a malformed payload.
+* `Plan.nt_groups`, `format_pp_segment`, `pp_segment_length` (superseded by the shared `format_segment` and `segment_length`), and `totals[:nt_rest_days]`.
+* `nt_rest_days` remains but now always returns an empty array.
 
-### Changed
-- `sign_out` is `DELETE` only (previously `GET` or `DELETE`).
-- Guarded actions redirect to the sign-in page instead of `request.referer`.
+## [0.6.2] — 2026-07-25
 
-## [0.4.0] — 2026-07-24
+This is the initial public release.
 
 ### Added
-- **Configurable start dates.** `config.start_date` sets a community-wide cohort date (accepting a
-  `Date`, `Time`, or `"YYYY-MM-DD"` string); `config.allow_reader_start_date` controls whether
-  individuals may set their own. The four combinations give undated, per-reader, community-with-
-  override, and fully pinned modes.
-- Readers manage their own date from the overview (`PATCH`/`DELETE <mount>/start-date`).
-- Calendar mapping as pure functions on `Bible270::Plan`: `date_for`, `day_for` (clamped by default,
-  `clamp: false` to detect out-of-range), `end_date_for`, `before_start?`, `after_end?`, `to_date`.
-- Day pages show their calendar date with a **Today** badge; the overview gains a "Go to today" link
-  and a pace indicator ("3 days behind", "right on pace", "begins in 12 days").
-
-### Notes
-- Check-offs and comments are keyed to day numbers, never dates, so changing a start date only
-  re-maps the calendar — no reading history moves or is lost.
-- A malformed `config.start_date` degrades to `nil` rather than raising at boot; the controller does
-  reject bad input with a flash message.
 
-## [0.3.1] — 2026-07-24
+* Initial release of a mountable Rails engine providing a 270-day Bible reading plan with three daily tracks: Old Testament, New Testament, and Psalms/Proverbs.
+* Per-reader check-offs, public per-day reflections, a community leaderboard, and reader profiles.
+* Two identity paths: built-in session sign-in, or bridging the host application's users via `config.current_reader_resolver` and `Reader.for_owner`.
+* A pure, deterministic Ruby schedule; the database stores readers, check-offs, and comments rather than plan rows.
+* `Bible270::Versification`, providing per-chapter verse counts for all 66 books, generated from a public-domain KJV text and validated against canonical anchors.
+* Verse-balanced daily portions rather than chapter-count balancing, so daily reading time is approximately even.
+* Old Testament days grouped to be even in verses, averaging approximately 73 verses per day.
+* Per-track progress bars based on days read rather than chapter totals.
+* The New Testament read twice, with each pass occupying half of the 270-day plan. Whole chapters are verse-balanced within each pass.
+* A Psalms/Proverbs companion plan resolving to exactly 135 portions, making two complete passes across the 270-day plan.
+* Chapters are generally kept whole; Psalm 119 is divided into two readings, while shorter chapters may be combined with a neighboring psalm.
+* Configurable start dates through `config.start_date` and `config.allow_reader_start_date`, including per-reader date management.
+* Calendar mapping functions on `Bible270::Plan`: `date_for`, `day_for`, `end_date_for`, `before_start?`, `after_end?`, and `to_date`.
+* Calendar-aware day pages, including a **Today** badge, a **Go to today** link, and a pace indicator.
+* Built-in OmniAuth sign-in as the primary authentication path.
+* Configurable OmniAuth providers, including labels for common providers and titleisation for custom providers.
+* A sign-in page at `GET <mount>/sign_in`.
+* `rails generate bible270:install`, which creates the initializers, adds the engine mount, configures OmniAuth's path prefix, and prints the callback URL.
+* Passwordless email sign-in using single-use magic links.
+* Secure email sign-in tokens that are 256-bit, URL-safe, expire after 20 minutes, and are stored only as SHA-256 digests.
+* Rate limiting for email sign-in attempts and protection against account enumeration.
+* Optional reader-selected display names for email sign-in.
+* `Bible270::SignInToken.sweep!` for clearing spent and stale tokens.
+* `Bible270::EmailSignIn`, a Rails-free module containing the normalization and token logic.
+* `Bible270::SignInMailer` with text and HTML magic-link templates.
+* `Bible270::Reader.from_email`, using the same identity columns as OmniAuth with `provider: "email"`.
+* The `bible270_sign_in_tokens` table.
+* `config.any_sign_in_method?`.
+* A centralized `config.mount_at` setting, defaulting to `/daily-bread`, with derived `config.auth_path_prefix`.
+* Support for nested mount paths and mounting at `/`.
+* Configuration-driven engine mounting and OmniAuth path prefixes.
+* `spec.email` in the gemspec.
+* Gem metadata pointing to the actual repository for `source_code_uri`, `bug_tracker_uri`, and `changelog_uri`.
+* RubyGems MFA requirement through `rubygems_mfa_required`.
+* This changelog, packaged with the gem.
+* Compatibility notes and tests covering Ruby 4.0 changes, including removal of the `cgi` dependency.
 
-### Fixed
-- **Ruby 4.0 compatibility.** Dropped the `cgi` dependency: the CGI library was removed from Ruby's
-  default gems in 4.0 (only `cgi/escape` remains), so `require "cgi"` emits a deprecation warning
-  there. URL escaping now uses `URI.encode_www_form_component`, which produces byte-identical output
-  to `CGI.escape` and relies only on `uri`, a stable default gem.
+### Changed
 
-### Added
-- Regression test asserting the gem never loads the `cgi` library.
-- Compatibility notes in the README: audited against the Ruby 4.0 breaking changes (`Set`/`SortedSet`,
-  `Ractor`, `Net::HTTP`, `Process::Status`, `ObjectSpace`, and the gems promoted from default to
-  bundled). Every file carries a `frozen_string_literal` comment and the suite passes with
-  `--enable-frozen-string-literal` forced.
-
-## [0.3.0] — 2026-07-24
-
-### Changed — BREAKING
-- **Renamed from `bible_reading_plan` to `bible270`.** Module `Bible270`, tables `bible270_*`,
-  migrations `CreateBible270*`, CSS and helper prefix `b270`, install task
-  `bible270:install:migrations`, mount `Bible270::Engine`. Table names changed, so this is a fresh
-  install rather than an upgrade.
-- **The New Testament is now read twice.** Each pass gets its own half of the plan (135 days), so
-  Revelation lands on day 135 and again on day 270. Whole chapters are verse-balanced within each
-  pass, tightening NT days from 11–140 verses to 20–104. The NT track now has content every day, so
-  there are no rest days and all three tracks are present on all 270 days.
-- **Chapters are kept whole.** Only a chapter longer than `PP_LONG_CHAPTER` (100 verses) is divided,
-  which in the whole Psalter and Proverbs is Psalm 119 alone — split into exactly two readings
-  (1–88, 89–176). Psalms 78 and 89 are no longer split. Short chapters merge with a neighbour, so
-  Psalm 117 reads as "Psalm 116–117" rather than occupying a two-verse day.
-- The Psalms/Proverbs companion resolves to exactly 135 portions, making two complete passes across
-  270 days and finishing on Proverbs 31 — so all three tracks finish together at the halfway mark
-  and at the end.
+* The project was renamed from `bible_reading_plan` to `bible270`, including the `Bible270` module, database tables, migrations, CSS and helper prefixes, install task, and engine name.
+* The install generator defaults to `/daily-bread`, writes the mount path into the engine initializer, and emits configuration-driven `mount` and `path_prefix` lines.
+* The README documents the mount point, initializer load-order requirements, OAuth callback URLs, and CMS links that may need updating when the mount path changes.
+* The engine's sign-in paths follow the mount point at runtime through `request.script_name`.
+* Author and copyright information now read “Andrew vonderLuft”.
+* The display-name-from-email example uses a neutral address.
+* `sign_out` is `DELETE` only.
+* Guarded actions redirect to the sign-in page.
+* URL escaping uses `URI.encode_www_form_component` rather than `CGI.escape`.
 
-### Added
-- `Plan.nt_days_per_pass`, `nt_second_pass_start_day`, `nt_verse_loads`, `pp_cycle_length`,
-  `pp_base_portions`, and tuning constants documented in the README.
+### Fixed
 
-## [0.2.0] — 2026-07-24
+* **`db:migrate` failed with `ActiveRecord::DuplicateMigrationNameError`.** The engine appended its own `db/migrate` to the host application's migration paths and also exposed `bible270:install:migrations`. Using the task meant every migration class was defined twice. The engine no longer touches the host's migration paths; copying via the task is the single supported path.
+* Sign-in was broken under OmniAuth 2.0 because the request phase no longer permits GET requests. Sign-in controls now use POST forms with CSRF tokens.
+* Open redirects through the `origin` parameter, including protocol-relative URLs, backslashes, and authentication routes.
+* Session fixation by resetting the session on sign-in and sign-out.
+* `Reader.from_omniauth` now tolerates plain hashes, missing `info`, and malformed payloads without raising.
+* `display_name_from` no longer raises `ArgumentError` for addresses containing underscores.
+* Ruby 4.0 compatibility issues caused by the removed `cgi` default gem.
+* Progress bars that could not reach the correct totals because they compared checked days with chapter totals.
 
-### Changed
-- **Daily portions are balanced by verse count, not chapter count**, so each day takes roughly the
-  same time to read. Previously a day on Psalm 119 (176 verses) counted the same as a day on Psalm
-  117 (2 verses).
-- Old Testament days are grouped to be even in verses (avg ~73/day).
+### Breaking Changes
 
-### Added
-- `Bible270::Versification` — per-chapter verse counts for all 66 books, generated from a
-  public-domain KJV text and validated against canonical anchors (1,189 chapters; Psalms 2,461
-  verses; Proverbs 915; Psalm 119 = 176; Psalm 117 = 2). Verse counts are facts about the text's
-  structure, so nothing copyrighted is bundled.
+* The project was renamed from `bible_reading_plan` to `bible270`; this is a fresh install rather than an in-place upgrade because database table names changed.
+* The New Testament schedule changed from a single pass to two verse-balanced passes.
+* The Psalms/Proverbs schedule changed to two complete 135-portion passes.
+* Calendar and reading-plan behavior is based on day numbers rather than stored plan rows.
 
-### Fixed
-- Per-track progress bars compared days checked against *chapter* totals, so the Old Testament bar
-  could never exceed ~36%. Renamed `chapters_read_in` to `days_read_in` and made the totals
-  day-based.
+### Requirements
 
-## [0.1.0] — 2026-07-24
+* 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.
 
-### Added
-- Initial release: a mountable Rails engine providing a 270-day Bible reading plan with three daily
-  tracks (Old Testament, New Testament, Psalms/Proverbs).
-- Per-reader check-offs, public per-day reflections, a community leaderboard, and reader profiles.
-- Two identity paths: built-in session sign-in, or bridging the host application's users via
-  `config.current_reader_resolver` and `Reader.for_owner`.
-- The schedule is pure, deterministic Ruby — no rows are stored for the plan itself; the database
-  holds only readers, check-offs, and comments.
-
-[0.6.3]: https://github.com/avonderluft/bible270/releases/tag/v0.6.3
+[0.10.0]: https://github.com/avonderluft/bible270/releases/tag/v0.10.0
+[0.9.0]: https://github.com/avonderluft/bible270/releases/tag/v0.9.0
 [0.6.2]: https://github.com/avonderluft/bible270/releases/tag/v0.6.2
-[0.6.1]: https://github.com/avonderluft/bible270/releases/tag/v0.6.1
-[0.6.0]: https://github.com/avonderluft/bible270/releases/tag/v0.6.0
-[0.5.0]: https://github.com/avonderluft/bible270/releases/tag/v0.5.0
-[0.4.0]: https://github.com/avonderluft/bible270/releases/tag/v0.4.0
-[0.3.1]: https://github.com/avonderluft/bible270/releases/tag/v0.3.1
-[0.3.0]: https://github.com/avonderluft/bible270/releases/tag/v0.3.0
-[0.2.0]: https://github.com/avonderluft/bible270/releases/tag/v0.2.0
-[0.1.0]: https://github.com/avonderluft/bible270/releases/tag/v0.1.0