lluminary 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02594d2f6a20444f1e6609a1582ca06c29ecddaf12042a42fdf65621eb16fce3'
-  data.tar.gz: 20c476662fe4ab8dcc4fe403fd580b5d44323bc970f8c9830a7b32eb06589d4e
+  metadata.gz: cd0178afb0e59f3bf23029641e37f9ed149a7a3fadcdf364a88ad9079c8adc7d
+  data.tar.gz: 4fe96f29859d3f55104d977ca81df4e41ff450c1e37a3a880f7af3f574bf8037
 SHA512:
-  metadata.gz: 5b0f2590d708746f35958ea556d6b6bd6d7e9d594505fc5b70178af317a9b6570b1ac9f4ab8580eee0d16776358fa7be7b65f4a3abc88cf14ce364c5410442bf
-  data.tar.gz: aad105c596b169ccb3ca0613d974b3883553d7296190c9906bda88f2b5b00b765a079364cb3b45ffaa94dbf9aa81e2b369aa3a236936eb756671785c32058d5d
+  metadata.gz: 33ec5d4bd8e00d43dca677aafd076f6de386859c14fb0b001b962032ca0a455fdd2c36e5755e6d898ee54a1bbc4f64714c1ea7b9d7774330a25478c4698c8759
+  data.tar.gz: 99c318f93c98a31b1c171436db63609b3258ed183c7e9fc73f16c7f0eb8c09a5eb3d5d1c4e548232e10c2b40956d13b31efae5a0582bb35d91b19d315d667a06

data/lib/lluminary/config.rb

@@ -1,4 +1,14 @@
+# frozen_string_literal: true
+
 module Lluminary
+  # Configuration class for Lluminary framework.
+  # Handles global settings and provider configurations.
+  #
+  # @example Setting up configuration
+  #   Lluminary.configure do |config|
+  #     config.provider = :openai
+  #     config.api_key = "your-api-key"
+  #   end
   class Config
     def initialize
       @providers = {}
@@ -20,4 +30,4 @@ module Lluminary
       @providers = {}
     end
   end
-end 
+end

data/lib/lluminary/field_description.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 module Lluminary
+  # Represents a field in a schema with its type, description, and validations.
+  # Used to generate human-readable descriptions and validate field values.
   class FieldDescription
     def initialize(name, field)
       @name = name
@@ -11,7 +14,9 @@ module Lluminary
       parts = []
       parts << "#{@name} (#{type_description})"
       parts << ": #{@description}" if @description
-      parts << " (#{validation_descriptions.join(', ')})" if validation_descriptions.any?
+      if validation_descriptions.any?
+        parts << " (#{validation_descriptions.join(", ")})"
+      end
       parts.join
     end
 
@@ -19,7 +24,9 @@ module Lluminary
       parts = []
       parts << "#{@name} (#{type_description})"
       parts << ": #{@description}" if @description
-      parts << "\nValidation: #{validation_descriptions.join(', ')}" if validation_descriptions.any?
+      if validation_descriptions.any?
+        parts << "\nValidation: #{validation_descriptions.join(", ")}"
+      end
       parts << "\nExample: #{example_value}"
       parts.join
     end
@@ -36,26 +43,28 @@ module Lluminary
     end
 
     def validation_descriptions
-      @validations.map do |_, options|
-        case options.keys.first
-        when :absence
-          "must be absent"
-        when :comparison
-          comparison_descriptions(options[:comparison])
-        when :exclusion
-          "must not be one of: #{options[:exclusion][:in].join(', ')}"
-        when :format
-          "must match format: #{options[:format][:with]}"
-        when :inclusion
-          "must be one of: #{options[:inclusion][:in].join(', ')}"
-        when :length
-          length_descriptions(options[:length])
-        when :numericality
-          numericality_descriptions(options[:numericality])
-        when :presence
-          "must be present"
+      @validations
+        .map do |_, options|
+          case options.keys.first
+          when :absence
+            "must be absent"
+          when :comparison
+            comparison_descriptions(options[:comparison])
+          when :exclusion
+            "must not be one of: #{options[:exclusion][:in].join(", ")}"
+          when :format
+            "must match format: #{options[:format][:with]}"
+          when :inclusion
+            "must be one of: #{options[:inclusion][:in].join(", ")}"
+          when :length
+            length_descriptions(options[:length])
+          when :numericality
+            numericality_descriptions(options[:numericality])
+          when :presence
+            "must be present"
+          end
         end
-      end.compact
+        .compact
     end
 
     def comparison_descriptions(options)
@@ -119,14 +128,10 @@ module Lluminary
         descriptions << "must be other than #{options[:other_than]}"
       end
       if options[:in]
-        descriptions << "must be in: #{options[:in].to_a.join(', ')}"
-      end
-      if options[:odd]
-        descriptions << "must be odd"
-      end
-      if options[:even]
-        descriptions << "must be even"
+        descriptions << "must be in: #{options[:in].to_a.join(", ")}"
       end
