aia 0.3.19 → 0.4.1

data/lib/aia/prompt.rb

@@ -0,0 +1,267 @@
+# lib/aia/prompt.rb
+
+require 'reline'
+
+class AIA::Prompt
+  #
+  # used when no prompt_id is provided but there
+  # are extra parameters that need to be passed
+  # to the backend.  For example "aia -- --settings"
+  #
+  class Fake
+    def id          = '_fake_'
+    def path        = '_fake_'
+    def keywords    = []
+    def directives  = []
+    def to_s        = ''
+  end
+
+  KW_HISTORY_MAX = 5
+
+  attr_reader :prompt
+
+  # setting build: false supports unit testing.
+  def initialize(build: true)
+    get_prompt
+
+    process_prompt if build
+  end
+
+
+  # Fetch the first argument which should be the prompt id
+  def get_prompt
+    prompt_id = AIA.config.arguments.shift
+
+    unless prompt_id
+      if AIA.config.extra.empty?
+        abort("Please provide a prompt id") 
+      else
+        @prompt = Fake.new
+        return
+      end
+    end
+
+    search_for_a_matching_prompt(prompt_id) unless existing_prompt?(prompt_id)
+    edit_prompt if AIA.config.edit?
+  end
+
+
+  # Check if a prompt with the given id already exists.  If so, use it.
+  def existing_prompt?(prompt_id)
+    @prompt = PromptManager::Prompt.get(id: prompt_id)
+    true
+  rescue ArgumentError
+    false
+  end
+
+
+  # Process the prompt's associated keywords and parameters
+  def process_prompt
+    unless @prompt.keywords.empty?
+      replace_keywords
+      @prompt.build
+      @prompt.save
+    end
+  end
+
+
+  def replace_keywords
+    puts
+    puts "ID: #{@prompt.id}"
+    
+    show_prompt_without_comments
+
+    puts "\nPress up/down arrow to scroll through history."
+    puts "Type new input or edit the current input."
+    puts  "Quit #{MY_NAME} with a CNTL-D or a CNTL-C"
+    puts
+    @prompt.keywords.each do |kw|
+      value = keyword_value(kw, @prompt.parameters[kw])
+      
+      unless value.nil? || value.strip.empty?
+        value_inx = @prompt.parameters[kw].index(value)
+        
+        if value_inx
+          @prompt.parameters[kw].delete_at(value_inx)
+        end
+
+        # The most recent value for this kw will always be
+        # in the last position
+        @prompt.parameters[kw] << value
+        @prompt.parameters[kw].shift if @prompt.parameters[kw].size > KW_HISTORY_MAX
+      end
+    end
+  end
+
+
+  # Function to setup the Reline history with a maximum depth
+  def setup_reline_history(max_history_size=5)
+    Reline::HISTORY.clear
+    # Reline::HISTORY.max_size = max_history_size
+  end
+
+
+  # Function to prompt the user with a question using reline
+  def ask_question_with_reline(prompt)
+    answer = Reline.readline(prompt)
+    Reline::HISTORY.push(answer) unless answer.nil? || Reline::HISTORY.to_a.include?(answer)
+    answer
+    rescue Interrupt
+      ''
+  end
+
+
+  # query the user for a value to the keyword allow the
+  # reuse of the previous value shown as the default
+  #
+  # FIXME:  Ruby v3.3.0 drops readline in favor or reline
+  #         internally it redirects "require 'readline'" to Reline
+  #         puts lipstick on the pig so that you can continue to
+  #         use the Readline namespace
+  #
+  def keyword_value(kw, history_array)
+    setup_reline_history
+    
+    default = history_array.last
+
+    Array(history_array).each { |entry| Reline::HISTORY.push(entry) unless entry.nil? || entry.empty? }
+
+    puts "Parameter #{kw} ..."
+
+    if default.empty?
+      user_prompt = "\n-=> "
+    else
+      user_prompt = "\n(#{default}) -=>"
+    end
+
+    a_string = ask_question_with_reline(user_prompt)
+
+    if a_string.nil?
+      puts "okay. Come back soon."
+      exit
+    end
+
+    puts
+    a_string.empty? ? default : a_string
+  end
+
+
+  # Search for a prompt with a matching id or keyword
+  def search_for_a_matching_prompt(prompt_id)
+    # TODO: using the rgfzf version of the search_proc should only
+    #       return a single prompt_id
+    found_prompts = PromptManager::Prompt.search(prompt_id)
+
+    if found_prompts.empty?
+      if AIA.config.edit?
+        create_prompt(prompt_id)
+        edit_prompt
+      else
+        abort <<~EOS
+          
+          No prompts where found for: #{prompt_id}
+          To create a prompt with this ID use the --edit option
+          like this:
+            #{MY_NAME} #{prompt_id} --edit
+
+        EOS
+      end
+    else    
+      prompt_id     = 1 == found_prompts.size ? found_prompts.first : handle_multiple_prompts(found_prompts, prompt_id)
+      @prompt       = PromptManager::Prompt.get(id: prompt_id)
+    end
+  end
+
+
+  def handle_multiple_prompts(found_these, while_looking_for_this)
+    raise ArgumentError, "Argument is not an Array" unless found_these.is_a?(Array)
+    
+    # TODO: Make this a class constant for defaults; make the header content
+    #       a parameter so it can be varied.
+    fzf_options       = [
+      "--tabstop=2",  # 2 soaces for a tab
+      "--header='Prompt IDs which contain: #{while_looking_for_this}\nPress ESC to cancel.'",
+      "--header-first",
+      "--prompt='Search term: '",
+      '--delimiter :',
+      "--preview 'cat $PROMPTS_DIR/{1}.txt'",
+      "--preview-window=down:50%:wrap"
+    ].join(' ') 
+
+
+    # Create a temporary file to hold the list of strings
+    temp_file = Tempfile.new('fzf-input')
+
+    begin
+      # Write all strings to the temp file
+      temp_file.puts(found_these)
+      temp_file.close
+
+      # Execute fzf command-line utility to allow selection
+      selected = `cat #{temp_file.path} | fzf #{fzf_options}`.strip
+
+      # Check if fzf actually returned a string; if not, return nil
+      result = selected.empty? ? nil : selected
+    ensure
+      # Ensure that the tempfile is closed and unlinked
+      temp_file.unlink
+    end
+
+    exit unless result
+
+    result
+  end
+
+
+  def create_prompt(prompt_id)
+    @prompt = PromptManager::Prompt.create(id: prompt_id)
+    # TODO: consider a configurable prompt template
+    #       ERB ???
+  end
+
+
+  def edit_prompt
+    # FIXME: replace with the editor from the configuration
+    
+    @editor   = AIA::Subl.new(
+                  file: @prompt.path
+                )
+    
+    @editor.run # blocks until file is closed
+
+    AIA.config[:edit?] = false # turn off the --edit switch
+
+    # reload the edited prompt
+    @prompt = PromptManager::Prompt.get(id: @prompt.id)
+  end
+
+
+  def show_prompt_without_comments
+    puts remove_comments.wrap(indent: 4)
+  end
+
+
+  # removes comments and directives
+  def remove_comments
+    lines           = @prompt.text
+                        .split("\n")
+                        .reject{|a_line| 
+                          a_line.strip.start_with?('#') ||
+                          a_line.strip.start_with?('//')
+                        }
+
+    # Remove empty lines at the start of the prompt
+    #
+    lines = lines.drop_while(&:empty?)
+
+    # Drop all the lines at __END__ and after
+    #
+    logical_end_inx = lines.index("__END__")
+
+    if logical_end_inx
+      lines[0...logical_end_inx] # NOTE: ... means to not include last index
+    else
+      lines
+    end.join("\n") 
+  end
+end

