bible270 0.6.3 → 0.10.0

data/db/migrate/20260101000001_create_bible270_readers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateBible270Readers < ActiveRecord::Migration[7.0]
   def change
     create_table :bible270_readers do |t|
@@ -8,10 +9,10 @@ class CreateBible270Readers < ActiveRecord::Migration[7.0]
       t.string  :provider
       t.string  :uid
       t.references :owner, polymorphic: true, index: true
-      t.date    :started_on
+      t.date :started_on
       t.timestamps
     end
     add_index :bible270_readers, %i[provider uid], unique: true,
-              name: "idx_b270_readers_provider_uid"
+                                                   name: 'idx_b270_readers_provider_uid'
   end
 end

data/db/migrate/20260101000002_create_bible270_checkoffs.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 class CreateBible270Checkoffs < ActiveRecord::Migration[7.0]
   def change
     create_table :bible270_checkoffs do |t|
       t.references :reader, null: false, index: true,
-                   foreign_key: { to_table: :bible270_readers }
+                            foreign_key: { to_table: :bible270_readers }
       t.integer :day,   null: false
       t.string  :track, null: false
       t.timestamps
     end
     add_index :bible270_checkoffs, %i[reader_id day track], unique: true,
-              name: "idx_b270_checkoffs_unique"
+                                                            name: 'idx_b270_checkoffs_unique'
     add_index :bible270_checkoffs, :day
   end
 end

data/db/migrate/20260101000003_create_bible270_comments.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 class CreateBible270Comments < ActiveRecord::Migration[7.0]
   def change
     create_table :bible270_comments do |t|
       t.references :reader, null: false, index: true,
-                   foreign_key: { to_table: :bible270_readers }
-      t.integer :day,   null: false
+                            foreign_key: { to_table: :bible270_readers }
+      t.integer :day, null: false
       t.string  :track
-      t.text    :body,  null: false
+      t.text    :body, null: false
       t.timestamps
     end
     add_index :bible270_comments, %i[day created_at]

data/db/migrate/20260101000004_create_bible270_sign_in_tokens.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
+
 class CreateBible270SignInTokens < ActiveRecord::Migration[7.0]
   def change
     create_table :bible270_sign_in_tokens do |t|
       t.string   :email,        null: false
       t.string   :token_digest, null: false
       t.string   :display_name
-      t.datetime :expires_at,   null: false
+      t.datetime :expires_at, null: false
       t.datetime :consumed_at
       t.timestamps
     end
 
     add_index :bible270_sign_in_tokens, :token_digest, unique: true,
-              name: "idx_b270_signin_tokens_digest"
+                                                       name: 'idx_b270_signin_tokens_digest'
     add_index :bible270_sign_in_tokens, %i[email created_at],
-              name: "idx_b270_signin_tokens_email"
+              name: 'idx_b270_signin_tokens_email'
   end
 end

data/db/migrate/20260101000005_add_names_to_bible270_readers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class AddNamesToBible270Readers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :bible270_readers, :first_name, :string
+    add_column :bible270_readers, :last_name, :string
+    add_column :bible270_sign_in_tokens, :first_name, :string
+    add_column :bible270_sign_in_tokens, :last_name, :string
+
+    add_index :bible270_readers, %i[last_name first_name], name: 'idx_b270_readers_name'
+  end
+end

data/db/migrate/20260101000006_add_approval_to_bible270_comments.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddApprovalToBible270Comments < ActiveRecord::Migration[7.0]
+  def change
+    # Reflections are visible as soon as they are written; moderation is for
+    # taking something down after the fact, not for gatekeeping every post.
+    add_column :bible270_comments, :approved, :boolean, null: false, default: true
+    add_column :bible270_comments, :moderated_at, :datetime
+    add_index :bible270_comments, %i[approved day]
+  end
+end

data/lib/bible270/configuration.rb

@@ -4,8 +4,8 @@
 # here: the CGI library was removed from Ruby's default gems in Ruby 4.0 (only
 # cgi/escape remains), so requiring it emits a deprecation warning there.
 # URI.encode_www_form_component produces byte-identical output to CGI.escape.
-require "uri"
-require "bible270/plan"
+require 'uri'
+require 'bible270/plan'
 
 module Bible270
   class Configuration
@@ -27,9 +27,36 @@ module Bible270
     # Leave nil to use the built-in session-based sign-in (OmniAuth).
     attr_accessor :current_reader_resolver
 
