aia 0.0.5 → 0.3.0

data/lib/aia/external/sgpt.rb

@@ -0,0 +1,58 @@
+# lib/aia/external/sgpt.rb
+
+class AIA::External::Sgpt < AIA::External::Tool
+  def initialize
+    super
+    @role     = :backend
+    @desc     = "shell-gpt"
+    @url      = "https://github.com/TheR1D/shell_gpt"
+    @install  = "pip install shell-gpt"
+  end
+end
+
+__END__
+                                                                                               
+ Usage: sgpt [OPTIONS] [PROMPT]                                                                
+                                                                                               
+╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────╮
+│   prompt      [PROMPT]  The prompt to generate completions for.                             │
+╰─────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────╮
+│ --model                             TEXT                       Large language model to use. │
+│                                                                [default: gpt-3.5-turbo]     │
+│ --temperature                       FLOAT RANGE [0.0<=x<=2.0]  Randomness of generated      │
+│                                                                output.                      │
+│                                                                [default: 0.1]               │
+│ --top-probability                   FLOAT RANGE [0.1<=x<=1.0]  Limits highest probable      │
+│                                                                tokens (words).              │
+│                                                                [default: 1.0]               │
+│ --editor             --no-editor                               Open $EDITOR to provide a    │
+│                                                                prompt.                      │
+│                                                                [default: no-editor]         │
+│ --cache              --no-cache                                Cache completion results.    │
+│                                                                [default: cache]             │
+│ --help                                                         Show this message and exit.  │
+╰─────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Assistance Options ────────────────────────────────────────────────────────────────────────╮
+│ --shell           -s                 Generate and execute shell commands.                   │
+│ --describe-shell  -d                 Describe a shell command.                              │
+│ --code                --no-code      Generate only code. [default: no-code]                 │
+╰─────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Chat Options ──────────────────────────────────────────────────────────────────────────────╮
+│ --chat                             TEXT  Follow conversation with id, use "temp" for quick  │
+│                                          session.                                           │
+│                                          [default: None]                                    │
+│ --repl                             TEXT  Start a REPL (Read–eval–print loop) session.       │
+│                                          [default: None]                                    │
+│ --show-chat                        TEXT  Show all messages from provided chat id.           │
+│                                          [default: None]                                    │
+│ --list-chats    --no-list-chats          List all existing chat ids.                        │
+│                                          [default: no-list-chats]                           │
+╰─────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Role Options ──────────────────────────────────────────────────────────────────────────────╮
+│ --role                              TEXT  System role for GPT model. [default: None]        │
+│ --create-role                       TEXT  Create role. [default: None]                      │
+│ --show-role                         TEXT  Show role. [default: None]                        │
+│ --list-roles     --no-list-roles          List roles. [default: no-list-roles]              │
+╰─────────────────────────────────────────────────────────────────────────────────────────────╯
+

data/lib/aia/external/subl.rb

@@ -0,0 +1,47 @@
+# lib/aia/external/subl.rb
+
+class AIA::External::Subl < AIA::External::Tool
+  def initialize
+    super
+    @role     = :editor
+    @desc     = "Sublime Text Editor"
+    @url      = "https://www.sublimetext.com/"
+    @install  = "echo 'Download from website'"
+  end
+
+  
+  def open(file)
+    `#{name} #{file}`
+  end
+end
+
+__END__
+
+$ subl --help
+Sublime Text build 4166
+
+Usage: subl [arguments] [files]         Edit the given files
+ or: subl [arguments] [directories]   Open the given directories
+ or: subl [arguments] -- [files]      Edit files that may start with '-'
+ or: subl [arguments] -               Edit stdin
+ or: subl [arguments] - >out          Edit stdin and write the edit to stdout
+
+Arguments:
+--project <project>:    Load the given project
+--command <command>:    Run the given command
+-n or --new-window:     Open a new window
+--launch-or-new-window: Only open a new window if the application is open
+-a or --add:            Add folders to the current window
+-w or --wait:           Wait for the files to be closed before returning
+-b or --background:     Don't activate the application
+-s or --stay:           Keep the application activated after closing the file
+--safe-mode:            Launch using a sandboxed (clean) environment
+-h or --help:           Show help (this message) and exit
+-v or --version:        Show version and exit
+
+--wait is implied if reading from stdin. Use --stay to not switch back
+to the terminal when a file is closed (only relevant if waiting for a file).
+
+Filenames may be given a :line or :line:column suffix
+
+

