action_prompt 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d077c592d1944448a6fee2d5eb1184c3e8a3c42cccb21929fdae60fa9806aed2
-  data.tar.gz: 347712c9bc12ce13c43fe3a983c29a90776426e1f2d88a2ef7ea8477cb1aae3a
+  metadata.gz: de8ad6099ba3b0e8ff896d96e8ff8a543a9558d09c129d248b778bbf33ca5b36
+  data.tar.gz: b4473d1847ebf29e43c57461f8397281b6ccdb12132673517477a7a424c210da
 SHA512:
-  metadata.gz: 17ffba4a0d8ec79e77b25c1337bacfbe83523976cfa69f3c26d4272da9d859e1d4821575b6695073916b5bac71cd7ba990924dbdcc37acb683363822f488fe55
-  data.tar.gz: ee62f030e9df50de5b0a5783bf103d036a028e6cdaab5c829a97021892595b2bbfd2ecc795e1f8f9a04032370cce31dcc4f11df2cab5d3e872f1058d61f7ac81
+  metadata.gz: 56349f3e9365bee80336405ae7a04a3d8cee84fe83571c011f4f4fda49bc8048ac257853bd7d205fdbef72edad1275e4cd2960278a6bebd4534c3ffc9643b3d5
+  data.tar.gz: 385a20ef932cdf6d45e261b241333c886c1ab39e6feb6b10c265c207f05fe2e7ad350bd30e9c68bd7235d8eb7264ef26288d3cf2e8c501c7ef687b65f04f232d

data/README.md

@@ -1,28 +1,61 @@
-# ActionPrompt
-Short description and motivation.
+# Action Prompt
 
-## Usage
-How to use my plugin.
+Action Prompt provides a dead simple way to way to organize, preview, and render prompts within a Ruby on Rails App. Because this leverages the `ApplicationController`, you're able to leverage all the bells an whistles
+
+This draws heavy inspiration from `ActionMailer::Preview`.
+
+> [!IMPORTANT]
+> This gem is a work-in-progress. **It is not production ready** . That said, `ActionPrompt` is under active development. Any and all feedback would be very welcome. Or hey, feel free to open a PR.
+
+## Motivation & Usage
+
+As LLMs have become ubiquitous in web applications, we've that prompts intended for Claude or GPT have become scattered throughout our codebase or buried within objects. Often, these prompts were built inline through string manipulation. Our thinking was two-fold, 1) Let's come up with a simple pattern for organizing and rendering these prompts, and 2) Let's make them easy to review.
 
 ## Installation
-Add this line to your application's Gemfile:
 
-```ruby
-gem "action_prompt"
-```
+Install the gem with `gem "action_prompt"`.
+
+## Organizing & Previewing Prompts
+
+1. Create a template for organizing your prompts located at your `app/prompts`. For example, you might create `app/prompts/hello_world.text.erb` and give it the following content:
+
+   ```erb
+   You are a helpful assistant who replies with, "<%= @message >"
+   ```
+
+2. Create a preview class. These live in `test/prompts` and they inherit from `ActionPrompt::Preview`. For example, you might create `tests/prompts/hello_world_preview.rb` and give it the following context:
 
-And then execute:
-```bash
-$ bundle
-```
+   ```ruby
+   class HelloWorldPreview < ActionPrompt::Preview
+    def example_prompt
+      render "hello_world", locals: {message: "Hello, world!"}
+    end
+   end
+   ```
 
