Module: OllamaChat::PromptManagement

Included in:
Chat
Defined in:
lib/ollama_chat/prompt_management.rb

Overview

Provides administrative and interactive management for prompt templates stored in the database.

This module handles the user-facing selection process for prompts, allowing users to interactively pick a prompt from the database.

Instance Method Summary collapse

Instance Method Details

#add_new_prompt(context: nil) ⇒ self?

Interactively prompts the user for a name and content (optionally loading from a file) to create a new prompt template.

Returns:

  • (self, nil) —

    self if the prompt was added, nil if the process was cancelled



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ollama_chat/prompt_management.rb', line 95

def add_new_prompt(context: nil)
  context ||= 'prompt'
  switch_history(:prompt) do
    name = determine_valid_new_name_for_prompt('to add', context:) or return

    sources       = %w[ [CLIPBOARD] [FILES] [EMPTY/MANUAL] ]
    chosen_source = choose_entry(sources, prompt: 'Where shall we source the prompt from? %s')
    chosen_source or return

    content = case chosen_source
              when '[CLIPBOARD]'
                perform_paste_from_clipboard(edit: false)
              when '[FILES]'
                patterns = switch_history(:patterns) do
                  ask?(
                    prompt: "❓ Enter file patterns to load file, C-u ⇒ new, C-c ⇒ cancel: ",
                    prefill: '**/*.{txt,md}'
                  )
                end
                patterns.nil? ? (return) : (patterns.present? ? load_prompt_from_file(patterns) : nil)
              else
                nil
              end

    prompt_content = edit_text(content)
    store_prompt(name, prompt_content, context:)
    log(:info, "Prompt added", data: { name:, context: })
    self
  end
end

#all_prompts(default: nil, context: nil) ⇒ Array<SearchUI::Wrapper>

Retrieves all stored prompts, decorated with a heart if they are marked as favourites.

Parameters:

  • default (Boolean, nil) (defaults to: nil) —

    filter for default prompts (true: only defaults, false: only non-defaults)

Returns:

  • (Array<SearchUI::Wrapper>) —

    the list of prompts for display in a chooser



18
19
20
21
22
23
24
 
# File 'lib/ollama_chat/prompt_management.rb', line 18

def all_prompts(default: nil, context: nil)
  context ||= 'prompt'
  favs = all_favourited(context)
  each_prompt(context:, default:).sort_by(&:name).map do |p|
    prompt_with_favourite(p.name, favs[p.name])
  end
end

#choose_and_delete_prompt(context: nil, force: false) ⇒ Object

Interactively selects an existing non-default prompt and deletes it after confirmation.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ollama_chat/prompt_management.rb', line 128

def choose_and_delete_prompt(context: nil, force: false)
  context ||= 'prompt'
  selected_prompt = choose_prompt(
    default:  force ? nil : false,
    context:,
    prompt:  'Which template has outlived its usefulness? %s'
  ) or return
  STDOUT.puts kramdown_ansi_parse(
    selected_prompt.to_s + "\n---"
  )
  confirm?(
    prompt: "🔔 Really delete the prompt #{bold{selected_prompt.name}}? (y/n) ",
    yes: /\Ay/i
  ) or return
  selected_prompt.destroy
  log(:info, "Prompt deleted", data: { name: selected_prompt.name, context: })
end

#choose_and_edit_prompt(context: nil) ⇒ self?

Interactively selects an existing prompt and allows the user to edit its content via the integrated editor.

Returns:

  • (self, nil) —

    the current context on success, or nil if cancelled



150
151
152
153
154
155
156
157
 
# File 'lib/ollama_chat/prompt_management.rb', line 150

def choose_and_edit_prompt(context: nil)
  context ||= 'prompt'
  selected_prompt = choose_prompt(context:, prompt: 'Which spell needs some fine-tuning? %s') or return
  selected_prompt.metadata['content'] = edit_text(selected_prompt.metadata['content'].to_s)
  selected_prompt.save
  log(:info, "Prompt edited", data: { name: selected_prompt.name, context: })
  self
end

#choose_prompt(default: nil, context: nil, prompt: "Select a #{context || 'prompt'} template: %s") ⇒ OllamaChat::Database::Models::Prompt?

