Module: MaquinaStream::Export

Defined in:
lib/maquina_stream/export.rb

Overview

A whole message, back out as markdown.

MaquinaStream::Export.markdown(message) # => String

The buffer already is markdown, so export is mostly a question of what to do with the parts that are not clean:

  • A cancelled stream ends mid-token. The raw buffer would export a half written bold run or an unterminated fence, so the buffer is repaired first — the same preprocessor the renderer uses, so an export matches what was on screen.
  • Deferred content exports as its source, which is the Phase 6 fallback, decided once and applied everywhere. A diagram exports as its mermaid fence, verbatim, because that is what the model wrote and what another tool can read. There is nothing to substitute: rendering it would mean shipping the renderer to the server.

A status footer is appended for anything that did not finish, because a cancelled message that exports as though it were complete is a lie in a file somebody keeps.

Constant Summary collapse

INCOMPLETE =

The seal statuses that get a footer. :complete does not; neither does a stream that is still open, which exports as far as it has got.

%i[cancelled errored timed_out].freeze

Class Method Summary collapse

Class Method Details

.markdown(record, config: MaquinaStream.config, annotate: true) ⇒ Object

A whole message as markdown, as a String.

annotate: false suppresses the status footer — for a caller that is re-ingesting the text rather than handing a human a file, and that will carry the status some other way.

The footer comes from the maquina_stream.export.<status> locale key, falling back to > [status].



40
41
42
43
44
45
46
47
 
# File 'lib/maquina_stream/export.rb', line 40

def markdown(record, config: MaquinaStream.config, annotate: true)
  buffer = MaquinaRemend.call(record.maquina_stream_buffer.to_s)
  status = status_of(record)

  return buffer unless annotate && INCOMPLETE.include?(status)

  "#{buffer.rstrip}\n\n#{note_for(status, config)}\n"
end