aia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 993c2562cf2bad7c76f3408376883dc32cc8d7b69a6810f16cecf7753360f2e6
+  data.tar.gz: 1e7f5c44c0b4e5d753a43aad73cb7bd2e681b0873c26ecaf0b185be86536b03d
+SHA512:
+  metadata.gz: 47cc84453f2f57bf5f996546ea63c7232866906e27409448aa11e63b43ff7e0045412da5c55637f039bee39a04044c569a2fd368ba12a3248d41d68a1e699d79
+  data.tar.gz: fd72b98ba96ce71f0da3cb81c467d3b326608878df6062f9ad8dcccf55767aef14aaff84ed918118ab926d6422b0a5b1122a035440753f52ee6960b9aba19ef6

data/.envrc

@@ -0,0 +1 @@
+export RR=`pwd`

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-23
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Dewayne VanHoozer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Dewayne VanHoozer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# 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.
+
+
+
+## Installation
+
+Install the gem by executing:
+
+    gem install aia
+
+
+Install the command-line utilities by executing:
+
+    brew install mods fzf ripgrep
+
+You will also need to establish a directory in your file system where your prompt text files, last used parameters and usage log files are kept.
+
+Setup a system environment variable named "PROMPTS_DIR" that points to your prompts directory.  The default is in your HOME directory named ".prompts_dir"
+
+You will also need to source the completion script.
+
+TODO: May want to add a `setup` function to the command-line options that will create the directory, and do something with the completion function.
+
+TODO: don't forget to mention have access token (API keys) setup as envars for the various backend services like OpenAI... if they are still in business.
+
+## Usage
+
+`aia prompt_id [context_file]*`
+
+`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.
+
+TODO: consider a config file.
+TODO: consider a --no-log option to turn off logging
+
+The `_prompts.log` file is also located in the `$PROMPTS_DIR`
+
+The default output file is `temp.md` which is written to the current directory from which `aia` was executed.
+
+
+```text
+$ aia -h
+Use generative AI with saved parameterized prompts
+
+Usage: aia [options] ...
+
+Where:
+
+  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
+
+  Program Options Are:
+    -f, --fuzzy    Allow fuzzy matching
+    -o, --output   The output file
+
+AI Assistant (aia)
+==================
+
+The AI cli program being used is: mods
+
+The defaul options to mods are:
+  "-m gpt-4-1106-preview --no-limit -f"
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MadBomber/aia.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+begin
+  require "tocer/rake/register"
+rescue LoadError => error
+  puts error.message
+end
+
+Tocer::Rake::Register.call
+
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/bin/aia