data/lib/aia/tools/backend_common.rb

@@ -0,0 +1,76 @@
+# aia/lib/aia/tools/backend_common.rb
+
+# Used by both the AIA::Mods and AIA::Sgpt classes
+
+module AIA::BackendCommon
+  attr_accessor :command, :text, :files, :parameters
+
+  def initialize(text: "", files: [])
+    @text       = text
+    @files      = files
+    @parameters = self.class::DEFAULT_PARAMETERS.dup
+    build_command
+  end
+
+  def sanitize(input)
+    Shellwords.escape(input)
+  end
+  def build_command
+    @parameters += " --model #{AIA.config.model} " if AIA.config.model
+    @parameters += AIA.config.extra
+
+    set_parameter_from_directives
+
+    @command = "#{meta.name} #{@parameters} "
+    @command += sanitize(text)
+
+    puts @command if AIA.config.debug?
+
+    @command
+  end
+
+  def set_parameter_from_directives
+    AIA.config.directives.each do |entry|
+      directive, value = entry
+      if self.class::DIRECTIVES.include?(directive)
+        @parameters += " --#{directive} #{sanitize(value)}" unless @parameters.include?(directive)
+      end
+    end
+  end
+
+  def run
+    case @files.size
+    when 0
+      @result = `#{build_command}`
+    when 1
+      @result = `#{build_command} < #{@files.first}`
+    else
+      create_temp_file_with_contexts
+      run_with_temp_file
+      clean_up_temp_file
+    end
+
+    @result
+  end
+
+  def create_temp_file_with_contexts
+    @temp_file = Tempfile.new("#{self.class::COMMAND_NAME}-context")
+
+    @files.each do |file|
+      content = File.read(file)
+      @temp_file.write(content)
+      @temp_file.write("\n")
+    end
+
+    @temp_file.close
+  end
+
+  def run_with_temp_file
+    command = "#{build_command} < #{@temp_file.path}"
+    @result = `#{command}`
+  end
+
+  def clean_up_temp_file
+    @temp_file.unlink if @temp_file
+  end
+end