The choose_prompt method presents a menu of available prompts for selection. It retrieves the list of prompt names from the database, adds an '[EXIT]' option, and displays them via the Chooser utility.

Parameters:

  • default (Boolean, nil) (defaults to: nil) —

    filter for default prompts (true: only defaults, false: only non-defaults)

  • prompt (String) (defaults to: "Select a #{context || 'prompt'} template: %s") —

    the prompt message to display when asking for input

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ollama_chat/prompt_management.rb', line 57

def choose_prompt(default: nil, context: nil, prompt: "Select a #{context || 'prompt'} template: %s")
  context ||= 'prompt'
  prompts = all_prompts(default:, context:)
  prompts.unshift('[EXIT]')
  case chosen = choose_entry(prompts, prompt:)
  when '[EXIT]', nil
    STDOUT.puts "Exiting chooser."
    return
  when SearchUI::Wrapper
    prompt(chosen.value, context:)
  end
end

#choose_prompt_context ⇒ String?

The choose_prompt_context method presents a menu of available prompt contexts for selection. It allows the user to choose between 'prompt', 'system', and 'suggest' contexts.

Returns:

  • (String, nil) —

    the selected context name, or nil if the user cancels the selection.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/ollama_chat/prompt_management.rb', line 32

def choose_prompt_context
  contexts = models::Prompt.group(:context).order(:context).pluck(:context)
  contexts.unshift('[EXIT]')
  case chosen = choose_entry(
    contexts,
    prompt: '📝 Which prompt context shall we work in? %s'
  )
  when '[EXIT]', nil
    STDOUT.puts "Exiting chooser."
    return
  else
    chosen
  end
end

#determine_valid_new_name_for_prompt(action, context: nil) ⇒ String? (private)

Interactively determines a unique name for a new prompt, ensuring it does not conflict with existing prompts in the database.

The method loops until the user either provides a name that is not currently in use or cancels the operation.

Parameters:

  • action (String) —

    The action being performed (e.g., 'to import' or 'to duplicate as'), used to provide context in the user prompt.

Returns:

  • (String, nil) —

    The validated unique prompt name, or nil if the operation was cancelled.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/ollama_chat/prompt_management.rb', line 532

def determine_valid_new_name_for_prompt(action, context: nil)
  context ||= 'prompt'
  switch_history(:prompt) do
    prompt_name = nil
    loop do
      prompt_name = ask?(
        prompt: "❓ Enter new prompt name #{action}, C-c ⇒ cancel: "
      )
      if prompt_name.nil?
        STDOUT.puts "Cancelled."
        return nil
      end
      if prompt(prompt_name, context:)
        STDOUT.puts "Prompt named #{bold{prompt_name}} already exists."
      else
        break
      end
    end
    prompt_name
  end
end

#duplicate_prompt(context: nil) ⇒ self?

Duplicates an existing prompt.

This method initiates an interactive workflow:

  1. Prompts the user to select a prompt to clone.
  2. Displays the content of the selected prompt for verification.
  3. Requests a new name for the duplicate, validating that it does not already exist in the database.
  4. Creates and saves the new prompt record using the Database::Duplicatable mixin.

Returns:

  • (self, nil) —

    the current context on success, or nil if the user cancelled the operation or no prompt was selected.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ollama_chat/prompt_management.rb', line 170

def duplicate_prompt(context: nil)
  context ||= 'prompt'
  switch_history(:prompt) do
    selected_prompt = choose_prompt(context:, prompt: 'Which prompt shall be the basis for a new one? %s') or return
    STDOUT.puts kramdown_ansi_parse(
      selected_prompt.to_s + "\n---"
    )
    name = nil
    loop do
      name = ask?(
        prompt: "❓ Enter new prompt name to duplicate as, C-c ⇒ cancel: "
      )
      if name.nil?
        STDOUT.puts "Cancelled."
        return nil
      end
      if prompt(name, context:)
        STDOUT.puts "Prompt named #{bold{name}} already exists."
      else
        break
      end
    end
    duplicated_prompt = selected_prompt.duplicate
    duplicated_prompt.name = name
    duplicated_prompt.metadata['default'] = false
    duplicated_prompt.save
    log(:info, "Prompt duplicated", data: { name:, old_name: selected_prompt.name, context: })
    self
  end
end

