prompt_manager 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c96927dad3be1d7e793e3edd5d3df3e3a12999fcec57ad01d3d773d9b40e674
-  data.tar.gz: 4aa47ce704540fa933dbdf30d3afddbb3704bd541b4dab1f7a751e0e461f3c1e
+  metadata.gz: 6785a25ba5b2c7e8bacf3bdba572eced1c95bdab2f83144a4ec32f0ae359eeb1
+  data.tar.gz: fd21f559d660899ec94765b7ef3f3fd6a4579ac625a44af428ab7771ba934713
 SHA512:
-  metadata.gz: '0857d6d0532c0c1293799e760933e5bf2ee1a82f8cfdce6dd649b187f724e31935bf959b04c8058a90877525751cf99deaa4fd51a9cc64d0259a3d4b1e40de38'
-  data.tar.gz: 59d2e1cabed3a87766092f56eae6ed7e7d30a2c0d0b3e3dc2efd93fe9ce79d97ce7ee5af3d1beae6896aed3a1754649dc7a7f3bbdec1e0566015640d8f7f2128
+  metadata.gz: 4373edc2de2e838a606ab748a81a73bc15242f9bac45343ce5d89fa2cd13fd57b228bf1f34e1a870e31640ff7f957382d44b65bcf0fa7360d004b95854965dae
+  data.tar.gz: e1b04a1643de8de6a24618d5e2737241b17580922436bf6f3fa73e9caf394f9122426721eb3a44b37f227bd2eba21b0e20fad150a2b98265d707be033a7c4887

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] = 2023-11-28
+
+- **Breaking change** The value of the parameters Hash for a keyword is now an Array instead of a single value.  The last value in the Array is always the most recent value used for the given keyword.  This was done to support the use of a Readline::History object editing in the [aia](https://github.com/MadBomber/aia) CLI tool
+
 ## [0.2.0] - 2023-11-21
 
 - **Breaking change to FileSystemAdapter config process**

data/README.md

@@ -2,7 +2,8 @@
 
 Manage the parameterized prompts (text) used in generative AI (aka chatGPT, OpenAI, _et.al._) using storage adapters such as FileSystemAdapter, SqliteAdapter and ActiveRecordAdapter.
 
-**Breaking Change** in version 0.2.0 for `FileSystemAdapter` configuration. See [Configuration](#configuration) to see how the new `config` block works.
+**Breaking Change** in version 0.3.0 - The value of the parameters Hash for a keyword is now an Array instead of a single value.  The last value in the Array is always the most recent value used for the given keyword.  This was done to support the use of a Readline::History object editing in the [aia](https://github.com/MadBomber/aia) CLI tool
+
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -19,6 +20,8 @@ Manage the parameterized prompts (text) used in generative AI (aka chatGPT, Open
           - [prompts_dir](#prompts_dir)
           - [search_proc](#search_proc)
           - [File Extensions](#file-extensions)
+        - [Example Prompt Text File](#example-prompt-text-file)
+        - [Example Prompt Parameters JSON File](#example-prompt-parameters-json-file)
         - [Extra Functionality](#extra-functionality)
       - [SqliteAdapter](#sqliteadapter)
       - [ActiveRecordAdapter](#activerecordadapter)
@@ -118,6 +121,36 @@ Currently the `FileSystemAdapter` only supports a JSON serializer for its parame
 
 They exist so that there is a platform on to which other storage adapters can be built or serializers added.  This is not currently on the roadmap.
 
+##### Example Prompt Text File
+
+```text
+# ~/.prompts/joke.txt
+# Desc: Tell some jokes
+
+Tell me a few [KIND] jokes about [SUBJECT]
+```
+
+Note the command lines at the top.  This is a convention I use.  It is not part of the software.  I find it helpful in documenting the prompt.
+
+##### Example Prompt Parameters JSON File
+
+```json
+{
+  "[KIND]": [
+    "pun",
+    "family friendly"
+  ],
+  "[SUBJECT]": [
+    "parrot",
+    "garbage man",
+    "snowman",
+    "weather girl"
+  ]
+}
+```
+
+The last value in the keyword's Array is the most recent value used for that keyword.  This is a functionality established since v0.3.0.  Its purpose is to provide a history of values from which a user can select to repeat a previous value or to select ta previous value and edit it into something new.
+
 ##### Extra Functionality
 
 The `FileSystemAdapter` adds two new methods for use by the `Prompt` class:

data/lib/prompt_manager/prompt.rb

@@ -108,7 +108,7 @@ class PromptManager::Prompt
   def build
     @prompt = text.gsub(PARAMETER_REGEX) do |match|
                 param_name = match
-                parameters[param_name] || match
+                parameters[param_name].last || match
               end
 
     remove_comments
@@ -120,7 +120,7 @@ class PromptManager::Prompt
   def update_keywords
     @keywords = @text.scan(PARAMETER_REGEX).flatten.uniq
     keywords.each do |kw|
-      @parameters[kw] = "" unless @parameters.has_key?(kw)
+      @parameters[kw] = [] unless @parameters.has_key?(kw)
     end
   end
 

data/lib/prompt_manager/storage/active_record_adapter.rb

@@ -63,4 +63,99 @@ class PromptManager::Storage::ActiveRecordAdapter
   def find_prompt(prompt_id)
     model_class.find_by(id: prompt_id) || raise('Prompt not found')
   end
-end
+end
+
+
+__END__
+
+# prompt_manager/lib/prompt_manager/storage/active_record_adapter.rb
+
+require 'active_record'
+
+module PromptManager
+  module Storage
+    class ActiveRecordAdapter
+
+      # Define models for ActiveRecord
+      class Prompt < ActiveRecord::Base
+        validates :unique_id, presence: true
+        validates :text, presence: true
+      end
+
+      class PromptParameter < ActiveRecord::Base
+        belongs_to :prompt
+        validates :key, presence: true
+        serialize :value
+      end
+
+      def initialize
+        unless ActiveRecord::Base.connected?
+          raise ArgumentError, "ActiveRecord is not connected"
+        end
+      end
+
+      def get(id:)
+        prompt = Prompt.find_by(unique_id: id)
+        return nil unless prompt
+
+        parameters = prompt.prompt_parameters.index_by(&:key)
+
+        {
+          id:         prompt.unique_id,
+          text:       prompt.text,
+          parameters: parameters.transform_values(&:value)
+        }
+      end
+
+      def save(id:, text: "", parameters: {})
+        prompt = Prompt.find_or_initialize_by(unique_id: id)
+        prompt.text = text
+        prompt.save!
+
+        parameters.each do |key, value|
+          parameter = PromptParameter.find_or_initialize_by(prompt: prompt, key: key)
+          parameter.value = value
+          parameter.save!
+        end
+      end
+
+      def delete(id:)
+        prompt = Prompt.find_by(unique_id: id)
+        return unless prompt
+        
+        prompt.prompt_parameters.destroy_all
+        prompt.destroy
+      end
+
+      def search(for_what)
+        query = '%' + for_what.downcase + '%'
+        Prompt.where('LOWER(text) LIKE ?', query).pluck(:unique_id)
+      end
+
+      def list(*)
+        Prompt.pluck(:unique_id)
+      end
+
+      private
+
+      # This is an example of how the database connection setup could look like, 
+      # but it should be handled externally in the actual application setup.
+      def self.setup_database_connection
+        ActiveRecord::Base.establish_connection(
+          adapter: 'sqlite3',
+          database: 'prompts.db'
+        )
+      end
+    end
+  end
+end
+
+# After this, you would need to create a database migration to generate the required tables.
+# Additionally, you have to establish an ActiveRecord connection before using this adapter,
+# typically in the environment setup of your application.
+
+# Keep in mind you need to create migrations for both the Prompt and PromptParameter models,
+# and manage the database schema using ActiveRecord migrations. This adapter assumes that the
+# database structure is already in place and follows the schema inferred by the models in the adapter.
+
+

data/lib/prompt_manager/storage/sqlite_adapter.rb

@@ -61,5 +61,96 @@ class PromptManager::Storage::SqliteAdapter
 end
 
 
+__END__
+
+
+require 'sequel'
+require 'pathname'
+require 'json'
+
+module PromptManager
+  module Storage
+    class SqliteAdapter
+      DEFAULT_DB_FILE = 'prompts.sqlite3'.freeze
+
+      class << self
+        attr_accessor :db_file, :db
+
+        def config
+          if block_given?
+            yield self
+          else
+            raise ArgumentError, 'No block given to config'
+          end
+
+          self.db = Sequel.sqlite(db_file || DEFAULT_DB_FILE) # Use provided db_file or default
+          create_tables unless db.table_exists?(:prompts)
+        end
+
+        # Define the necessary tables within the SQLite database if they don't exist
+        def create_tables
+          db.create_table :prompts do
+            primary_key :id
+            String :prompt_id, unique: true, null: false
+            Text :text
+            Json :parameters
+
+            index :prompt_id
+          end
+        end
+      end
+
+      def initialize
+        @db = self.class.db
+      end
+
+      def get(id:)
+        validate_id(id)
+        result = @db[:prompts].where(prompt_id: id).first 
+        raise ArgumentError, 'Prompt not found' unless result
+
+        {
+          id:         result[:prompt_id],
+          text:       result[:text],
+          parameters: result[:parameters]
+        }
+      end
+
+      def save(id:, text: '', parameters: {})
+        validate_id(id)
+        rec = @db[:prompts].where(prompt_id: id).first
+        if rec
+          @db[:prompts].where(prompt_id: id).update(text: text, parameters: Sequel.pg_json(parameters))
+        else
+          @db[:prompts].insert(prompt_id: id, text: text, parameters: Sequel.pg_json(parameters))
+        end
+      end
+
+      def delete(id:)
+        validate_id(id)
+        @db[:prompts].where(prompt_id: id).delete
+      end
+
+      # Return an Array of prompt IDs
+      def list()
+        @db[:prompts].select_map(:prompt_id)
+      end
+
+      def search(for_what)
+        search_term = for_what.downcase
+        @db[:prompts].where(Sequel.ilike(:text, "%#{search_term}%")).select_map(:prompt_id)
+      end
+
+      private
+
+      # Validate that the ID contains good characters.
+      def validate_id(id)
+        raise ArgumentError, "Invalid ID format id: #{id}" unless id =~ /^[a-zA-Z0-9\-\/_]+$/
+      end
+    end
+  end
+end
+
+
 
 

data/lib/prompt_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PromptManager
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prompt_manager
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print