data/lib/aia/tools/editor.rb

@@ -4,19 +4,21 @@
 
 
 class AIA::Editor < AIA::Tools
+
+  meta(
+    name:     'editor',
+    role:     :editor,
+    desc:     "Your default system $EDITOR",
+    url:      "unknown",
+    install:  "should already be installed",
+  )
+
   DEFAULT_PARAMETERS = ""
   
   attr_accessor :command
 
 
-  def initialize(file: "")
-    super
-    
-    @role         = :editor
-    @description  = "Your default system $EDITOR"
-    @url          = "unknown"
-    @install      = "should already be installed"
-
+  def initialize(file: "")    
     @file     = file
 
     discover_editor
@@ -39,7 +41,7 @@ class AIA::Editor < AIA::Tools
 
 
   def build_command
-    @command = "#{name} #{DEFAULT_PARAMETERS} #{@file}"
+    @command = "#{meta.name} #{DEFAULT_PARAMETERS} #{@file}"
   end
 
   

data/lib/aia/tools/mods.rb

@@ -1,115 +1,81 @@
 # lib/aia/tools/mods.rb
 
-class AIA::Mods < AIA::Tools
-  DEFAULT_PARAMETERS = [
-    "--no-limit"              # no limit on input context
-  ].join(' ').freeze
-
-  attr_accessor :command, :extra_options, :text, :files
+require_relative 'backend_common'
 
-  # TODO: put the prompt text to be resolved into a 
-  #       temporary text file then cat that file into mods.
-  #       This will keep from polluting the CLI history with
-  #       lots of text
+class AIA::Mods < AIA::Tools
+  include AIA::BackendCommon
 
+  meta(
+    name:     'mods',
+    role:     :backend,
+    desc:     'AI on the command-line',
+    url:      'https://github.com/charmbracelet/mods',
+    install:  'brew install mods',
+  )
 
-  def initialize(
-      extra_options:  "", # everything after -- on command line
-      text:           "", # prompt text after keyword replacement
-      files:          []  # context file paths (Array of Pathname)
-    )
-    super
-    @role         = :gen_ai
-    @description  = 'AI on the command-line'
-    @url          = 'https://github.com/charmbracelet/mods'
   