-Or install it yourself as:
-```bash
-$ gem install action_prompt
-```
+3. Next, start up your rails server (`rails s`) and navigate to [http://localhost:3000/action_prompt/previews](http://localhost:3000/action_prompt/previews). You'll see a list of your prompts that resembles the following:
 
-## Contributing
-Contribution directions go here.
+   ![Screenshot](docs/assets/images/screenshot.png)
+
+   You can now preview your prompts.
+
+## Rendering prompts within your app
+
+1. Assume you've followed step one above, and you have a prompt located at `app/prompts/hello_world.text.erb`.
+2. You can now render this anywhere in your codebase with the following:
+
+   ```ruby
+   ActionPrompt::Renderer.new.render("hello_world", locals: {message: "Now we're cooking"})
+   # You are a helpful assistant who replies with, "Now we're cooking"
+   ```
+
+Under the hood, `ActionPrompt` is leveraging the app's `ApplicationController`. That means you can use the full magic of `ActionView` which includes
+
+- Rendering partials.
+- Rendering json with `Jbuilder`
+- Using route helpers, i.e. `posts_url`
+- ...and more!
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/action_prompt/previews_controller.rb

@@ -0,0 +1,22 @@
+class ActionPrompt::PreviewsController < ActionController::Base
+  prepend_view_path ActionPrompt::Engine.root.join("app", "views")
+  layout "application"
+  # Ideally, we'd like to inhert from Rails::ApplicationController, but that
+  # would prevent us from using a Tailwind CDN. So instead, we're using ActionController::Base.
+  #
+  # If we are able to use Rails::ApplicationController, then re-enable this line
+  # before_action :require_local!
+
+  def index
+    @page_title = "Action Prompt Previews"
+    @previews = ActionPrompt::Preview.all
+  end
+
+  def show
+    preview_class_name = params[:preview_slug].camelize + "Preview"
+    @preview_class = ActionPrompt::Preview.find(preview_class_name)
+    slug = "#{params[:preview_slug]}/#{params[:prompt_name]}"
+    @prompt = @preview_class.find_prompt(slug)
+    @prompt_output = @preview_class.new.send(params[:prompt_name].to_sym)
+  end
+end

data/app/views/action_prompt/previews/index.html.erb

@@ -0,0 +1,20 @@
+<h1 class="text-xl font-semibold">Action Prompt Previews</h1>
+<div class="py-4">
+  <% if @previews.blank? %>
+    <p>You have not defined any Action Prompt Previews.</p>
+    <!-- TODO: Add a link to the Action Prompt documentation here -->
+  <% else %>
+    <div class="space-y-4">
+      <% @previews.each do |preview| %>
+        <div>
+          <h2 class="text-lg font-semibold"><%= preview.display_name %></h2>
+          <ul>
+            <% preview.prompts.each do |prompt| %>
+              <li><%= link_to prompt.name, "/action_prompt/previews/#{prompt.slug}", class: "cursor-pointer underline  text-blue-600 hover:text-blue-800" %></li>
+            <% end %>
+          </ul>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/views/action_prompt/previews/show.html.erb

@@ -0,0 +1,12 @@
+<h1 class="text-xl font-semibold">
+  <%= @preview_class.display_name %>: <%= @prompt.name %>
+</h1>
+<div class="pb-2">
+  <%= link_to "<< Back to prompts", "/action_prompt/previews", class: "cursor-pointer underline text-blue-600 hover:text-blue-800 text-sm" %>
+</div>
+<div class="py-2">
+  <div>
+    Output
+  </div>
+  <div class="bg-gray-100 p-2 rounded-md border shadow-sm" style="word-wrap: break-word; white-space: pre-wrap;"><%= @prompt_output %></div>
+</div>

data/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= @page_title %></title>
+  <script src="https://cdn.tailwindcss.com"></script>
+</head>
+<body class="min-h-screen bg-gray-100 pt-4">
+
+<div class="mx-auto w-2/3 bg-white rounded-lg p-8 shadow-lg border-2">
+<%= yield %>
+</div>
+
+</body>
+</html>

data/lib/action_prompt/engine.rb

@@ -1,4 +1,5 @@
 module ActionPrompt
   class Engine < ::Rails::Engine
+    isolate_namespace ActionPrompt
   end
 end

data/lib/action_prompt/preview.rb

@@ -0,0 +1,55 @@
+require "active_support/descendants_tracker"
+
+module ActionPrompt
+  class Preview
+    # We need to be able to do the following:
+    # - find all the preview objects
+    # - find all the preview methods on those objects
+    # - render a preview
+    #
+    class << self
+      def all
+        load_previews if descendants.empty?
+        descendants.sort_by(&:name)
+      end
+
+      def load_previews
+        # TODO: this preview path could be made configurable in order to have equivalent
+        # functionality to Rails mailer previews
+        Dir[Rails.root.join("test", "prompts", "**", "*_preview.rb")].each do |path|
+          require path
+        end
+      end
+
+      def display_name
+        name.titleize
+      end
+
+      def slug
+        name.delete_suffix("Preview").underscore
+      end
+
+      def prompts
+        # TODO: this might benefit from some memoization
+        prompt_methods = public_instance_methods(false).map(&:to_s).sort
+
+        prompt_methods.map do |method_name|
+          Prompt.new(name: method_name.humanize,
+                     slug: "#{slug}/#{method_name}")
+        end
+      end
+
+      def find(name)
+        all.find { |preview| preview.name == name }
+      end
+
+      def find_prompt(slug)
+        prompts.find { |p| p.slug == slug }
+      end
+    end
+
+    def render(template_name, locals: {})
+      ActionPrompt::Renderer.new.render(template_name, locals: locals)
+    end
+  end
+end

data/lib/action_prompt/prompt.rb

@@ -0,0 +1,11 @@
+module ActionPrompt
+  class Prompt
+    attr_reader :name, :slug
+
+    # NOTE: this could probably be a Struct
+    def initialize(name:, slug:)
+      @name = name
+      @slug = slug
+    end
+  end
+end

data/lib/action_prompt/railtie.rb

@@ -0,0 +1,18 @@
+require "rails/application_controller"
+
+module ActionPrompt
+  class Railtie < Rails::Railtie
+    config.before_configuration do |app|
+      app.config.autoload_paths << Rails.root.join("tests/prompts")
+    end
+
+    config.after_initialize do |app|
+      if Rails.env.development? || Rails.env.test?
+        app.routes.prepend do
+          get "/action_prompt/previews", to: "action_prompt/previews#index" # , internal: true
+          get "/action_prompt/previews/:preview_slug/:prompt_name", to: "action_prompt/previews#show" # , internal: true
+        end
+      end
+    end
+  end
+end

data/lib/action_prompt/renderer.rb

@@ -0,0 +1,13 @@
+module ActionPrompt
+  class Renderer
+    def initialize
+      # NOOP
+    end
+
+    def render(template_name, locals: {})
+      controller = ApplicationController.new
+      controller.prepend_view_path(Rails.root.join("app", "prompts"))
+      controller.render_to_string(template: template_name, locals: locals, layout: false)
+    end
+  end
+end

data/lib/action_prompt/version.rb

@@ -1,3 +1,3 @@
 module ActionPrompt
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/action_prompt.rb

@@ -1,6 +1,8 @@
 require "action_prompt/version"
 require "action_prompt/engine"
-
+require "action_prompt/railtie"
+require "action_prompt/prompt"
+require "action_prompt/preview"
+require "action_prompt/renderer"
 module ActionPrompt
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_prompt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Evan Arnold
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,12 +35,18 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/action_prompt_manifest.js
+- app/controllers/action_prompt/previews_controller.rb
+- app/views/action_prompt/previews/index.html.erb
+- app/views/action_prompt/previews/show.html.erb
+- app/views/layouts/application.html.erb
 - config/routes.rb
 - lib/action_prompt.rb
-- lib/action_prompt/base.rb
 - lib/action_prompt/engine.rb
+- lib/action_prompt/preview.rb
+- lib/action_prompt/prompt.rb
+- lib/action_prompt/railtie.rb
+- lib/action_prompt/renderer.rb
 - lib/action_prompt/version.rb
-- lib/tasks/action_prompt_tasks.rake
 homepage: https://github.com/evdevdev/action_prompt
 licenses:
 - MIT
@@ -61,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.19
 signing_key:
 specification_version: 4
 summary: ActionPrompt is a Rails plugin for managing templated LLM prompts

data/lib/action_prompt/base.rb

@@ -1,6 +0,0 @@
-module ActionPrompt
-  class Base
-    def self.render_prompt(template_name, locals: {})
-    end
-  end
-end

data/lib/tasks/action_prompt_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :action_prompt do
-#   # Task goes here
-# end