prompt_manager 0.5.8 → 1.0.0

data/lib/pm.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'pathname'
+require 'yaml'
+
+# PM (PromptManager) parses YAML metadata from markdown strings or files.
+# Processing pipeline: strip HTML comments → extract metadata → shell expansion → ERB on demand.
+module PM
+  METADATA_REGEXP = /
+    \A
+    [[:space:]]*
+    ---
+    (?<metadata>.*?)
+    ---
+    [[:blank:]]*$[\n\r]?
+    (?<content>.*)
+    \z
+  /mx
+
+  HTML_COMMENT_REGEXP = /<!--.*?-->/m
+  ENV_VAR_REGEXP     = /\$\{([A-Z_][A-Z0-9_]*)\}|\$([A-Z_][A-Z0-9_]*)/
+  COMMAND_START      = '$('
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+
+  # --- Parsing ---
+
+  # Parses a source through the full pipeline:
+  # strip HTML comments → extract YAML metadata → shell expansion (when shell: true).
+  #
+  # When source is a Pathname, responds to :to_path, is a String ending
+  # in ".md", a Symbol, or a single word (e.g. "greeting"), it is treated
+  # as a file path. Symbols and single-word strings are converted to
+  # "name.md" basenames. The file is read and parsed, and `directory`,
+  # `name`, `created_at`, `modified_at` are added to metadata.
+  #
+  # Otherwise source is parsed directly as a string.
+  def self.parse(source)
+    source = "#{source}.md" if source.is_a?(Symbol) || single_word?(source)
+
+    if file_source?(source)
+      raw = source.respond_to?(:to_path) ? source.to_path : source
+      unless config.prompts_dir.empty?
+        raw = (Pathname.new(config.prompts_dir) + raw).to_s
+      end
+      path = File.expand_path(raw)
+      parsed = parse_string(File.read(path))
+
+      stat = File.stat(path)
+      metadata = build_metadata(
+        parsed.metadata.to_h.merge(
+          directory:   File.dirname(path),
+          name:        File.basename(path),
+          created_at:  stat.birthtime,
+          modified_at: stat.mtime
+        )
+      )
+      Parsed.new(metadata: metadata, content: parsed.content)
+    else
+      parse_string(source)
+    end
+  end
+
+  # Returns true when source should be treated as a file path.
+  def self.file_source?(source)
+    source.respond_to?(:to_path) || (source.is_a?(String) && source.end_with?('.md'))
+  end
+  private_class_method :file_source?
+
+  # Returns true when source is a single word with no spaces,
+  # path separators, or file extension.
+  def self.single_word?(source)
+    source.is_a?(String) && source.match?(/\A\w+\z/)
+  end
+  private_class_method :single_word?
+
+  # Parses a string through the full pipeline.
+  def self.parse_string(string)
+    stripped = strip_comments(string)
+    match = stripped.match(METADATA_REGEXP)
+
+    if match
+      metadata = build_metadata(YAML.safe_load(match[:metadata], permitted_classes: [Date, Time]))
+      content = match[:content]
+    else
+      metadata = build_metadata({})
+      content = stripped
+    end
+
+    content = expand_shell(content) if metadata.shell?
+
+    Parsed.new(metadata: metadata, content: content)
+  end
+  private_class_method :parse_string
+
+  # Builds a Metadata object with defaults for shell and erb.
+  def self.build_metadata(hash)
+    defaults = { 'shell' => config.shell, 'erb' => config.erb }
+    Metadata.new(defaults.merge(hash.transform_keys(&:to_s)))
+  end
+  private_class_method :build_metadata
+
+  # Strips HTML comments from a string.
+  def self.strip_comments(string)
+    string.gsub(HTML_COMMENT_REGEXP, '')
+  end
+end
+
+require_relative 'pm/configuration'
+require_relative 'pm/version'
+require_relative 'pm/metadata'
+require_relative 'pm/parsed'
+require_relative 'pm/directives'
+require_relative 'pm/shell'

data/lib/prompt_manager.rb