-    @extra_options  = extra_options
-    @text           = text
-    @files          = files
-
-    build_command
-  end
-
-
-  def build_command
-    parameters  = DEFAULT_PARAMETERS.dup + " "
-    parameters += "-f "                     if ::AIA.config.markdown?
-    parameters += "-m #{AIA.config.model} " if ::AIA.config.model
-    parameters += @extra_options
-    @command    = "mods #{parameters} "
-    @command   += %Q["#{@text}"]        # TODO: consider using the pipeline
-
-    @files.each {|f| @command += " < #{f}" }
-
-    @command
-  end
+  DEFAULT_PARAMETERS = [
+    # "--no-cache",           # do not save prompt and response
+    "--no-limit"              # no limit on input context
+  ].join(' ').freeze
 
 
-  def run
-    `#{command}`
-  end
+  DIRECTIVES = %w[
+    api        
+    fanciness  
+    http-proxy 
+    max-retries
+    max-tokens 
+    no-cache
+    no-limit  
+    quiet      
+    raw        
+    status-text
+    temp       
+    title      
+    topp       
+  ]
 end
 
 __END__
 
 
-  # Execute the command and log the results
-  def send_prompt_to_external_command
-    command = build_command
-
-    puts command if verbose?
-    @result = `#{command}`
-
-    if @output.nil?
-      puts @result
-    else
-      @output.write @result
-    end
-
-    @result
-  end
-
-
-
-
-
 ##########################################################
 
-
 GPT on the command line. Built for pipelines.
 
 Usage:
   mods [OPTIONS] [PREFIX TERM]
 
 Options:
-  -m, --model                                  Default model (gpt-3.5-turbo, gpt-4, ggml-gpt4all-j...).
-  -a, --api                                    OpenAI compatible REST API (openai, localai).
-  -x, --http-proxy                             HTTP proxy to use for API requests.
-  -f, --format                                 Ask for the response to be formatted as markdown unless otherwise set.
-  -r, --raw                                    Render output as raw text when connected to a TTY.
-  -P, --prompt                                 Include the prompt from the arguments and stdin, truncate stdin to specified number of lines.
-  -p, --prompt-args                            Include the prompt from the arguments in the response.
-  -c, --continue                               Continue from the last response or a given save title.
-  -C, --continue-last                          Continue from the last response.
-  -l, --list                                   Lists saved conversations.
-  -t, --title                                  Saves the current conversation with the given title.
-  -d, --delete                                 Deletes a saved conversation with the given title or ID.
-  -s, --show                                   Show a saved conversation with the given title or ID.
-  -S, --show-last                              Show a the last saved conversation.
-  -q, --quiet                                  Quiet mode (hide the spinner while loading and stderr messages for success).
-  -h, --help                                   Show help and exit.
-  -v, --version                                Show version and exit.
-  --max-retries                                Maximum number of times to retry API calls.
-  --no-limit                                   Turn off the client-side limit on the size of the input into the model.
-  --max-tokens                                 Maximum number of tokens in response.
-  --temp                                       Temperature (randomness) of results, from 0.0 to 2.0.
-  --topp                                       TopP, an alternative to temperature that narrows response, from 0.0 to 1.0.
-  --fanciness                                  Your desired level of fanciness.
-  --status-text                                Text to show while generating.
-  --no-cache                                   Disables caching of the prompt/response.
-  --reset-settings                             Backup your old settings file and reset everything to the defaults.
-  --settings                                   Open settings in your $EDITOR.
-  --dirs                                       Print the directories in which mods store its data
+  -m, --model           Default model (gpt-3.5-turbo, gpt-4, ggml-gpt4all-j...).
+  -a, --api             OpenAI compatible REST API (openai, localai).
+  -x, --http-proxy      HTTP proxy to use for API requests.
+  -f, --format          Ask for the response to be formatted as markdown unless otherwise set.
+  -r, --raw             Render output as raw text when connected to a TTY.
+  -P, --prompt          Include the prompt from the arguments and stdin, truncate stdin to specified number of lines.
+  -p, --prompt-args     Include the prompt from the arguments in the response.
+  -c, --continue        Continue from the last response or a given save title.
+  -C, --continue-last   Continue from the last response.
+  -l, --list            Lists saved conversations.
+  -t, --title           Saves the current conversation with the given title.
+  -d, --delete          Deletes a saved conversation with the given title or ID.
+  -s, --show            Show a saved conversation with the given title or ID.
+  -S, --show-last       Show a the last saved conversation.
+  -q, --quiet           Quiet mode (hide the spinner while loading and stderr messages for success).
+  -h, --help            Show help and exit.
+  -v, --version         Show version and exit.
+  --max-retries         Maximum number of times to retry API calls.
+  --no-limit            Turn off the client-side limit on the size of the input into the model.
+  --max-tokens          Maximum number of tokens in response.
+  --temp                Temperature (randomness) of results, from 0.0 to 2.0.
+  --topp                TopP, an alternative to temperature that narrows response, from 0.0 to 1.0.
+  --fanciness           Your desired level of fanciness.
+  --status-text         Text to show while generating.
+  --no-cache            Disables caching of the prompt/response.
+  --reset-settings      Backup your old settings file and reset everything to the defaults.
+  --settings            Open settings in your $EDITOR.
+  --dirs                Print the directories in which mods store its data
 
 Example:
   # Editorialize your video files