data/lib/aia/external/temp.md

@@ -0,0 +1,37 @@
+If you want to find out which classes have inherited from a class named `Tool`, you can leverage Ruby's `ObjectSpace` module to iterate through all the classes and select those that are descendants of `Tool`. Here's how you could write the code:
+
+```ruby
+class Tool
+  # Tool class implementation
+end
+
+# Other classes that inherit from Tool
+class Hammer < Tool; end
+class Screwdriver < Tool; end
+class Wrench < Tool; end
+
+# Non-inheriting classes
+class RandomClass; end
+
+def find_descendants_of(klass)
+  ObjectSpace.each_object(Class).select { |c| c < klass }.map(&:name)
+end
+
+# Get the list of class names that inherit from Tool
+descendant_classes = find_descendants_of(Tool)
+
+# Format the list as markdown (as required)
+markdown_list = descendant_classes.map { |name| "- #{name}" }.join("\n")
+puts markdown_list
+```
+
+When you run this code, you will get an output similar to the following (the actual order may vary):
+
+```
+- Hammer
+- Screwdriver
+- Wrench
+```
+
+This list shows the class names that have inherited from the `Tool` class, and it is formatted as a markdown list without enclosing backticks as requested.
+

data/lib/aia/external/tool.rb

@@ -0,0 +1,73 @@
+# lib/aia/external/tool.rb
+
+class AIA::External::Tool
+  @@subclasses = []
+
+  # This method is called whenever a subclass is created
+  def self.inherited(subclass)
+    @@subclasses << subclass
+  end
+
+
+  attr_reader :name, :description, :url
+
+  def initialize
+    @role     = :role
+    @name     = self.class.name.split('::').last.downcase
+    @desc     = "description"
+    @url      = "URL"
+    @install  = "brew install #{name}"
+  end
+
+
+  def self.tools
+    @@subclasses.map(&:name)
+  end
+
+
+  def installed?
+    path = `which #{name}`.chomp
+    !path.empty? && File.executable?(path)
+  end
+
+
+  def help    = `#{name} --help`
+  def version = `#{name} --version`
+
+
+  ###################################################
+  class << self
+    def verify_tools(tools)
+      missing_tools = tools.reject(&:installed?)
+      unless missing_tools.empty?
+        puts format_missing_tools_response(missing_tools)
+      end
+    end
+
+
+    def format_missing_tools_response(missing_tools)
+      response = <<~EOS
+
+        WARNING: AIA makes use of external CLI tools that are missing.
+
+        Please install the following tools:
+
+      EOS
+
+      missing_tools.each do |tool|
+        response << "  #{tool.name}: install from #{tool.url}\n"
+      end
+
+      response
+    end
+  end
+end
+
+
+Pathname.new(__dir__)
+  .glob('*.rb')
+  .reject{|f| f.basename.to_s.end_with?('tool.rb') }
+  .each do |tool|
+    require_relative tool.basename.to_s 
+  end
+

data/lib/aia/external.rb