+    # Where the engine is mounted in the host application. Set this once, in
+    # config/initializers/bible270.rb, and use it everywhere the path is needed:
+    #
+    #   # config/routes.rb
+    #   mount Bible270::Engine, at: Bible270.config.mount_at
+    #
+    #   # config/initializers/omniauth.rb
+    #   path_prefix Bible270.config.auth_path_prefix
+    #
+    # Accepts "daily-bread" or "/daily-bread"; stored with a leading slash and
+    # no trailing one.
+    attr_reader :mount_at
+
+    def mount_at=(value)
+      path = value.to_s.strip
+      path = "/#{path}" unless path.start_with?('/')
+      path = path.chomp('/')
+      @mount_at = path.empty? ? '/' : path
+    end
+
+    # The prefix OmniAuth's middleware should serve its routes under. Derived
+    # from mount_at unless omniauth_path_prefix is set explicitly.
+    def auth_path_prefix
+      return omniauth_path_prefix if omniauth_path_prefix
+
+      mount_at == '/' ? '/auth' : "#{mount_at}/auth"
+    end
+
     # Where to send the reader after a successful sign-in / sign-out.
     attr_accessor :after_sign_in_path
-    attr_accessor :after_sign_out_path
 
     # ---- OmniAuth (built-in sign-in) --------------------------------------
 
@@ -50,17 +77,17 @@ module Bible270
 
     # Human labels for providers we know; anything else is titleised.
     PROVIDER_LABELS = {
-      github: "GitHub", gitlab: "GitLab", google_oauth2: "Google", google: "Google",
-      facebook: "Facebook", twitter: "Twitter", apple: "Apple", discord: "Discord",
-      microsoft_graph: "Microsoft", azure_activedirectory_v2: "Microsoft",
-      openid_connect: "OpenID Connect", saml: "SSO"
+      github: 'GitHub', gitlab: 'GitLab', google_oauth2: 'Google', google: 'Google',
+      facebook: 'Facebook', twitter: 'Twitter', apple: 'Apple', discord: 'Discord',
+      microsoft_graph: 'Microsoft', azure_activedirectory_v2: 'Microsoft',
+      openid_connect: 'OpenID Connect', saml: 'SSO'
     }.freeze
 
     def omniauth_providers=(list)
       @omniauth_providers = Array(list).map do |entry|
         key, label = entry.is_a?(Array) ? entry : [entry, nil]
         key = key.to_sym
-        [key, (label || PROVIDER_LABELS[key] || key.to_s.tr("_", " ").split.map(&:capitalize).join(" "))]
+        [key, label || PROVIDER_LABELS[key] || key.to_s.tr('_', ' ').split.map(&:capitalize).join(' ')]
       end
     end
 
@@ -81,12 +108,52 @@ module Bible270
 
     # Simple abuse guard: at most N links per address per window (seconds).
     attr_accessor :email_sign_in_window
-    attr_accessor :email_sign_in_max_per_window
+    attr_accessor :after_sign_out_path, :email_sign_in_max_per_window, :passage_url_builder, :tagline, :admin_emails, :admin_resolver
 
     # Whether a reader may type the display name shown beside their reflections
     # when signing in by email (otherwise it's derived from the address).
     attr_accessor :email_sign_in_ask_name
 
+    # Write the sign-in link to the log. nil (default) means development and test
+    # only; true forces it on, for smoke-testing a production build locally
+    # before mail is wired up; false disables it everywhere. The link is a bearer
+    # credential, so true is not for a deployment real users can reach.
+    attr_accessor :email_sign_in_log_link
+
+    # Require a first AND last name when signing in by email. Names identify
+    # people to each other beside their reflections, so this is on by default.
+    attr_accessor :email_sign_in_require_name
+
+    # Who may reach the admin panel. Either a list of email addresses, or a
+    # lambda taking the current reader and returning true/false:
+    #
+    #   config.admin_emails = %w[andrew@example.org]
+    #   config.admin_resolver = ->(reader) { reader.email.end_with?('@example.org') }
+    #
+    # With neither set the panel is unreachable and its routes 404.
+    # Break points set from the host app, overriding Plan::CHAPTER_BREAKS.
+    # Keys may be ['Psalm', 18] or 'Psalm 18'; [] keeps a chapter whole.
+    attr_accessor :chapter_breaks
+
+    # Optional YAML file holding the same thing, re-read whenever it changes so
+    # breaks can be tuned without restarting:
+    #
+    #   # config/bible270_breaks.yml
+    #   Psalm 35: []
+    #   Psalm 78: [20, 39, 55]
+    attr_accessor :chapter_breaks_path
+
+    def admin?(reader)
+      return false if reader.nil?
+      return !!admin_resolver.call(reader) if admin_resolver.respond_to?(:call)
+
+      Array(admin_emails).map { |e| e.to_s.downcase }.include?(reader.email.to_s.downcase)
+    end
+
+    def admin_configured?
+      admin_resolver.respond_to?(:call) || Array(admin_emails).any?
+    end
+
     # Send the sign-in email via Active Job (deliver_later) instead of inline.
     # Leave false unless you have a queue backend configured.
     attr_accessor :email_sign_in_deliver_later