#export_prompt(context: nil) ⇒ self?

Interactively exports a prompt to a specified file.

The process follows these steps:

  1. Prompts the user to select a prompt via choose_prompt.
  2. Displays the prompt's current content to the terminal.
  3. Prompts for a destination filename via determine_valid_output_filename.
  4. Writes the prompt content to the chosen file.

Returns:

  • (self, nil) —

    returns self if the export was successful, or nil if the process was cancelled during prompt selection or filename entry.



289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/ollama_chat/prompt_management.rb', line 289

def export_prompt(context: nil)
  context ||= 'prompt'
  selected_prompt = choose_prompt(context:, prompt: 'Which template are you exporting to disk? %s') or return
  STDOUT.puts kramdown_ansi_parse(
    selected_prompt.to_s + "\n---"
  )
  filename = determine_valid_output_filename('to write to') or return
  filename.write(selected_prompt.to_s)
  log(:info, "Prompt exported", data: { name: selected_prompt.name, dest: filename.to_s, context: })
  STDOUT.puts "Prompt #{selected_prompt.name.inspect} was exported as #{filename.to_path.inspect}?"
  self
end

#import_prompt(filename, context: nil) ⇒ self?

Interactively imports a prompt from a file.

The process follows these steps:

  1. Resolves the source file path (either using the provided filename or prompting the user to choose one).
  2. Prompts for a unique name for the new prompt via determine_valid_new_name_for_prompt.
  3. Reads the file content and stores it in the database.

Parameters:

  • filename (String, Pathname, nil) —

    the path to the file to import, or nil to trigger interactive file selection.

Returns:

  • (self, nil) —

    the current context on success, or nil if the import was cancelled.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ollama_chat/prompt_management.rb', line 255

def import_prompt(filename, context: nil)
  context ||= 'prompt'
  if filename
    if File.exist?(filename)
      filename = Pathname.new(filename)
    else
      filename = choose_filename(filename)
    end
  else
    filename = choose_filename('**/*.md')
  end
  unless filename
    STDOUT.puts "Cancelled."
    return
  end
  prompt_name = determine_valid_new_name_for_prompt('to import', context:) or return
  prompt_content = filename.read
  store_prompt(prompt_name, prompt_content, context:)
  log(:info, "Prompt imported", data: { name: prompt_name, source: filename.to_s, context: })
  STDOUT.puts "Imported prompt as #{prompt_name.inspect}."
  self
end

#info_prompt(context: nil) ⇒ self

Displays detailed information about a selected prompt template.

Returns:

  • (self) —

    the current context



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ollama_chat/prompt_management.rb', line 73

def info_prompt(context: nil)
  context ||= 'prompt'
  if selected_prompt = choose_prompt(context:, prompt: 'Which blueprint would you like to inspect? %s')
    use_pager do |output|
      output.puts kramdown_ansi_parse(<<~EOT)
        # Prompt #{selected_prompt.name}
        ---

        #{selected_prompt.to_s}

        ---
      EOT
    end
  end
  self
end

#list_prompts(context: nil) ⇒ Array

Lists all prompt templates in the database, indicating which are defaults and showing a truncated preview of their content.

Returns:

  • (Array) —

    the result of the prompt mapping



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/ollama_chat/prompt_management.rb', line 359

def list_prompts(context: nil)
  context ||= 'prompt'
  favs = all_favourited(context)
  each_prompt(context:).sort_by(&:name).map do |p|
    default = p.metadata['default'] ? '⛭' : '✎'
    start   = '%s %s' % [ default, bold { p.name } ]
    start   = prefix_favourite(start, favs[p.name])
    content = p.to_s.inspect[1..-2]
    content = Kramdown::ANSI::Width.truncate(
      content, length: 0.9 * (Tins::Terminal.columns - start.size)
    )
    STDOUT.print start
    STDOUT.puts ' %s' % italic { content }
  end
end

#prepare_conversation_history ⇒ String

Aggregates the current conversation history into a single string for context-aware generation.

Each message is formatted as "Sender Name: Message Content", skipping messages that contain no content.

Returns:

  • (String) —

    The flattened conversation history.



309
310
311
312
313
314
315
 
# File 'lib/ollama_chat/prompt_management.rb', line 309

