aia 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63be1bf9f76bf377e09bd05cefc15651c05372863f411c343849d5a68d40a4d8
-  data.tar.gz: c979390da7d47566026c89590c283dda30c7cc9a4778242acf131d8a241b58ba
+  metadata.gz: 97bd3e1401d2883bca0d6ce3ab427a9fab12d3b71b2114a87fe278a0360f3693
+  data.tar.gz: 0333f04542cde2c853ccd00aff70e90b9d680960020f5187ab0b265916c24a27
 SHA512:
-  metadata.gz: ceb70944b23cfe72c06fd3aa62bc377cfa95122238c75cc68906ac6f3117de1d2e9809064343b642016d729dc6cdc8af55706db292858231d0777ad7508d61d0
-  data.tar.gz: c1eb7647759e8c0dd9429df75ac4943e7399887e1ef0ffb3ccbc2d9f716a33d114e836c00957ebd6c192515fe4d7a2db336c4e9aa36fc84c446b06da3b1641b9
+  metadata.gz: 17395c59e8aabf7d4994236fd407beaf2231c6d05744af1fcd84ae588ad7ffcd4abd853096728ca50fb09976075b4ac920200e6732d7736d072e2d2a4071e7fb
+  data.tar.gz: f8f21824485408330c31fe99b6b77fd072e08486ccd4293df9f9a55fc464369081f901f0bf6bc8c818e2238ad17d63ce497f164cd9960967d0f55942558c55c8

data/.semver

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

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 ## [Unreleased]
+
+## [0.5.8] 2024-01-17
+- Changed the behavior of the --dump option.  It must now be followed by path/to/file.ext where ext is a supported config file format: yml, yaml, toml
+
 ## [0.5.7] 2024-01-15
 - Added ERB processing to the config_file
 

data/README.md

@@ -124,7 +124,10 @@ OPTIONS
 
        --completion SHELL_NAME
 
-       --dump FORMAT
+       --dump PATH/TO/FILE.ext
+              Dump the current configuration to a file in the format denoted by the file’s
+              extension.  Currently only .yml, .yaml and .toml are acceptable file
+              extensions.  If the file exists, it will be over-written without warning.
 
        -e, --edit
               Invokes an editor on the prompt file.  You can make changes to the prompt file,
@@ -246,8 +249,9 @@ USAGE NOTES
        bash, zsh, or fish shells. It’s crucial to integrate the script into the shell’s
        runtime to take effect.
 
-       The --dump options will send the current configuration to STDOUT in the format
-       requested.  Both YAML and TOML formats are supported.
+       The --dump path/to/file.ext option will write the current configuration to a file in
+       the format requested by the file’s extension.  The following extensions are supported:
+       .yml, .yaml and .toml
 
 PROMPT DIRECTIVES
        Within a prompt text file any line that begins with “//” is considered a prompt
@@ -323,7 +327,7 @@ The `aia` configuration defaults can be over-ridden by system environment variab
 | VERBOSE       | FALSE         | AIA_VERBOSE |
 
 
-See the `@options` hash in the `cli.rb` file for a complete list.  There are some config items that do not necessarily make sense for use as an envar over-ride.  For example if you set `export AIA_DUMP=yaml` then `aia` would dump a config file in YAML format and exit every time it is ran until you finally did `unset AIA_DUMP`
+See the `@options` hash in the `cli.rb` file for a complete list.  There are some config items that do not necessarily make sense for use as an envar over-ride.  For example if you set `export AIA_DUMP_FILE=config.yaml` then `aia` would dump the current configuration config.yaml and exit every time it is ran until you finally `unset AIA_DUMP_FILE`
 
 In addition to these config items for `aia` the optional command line parameters for the backend prompt processing utilities (mods and sgpt) can also be set using envars with the "AIA_" prefix.  For example "export AIA_TOPP=1.0" will set the "--topp 1.0" command line option for the `mods` utility when its used as the backend processor.
 

data/justfile

@@ -116,7 +116,7 @@ module_git := "/Users/dewayne/just_modules/git.just"
 
 
 # Install Locally
-install: update_toc_in_readmen create_man_page test
+install: update_toc_in_readmen create_man_page flay
   rake install
 
 
@@ -129,6 +129,15 @@ update_toc_in_readmen:
 preview_man_page:
   kramdown-man {{RR}}/man/aia.1.md
 
+# Static Code Check
+flay: coverage
+  flay {{RR}}
+
+
+# View coverage report
+coverage: test
+  open {{RR}}/coverage/index.html
+
 
 # Run Unit Tests
 test:

data/lib/aia/cli.rb

@@ -134,7 +134,7 @@ class AIA::Cli
       #
       model:      ["gpt-4-1106-preview",  "--llm --model"],
       #
-      dump:       [nil,       "--dump"],
+      dump_file:  [nil,       "--dump"],
       completion: [nil,       "--completion"],
       #
       chat?:      [false,     "--chat"],
