prompt_manager 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add8f0261dd0fd2e91e8195330d923e8806c2e3a7243cfb51ce70a589fc76ef2
-  data.tar.gz: 73b69061afdd242679c231949fba6a3b075f486feb20113cb838d0345dd2ffcf
+  metadata.gz: 60ae8d4c5f669935906248aa0e5ffc628e6ef0fbcc28eb31c889eb85b200d370
+  data.tar.gz: 44e51b38634667930b5524232cefd63fe0dab3ef334500714361680009186bfd
 SHA512:
-  metadata.gz: a65630d9623b49c34265b137f03cfb032ec645f736e9ca9327e2aaf045cdd0e2818e28e1b000bc80b32016f32a59192861db6cc7596c8ea6834b2c386ce1aac2
-  data.tar.gz: ec16e90d781c354875932d454d04783bcd46b10f7a815ffe94204fd17475bc2930cb6627e55072ec9b937512031033bdf01eda83d62ed126d2833801fd156e0c
+  metadata.gz: 634cc2d1cfdedaf1ca5f5a232334b7e8ccbad25dbb48e669daddf831e43eb45f03367f2921561cdb8ddcf1675ea48f1dcf8cc40defb479aa1eced3bb493442f9
+  data.tar.gz: f04cc92a7ac3c286fb3958eaa44358c402899a121e89ca41aa7bddd30c41bd704bed55dd57775340c622671d0fbf36eef48171ffc3d290f220d6306622486ef3

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## [Unreleased]
+## [0.4.0] = 2023-12-19
+- Add "//directives param(s)" with keywords just like the prompt text.
+
+## [0.3.3] = 2023-12-01
+- Added example of using the `search_proc` config parameter with the FileSystemAdapter.
+
+## [0.3.2] = 2023-12-01
+
+- The ActiveRecordAdapter is passing its unit tests
+- Dropped the concept of an sqlite3 adapter since active record can be used to access sqlite3 databases as well as the big boys.
 
 ## [0.3.0] = 2023-11-28
 

data/README.md

