aia 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac671687f74fc804d119d8492ba0975cee0808eeeb0e6a1bd8943076d70c0472
-  data.tar.gz: f18d49026bfeae63f44c036d5f76b350c070a0817a8326fbf5ee0aa2ddce3e54
+  metadata.gz: a080fd671c1e5e3f9420f036892afb69a8d4190745da8bbce82620356ae2ad10
+  data.tar.gz: ffe746cbcb3a24216f39f4ec220b962828ab925041fe6f97f006676988006690
 SHA512:
-  metadata.gz: 89fc8032f90b88538e109de44ffed06c87443bae64ce0f7cd7a450d549004ca8facc49de6456e8af3a5ae72775ef43f46e008b18d6f4a961b7cb815a9a3cc8bc
-  data.tar.gz: 0f796a27dc7e8531f3752f24f9c2c442724cc2102d0c6b192ff249edce74cf5701475d99e1a62e339f9de12c83dd404f09ec0d99f9d3a5ba13ca066c2b6c4929
+  metadata.gz: 6ac1c123e391a981800ac8777e31de96cc68af4747e0756902c3f3bd6eaa3fef4c23e425ff7d951c63f93ee5dbb85c1573f8434958dd3e6ce142579f52bf7bd6
+  data.tar.gz: ed7e48ffa949db795884eb0d552a3ac312079dce7152fd45643191f2907ff5a697d334cc26a492cee44a649420fecaf9d6063dfc72ff82e7bd226dc2a77e81c6

data/README.md

@@ -31,48 +31,114 @@ TODO: don't forget to mention have access token (API keys) setup as envars for t
 
 ## Usage
 
-`aia prompt_id [context_file]*`
+```text
+$ aia --help
+
+aia v0.0.5
+
+Usage:  aia [options] prompt_id [context_file]* [-- external_options+]
+
+Options
+-------
+
+Edit the Prompt File  -e --edit
+ default: false
+
+Turn On Debugging     -d --debug
+ default: false
+
+Be Verbose            -v --verbose
+ default: false
 
-`prompt_id` is the basename of the `prompt_id.txt` file that is located in the `$PROMPTS_DIR` directory.  There is also a `prompt_id.json` file saved in the same place to hold the last-used values (parameters) for the keywords (if any) found in your prompt file.
+Print Version         --version
+ default: false
+
+Show Usage            -h --help
+ default: false
+
+Use Fuzzy Matching    --fuzzy
+ default: false
+
+Out FILENAME          -o --output --no-output
+ default: ./temp.md
+
+Log FILEPATH          -l --log --no-log
+ default: $HOME/.prompts/_prompts.log
+
+Format with Markdown  -m --markdown --no-markdown --md --no-md
+ default: true
+```
 
-TODO: consider a config file.
-TODO: consider a --no-log option to turn off logging
+Turn on `verbose` with `help` to see more usage information that includes system environment variables and external CLI tools that are used.
 
-The `_prompts.log` file is also located in the `$PROMPTS_DIR`
+```text
+$ aia --help --verbose
+```
 
-The default output file is `temp.md` which is written to the current directory from which `aia` was executed.
+## System Environment Variables (envars)
 
+From the verbose help text ...
 
 ```text
-$ aia -h
-Use generative AI with saved parameterized prompts
 
-Usage: aia [options] ...
+System Environment Variables Used
+---------------------------------
 
-Where:
+The OUTPUT and PROMPT_LOG envars can be overridden
+by cooresponding options on the command line.
 
-  Common Options Are:
-    -h, --help     show this message
-    -v, --verbose  enable verbose mode
-    -d, --debug    enable debug mode
-    --version      print the version: 1.2.0
+Name            Default Value
+--------------  -------------------------
+PROMPTS_DIR     $HOME/.prompts_dir
+AI_CLI_PROGRAM  mods
+EDITOR          edit
+MODS_MODEL      gpt-4-1106-preview
+OUTPUT          ./temp.md
+PROMPT_LOG      $PROMPTS_DIR/_prompts.log
 
-  Program Options Are:
-    -f, --fuzzy    Allow fuzzy matching
-    -o, --output   The output file
+These two are required for access the OpenAI
+services.  The have the same value but different
+programs use different envar names.
 
-AI Assistant (aia)
-==================
+To get an OpenAI access key/token (same thing)
+you must first create an account at OpenAI.
+Here is the link:  https://platform.openai.com/docs/overview
+
+OPENAI_ACCESS_TOKEN
+OPENAI_API_KEY
+```
 