def prepare_conversation_history
  messages.each_message.inject('') do |result, message|
    message_content = message.content.full? or next result
    sender_name     = sender_name_displayed(message, template: false)
    result << "%s: %s" % [ sender_name, message_content ]
  end
end

#prompt_sync(context: nil) ⇒ self?

Synchronizes database prompts with their shipped defaults from the configuration.

For each default prompt in the given context, compares the database copy against the shipped default. Drifted prompts are displayed as a unified diff (via OC::DIFF_COMMAND), and the user is offered an interactive resolution via OC::DIFF_TOOL.

Orphaned default prompts (present in the database but no longer in the shipped config) are listed and offered for deletion.

Parameters:

  • context (String, nil) (defaults to: nil) —

    the prompt context to sync (default: 'prompt')

Returns:

  • (self, nil) —

    self on success, nil if no drift was found



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/ollama_chat/prompt_management.rb', line 400

def prompt_sync(context: nil)
  context ||= 'prompt'
  shipped    = config.prompts[context].to_h.stringify_keys_recursive
  db_prompts = each_prompt(context:, default: true).to_a

  drifted = db_prompts.select do |p|
    shipped.key?(p.name) && shipped[p.name].to_s != p.to_s
  end

  orphans = db_prompts.select { |p| !shipped.key?(p.name) }

  if drifted.empty? && orphans.empty?
    STDOUT.puts "All prompts in context #{bold{context}} are in sync. ✨"
    return self
  end

  if drifted.any?
    STDOUT.puts "\n#{drifted.count} drifted prompt(s) found:\n"
    drifted.each { |p| STDOUT.puts "  • #{bold{p.name}} in #{italic{p.context}}" }
    STDOUT.puts
  end

  confirm?(prompt: '⏎  Press any key to continue (%s). ', timeout: 5)

  drifted.each do |p|
    show_prompt_diff(p, shipped[p.name], context:)
  end

  if orphans.any?
    STDOUT.puts "\n#{orphans.count} orphaned prompt(s) "\
               "(no longer in default config):\n"
    orphans.each { |p| STDOUT.puts "  • #{bold{p.name}} in #{italic{p.context}}" }
    STDOUT.puts
  end

  confirm?(prompt: '⏎  Press any key to continue (%s). ', timeout: 5)

  unless orphans.empty?
    STDOUT.puts
    if confirm?(
      prompt: "🧹 Remove #{orphans.count} orphaned prompt(s)? (y/n) ",
      yes: /\Ay/i
    )
    then
      orphans.each do |p|
        p.destroy
        STDOUT.puts "  ✓ Removed #{bold{p.name}}"
        log(:info, "Orphan prompt cleaned up", data: { name: p.name, context: })
      end
    end
  end

  self
end

#prompt_with_favourite(name, favourited) ⇒ SearchUI::Wrapper (private)

Helper to wrap a prompt name with its favourite status for the UI.

Parameters:

  • name (String) —

    the name of the prompt

  • favourited (Boolean) —

    whether the prompt is marked as a favourite

Returns:

  • (SearchUI::Wrapper) —

    a wrapper containing the original name and the decorated display string



463
464
465
466
 
# File 'lib/ollama_chat/prompt_management.rb', line 463

def prompt_with_favourite(name, favourited)
  display = prefix_favourite(name, favourited)
  SearchUI::Wrapper.new(name, display:)
end

#rename_prompt(context: nil) ⇒ self?

Interactively selects an existing prompt and renames it.

Returns:

  • (self, nil) —

    the current context on success, or nil if the user cancelled the operation or no prompt was selected.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ollama_chat/prompt_management.rb', line 205

def rename_prompt(context: nil)
  context ||= 'prompt'
  switch_history(:prompt) do
    selected_prompt = choose_prompt(
      prompt: 'Which prompt would you like to rename? %s',
      context:
    ) or return

    STDOUT.puts kramdown_ansi_parse(
      selected_prompt.to_s + "\n---"
    )

    name = nil
    loop do
      name = ask?(
        prompt: "❓ Enter new prompt name, C-c ⇒ cancel: "
      )
      if name.nil?
        STDOUT.puts "Cancelled."
        return nil
      end
      if name == selected_prompt.name
        STDOUT.puts "That is the current name."
      elsif prompt(name, context:)
        STDOUT.puts "Prompt named #{bold{name}} already exists."
      else
        break
      end
    end

    old_name = selected_prompt.name
    selected_prompt.name = name
    selected_prompt.save
    log(:info, "Prompt renamed", data: { old_name:, new_name: name, context: })
    self
  end
