ruby_llm-red_candle 0.1.0

data/lib/ruby_llm/red_candle/schema_validator.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module RedCandle
+    # Validates JSON schemas for structured generation
+    module SchemaValidator
+      class << self
+        # Validate a schema for structured generation
+        # @param schema [Hash] the JSON schema to validate
+        # @raise [RubyLLM::Error] if the schema is invalid
+        # @return [true] if validation passes
+        def validate!(schema)
+          errors = validate(schema)
+          return true if errors.empty?
+
+          raise RubyLLM::Error.new(
+            nil,
+            build_error_message(errors, schema)
+          )
+        end
+
+        # Validate a schema and return any errors
+        # @param schema [Hash] the JSON schema to validate
+        # @return [Array<String>] list of validation errors (empty if valid)
+        def validate(schema)
+          errors = []
+
+          # Check schema is a Hash
+          unless schema.is_a?(Hash)
+            errors << "Schema must be a Hash, got #{schema.class.name}"
+            return errors # Can't continue validation
+          end
+
+          # Check type is "object"
+          schema_type = schema[:type] || schema["type"]
+          if schema_type.nil?
+            errors << "Schema must have a 'type' field"
+          elsif schema_type.to_s != "object"
+            errors << "Schema type must be 'object' for structured generation, got '#{schema_type}'"
+          end
+
+          # Check properties exist and are valid
+          properties = schema[:properties] || schema["properties"]
+          if properties.nil?
+            errors << "Schema must have a 'properties' field defining the expected output structure"
+          elsif !properties.is_a?(Hash)
+            errors << "Schema 'properties' must be a Hash, got #{properties.class.name}"
+          elsif properties.empty?
+            errors << "Schema 'properties' must define at least one property"
+          else
+            # Validate each property has a type
+            properties.each do |key, value|
+              unless value.is_a?(Hash)
+                errors << "Property '#{key}' must be a Hash with at least a 'type' field"
+                next
+              end
+
+              prop_type = value[:type] || value["type"]
+              if prop_type.nil?
+                errors << "Property '#{key}' must have a 'type' field"
+              end
+            end
+          end
+
+          errors
+        end
+
+        # Check if a schema is valid without raising
+        # @param schema [Hash] the JSON schema to validate
+        # @return [Boolean] true if valid
+        def valid?(schema)
+          validate(schema).empty?
+        end
+
+        private
+
+        def build_error_message(errors, schema)
+          message = ["Invalid schema for structured generation:"]
+          errors.each { |e| message << "  - #{e}" }
+          message << ""
+          message << "Expected a JSON Schema like:"
+          message << "  {"
+          message << "    type: 'object',"
+          message << "    properties: {"
+          message << "      name: { type: 'string' },"
+          message << "      age: { type: 'integer' }"
+          message << "    },"
+          message << "    required: ['name', 'age']"
+          message << "  }"
+          message << ""
+          message << "Received: #{truncate_schema(schema)}"
+          message.join("\n")
+        end
+
+        def truncate_schema(schema)
+          str = schema.inspect
+          str.length > 200 ? "#{str[0..200]}..." : str
+        end
+      end
+    end
+  end
+end

data/lib/ruby_llm/red_candle/streaming.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module RedCandle
+    # Streaming methods of the RedCandle integration
+    module Streaming
+      def stream(payload, &block)
+        if payload[:stream]
+          perform_streaming_completion!(payload, &block)
+        else
+          # Non-streaming fallback
+          result = perform_completion!(payload)
+          # Yield the complete result as a single chunk
+          chunk = {
+            content: result[:content],
+            role: result[:role],
+            finish_reason: result[:finish_reason]
+          }
+          block.call(chunk)
+        end
+      end
+
+      private
+
+      def stream_processor
+        # Red Candle handles streaming internally through blocks
+        # This method is here for compatibility with the base streaming interface
+        nil
+      end
+
+      def process_stream_response(response)
+        # Red Candle doesn't use HTTP responses
+        # Streaming is handled directly in perform_streaming_completion!
+        response
+      end
+    end
+  end
+end

data/lib/ruby_llm/red_candle/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module RedCandle
+    VERSION = "0.1.0"
+  end
+end

data/lib/ruby_llm-red_candle.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "ruby_llm"
+
+require_relative "ruby_llm/red_candle/version"
+require_relative "ruby_llm/red_candle/configuration"
+require_relative "ruby_llm/red_candle/schema_validator"
+require_relative "ruby_llm/red_candle/capabilities"
+require_relative "ruby_llm/red_candle/models"
+require_relative "ruby_llm/red_candle/streaming"
+require_relative "ruby_llm/red_candle/chat"
+require_relative "ruby_llm/red_candle/provider"
+
+module RubyLLM
+  # Red Candle plugin module - provides local LLM execution using quantized GGUF models
+  module RedCandle
+    class << self
+      # Register the provider with RubyLLM
+      def register!
+        RubyLLM::Provider.register :red_candle, Provider
+
+        # Register Red Candle models with the global registry
+        Provider.models.each do |model|
+          RubyLLM.models.instance_variable_get(:@models) << model
+        end
+      end
+    end
+  end
+end
+
+# Auto-register when the gem is loaded
+RubyLLM::RedCandle.register!

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ruby_llm-red_candle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Petersen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_llm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: red-candle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: |
+  A RubyLLM plugin that enables local LLM execution using the Red Candle gem.
+  Run quantized GGUF models directly in Ruby without external API calls.
+  Supports streaming, structured output, and multiple model architectures
+  including Gemma, Llama, Qwen, Mistral, and Phi.
+email:
+- chris@scientist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/smoke_test.rb
+- lib/ruby_llm-red_candle.rb
+- lib/ruby_llm/red_candle/capabilities.rb
+- lib/ruby_llm/red_candle/chat.rb
+- lib/ruby_llm/red_candle/configuration.rb
+- lib/ruby_llm/red_candle/models.rb
+- lib/ruby_llm/red_candle/provider.rb
+- lib/ruby_llm/red_candle/schema_validator.rb
+- lib/ruby_llm/red_candle/streaming.rb
+- lib/ruby_llm/red_candle/version.rb
+homepage: https://github.com/scientist-labs/ruby_llm-red_candle
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/scientist-labs/ruby_llm-red_candle
+  source_code_uri: https://github.com/scientist-labs/ruby_llm-red_candle
+  changelog_uri: https://github.com/scientist-labs/ruby_llm-red_candle/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Red Candle provider for RubyLLM - local LLM execution using quantized GGUF
+  models
+test_files: []