@@ -0,0 +1,259 @@
+# lib/aia/external.rb
+
+# TODO: move stuff associated with the CLI options for
+#       external commands to this module.
+#       Is the EDITOR considered an external command? Yes.
+
+=begin
+
+There are at least 4 processes handled by external tools:
+
+  search .......... default PromptManager::Prompt or search_proc
+  review/select ... using fzf either exact or fuzzy
+  edit ............ ENV['EDITOR']
+  execute ......... mods or sgpt or ???
+                      with different models / settings
+
+  sgpt is the executable for "shell-gpt" a python project
+
+=end
+
+module AIA::External
+  class Mods;    end
+  class Fzf;     end
+  class Rg;      end
+  class Editor;  end
+end
+
+module AIA::External
+  TOOLS = {
+    'fzf'   => [  'Command-line fuzzy finder written in Go',
+                  'https://github.com/junegunn/fzf'],
+    
+    'mods'  => [  'AI on the command-line',
+                  'https://github.com/charmbracelet/mods'],
+    
+    'rg'    => [  'Search tool like grep and The Silver Searcher',
+                  'https://github.com/BurntSushi/ripgrep']
+  }
+
+
+  HELP = <<~EOS
+    External Tools Used
+    -------------------
+
+    To install the external CLI programs used by aia:
+      brew install #{TOOLS.keys.join(' ')}
+
+    #{TOOLS.to_a.map{|t| t.join("\n  ") }.join("\n\n")}
+
+    A text editor whose executable is setup in the 
+    system environment variable 'EDITOR' like this:
+
+    export EDITOR="#{ENV['EDITOR']}"
+
+  EOS
+
+
+  # Setup the AI CLI program with necessary variables
+  def setup_external_programs
+    verify_external_tools
+
+    ai_default_opts = "-m #{MODS_MODEL} --no-limit "
+    ai_default_opts += "-f " if markdown?
+    @ai_options     = ai_default_opts.dup
+
+
+    @ai_options     += @extra_options.join(' ') 
+
+    @ai_command     = "#{AI_CLI_PROGRAM} #{@ai_options} "
+  end
+
+
+  # Check if the external tools are present on the system
+  def verify_external_tools
+    missing_tools = []
+
+    TOOLS.each do |tool, url|
+      path = `which #{tool}`.chomp
+      if path.empty? || !File.executable?(path)
+        missing_tools << { name: tool, url: url }
+      end
+    end
+
+    if missing_tools.any?
+      puts format_missing_tools_response(missing_tools)
+    end
+  end
+
+
+  def format_missing_tools_response(missing_tools)
+    response = <<~EOS
+
+      WARNING:  #{MY_NAME} makes use of a few external CLI tools.
+                #{MY_NAME} may not respond as designed without these.
+                
+      The following tools are missing on your system:
+
+    EOS
+
+    missing_tools.each do |tool|
+      response << "  #{tool[:name]}: install from #{tool[:url]}\n"
+    end
+
+    response
+  end
+
+
+  # Build the command to interact with the AI CLI program
+  def build_command
+    command = @ai_command + %Q["#{@prompt.to_s}"]
+
+    @arguments.each do |input_file|
+      file_path = Pathname.new(input_file)
+      abort("File does not exist: #{input_file}") unless file_path.exist?
+      command += " < #{input_file}"
+    end
+
+    command
+  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
+end
+
+
+__END__
+
+
+
+MODS_MODEL      = ENV['MODS_MODEL'] || 'gpt-4-1106-preview'
+
+AI_CLI_PROGRAM  = "mods"
+ai_default_opts = "-m #{MODS_MODEL} --no-limit -f"
+ai_options      = ai_default_opts.dup
+
+extra_inx       = ARGV.index('--')
+
+if extra_inx
+  ai_options += " " + ARGV[extra_inx+1..].join(' ')
+  ARGV.pop(ARGV.size - extra_inx)
+end
+
+AI_COMMAND        = "#{AI_CLI_PROGRAM} #{ai_options} "
+EDITOR            = ENV['EDITOR']
+PROMPT_DIR        = HOME + ".prompts"
+PROMPT_LOG        = PROMPT_DIR + "_prompts.log"
+PROMPT_EXTNAME    = ".txt"
+DEFAULTS_EXTNAME  = ".json"
+# SEARCH_COMMAND    = "ag -l"
+KEYWORD_REGEX     = /(\[[A-Z _|]+\])/
+
+AVAILABLE_PROMPTS = PROMPT_DIR
+                      .children
+                      .select{|c| PROMPT_EXTNAME == c.extname}
+                      .map{|c| c.basename.to_s.split('.')[0]}
+
+AVAILABLE_PROMPTS_HELP  = AVAILABLE_PROMPTS
+                            .map{|c| "  * " + c}
+                            .join("\n")
+
+
+AI_CLI_PROGRAM_HELP = `#{AI_CLI_PROGRAM} --help`
+
+HELP = <<EOHELP
+AI CLI Program
+==============
+
+The AI cli program being used is: #{AI_CLI_PROGRAM}
+
+The defaul options to #{AI_CLI_PROGRAM} are:
+  "#{ai_default_opts}"
+
+You can pass additional CLI options to #{AI_CLI_PROGRAM} like this:
+  "#{my_name} my options -- options for #{AI_CLI_PROGRAM}"
+
+#{AI_CLI_PROGRAM_HELP}
+
+EOHELP
+
+
+
+AG_COMMAND        = "ag --file-search-regex '\.txt$' e" # searching for the letter "e"
+CD_COMMAND        = "cd #{PROMPT_DIR}"
+FIND_COMMAND      = "find . -name '*.txt'"
+
+FZF_OPTIONS       = [
+  "--tabstop=2",  # 2 soaces for a tab
+  "--header='Prompt contents below'",
+  "--header-first",
+  "--prompt='Search term: '",
+  '--delimiter :',
+  "--preview 'ww {1}'",              # ww comes from the word_wrap gem
+  "--preview-window=down:50%:wrap"
+].join(' ')
+
+FZF_OPTIONS += " --exact" unless fuzzy?
+
+FZF_COMMAND       = "#{CD_COMMAND} ; #{FIND_COMMAND} | fzf #{FZF_OPTIONS}"
+AG_FZF_COMMAND    = "#{CD_COMMAND} ; #{AG_COMMAND}   | fzf #{FZF_OPTIONS}"
+
+# use `ag` ti build a list of text lines from each prompt
+# use `fzf` to search through that list to select a prompt file
+
+def ag_fzf = `#{AG_FZF_COMMAND}`.split(':')&.first&.strip&.gsub('.txt','')
+
+
+if configatron.prompt.empty?
+  unless first_argument_is_a_prompt?
+    configatron.prompt  = ag_fzf
+  end
+end
+
+###############################################
+
+
+
+#!/usr/bin/env bash
+# ~/scripts/ripfzfsubl
+#
+# Uses Sublime Text (subl) as the text editor
+#
+# brew install bat ripgrep fzf
+# 
+# bat  Clone of cat(1) with syntax highlighting and Git integration
+#      |__ https://github.com/sharkdp/bat
+# 
+# ripgrep  Search tool like grep and The Silver Searcher
+#          |__ https://github.com/BurntSushi/ripgrep
+# 
+# fzf  Command-line fuzzy finder written in Go
+#      |__ https://github.com/junegunn/fzf
+#
+#
+# 1. Search for text in files using Ripgrep
+# 2. Interactively narrow down the list using fzf
+# 3. Open the file in Sublime Text Editor
+
+rg --color=always --line-number --no-heading --smart-case "${*:-}" |
+  fzf --ansi \
+      --color "hl:-1:underline,hl+:-1:underline:reverse" \
+      --delimiter : \
+      --preview 'bat --color=always {1} --highlight-line {2}' \
+      --preview-window 'up,60%,border-bottom,+{2}+3/3,~3' \
+      --bind 'enter:become(subl {1}:{2})'
+