@@ -14,18 +14,24 @@ Manage the parameterized prompts (text) used in generative AI (aka chatGPT, Open
   - [Overview](#overview)
     - [Generative AI (gen-AI)](#generative-ai-gen-ai)
       - [What does a keyword look like?](#what-does-a-keyword-look-like)
-    - [Storage Adapters](#storage-adapters)
-      - [FileSystemAdapter](#filesystemadapter)
-        - [Configuration](#configuration)
-          - [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)
-      - [Other Potential Storage Adapters](#other-potential-storage-adapters)
+      - [All about directives](#all-about-directives)
+      - [Comments Are Ignored](#comments-are-ignored)
+  - [Storage Adapters](#storage-adapters)
+    - [FileSystemAdapter](#filesystemadapter)
+      - [Configuration](#configuration)
+        - [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)
+    - [ActiveRecordAdapter](#activerecordadapter)
+      - [Configuration](#configuration-1)
+        - [model](#model)
+        - [id_column](#id_column)
+        - [text_column](#text_column)
+        - [parameters_column](#parameters_column)
+    - [Other Potential Storage Adapters](#other-potential-storage-adapters)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -46,8 +52,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 See [examples/simple.rb](examples/simple.rb)
 
+See also [examples/using_search_proc.rb](examples/using_search_proc.rb)
+
 ## Overview
 
+The `prompt_manager` gem provides functionality to manage prompts that have keywords and directives for use with generative AI processes.
+
 ### Generative AI (gen-AI)
 
 Gen-AI deals with the conversion (some would say execution) of a human natural language text (the "prompt") into somthing else using what are known as large language models (LLM) such as those available from OpenAI.  A parameterized prompt is one in which there are embedded keywords (parameters) which are place holders for other text to be inserted into the prompt.
@@ -60,13 +70,57 @@ The current hard-coded REGEX for a [KEYWORD] identifies any all [UPPERCASE_TEXT]
 
 This is just the initial convention adopted by prompt_manager. It is intended that this REGEX be configurable so that the prompt_manager can be used with other conventions.
 
-### Storage Adapters
+#### All about directives
+
+A directive is a line in the prompt text that starts with the two characters '//' - slash slash - just like in the old days of IBM JCL - Job Control Language.  A prompt can have zero or more directives.  Directives can have parameters and can make use of keywords.
+
+The `prompt_manager` only collections directives.  It extracts keywords from directive lines and provides the substitution of those keywords with other text just like it does for the prompt.  Remember a directive is part of the prompt.
+
+Here is an example problem with comments, directives and keywords:
+
+```
+# prompts/sing_a_song.txt
+# Desc: Has the computer sing a song
+
+//TextToSpeech [LANGUAGE] [VOICE NAME]
+
+Say the lyrics to the song [SONG NAME].  Please provide only the lyrics without commentary.
+
+__END__
+Computers will never replace Frank Sinatra
+```
+
+Getting directives from a prompt is as easy as getting the kewyords:
+
+```ruby
+prompt = PromptManager::Prompt.new(...)
+prompt.keywords   #=> an Array
+prompt.directives #=> a Hash
+
+# to_s builds the prompt by substituting
+# values for keywords amd removing comments.
+# The resulting text contains directives and
+# prompt text ready for the LLM process.
+puts prompt.to_s  
+```
+
+The Hash returned by the `prompt.directives` method has as its key the directive name (without the double-slash).  Its also case-sensitive.  So any typo made in editing the prompt with regard to the case of the directive's name will impact the backend processing of the prompt.
+
+The value for each key is a String exactly as entered in the prompt file.
+
+#### Comments Are Ignored
+
+The `prompt_manager` gem ignores comments.  A line that begins with the '#' - pound (aka hash) character - is a line comment.  Any lines that follow a line that is '__END__ at the end of a file are considered comments.  Basically the '__END__' the end of the file.  Nothing is process following that line.
+
+The gem also ignores blank lines.
+
+## Storage Adapters
 
 A storage adapter is a class instance that ties the `PromptManager::Prompt` class to a storage facility that holds the actual prompts. Currently there are 3 storage adapters planned for implementation.
 
 The `PromptManager::Prompt` to support a small set of methods.  A storage adapter can provide "extra" class or instance methods that can be used through the Prompt class.  See the `test/prompt_manager/prompt_test.rb` for guidance on creating a new storage adapter.
 
-#### FileSystemAdapter
+### FileSystemAdapter
 
 This is the first storage adapter developed. It saves prompts as text files within the file system inside a designated `prompts_dir` (directory) such as `~/.prompts` or where it makes the most sense to you.  Another example would be to have your directory on a shared file system so that others can use the same prompts.
 
@@ -74,16 +128,16 @@ The `prompt ID` is the basename of the text file. For example `todo.txt` is the
 
 The parameters for the `todo` prompt ID are saved in the same directory as `todo.txt` in a JSON file named `todo.json` (also in the examples directory.)
 
-##### Configuration
+#### Configuration
 
 Use a `config` block to establish the configuration for the class.
 
 ```ruby
 PromptManager::Storage::FileSystemAdapter.config do |o|
-  o.prompts_dir = "path/to/prompts_directory" 
-  o.search_proc = -> (q) { "ag -l #{q} #{prompts_dir} | reformat" } 
-  o.prompt_extension = '.txt' # default
-  o.params_extension = '.json' # the default
+  o.prompts_dir       = "path/to/prompts_directory" 
+  o.search_proc       = nil     # default 
+  o.prompt_extension  = '.txt'  # default
+  o.params_extension  = '.json' # default
 end
 ```
 
@@ -98,19 +152,21 @@ PromptManager::Prompt
       end.new
 ```
 
-###### prompts_dir
+##### prompts_dir
 
 This is either a `String` or a `Pathname` object.  All file paths are maintained in the class as `Pathname` objects.  If you provide a `String` it will be converted.  Relative paths will be converted to absolute paths.
 
 An `ArgumentError` will be raised when `prompts_dir` does not exist or if it is not a directory.
 
-###### search_proc
+##### search_proc
+
+The default for `search_proc` is nil which means that the search will be preformed by a default `search` method which is basically reading all the prompt files to see which ones contain the search term. It will return an Array of prompt IDs for each prompt file found that contains the search term.  Its up to the application to select which returned prompt ID to use. 
 
-The default for `search_proc` is nil.  In this case the search will be preformed by a default `search` method which is basically reading all the prompt files to see which ones contain the search term.  There are faster ways to do this kind of thing using CLI=based utilities.
+There are faster ways to search and select files.  For example there are specialized search and selection utilities that are available for the command line. The `examples` directory contains a `bash` script named `rgfzf` that uses `rg` (aka `ripgrep`) to do the searching and `fzf` to do the selecting.
 
-TODO: add a example to the examples directory on how to integrate with command line utilities.
+See [examples/using_search_proc.rb](examples/using_search_proc.rb)
 
-###### File Extensions
+##### File Extensions
 
 These two configuration options are `String` objects that must start with a period "." utherwise an `ArgumentError` will be raised.
 
@@ -121,7 +177,7 @@ 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
+#### Example Prompt Text File
 
 ```text
 # ~/.prompts/joke.txt
@@ -132,7 +188,7 @@ 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
+#### Example Prompt Parameters JSON File
 
 ```json
 {
@@ -151,7 +207,7 @@ Note the command lines at the top.  This is a convention I use.  It is not part
 
 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
+#### Extra Functionality
 
 The `FileSystemAdapter` adds two new methods for use by the `Prompt` class:
 * list - returns an Array of prompt IDs
@@ -160,15 +216,50 @@ The `FileSystemAdapter` adds two new methods for use by the `Prompt` class:
 Use the `path(prompt_id)` form against the `Prompt` class
 Use `prompt.path` when you have an instance of a `Prompt`
 
-#### SqliteAdapter
+### ActiveRecordAdapter
+
+The `ActiveRecordAdapter` assumes that there is a database already configured by the application program that is requiring `prompt_manager` which has a model that contains prompt content.  This model must have at least three columns which contain content for:
+
+- a prompt ID
+- prompt text
+- prompt parameters
+
+The model and the columns for these three elements can have any name.  Those names are provided to the `ActiveRecordAdapter` in its config block.
+
+
+#### Configuration
+
+Use a `config` block to establish the configuration for the class.
+
+The `PromptManager::Prompt` class expects an instance of a storage adapter class.  By convention storage adapter class config methods will return `self` so that a simple `new` after the config will establish the instance.
+
+```ruby
+PromptManager::Prompt
+  .storage_adapter = 
+    PromptManager::Storage::ActiveRecordAdapter.config do |config|
+      config.model              = DbPromptModel # any ActiveRecord::Base model
+      config.id_column          = :prompt_name
+      config.text_column        = :prompt_text
+      config.parameters_column  = :prompt_params
+    end.new # adapters an instances of the adapter class
+```
+
+##### model
+The `model` configuration parameter is the actual class name of the `ActiveRecord::Base` or `ApplicationRecord` (if you are using a rails application) that contains the content used for prompts.
+
+##### id_column
+The `id_column` contains the name of the column that contains the "prompt ID" content.  It can be either a `String` or `Symbol` value.
+
+##### text_column
+The `text_column` contains name of the column that contains the actual raw text of the prompt.  This raw text can include the keywords which will be replaced by values from the parameters Hash.  The column name value can be either a `String` or a `Symbol`.
 
-TODO: This may be the next adapter to be implemented.
+##### parameters_column
+The `parameters_column` contains the name of the column that contains the parameters used to replace keywords in the prompt text.  This column in the database model is expected to be serialized.  The `ActiveRecordAdapter` currently has a kludge bit of code that assumes that the serialization is done with JSON.  The value of the parameters_column can be either a `String` or a `Symbol`.
 
-#### ActiveRecordAdapter
+TODO: fix the kludge so that any serialization can be used.
 
-TODO: Still looking for requirements on how to integrate with an existing `rails` app.  Looking for ideas.
 
-#### Other Potential Storage Adapters
+### Other Potential Storage Adapters
 
 There are many possibilities to example this plugin concept of the storage adapter.  Here are some for consideration:
 

data/examples/rgfzf

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Refactored examples/rgfzf to take search term and directory path as parameters
+
+search_term="$1"
+directory_path="${2:-$(pwd)}" # Use given directory path, or current working directory if not provided
+
+# Verify that a search term is provided
+if [[ -z "$search_term" ]]; then
+  echo "Usage: $0 search_term [directory_path]"
+  exit 1
+fi
+
+# Ensure ripgrep (rg) and fzf are installed
+if ! command -v rg &> /dev/null || ! command -v fzf &> /dev/null; then
+  echo "Please ensure ripgrep and fzf are installed before running this script."
+  exit 1
+fi
+
+# Perform the file search using ripgrep and selection using fzf
+selected_file=$(
+  rg  --files-with-matches \
+      --no-messages \
+      --smart-case "$search_term" "$directory_path" |
+  sed "s#^$directory_path/##" | # Strip out the directory path
+  fzf --ansi \
+      --color "hl:-1:underline,hl+:-1:underline:reverse" \
+      --preview "cat $directory_path/{}" \
+      --preview-window "up,60%,border-bottom" \
+      --no-multi \
+      --exit-0 \
+      --query "$search_term"
+)
+
+
+# If no file was selected, exit the script
+if [[ -z "$selected_file" ]]; then
+  # echo "No file selected."
+  exit 0
+fi
+
+# Remove the file extension
+prompt_id=$(echo "$selected_file" | sed "s/\.[^.]*$//")
+
+echo "$prompt_id"

data/examples/simple.rb

@@ -9,9 +9,6 @@
 ##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
 ##
 #
-# TODO: Add `list` to get an Array of prompt IDs
-# TODO: Add `path` to get a path to the prompt file
-#
 
 require 'prompt_manager'
 require 'prompt_manager/storage/file_system_adapter'
@@ -140,3 +137,23 @@ puts <<~EOS
 EOS
 
 puts PromptManager::Prompt.path('toy/8-ball')
+
+puts
+
+puts "Default Search for Prompts"
+puts "=========================="
+
+print "Search Proc Class: "
+puts PromptManager::Prompt.storage_adapter.search_proc.class
+
+search_term = "txt"  # some comment lines show the file name example: todo.txt
+
+puts "Search for '#{search_term}' ..."
+
+prompt_ids = PromptManager::Prompt.search search_term
+
+# NOTE: prompt+ids is an Array of prompt IDs even if there is only one entry.
+#       or and empty array if there are no prompts have the search term.
+
+puts "Found: #{prompt_ids}"
+

data/examples/using_search_proc.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
+# warn_indent: true
+##########################################################
+###
+##  File: using_search_proc.rb
+##  Desc: Simple demo of the PromptManager and FileStorageAdapter
+##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+##
+#
+
+require 'debug_me'
+include DebugMe
+
+require 'prompt_manager'
+require 'prompt_manager/storage/file_system_adapter'
+
+require 'amazing_print'
+require 'pathname'
+
+HERE          = Pathname.new( __dir__ )
+PROMPTS_DIR   = HERE + "prompts_dir"
+SEARCH_SCRIPT = HERE + 'rgfzf'  # a bash script using rg and fzf
+
+######################################################
+# Main
+
+at_exit do
+  puts
+  puts "Done."
+  puts
+end
+
+# Configure the Storage Adapter to use
+PromptManager::Storage::FileSystemAdapter.config do |config|
+  config.prompts_dir        = PROMPTS_DIR
+  config.search_proc        = ->(q) {`#{SEARCH_SCRIPT} #{q} #{PROMPTS_DIR}`}     # default
+  # config.prompt_extension = '.txt'  # default
+  # config.parms+_extension = '.json' # default
+end
+
+PromptManager::Prompt.storage_adapter = PromptManager::Storage::FileSystemAdapter.new
+
+
+
+puts "Using Custom Search Proc"
+puts "========================"
+
+print "Search Proc Class: "
+puts PromptManager::Prompt.storage_adapter.search_proc.class
+
+search_term = "txt"  # some comment lines show the file name example: todo.txt
+
+puts "Search for '#{search_term}' ..."
+
+prompt_id = PromptManager::Prompt.search search_term
+
+# NOTE: the search proc uses fzf as a selection tool.  In this
+#       case only one selected prompt ID that matches the search
+#       term will be returned.
+
+puts "Found: '#{prompt_id}' which is a #{prompt_id.class}. empty? #{prompt_id.empty?}"
+
+puts <<~EOS
+  
+  When the rgfzf bash script does not find a prompt ID or if the 
+  ESC key is pressed, the prompt ID that is returned will be an empty String.
+
+EOS
+

data/lib/prompt_manager/prompt.rb

@@ -5,9 +5,20 @@
 # as well as building prompts with replacement of parameterized values and 
 # comment removal. It communicates with a storage system through a storage 
 # adapter.
+#
+# Directives can be anything required by the backend
+# prompt processing functionality.  Directives are
+# available along with the prompt text w/o comments.
+# Keywords can be used in the directives.
+#
+# It is expected that the backend prompt processes will
+# act on and remove the directives before passing the
+# prompt text on through the LLM.
 
 class PromptManager::Prompt
-  PARAMETER_REGEX   = /(\[[A-Z _|]+\])/ # NOTE: old from aip.rb
+  COMMENT_SIGNAL    = '#'   # lines beginning with this are a comment
+  DIRECTIVE_SIGNAL  = '//'  # Like the old IBM JCL
+  PARAMETER_REGEX   = /(\[[A-Z _|]+\])/
   @storage_adapter  = nil
 
   class << self
@@ -47,8 +58,8 @@ class PromptManager::Prompt
   
   # SMELL:  Does the db (aka storage adapter) really need
   #         to be accessible by the main program?
-  attr_accessor :db, :id, :text, :parameters, :keywords
-  
+  attr_accessor :db, :id, :text, :parameters
+
 
   # Retrieve the specific prompt ID from the Storage system.
   def initialize(
@@ -64,9 +75,12 @@ class PromptManager::Prompt
     @record     = db.get(id: id)
     @text       = @record[:text]
     @parameters = @record[:parameters]
-    @keywords   = []
+    @keywords   = []  # Array of String
+    @directives = {}  # Hash with directive as key, parameters as value
 
     update_keywords
+    update_directives
+
     build
   end
 
@@ -120,6 +134,12 @@ class PromptManager::Prompt
     update_keywords
   end
 
+
+  def directives
+    update_directives    
+  end
+
+
   ######################################
   private
 
@@ -133,10 +153,26 @@ class PromptManager::Prompt
   end
 
 
+  def update_directives
+    @text.split("\n").each do |a_line|
+      line = a_line.strip
+      next unless line.start_with?(DIRECTIVE_SIGNAL)
+      
+      parts     = line.split(' ')
+      directive = parts.shift()[DIRECTIVE_SIGNAL.length..] # drop the directive signal
+      @directives[directive] = parts.join(' ')
+    end
+
+    @directives
+  end
+
+
   def remove_comments
     lines           = @prompt
                         .split("\n")
-                        .reject{|a_line| a_line.strip.start_with?('#')}
+                        .reject{|a_line| 
+                          a_line.strip.start_with?(COMMENT_SIGNAL)
+                        }
 
     # Remove empty lines at the start of the prompt
     #

data/lib/prompt_manager/storage/active_record_adapter.rb

@@ -1,161 +1,146 @@
 # prompt_manager/lib/prompt_manager/storage/active_record_adapter.rb
 
-require 'active_record'
-
-# TODO: Will need a database.yml file
-#       will need to know the column names that coorespond
-#       with the things that the Prompt class wants.
+# This class acts as an adapter for interacting with an ActiveRecord model
+# to manage storage operations for PromptManager::Prompt instances. It defines
+# methods that allow for saving, searching, retrieving by ID, and deleting
+# prompts.
 
 class PromptManager::Storage::ActiveRecordAdapter
-  attr_reader :model_class
+  
+  class << self
+    attr_accessor :model, 
+                  :id_column, 
+                  :text_column, 
+                  :parameters_column
 
-  def initialize(model_class)
-    @model_class = model_class
-  end
+    def config
+      if block_given?
+        yield self
+        validate_configuration
+      else
+        raise ArgumentError, "No block given to config"
+      end
+      
+      self
+    end
 
 
-  def prompt_text(prompt_id)
-    prompt = find_prompt(prompt_id)
-    prompt.text
-  end
+    def validate_configuration
+      validate_model
+      validate_columns
+    end
 
 
-  def parameter_values(prompt_id)
-    prompt = find_prompt(prompt_id)
-    JSON.parse(prompt.params, symbolize_names: true)
-  end
+    def validate_model
+      raise ArgumentError, "AR Model not set" unless model
+      raise ArgumentError, "AR Model is not an ActiveRecord model" unless model < ActiveRecord::Base
+    end
 
 
-  def save(prompt_id, prompt_text, parameter_values)
-    prompt        = model_class.find_or_initialize_by(id: prompt_id)
-    prompt.text   = prompt_text
-    prompt.params = parameter_values.to_json
-    prompt.save!
-  end
+    def validate_columns
+      columns = model.column_names # Array of Strings
+      [id_column, text_column, parameters_column].each do |column|
+        raise ArgumentError, "#{column} is not a valid column for model #{model}" unless columns.include?(column.to_s)
+      end
+    end
 
 
-  def delete(prompt_id)
-    prompt = find_prompt(prompt_id)
-    prompt.destroy
-  end
 
+    def method_missing(method_name, *args, &block)
+      if model.respond_to?(method_name)
+        model.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
 
-  def search(for_what)
-    # TODO: search through all prompts. Return an Array of
-    #       prompt_id where the text of the prompt contains
-    #       for_what is being searched.
 
-    []
+    def respond_to_missing?(method_name, include_private = false)
+      model.respond_to?(method_name, include_private) || super
+    end
   end
+  
 
+  ##############################################
+  attr_accessor :record
 
-  class << self
-    def config
-      # TODO: establish a connection to the database
-      #       maybe define the prompts table and its
-      #       columns of interest.
-    end
-  end
 
-  ###############################################
-  private
+  # Avoid code littered with self.class prefixes ...
+  def model               = self.class.model
+  def id_column    = self.class.id_column
+  def text_column  = self.class.text_column
+  def parameters_column   = self.class.parameters_column
+
 
-  def find_prompt(prompt_id)
-    model_class.find_by(id: prompt_id) || raise('Prompt not found')
+  def initialize
+    self.class.send(:validate_configuration) # send gets around private designations of a method
+    @record = model.first
   end
-end
 
 
-__END__
+  def get(id:)
+    @record = model.find_by(id_column => id)
+    raise ArgumentError, "Prompt not found with id: #{id}" unless @record
 
-# prompt_manager/lib/prompt_manager/storage/active_record_adapter.rb
+    # kludge? testing showed that parameters was being
+    # returned as a String.  Did serialization fail or is
+    # there something else going on?
+    # FIXME: expected the parameters_column to be a HAsh after de-serialization
+    parameters = @record[parameters_column]
 
-require 'active_record'
+    if parameters.is_a? String
+      parameters = JSON.parse parameters
+    end
 
-module PromptManager
-  module Storage
-    class ActiveRecordAdapter
+    {
+      id:         id, # same as the id_column
+      text:       @record[text_column],
+      parameters: parameters
+    }
+  end
 
-      # 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 save(id:, text: "", parameters: {})
+    @record = model.find_or_initialize_by(id_column => id) 
 
-      def initialize
-        unless ActiveRecord::Base.connected?
-          raise ArgumentError, "ActiveRecord is not connected"
-        end
-      end
+    @record[text_column] = text
+    @record[parameters_column]  = parameters
+    @record.save!
+  end
 
-      def get(id:)
-        prompt = Prompt.find_by(unique_id: id)
-        return nil unless prompt
 
-        parameters = prompt.prompt_parameters.index_by(&:key)
+  def delete(id:)
+    @record = model.find_by(id_column => id)
+    @record&.destroy
+  end
 
-        {
-          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!
+  
+  def list(*)
+    model.all.pluck(id_column)
+  end
 
-        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)
+    model.where("#{text_column} LIKE ?", "%#{for_what}%").pluck(id_column)
+  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
 
-      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
+  def method_missing(method_name, *args, &block)
+    if @record.respond_to?(method_name)
+      model.send(method_name, args.first, &block)
+    else
+      super
     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.
 
+  def respond_to_missing?(method_name, include_private = false)
+    model.respond_to?(method_name, include_private) || super
+  end
+end
 

data/lib/prompt_manager/storage/file_system_adapter.rb

@@ -211,8 +211,8 @@ class PromptManager::Storage::FileSystemAdapter
   def search(for_what)
     search_term = for_what.downcase
 
-    if @search_proc
-      @search_proc.call(search_term)
+    if search_proc.is_a? Proc
+      search_proc.call(search_term)
     else
       search_prompts(search_term)
     end

data/lib/prompt_manager/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prompt_manager
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: amazing_print
   requirement: !ruby/object:Gem::Requirement
@@ -84,13 +98,14 @@ files:
 - examples/prompts_dir/todo.json
 - examples/prompts_dir/todo.txt
 - examples/prompts_dir/toy/8-ball.txt
+- examples/rgfzf
 - examples/simple.rb
+- examples/using_search_proc.rb
 - lib/prompt_manager.rb
 - lib/prompt_manager/prompt.rb
 - lib/prompt_manager/storage.rb
 - lib/prompt_manager/storage/active_record_adapter.rb
 - lib/prompt_manager/storage/file_system_adapter.rb
-- lib/prompt_manager/storage/sqlite_adapter.rb
 - lib/prompt_manager/version.rb
 homepage: https://github.com/MadBomber/prompt_manager
 licenses:
@@ -115,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Manage prompts for use with gen-AI processes

data/lib/prompt_manager/storage/sqlite_adapter.rb

@@ -1,156 +0,0 @@
-# prompt_manager/lib/prompt_manager/storage/sqlite_adapter.rb
-
-require 'json'
-require 'sqlite3'
-
-class PromptManager::Storage::SqliteAdapter
-  def initialize(db_path = 'prompts.db')
-    @db = SQLite3::Database.new(db_path)
-    create_tables
-  end
-
-  def save_prompt(prompt_id, text, params)
-    @db.execute("INSERT INTO prompts (id, text, params) VALUES (?, ?, ?)",
-                [prompt_id, text, params.to_json])
-  end
-
-  def prompt_text(prompt_id)
-    result = @db.get_first_value("SELECT text FROM prompts WHERE id = ?", [prompt_id])
-    raise 'Prompt not found' if result.nil?
-    result
-  end
-
-  def parameter_values(prompt_id)
-    json_content = @db.get_first_value("SELECT params FROM prompts WHERE id = ?", [prompt_id])
-    raise 'Parameters not found' if json_content.nil?
-    JSON.parse(json_content, symbolize_names: true)
-  end
-
-  def save(prompt_id, prompt_text, parameter_values)
-    @db.execute(
-      'REPLACE INTO prompts (id, text, params) VALUES (?, ?, ?)',
-      [prompt_id, prompt_text, parameter_values.to_json]
-    )
-  end
-
-  def delete(prompt_id)
-    @db.execute('DELETE FROM prompts WHERE id = ?', [prompt_id])
-  end
-
-
-  def search(for_what)
-    # TODO: search through all prompts. Return an Array of
-    #       prompt_id where the text of the prompt contains
-    #       for_what is being searched.
-
-    []
-  end
-
-  ###################################################
-  private
-
-  def create_tables
-    @db.execute <<-SQL
-      CREATE TABLE IF NOT EXISTS prompts (
-        id TEXT PRIMARY KEY,
-        text TEXT NOT NULL,
-        params TEXT NOT NULL
-      );
-    SQL
-  end
-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
-
-
-
-