spectre_ai 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ce184de05db051e8406fcd782ab084b745899cf914ac606a3a57b7201835325
-  data.tar.gz: b2adc0ef0d18ca87a9af0d5a1e3ca4273d2fad2d234a8f1f2cb9c3ca370723ae
+  metadata.gz: 5a1b57e957fd8d44c84db209bc46d0c86a7be77a37d5f0f9ca726c2f2622a539
+  data.tar.gz: b09d880f7f80e918c229caba2d5754e2dcf96ca9afeb1ca3091e7db0232420c1
 SHA512:
-  metadata.gz: cbfaa059e8432580a7fbda955ff66945a7e5b97fd76205feb1ae9f1934bf02bfe610741e56f43ecf8dc842fb600e3e1a913e5992044dc96b72a3c7feece87a3c
-  data.tar.gz: ea9ef3108a3f6550646cd698e13e9e32d97c0de7dcba1b4045d5b880095f078e7ef7520bea5c1515265853290610cf6859ce34497eee1dfbcee2a7f2852068bb
+  metadata.gz: 91d020445d05ca703d78b6f0fda842a9f92c55b4c67d8b201accdad8fe352ccec2e4e28e36b157ae2a82f86f574d0873ddf23ff4ebbf7c15f707a2c467c47532
+  data.tar.gz: 48eb3d8f6339d999ff7386e32de81cb01008ceb3245fb9fc2e150311845779e1f5c788198c35710d20584100085974035fd1730f1c093d8634202a45d9b3756f

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog for Version 1.0.1
+
+**Release Date:** [19th Sep 2024]
+
+**Improvements to Prompt Class**
+
+1.	Escaping Special Characters in YAML/ERB:
+
+•	Implemented automatic escaping of special characters in YAML/ERB templates, such as &, <, >, ", and ' to prevent parsing issues.
+
+•	Special characters are escaped before rendering the YAML file to ensure compatibility with YAML parsers.
+
+•	After rendering, the escaped characters are converted back to their original form, ensuring the final output is clean and readable.
+
+•	This update prevents errors that occur when rendering templates with complex queries or strings containing special characters.
+
+Example:
+
+```yaml
+user: |
+  User's query: <%= @query %>
+  Context: <%= @responses.join(", ") %>
+```
+
+Before this change, queries or responses containing special characters might have caused YAML parsing errors. This update ensures that even complex strings are handled safely and returned in their original form.
+
+To upgrade, update your Gemfile to version 1.0.1 and run bundle install. Make sure your YAML/ERB templates do not manually escape special characters anymore, as the Prompt class will handle it automatically.

data/README.md

@@ -1,4 +1,4 @@
-# Spectre
+# Spectre [![Gem Version](https://badge.fury.io/rb/spectre_ai.svg)](https://badge.fury.io/rb/spectre_ai)
 
 **Spectre** is a Ruby gem that makes it easy to AI-enable your Ruby on Rails application. Currently, Spectre focuses on helping developers create embeddings, perform vector-based searches, create chat completions, and manage dynamic prompts — ideal for applications that are featuring RAG (Retrieval-Augmented Generation), chatbots and dynamic prompts.
 
@@ -18,7 +18,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'spectre'
+gem 'spectre_ai'
 ```
 
 And then execute:
@@ -30,7 +30,7 @@ bundle install
 Or install it yourself as:
 
 ```bash
-gem install spectre
+gem install spectre_ai
 ```
 
 ## Usage

data/lib/generators/spectre/templates/spectre_initializer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'spectre'
+
 Spectre.setup do |config|
   # Chose your LLM (openai, cohere, ollama)
   config.llm_provider = :openai

data/lib/spectre/prompt.rb

@@ -19,13 +19,26 @@ module Spectre
 
       raise "Prompt file not found: #{file_path}" unless File.exist?(file_path)
 
+      # Preprocess the locals before rendering the YAML file
+      preprocessed_locals = preprocess_locals(locals)
+
       template_content = File.read(file_path)
       erb_template = ERB.new(template_content)
 
-      context = Context.new(locals)
+      context = Context.new(preprocessed_locals)
       rendered_prompt = erb_template.result(context.get_binding)
 
-      YAML.safe_load(rendered_prompt)[prompt]
+      # YAML.safe_load returns a hash, so fetch the correct part based on the prompt
+      parsed_yaml = YAML.safe_load(rendered_prompt)[prompt]
+
+      # Convert special characters back after YAML processing
+      convert_special_chars_back(parsed_yaml)
+    rescue Errno::ENOENT
+      raise "Template file not found at path: #{file_path}"
+    rescue Psych::SyntaxError => e
+      raise "YAML Syntax Error in file #{file_path}: #{e.message}"
+    rescue StandardError => e
+      raise "Error rendering prompt for template '#{template}': #{e.message}"
     end
 
     private
@@ -48,7 +61,54 @@ module Spectre
       "#{PROMPTS_PATH}/#{type}/#{prompt}.yml.erb"
     end
 
-    # Helper class to handle the binding for ERB rendering
+    # Preprocess locals recursively to escape special characters in strings
+    #
+    # @param value [Object] The value to process (string, array, hash, etc.)
+    # @return [Object] Processed value with special characters escaped
+    def self.preprocess_locals(value)
+      case value
+      when String
+        escape_special_chars(value)
+      when Hash
+        value.transform_values { |v| preprocess_locals(v) } # Recurse into hash values
+      when Array
+        value.map { |item| preprocess_locals(item) } # Recurse into array items
+      else
+        value
+      end
+    end
+
+    # Escape special characters in strings to avoid YAML parsing issues
+    #
+    # @param value [String] The string to process
+    # @return [String] The processed string with special characters escaped
+    def self.escape_special_chars(value)
+      value.gsub('&', '&')
+           .gsub('<', '&lt;')
+           .gsub('>', '&gt;')
+           .gsub('"', '&quot;')
+           .gsub("'", '&#39;')
+           .gsub("\n", '\\n')
+           .gsub("\r", '\\r')
+           .gsub("\t", '\\t')
+    end
+
+    # Convert special characters back to their original form after YAML processing
+    #
+    # @param value [String] The string to process
+    # @return [String] The processed string with original special characters restored
+    def self.convert_special_chars_back(value)
+      value.gsub('&amp;', '&')
+           .gsub('&lt;', '<')
+           .gsub('&gt;', '>')
+           .gsub('&quot;', '"')
+           .gsub('&#39;', "'")
+           .gsub('\\n', "\n")
+           .gsub('\\r', "\r")
+           .gsub('\\t', "\t")
+    end
+
+    # Helper class to handle the binding for ERB template rendering
     class Context
       def initialize(locals)
         locals.each do |key, value|

data/lib/spectre/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spectre # :nodoc:all
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectre_ai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ilya Klapatok
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails