aia 0.5.3 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 872817d33ce07dce0b81526206b55de4800df41adc7b31a295c0d690f677ff58
-  data.tar.gz: f95bdf3845fec419a8b0e56a0c2075e2b1cbab79342538eeb32acb4dc255f8c1
+  metadata.gz: '021416691c11252ce3462ee7ec394691e0a7d0fd81eb6df473df3447dd02da3b'
+  data.tar.gz: 2bd5eb6bd2098c7e9bd04234a11c1192004bb217ec054aa9222334d9b96309d2
 SHA512:
-  metadata.gz: 04fc7614ec13ba847e66def37dda93cdfbe8bd0f19425083339276c7bfa5f1ecc214684d0cb9fcb479fddb7fda2cd818ac74fd5498083af3452f8df4f8442a29
-  data.tar.gz: 03d5adfdc25ac89cd29b752dd8a2af1c3d6876cad6206471ff9ae1c13e251ea8ee2b2c1038bb64f28febd3f977a375bbe03868b5b3b686a4c35b621e3216a2e1
+  metadata.gz: 0e2d78c3b6b1b8848645ef586c3b2f7a4557339504efc1a7434b12e313637e47b6803da8e5fa21908f88ee59046a372ef22553a5fdffe97d5777b65845f5ce41
+  data.tar.gz: 142dd7b40622124089363670fcb6ffde02368ad07de7016e6c12e0511a47d89d8b0be9b153d31076758c321e6762e1d361fd4ac086b6f8ffca8d2a2abebeff7b

data/.semver

@@ -1,6 +1,6 @@
 ---
 :major: 0
 :minor: 5
-:patch: 3
+:patch: 6
 :special: ''
 :metadata: ''

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.5.6] 2024-01-15
+- Adding processing for directives, shell integration and erb to the follow up prompt in a chat session
+- some code refactoring.
+
 ## [0.5.3] 2024-01-14
 - adding ability to render markdown to the terminal using the "glow" CLI utility
 

data/README.md

@@ -5,6 +5,11 @@
 It leverages the `prompt_manager` gem to manage prompts for the `mods` and `sgpt` CLI utilities. It utilizes "ripgrep" for searching for prompt files.  It uses `fzf` for prompt selection based on a search term and fuzzy matching.
 
 **Most Recent Change**: Refer to the [Changelog](CHANGELOG.md)
+v0.5.6
+- Directives within a chat session follow up are now available
+- when the `--shell` option is set access to envars and shell scripts are availabe in a chat session follow up prompt
+- when the `--erb` option is set, access to ERB-based dynamic content is available in a chat session follow up prompt.
+
 v0.5.3
 - `--render` will render markdown formatted content to the terminal using the `glow` CLI utility.
 - fixes to some terminal UI stuff like AI response is not being wrapped to the terminal width to make for easier reading.