-The AI cli program being used is: mods
+## External CLI Tools Used
+
+From the verbose help text ...
+
+```text
+External Tools Used
+-------------------
 
-The defaul options to mods are:
-  "-m gpt-4-1106-preview --no-limit -f"
+To install the external CLI programs used by aia:
+  brew install fzf mods rg
+
+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
+
+A text editor whose executable is setup in the
+system environment variable 'EDITOR' like this:
+
+export EDITOR="subl -w"
 
-You can pass additional CLI options to mods like this:
-  "aia my options -- options for mods"
 ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/aia

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
-# aia
+# bin/aia
 
-require_relative '../lib/aia'
-
-# Create an instance of the Main class and run the program
-AIA::Main.new.call
+require 'aia'
+AIA.run

data/lib/aia/cli.rb

@@ -0,0 +1,209 @@
+# lib/aia/cli.rb
+
+module AIA::Cli
+  def setup_cli_options(args)
+    @arguments  = args
+    @options    = {
+      #           Value
+      edit?:      [false, "-e --edit",    "Edit the Prompt File"],
+      debug?:     [false, "-d --debug",   "Turn On Debugging"],
+      verbose?:   [false, "-v --verbose", "Be Verbose"],
+      version?:   [false, "--version",    "Print Version"],
+      help?:      [false, "-h --help",    "Show Usage"],
+      fuzzy?:     [false, "--fuzzy",      "Use Fuzzy Matching"],
+      # 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"],
+    }
+    
+    # Array(String)
+    @extra_options = [] # intended for the backend AI processor
+
+    build_reader_methods # for the @options keys      
+    process_arguments
+  end
+
+
+  def usage
+    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
+  end
+ 
+
+  def usage_options
+    options = [
+      "Options",
+      "-------",
+      ""
+    ]
+
+    max_size = @options.values.map{|o| o[2].size}.max + 2
+
+    @options.values.each do |o|
+      pad_size = max_size - o[2].size
+      options << o[2] + (" "*pad_size) + o[1]
+
+      default = o[0]
+      default = "./" + default.basename.to_s if o[1].include?('output')
+      default = default.is_a?(Pathname) ? "$HOME/" + default.relative_path_from(HOME).to_s : default
+
+      options << " default: #{default}\n"
+    end
+
+    options.join("\n")
+  end
+
+
+  def usage_notes
+    <<~EOS
+      #{usage_envars}
+      #{AIA::ExternalCommands::HELP}
+    EOS
+  end
+
+
+  def usage_envars
+    <<~EOS
+      System Environment Variables Used
+      ---------------------------------
+
+      The OUTPUT and PROMPT_LOG envars can be overridden
+      by cooresponding options on the command line.
+
+      Name            Default Value
+      --------------  -------------------------
+      PROMPTS_DIR     $HOME/.prompts_dir
+      AI_CLI_PROGRAM  mods
+      EDITOR          edit
+      MODS_MODEL      gpt-4-1106-preview
+      OUTPUT          ./temp.md
+      PROMPT_LOG      $PROMPTS_DIR/_prompts.log
+
+      These two are required for access the OpenAI
+      services.  The have the same value but different
+      programs use different envar names.
+
+      To get an OpenAI access key/token (same thing)
+      you must first create an account at OpenAI.
+      Here is the link:  https://platform.openai.com/docs/overview
+
+      OPENAI_ACCESS_TOKEN
+      OPENAI_API_KEY
+
+    EOS
+  end
+
+
+  def build_reader_methods
+    @options.keys.each do |key|
+      define_singleton_method(key) do
+        @options[key][0]
+      end
+    end
+  end
+
+
+  def process_arguments
+    @options.keys.each do |option|
+      check_for option
+    end
+
+    # get the options meant for the backend AI command
+    extract_extra_options
+
+    bad_options = @arguments.select{|a| a.start_with?('-')}
+
+    unless bad_options.empty?
+      puts <<~EOS
+
+        ERROR: Unknown options: #{bad_options.join(' ')}
+
+      EOS
+      
+      show_usage
+
+      exit
+    end
+  end
+
+
+  def check_for(option_sym)
+    boolean = option_sym.to_s.end_with?('?')
+    switches = @options[option_sym][1].split
+
+    switches.each do |switch|
+      if @arguments.include?(switch)
+        index = @arguments.index(switch)
+
+        if boolean
+          @options[option_sym][0] = switch.include?('-no-') ? false : true
+          @arguments.slice!(index,1)
+        else
+          if switch.include?('-no-')
+            @options[option_sym][0] = nil
+            @arguments.slice!(index,1)
+          else
+            @options[option_sym][0] = @arguments[index + 1]
+            @arguments.slice!(index,2)
+          end
+        end
+        
+        break
+      end
+    end
+  end
+
+
+
+  def show_usage
+    @options[:help?][0] = false 
+    puts usage
+    exit
+  end
+  alias_method :show_help, :show_usage
+
+
+  def show_version
+    puts AIA::VERSION
+    exit
+  end
+end
+
+
+__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
+  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)
+  end
+end
+

data/lib/aia/configuration.rb

@@ -0,0 +1,44 @@
+# lib/aia/configuration.rb
+
+HOME            = Pathname.new(ENV['HOME'])
+PROMPTS_DIR     = Pathname.new(ENV['PROMPTS_DIR'] || (HOME + ".prompts_dir"))
+
+AI_CLI_PROGRAM  = "mods"
+EDITOR          = ENV['EDITOR'] || 'edit'
+MY_NAME         = "aia"
+MODS_MODEL      = ENV['MODS_MODEL'] || 'gpt-4-1106-preview'
+OUTPUT          = Pathname.pwd + "temp.md"
+PROMPT_LOG      = PROMPTS_DIR  + "_prompts.log"
+
+
+module AIA::Configuration
+  def setup_configuration
+    @prompt     = nil
+
+    PromptManager::Prompt.storage_adapter = 
+      PromptManager::Storage::FileSystemAdapter.config do |config|
+        config.prompts_dir        = PROMPTS_DIR
+        config.prompt_extension   = '.txt'
+        config.params_extension   = '.json'
+        config.search_proc        = nil
+        # TODO: add the rgfzz script for search_proc
+      end.new
+  end
+
+
+  # Get the additional CLI arguments intended for the
+  # backend gen-AI processor.
+  def extract_extra_options
+    extra_index = @arguments.index('--')
+    if extra_index.nil?
+      @extra_options = []
+    else
+      @extra_options = @arguments.slice!(extra_index..-1)[1..]
+    end
+  end
+
+
+
+
+
+end

data/lib/aia/external_commands.rb

@@ -0,0 +1,116 @@
+# lib/aia/external_commands.rb
+
+# TODO: move stuff associated with the CLI options for
+#       external commands to this module.
+#       Is the EDITOR considered an external command? Yes.
+
+module AIA::ExternalCommands
+  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

data/lib/aia/logging.rb

@@ -0,0 +1,22 @@
+# lib/aia/logging.rb
+
+module AIA::Logging
+  def log_result
+    return if log.nil?
+    
+    f = File.open(log, "ab")
+
+    f.write <<~EOS
+      =======================================
+      == #{Time.now}
+      == #{@prompt.path}
+
+      PROMPT:
+      #{@prompt}
+
+      RESULT:
+      #{@result}
+
+    EOS
+  end
+end

data/lib/aia/main.rb

@@ -0,0 +1,39 @@
+# lib/aia/main.rb
+
+module AIA ; end
+
+require_relative 'configuration'
+
+require_relative 'cli'
+require_relative 'prompt_processing'
+require_relative 'external_commands'
+require_relative 'logging'
+
+# Everything is being handled within the context
+# of a single class.
+
+class AIA::Main
+  include AIA::Configuration
+  include AIA::Cli
+  include AIA::PromptProcessing
+  include AIA::ExternalCommands
+  include AIA::Logging
+
+
+  def initialize(args= ARGV)
+    setup_configuration
+    setup_cli_options(args)
+    setup_external_programs
+  end
+
+
+  def call
+    show_usage    if help?
+    show_version  if version?
+
+    get_prompt
+    process_prompt
+    send_prompt_to_external_command
+    log_result unless log.nil?
+  end
+end

data/lib/aia/prompt_processing.rb

@@ -0,0 +1,158 @@
+# lib/aia/prompt_processing.rb
+
+module AIA::PromptProcessing
+
+  # Fetch the first argument which should be the prompt id
+  def get_prompt
+    prompt_id = @arguments.shift
+
+    # TODO: or maybe go to a generic search and select process
+
+    abort("Please provide a prompt id") unless prompt_id
+
+    search_for_a_matching_prompt(prompt_id) unless existing_prompt?(prompt_id)
+    edit_prompt if edit?
+  end
+
+
+  # Check if a prompt with the given id already exists
+  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
+    print "\nQuit #{MY_NAME} with a CNTL-D or a CNTL-C\n\n"
+    
+    defaults = @prompt.parameters
+
+    @prompt.keywords.each do |kw|
+      defaults[kw] = keyword_value(kw, defaults[kw])
+    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: "
+    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)
+    rescue Interrupt
+      a_string = nil
+    end
+
+    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 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
+    `#{EDITOR} #{@prompt.path}`
+    @options[:edit?][0] = false
+    @prompt = PromptManager::Prompt.get(id: @prompt.id)
+  end
+
+end