@@ -1,28 +1,3 @@
-# prompt_manager/lib/prompt_manager.rb
-#
-# frozen_string_literal: true
+require_relative 'pm'
 
-require 'ostruct'
-
-require_relative "prompt_manager/version"
-require_relative "prompt_manager/prompt"
-require_relative "prompt_manager/storage"
-require_relative "prompt_manager/storage/file_system_adapter"
-
-# The PromptManager module provides functionality for managing, storing,
-# retrieving, and parameterizing text prompts used with generative AI systems.
-# It supports different storage backends through adapters and offers features
-# like parameter substitution, directives processing, and comment handling.
-module PromptManager
-  # Base error class for all PromptManager-specific errors
-  class Error < StandardError; end
-
-  # Error class for storage-related issues
-  class StorageError < Error; end
-
-  # Error class for parameter substitution issues
-  class ParameterError < Error; end
-
-  # Error class for configuration issues
-  class ConfigurationError < Error; end
-end
+PromptManager = PM

data/mkdocs.yml

@@ -1,43 +1,56 @@
-site_name: PromptManager Documentation
-site_description: Comprehensive documentation for the PromptManager Ruby gem - Manage parameterized prompts for generative AI
-site_author: MadBomber
+# MkDocs Configuration for PM (PromptManager) Documentation
+site_name: PM (PromptManager)
+site_description: Parse YAML metadata from markdown prompts with shell expansion and ERB rendering
+site_author: Dewayne VanHoozer
 site_url: https://madbomber.github.io/prompt_manager
-repo_url: https://github.com/MadBomber/prompt_manager
-repo_name: MadBomber/prompt_manager
+copyright: Copyright © 2025 Dewayne VanHoozer
+
+# Repository information
+repo_name: madbomber/prompt_manager
+repo_url: https://github.com/madbomber/prompt_manager
 edit_uri: edit/main/docs/
 
+# Configuration
 theme:
   name: material
-  logo: assets/logo.svg
-  favicon: assets/favicon.ico
+
+  # Color scheme
   palette:
-    - media: "(prefers-color-scheme: light)"
-      scheme: default
-      primary: indigo
+    - scheme: default
+      primary: teal
       accent: amber
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
-      scheme: slate
-      primary: indigo
+
+    - scheme: slate
+      primary: teal
       accent: amber
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+
+  # Typography
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  # Logo and icon
+  icon:
+    repo: fontawesome/brands/github
+    logo: material/text-box-outline
+
+  # Theme features
   features:
     - navigation.instant
     - navigation.tracking
     - navigation.tabs
     - navigation.tabs.sticky
-    - navigation.sections
-    - navigation.expand
     - navigation.path
-    - navigation.prune
     - navigation.indexes
     - navigation.top
+    - navigation.footer
     - toc.follow
-    - toc.integrate
     - search.suggest
     - search.highlight
     - search.share
@@ -45,11 +58,17 @@ theme:
     - content.code.copy
     - content.code.annotate
     - content.tabs.link
+    - content.tooltips
+    - content.action.edit
+    - content.action.view
 
+# Plugins
 plugins:
   - search:
-      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+  - tags
 
+# Extensions
 markdown_extensions:
   - abbr
   - admonition
@@ -57,26 +76,36 @@ markdown_extensions:
   - def_list
   - footnotes
   - md_in_html
+  - tables
   - toc:
       permalink: true
-      toc_depth: 3
+      title: On this page
+
   - pymdownx.arithmatex:
       generic: true
   - pymdownx.betterem:
       smart_enable: all
   - pymdownx.caret
+  - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
   - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: madbomber
+      repo: prompt_manager
+      normalize_issue_symbols: true
   - pymdownx.mark
   - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      check_paths: true
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid
@@ -88,59 +117,65 @@ markdown_extensions:
       custom_checkbox: true
   - pymdownx.tilde
 
+# Extra CSS
+extra_css:
+  - assets/css/custom.css
+
+# Social media and extra configuration
 extra:
   social:
     - icon: fontawesome/brands/github