+      descriptions << "must be odd" if options[:odd]
+      descriptions << "must be even" if options[:even]
       descriptions.join(", ")
     end
 
@@ -145,4 +150,4 @@ module Lluminary
       end
     end
   end
-end 
+end

data/lib/lluminary/provider_error.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Lluminary
   class ProviderError < StandardError
   end
-end 
+end

data/lib/lluminary/providers/base.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Lluminary
   module Providers
+    # Base class for all LLM providers.
+    # Defines the interface that all providers must implement.
     class Base
       attr_reader :config
 
@@ -12,4 +16,4 @@ module Lluminary
       end
     end
   end
-end 
+end

data/lib/lluminary/providers/bedrock.rb

@@ -1,51 +1,53 @@
-require 'aws-sdk-bedrockruntime'
-require 'json'
-require_relative '../provider_error'
+# frozen_string_literal: true
+require "aws-sdk-bedrockruntime"
+require "json"
+require_relative "../provider_error"
 
-require 'pry-byebug'
+require "pry-byebug"
 
 module Lluminary
   module Providers
+    # Provider for AWS Bedrock models.
+    # Implements the Base provider interface for AWS Bedrock's API.
     class Bedrock < Base
-      DEFAULT_MODEL_ID = 'anthropic.claude-instant-v1'
+      DEFAULT_MODEL_ID = "anthropic.claude-instant-v1"
 
       attr_reader :client, :config
 
       def initialize(**config)
         super
-        @config = config
+        @config = { model_id: DEFAULT_MODEL_ID }.merge(config)
 
