aia 0.0.4 → 0.3.0

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.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prompt_manager
@@ -103,8 +103,28 @@ files:
 - bin/aia
 - bin/aia_completion.sh
 - lib/aia.rb
+- lib/aia/cli.rb
+- lib/aia/configuration.rb
+- lib/aia/external.rb
+- lib/aia/external/,keep
+- lib/aia/external/.irbrc
+- lib/aia/external/ag.rb
+- lib/aia/external/bat.rb
+- lib/aia/external/fzf.rb
+- lib/aia/external/glow.rb
+- lib/aia/external/mods.rb
+- lib/aia/external/rg.rb
+- lib/aia/external/sgpt.rb
+- lib/aia/external/subl.rb
+- lib/aia/external/temp.md
+- lib/aia/external/tool.rb
+- lib/aia/external_two.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