prompt_manager 0.5.8 → 1.0.0

data/lib/prompt_manager/storage/file_system_adapter.rb

@@ -1,339 +0,0 @@
-# prompt_manager/lib/prompt_manager/storage/file_system_adapter.rb
-
-# Use the local (or remote) file system as a place to
-# store and access prompts.
-#
-# Adds two additional methods to the Prompt class:
-#   list - returns Array of prompt IDs
-#   path - returns a Pathname object to the prompt's text file
-#   path(prompt_id) - same as path on the prompt instance
-#
-# Allows sub-directories of the prompts_dir to be
-# used like categories. For example the prompt_id "toy/magic"
-# is found in the `magic.txt` file inside the `toy` sub-directory
-# of the prompts_dir.
-#
-# There can be many layers of categories (sub-directories)
-#
-# This adapter serves as the file-based storage backend for PromptManager::Prompt,
-# enabling prompt retrieval and persistence using file system operations.
-
-require 'json'      # basic serialization of parameters
-require 'pathname'
-require 'fileutils'
-
-class PromptManager::Storage::FileSystemAdapter
-  # Placeholder for search proc
-  SEARCH_PROC       = nil
-  # File extension for parameters
-  PARAMS_EXTENSION  = '.json'.freeze
-  # File extension for prompts
-  PROMPT_EXTENSION  = '.txt'.freeze
-  # Regular expression for valid prompt IDs
-  PROMPT_ID_FORMAT  = /^[a-zA-Z0-9\-\/_]+$/
-
-  class << self
-    # Accessors for configuration options
-    attr_accessor :prompts_dir, :search_proc,
-                  :params_extension, :prompt_extension
-
-    # Configure the adapter
-    def config
-      if block_given?
-        yield self
-        validate_configuration
-      else
-        raise ArgumentError, "No block given to config"
-      end
-
-      self
-    end
-
-    # Expansion methods on the Prompt class specific to
-    # this storage adapter.
-
-    # Ignore the incoming prompt_id
-    def list(prompt_id = nil)
-      new.list
-    end
-
-    def path(prompt_id)
-      new.path(prompt_id)
-    end
-
-    #################################################
-    private
-
-    # Validate the configuration
-    def validate_configuration
-      validate_prompts_dir
-      validate_search_proc
-      validate_prompt_extension
-      validate_params_extension
-    end
-
-    # Validate the prompts directory
-    def validate_prompts_dir
-      # This is a work around for a Ruby scope issue where the
-      # class getter/setter method is becoming confused with a
-      # local variable when anything other than plain 'ol get and
-      # set are used. This error is in both Ruby v3.2.2 and
-      # v3.3.0-preview3.
-      #
-      prompts_dir_local = self.prompts_dir
-
-      raise ArgumentError, "prompts_dir must be set" if prompts_dir_local.nil? || prompts_dir_local.to_s.strip.empty?
-
-      unless prompts_dir_local.is_a?(Pathname)
-        prompts_dir_local = Pathname.new(prompts_dir_local)
-      end
-
-      prompts_dir_local = prompts_dir_local.expand_path
-
-      unless prompts_dir_local.exist?
-        FileUtils.mkdir_p(prompts_dir_local)
-      end
-      raise(ArgumentError, "prompts_dir: #{prompts_dir_local} is not a directory") unless prompts_dir_local.directory?
-
-      self.prompts_dir = prompts_dir_local
-    end
-
-    # Validate the search proc
-    def validate_search_proc
-      search_proc_local = self.search_proc
-
-      if search_proc_local.nil?
-        search_proc_local = SEARCH_PROC
-      else
-        raise(ArgumentError, "search_proc invalid; does not respond to call") unless search_proc_local.respond_to?(:call)
-      end
-
-      self.search_proc = search_proc_local
-    end
-
-    # Validate the prompt extension
-    def validate_prompt_extension
-      prompt_extension_local = self.prompt_extension
-
-      if prompt_extension_local.nil?
-        prompt_extension_local = PROMPT_EXTENSION
-      else
-        unless  prompt_extension_local.is_a?(String)    &&
-                prompt_extension_local.start_with?('.')
-          raise(ArgumentError, "Invalid prompt_extension: #{prompt_extension_local}")
-        end
-      end
-
-      self.prompt_extension = prompt_extension_local
-    end
-
-    # Validate the params extension
-    def validate_params_extension
-      params_extension_local = self.params_extension
-
-      if params_extension_local.nil?
-        params_extension_local = PARAMS_EXTENSION
-      else
-        unless  params_extension_local.is_a?(String)    &&
-                params_extension_local.start_with?('.')
-          raise(ArgumentError, "Invalid params_extension: #{params_extension_local}")
-        end
-      end
-
-      self.params_extension = params_extension_local
-    end
-  end
-
-  ##################################################
-  ###
-  ##  Instance
-  #
-
-  # Accessors for instance variables
-  def prompts_dir       = self.class.prompts_dir
-  def search_proc       = self.class.search_proc
-  def prompt_extension  = self.class.prompt_extension
-  def params_extension  = self.class.params_extension
-
-  # Initialize the adapter
-  def initialize
-    # NOTE: validate because main program may have made
-    #       changes outside of the config block
-    self.class.send(:validate_configuration) # send gets around private designations of a method
-  end
-
-  # Get a prompt by ID
-  def get(id:)
-    validate_id(id)
-    verify_id(id)
-
-    {
-      id:         id,
-      text:       prompt_text(id),
-      parameters: parameter_values(id)
-    }
-  end
-
-  # Retrieve prompt text by its id
-  def prompt_text(prompt_id)
-    read_file(file_path(prompt_id, prompt_extension))
-  end
-
-  # Retrieve parameter values by its id
-  def parameter_values(prompt_id)
-    # Parse parameters from the prompt text
-    prompt_text_content = prompt_text(prompt_id)
-    parsed_parameters = parse_parameters_from_text(prompt_text_content)
-
-    # Load parameters from JSON file if it exists
-    params_path = file_path(prompt_id, params_extension)
-    file_parameters = params_path.exist? ? deserialize(read_file(params_path)) : {}
-
-    # Only preserve JSON values for parameters that exist in the current text
-    parsed_parameters.each_key do |key|
-      if file_parameters.key?(key) && file_parameters[key].is_a?(Array)
-        parsed_parameters[key] = file_parameters[key]
-      end
-    end
-    
-    parsed_parameters
-  end
-
-  # Parse parameters from the prompt text
-  def parse_parameters_from_text(text)
-    parameters = {}
-
-    text.scan(PromptManager::Prompt.parameter_regex).each do |match|
-      variable_name = match.shift
-      parameters[variable_name] = [] unless parameters.key?(variable_name)
-    end
-
-    parameters
-  end
-
-  # Save prompt text and parameter values to corresponding files
-  def save(
-      id:,
-      text: "",
-      parameters: {}
-    )
-    validate_id(id)
-
-    prompt_filepath = file_path(id, prompt_extension)
-    params_filepath = file_path(id, params_extension)
-
-    write_with_error_handling(prompt_filepath, text)
-    write_with_error_handling(params_filepath, serialize(parameters))
-  end
-
-  # Delete prompt text and parameter values files
-  def delete(id:)
-    validate_id(id)
-
-    prompt_filepath = file_path(id, prompt_extension)
-    params_filepath = file_path(id, params_extension)
-
-    delete_with_error_handling(prompt_filepath)
-    delete_with_error_handling(params_filepath)
-  end
-
-  # Search for prompts
-  def search(for_what)
-    search_term = for_what.downcase
-
-    if search_proc.is_a? Proc
-      search_proc.call(search_term)
-    else
-      search_prompts(search_term)
-    end
-  end
-
-  # Return an Array of prompt IDs
-  def list(*)
-    prompt_ids = []
-
-    Pathname.glob(prompts_dir.join("**/*#{prompt_extension}")).each do |file_path|
-      prompt_id = file_path.relative_path_from(prompts_dir).to_s.gsub(prompt_extension, '')
-      prompt_ids << prompt_id
-    end
-
-    prompt_ids.sort
-  end
-
-  # Returns a Pathname object for a prompt ID text file
-  # However, it is possible that the file does not exist.
-  def path(id)
-    validate_id(id)
-    file_path(id, prompt_extension)
-  end
-
-  ##########################################
-  private
-
-  # Validate that the ID contains good characters.
-  def validate_id(id)
-    raise ArgumentError, "Invalid ID format id: #{id}" unless id =~ PROMPT_ID_FORMAT
-  end
-
-  # Verify that the ID exists
-  def verify_id(id)
-    unless file_path(id, prompt_extension).exist?
-      raise ArgumentError, "Invalid prompt_id: #{id}"
-    end
-  end
-
-  # Write to a file with error handling
-  def write_with_error_handling(file_path, content)
-    begin
-      file_path.write content
-      true
-    rescue IOError => e
-      raise "Failed to write to file: #{e.message}"
-    end
-  end
-
-  # Delete a file with error handling
-  def delete_with_error_handling(file_path)
-    begin
-      file_path.delete
-      true
-    rescue IOError => e
-      raise "Failed to delete file: #{e.message}"
-    end
-  end
-
-  # Get the file path for a prompt ID and extension
-  def file_path(id, extension)
-    prompts_dir + "#{id}#{extension}"
-  end
-
-  # Read a file
-  def read_file(full_path)
-    raise IOError, 'File does not exist' unless File.exist?(full_path)
-    File.read(full_path)
-  end
-
-  # Search for prompts
-  def search_prompts(search_term)
-    prompt_ids = []
-
-    Pathname.glob(prompts_dir.join("**/*#{prompt_extension}")).each do |prompt_path|
-      if prompt_path.read.downcase.include?(search_term)
-        prompt_id = prompt_path.relative_path_from(prompts_dir).to_s.gsub(prompt_extension, '')
-        prompt_ids << prompt_id
-      end
-    end
-
-    prompt_ids.sort
-  end
-
-  # Serialize data to JSON
-  def serialize(data)
-    data.to_json
-  end
-
-  # Deserialize JSON data
-  def deserialize(data)
-    JSON.parse(data)
-  end
-end

