action_prompt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aadef0f0c0b9de5ed1dcc33d550137a92b69fcd84b003dbc081d25f9e741e3f4
-  data.tar.gz: 023eabdc185943d87c587f424b20b71cc425ca8d59b13688ffc54133ef19eca0
+  metadata.gz: de8ad6099ba3b0e8ff896d96e8ff8a543a9558d09c129d248b778bbf33ca5b36
+  data.tar.gz: b4473d1847ebf29e43c57461f8397281b6ccdb12132673517477a7a424c210da
 SHA512:
-  metadata.gz: cfe7c7884e48024e04187aa8a92390994d84300c022fd0f4dc780aa79a01e083f2c79f703a964dcf22be7d81ae26de5d936a741773cc3267a019572d0db99834
-  data.tar.gz: 7762444c108aaee485b964e90002ad2361db3fb46f38a5dcb08697af38068535f88126bb3d326157f1d87c0b2f41c0fa86499473c929d3d6780ddb4941f6ba11
+  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

@@ -13,9 +13,9 @@ class ActionPrompt::PreviewsController < ActionController::Base
   end
 
   def show
-    preview_class_name = params[:preview_name].camelize + "Preview"
+    preview_class_name = params[:preview_slug].camelize + "Preview"
     @preview_class = ActionPrompt::Preview.find(preview_class_name)
-    slug = "#{params[:preview_name]}/#{params[:prompt_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

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

@@ -7,10 +7,10 @@
     <div class="space-y-4">
       <% @previews.each do |preview| %>
         <div>
-          <h2 class="text-lg font-semibold"><%= preview.preview_name.titleize %></h2>
+          <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 text-blue-500 underline hover:text-blue-600" %></li>
+              <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>

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

@@ -1,8 +1,8 @@
 <h1 class="text-xl font-semibold">
-  <%= @preview_class.name %>: <%= @prompt.name %>
+  <%= @preview_class.display_name %>: <%= @prompt.name %>
 </h1>
 <div class="pb-2">
-  <%= link_to "<< Back to prompts", "/action_prompt/previews", class: "cursor-pointer text-blue-500 underline hover:text-blue-600 text-sm" %>
+  <%= 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>

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

@@ -6,9 +6,9 @@
   <title><%= @page_title %></title>
   <script src="https://cdn.tailwindcss.com"></script>
 </head>
-<body class="min-h-screen bg-yellow-100 pt-2">
+<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">
+<div class="mx-auto w-2/3 bg-white rounded-lg p-8 shadow-lg border-2">
 <%= yield %>
 </div>
 

data/lib/action_prompt/preview.rb

@@ -21,7 +21,11 @@ module ActionPrompt
         end
       end
 
-      def preview_name
+      def display_name
+        name.titleize
+      end
+
+      def slug
         name.delete_suffix("Preview").underscore
       end
 
@@ -31,7 +35,7 @@ module ActionPrompt
 
         prompt_methods.map do |method_name|
           Prompt.new(name: method_name.humanize,
-                     slug: "#{preview_name}/#{method_name}")
+                     slug: "#{slug}/#{method_name}")
         end
       end
 
@@ -44,17 +48,6 @@ module ActionPrompt
       end
     end
 
-
-    class Prompt
-      attr_reader :name, :slug
-
-      # NOTE: this could probably be a Struct
-      def initialize(name:, slug:)
-        @name = name
-        @slug = slug
-      end
-    end
-
     def render(template_name, locals: {})
       ActionPrompt::Renderer.new.render(template_name, locals: locals)
     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

@@ -2,13 +2,15 @@ require "rails/application_controller"
 
 module ActionPrompt
   class Railtie < Rails::Railtie
-    config.autoload_paths << Rails.root.join("tests/prompts")
+    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_name/:prompt_name", to: "action_prompt/previews#show" # , internal: true
+          get "/action_prompt/previews/:preview_slug/:prompt_name", to: "action_prompt/previews#show" # , internal: true
         end
       end
     end

data/lib/action_prompt/version.rb

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

data/lib/action_prompt.rb

@@ -1,6 +1,7 @@
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_prompt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Evan Arnold
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-13 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,7 @@ files:
 - lib/action_prompt.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
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.19
 signing_key:
 specification_version: 4
 summary: ActionPrompt is a Rails plugin for managing templated LLM prompts