data/lib/aia/external_two.rb

@@ -0,0 +1,43 @@
+# lib/aia/external_two.rb
+#
+# Maybe something like this ...
+#
+# or a class structure based upon function where the external
+# tool and its default options can be injected.
+#
+module AIA::External
+  EDITOR = ENV['EDITOR']
+
+
+end
+
+# Usage example:
+
+# Verify and install tools if needed
+mods = AIA::External::Mods.new
+fzf = AIA::External::Fzf.new
+rg = AIA::External::Rg.new
+tools = [mods, fzf, rg]
+AIA::External.verify_tools(tools)
+
+# Build command for Mods tool with extra_options
+extra_options = ['--some-extra-option']
+mods_command = mods.command(extra_options)
+puts "Mods command: #{mods_command}"
+
+# Open a file with the system editor
+AIA::External::Editor.open('path/to/file.txt')
+
+# Search and select a file using Fzf tool
+fzf_options = {
+  prompt_dir: 'path/to/prompts',
+  fuzzy: true
+}
+fzf_command = fzf.command(fzf_options)
+puts "Fzf command: #{fzf_command}"
+
+# Use Rg tool to search within files
+search_term = 'search_query'
+rg_command = rg.command(search_term, fzf_options: fzf.options)
+puts "Rg command: #{rg_command}"
+