@@ -104,16 +171,14 @@ module Bible270
       found = omniauth_providers.find { |k, _| k.to_s == key.to_s }
       return found.last if found
 
-      PROVIDER_LABELS[key.to_sym] || key.to_s.tr("_", " ").split.map(&:capitalize).join(" ")
+      PROVIDER_LABELS[key.to_sym] || key.to_s.tr('_', ' ').split.map(&:capitalize).join(' ')
     end
 
     # Default Bible translation and a builder for external passage links.
     attr_accessor :bible_version
-    attr_accessor :passage_url_builder
 
     # Public labels.
     attr_accessor :app_name
-    attr_accessor :tagline
 
     # Optional community-wide start date for the plan. Set this when everyone
     # reads together as a cohort (e.g. a church starting on a set Sunday):
@@ -132,30 +197,37 @@ module Bible270
     attr_accessor :require_sign_in_to_participate
 
     def initialize
-      @parent_controller = "ActionController::Base"
-      @layout = "bible270/application"
+      @parent_controller = 'ActionController::Base'
+      @layout = 'bible270/application'
       @current_reader_resolver = nil
       @after_sign_in_path = nil
       @after_sign_out_path = nil
-      @bible_version = "ESV"
-      @passage_url_builder = lambda do |reference, version|
+      @bible_version = 'NKJV'
+      @passage_url_builder = ->(reference, version) do
         search  = URI.encode_www_form_component(reference)
         version = URI.encode_www_form_component(version)
         "https://www.biblegateway.com/passage/?search=#{search}&version=#{version}"
       end
-      @app_name = "Daily Bread"
-      @tagline = "A 270-day journey through Scripture"
+      @app_name = 'Daily Bread'
+      @tagline = 'Journeying through Scripture in 9 months'
       @require_sign_in_to_participate = true
+      self.mount_at = '/daily-bread'
       @start_date = nil
       @allow_reader_start_date = true
       self.omniauth_providers = [:github]
       @omniauth_path_prefix = nil
       @email_sign_in = true
-      @mailer_from = "no-reply@example.com"
+      @mailer_from = 'no-reply@example.com'
       @email_sign_in_ttl = 20 * 60          # 20 minutes
       @email_sign_in_window = 15 * 60       # 15 minutes
       @email_sign_in_max_per_window = 5
       @email_sign_in_ask_name = true
+      @email_sign_in_require_name = true
+      @email_sign_in_log_link = nil
+      @chapter_breaks = {}
+      @chapter_breaks_path = nil
+      @admin_emails = []
+      @admin_resolver = nil
       @email_sign_in_deliver_later = false
     end
 

data/lib/bible270/email_sign_in.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "securerandom"
-require "digest"
+require 'securerandom'
+require 'digest'
 
 module Bible270
   # Pure helpers for passwordless ("magic link") email sign-in. Kept free of
@@ -11,14 +11,14 @@ module Bible270
   # digest of it, so a leaked database can't be used to sign in.
   module EmailSignIn
     # Deliberately permissive: real validation is "did the link get clicked".
-    EMAIL_RE = /\A[^@\s,;:<>"]+@[^@\s,;:<>"]+\.[A-Za-z]{2,}\z/
+    EMAIL_RE = %r{\A[^@\s,;:<>"]+@[^@\s,;:<>"]+\.[A-Za-z]{2,}\z}
 
-    module_function
+  module_function
 
     # Trim, strip a mailto:, and downcase. Returns nil for anything unusable.
     def normalize_email(value)
       email = value.to_s.strip
-      email = email[7..] if email.downcase.start_with?("mailto:")
+      email = email[7..] if email.downcase.start_with?('mailto:')
       email = email.strip.downcase
       return nil if email.empty?
       return nil unless email.match?(EMAIL_RE)
@@ -58,11 +58,11 @@ module Bible270
     # The part of an address we can use as a default display name:
     # "mary.anne.smith@example.com" => "Mary Anne Smith"
     def display_name_from(email)
-      local = normalize_email(email)&.split("@")&.first
+      local = normalize_email(email)&.split('@')&.first
       return nil if local.nil? || local.empty?
 
       # NB: the hyphen must come last or tr reads "_-+" as a range.
-      local.tr("._+-", " ").split.map { |w| w[0].upcase + (w[1..] || "") }.join(" ")
+      local.tr('._+-', ' ').split.map { |w| w[0].upcase + (w[1..] || '') }.join(' ')
     end
   end
 end

data/lib/bible270/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bible270
   class Engine < ::Rails::Engine
     isolate_namespace Bible270