end

#reset_prompt_to_default(name, context: nil) ⇒ Boolean?

Resets a prompt's content to the default value defined in the configuration.

Parameters:

  • name (String, Symbol) —

    the name of the prompt to reset

Returns:

  • (Boolean, nil) —

    true if the prompt was reset, false if no default was found



379
380
381
382
383
384
385
 
# File 'lib/ollama_chat/prompt_management.rb', line 379

def reset_prompt_to_default(name, context: nil)
  context ||= 'prompt'
  if content = config.prompts.prompt[name.to_s]
    store_prompt(name, content, context:)
    true
  end
end

#show_prompt_diff(prompt, shipped, context:) ⇒ Object (private)

Writes the database copy and the shipped default to temp files and displays a unified diff via OC::DIFF_COMMAND.

If the user opts in, launches OC::DIFF_TOOL for interactive resolution; the resolved content (file A) is then written back to the database.

Parameters:



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/ollama_chat/prompt_management.rb', line 478

def show_prompt_diff(prompt, shipped, context:)
  STDOUT.puts "\n#{'─' * 60}"
  STDOUT.puts "📝 #{bold{prompt.name}}"
  STDOUT.puts '─' * 60

  Dir.mktmpdir('prompt_sync') do |dir|
    file_a = File.join(dir, "#{prompt.name}.local")
    file_b = File.join(dir, "#{prompt.name}.default")
    File.write(file_a, prompt.to_s)
    File.write(file_b, shipped.to_s)

    cmd    = OC::DIFF_COMMAND.dup << file_a << file_b
    output = IO.popen(cmd, &:read).chomp

    if output.empty?
      STDOUT.puts "  (no differences detected)"
    else
      STDOUT.puts output
    end

    STDOUT.puts
    if confirm?(
      prompt: "🔧 Resolve differences for #{bold{prompt.name}}? (y/n) ",
      yes: /\Ay/i
    )
    then
      unless diff_tool = OC::DIFF_TOOL?
        STDERR.puts '  No DIFF_TOOL available.'
        return
      end
      system(*[diff_tool, file_a, file_b].map(&:to_s))
      resolved = File.read(file_a)
      if resolved != prompt.to_s
        write_prompt(prompt.name, resolved, context:)
        STDOUT.puts "  ✓ Updated #{bold{prompt.name}}"
        log(:info, "Prompt synced via diff tool",
            data: { name: prompt.name, context: })
      else
        STDOUT.puts "  (no changes made)"
      end
    end
  end
end

#suggest_prompts(edit: false) ⇒ String?

Interactively generates follow-up prompt suggestions based on the current session.

This method constructs a prompt containing the conversation history and an instruction (either selected from a template or provided manually) and requests a generation from the AI model. The resulting suggestions are then opened in the editor for final refinement before being returned.

Parameters:

  • edit (Boolean) (defaults to: false) —

    If true, allows the user to write a custom suggestion instruction on the fly; otherwise, prompts the user to pick a template.

Returns:

  • (String, nil) —

    The refined suggestion text, or nil if the process was cancelled.



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ollama_chat/prompt_management.rb', line 330

def suggest_prompts(edit: false)
  instruction = nil
  if edit
    # Let the user write a suggestion instruction on the fly
    instruction = edit_text('').full? or return
  else
    # Let the user pick a prompt template (e.g., suggest_coding, suggest_roleplaying)
    instruction = choose_prompt(
      prompt: 'Which suggestion strategy shall we employ? %s',
      context: 'suggest'
    ) or return
  end

  # Build the context by gathering all current conversation messages
  history     = prepare_conversation_history
  template    = prompt('context_template_suggest', context: 'prompt').to_s
  full_prompt = template % { history:, instruction: }

  # Execute a silent chat oneshot call (doesn't add to history)
  suggestions = generate(prompt: full_prompt).full? or return

  # Pass the AI's suggestions through the editor for final refinement
  edit_text(suggestions)
end