-      link: https://github.com/MadBomber/prompt_manager
-      name: GitHub Repository
+      link: https://github.com/madbomber/prompt_manager
+      name: PM on GitHub
     - icon: fontawesome/solid/gem
       link: https://rubygems.org/gems/prompt_manager
-      name: RubyGems Package
-  version:
-    provider: mike
-    default: latest
+      name: PM on RubyGems
+
+  analytics:
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: material/emoticon-happy-outline
+          name: This page was helpful
+          data: 1
+          note: Thanks for your feedback!
+        - icon: material/emoticon-sad-outline
+          name: This page could be improved
+          data: 0
+          note: Thanks for your feedback! Help us improve by creating an issue.
 
+# Navigation
 nav:
-  - Home: index.md
+  - Home:
+      - Overview: index.md
   - Getting Started:
-    - Installation: getting-started/installation.md
-    - Quick Start: getting-started/quick-start.md
-    - Basic Concepts: getting-started/basic-concepts.md
-  - Core Features:
-    - Parameterized Prompts: core-features/parameterized-prompts.md
-    - Directive Processing: core-features/directive-processing.md
-    - ERB Integration: core-features/erb-integration.md
-    - Shell Integration: core-features/shell-integration.md
-    - Comments & Documentation: core-features/comments.md
-    - Parameter History: core-features/parameter-history.md
-    - Error Handling: core-features/error-handling.md
-  - Storage Adapters:
-    - Overview: storage/overview.md
-    - FileSystemAdapter: storage/filesystem-adapter.md
-    - ActiveRecordAdapter: storage/activerecord-adapter.md
-    - Custom Adapters: storage/custom-adapters.md
+      - getting-started/index.md
+      - Installation: getting-started/installation.md
+      - Quick Start: getting-started/quick-start.md
+      - Configuration: getting-started/configuration.md
+  - Guides:
+      - guides/index.md
+      - Parsing Prompts: guides/parsing.md
+      - Parameters: guides/parameters.md
+      - Shell Expansion: guides/shell-expansion.md
+      - ERB Rendering: guides/erb-rendering.md
+      - Including Files: guides/includes.md
+      - Custom Directives: guides/custom-directives.md
+      - Comment Stripping: guides/comment-stripping.md
   - API Reference:
-    - Prompt Class: api/prompt-class.md
-    - Storage Adapters: api/storage-adapters.md
-    - Directive Processor: api/directive-processor.md
-    - Configuration: api/configuration.md
-  - Advanced Usage:
-    - Custom Keywords: advanced/custom-keywords.md
-    - Dynamic Directives: advanced/dynamic-directives.md
-    - Search Integration: advanced/search-integration.md
-    - Performance Tips: advanced/performance.md
+      - api/index.md
+      - PM Module: api/pm-module.md
+      - Configuration: api/configuration.md
+      - Metadata: api/metadata.md
+      - Parsed: api/parsed.md
+      - RenderContext: api/render-context.md
+      - Constants: api/constants.md
+  - Architecture:
+      - architecture/index.md
+      - Processing Pipeline: architecture/processing-pipeline.md
+      - Design Decisions: architecture/design-decisions.md
   - Examples:
-    - Overview: examples.md
-    - Basic Examples: examples/basic.md
-    - Advanced Examples: examples/advanced.md
-    - Real World Use Cases: examples/real-world.md
-  - Development:
-    - Architecture: development/architecture.md
-    - Contributing: development/contributing.md
-    - Testing: development/testing.md
-    - Roadmap: development/roadmap.md
-  - Migration Guides:
-    - Version 0.9.0: migration/v0.9.0.md
-    - Version 1.0.0: migration/v1.0.0.md
-
-copyright: Copyright © 2024 MadBomber - MIT License
+      - examples/index.md
+      - Code Review Prompt: examples/code-review-prompt.md
+      - Multi-File Composition: examples/multi-file-composition.md
+      - AI Agent Prompts: examples/ai-agent-prompts.md

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prompt_manager
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -10,13 +10,13 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -65,34 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  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
-    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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -107,23 +79,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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'
-description: "Manage the parameterized prompts (text) used in generative AI (aka chatGPT,
-  \nOpenAI, et.al.) using storage adapters such as FileSystemAdapter, \nSqliteAdapter,
-  and ActiveRecordAdapter.\n"
+description: |
+  PM (PromptManager) parses YAML metadata from markdown strings or files.
+  It expands shell references, extracts metadata and content, and renders
+  ERB templates on demand.
 email:
 - dvanhoozer@gmail.com
 executables: []