data/lib/aia/version.rb

@@ -1,5 +1,6 @@
+# lib/aia/version.rb
 # frozen_string_literal: true
 
 module AIA
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/aia.rb

@@ -1,397 +1,20 @@
 # lib/aia.rb
 
-require 'amazing_print'
 require 'pathname'
 require 'readline'
 require 'tempfile'
 
-
-require 'debug_me'
-include DebugMe
-
-$DEBUG_ME = true # ARGV.include?("--debug") || ARGV.include?("-d")
-
 require 'prompt_manager'
 require 'prompt_manager/storage/file_system_adapter'
 
 require_relative "aia/version"
+require_relative "aia/main"
 require_relative "core_ext/string_wrap"
 
 module AIA
-  class Main
-    HOME            = Pathname.new(ENV['HOME'])
-    PROMPTS_DIR     = Pathname.new(ENV['PROMPTS_DIR'] || (HOME + ".prompts_dir"))
-    
-    AI_CLI_PROGRAM  = "mods"
-    EDITOR          = ENV['EDITOR'] || 'edit'
-    MY_NAME         = Pathname.new(__FILE__).basename.to_s.split('.')[0]
-    MODS_MODEL      = ENV['MODS_MODEL'] || 'gpt-4-1106-preview'
-    OUTPUT          = Pathname.pwd + "temp.md"
-    PROMPT_LOG      = PROMPTS_DIR  + "_prompts.log"
-
-
-    # TODO: write the usage text
-    USAGE = <<~EOUSAGE
-      AI Assistant (aia)
-      ==================
-
-      The AI cli program being used is: #{AI_CLI_PROGRAM}
-
-      You can pass additional CLI options to #{AI_CLI_PROGRAM} like this:
-      "#{MY_NAME} my options -- options for #{AI_CLI_PROGRAM}"
-    EOUSAGE
-
-
-    def initialize(args= ARGV)
-      @prompt     = nil
-      @arguments  = args
-      @options    = {
-        edit?:      false,
-        debug?:     false,
-        verbose?:   false,
-        version?:   false,
-        help?:      false,
-        fuzzy?:     false,
-        markdown?:  true,
-        output:     OUTPUT,
-        log:        PROMPT_LOG,
-      }
-      @extra_options = [] # intended for the backend AI processor
-
-      build_reader_methods # for the @options keys      
-      process_arguments
-
-      PromptManager::Prompt.storage_adapter = 
-        PromptManager::Storage::FileSystemAdapter.config do |config|
-          config.prompts_dir        = PROMPTS_DIR
-          config.prompt_extension   = '.txt'
-          config.params_extension   = '.json'
-          config.search_proc        = nil
-          # TODO: add the rgfzz script for search_proc
-        end.new
-
-      setup_cli_program
-    end
-
-
-    def build_reader_methods
-      @options.keys.each do |key|
-        define_singleton_method(key) do
-          @options[key]
-        end
-      end
-    end
-
-
-    def process_arguments
-      @options.keys.each do |option|
-        check_for option
-      end
-
-      # get the options meant for the backend AI command
-      extract_extra_options
-
-      bad_options = @arguments.select{|a| a.start_with?('-')}
-
-      unless bad_options.empty?
-        puts <<~EOS
-
-          ERROR: Unknown options: #{bad_options.join(' ')}
-
-        EOS
-        
-        show_usage
-
-        exit
-      end
-    end
-
-
-    def check_for(an_option)
-      switches = [
-        "--#{an_option}".gsub('?',''),    # Dropping ? in case of a boolean
-        "--no-#{an_option}".gsub('?',''),
-        "-#{an_option.to_s[0]}"  # SMELL: -v for both --verbose and --version
-      ]
-
-      process_option(an_option, switches)
-    end
-
-
-    def process_option(option_sym, switches)
-      boolean = option_sym.to_s.end_with?('?')
-
-      switches.each do |switch|
-        if @arguments.include?(switch)
-          index = @arguments.index(switch)
-
-          if boolean
-            @options[option_sym] = switch.include?('-no-') ? false : true
-            @arguments.slice!(index,1)
-          else
-            if switch.include?('-no-')
-              @option[option_sym] = nil
-              @arguments.slice!(index,1)
-            else
-              @option[option_sym] = @arguments[index + 1]
-              @arguments.slice!(index,2)
-            end
-          end
-          
-          break
-        end
-      end
-    end
-
-
-    def show_usage
-      puts USAGE
-      exit
-    end
-
-
-    def show_version
-      puts VERSION
-      exit
-    end
-
-
-    def call
-      show_usage    if help?
-      show_version  if version?
-
-      prompt_id = get_prompt_id
-
-      search_for_a_matching_prompt(prompt_id) unless existing_prompt?(prompt_id)
-      process_prompt
-      execute_and_log_command(build_command)
-    end
-
-
-    ####################################################
-    private
-
-    # Setup the AI CLI program with necessary variables
-    def setup_cli_program
-
-      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
-
-
-    # Get the additional CLI arguments intended for the
-    # backend gen-AI processor.
-    def extract_extra_options
-      extra_index = @arguments.index('--')
-      if extra_index.nil?
-        @extra_options = []
-      else
-        @extra_options = @arguments.slice!(extra_index..-1)[1..]
-      end
-    end
-
-
-    # Fetch the first argument which should be the prompt id
-    def get_prompt_id
-      prompt_id = @arguments.shift
-
-      # TODO: or maybe go to a search and select process
-
-      abort("Please provide a prompt id") unless prompt_id
-      prompt_id
-    end
-
-
-    # Check if a prompt with the given id already exists
-    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
-      print "\nQuit #{MY_NAME} with a CNTL-D or a CNTL-C\n\n"
-      
-      defaults = @prompt.parameters
-
-      @prompt.keywords.each do |kw|
-        defaults[kw] = keyword_value(kw, defaults[kw])
-      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: "
-      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)
-      rescue Interrupt
-        a_string = nil
-      end
-
-      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)
-      prompt_id     = found_prompts.size == 1 ? found_prompts.first : handle_multiple_prompts(found_prompts, prompt_id)
-      @prompt       = PromptManager::Prompt.get(id: prompt_id)
-    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
-
-
-    # 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 execute_and_log_command(command)
-      puts command if verbose?
-      result = `#{command}`
-      output.write result
-
-      write_to_log(result) unless log.nil?
-    end
-
-
-    def write_to_log(answer)
-      f = File.open(log, "ab")
-
-      f.write <<~EOS
-        =======================================
-        == #{Time.now}
-        == #{@prompt.path}
-
-        PROMPT:
-        #{@prompt}
-
-        RESULT:
-        #{answer}
-
-      EOS
-    end
+  def self.run(args=ARGV)
+    args = args.split(' ') if args.is_a?(String)
+    AIA::Main.new(args).call
   end
 end
 