data/lib/prompt_manager/storage.rb

@@ -1,34 +0,0 @@
-# prompt_manager/lib/prompt_manager/storage.rb
-
-# The Storage module provides a namespace for different storage adapters
-# that handle persistence of prompts. Each adapter implements a common
-# interface for saving, retrieving, searching, and deleting prompts.
-#
-# Available adapters:
-# - FileSystemAdapter: Stores prompts in text files on the local filesystem
-# - ActiveRecordAdapter: Stores prompts in a database using ActiveRecord
-#
-# To use an adapter, configure it before using PromptManager::
-#
-# Example with FileSystemAdapter:
-#   PromptManager::Storage::FileSystemAdapter.config do |config|
-#     config.prompts_dir = Pathname.new('/path/to/prompts')
-#   end
-#   PromptManager::Prompt.storage_adapter = PromptManager::Storage::FileSystemAdapter.new
-#
-# Example with ActiveRecordAdapter:
-#   PromptManager::Storage::ActiveRecordAdapter.config do |config|
-#     config.model = MyPromptModel
-#     config.id_column = :prompt_id
-#     config.text_column = :content
-#     config.parameters_column = :params
-#   end
-#   PromptManager::Prompt.storage_adapter = PromptManager::Storage::ActiveRecordAdapter.new
-module PromptManager
-  # The Storage module provides adapters for different storage backends.
-  # Each adapter implements a common interface for managing prompts.
-  # Note: PromptManager::Prompt uses one of these adapters as its storage backend to
-  # perform all CRUD operations on prompt data.
-  module Storage
-  end
-end

data/lib/prompt_manager/version.rb

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