active_prompt_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3acda164ca3d3f9d1cdb8be59df667ad5e7a86a034eb659792b89cb05a671ea
+  data.tar.gz: 02caaedae4819c0a5f989fd5a23651435429a324f1ac8b775ed66f213a65debd
+SHA512:
+  metadata.gz: 3adeb75900c04e0d120c5337dd07e2fbb0d0c1d58229a36e44a5484e2a300cf009caacfacce66daafb9342f4989f8d8b1421082ad40b3074ead641f029377c4c
+  data.tar.gz: d2abb4207dc8c50e470d9a7532d6c26953f8b2ff6f153bca66a05a20169f7b7f9333374e87549d0d0297a36dd75fdd561e6999f710b4fb631ca642709b637938

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-15
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_prompt.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/README.md

@@ -0,0 +1,31 @@
+# ActivePrompt
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_prompt`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_prompt.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/active_prompt.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_prompt/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "active_prompt_rails"
+  spec.licenses = ["MIT"]
+  spec.version = ActivePrompt::VERSION
+  spec.authors = ["Shane Perreault"]
+  spec.email = ["shaneprrlt@gmail.com"]
+  spec.summary = "Easily create and manage LLM prompt templates in your rails app."
+  spec.description = "Easily create and manage LLM prompt templates in your rails app." \
+                     "Use your own custom templating engine like ERB or Shopify Liquid."
+  spec.homepage = "https://www.github.com/Shaneprrlt/active_prompt"
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/Shaneprrlt/active_prompt"
+  spec.metadata["changelog_uri"] = "https://www.github.com/Shaneprrlt/active_prompt/blob/main/CHANGELOG.md"
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "liquid", "~> 5.2", ">= 5.2.0"
+  spec.add_runtime_dependency "rails", "~> 6.0"
+end

data/lib/active_prompt/base.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# lib/active_prompt/base.rb
+require "active_support/inflector"
+require "liquid"
+require_relative "errors"
+
+module ActivePrompt
+  # Base class for all prompt classes
+  class Base
+    def self.variables
+      @variables ||= []
+    end
+
+    def self.variable(name)
+      variables << name
+      attr_accessor name
+    end
+
+    def initialize(params = {})
+      self.class.variables.each do |var|
+        raise MissingVariableError, var unless params.key?(var)
+
+        send("#{var}=", params[var]) # Dynamic method call to set the variable
+      end
+    end
+
+    def render_system
+      render_template("system.liquid")
+    end
+
+    def render_user
+      render_template("user.liquid")
+    end
+
+    def render_messages
+      [
+        { role: "system", content: render_system },
+        { role: "user", content: render_user }
+      ]
+    end
+
+    private
+
+    def render_template(template_name)
+      template_path = File.join("app", "prompts", self.class.name.underscore, template_name)
+      template = File.read(template_path)
+      context = # Dynamic method call to get the variable value
+        self.class.variables.map do |var|
+          [var, send(var)]
+        end.to_h
+      Liquid::Template.parse(template).render(context)
+    end
+  end
+end

data/lib/active_prompt/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActivePrompt
+  # Error raised when a required variable is missing
+  class MissingVariableError < StandardError
+    def initialize(variable_name)
+      super("Missing required variable: #{variable_name}")
+    end
+  end
+end

data/lib/active_prompt/generators/prompt/prompt_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActivePrompt
+  module Generators
+    # This generator creates a new prompt in the app/prompts directory
+    class PromptGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_prompt_files
+        create_file "app/prompts/#{file_name}/system.liquid"
+        create_file "app/prompts/#{file_name}/user.liquid"
+        create_file "app/prompts/#{file_name}/prompt.rb", <<~RUBY
+          # This is a generated prompt class for #{file_name}
+          class #{file_name.camelize}Prompt < ActivePrompt::Base
+            # Define your prompt methods here
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/active_prompt/generators/prompt/templates/system.liquid

@@ -0,0 +1 @@
+Enter your system message here.

data/lib/active_prompt/generators/prompt/templates/user.liquid

@@ -0,0 +1 @@
+Enter your user message here.

data/lib/active_prompt/version.rb

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

data/lib/active_prompt.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "active_prompt/version"
+
+module ActivePrompt
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/active_prompt.rbs

@@ -0,0 +1,4 @@
+module ActivePrompt
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: active_prompt_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shane Perreault
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Easily create and manage LLM prompt templates in your rails app.Use your
+  own custom templating engine like ERB or Shopify Liquid.
+email:
+- shaneprrlt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- active_prompt.gemspec
+- lib/active_prompt.rb
+- lib/active_prompt/base.rb
+- lib/active_prompt/errors.rb
+- lib/active_prompt/generators/prompt/prompt_generator.rb
+- lib/active_prompt/generators/prompt/templates/system.liquid
+- lib/active_prompt/generators/prompt/templates/user.liquid
+- lib/active_prompt/version.rb
+- sig/active_prompt.rbs
+homepage: https://www.github.com/Shaneprrlt/active_prompt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/Shaneprrlt/active_prompt
+  source_code_uri: https://www.github.com/Shaneprrlt/active_prompt
+  changelog_uri: https://www.github.com/Shaneprrlt/active_prompt/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Easily create and manage LLM prompt templates in your rails app.
+test_files: []