@@ -137,63 +96,45 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- docs/.keep
-- docs/advanced/custom-keywords.md
-- docs/advanced/dynamic-directives.md
-- docs/advanced/performance.md
-- docs/advanced/search-integration.md
 - docs/api/configuration.md
-- docs/api/directive-processor.md
-- docs/api/prompt-class.md
-- docs/api/storage-adapters.md
-- docs/assets/favicon.ico
-- docs/assets/logo.svg
-- docs/core-features/comments.md
-- docs/core-features/directive-processing.md
-- docs/core-features/erb-integration.md
-- docs/core-features/error-handling.md
-- docs/core-features/parameter-history.md
-- docs/core-features/parameterized-prompts.md
-- docs/core-features/shell-integration.md
-- docs/development/architecture.md
-- docs/development/contributing.md
-- docs/development/roadmap.md
-- docs/development/testing.md
-- docs/examples.md
-- docs/examples/advanced.md
-- docs/examples/basic.md
-- docs/examples/real-world.md
-- docs/getting-started/basic-concepts.md
+- docs/api/constants.md
+- docs/api/index.md
+- docs/api/metadata.md
+- docs/api/parsed.md
+- docs/api/pm-module.md
+- docs/api/render-context.md
+- docs/architecture/design-decisions.md
+- docs/architecture/index.md
+- docs/architecture/processing-pipeline.md
+- docs/assets/css/custom.css
+- docs/assets/images/prompt_manager.gif
+- docs/assets/images/prompt_manager.mp4
+- docs/examples/ai-agent-prompts.md
+- docs/examples/code-review-prompt.md
+- docs/examples/index.md
+- docs/examples/multi-file-composition.md
+- docs/getting-started/configuration.md
+- docs/getting-started/index.md
 - docs/getting-started/installation.md
 - docs/getting-started/quick-start.md
+- docs/guides/comment-stripping.md
+- docs/guides/custom-directives.md
+- docs/guides/erb-rendering.md
+- docs/guides/includes.md
+- docs/guides/index.md
+- docs/guides/parameters.md
+- docs/guides/parsing.md
+- docs/guides/shell-expansion.md
 - docs/index.md
-- docs/migration/v0.9.0.md
-- docs/migration/v1.0.0.md
-- docs/storage/activerecord-adapter.md
-- docs/storage/custom-adapters.md
-- docs/storage/filesystem-adapter.md
-- docs/storage/overview.md
-- examples/advanced_integrations.rb
-- examples/directives.rb
-- examples/prompts_dir/advanced_demo.txt
-- examples/prompts_dir/directive_example.json
-- examples/prompts_dir/directive_example.txt
-- 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
-- improvement_plan.md
+- lib/pm.rb
+- lib/pm/configuration.rb
+- lib/pm/directives.rb
+- lib/pm/metadata.rb
+- lib/pm/parsed.rb
+- lib/pm/shell.rb
+- lib/pm/version.rb
 - lib/prompt_manager.rb
-- lib/prompt_manager/directive_processor.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/version.rb
 - mkdocs.yml
-- prompt_manager_logo.png
 homepage: https://github.com/MadBomber/prompt_manager
 licenses:
 - MIT
@@ -216,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.5
 specification_version: 4
-summary: Manage prompts for use with gen-AI processes
+summary: Parse YAML metadata from markdown prompts with shell expansion and ERB rendering
 test_files: []