@@ -0,0 +1,272 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
+# warn_indent: true
+##########################################################
+###
+##  File: aia
+##  Desc: AI Assistant
+##        Use generative AI with saved parameterized prompts
+##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+##
+##  This program makes use of the gem word_wrap's
+##  CLI tool: ww
+##
+##  brew install fzf mods the_silver_searcher ripgrep
+#
+# TODO: refactor with a goal to isolate the search_proc and mods functionality
+# TODO: consider a config file.
+# TODO: remove use of CLI Helper.
+# TODO: consider --no-log
+#
+
+require 'pathname'
+HOME        = Pathname.new( ENV['HOME'] )
+PROMPTS_DIR = Pathname.new(ENV['PROMPTS_DIR'] || (HOME + ".prompts_dir"))
+
+require 'prompt_manager'
+require 'prompt_manager/storage/file_system_adapter'
+
+PromptManager::Prompt.storage_adapter = 
+  PromptManager::Storage::FileSystemAdapter.config do |config|
+    config.prompts_dir        = PROMPTS_DIR
+    config.prompt_extension   = '.txt'  # default
+    config.params_extension   = '.json' # default
+    # config.search_proc      = nil     # default
+  end.new
+
+
+
+require 'amazing_print'
+require 'readline'    # TODO: or reline ??
+require 'word_wrap'
+require 'word_wrap/core_ext'
+
+require 'debug_me'
+include DebugMe
+
+require 'cli_helper'
+include CliHelper
+
+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_LOG        = PROMPTS_DIR + "_prompts.log"
+
+# PROMPT_EXTNAME    = ".txt"
+# DEFAULTS_EXTNAME  = ".json"
+
+# SEARCH_COMMAND    = "ag -l"
+# KEYWORD_REGEX     = /(\[[A-Z _|]+\])/
+
+
+configatron.version = '1.2.0'
+
+AI_CLI_PROGRAM_HELP = `#{AI_CLI_PROGRAM} --help`
+
+HELP = <<EOHELP
+AI Assistant (aia)
+==================
+
+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}"
+
+EOHELP
+
+cli_helper("Use generative AI with saved parameterized prompts") do |o|
+  o.bool    '-f', '--fuzzy',  'Allow fuzzy matching',   default: false
+  o.path    '-o', '--output', 'The output file',        default: Pathname.pwd + "temp.md"
+end
+
+
+AG_COMMAND        = "ag --file-search-regex '\.txt$' e" # searching for the letter "e"
+CD_COMMAND        = "cd #{PROMPTS_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` to 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','')
+
+
+
+# The prompt_id is always the first argument
+if configatron.arguments.empty?
+  show_usage
+  exit
+end
+
+
+def process_arguments
+  prompt_id = configatron.arguments.shift
+
+  if prompt_id.include?('.')
+    error "Invalid prompt_id: #{configatron.prompt_id}"
+  else
+    configatron.input_files = []
+    configatron.arguments.each do |arg|
+      file_path = Pathname.new(arg)
+      if file_path.exist?
+        configatron.input_files << file_path
+      else
+        error "File does not exist: #{file_path}"
+      end
+    end
+  end
+
+  prompt_id # may be invalid
+end
+
+configatron.prompt_id = process_arguments
+
+abort_if_errors
+
+######################################################
+# Local methods
+
+def replace_keywords
+  defaults = configatron.prompt.parameters
+
+  configatron.prompt.keywords.each do |kw|
+    defaults[kw] = keyword_value(kw, defaults[kw])
+  end
+
+  configatron.prompt.parameters = defaults
+  configatron.prompt.save
+end
+
+
+def keyword_value(kw, default)
+  label = "Default: "
+  puts "#{kw} ..."
+  print label 
+  puts default.wrap.split("\n").join("\n"+" "*label.length)
+  a_string = Readline.readline("\n-=> ", false)
+  puts
+  a_string.empty? ? default : a_string
+end
+
+
+def log(prompt, answer)
+  f = File.open(PROMPT_LOG, "ab")
+
+  f.write <<~EOS
+    =======================================
+    == #{Time.now}
+    == #{prompt.path}
+
+    PROMPT: #{prompt}
+
+    RESULT:
+    #{answer}
+
+  EOS
+end
+
+
+def search_for_a_matching_prompt
+  found_prompt_ids  = PromptManager::Prompt.search(
+                        configatron.prompt_id
+                      )
+  if found_prompt_ids.size > 1
+    puts <<~EOS
+
+      Search Results
+      ==============
+
+      The following prompt IDs have the search term '#{configatron.prompt_id}'
+      #{found_prompt_ids.join(', ').wrap}
+
+    EOS
+    exit
+  else
+    configatron.prompt_id = found_prompt_ids.first
+    configatron.prompt    = PromptManager::Prompt.get(id: configatron.prompt_id)
+  end
+end
+
+######################################################
+# Main
+
+at_exit do
+  puts
+  puts "Done."
+  puts
+end
+
+ap configatron.to_h  if debug?
+
+
+begin
+  configatron.prompt = PromptManager::Prompt.get(id: configatron.prompt_id)
+rescue ArgumentError
+  search_for_a_matching_prompt
+end
+
+
+puts
+puts "PROMPT:"
+puts configatron.prompt.text.wrap
+puts
+
+unless configatron.prompt.keywords.empty?
+  replace_keywords 
+  configatron.prompt.build
+  configatron.prompt.save
+end
+
+command = AI_COMMAND + configatron.prompt.to_s
+
+configatron.input_files.each do |input_file|
+  command += " < #{input_file}"
+end
+
+print "\n\n" if verbose? && !keywords.empty?
+
+if verbose?
+  puts "="*42
+  puts command
+  puts "="*42
+  print "\n\n"
+end
+
+result = `#{command}`
+
+configatron.output.write result
+
+log configatron.prompt, result
+
+
+__END__

data/bin/aia_completion.sh

@@ -0,0 +1,33 @@
+# bin/aia_completion.sh
+# Setup a prompt completion for use with
+# aia (a Ruby program) AI Assistant
+#
+# Requires the $PROMPTS_DIR envar be set 
+
+# SMELL: Is this BASH-only or will it work with other shells?
+
+# Function to generate prompt completions for aia
+
+_aia_completion() {
+  # The current word being completed
+  local cur_word="${COMP_WORDS[COMP_CWORD]}"
+
+  # Store the previous directory to return to it later
+  local initial_pwd=$(pwd)
+
+  # Change directory to the prompts directory
+  cd $PROMPTS_DIR
+
+  # 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"
+
+  # Generate possible matches and store them in the COMPREPLY array
+  COMPREPLY=($(compgen -W "${files[*]}" -- "$cur_word"))
+}
+
+
+# Register the completion function for the aip command
+complete -F _aia_completion aia

data/lib/aia/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AIA
+  VERSION = "0.0.1"
+end

data/lib/aia.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "aia/version"
+
+module AIA
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: aia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dewayne VanHoozer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prompt_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: word_wrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug_me
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tocer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "A command-line AI Assistante (aia) that provides\nparameterized prompt
+  management (via the prompt_manager gem) to\nvarious backend gen-AI processes.  Currently
+  supports the `mods`\nCLI tool.  `aia`uses `ripgrep` and `fzf` command-line utilities
+  \nto search for and select prompt files to send to the backend gen-AI\ntool along
+  with supported context files.\n"
+email:
+- dvanhoozer@gmail.com
+executables:
+- aia
+- aia_completion.sh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/aia
+- bin/aia_completion.sh
+- lib/aia.rb
+- lib/aia/version.rb
+homepage: https://github.com/MadBomber/aia
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/MadBomber/aia
+  source_code_uri: https://github.com/MadBomber/aia
+  changelog_uri: https://github.com/MadBomber/aia
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: AI Assistant (aia) a command-ling utility
+test_files: []