aia 0.3.19 → 0.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 505546a036010eb8b0360f7fbfbb4c6494c311e98969c8095fa091882815aac2
-  data.tar.gz: 6f9323e50879c3b51a5ead99c29b1b41fc377dc1957283edb13e03bb30c866db
+  metadata.gz: b3061141e7330122b3ec6ffd64cf967d8fb0c4f8741531337bf32bfba28ee4ea
+  data.tar.gz: b62080a48b5d4afefb9da0eb5bdc1deff20a8c666048a755b38f759815bea8f3
 SHA512:
-  metadata.gz: 23926f77a010a023fd1fbbde152f83cfacd75f003bb2e060d4e2b4ca0cd7aecac6631b0520c5e3c6d56cbde31914f158f520f15bfa239a1a72bf682c5ea79032
-  data.tar.gz: 9d76ab35f70a13a4320d9fb4ee5f3fd47e4039c95e99fc02ce858977e179d1891d44fb08cf7cfc17975e6828dbe28d01d9d778d949c371e898e847e7fa865020
+  metadata.gz: c2e83d7db907fe2e3c91aae7acad12bf1569071479f99ba70f3626c98640323148e83b46cda2aa2353afcad54d740116999399e8e646b7db02b4a7e42916d0fc
+  data.tar.gz: 3f327c042a67a574231d9e25a5ed8df83ca6d4cf28444ae92be20d241480143ce95ec4e4238aab70caecf0c9c64417d579c6e8fd3dd3e7928c64f8e56fb2196a

data/.semver

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

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 ## [Unreleased]
+## [0.3.20] 2023-12-28
+- added work around to issue with multiple context files going to the `mods` backend
+- added shellwords gem to santize prompt text on the command line
+
 ## [0.3.19] 2023-12-26
 - major code refactoring.
 - supports config files \*.yml, \*.yaml and \*.toml

data/lib/aia/main.rb

@@ -20,9 +20,10 @@ class AIA::Main
     AIA::Cli.new(args)
 
     @logger = AIA::Logging.new(AIA.config.log_file)
-    @tools  = AIA::Tools.new
+    AIA::Tools.load_tools
 
-    tools.class.verify_tools
+    # TODO: still should verify that the tools are ion the $PATH
+    # tools.class.verify_tools
   end
 
 
@@ -37,14 +38,30 @@ class AIA::Main
     #       prompt keyword or process the prompt.  Do not
     #       want invalid files to make it this far.
 
+    found = AIA::Tools
+              .search_for(
+                name: AIA.config.backend, 
+                role: :backend
+              )
+
+    if found.empty?
+      abort "There are no :backend tools named #{AIA.config.backend}"
+    end
+
+    if found.size > 1
+      abort "There are #{found.size} :backend tools with the name #{AIAA.config.backend}"
+    end
+
+    backend_klass = found.first.klass
+
+    abort "backend not found: #{AIA.config.backend}" if backend_klass.nil?
 