@@ -173,7 +173,7 @@ class AIA::Cli
   def execute_immediate_commands
     show_usage        if AIA.config.help?
     show_version      if AIA.config.version?
-    dump_config_file  if AIA.config.dump
+    dump_config_file  if AIA.config.dump_file
     show_completion   if AIA.config.completion
   end
 
@@ -181,13 +181,16 @@ class AIA::Cli
   def dump_config_file
     a_hash = prepare_config_as_hash
 
-    case AIA.config.dump.downcase
-    when 'yml', 'yaml'
-      puts YAML.dump(a_hash)
-    when 'toml'
-      puts TomlRB.dump(a_hash)
+    dump_file = Pathname.new AIA.config.dump_file
+    extname   = dump_file.extname.to_s.downcase
+
+    case extname
+    when '.yml', '.yaml'
+      dump_file.write YAML.dump(a_hash)
+    when '.toml'
+      dump_file.write TomlRB.dump(a_hash)
     else
-      abort "Invalid config file format request.  Only #{CF_FORMATS.join(', ')} are supported."
+      abort "Invalid config file format (#{extname}) request.  Only #{CF_FORMATS.join(', ')} are supported."
     end
 
     exit
@@ -200,9 +203,10 @@ class AIA::Cli
     a_hash          = AIA.config.to_h
     a_hash['dump']  = nil
 
-    a_hash.delete('arguments')
-    a_hash.delete('config_file')
-
+    %w[ arguments config_file dump_file ].each do |unwanted_key|
+      a_hash.delete(unwanted_key)
+    end
+    
     a_hash
   end
 
@@ -252,8 +256,14 @@ class AIA::Cli
             AIA.config[option_sym] = switch.include?('out_file') ? STDOUT : nil
             arguments.slice!(index,1)
           else
-            AIA.config[option_sym] = arguments[index + 1]
-            arguments.slice!(index,2)
+            value = arguments[index + 1]
+            if value.nil? || value.start_with?('-')
+              STDERR.puts "ERROR: #{option_sym} requires a parameter value"
+              exit(1)
+            else
+              AIA.config[option_sym] = value
+              arguments.slice!(index,2)
+            end
           end
         end
         
@@ -349,4 +359,3 @@ class AIA::Cli
     end
   end
 end
-

data/lib/aia/logging.rb

@@ -13,6 +13,9 @@ class AIA::Logging
                   'a'             # append to existing file
                 )
               else
+                # SMELL: Looks like you get logging whether you want it or not
+                # TODO: when path is nil create a fake logger
+                #       that does nothing
                 Logger.new(STDOUT) # Fall back to standard output if path is nil or invalid
               end
 

data/lib/aia/main.rb

@@ -9,13 +9,15 @@ require_relative 'dynamic_content'
 require_relative 'prompt'
 require_relative 'logging'
 require_relative 'tools'
+require_relative 'user_query'
 
 # Everything is being handled within the context
 # of a single class.
 
 class AIA::Main
   include AIA::DynamicContent
-
+  include AIA::UserQuery
+  
   attr_accessor :logger, :tools, :backend
 
   def initialize(args= ARGV)    
@@ -44,9 +46,13 @@ class AIA::Main
 
 
   def speak(what)
-    return unless AIA.config.speak?
+    return false unless AIA.config.speak?
+    # TODO: Consider putting this into a thread
+    #       so that it can speak at the same time
+    #       the output is going to the screen
     # MacOS uses the say command
     system "say #{Shellwords.escape(what)}"
+    true
   end
 
 
@@ -57,22 +63,6 @@ class AIA::Main
   end
 
 
-  # Function to prompt the user with a question using reline
-  def ask_question_with_reline(prompt)
-    if prompt.start_with?("\n")
-      puts
-      puts
-      prompt = prompt[1..]
-    end
-
-    answer = Reline.readline(prompt)
-    Reline::HISTORY.push(answer) unless answer.nil? || Reline::HISTORY.to_a.include?(answer)
-    answer
-    rescue Interrupt
-      ''
-  end
-
-
   def call
     @directives_processor.execute_my_directives
 

data/lib/aia/prompt.rb

@@ -3,10 +3,12 @@
 require 'reline'
 
 require_relative 'dynamic_content'
+require_relative 'user_query'
 
 class AIA::Prompt
   include AIA::DynamicContent
-
+  include AIA::UserQuery
+  
   #
   # used when no prompt_id is provided but there
   # are extra parameters that need to be passed
@@ -134,22 +136,6 @@ class AIA::Prompt
   end
 
 
-  # Function to prompt the user with a question using reline
-  def ask_question_with_reline(prompt)
-    if prompt.start_with?("\n")
-      puts
-      puts
-      prompt = prompt[1..]
-    end
-
-    answer = Reline.readline(prompt)
-    Reline::HISTORY.push(answer) unless answer.nil? || Reline::HISTORY.to_a.include?(answer)
-    answer
-    rescue Interrupt
-      ''
-  end
-
-
   # query the user for a value to the keyword allow the
   # reuse of the previous value shown as the default
   #

