aia 0.0.5 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a080fd671c1e5e3f9420f036892afb69a8d4190745da8bbce82620356ae2ad10
-  data.tar.gz: ffe746cbcb3a24216f39f4ec220b962828ab925041fe6f97f006676988006690
+  metadata.gz: 0d2d934f517983c9854654eeb01d9b5ca6a08c92cb531b315a8b223e6e2ffd23
+  data.tar.gz: cd5ac0f18c2a290205c717c2d9e1e2e43ffe0a51f5aac400d3a1fce6137db4c5
 SHA512:
-  metadata.gz: 6ac1c123e391a981800ac8777e31de96cc68af4747e0756902c3f3bd6eaa3fef4c23e425ff7d951c63f93ee5dbb85c1573f8434958dd3e6ce142579f52bf7bd6
-  data.tar.gz: ed7e48ffa949db795884eb0d552a3ac312079dce7152fd45643191f2907ff5a697d334cc26a492cee44a649420fecaf9d6063dfc72ff82e7bd226dc2a77e81c6
+  metadata.gz: 04c859d26173c65d577cd9a49c4333f5c104d69b37205523a1f2249f284de38e1af06ec1870cea9774858e9688eb67639135fe2500b3550693f33ba621eada79
+  data.tar.gz: 808e69fc41eaba3396ebfb7157063e43709034a5009fcc06fb01c0055a2b371ef128962bea32a2cae8efc0e8ee0b8d8aeb5f4f180e5e4754176bfc70fecf17a0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] = 2023-11-23
+
+- Matching version to [prompt_manager](https://github.com/prompt_manager) This version allows for the user of history in the entery of values to prompt keywords.  KW_HISTORY_MAX is set at 5.  Changed CLI enteraction to use historical selection and editing of prior keyword values.
+
 ## [0.1.0] - 2023-11-23
 
 - Initial release

data/README.md

@@ -1,11 +1,27 @@
 # AI Assistant (AIA)
 
-**Under Development**
-
 `aia` is a command-line utility that integrates prameterized prompt management with generative AI (gen-AI) execution.
 
 Uses the gem "prompt_manager" to manage the prompts sent to the `mods` command-line utility.  Uses the command line tools "ripgrep" to search for prompts to send and "fzf" to select the prompts that match the search term.
 
+**Most Recent Change**
+
+v0.3.0 - Matching version to [prompt_manager](https://github.com/prompt_manager) This version allows for the user of history in the entery of values to prompt keywords.  KW_HISTORY_MAX is set at 5.  Changed CLI enteraction to use historical selection and editing of prior keyword values.
+
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [System Environment Variables (envars)](#system-environment-variables-envars)
+  - [External CLI Tools Used](#external-cli-tools-used)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 
 ## Installation
@@ -138,6 +154,12 @@ export EDITOR="subl -w"
 
 ```
 
+## Shell Completion
+
+One of the executables with this gem is `aia_completion.sh` which contains a completion script for hte `aia` such that you specify the first few characters of a prompt ID on the command line and the shell will complete the rest of the ID for you.  It works with the `bash` shell but do not know whether it works with the other shells.
+
+To set the completion you can execute aia_completion.sh` in your `.bashrc`  however, the PROMPTS_DIR environment variable must be set in order for prompt ID to work correctly.
+
 
 ## Development
 

data/lib/aia/aia_completion.bash

@@ -0,0 +1,39 @@
+# lib/aia/aia_completion.bash
+# Setup a prompt completion for use with
+# the bash shell
+#
+# This script assumes that the system environment
+# variable PROMPTS_DIR has been set correctly
+
+_aia_completion() {
+  # The current word being completed
+  local cur_word="${COMP_WORDS[COMP_CWORD]}"
+
+  # The previous word before the current word
+  local prev_word="${COMP_WORDS[COMP_CWORD-1]}"
+
+  # Store the previous directory to return to it later
+  local initial_pwd=$(pwd)
+
+  # Check if we are currently completing the option that requires prompt IDs
+  if [[ "$prev_word" == "aia" ]]; then
+    # Change directory to the prompts directory
+    cd "$PROMPTS_DIR" || return
+
+    # Generate a list of relative paths from the ~/.prompts directory (without .txt extension)
+    local files=($(find . -name "*.txt" -type f | sed 's|^\./||' | sed 's/\.txt$//'))
+
+    # Change back to the initial directory
+    cd "$initial_pwd" || return
+
+    # Generate possible matches and store them in the COMPREPLY array
+    COMPREPLY=($(compgen -W "${files[*]}" -- "$cur_word"))
+  else
+    # If not the specific option, perform regular file completion
+    COMPREPLY=($(compgen -o default -- "$cur_word"))
+  fi
+}
+
+# Register the completion function for the aia command
+complete -F _aia_completion aia
+

data/lib/aia/aia_completion.fish

@@ -0,0 +1,34 @@
+# lib/aia/aia_completion.fish
+# Setup a prompt completion for use with the fish shell
+#
+# This script assumes that the system environment
+# variable PROMPTS_DIR has been set correctly
+
+function __fish_aia_complete
+  # Get the command line and current token
+  set -l cmd_line (commandline -opc)
+  set -l current_token (commandline -ct)
+  
+  # Check if we are currently completing the option that requires prompt IDs
+  if set -q cmd_line[2]
+    # Change directory to the prompts directory
+    if test -d $PROMPTS_DIR
+      pushd $PROMPTS_DIR
+      # Generate completions based on .txt files in the PROMPTS_DIR directory
+      for file in (find . -name "*.txt" -type f)
+        set file (string replace -r '\.txt$' '' -- $file)
+        set file (string replace -r '^\./' '' -- $file)
+        printf "%s\n" $file
+      end
+      popd
+    end
+  else
+    # Use the default file completion if we are not completing a prompt ID
+    complete -f -c aia -a "(commandline -ct)"
+  end
+end
+
+# Register the completion function for the aia command
+complete -c aia -a '(__fish_aia_complete)' -f
+
+

data/lib/aia/aia_completion.zsh

@@ -0,0 +1,39 @@
+# lib/aia/aia_completion.zsh
+# Setup a prompt completion for use with
+# the zsh shell
+#
+# This script assumes that the system environment
+# variable PROMPTS_DIR has been set correctly
+
+_aia_completion() {
+  # The current word being completed
+  local cur_word="$words[$CURRENT]"
+
+  # The previous word before the current word
+  local prev_word="$words[$CURRENT-1]"
+
+  # Store the previous directory to return to it later
+  local initial_pwd=$PWD
+
+  # Check if we are currently completing the option that requires prompt IDs
+  if [[ "$prev_word" == "aia" ]]; then
+    # Change directory to the prompts directory
+    cd "$PROMPTS_DIR" || return
+
+    # Generate a list of relative paths from the ~/.prompts directory (without .txt extension)
+    local files=($(find . -name "*.txt" -type f | sed 's|^\./||' | sed 's/\.txt$//'))
+
+    # Change back to the initial directory
+    cd "$initial_pwd" || return
+
+    # Generate possible matches and store them in an array
+    _describe 'prompt ID' files
+  else
+    # If not the specific option, use the standard filename completion
+    _files
+  fi
+}
+
+# Register the completion function for the aia command using compctl
+compctl -K _aia_completion aia
+

data/lib/aia/cli.rb

@@ -3,6 +3,7 @@
 module AIA::Cli
   def setup_cli_options(args)
     @arguments  = args
+    # TODO: consider a fixed config file: ~/,aia
     @options    = {
       #           Value
       edit?:      [false, "-e --edit",    "Edit the Prompt File"],
@@ -11,11 +12,13 @@ module AIA::Cli
       version?:   [false, "--version",    "Print Version"],
       help?:      [false, "-h --help",    "Show Usage"],
       fuzzy?:     [false, "--fuzzy",      "Use Fuzzy Matching"],
+      completion: [nil,   "--completion", "Show completion script for bash|zsh|fish"],
       # TODO: Consider dropping output in favor of always
       #       going to STDOUT so user can redirect or pipe somewhere else
       output:     [OUTPUT,"-o --output --no-output",  "Out FILENAME"],
       log:        [PROMPT_LOG,"-l --log --no-log", "Log FILEPATH"],
       markdown?:  [true,  "-m --markdown --no-markdown --md --no-md", "Format with Markdown"],
+      backend:    [:mods, "-b --be --backend --no-backend", "Specify the backend prompt resolver"],
     }
     
     # Array(String)
@@ -30,8 +33,9 @@ module AIA::Cli
     usage =   "\n#{MY_NAME} v#{AIA::VERSION}\n\n"
     usage +=  "Usage:  #{MY_NAME} [options] prompt_id [context_file]* [-- external_options+]\n\n"
     usage +=  usage_options
-    usage += "\n"
-    usage += usage_notes if verbose?
+    usage +=  usage_options_details
+    usage +=  "\n"
+    usage +=  usage_notes if verbose?
     
     usage
   end
@@ -61,10 +65,30 @@ module AIA::Cli
   end
 
 
+  def usage_options_details
+    <<~EOS
+
+      Details
+      -------
+
+      Use (--help --verbose) or (-h -v) for verbose usage text.
+
+      Use --completion bash|zsh|fish to show a script
+      that will add prompt ID completion to your desired shell.
+      You must copy the output from this option into a
+      place where the function will be executed for
+      your shell.
+
+    EOS
+  end
+
+
   def usage_notes
     <<~EOS
+
       #{usage_envars}
-      #{AIA::ExternalCommands::HELP}
+      #{AIA::External::HELP}
+
     EOS
   end
 
@@ -115,6 +139,8 @@ module AIA::Cli
       check_for option
     end
 
+    show_completion unless @options[:completion].nil?
+
     # get the options meant for the backend AI command
     extract_extra_options
 
@@ -161,7 +187,6 @@ module AIA::Cli
   end
 
 
-
   def show_usage
     @options[:help?][0] = false 
     puts usage
@@ -170,40 +195,29 @@ module AIA::Cli
   alias_method :show_help, :show_usage
 
 
-  def show_version
-    puts AIA::VERSION
-    exit
-  end
-end
+  def show_completion
+    shell   = @options[:completion].first
+    script  = Pathname.new(__dir__) + "aia_completion.#{shell}"
 
+    if script.exist?
+      puts
+      puts script.read
+      puts
+    else
+      STDERR.puts <<~EOS
 
-__END__
+        ERRORL The shell '#{shell}' is not supported.
 
+      EOS
+    end
 
-# TODO: Consider using this history process to preload the default
-#       so that an up arrow will bring the previous answer into
-#       the read buffer for line editing.
-#       Instead of usin the .history file just push the default
-#       value from the JSON file.
 
-while input = Readline.readline('> ', true)
-  # Skip empty entries and duplicates
-  if input.empty? || Readline::HISTORY.to_a[-2] == input
-    Readline::HISTORY.pop
+    exit    
   end
-  break if input == 'exit'
 
-  # Do something with the input
-  puts "You entered: #{input}"
 
-  # Save the history in case you want to preserve it for the next sessions
-  File.open('.history', 'a') { |f| f.puts(input) }
-end
-
-# Load history from file at the beginning of the program
-if File.exist?('.history')
-  File.readlines('.history').each do |line|
-    Readline::HISTORY.push(line.chomp)
+  def show_version
+    puts AIA::VERSION
+    exit
   end
 end
-

data/lib/aia/configuration.rb

@@ -36,9 +36,4 @@ module AIA::Configuration
       @extra_options = @arguments.slice!(extra_index..-1)[1..]
     end
   end
-
-
-
-
-
 end

data/lib/aia/external/.irbrc

@@ -0,0 +1,11 @@
+
+
+
+module AIA
+  module External
+  end
+end
+
+require_relative 'tool'
+include AIA
+include External

data/lib/aia/external/ag.rb

@@ -0,0 +1,103 @@
+# lib/aia/external/ag.rb
+
+class AIA::External::Ag < AIA::External::Tool
+  def initialize
+    super
+    @role = :search
+    @desc = "the_silver_searcher Code-search similar to ack"
+    @url  = "https://github.com/ggreer/the_silver_searcher"
+  end
+end
+
+__END__
+
+Usage: ag [FILE-TYPE] [OPTIONS] PATTERN [PATH]
+
+  Recursively search for PATTERN in PATH.
+  Like grep or ack, but faster.
+
+Example:
+  ag -i foo /bar/
+
+Output Options:
+     --ackmate            Print results in AckMate-parseable format
+  -A --after [LINES]      Print lines after match (Default: 2)
+  -B --before [LINES]     Print lines before match (Default: 2)
+     --[no]break          Print newlines between matches in different files
+                          (Enabled by default)
+  -c --count              Only print the number of matches in each file.
+                          (This often differs from the number of matching lines)
+     --[no]color          Print color codes in results (Enabled by default)
+     --color-line-number  Color codes for line numbers (Default: 1;33)
+     --color-match        Color codes for result match numbers (Default: 30;43)
+     --color-path         Color codes for path names (Default: 1;32)
+     --column             Print column numbers in results
+     --[no]filename       Print file names (Enabled unless searching a single file)
+  -H --[no]heading        Print file names before each file's matches
+                          (Enabled by default)
+  -C --context [LINES]    Print lines before and after matches (Default: 2)
+     --[no]group          Same as --[no]break --[no]heading
+  -g --filename-pattern PATTERN
+                          Print filenames matching PATTERN
+  -l --files-with-matches Only print filenames that contain matches
+                          (don't print the matching lines)
+  -L --files-without-matches
+                          Only print filenames that don't contain matches
+     --print-all-files    Print headings for all files searched, even those that
+                          don't contain matches
+     --[no]numbers        Print line numbers. Default is to omit line numbers
+                          when searching streams
+  -o --only-matching      Prints only the matching part of the lines
+     --print-long-lines   Print matches on very long lines (Default: >2k characters)
+     --passthrough        When searching a stream, print all lines even if they
+                          don't match
+     --silent             Suppress all log messages, including errors
+     --stats              Print stats (files scanned, time taken, etc.)
+     --stats-only         Print stats and nothing else.
+                          (Same as --count when searching a single file)
+     --vimgrep            Print results like vim's :vimgrep /pattern/g would
+                          (it reports every match on the line)
+  -0 --null --print0      Separate filenames with null (for 'xargs -0')
+
+Search Options:
+  -a --all-types          Search all files (doesn't include hidden files
+                          or patterns from ignore files)
+  -D --debug              Ridiculous debugging (probably not useful)
+     --depth NUM          Search up to NUM directories deep (Default: 25)
+  -f --follow             Follow symlinks
+  -F --fixed-strings      Alias for --literal for compatibility with grep
+  -G --file-search-regex  PATTERN Limit search to filenames matching PATTERN
+     --hidden             Search hidden files (obeys .*ignore files)
+  -i --ignore-case        Match case insensitively
+     --ignore PATTERN     Ignore files/directories matching PATTERN
+                          (literal file/directory names also allowed)
+     --ignore-dir NAME    Alias for --ignore for compatibility with ack.
+  -m --max-count NUM      Skip the rest of a file after NUM matches (Default: 10,000)
+     --one-device         Don't follow links to other devices.
+  -p --path-to-ignore STRING
+                          Use .ignore file at STRING
+  -Q --literal            Don't parse PATTERN as a regular expression
+  -s --case-sensitive     Match case sensitively
+  -S --smart-case         Match case insensitively unless PATTERN contains
+                          uppercase characters (Enabled by default)
+     --search-binary      Search binary files for matches
+  -t --all-text           Search all text files (doesn't include hidden files)
+  -u --unrestricted       Search all files (ignore .ignore, .gitignore, etc.;
+                          searches binary and hidden files as well)
+  -U --skip-vcs-ignores   Ignore VCS ignore files
+                          (.gitignore, .hgignore; still obey .ignore)
+  -v --invert-match
+  -w --word-regexp        Only match whole words
+  -W --width NUM          Truncate match lines after NUM characters
+  -z --search-zip         Search contents of compressed (e.g., gzip) files
+
+File Types:
+The search can be restricted to certain types of files. Example:
+  ag --html needle
+  - Searches for 'needle' in files with suffix .htm, .html, .shtml or .xhtml.
+
+For a list of supported file types run:
+  ag --list-file-types
+
+ag was originally created by Geoff Greer. More information (and the latest release)
+can be found at http://geoff.greer.fm/ag

data/lib/aia/external/bat.rb

@@ -0,0 +1,189 @@
+# lib/aia/external/bat.rb
+
+class AIA::External::Bat < AIA::External::Tool
+  def initialize
+    super
+    @role = :render
+    @desc = 'Clone of cat(1) with syntax highlighting and Git integration'
+    @url  = 'https://github.com/sharkdp/bat'
+  end
+end
+
+__END__
+
+
+A cat(1) clone with syntax highlighting and Git integration.
+
+Usage: bat [OPTIONS] [FILE]...
+       bat <COMMAND>
+
+Arguments:
+  [FILE]...
+          File(s) to print / concatenate. Use a dash ('-') or no argument at all to read from
+          standard input.
+
+Options:
+  -A, --show-all
+          Show non-printable characters like space, tab or newline. This option can also be
+          used to print binary files. Use '--tabs' to control the width of the
+          tab-placeholders.
+
+      --nonprintable-notation <notation>
+          Set notation for non-printable characters.
+          
+          Possible values:
+            * unicode (␇, ␊, ␀, ..)
+            * caret   (^G, ^J, ^@, ..)
+
+  -p, --plain...
+          Only show plain style, no decorations. This is an alias for '--style=plain'. When
+          '-p' is used twice ('-pp'), it also disables automatic paging (alias for
+          '--style=plain --paging=never').
+
+  -l, --language <language>
+          Explicitly set the language for syntax highlighting. The language can be specified as
+          a name (like 'C++' or 'LaTeX') or possible file extension (like 'cpp', 'hpp' or
+          'md'). Use '--list-languages' to show all supported language names and file
+          extensions.
+
+  -H, --highlight-line <N:M>
+          Highlight the specified line ranges with a different background color For example:
+            '--highlight-line 40' highlights line 40
+            '--highlight-line 30:40' highlights lines 30 to 40
+            '--highlight-line :40' highlights lines 1 to 40
+            '--highlight-line 40:' highlights lines 40 to the end of the file
+            '--highlight-line 30:+10' highlights lines 30 to 40
+
+      --file-name <name>
+          Specify the name to display for a file. Useful when piping data to bat from STDIN
+          when bat does not otherwise know the filename. Note that the provided file name is
+          also used for syntax detection.
+
+  -d, --diff
+          Only show lines that have been added/removed/modified with respect to the Git index.
+          Use --diff-context=N to control how much context you want to see.
+
+      --diff-context <N>
+          Include N lines of context around added/removed/modified lines when using '--diff'.
+
+      --tabs <T>
+          Set the tab width to T spaces. Use a width of 0 to pass tabs through directly
+
+      --wrap <mode>
+          Specify the text-wrapping mode (*auto*, never, character). The '--terminal-width'
+          option can be used in addition to control the output width.
+
+  -S, --chop-long-lines
+          Truncate all lines longer than screen width. Alias for '--wrap=never'.
+
+      --terminal-width <width>
+          Explicitly set the width of the terminal instead of determining it automatically. If
+          prefixed with '+' or '-', the value will be treated as an offset to the actual
+          terminal width. See also: '--wrap'.
+
+  -n, --number
+          Only show line numbers, no other decorations. This is an alias for '--style=numbers'
+
+      --color <when>
+          Specify when to use colored output. The automatic mode only enables colors if an
+          interactive terminal is detected - colors are automatically disabled if the output
+          goes to a pipe.
+          Possible values: *auto*, never, always.
+
+      --italic-text <when>
+          Specify when to use ANSI sequences for italic text in the output. Possible values:
+          always, *never*.
+
+      --decorations <when>
+          Specify when to use the decorations that have been specified via '--style'. The
+          automatic mode only enables decorations if an interactive terminal is detected.
+          Possible values: *auto*, never, always.
+
+  -f, --force-colorization
+          Alias for '--decorations=always --color=always'. This is useful if the output of bat
+          is piped to another program, but you want to keep the colorization/decorations.
+
+      --paging <when>
+          Specify when to use the pager. To disable the pager, use --paging=never' or its
+          alias,'-P'. To disable the pager permanently, set BAT_PAGING to 'never'. To control
+          which pager is used, see the '--pager' option. Possible values: *auto*, never,
+          always.
+
+      --pager <command>
+          Determine which pager is used. This option will override the PAGER and BAT_PAGER
+          environment variables. The default pager is 'less'. To control when the pager is
+          used, see the '--paging' option. Example: '--pager "less -RF"'.
+
+  -m, --map-syntax <glob:syntax>
+          Map a glob pattern to an existing syntax name. The glob pattern is matched on the
+          full path and the filename. For example, to highlight *.build files with the Python
+          syntax, use -m '*.build:Python'. To highlight files named '.myignore' with the Git
+          Ignore syntax, use -m '.myignore:Git Ignore'. Note that the right-hand side is the
+          *name* of the syntax, not a file extension.
+
+      --ignored-suffix <ignored-suffix>
+          Ignore extension. For example:
+            'bat --ignored-suffix ".dev" my_file.json.dev' will use JSON syntax, and ignore
+            '.dev'
+
+      --theme <theme>
+          Set the theme for syntax highlighting. Use '--list-themes' to see all available
+          themes. To set a default theme, add the '--theme="..."' option to the configuration
+          file or export the BAT_THEME environment variable (e.g.: export BAT_THEME="...").
+
+      --list-themes
+          Display a list of supported themes for syntax highlighting.
+
+      --style <components>
+          Configure which elements (line numbers, file headers, grid borders, Git
+          modifications, ..) to display in addition to the file contents. The argument is a
+          comma-separated list of components to display (e.g. 'numbers,changes,grid') or a
+          pre-defined style ('full'). To set a default style, add the '--style=".."' option to
+          the configuration file or export the BAT_STYLE environment variable (e.g.: export
+          BAT_STYLE="..").
+          
+          Possible values:
+          
+            * default: enables recommended style components (default).
+            * full: enables all available components.
+            * auto: same as 'default', unless the output is piped.
+            * plain: disables all available components.
+            * changes: show Git modification markers.
+            * header: alias for 'header-filename'.
+            * header-filename: show filenames before the content.
+            * header-filesize: show file sizes before the content.
+            * grid: vertical/horizontal lines to separate side bar
+                    and the header from the content.
+            * rule: horizontal lines to delimit files.
+            * numbers: show line numbers in the side bar.
+            * snip: draw separation lines between distinct line ranges.
+
+  -r, --line-range <N:M>
+          Only print the specified range of lines for each file. For example:
+            '--line-range 30:40' prints lines 30 to 40
+            '--line-range :40' prints lines 1 to 40
+            '--line-range 40:' prints lines 40 to the end of the file
+            '--line-range 40' only prints line 40
+            '--line-range 30:+10' prints lines 30 to 40
+
+  -L, --list-languages
+          Display a list of supported languages for syntax highlighting.
+
+  -u, --unbuffered
+          This option exists for POSIX-compliance reasons ('u' is for 'unbuffered'). The output
+          is always unbuffered - this option is simply ignored.
+
+      --diagnostic
+          Show diagnostic information for bug reports.
+
+      --acknowledgements
+          Show acknowledgements.
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+  -V, --version
+          Print version
+
+You can use 'bat cache' to customize syntaxes and themes. See 'bat cache --help' for more
+information