-    mods    = AIA::Mods.new(
-                extra_options:  AIA.config.extra,
+    backend = backend_klass.new(
                 text:           @prompt.to_s,
                 files:          AIA.config.arguments    # FIXME: want validated context files
               )
 
-    result  = mods.run
+    result  = backend.run
 
     AIA.config.output_file.write result
 

data/lib/aia/tools/editor.rb

@@ -4,19 +4,21 @@
 
 
 class AIA::Editor < AIA::Tools
+
+  meta(
+    name:     'editor',
+    role:     :editor,
+    desc:     "Your default system $EDITOR",
+    url:      "unknown",
+    install:  "should already be installed",
+  )
+
   DEFAULT_PARAMETERS = ""
   
   attr_accessor :command
 
 
-  def initialize(file: "")
-    super
-    
-    @role         = :editor
-    @description  = "Your default system $EDITOR"
-    @url          = "unknown"
-    @install      = "should already be installed"
-
+  def initialize(file: "")    
     @file     = file
 
     discover_editor
@@ -39,7 +41,7 @@ class AIA::Editor < AIA::Tools
 
 
   def build_command
-    @command = "#{name} #{DEFAULT_PARAMETERS} #{@file}"
+    @command = "#{meta.name} #{DEFAULT_PARAMETERS} #{@file}"
   end
 
   

data/lib/aia/tools/mods.rb

@@ -1,29 +1,28 @@
 # lib/aia/tools/mods.rb
 
 class AIA::Mods < AIA::Tools
+
+  meta(
+    name:     'mods',
+    role:     :backend,
+    desc:     'AI on the command-line',
+    url:      'https://github.com/charmbracelet/mods',
+    install:  'brew install mods',
+  )
+
+  
   DEFAULT_PARAMETERS = [
     "--no-limit"              # no limit on input context
   ].join(' ').freeze
 
-  attr_accessor :command, :extra_options, :text, :files
-
-  # TODO: put the prompt text to be resolved into a 
-  #       temporary text file then cat that file into mods.
-  #       This will keep from polluting the CLI history with
-  #       lots of text
+  attr_accessor :command, :text, :files
 
 
   def initialize(
-      extra_options:  "", # everything after -- on command line
       text:           "", # prompt text after keyword replacement
       files:          []  # context file paths (Array of Pathname)
     )
-    super
-    @role         = :gen_ai
-    @description  = 'AI on the command-line'
-    @url          = 'https://github.com/charmbracelet/mods'
-  
-    @extra_options  = extra_options
+
     @text           = text
     @files          = files
 
@@ -31,46 +30,84 @@ class AIA::Mods < AIA::Tools
   end
 
 
+  def sanitize(input)
+    Shellwords.escape(input)
+  end
+
+
   def build_command
     parameters  = DEFAULT_PARAMETERS.dup + " "
-    parameters += "-f "                     if ::AIA.config.markdown?
-    parameters += "-m #{AIA.config.model} " if ::AIA.config.model
-    parameters += @extra_options
+    parameters += "-f "                     if AIA.config.markdown?
+    parameters += "-m #{AIA.config.model} " if AIA.config.model
+    parameters += AIA.config.extra
     @command    = "mods #{parameters} "
-    @command   += %Q["#{@text}"]        # TODO: consider using the pipeline
-
-    @files.each {|f| @command += " < #{f}" }
+    @command   += sanitize(@text)
+
+    # context = @files.join(' ')
+    #
+    # unless context.empty?
+    #   if @files.size > 1
+    #     # FIXME:  This syntax breaks mods which does not know how
+    #     #         to read the temporary file descriptor created
+    #     #         by the shell
+    #     @command += " <(cat #{context})"
+    #   else
+    #     @command += " < #{context}"
+    #   end
+    # end
 
     @command
   end
 
 
   def run
-    `#{command}`
+    case @files.size
+    when 0
+      @result = `#{build_command}`
+    when 1
+      @result = `#{build_command} < #{@files.first}`
+    else
+      create_temp_file_with_contexts
+      run_mods_with_temp_file
+      clean_up_temp_file
+    end
+    
+    @result
   end
-end
-
-__END__
-
+  
+  
+  # Create a temporary file that concatenates all contexts,
+  # to be used as STDIN for the 'mods' utility
+  def create_temp_file_with_contexts
+    @temp_file = Tempfile.new('mods-context')
+
+    @files.each do |file|
+      content = File.read(file)
+      @temp_file.write(content)
+      @temp_file.write("\n")
+    end
 
-  # Execute the command and log the results
-  def send_prompt_to_external_command
-    command = build_command
+    @temp_file.close
+  end
+  
 
-    puts command if verbose?
+  # Run 'mods' with the temporary file as STDIN
+  def run_mods_with_temp_file
+    command = "#{build_command} < #{@temp_file.path}"
     @result = `#{command}`
+  end
+  
 
-    if @output.nil?
-      puts @result
-    else
-      @output.write @result
-    end
-
-    @result
+  # Clean up the temporary file after use
+  def clean_up_temp_file
+    @temp_file.unlink if @temp_file
   end
+end
 
+__END__
 
 
+    
 
 
 ##########################################################

data/lib/aia/tools/sgpt.rb

@@ -1,12 +1,17 @@
 # lib/aia/tools/sgpt.rb
 
 class AIA::Sgpt < AIA::Tools
+
+  meta(
+    name:     'sgpt',
+    role:     :backend,
+    desc:     "shell-gpt",
+    url:      "https://github.com/TheR1D/shell_gpt",
+    install:  "pip install shell-gpt",
+  )
+
   def initialize
-    super
-    @role     = :backend
-    @desc     = "shell-gpt"
-    @url      = "https://github.com/TheR1D/shell_gpt"
-    @install  = "pip install shell-gpt"
+    # TODO: something
   end
 end
 

data/lib/aia/tools/subl.rb

@@ -1,6 +1,16 @@
 # lib/aia/tools/subl.rb
 
 class AIA::Subl < AIA::Tools
+
+  meta(
+    name:     'subl',
+    role:     :editor,
+    desc:     "Sublime Text Editor",
+    url:      "https://www.sublimetext.com/",
+    install:  "echo 'Download from website'",
+  )
+
+
   DEFAULT_PARAMETERS = [
     "--new-window",   # Open a new window
     "--wait",         # Wait for the files to be closed before returning
@@ -10,13 +20,6 @@ class AIA::Subl < AIA::Tools
 
 
   def initialize(file: "")
-    super
-    
-    @role     = :editor
-    @desc     = "Sublime Text Editor"
-    @url      = "https://www.sublimetext.com/"
-    @install  = "echo 'Download from website'"
-
     @file     = file
 
     build_command
@@ -24,7 +27,7 @@ class AIA::Subl < AIA::Tools
 
 
   def build_command
-    @command = "#{name} #{DEFAULT_PARAMETERS} #{@file}"
+    @command = "#{meta.name} #{DEFAULT_PARAMETERS} #{@file}"
   end
 
   

data/lib/aia/tools/temp.md

@@ -0,0 +1,97 @@
+# lib/aia/tools.rb
+
+```ruby
+require 'hashie'
+
+module AIA
+  class Tools
+    @subclasses = {}
+
+    class << self
+      attr_reader :subclasses, :metadata
+
+      def inherited(subclass)
+        @subclasses[subclass.name.split('::').last.downcase] = subclass
+        subclass.instance_variable_set(:@metadata, Jashie::Mash.new)
+      end
+
+      def meta
+        @metadata ||= Jashie::Mash.new
+      end
+
+      def define_metadata(&block)
+        meta.instance_eval(&block)
+      end
+
+      def search_for(name: nil, role: nil)
+        return subclasses[name.downcase] if name
+        return subclasses.values.select { |subclass| subclass.meta.role == role } if role
+      end
+    end
+
+    def self.method_missing(name, *args, &block)
+      @metadata.public_send(name, *args, &block)
+    end
+
+    def self.respond_to_missing?(method_name, include_private = false)
+      @metadata.respond_to?(method_name) || super
+    end
+  end
+end
+```
+
+# lib/aia/tools/mods.rb
+
+```ruby
+require_relative 'tools'
+
+module AIA
+  class Mods < Tools
+    DEFAULT_PARAMETERS = "--no-limit".freeze
+
+    attr_accessor :command, :extra_options, :text, :files
+
+    define_metadata do
+      role :backend
+      desc 'AI on the command-line'
+      url  'https://github.com/charmbracelet/mods'
+    end
+
+    def initialize(extra_options: "", text: "", files: [])
+      @extra_options = extra_options
+      @text = text
+      @files = files
+      build_command
+    end
+
+    def build_command
+      parameters = DEFAULT_PARAMETERS.dup + " "
+      parameters += "-f " if ::AIA.config.markdown?
+      parameters += "-m #{AIA.config.model} " if ::AIA.config.model
+      parameters += @extra_options
+      @command = "mods #{parameters}"
+      @command += %Q["#{@text}"]
+
+      @files.each { |f| @command += " < #{f}" }
+
+      @command
+    end
+
+    def run
+      `#{@command}`
+    end
+  end
+end
+```
+
+```ruby
+# Example usage:
+# mods_class = AIA::Tools.search_for(name: 'mods')
+# mods_instance = mods_class.new(text: "Hello, mods!")
+# result = mods_instance.run
+
+# backend_tools = AIA::Tools.search_for(role: :backend)
+```
+
+Note: The `Jashie::Mash` class is assumed to behave like `Hashie::Mash` (or similar) in providing a flexible object for storing metadata. You'll need to define `Jashie::Mash` or import a library that provides a similar functionality to match this example.
+

data/lib/aia/tools/vim.rb

@@ -1,6 +1,15 @@
 # lib/aia/tools/vim.rb
 
 class AIA::Vim < AIA::Tools
+
+  meta(
+    name:     'vim',
+    role:     :editor,
+    desc:     "Vi IMproved (VIM)",
+    url:      "https://www.vim.org",
+    install:  "brew install vim",
+  )
+
   DEFAULT_PARAMETERS = [
     " ", # no parameters 
   ].join(' ')
@@ -9,13 +18,6 @@ class AIA::Vim < AIA::Tools
 
 
   def initialize(file: "")
-    super
-    
-    @role         = :editor
-    @description  = "Vi IMproved (VIM)"
-    @url          = "https://www.vim.org"
-    @install      = "brew install vim"
-
     @file     = file
 
     build_command
@@ -23,7 +25,7 @@ class AIA::Vim < AIA::Tools
 
 
   def build_command
-    @command = "#{name} #{DEFAULT_PARAMETERS} #{@file}"
+    @command = "#{meta.name} #{DEFAULT_PARAMETERS} #{@file}"
   end
 
   

data/lib/aia/tools.rb

@@ -1,77 +1,50 @@
 # lib/aia/tools.rb
 
-class AIA::Tools
-  @@subclasses = []
-
-  def self.inherited(subclass)
-    @@subclasses << subclass
-  end
+require 'hashie'
 
-  attr_accessor :role, :name, :description, :url, :install
-  
-
-  def initialize(*)
-    @role         = :role
-    @name         = self.class.name.split('::').last.downcase
-    @description  = "description"
-    @url          = "URL"
-    @install      = "brew install #{name}"
-  end
+class AIA::Tools
+  @@catalog = []
 
+  class << self
+    def inherited(subclass)
+      subclass_meta = Hashie::Mash.new(klass: subclass)
+      subclass.instance_variable_set(:@_metadata, subclass_meta)
 
-  def installed?
-    path = `which #{name}`.chomp
-    !path.empty? && File.executable?(path)
-  end
+      @@catalog << subclass_meta
+    end
 
 
-  def help
-    `#{name} --help`
-  end
-  
+    def meta(metadata = nil)
+      return @_metadata if metadata.nil?
 
-  def version
-    `#{name} --version`
-  end
+      @_metadata  = Hashie::Mash.new(metadata)
+      entry       = @@catalog.detect { |item| item[:klass] == self }
+      
+      entry.merge!(metadata) if entry
+    end
 
 
-  #########################################
-  class << self
-    def tools
-      @@subclasses.map(&:name)
+    def get_meta
+      @_metadata
     end
 
 
-    def verify_tools
-      missing_tools = @@subclasses.map(&:new).reject(&:installed?)
-      unless missing_tools.empty?
-        puts format_missing_tools_response(missing_tools)
+    def search_for(criteria = {})
+      @@catalog.select do |meta|
+        criteria.all? { |k, v| meta[k] == v }
       end
     end
 
 
-    def format_missing_tools_response(missing_tools)
-      response = <<~EOS
-
-        WARNING: AIA makes use of external CLI tools that are missing.
-
-        Please install the following tools:
+    def catalog
+      @@catalog
+    end
 
-      EOS
 
-      missing_tools.each do |tool|
-        response << "  #{tool.name}: install from #{tool.url}\n"
+    def load_tools
+      Dir.glob(File.join(File.dirname(__FILE__), 'tools', '*.rb')).each do |file|
+        require file
       end
-
-      response
     end
   end
 end
-
-
-(Pathname.new(__dir__)+"tools")
-  .glob('*.rb')
-  .each do |tool|
-    require_relative "tools/#{tool.basename.to_s}" 
-  end
-

data/lib/aia.rb

@@ -6,6 +6,7 @@ include DebugMe
 require 'hashie'
 require 'pathname'
 require 'readline'
+require 'shellwords'
 require 'tempfile'
 
 require 'prompt_manager'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 0.3.20
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2023-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shellwords
+  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: toml-rb
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,7 @@ files:
 - lib/aia/tools/mods.rb
 - lib/aia/tools/sgpt.rb
 - lib/aia/tools/subl.rb
+- lib/aia/tools/temp.md
 - lib/aia/tools/vim.rb
 - lib/aia/version.rb
 - lib/core_ext/string_wrap.rb