-
-# Create an instance of the Main class and run the program
-AIA::Main.new.call if $PROGRAM_NAME == __FILE__
-
-
-__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
-  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)
-  end
-end
-
-

data/lib/modularization_plan.md

@@ -0,0 +1,126 @@
+## Suggested Refactoring into Modules
+
+### ConfigurationModule
+
+This module could encapsulate all the constants and environment-dependent settings.
+
+```ruby
+module Configuration
+  HOME            = Pathname.new(ENV['HOME'])
+  PROMPTS_DIR     = Pathname.new(ENV['PROMPTS_DIR'] || (HOME + ".prompts_dir"))
+  AI_CLI_PROGRAM  = "mods"
+  EDITOR          = ENV['EDITOR'] || 'edit'
+  MY_NAME         = Pathname.new(__FILE__).basename.to_s.split('.')[0]
+  MODS_MODEL      = ENV['MODS_MODEL'] || 'gpt-4-1106-preview'
+  OUTPUT          = Pathname.pwd + "temp.md"
+  PROMPT_LOG      = PROMPTS_DIR  + "_prompts.log"
+  USAGE = <<~EOUSAGE
+    AI Assistant (aia)
+    ==================
+    The AI cli program being used is: #{AI_CLI_PROGRAM}
+    You can pass additional CLI options to #{AI_CLI_PROGRAM} like this:
+    "#{MY_NAME} my options -- options for #{AI_CLI_PROGRAM}"
+  EOUSAGE
+end
+```
+
+### OptionParsingModule
+
+This module could manage the parsing of command-line arguments and configuring the options for the application.
+
+```ruby
+module OptionParsing
+  def build_reader_methods
+    # ... method definition ...
+  end
+
+  def process_arguments
+    # ... method definition ...
+  end
+
+  def check_for(an_option)
+    # ... method definition ...
+  end
+
+  def process_option(option_sym, switches)
+    # ... method definition ...
+  end
+end
+```
+
+### CommandLineInterfaceModule
+
+This module would manage interactions with the command-line interface including editing of prompts and selection processes.
+
+```ruby
+module CommandLineInterface
+  def keyword_value(kw, default)
+    # ... method definition ...
+  end
+
+  def handle_multiple_prompts(found_these, while_looking_for_this)
+    # ... method definition ...
+  end
+end
+```
+
+### LoggingModule
+
+Responsible for logging the results of the command.
+
+```ruby
+module Logging
+  def write_to_log(answer)
+    # ... method definition ...
+  end
+end
+```
+
+### AICommandModule
+
+Manages the building and execution of the AI CLI command.
+
+```ruby
+module AICommand
+  def setup_cli_program
+    # ... method definition ...
+  end
+
+  def build_command
+    # ... method definition ...
+  end
+
+  def execute_and_log_command(command)
+    # ... method definition ...
+  end
+end
+```
+
+### PromptProcessingModule
+
+Handles prompt retrieval, existing check, and keyword processing.
+
+```ruby
+module PromptProcessing
+  def existing_prompt?(prompt_id)
+    # ... method definition ...
+  end
+
+  def process_prompt
+    # ... method definition ...
+  end
+
+  def replace_keywords
+    # ... method definition ...
+  end
+
+  def search_for_a_matching_prompt(prompt_id)
+    # ... method definition ...
+  end
+end
+```
+
+Each module should only contain the methods relevant to that module's purpose. After defining these modules, they can be included in the `AIA::Main` class where appropriate. Note that the method `get_prompt_id` didn't fit neatly into one of the outlined modules; it may remain in the main class or be included in a module if additional context becomes available or if it can be logically grouped with similar methods.
+
+The `__END__` block and the Readline history management could be encapsulated into a separate module for terminal interactions if that block grows in complexity or moves out of the overall class definition.
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2023-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prompt_manager
@@ -103,8 +103,15 @@ files:
 - bin/aia
 - bin/aia_completion.sh
 - lib/aia.rb
+- lib/aia/cli.rb
+- lib/aia/configuration.rb
+- lib/aia/external_commands.rb
+- lib/aia/logging.rb
+- lib/aia/main.rb
+- lib/aia/prompt_processing.rb
 - lib/aia/version.rb
 - lib/core_ext/string_wrap.rb
+- lib/modularization_plan.md
 homepage: https://github.com/MadBomber/aia
 licenses:
 - MIT