data/lib/aia/user_query.rb

@@ -0,0 +1,21 @@
+# aia/lia/aia/user_query.rb
+
+require 'reline'
+
+module AIA::UserQuery
+
+  # Function to prompt the user with a question using reline
+  def ask_question_with_reline(prompt)
+    if prompt.start_with?("\n")
+      puts
+      puts
+      prompt = prompt[1..]
+    end
+
+    answer = Reline.readline(prompt)
+    Reline::HISTORY.push(answer) unless answer.nil? || Reline::HISTORY.to_a.include?(answer)
+    answer
+    rescue Interrupt
+      ''
+  end
+end

data/main.just

@@ -18,7 +18,7 @@ module git /Users/dewayne/just_modules/git.just
 
 
 # Install Locally
-install: update_toc_in_readmen create_man_page test
+install: update_toc_in_readmen create_man_page flay
   rake install
 
 
@@ -31,6 +31,15 @@ update_toc_in_readmen:
 preview_man_page:
   kramdown-man {{RR}}/man/aia.1.md
 
+# Static Code Check
+flay: coverage
+  flay {{RR}}
+
+
+# View coverage report
+coverage: test
+  open {{RR}}/coverage/index.html
+
 
 # Run Unit Tests
 test:

data/man/aia.1

@@ -27,7 +27,8 @@ begin a chat session with the backend after the initial prompt response;  will s
 .TP
 \fB\-\-completion\fR \fISHELL\[ru]NAME\fP
 .TP
-\fB\-\-dump\fR \fIFORMAT\fP
+\fB\-\-dump\fR \fIPATH\[sl]TO\[sl]FILE\.ext\fP
+Dump the current configuration to a file in the format denoted by the file\[cq]s extension\.  Currently only \.yml, \.yaml and \.toml are acceptable file extensions\.  \fIIf the file exists, it will be over\-written without warning\.\fP
 .TP
 \fB\-e\fR, \fB\-\-edit\fR
 Invokes an editor on the prompt file\.  You can make changes to the prompt file, save it and the newly saved prompt will be processed by the backend\.
@@ -116,7 +117,7 @@ To acquire an OpenAI access key, first create an account on the OpenAI platform,
 .PP
 The \fB\-\-completion\fR option displays a script that enables prompt ID auto\-completion for bash, zsh, or fish shells\. It\[cq]s crucial to integrate the script into the shell\[cq]s runtime to take effect\.
 .PP
-The \fB\-\-dump\fR options will send the current configuration to STDOUT in the format requested\.  Both YAML and TOML formats are supported\.
+The \fB\-\-dump path\[sl]to\[sl]file\.ext\fR option will write the current configuration to a file in the format requested by the file\[cq]s extension\.  The following extensions are supported:  \.yml, \.yaml and \.toml
 .SH PROMPT DIRECTIVES
 .PP
 Within a prompt text file any line that begins with \[lq]\[sl]\[sl]\[rq] is considered a prompt directive\.  There are numerious prompt directives available\.  In the discussion above on the configuration you learned about the \[lq]\[sl]\[sl]config\[rq] directive\.

data/man/aia.1.md

@@ -31,8 +31,8 @@ The aia command-line tool is an interface for interacting with an AI model backe
 `--completion` *SHELL_NAME*
 : Show completion script for bash|zsh|fish - default is nil
 
-`--dump` *FORMAT*
-: Dump a Config File in [yaml | toml] to STDOUT - default is nil
+`--dump` *PATH/TO/FILE.ext*
+: Dump the current configuration to a file in the format denoted by the file's extension.  Currently only .yml, .yaml and .toml are acceptable file extensions.  *If the file exists, it will be over-written without warning.*
 
 `-e`, `--edit`
 : Invokes an editor on the prompt file.  You can make changes to the prompt file, save it and the newly saved prompt will be processed by the backend.
@@ -122,7 +122,8 @@ To acquire an OpenAI access key, first create an account on the OpenAI platform,
 
 The `--completion` option displays a script that enables prompt ID auto-completion for bash, zsh, or fish shells. It's crucial to integrate the script into the shell's runtime to take effect.
 
-The `--dump` options will send the current configuration to STDOUT in the format requested.  Both YAML and TOML formats are supported.
+The `--dump path/to/file.ext` option will write the current configuration to a file in the format requested by the file's extension.  The following extensions are supported:  .yml, .yaml and .toml
+
 
 ## PROMPT DIRECTIVES
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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
@@ -241,6 +255,7 @@ files:
 - lib/aia/tools/sgpt.rb
 - lib/aia/tools/subl.rb
 - lib/aia/tools/vim.rb
+- lib/aia/user_query.rb
 - lib/aia/version.rb
 - lib/core_ext/string_wrap.rb
 - main.just