data/lib/aia/main.rb

@@ -6,7 +6,7 @@ require_relative 'configuration'
 
 require_relative 'cli'
 require_relative 'prompt_processing'
-require_relative 'external_commands'
+require_relative 'external'
 require_relative 'logging'
 
 # Everything is being handled within the context
@@ -16,7 +16,7 @@ class AIA::Main
   include AIA::Configuration
   include AIA::Cli
   include AIA::PromptProcessing
-  include AIA::ExternalCommands
+  include AIA::External
   include AIA::Logging
 
 

data/lib/aia/prompt_processing.rb

@@ -1,6 +1,7 @@
 # lib/aia/prompt_processing.rb
 
 module AIA::PromptProcessing
+  KW_HISTORY_MAX = 5
 
   # Fetch the first argument which should be the prompt id
   def get_prompt
@@ -18,6 +19,19 @@ module AIA::PromptProcessing
   # Check if a prompt with the given id already exists
   def existing_prompt?(prompt_id)
     @prompt = PromptManager::Prompt.get(id: prompt_id)
+  
+    # FIXME:  Kludge until prompt_manager is changed
+    #         prompt_manager v0.3.0 now supports this feature.
+    #         keeping the kludge in for legacy JSON files
+    #         files which have not yet been reformatted.
+    @prompt.keywords.each do |kw|
+      if @prompt.parameters[kw].nil? || @prompt.parameters[kw].empty?
+        @prompt.parameters[kw] = []
+      else
+        @prompt.parameters[kw] = Array(@prompt.parameters[kw])
+      end
+    end
+
     true
   rescue ArgumentError
     false
@@ -36,31 +50,45 @@ module AIA::PromptProcessing
 
 
   def replace_keywords
-    print "\nQuit #{MY_NAME} with a CNTL-D or a CNTL-C\n\n"
+    puts
+    puts "ID: #{@prompt.id}"
     
-    defaults = @prompt.parameters
+    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|
-      defaults[kw] = keyword_value(kw, defaults[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
-
-    @prompt.parameters = defaults
   end
 
 
-
-
   # query the user for a value to the keyword allow the
   # reuse of the previous value shown as the default
-  def keyword_value(kw, default)
-    label = "Default: "
+  def keyword_value(kw, history_array)
+
+    Readline::HISTORY.clear
+    Array(history_array).each { |entry| Readline::HISTORY.push(entry) unless entry.nil? || entry.empty? }
+
     puts "Parameter #{kw} ..."
-    default_wrapped = default.wrap(indent: label.size)
-    default_wrapped[0..label.size] = label
-    puts default_wrapped
 
     begin
-      a_string = Readline.readline("\n-=> ", false)
+      a_string = Readline.readline("\n-=> ", true)
     rescue Interrupt
       a_string = nil
     end
@@ -155,4 +183,30 @@ module AIA::PromptProcessing
     @prompt = PromptManager::Prompt.get(id: @prompt.id)
   end
 
+
+  def show_prompt_without_comments
+    puts remove_comments.wrap(indent: 4)
+  end
+
+
+  def remove_comments
+    lines           = @prompt.text
+                        .split("\n")
+                        .reject{|a_line| 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/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module AIA
-  VERSION = "0.0.5"
+  VERSION = "0.3.0"
 end