data/lib/aia/tools/sgpt.rb

@@ -1,13 +1,34 @@
 # lib/aia/tools/sgpt.rb
 
+require_relative 'backend_common'
+
 class AIA::Sgpt < AIA::Tools
-  def initialize
-    super
-    @role     = :backend
-    @desc     = "shell-gpt"
-    @url      = "https://github.com/TheR1D/shell_gpt"
-    @install  = "pip install shell-gpt"
-  end
+  include AIA::BackendCommon
+
+  meta(
+    name:     'sgpt',
+    role:     :backend,
+    desc:     "shell-gpt",
+    url:      "https://github.com/TheR1D/shell_gpt",
+    install:  "pip install shell-gpt",
+  )
+
+
+  DEFAULT_PARAMETERS = [
+    # "--verbose",          # enable verbose logging (if applicable)
+    # Add default parameters here
+  ].join(' ').freeze
+
+  DIRECTIVES = %w[
+    model
+    temperature
+    max_tokens
+    top_p
+    frequency_penalty
+    presence_penalty
+    stop_sequence
+    api_key
+  ]
 end
 
 __END__

data/lib/aia/tools/subl.rb

@@ -1,6 +1,16 @@
 # lib/aia/tools/subl.rb
 
 class AIA::Subl < AIA::Tools
+
+  meta(
+    name:     'subl',
+    role:     :editor,
+    desc:     "Sublime Text Editor",
+    url:      "https://www.sublimetext.com/",
+    install:  "echo 'Download from website'",
+  )
+
+
   DEFAULT_PARAMETERS = [
     "--new-window",   # Open a new window
     "--wait",         # Wait for the files to be closed before returning
@@ -10,13 +20,6 @@ class AIA::Subl < AIA::Tools
 
 
   def initialize(file: "")
-    super
-    
-    @role     = :editor
-    @desc     = "Sublime Text Editor"
-    @url      = "https://www.sublimetext.com/"
-    @install  = "echo 'Download from website'"
-
     @file     = file
 
     build_command
@@ -24,7 +27,7 @@ class AIA::Subl < AIA::Tools
 
 
   def build_command
-    @command = "#{name} #{DEFAULT_PARAMETERS} #{@file}"
+    @command = "#{meta.name} #{DEFAULT_PARAMETERS} #{@file}"
   end
 
   

data/lib/aia/tools/vim.rb

@@ -1,6 +1,15 @@
 # lib/aia/tools/vim.rb
 
 class AIA::Vim < AIA::Tools
+
+  meta(
+    name:     'vim',
+    role:     :editor,
+    desc:     "Vi IMproved (VIM)",
+    url:      "https://www.vim.org",
+    install:  "brew install vim",
+  )
+
   DEFAULT_PARAMETERS = [
     " ", # no parameters 
   ].join(' ')
@@ -9,13 +18,6 @@ class AIA::Vim < AIA::Tools
 
 
   def initialize(file: "")
-    super
-    
-    @role         = :editor
-    @description  = "Vi IMproved (VIM)"
-    @url          = "https://www.vim.org"
-    @install      = "brew install vim"
-
     @file     = file
 
     build_command
@@ -23,7 +25,7 @@ class AIA::Vim < AIA::Tools
 
 
   def build_command
-    @command = "#{name} #{DEFAULT_PARAMETERS} #{@file}"
+    @command = "#{meta.name} #{DEFAULT_PARAMETERS} #{@file}"
   end