-        @client = Aws::BedrockRuntime::Client.new(
-          region: config[:region],
-          credentials: Aws::Credentials.new(
-            config[:access_key_id],
-            config[:secret_access_key]
+        @client =
+          Aws::BedrockRuntime::Client.new(
+            region: config[:region],
+            credentials:
+              Aws::Credentials.new(
+                config[:access_key_id],
+                config[:secret_access_key]
+              )
           )
-        )
       end
 
-      def call(prompt, task)
-        response = @client.converse(
-          model_id: config[:model_id] || DEFAULT_MODEL_ID,
-          messages: [
-            {
-              role: 'user',
-              content: [{text: prompt}]
-            }
-          ]
-        )
+      def call(prompt, _task)
+        response =
+          @client.converse(
+            model_id: config[:model_id],
+            messages: [{ role: "user", content: [{ text: prompt }] }]
+          )
 
         content = response.dig(:output, :message, :content, 0, :text)
-        
-        { 
+
+        {
           raw: content,
-          parsed: begin
-            JSON.parse(content) if content
-          rescue JSON::ParserError
-            nil
-          end
+          parsed:
+            begin
+              JSON.parse(content) if content
+            rescue JSON::ParserError
+              nil
+            end
         }
       end
     end
   end
-end 
+end

data/lib/lluminary/providers/openai.rb

@@ -1,9 +1,12 @@
-require 'openai'
-require 'json'
-require_relative '../provider_error'
+# frozen_string_literal: true
+require "openai"
+require "json"
+require_relative "../provider_error"
 
 module Lluminary
   module Providers
+    # Provider for OpenAI's GPT models.
+    # Implements the Base provider interface for OpenAI's API.
     class OpenAI < Base
       DEFAULT_MODEL = "gpt-3.5-turbo"
 
@@ -11,30 +14,34 @@ module Lluminary
 
       def initialize(**config)
         super
-        @config = config
+        @config = { model: DEFAULT_MODEL }.merge(config)
         @client = ::OpenAI::Client.new(access_token: config[:api_key])
       end
 
-      def call(prompt, task)
-        response = @client.chat(
-          parameters: {
-            model: config[:model] || DEFAULT_MODEL,
-            messages: [{ role: "user", content: prompt }],
-            response_format: { type: "json_object" }
-          }
-        )
+      def call(prompt, _task)
+        response =
+          @client.chat(
+            parameters: {
+              model: config[:model],
+              messages: [{ role: "user", content: prompt }],
+              response_format: {
+                type: "json_object"
+              }
+            }
+          )
 
-        content = response.dig('choices', 0, 'message', 'content')
-        
-        { 
+        content = response.dig("choices", 0, "message", "content")
+
+        {
           raw: content,
-          parsed: begin
-            JSON.parse(content) if content
-          rescue JSON::ParserError
-            nil
-          end
+          parsed:
+            begin
+              JSON.parse(content) if content
+            rescue JSON::ParserError
+              nil
+            end
         }
       end
     end
   end
-end 
+end

data/lib/lluminary/providers/test.rb

@@ -1,25 +1,20 @@
+# frozen_string_literal: true
+
 module Lluminary
   module Providers
+    # Test provider for development and testing.
+    # Returns predefined responses for testing purposes.
     class Test < Base
-      def initialize(**config)
-        super
-      end
-
-      def call(prompt, task)
+      def call(_prompt, task)
         response = generate_response(task.class.output_fields)
-        raw_response = JSON.pretty_generate(response).gsub(/\n\s*/, '')
-        {
-          raw: raw_response,
-          parsed: JSON.parse(raw_response)
-        }
+        raw_response = JSON.pretty_generate(response).gsub(/\n\s*/, "")
+        { raw: raw_response, parsed: JSON.parse(raw_response) }
       end
 
       private
 
       def generate_response(fields)
-        fields.each_with_object({}) do |(name, field), hash|
-          hash[name] = generate_value(field[:type])
-        end
+        fields.transform_values { |field| generate_value(field[:type]) }
       end
 
       def generate_value(type)
@@ -34,4 +29,4 @@ module Lluminary
       end
     end
   end
-end 
+end

data/lib/lluminary/result.rb

@@ -1,6 +1,9 @@
-require 'ostruct'
+# frozen_string_literal: true
+require "ostruct"
 
 module Lluminary
+  # Represents the result of a task execution.
+  # Contains the output data and any metadata about the execution.
   class Result
     attr_reader :raw_response, :output, :prompt
 
@@ -10,4 +13,4 @@ module Lluminary
       @prompt = prompt
     end
   end
-end 
+end

data/lib/lluminary/schema.rb

@@ -1,13 +1,10 @@
-require 'active_model'
-require_relative 'schema_model'
+# frozen_string_literal: true
+require "active_model"
+require_relative "schema_model"
 
 module Lluminary
-  class JsonValidator < ActiveModel::EachValidator
-    def validate_each(record, attribute, value)
-      record.errors.add(:base, "Response must be valid JSON") unless value.is_a?(Hash)
-    end
-  end
-
+  # Represents a JSON schema for validating task inputs and outputs.
+  # Provides methods for defining and validating schemas.
   class Schema
     def initialize
       @fields = {}
@@ -34,9 +31,7 @@ module Lluminary
       @fields[name] = { type: :datetime, description: description }
     end
 
-    def fields
-      @fields
-    end
+    attr_reader :fields
 
     def validates(*args, **options)
       @validations << [args, options]
@@ -47,10 +42,8 @@ module Lluminary
     end
 
     def schema_model
-      @schema_model ||= SchemaModel.build(
-        fields: @fields,
-        validations: @validations
-      )
+      @schema_model ||=
+        SchemaModel.build(fields: @fields, validations: @validations)
     end
 
     def validate(values)
@@ -58,4 +51,4 @@ module Lluminary
       instance.valid? ? [] : instance.errors.full_messages
     end
   end
-end 
+end

data/lib/lluminary/schema_model.rb

@@ -1,6 +1,9 @@
-require 'active_model'
+# frozen_string_literal: true
+require "active_model"
 
 module Lluminary
+  # Base class for models that use JSON schema validation.
+  # Provides ActiveModel integration and schema validation.
   class SchemaModel
     include ActiveModel::Validations
 
@@ -12,7 +15,7 @@ module Lluminary
 
     def to_s
       attrs = attributes.dup
-      attrs.delete('raw_response')
+      attrs.delete("raw_response")
       "#<#{self.class.name} #{attrs.inspect}>"
     end
 
@@ -25,8 +28,10 @@ module Lluminary
         end
 
         # Add raw_response field and validation
-        define_method(:raw_response) { @attributes['raw_response'] }
-        define_method(:raw_response=) { |value| @attributes['raw_response'] = value }
+        define_method(:raw_response) { @attributes["raw_response"] }
+        define_method(:raw_response=) do |value|
+          @attributes["raw_response"] = value
+        end
 
         validate do |record|
           if record.raw_response
@@ -41,7 +46,7 @@ module Lluminary
         # Add type validations
         validate do |record|
           record.attributes.each do |name, value|
-            next if name == 'raw_response'
+            next if name == "raw_response"
             next if value.nil?
 
             field = fields[name.to_sym]
@@ -57,7 +62,7 @@ module Lluminary
                 record.errors.add(name, "must be an Integer")
               end
             when :boolean
-              unless value == true || value == false
+              unless [true, false].include?(value)
                 record.errors.add(name, "must be true or false")
               end
             when :float
@@ -73,9 +78,7 @@ module Lluminary
         end
 
         # Add ActiveModel validations
-        validations.each do |args, options|
-          validates(*args, **options)
-        end
+        validations.each { |args, options| validates(*args, **options) }
 
         # Set model name for error messages
         define_singleton_method(:model_name) do
@@ -84,4 +87,4 @@ module Lluminary
       end
     end
   end
-end 
+end