ruby_llm-template 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49596291defa8cac6cb6088736c1403b7e7612aa5948da276dba410ae114ed27
-  data.tar.gz: '09b7dbfb13a4535aebd3c70df2353a9dc73597eacc160aea2643dc3272774e4b'
+  metadata.gz: 8af32c4910100355c57302be6fb145bc6463fa3c39105533bda9a6002709bd1c
+  data.tar.gz: a55213fce936c617a83db65eea1aeb54584fcafae203a54a8736c41c17d25c33
 SHA512:
-  metadata.gz: ed0c3650f34970ac5ecd0ed30c48196cdcb0a81283828431ab17852cde489591e210c9cb52c68e42e89b12ce5565b6aca399a1838ac38cfe3516d1e5d0912fba
-  data.tar.gz: 30520cba8a4e3aad1edbf971651310098f8f7c9c2f1367023337010537f6dd2a668aa94b6bfe5a53de2ba2af6e03d3e6d3628db5282d738422928e86d3c88574
+  metadata.gz: 8831170d3d2a9dc5feacfb0332cbe9c232a2383c970e1b50de51429e2fe0eddf87ee70cbaf85bc2fec67430082e2a3f0b40d7d2d62187ff454a4198a4d0be7d8
+  data.tar.gz: 9a16c7e87550bfd9d5e0cd796543429933a027641fdc99c770337fc97d2e37e940b216404e1a88d19fb3418405ac86417fed1755d0056711fabd2f6261998afc

data/README.md

@@ -7,12 +7,6 @@
 Organize prompts into easy-to-use templates for [RubyLLM](https://github.com/crmne/ruby_llm).
 
 ```ruby
-chat = RubyLLM.chat
-chat.with_template(:extract_metadata, document: @document).complete
-
-# ----------------------------------
-# Retrieves the following files:
-# ----------------------------------
 # prompts/
 #   extract_metadata/
 #     ├── system.txt.erb    # System message
@@ -20,6 +14,8 @@ chat.with_template(:extract_metadata, document: @document).complete
 #     ├── assistant.txt.erb # Assistant message (optional)
 #     └── schema.rb         # RubyLLM::Schema definition (optional)
 
+chat = RubyLLM.chat
+chat.with_template(:extract_metadata, document: @document).complete
 ```
 
 ## Features
@@ -115,28 +111,24 @@ end
 ### 3. Use the Template
 
 ```ruby
-# Basic usage
-RubyLLM.chat.with_template(:extract_metadata, document: @document).complete
+chat = RubyLLM.chat
+chat.with_template(:extract_metadata, document: @document, additional_context: "Focus on technical details").complete
 
-# With context variables
-RubyLLM.chat.with_template(:extract_metadata, 
-  document: @document,
-  additional_context: "Focus on technical details"
-).complete
+# Under the hood, RubyLLM::Template renders the templates with the context variables
+# and applies them to the chat instance using native RubyLLM methods:
 
-# Chaining with other RubyLLM methods
-RubyLLM.chat
-  .with_template(:extract_metadata, document: @document)
-  .with_model("gpt-4")
-  .complete
+# chat.add_message(:system, rendered_system_message)
+# chat.add_message(:user, rendered_user_message)
+# chat.add_schema(instantiated_schema)
 ```
 
+
 ## Configuration
 
 ### Non-Rails Applications
 
 ```ruby
-RubyLlm::Template.configure do |config|
+RubyLLM::Template.configure do |config|
   config.template_directory = "/path/to/your/prompts"
 end
 ```
@@ -146,7 +138,7 @@ end
 The gem automatically configures itself to use `Rails.root.join("app", "prompts")`, but you can override this in `config/initializers/ruby_llm_template.rb`:
 
 ```ruby
-RubyLlm::Template.configure do |config|
+RubyLLM::Template.configure do |config|
   config.template_directory = Rails.root.join("app", "ai_prompts")
 end
 ```
@@ -166,7 +158,13 @@ Templates are processed in order: system → user → assistant → schema
 
 All context variables passed to `with_template` are available in your ERB templates:
 
+```ruby
+chat = RubyLLM.chat
+chat.with_template(:message, name: "Alice", urgent: true, documents: @documents)
+```
+
 ```erb
+<!-- /prompts/message/user.txt.erb -->
 Hello <%= name %>!
 
 <% if urgent %>
@@ -249,7 +247,7 @@ The gem provides clear error messages for common issues:
 ```ruby
 begin
   RubyLLM.chat.with_template(:extract_metadata).complete
-rescue RubyLlm::Template::Error => e
+rescue RubyLLM::Template::Error => e
   puts e.message 
   # "Template 'extract_metadata' not found in /path/to/prompts"
   # "Schema file 'extract_metadata/schema.rb' found but RubyLLM::Schema gem is not installed"

data/examples/basic_usage.rb

@@ -7,7 +7,7 @@
 require_relative "../lib/ruby_llm/template"
 
 # Configure template directory
-RubyLlm::Template.configure do |config|
+RubyLLM::Template.configure do |config|
   config.template_directory = File.join(__dir__, "prompts")
 end
 
@@ -91,7 +91,7 @@ puts "=" * 40
 
 # Mock chat object that demonstrates the extension
 class MockChat
-  include RubyLlm::Template::ChatExtension
+  include RubyLLM::Template::ChatExtension
 
   def initialize
     @messages = []
@@ -135,7 +135,7 @@ begin
     document: "Q3 Financial Report: Revenue increased 15% to $2.3M. Key challenges include supply chain delays affecting Q4 projections.",
     additional_context: "Focus on financial metrics and future outlook",
     focus_areas: ["revenue", "challenges", "projections"]).complete
