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 ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ollama_chat/prompt_management.rb', line 68

def add_new_prompt
  switch_history(:add_prompt) do
    name = nil
    loop do
      name = ask?(
        prompt: "❓ Enter new system prompt name to add, C-c ⇒ cancel: "
      )
      if name.nil?
        STDOUT.puts "Cancelled."
        return nil
      end
      if prompt(name)
        STDOUT.puts "Prompt named #{bold{name}} already exists."
      else
        break
      end
    end
    patterns = ask?(
      prompt: "❓ Enter file patterns to load file, C-u ⇒ new, C-c ⇒ cancel: ",
      prefill: '**/*.{txt,md}'
    )
    patterns.nil? and return
    content = nil
    patterns.present? and content = load_prompt_from_file(patterns)
    prompt = edit_text(content)
    store_prompt(name, prompt).to_s
    true
  end
end

#all_prompts(default: 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



16
17
18
19
20
21
 
# File 'lib/ollama_chat/prompt_management.rb', line 16

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

#choose_and_delete_prompt ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ollama_chat/prompt_management.rb', line 100

def choose_and_delete_prompt
  prompt = choose_prompt(default: false) or return
  STDOUT.puts kramdown_ansi_parse(
    prompt.to_s + "\n---"
  )
  confirm?(
    prompt: "🔔 Really delete the prompt #{bold{prompt.name}}? (y/n) ",
    yes: /\Ay/i
  ) or return
  prompt.destroy
end

#choose_and_edit_prompt ⇒ 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



116
117
118
119
120
121
 
# File 'lib/ollama_chat/prompt_management.rb', line 116

def choose_and_edit_prompt
  prompt = choose_prompt or return
  prompt.metadata['content'] = edit_text(prompt.metadata['content'].to_s)
  prompt.save
  self
end

#choose_prompt(default: nil) ⇒ 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)

Returns:



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

def choose_prompt(default: nil)
  prompts = all_prompts(default: default)
  prompts.unshift('[EXIT]')
  case chosen = choose_entry(prompts)
  when '[EXIT]', nil
    STDOUT.puts "Exiting chooser."
    return
  when SearchUI::Wrapper
    prompt(chosen.value)
  end
end

#duplicate_prompt ⇒ 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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/ollama_chat/prompt_management.rb', line 134

def duplicate_prompt
  prompt = choose_prompt or return
  STDOUT.puts kramdown_ansi_parse(
    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)
      STDOUT.puts "Prompt named #{bold{name}} already exists."
    else
      break
    end
  end
  duplicated_prompt = prompt.duplicate
  duplicated_prompt.name = name
  duplicated_prompt.metadata['default'] = false
  duplicated_prompt.save
  self
end

#export_prompt ⇒ 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`.

  1. 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.



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/ollama_chat/prompt_management.rb', line 205

def export_prompt
  prompt = choose_prompt or return
  STDOUT.puts kramdown_ansi_parse(
    prompt.to_s + "\n---"
  )
  filename = determine_valid_output_filename('to write to') or return
  filename.write(prompt.to_s)
  STDOUT.puts "Prompt #{prompt.name.inspect} was exported as #{filename.to_path.inspect}?"
  self
end

#import_prompt(filename) ⇒ 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.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/ollama_chat/prompt_management.rb', line 173

def import_prompt(filename)
  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') or return
  prompt = filename.read
  store_prompt(prompt_name, prompt)
  STDOUT.puts "Imported prompt as #{prompt_name.inspect}."
  self
end

#info_prompt ⇒ self?

Displays detailed information about a selected prompt template.

Returns:

  • (self, nil) —

    the current context on success, or nil if cancelled



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/ollama_chat/prompt_management.rb', line 47

def info_prompt
  if prompt = choose_prompt
    use_pager do |output|
      output.puts kramdown_ansi_parse(<<~EOT)
        # Prompt #{prompt.name}
        ---

        #{prompt.to_s}

        ---
      EOT
    end
  end
  self
end

#list_prompts ⇒ 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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ollama_chat/prompt_management.rb', line 220

def list_prompts
  favs = all_favourited('prompt')
  each_prompt.sort_by(&:name).map do |prompt|
    default = prompt.metadata['default'] ? '⛭' : '✎'
    start   = '%s %s' % [ default, bold { prompt.name } ]
    start   = prefix_favourite(start, favs[prompt.name])
    content = prompt.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

#reset_prompt_to_default(name) ⇒ 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) —

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



239
240
241
242
243
244
 
# File 'lib/ollama_chat/prompt_management.rb', line 239

def reset_prompt_to_default(name)
  if content = config.prompts[name.to_s]
    store_prompt(name, content)
    true
  end
end