Collapse plain-text formatter into a context option

Same pattern as the static-HTML collapse: the `markdown_as_text` format
symbol was a thin subclass setting a context flag and swapping the filter
list. Replace it with `plain_text: true` on the existing rich formatter,
which now picks between `RICH_FILTERS` and `TEXT_FILTERS` constants based
on the flag. `static_html:` and `plain_text:` now sit as peer options on
one format.

Rename the `as_text` context key to `plain_text` for symmetry with
`static_html`. Update both mailer `.text.erb` views and the two handler
predicates that branch on the flag.

Author: akabiru

app/views/work_package_mailer/mentioned.text.erb

@@ -10,7 +10,7 @@
 <%= I18n.t(:label_comment_added) %>:
 <%= format_text(
       @journal.notes,
-      format: :markdown_as_text,
+      plain_text: true,
       only_path: false,
       object: @work_package,
       project: @work_package.project

app/views/work_package_mailer/watcher_changed.text.erb

@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
 <%= render partial: "work_package_details", locals: { work_package: @work_package } %>
 <%= format_text(
       t(:text_latest_note, note: last_work_package_note(@work_package)),
-      format: :markdown_as_text,
+      plain_text: true,
       only_path: false,
       object: @work_package,
       project: @work_package.project

lib/open_project/text_formatting/filters/mention_filter.rb

@@ -124,7 +124,7 @@ def work_package_mention(work_package, mention)
       # The hover-card endpoint a quickinfo would link to is unreachable
       # for plain-text recipients and for viewers without view permission.
       def text_only?(work_package)
-        context[:as_text] || @visible_mentioned_ids.exclude?(work_package.id)
+        context[:plain_text] || @visible_mentioned_ids.exclude?(work_package.id)
       end
 
       def work_package_quickinfo(work_package, detailed:)

lib/open_project/text_formatting/filters/plain_text_output_filter.rb

@@ -30,8 +30,8 @@
 
 module OpenProject::TextFormatting
   module Filters
-    # Final stage of the `markdown_as_text` pipeline — strips remaining
-    # markup so the output is safe for `text/plain` bodies.
+    # Terminal stage when the rich pipeline is rendering for `text/plain`
+    # bodies — collapses the DOM to its visible text so no HTML escapes.
     class PlainTextOutputFilter < HTML::Pipeline::Filter
       def call
         doc.text

lib/open_project/text_formatting/formats/markdown/formatter.rb

@@ -31,37 +31,53 @@
 
 module OpenProject::TextFormatting::Formats::Markdown
   class Formatter < OpenProject::TextFormatting::Formats::BaseFormatter
+    RICH_FILTERS = [
+      OpenProject::TextFormatting::Filters::SettingMacrosFilter,
+      OpenProject::TextFormatting::Filters::MarkdownFilter,
+      OpenProject::TextFormatting::Filters::SanitizationFilter,
+      OpenProject::TextFormatting::Filters::TaskListFilter,
+      OpenProject::TextFormatting::Filters::TableOfContentsFilter,
+      OpenProject::TextFormatting::Filters::MacroFilter,
+      OpenProject::TextFormatting::Filters::MentionFilter,
+      OpenProject::TextFormatting::Filters::PatternMatcherFilter,
+      OpenProject::TextFormatting::Filters::SyntaxHighlightFilter,
+      OpenProject::TextFormatting::Filters::AttachmentFilter,
+      OpenProject::TextFormatting::Filters::AutolinkFilter,
+      OpenProject::TextFormatting::Filters::AutolinkCustomProtocolsFilter,
+      OpenProject::TextFormatting::Filters::RelativeLinkFilter,
+      OpenProject::TextFormatting::Filters::LinkAttributeFilter,
+      OpenProject::TextFormatting::Filters::ExternalLinkCaptureFilter,
+      OpenProject::TextFormatting::Filters::FigureWrappedFilter,
+      OpenProject::TextFormatting::Filters::BemCssFilter
+    ].freeze
+
+    # `text/plain` mailer bodies share the matcher and mention stages so
+    # work-package references resolve consistently with the HTML channel,
+    # then `PlainTextOutputFilter` collapses the DOM to text. Filters that
+    # only shape HTML (TOC, syntax highlight, autolink, link-attribute,
+    # figure, BEM) are omitted because `doc.text` would discard their work.
+    TEXT_FILTERS = [
+      OpenProject::TextFormatting::Filters::SettingMacrosFilter,
+      OpenProject::TextFormatting::Filters::MarkdownFilter,
+      OpenProject::TextFormatting::Filters::SanitizationFilter,
+      OpenProject::TextFormatting::Filters::MentionFilter,
+      OpenProject::TextFormatting::Filters::PatternMatcherFilter,
+      OpenProject::TextFormatting::Filters::PlainTextOutputFilter
+    ].freeze
+
     def to_html(text)
       result = pipeline.call(text, context)
       output = result[:output].to_s
 
-      output.html_safe
+      context[:plain_text] ? output : output.html_safe # rubocop:disable Rails/OutputSafety
     end
 
     def to_document(text)
       pipeline.to_document text, context
     end
 
     def filters
-      [
-        OpenProject::TextFormatting::Filters::SettingMacrosFilter,
-        OpenProject::TextFormatting::Filters::MarkdownFilter,
-        OpenProject::TextFormatting::Filters::SanitizationFilter,
-        OpenProject::TextFormatting::Filters::TaskListFilter,
-        OpenProject::TextFormatting::Filters::TableOfContentsFilter,
-        OpenProject::TextFormatting::Filters::MacroFilter,
-        OpenProject::TextFormatting::Filters::MentionFilter,
-        OpenProject::TextFormatting::Filters::PatternMatcherFilter,
-        OpenProject::TextFormatting::Filters::SyntaxHighlightFilter,
-        OpenProject::TextFormatting::Filters::AttachmentFilter,
-        OpenProject::TextFormatting::Filters::AutolinkFilter,
-        OpenProject::TextFormatting::Filters::AutolinkCustomProtocolsFilter,
-        OpenProject::TextFormatting::Filters::RelativeLinkFilter,
-        OpenProject::TextFormatting::Filters::LinkAttributeFilter,
-        OpenProject::TextFormatting::Filters::ExternalLinkCaptureFilter,
-        OpenProject::TextFormatting::Filters::FigureWrappedFilter,
-        OpenProject::TextFormatting::Filters::BemCssFilter
-      ]
+      context[:plain_text] ? TEXT_FILTERS : RICH_FILTERS
     end
 
     def self.format

lib/open_project/text_formatting/formats/markdown/text_formatter.rb

@@ -142,7 +142,7 @@ def render_work_package_link(work_package, fallback_id:)
       # A nil WP means classic mode skipped the preload, or the reference
       # didn't resolve — neither case needs visibility gating.
       def text_only?(work_package)
-        context[:as_text] || (work_package && !preload_cache.visible?(work_package.id))
+        context[:plain_text] || (work_package && !preload_cache.visible?(work_package.id))
       end
 
       def preload_cache

lib/open_project/text_formatting/matchers/link_handlers/work_packages.rb

@@ -49,14 +49,12 @@ def format_text(text, format: :rich, **context)
         .to_html(text)
     end
 
-    # @param [:plain, :markdown_as_text, :rich] format the text format.
+    # @param [:plain, :rich] format the text format.
     # @return [Formats::BaseFormatter] a formatter implementation.
     def formatter_for(format)
       case format.to_sym
       when :plain
         Formats.plain_formatter
-      when :markdown_as_text
-        Formats::Markdown::TextFormatter
       else
         Formats.rich_formatter
       end

lib/open_project/text_formatting/renderer.rb

@@ -204,17 +204,17 @@ def mention_tag(work_package, sep: "#", data_id: nil, data_text: nil)
 
     context "in plain-text rendering mode",
             with_settings: { work_packages_identifier: "semantic" } do
-      # The `:markdown_as_text` channel must collapse mention envelopes
-      # to their current `formatted_id` so the plain-text mailer doesn't
-      # leak `<mention>` HTML or stale envelope text.
+      # `plain_text: true` must collapse mention envelopes to their current
+      # `formatted_id` so the `text/plain` mailer doesn't leak `<mention>`
+      # HTML or stale envelope text.
       let(:project) { create(:project, identifier: "MACROPROJ") }
       let(:work_package) { create(:work_package, project:, author:) }
 
       before { work_package.allocate_and_register_semantic_id }
 
       it "renders the formatted_id without an anchor or quickinfo" do
         wp = work_package.reload
-        rendered = format_text(mention_tag(wp), format: :markdown_as_text)
+        rendered = format_text(mention_tag(wp), plain_text: true)
 
         expect(rendered).to include(wp.formatted_id)
         expect(rendered).not_to include("<a")
@@ -229,7 +229,7 @@ def mention_tag(work_package, sep: "#", data_id: nil, data_text: nil)
       let(:work_package) { create(:work_package, project:, author:) }
 
       it "renders the hash-prefixed numeric id without an anchor or quickinfo" do
-        rendered = format_text(mention_tag(work_package), format: :markdown_as_text)
+        rendered = format_text(mention_tag(work_package), plain_text: true)
 
         expect(rendered).to include("##{work_package.id}")
         expect(rendered).not_to include("<a")

spec/lib/open_project/text_formatting/filters/mention_filter_spec.rb

@@ -30,10 +30,12 @@
 
 require "spec_helper"
 
-RSpec.describe OpenProject::TextFormatting::Formats::Markdown::TextFormatter do
-  subject(:formatted) { described_class.new(context).to_html(input).strip }
+RSpec.describe "Markdown plain-text rendering" do # rubocop:disable RSpec/DescribeClass
+  subject(:formatted) { render(input).strip }
 
-  let(:context) { {} }
+  def render(text)
+    OpenProject::TextFormatting::Renderer.format_text(text, plain_text: true)
+  end
 
   describe "plain markdown" do
     let(:input) { "Hello *world*" }
@@ -85,26 +87,22 @@
       end
 
       it "renders ##N as bare semantic identifier" do
-        input = "see #{'##'}#{work_package.id} please"
-        expect(described_class.new({}).to_html(input).strip).to eq("see DEMO-1 please")
+        expect(render("see #{'##'}#{work_package.id} please").strip).to eq("see DEMO-1 please")
       end
 
       it "renders ###N as bare semantic identifier" do
-        input = "see #{'###'}#{work_package.id} please"
-        expect(described_class.new({}).to_html(input).strip).to eq("see DEMO-1 please")
+        expect(render("see #{'###'}#{work_package.id} please").strip).to eq("see DEMO-1 please")
       end
     end
 
     context "in classic mode",
             with_settings: { work_packages_identifier: "classic" } do
       it "renders ##N as the hash-prefixed numeric id" do
-        input = "see #{'##'}#{work_package.id} please"
-        expect(described_class.new({}).to_html(input).strip).to eq("see ##{work_package.id} please")
+        expect(render("see #{'##'}#{work_package.id} please").strip).to eq("see ##{work_package.id} please")
       end
 
       it "renders ###N as the hash-prefixed numeric id" do
-        input = "see #{'###'}#{work_package.id} please"
-        expect(described_class.new({}).to_html(input).strip).to eq("see ##{work_package.id} please")
+        expect(render("see #{'###'}#{work_package.id} please").strip).to eq("see ##{work_package.id} please")
       end
     end
   end