-rescue RubyLlm::Template::Error => e
+rescue RubyLLM::Template::Error => e
   puts "❌ Error: #{e.message}"
 end
 

data/lib/generators/ruby_llm/template/install_generator.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RubyLLM
+  module Template
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        namespace "ruby_llm_template:install"
+        desc "Install RubyLLM Template system"
+
+        def self.source_root
+          @source_root ||= File.expand_path("templates", __dir__)
+        end
+
+        def create_initializer
+          create_file "config/initializers/ruby_llm_template.rb", <<~RUBY
+            # frozen_string_literal: true
+
+            RubyLLM::Template.configure do |config|
+              # Set the directory where your prompts are stored
+              # Default: Rails.root.join("app", "prompts")
+              # config.template_directory = Rails.root.join("app", "prompts")
+            end
+          RUBY
+        end
+
+        def create_template_directory
+          empty_directory "app/prompts"
+
+          create_file "app/prompts/.keep", ""
+
+          # Create an example template
+          create_example_template
+        end
+
+        def show_readme
+          say <<~MESSAGE
+
+            RubyLLM Template has been installed!
+
+            Prompts directory: app/prompts/
+            Configuration: config/initializers/ruby_llm_template.rb
+
+            Example usage:
+              RubyLLM.chat.with_template(:extract_metadata, document: @document).complete
+
+            Template structure:
+              app/prompts/extract_metadata/
+                ├── system.txt.erb    # System message
+                ├── user.txt.erb      # User prompt
+                ├── assistant.txt.erb # Assistant message (optional)
+                └── schema.rb         # RubyLLM::Schema definition (optional)
+
+            Get started by creating your first template!
+          MESSAGE
+        end
+
+        private
+
+        def create_example_template
+          example_dir = "app/prompts/extract_metadata"
+          empty_directory example_dir
+
+          create_file "#{example_dir}/system.txt.erb", <<~ERB
+            You are an expert document analyzer. Your task is to extract metadata from the provided document.
+
+            Please analyze the document carefully and extract relevant information such as:
+            - Document type
+            - Key topics
+            - Important dates
+            - Main entities mentioned
+
+            Provide your analysis in a structured format.
+          ERB
+
+          create_file "#{example_dir}/user.txt.erb", <<~ERB
+            Please analyze the following document and extract its metadata:
+
+            <% if defined?(document) && document %>
+            Document: <%= document %>
+            <% else %>
+            [Document content will be provided here]
+            <% end %>
+
+            <% if defined?(additional_context) && additional_context %>
+            Additional context: <%= additional_context %>
+            <% end %>
+          ERB
+
+          create_file "#{example_dir}/schema.rb", <<~RUBY
+            # frozen_string_literal: true
+
+            # Schema definition using RubyLLM::Schema DSL
+            # See: https://github.com/danielfriis/ruby_llm-schema
+
+            RubyLLM::Schema.create do
+              string :document_type, description: "The type of document (e.g., report, article, email)"
+
+              array :key_topics, description: "Main topics discussed in the document" do
+                string
+              end
+
+              array :important_dates, required: false, description: "Significant dates mentioned in the document" do
+                string format: "date"
+              end
+
+              array :entities, required: false, description: "Named entities found in the document" do
+                object do
+                  string :name
+                  string :type, enum: ["person", "organization", "location", "other"]
+                end
+              end
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/ruby_llm/template/chat_extension.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module RubyLlm
+module RubyLLM
   module Template
     module ChatExtension
       def with_template(template_name, context = {})
