rails_prompts 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 207485f6457081520bb54b841b850c9d89f0d6c25a15376e79c540bc167f6252
-  data.tar.gz: 9d8bde3d842ed98b6b2ce968e02cfc443db215bb9e311b3b1f1b18b8b75449f5
+  metadata.gz: f5b6672970bddc5af0f1f9fcdd741c3327b3caaefdc3fa5cda9b0bcea2ec2a4b
+  data.tar.gz: 16bd1ab2baf4d1cd00bee0b84d0fb10bd8621e540165b6fee148831863d3d091
 SHA512:
-  metadata.gz: 26c27a09a193384f0a6c997393c367d783c57e35f24e46ff4a572446642a8a832449ccd988f48d73a026672e7e9720a3914682da11bbeb87889b87ba6fd46ec0
-  data.tar.gz: 85a50e1d629625926ad50fb26baa8c728949c55767cb0937a6128823f303a315293236ef5ef29480c400ea083352be031cbc96caba71e21e60eea99d57ee04e5
+  metadata.gz: e30dffe4b3b4524dd9754bb095c8ca0540615ba939918102b449f2185ba411cd6444c732265021ad18af392bb709e7197023b5a8a5bf9def6b5e2781844ba1cc
+  data.tar.gz: 37e0c5fd86cdb5de025440ce41f2f096f1e06469df93aae4b00ed029d8755a24ebb3fce1bf75d5296bf19a84b1c3a1b4bf6754c3bf94dfae704d2a45826c97bb

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.2] - 2025-12-15
+
+### Added
+- Complete README documentation with usage examples
+- CHANGELOG.md for version tracking
+- LICENSE.txt (MIT License)
+
+## [0.0.1] - 2025-12-15
+
+### Added
+- Initial release of Rails Prompts gem
+- Core functionality for rendering AI prompts from ERB templates
+- Support for markdown files with `.md.erb` extension
+- `render_prompt` method to render templates with variable interpolation
+- `available_prompts` method to list all available prompt templates
+- Configurable prompts directory (defaults to `app/prompts`)
+- Clean variable binding using anonymous Structs for template isolation
+- Comprehensive documentation and usage examples
+
+### Features
+- ERB template support with trim mode
+- Rails integration with automatic directory detection
+- Flexible variable interpolation in prompt templates
+- Error handling for missing templates
+- Support for Ruby >= 2.7.0 and Rails >= 6.0
+
+[0.0.1]: https://github.com/riteshchaudhary/rails_prompts/releases/tag/v0.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ritesh Chaudhary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,227 @@
+# Rails Prompts
+
+A Ruby gem for managing AI prompts in Rails applications using ERB templates stored in markdown files. Centralize your prompts, make them easier to review, version control, and modify.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_prompts'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rails_prompts
+```
+
+## Usage
+
+### 1. Create Your Prompts Directory
+
+By default, Rails Prompts looks for prompt templates in `app/prompts/`. Create this directory:
+
+```bash
+mkdir -p app/prompts
+```
+
+### 2. Create Prompt Templates
+
+Create prompt templates as `.md.erb` files in the `app/prompts/` directory. Use ERB syntax to interpolate variables.
+
+**Example: `app/prompts/summarize_text.md.erb`**
+
+```erb
+You are an expert content summarizer. Please summarize the following text:
+
+Text to summarize:
+---
+<%= text %>
+---
+
+Provide a concise summary in <%= max_words %> words or less.
+```
+
+### 3. Render Prompts in Your Application
+
+Use `RailsPrompts.render_prompt` to render your templates with variables:
+
+```ruby
+# In your controller or service
+prompt = RailsPrompts.render_prompt('summarize_text', {
+  text: "Long article text here...",
+  max_words: 100
+})
+
+# Use the prompt with your AI service
+response = OpenAI::Client.new.chat(
+  parameters: {
+    model: "gpt-4",
+    messages: [{ role: "user", content: prompt }]
+  }
+)
+```
+
+### 4. List Available Prompts
+
+You can get a list of all available prompt templates:
+
+```ruby
+RailsPrompts.available_prompts
+# => ["summarize_text", "generate_title", "code_review"]
+```
+
+### 5. Configure Custom Prompts Directory (Optional)
+
+If you want to store prompts in a different directory:
+
+```ruby
+# In config/initializers/rails_prompts.rb
+RailsPrompts.prompts_dir = Rails.root.join('lib', 'prompts')
+```
+
+## Examples
+
+### Example 1: Code Review Prompt
+
+**`app/prompts/code_review.md.erb`**
+
+```erb
+You are an expert code reviewer. Please review the following <%= language %> code:
+
+```<%= language %>
+<%= code %>
+```
+
+Focus on:
+- Code quality and best practices
+- Potential bugs or security issues
+- Performance considerations
+- Readability and maintainability
+
+Provide constructive feedback.
+```
+
+**Usage:**
+
+```ruby
+prompt = RailsPrompts.render_prompt('code_review', {
+  language: 'ruby',
+  code: File.read('app/models/user.rb')
+})
+```
+
+### Example 2: Generate Product Description
+
+**`app/prompts/product_description.md.erb`**
+
+```erb
+Create a compelling product description for an e-commerce website.
+
+Product Details:
+- Name: <%= product_name %>
+- Category: <%= category %>
+- Key Features: <%= features.join(', ') %>
+- Target Audience: <%= target_audience %>
+
+Write a description that is engaging, SEO-friendly, and highlights the main benefits.
+Length: <%= word_count %> words.
+```
+
+**Usage:**
+
+```ruby
+prompt = RailsPrompts.render_prompt('product_description', {
+  product_name: "Smart Wireless Headphones",
+  category: "Electronics",
+  features: ["Noise cancellation", "30-hour battery", "Bluetooth 5.0"],
+  target_audience: "Music enthusiasts and commuters",
+  word_count: 150
+})
+```
+
+### Example 3: Customer Support Response
+
+**`app/prompts/support_response.md.erb`**
+
+```erb
+You are a friendly and helpful customer support agent for <%= company_name %>.
+
+Customer Issue:
+<%= customer_message %>
+
+<% if previous_interactions.any? %>
+Previous Interactions:
+<% previous_interactions.each do |interaction| %>
+- <%= interaction %>
+<% end %>
+<% end %>
+
+Generate a professional and empathetic response that addresses the customer's concern.
+Tone: <%= tone %>
+```
+
+**Usage:**
+
+```ruby
+prompt = RailsPrompts.render_prompt('support_response', {
+  company_name: "Acme Corp",
+  customer_message: "My order hasn't arrived yet",
+  previous_interactions: ["Order placed 5 days ago", "Shipped 3 days ago"],
+  tone: "friendly and apologetic"
+})
+```
+
+## Best Practices
+
+1. **Keep prompts version controlled**: Since prompts are just files, they're easy to track with git
+2. **Use descriptive template names**: Name your files clearly (e.g., `generate_blog_title.md.erb`)
+3. **Add comments in templates**: Document complex prompts or explain variable usage
+4. **Test your prompts**: Create tests to ensure prompts render correctly with different inputs
+5. **Organize by feature**: Use subdirectories if you have many prompts (coming soon)
+
+## Error Handling
+
+Rails Prompts will raise an `ArgumentError` if a template is not found:
+
+```ruby
+begin
+  prompt = RailsPrompts.render_prompt('nonexistent_template', {})
+rescue ArgumentError => e
+  puts e.message
+  # => "Prompt template 'nonexistent_template' not found at app/prompts/nonexistent_template.md.erb"
+end
+```
+
+## Testing
+
+In your tests, you can configure a test-specific prompts directory:
+
+```ruby
+# In test_helper.rb or rails_helper.rb
+RailsPrompts.prompts_dir = Rails.root.join('test', 'fixtures', 'prompts')
+```
+
+## Requirements
+
+- Ruby >= 2.7.0
+- Rails >= 6.0
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/riteshchaudhary/rails_prompts
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+
+Ritesh Chaudhary (chaudharyritesh7100@gmail.com)

data/lib/rails_prompts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RailsPrompts
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_prompts
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ritesh Chaudhary
@@ -74,6 +74,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - lib/rails_prompts.rb
 - lib/rails_prompts/version.rb
 homepage: https://github.com/riteshchaudhary/rails_prompts