@@ -25,11 +30,14 @@ v0.5.0 - Breaking changes:
   - [Shell Integration inside of a Prompt](#shell-integration-inside-of-a-prompt)
       - [Access to System Environment Variables](#access-to-system-environment-variables)
       - [Dynamic Shell Commands](#dynamic-shell-commands)
+      - [Chat Session Use](#chat-session-use)
   - [*E*mbedded *R*u*B*y (ERB)](#embedded-ruby-erb)
+    - [Chat Session Behavior](#chat-session-behavior)
   - [Prompt Directives](#prompt-directives)
     - [`aia` Specific Directive Commands](#aia-specific-directive-commands)
       - [//config](#config)
     - [Backend Directive Commands](#backend-directive-commands)
+    - [Using Directives in Chat Sessions](#using-directives-in-chat-sessions)
   - [All About ROLES](#all-about-roles)
     - [Other Ways to Insert Roles into Prompts](#other-ways-to-insert-roles-into-prompts)
   - [External CLI Tools Used](#external-cli-tools-used)
@@ -101,7 +109,15 @@ ARGUMENTS
 
 OPTIONS
        --chat begin a chat session with the backend after the initial prompt response;  will
-              set --no-out_file so that the backend response comes to STDOUT.
+              set --no-out_file so that the backend response comes to STDOUT.  After the
+              initial prompt is processed, you will be asked to provide a follow up.  Just
+              enter whatever is appropriate terminating your input with a RETURN.  The
+              backend will provide a response to you follow up and ask you again if you have
+              another follow up. This back and forth chatting will continue until you enter a
+              RETURN without any other content - an empty follow up prompt.  You may also
+              enter a directive to be processed after which another follow up is requested.
+              If you have the --shell and/or the --erb options set you may use those tools
+              within your follow up to provide dynamic content.
 
        --completion SHELL_NAME
 
@@ -280,6 +296,7 @@ AUTHOR
 AIA                                       2024-01-01                                   aia(1)
 ```
 
+
 ## Configuration Using Envars
 
 The `aia` configuration defaults can be over-ridden by system environment variables *(envars)* with the prefix "AIA_" followed by the config item name also in uppercase. All configuration items can be over-ridden in this way by an envar.  The following table show a few examples.
@@ -328,6 +345,15 @@ or insert content from a file in your home directory:
 Given the following constraints $(cat ~/3_laws_of_robotics.txt) determine the best way to instruct my roomba to clean my kids room.
 ```
 
+#### Chat Session Use
+
+When you use the `--shell` option to start a chat session, shell integration is available in your follow up prompts.  Suppose you started up a chat session using a roll of "Ruby Expert" expecting to chat about changes that could be made to a specific class BUT you forgot to include the class source file as part of the context when you got started.  You could enter this as your follow up prompt to this to keep going:
+
+```
+The class I want to chat about refactoring is this one: $(cat my_class.rb)
+```
+
+That inserts the entire class source file into your follow up prompt.  You can continue chatting with you AI Assistant avout changes to the class.
 
 ## *E*mbedded *R*u*B*y (ERB)
 
@@ -337,6 +363,11 @@ The `--erb` option turns the prompt text file into a fully functioning ERB templ
 
 Most websites that have information about ERB will give examples of how to use ERB to generate dynamice HTML content for web-based applications.  That is a common use case for ERB.  `aia` on the other hand uses ERB to generate dynamic prompt text.
 
+### Chat Session Behavior
+
+In a chat session whether started by the `--chat` option or its equivalent with a directive within a prompt text file behaves a little differently w/r/t its binding and local variable assignments.  Since a chat session by definition has multiple prompts, setting a local variable in one prompt and expecting it to be available in a subsequent prompt does not work.  You need to use instance variables to accomplish this prompt to prompt carry over of information.
+
+Also since follow up prompts are expected to be a single thing - sentence or paragraph - terminated by a single return, its likely that ERB enhance will be of benefit; but, you may find a use for it.
 
 ## Prompt Directives
 
@@ -390,6 +421,17 @@ FOr example `mods` has a configuration item `topp` which can be set by a directi
 
 If `mods` is not the backend the `//topp` direcive is ignored.
 
+### Using Directives in Chat Sessions
+
+Whe you are in a chat session, you may use a directive as a follow up prompt.  For example if you started the chat session with the option `--terse` expecting to get short answers from the backend; but, then you decide that you want more comprehensive answers you may do this:
+
+```
+//config terse? false
+```
+
+The directive is executed and a new follow up prompt can be entered with a more lengthy response generated from the backend.
+
+
 ## All About ROLES
 
 `aia` provides the `--role` CLI option to identify a prompt ID within your prompts directory which defines the context within which the LLM is to provide its response.  The text of the role ID is pre-pended to the text of the primary prompt to form a complete prompt to be processed by the backend.

data/lib/aia/directives.rb

@@ -2,13 +2,15 @@
 
 require 'hashie'
 
-class AIA::Directives
-  def initialize( prompt: )
-    @prompt = prompt  # PromptManager::Prompt instance
-    AIA.config.directives = @prompt.directives
-  end
+=begin
+  AIA.config.directives is an Array of Arrays.  An
+  entry looks like this:
+    [directive, parameters]
+  where both are String objects
+=end
 
 
+class AIA::Directives
   def execute_my_directives
     return if AIA.config.directives.nil? || AIA.config.directives.empty?
     

data/lib/aia/dynamic_content.rb

@@ -0,0 +1,26 @@
+# aia/lib/aia/dynamic_content.rb
+
+require 'erb'
+
+module AIA::DynamicContent
+
+  # inserts environment variables (envars) and dynamic content into a prompt
+  # replaces patterns like $HOME and ${HOME} with the value of ENV['HOME']
+  # replaces patterns like $(shell command) with the output of the shell command
+  #
+  def render_env(a_string)
+    a_string.gsub(/\$(\w+|\{\w+\})/) do |match|
+      ENV[match.tr('$', '').tr('{}', '')]
+    end.gsub(/\$\((.*?)\)/) do |match|
+      `#{match[2..-2]}`.chomp
+    end
+  end
+
+
+  # Need to use instance variables in assignments
+  # to maintain binding from one follow up prompt
+  # to another.
+  def render_erb(the_prompt_text)
+    ERB.new(the_prompt_text).result(binding)
+  end
+end

data/lib/aia/main.rb

@@ -5,6 +5,7 @@ module AIA ; end
 require_relative 'config'
 require_relative 'cli'
 require_relative 'directives'
+require_relative 'dynamic_content'
 require_relative 'prompt'
 require_relative 'logging'
 require_relative 'tools'
@@ -13,6 +14,7 @@ require_relative 'tools'
 # of a single class.
 
 class AIA::Main
+  include AIA::DynamicContent
 
   attr_accessor :logger, :tools, :backend
 
@@ -33,7 +35,8 @@ class AIA::Main
 
     @prompt = AIA::Prompt.new.prompt
 
-    @engine = AIA::Directives.new(prompt: @prompt)
+
+    @directives_processor = AIA::Directives.new 
 
     # TODO: still should verify that the tools are ion the $PATH
     # tools.class.verify_tools
@@ -71,7 +74,7 @@ class AIA::Main
 
 
   def call
-    @engine.execute_my_directives
+    @directives_processor.execute_my_directives
 
     if AIA.config.chat?
       AIA.config.out_file = STDOUT 
@@ -170,31 +173,41 @@ class AIA::Main
     a_string
   end
 
+  
+  def handle_directives(the_prompt_text)
+    signal = PromptManager::Prompt::DIRECTIVE_SIGNAL
+    result = the_prompt_text.start_with?(signal)
+
+    if result
+      parts       = the_prompt_text[signal.size..].split(' ')
+      directive   = parts.shift
+      parameters  = parts.join(' ')
+      AIA.config.directives << [directive, parameters]
+      @directives_processor.execute_my_directives
+    end
+
+    result
+  end
+
 
   def lets_chat
     add_continue_option    
 
     the_prompt_text = ask_question_with_reline("\nFollow Up: ")
-    
+
     until the_prompt_text.empty?
-      the_prompt_text = insert_terse_phrase(the_prompt_text)
-      
-      result = get_and_display_result(the_prompt_text)
+      the_prompt_text   = render_erb(the_prompt_text) if AIA.config.erb?
+      the_prompt_text   = render_env(the_prompt_text) if AIA.config.shell?
 
-      log_the_follow_up(the_prompt_text, result)
-
-      speak result
+      unless handle_directives(the_prompt_text)
+        the_prompt_text = insert_terse_phrase(the_prompt_text)
+        result          = get_and_display_result(the_prompt_text)
 
+        log_the_follow_up(the_prompt_text, result)
+        speak result
+      end
 
-      # TODO: Allow user to enter a directive; loop
-      #       until answer is not a directive
-      #
-      # while !directive do
-      
       the_prompt_text = ask_question_with_reline("\nFollow Up: ")
-      
-      # execute the directive
-      # end
     end
   end
 end

data/lib/aia/prompt.rb

@@ -1,9 +1,12 @@
 # lib/aia/prompt.rb
 
 require 'reline'
-require 'erb'
+
+require_relative 'dynamic_content'
 
 class AIA::Prompt
+  include AIA::DynamicContent
+
   #
   # used when no prompt_id is provided but there
   # are extra parameters that need to be passed
@@ -42,9 +45,11 @@ class AIA::Prompt
 
     if build
       @prompt.text = render_erb(@prompt.text)   if AIA.config.erb?
-      @prompt.text = replace_env(@prompt.text)  if AIA.config.shell?
+      @prompt.text = render_env(@prompt.text)   if AIA.config.shell?
       process_prompt 
     end
+
+    AIA.config.directives = @prompt.directives
   end
 
 
@@ -93,25 +98,6 @@ class AIA::Prompt
   end
 
 
-  # inserts environmant variables and dynamic content into a prompt
-  # replaces patterns like $HOME and ${HOME} with the value of ENV['HOME']
-  # replaces patterns like $(shell command) with the output of the shell command
-  #
-  def replace_env(a_string)
-    a_string.gsub(/\$(\w+|\{\w+\})/) do |match|
-      ENV[match.tr('$', '').tr('{}', '')]
-    end.gsub(/\$\((.*?)\)/) do |match|
-      `#{match[2..-2]}`.chomp
-    end
-  end
-
-
-  # You are just asking for trouble!
-  def render_erb(a_string)
-    ERB.new(a_string).result(binding)
-  end
-
-
   def replace_keywords
     puts
     puts "ID: #{@prompt.id}"

data/lib/aia/tools/backend_common.rb

@@ -12,9 +12,12 @@ module AIA::BackendCommon
     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
@@ -29,6 +32,7 @@ module AIA::BackendCommon
     @command
   end
 
+
   def set_parameter_from_directives
     AIA.config.directives.each do |entry|
       directive, value = entry
@@ -38,6 +42,7 @@ module AIA::BackendCommon
     end
   end
 
+
   def run
     case @files.size
     when 0
@@ -45,32 +50,9 @@ module AIA::BackendCommon
     when 1
       @result = `#{build_command} < #{@files.first}`
     else
-      create_temp_file_with_contexts
-      run_with_temp_file
-      clean_up_temp_file
+      @result = %x[cat #{@files.join(' ')} | #{build_command}]
     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/man/aia.1

@@ -23,7 +23,7 @@ External options are optional\.  Anything that follow \[lq] \-\- \[lq] will be s
 .SH OPTIONS
 .TP
 \fB\-\-chat\fR
-begin a chat session with the backend after the initial prompt response;  will set \-\-no\-out\[ru]file so that the backend response comes to STDOUT\.
+begin a chat session with the backend after the initial prompt response;  will set \-\-no\-out\[ru]file so that the backend response comes to STDOUT\.  After the initial prompt is processed, you will be asked to provide a follow up\.  Just enter whatever is appropriate terminating your input with a RETURN\.  The backend will provide a response to you follow up and ask you again if you have another follow up\. This back and forth chatting will continue until you enter a RETURN without any other content \- an empty follow up prompt\.  You may also enter a directive to be processed after which another follow up is requested\.  If you have the \fB\-\-shell\fR and\[sl]or the \fB\-\-erb\fR options set you may use those tools within your follow up to provide dynamic content\.
 .TP
 \fB\-\-completion\fR \fISHELL\[ru]NAME\fP
 .TP

data/man/aia.1.md

@@ -26,7 +26,7 @@ The aia command-line tool is an interface for interacting with an AI model backe
 ## OPTIONS
 
 `--chat`
-: begin a chat session with the backend after the initial prompt response;  will set --no-out_file so that the backend response comes to STDOUT.
+: begin a chat session with the backend after the initial prompt response;  will set --no-out_file so that the backend response comes to STDOUT.  After the initial prompt is processed, you will be asked to provide a follow up.  Just enter whatever is appropriate terminating your input with a RETURN.  The backend will provide a response to you follow up and ask you again if you have another follow up. This back and forth chatting will continue until you enter a RETURN without any other content - an empty follow up prompt.  You may also enter a directive to be processed after which another follow up is requested.  If you have the `--shell` and/or the `--erb` options set you may use those tools within your follow up to provide dynamic content.
 
 `--completion` *SHELL_NAME*
 : Show completion script for bash|zsh|fish - default is nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.6
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-14 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -229,6 +229,7 @@ files:
 - lib/aia/cli.rb
 - lib/aia/config.rb
 - lib/aia/directives.rb
+- lib/aia/dynamic_content.rb
 - lib/aia/logging.rb
 - lib/aia/main.rb
 - lib/aia/prompt.rb