-        loader = RubyLlm::Template::Loader.new(template_name)
+        loader = RubyLLM::Template::Loader.new(template_name)
 
         unless loader.template_exists?
-          raise RubyLlm::Template::Error, "Template '#{template_name}' not found in #{RubyLlm::Template.configuration.template_directory}"
+          raise RubyLLM::Template::Error, "Template '#{template_name}' not found in #{RubyLLM::Template.configuration.template_directory}"
         end
 
         # Apply templates in a specific order to maintain conversation flow

data/lib/ruby_llm/template/configuration.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RubyLlm
+module RubyLLM
   module Template
     class Configuration
       attr_writer :template_directory

data/lib/ruby_llm/template/loader.rb

@@ -9,14 +9,14 @@ rescue LoadError
   # RubyLLM::Schema not available, schema.rb files won't work
 end
 
-module RubyLlm
+module RubyLLM
   module Template
     class Loader
       SUPPORTED_ROLES = %w[system user assistant schema].freeze
 
       def initialize(template_name, template_directory: nil)
         @template_name = template_name.to_s
-        @template_directory = Pathname.new(template_directory || RubyLlm::Template.configuration.template_directory)
+        @template_directory = Pathname.new(template_directory || RubyLLM::Template.configuration.template_directory)
         @template_path = @template_directory.join(@template_name)
       end
 

data/lib/ruby_llm/template/railtie.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
-module RubyLlm
+module RubyLLM
   module Template
     class Railtie < Rails::Railtie
+      # Register generators
+      generators do
+        require_relative "../../generators/ruby_llm/template/install_generator"
+      end
+
       initializer "ruby_llm_template.configure" do |app|
         # Set default template directory for Rails applications
-        RubyLlm::Template.configure do |config|
+        RubyLLM::Template.configure do |config|
           config.template_directory ||= app.root.join("app", "prompts")
         end
       end

data/lib/ruby_llm/template/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module RubyLlm
+module RubyLLM
   module Template
-    VERSION = "0.1.4"
+    VERSION = "0.1.6"
   end
 end

data/lib/ruby_llm/template.rb

@@ -13,7 +13,7 @@ rescue LoadError
   # Rails not available
 end
 
-module RubyLlm
+module RubyLLM
   module Template
     class Error < StandardError; end
 
@@ -41,7 +41,7 @@ begin
 
     module RubyLLMChatTemplateExtension
       def self.extended(base)
-        base.extend(RubyLlm::Template::ChatExtension)
+        base.extend(RubyLLM::Template::ChatExtension)
       end
     end
 
@@ -49,7 +49,7 @@ begin
     module RubyLLMTemplateHook
       def chat(*args, **kwargs)
         chat_instance = super
-        chat_instance.extend(RubyLlm::Template::ChatExtension)
+        chat_instance.extend(RubyLLM::Template::ChatExtension)
         chat_instance
       end
     end

data/sig/ruby_llm/template.rbs

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-template
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Daniel Friis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-03 00:00:00.000000000 Z
+date: 2025-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_llm
@@ -68,7 +68,7 @@ files:
 - README.md
 - Rakefile
 - examples/basic_usage.rb
-- lib/generators/ruby_llm_template/install_generator.rb
+- lib/generators/ruby_llm/template/install_generator.rb
 - lib/ruby_llm/template.rb
 - lib/ruby_llm/template/chat_extension.rb
 - lib/ruby_llm/template/configuration.rb

data/lib/generators/ruby_llm_template/install_generator.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-
-module RubyLlmTemplate
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      desc "Install RubyLLM Template system"
-
-      def self.source_root
-        @source_root ||= File.expand_path("templates", __dir__)
-      end
-
-      def create_initializer
-        create_file "config/initializers/ruby_llm_template.rb", <<~RUBY
-          # frozen_string_literal: true
-
-          RubyLlm::Template.configure do |config|
-                      # Set the directory where your prompts are stored
-          # Default: Rails.root.join("app", "prompts")
-          # config.template_directory = Rails.root.join("app", "prompts")
-          end
-        RUBY
-      end
-
-      def create_template_directory
-        empty_directory "app/prompts"
-
-        create_file "app/prompts/.keep", ""
-
-        # Create an example template
-        create_example_template
-      end
-
-      def show_readme
-        say <<~MESSAGE
-          
-          RubyLLM Template has been installed!
-          
-          Prompts directory: app/prompts/
-          Configuration: config/initializers/ruby_llm_template.rb
-          
-          Example usage:
-            RubyLLM.chat.with_template(:extract_metadata, document: @document).complete
-          
-          Template structure:
-            app/prompts/extract_metadata/
-              ├── system.txt.erb    # System message
-              ├── user.txt.erb      # User prompt
-              ├── assistant.txt.erb # Assistant message (optional)
-              └── schema.rb         # RubyLLM::Schema definition (optional)
-          
-          Get started by creating your first template!
-        MESSAGE
-      end
-
-      private
-
-      def create_example_template
-        example_dir = "app/prompts/extract_metadata"
-        empty_directory example_dir
-
-        create_file "#{example_dir}/system.txt.erb", <<~ERB
-          You are an expert document analyzer. Your task is to extract metadata from the provided document.
-          
-          Please analyze the document carefully and extract relevant information such as:
-          - Document type
-          - Key topics
-          - Important dates
-          - Main entities mentioned
-          
-          Provide your analysis in a structured format.
-        ERB
-
-        create_file "#{example_dir}/user.txt.erb", <<~ERB
-          Please analyze the following document and extract its metadata:
-          
-          <% if defined?(document) && document %>
-          Document: <%= document %>
-          <% else %>
-          [Document content will be provided here]
-          <% end %>
-          
-          <% if defined?(additional_context) && additional_context %>
-          Additional context: <%= additional_context %>
-          <% end %>
-        ERB
-
-        create_file "#{example_dir}/schema.rb", <<~RUBY
-          # frozen_string_literal: true
-
-          # Schema definition using RubyLLM::Schema DSL
-          # See: https://github.com/danielfriis/ruby_llm-schema
-
-          RubyLLM::Schema.create do
-            string :document_type, description: "The type of document (e.g., report, article, email)"
-            
-            array :key_topics, description: "Main topics discussed in the document" do
-              string
-            end
-            
-            array :important_dates, required: false, description: "Significant dates mentioned in the document" do
-              string format: "date"
-            end
-            
-            array :entities, required: false, description: "Named entities found in the document" do
-              object do
-                string :name
-                string :type, enum: ["person", "organization", "location", "other"]
-              end
-            end
-          end
-        RUBY
-      end
-    end
-  end
-end