lluminary 0.1.0 → 0.1.2

data/lib/lluminary/task.rb

@@ -1,10 +1,20 @@
-require 'ostruct'
-require_relative 'schema'
-require_relative 'validation_error'
-require_relative 'field_description'
-require 'json'
+# frozen_string_literal: true
+require "ostruct"
+require_relative "schema"
+require_relative "validation_error"
+require_relative "field_description"
+require "json"
 
 module Lluminary
+  # Base class for all Lluminary tasks.
+  # Provides the core functionality for defining and running LLM-powered tasks.
+  #
+  # @example Creating a custom task
+  #   class MyTask < Lluminary::Task
+  #     def run
+  #       # Task implementation
+  #     end
+  #   end
   class Task
     class << self
       def input_schema(&block)
@@ -18,19 +28,20 @@ module Lluminary
       end
 
       def use_provider(provider_name, **config)
-        provider_class = case provider_name
-        when :openai
-          require_relative 'providers/openai'
-          Providers::OpenAI
-        when :test
-          require_relative 'providers/test'
-          Providers::Test
-        when :bedrock
-          require_relative 'providers/bedrock'
-          Providers::Bedrock
-        else
-          raise ArgumentError, "Unknown provider: #{provider_name}"
-        end
+        provider_class =
+          case provider_name
+          when :openai
+            require_relative "providers/openai"
+            Providers::OpenAI
+          when :test
+            require_relative "providers/test"
+            Providers::Test
+          when :bedrock
+            require_relative "providers/bedrock"
+            Providers::Bedrock
+          else
+            raise ArgumentError, "Unknown provider: #{provider_name}"
+          end
 
         # Merge global config with task-specific config
         global_config = Lluminary.config.provider_config(provider_name)
@@ -48,15 +59,14 @@ module Lluminary
       end
 
       def provider
-        @provider ||= begin
-          require_relative 'providers/test'
-          Providers::Test.new
-        end
+        @provider ||=
+          begin
+            require_relative "providers/test"
+            Providers::Test.new
+          end
       end
 
-      def provider=(provider)
-        @provider = provider
-      end
+      attr_writer :provider
 
       def input_fields
         @input_schema&.fields || {}
@@ -98,7 +108,7 @@ module Lluminary
       validate_input!
       response = self.class.provider.call(prompt, self)
       process_response(response)
-      
+
       self
     end
 
@@ -107,13 +117,12 @@ module Lluminary
     end
 
     def validate_input!
-      unless @input.valid?
-        raise ValidationError, @input.errors.full_messages.join(", ")
-      end
+      return if @input.valid?
+      raise ValidationError, @input.errors.full_messages.join(", ")
     end
 
     def prompt
-      base_prompt = <<~PROMPT
+      <<~PROMPT
         #{task_prompt}
 
         #{json_schema_example}
@@ -134,23 +143,32 @@ module Lluminary
       # Merge the parsed response first, then validate
       if @parsed_response.is_a?(Hash)
         # Get datetime fields from schema
-        datetime_fields = self.class.output_fields.select { |_, field| field[:type] == :datetime }.keys
+        datetime_fields =
+          self
+            .class
+            .output_fields
+            .select { |_, field| field[:type] == :datetime }
+            .keys
 
         # Convert datetime fields
         converted_response = @parsed_response.dup
         datetime_fields.each do |field_name|
-          if converted_response.key?(field_name.to_s) && converted_response[field_name.to_s].is_a?(String)
-            begin
-              converted_response[field_name.to_s] = DateTime.parse(converted_response[field_name.to_s])
-            rescue ArgumentError
-              # Leave as string, validation will fail
-            end
+          unless converted_response.key?(field_name.to_s) &&
+                   converted_response[field_name.to_s].is_a?(String)
+            next
+          end
+          begin
+            converted_response[field_name.to_s] = DateTime.parse(
+              converted_response[field_name.to_s]
+            )
+          rescue ArgumentError
+            # Leave as string, validation will fail
           end
         end
 
         @output.attributes.merge!(converted_response)
       end
-      
+
       # Validate after merging
       @output.valid?
 
@@ -186,29 +204,36 @@ module Lluminary
     end
 
     def generate_field_descriptions
-      fields.map do |name, field|
-        # Get validations for this field
-        validations = self.class.instance_variable_get(:@output_schema)&.validations_for(name) || []
-        field_with_validations = field.merge(validations: validations)
-        FieldDescription.new(name, field_with_validations).to_schema_s
-      end.join("\n\n")
+      fields
+        .map do |name, field|
+          # Get validations for this field
+          validations =
+            self
+              .class
+              .instance_variable_get(:@output_schema)
+              &.validations_for(name) || []
+          field_with_validations = field.merge(validations: validations)
+          FieldDescription.new(name, field_with_validations).to_schema_s
+        end
+        .join("\n\n")
     end
 
     def example_json
-      json = fields.each_with_object({}) do |(name, field), hash|
-        hash[name] = case field[:type]
-                    when :string
-                      "your #{name} here"
-                    when :integer
-                      0
-                    when :datetime
-                      "2024-01-01T12:00:00+00:00"
-                    when :boolean
-                      true
-                    when :float
-                      0.0
-                    end
-      end
+      json =
+        fields.each_with_object({}) do |(name, field), hash|
+          hash[name] = case field[:type]
+          when :string
+            "your #{name} here"
+          when :integer
+            0
+          when :datetime
+            "2024-01-01T12:00:00+00:00"
+          when :boolean
+            true
+          when :float
+            0.0
+          end
+        end
 
       JSON.pretty_generate(json)
     end
@@ -221,4 +246,4 @@ module Lluminary
       )
     end
   end
-end
+end

data/lib/lluminary/validation_error.rb

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

data/lib/lluminary/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Lluminary
-  VERSION = '0.1.0'
-end 
+  VERSION = "0.1.0"
+end

data/lib/lluminary.rb

@@ -1,10 +1,22 @@
-require_relative 'lluminary/version'
-require_relative 'lluminary/result'
-require_relative 'lluminary/task'
-require_relative 'lluminary/providers/base'
-require_relative 'lluminary/providers/openai'
-require_relative 'lluminary/config'
+# frozen_string_literal: true
 
+require_relative "lluminary/version"
+require_relative "lluminary/result"
+require_relative "lluminary/task"
+require_relative "lluminary/providers/base"
+require_relative "lluminary/providers/openai"
+require_relative "lluminary/config"
+
+# Lluminary is a framework for building and running LLM-powered tasks.
+# It provides a structured way to define tasks, their inputs and outputs,
+# and handles the interaction with various LLM providers.
+#
+# @example Creating a simple task
+#   class MyTask < Lluminary::Task
+#     def run
+#       # Task implementation
+#     end
+#   end
 module Lluminary
   class << self
     def config
@@ -14,5 +26,9 @@ module Lluminary
     def configure
       yield config
     end
+
+    def reset_configuration
+      @config = Config.new
+    end
   end
-end 
+end

data/spec/examples/analyze_text_spec.rb

@@ -1,8 +1,11 @@
-require 'spec_helper'
-require_relative '../../examples/analyze_text'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/analyze_text"
 
 RSpec.describe AnalyzeText do
-  let(:text) { "Ruby is a dynamic, open source programming language with a focus on simplicity and productivity. It has an elegant syntax that is natural to read and easy to write." }
+  let(:text) { <<~TEXT }
+      Ruby is a dynamic, open source programming language with a focus on simplicity and productivity. It has an elegant syntax that is natural to read and easy to write.
+    TEXT
 
   it "analyzes text" do
     result = described_class.call(text: text)
@@ -18,4 +21,4 @@ RSpec.describe AnalyzeText do
     expect(json).to have_key("analysis")
     expect(json["analysis"]).to eq(result.output.analysis)
   end
-end 
+end

data/spec/examples/color_analyzer_spec.rb

@@ -1,42 +1,42 @@
-require 'spec_helper'
-require_relative '../../examples/color_analyzer'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/color_analyzer"
 
 RSpec.describe ColorAnalyzer do
-  describe '#call' do
+  describe "#call" do
     it 'returns "red" for a description strongly suggesting the color red' do
-      result = described_class.call(
-        image_description: "A bright red sports car parked in front of a red brick building at sunset. The car's glossy red paint reflects the warm light, making it appear even more vibrant. A red stop sign stands nearby, and red roses bloom in a garden beside the building."
-      )
+      result = described_class.call(image_description: <<~DESCRIPTION)
+              A bright red sports car parked in front of a red brick building at sunset. The car's glossy red paint reflects the warm light, making it appear even more vibrant. A red stop sign stands nearby, and red roses bloom in a garden beside the building.
+            DESCRIPTION
 
       expect(result.output.color_name).to eq("red")
       expect(result.output.valid?).to be true
     end
 
-    it 'returns invalid output when description strongly suggests orange' do
+    it "returns invalid output when description strongly suggests orange" do
       # This should fail validation because "orange" is not a CSS Level 1 color
-      result = described_class.call(
-        image_description: "A field of ripe oranges under a bright orange sunset. The fruit glows with a warm orange hue, and the sky is painted in shades of orange and gold. Orange butterflies flutter among the trees, and orange flowers bloom throughout the scene."
-      )
+      result = described_class.call(image_description: <<~DESCRIPTION)
+              A field of ripe oranges under a bright orange sunset. The fruit glows with a warm orange hue, and the sky is painted in shades of orange and gold. Orange butterflies flutter among the trees, and orange flowers bloom throughout the scene.
+            DESCRIPTION
 
       expect(result.output.valid?).to be false
-      expect(result.output.errors.full_messages).to include("Color name must be a valid CSS level 1 color name")
+      expect(result.output.errors.full_messages).to include(
+        "Color name must be a valid CSS level 1 color name"
+      )
     end
 
-    it 'validates presence of image_description' do
-      expect {
-        described_class.call!(
-          image_description: ""
-        )
-      }.to raise_error(Lluminary::ValidationError)
+    it "validates presence of image_description" do
+      expect { described_class.call!(image_description: "") }.to raise_error(
+        Lluminary::ValidationError
+      )
     end
 
-    it 'validates that color_name is lowercase' do
-      result = described_class.call(
-        image_description: "A bright red sports car"
-      )
+    it "validates that color_name is lowercase" do
+      result =
+        described_class.call(image_description: "A bright red sports car")
 
       expect(result.output.valid?).to be true
       expect(result.output.color_name).to eq(result.output.color_name.downcase)
     end
   end
-end 
+end

data/spec/examples/content_analyzer_spec.rb

@@ -1,75 +1,58 @@
-require 'spec_helper'
-require_relative '../../examples/content_analyzer'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/content_analyzer"
 
 RSpec.describe ContentAnalyzer do
-  let(:technical_text) do
-    <<~TEXT
+  let(:technical_text) { <<~TEXT }
       The revolutionary new quantum processor leverages advanced photonic circuits to achieve unprecedented computational speeds. 
       By utilizing entangled photon pairs, it can perform complex calculations in parallel, significantly reducing processing time.
       This breakthrough technology represents a major advancement in quantum computing.
     TEXT
-  end
 
-  let(:emotional_text) do
-    <<~TEXT
+  let(:emotional_text) { <<~TEXT }
       I can't believe how amazing this experience was! My heart was racing with excitement as I watched the performance. 
       The raw emotion and passion in every movement brought tears to my eyes. It was truly a transformative moment that I'll never forget.
     TEXT
-  end
 
-  describe '#call' do
-    it 'correctly identifies technical content' do
-      result = described_class.call(
-        text: technical_text,
-        content_type: "technical"
-      )
+  describe "#call" do
+    it "correctly identifies technical content" do
+      result =
+        described_class.call(text: technical_text, content_type: "technical")
 
       expect(result.output.contains_type).to be true
     end
 
-    it 'correctly identifies non-technical content' do
-      result = described_class.call(
-        text: emotional_text,
-        content_type: "technical"
-      )
+    it "correctly identifies non-technical content" do
+      result =
+        described_class.call(text: emotional_text, content_type: "technical")
 
       expect(result.output.contains_type).to be false
     end
 
-    it 'correctly identifies emotional content' do
-      result = described_class.call(
-        text: emotional_text,
-        content_type: "emotional"
-      )
+    it "correctly identifies emotional content" do
+      result =
+        described_class.call(text: emotional_text, content_type: "emotional")
 
       expect(result.output.contains_type).to be true
     end
 
-    it 'correctly identifies non-emotional content' do
-      result = described_class.call(
-        text: technical_text,
-        content_type: "emotional"
-      )
+    it "correctly identifies non-emotional content" do
+      result =
+        described_class.call(text: technical_text, content_type: "emotional")
 
       expect(result.output.contains_type).to be false
     end
 
-    it 'validates presence of text' do
-      expect {
-        described_class.call!(
-          text: "",
-          content_type: "technical"
-        )
-      }.to raise_error(Lluminary::ValidationError)
+    it "validates presence of text" do
+      expect do
+        described_class.call!(text: "", content_type: "technical")
+      end.to raise_error(Lluminary::ValidationError)
     end
 
-    it 'validates presence of content_type' do
-      expect {
-        described_class.call!(
-          text: technical_text,
-          content_type: ""
-        )
-      }.to raise_error(Lluminary::ValidationError)
+    it "validates presence of content_type" do
+      expect do
+        described_class.call!(text: technical_text, content_type: "")
+      end.to raise_error(Lluminary::ValidationError)
     end
   end
-end 
+end

data/spec/examples/historical_event_analyzer_spec.rb

@@ -1,14 +1,16 @@
-require 'spec_helper'
-require_relative '../../examples/historical_event_analyzer'
-require 'pry-byebug'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/historical_event_analyzer"
+require "pry-byebug"
 
 RSpec.describe HistoricalEventAnalyzer do
-  describe '#call' do
-    context 'with events that have known exact times' do
-      it 'returns the exact time of the human step on the moon' do
-        result = described_class.call(
-          event_description: "Neil Armstrong's first step onto the Moon"
-        )
+  describe "#call" do
+    context "with events that have known exact times" do
+      it "returns the exact time of the human step on the moon" do
+        result =
+          described_class.call(
+            event_description: "Neil Armstrong's first step onto the Moon"
+          )
 
         expect(result.output.valid?).to be true
         expect(result.output.event_datetime).to be_a(DateTime)
@@ -19,11 +21,12 @@ RSpec.describe HistoricalEventAnalyzer do
       end
     end
 
-    context 'with events that have approximate times' do
-      it 'returns midnight for the fall of the Roman Empire' do
-        result = described_class.call(
-          event_description: "Assassination of Julius Caesar"
-        )
+    context "with events that have approximate times" do
+      it "returns midnight for the fall of the Roman Empire" do
+        result =
+          described_class.call(
+            event_description: "Assassination of Julius Caesar"
+          )
 
         expect(result.output.valid?).to be true
         expect(result.output.event_datetime).to be_a(DateTime)
@@ -34,4 +37,4 @@ RSpec.describe HistoricalEventAnalyzer do
       end
     end
   end
-end 
+end

data/spec/examples/price_analyzer_spec.rb

@@ -1,46 +1,40 @@
-require 'spec_helper'
-require_relative '../../examples/price_analyzer'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/price_analyzer"
 
 RSpec.describe PriceAnalyzer do
-  describe '#call' do
-    it 'returns a competitiveness score between 0.0 and 1.0 for a high-priced item' do
-      result = described_class.call(
-        product_name: "Entry LevelLuxury Watch",
-        price: 999.99
-      )
+  describe "#call" do
+    it "returns a competitiveness score between 0.0 and 1.0 for a high-priced item" do
+      result =
+        described_class.call(
+          product_name: "Entry LevelLuxury Watch",
+          price: 999.99
+        )
 
       expect(result.output.competitiveness_score).to be_a(Float)
       expect(result.output.competitiveness_score).to be_between(0.0, 1.0)
       expect(result.output.competitiveness_score).to be >= 0.5 # Lower priced luxury watch is more competitive
     end
 
-    it 'returns a higher competitiveness score for a reasonably priced item' do
-      result = described_class.call(
-        product_name: "Basic Watch",
-        price: 10049.99
-      )
+    it "returns a higher competitiveness score for a reasonably priced item" do
+      result =
+        described_class.call(product_name: "Basic Watch", price: 10_049.99)
 
       expect(result.output.competitiveness_score).to be_a(Float)
       expect(result.output.competitiveness_score).to be_between(0.0, 1.0)
       expect(result.output.competitiveness_score).to be <= 0.5 # Higher priced basic watch is less competitive
     end
 
-    it 'validates presence of product_name' do
-      expect {
-        described_class.call!(
-          product_name: "",
-          price: 49.99
-        )
-      }.to raise_error(Lluminary::ValidationError)
+    it "validates presence of product_name" do
+      expect do
+        described_class.call!(product_name: "", price: 49.99)
+      end.to raise_error(Lluminary::ValidationError)
     end
 
-    it 'validates presence of price' do
-      expect {
-        described_class.call!(
-          product_name: "Basic Watch",
-          price: nil
-        )
-      }.to raise_error(Lluminary::ValidationError)
+    it "validates presence of price" do
+      expect do
+        described_class.call!(product_name: "Basic Watch", price: nil)
+      end.to raise_error(Lluminary::ValidationError)
     end
   end
-end 
+end

data/spec/examples/quote_task_spec.rb

@@ -1,27 +1,28 @@
-require 'spec_helper'
-require_relative '../../examples/quote_task'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/quote_task"
 
 RSpec.describe QuoteTask do
-  describe '.call' do
-    it 'returns a quote and its author' do
+  describe ".call" do
+    it "returns a quote and its author" do
       result = described_class.call
 
       expect(result.output.quote).to be_a(String)
       expect(result.output.quote).not_to be_empty
-      
+
       expect(result.output.author).to be_a(String)
       expect(result.output.author).not_to be_empty
     end
 
-    it 'can be called without any input parameters' do
+    it "can be called without any input parameters" do
       expect { described_class.call }.not_to raise_error
     end
 
-    it 'returns a valid result object' do
+    it "returns a valid result object" do
       result = described_class.call
       expect(result).to be_a(Lluminary::Task)
       expect(result.input).to be_a(Lluminary::SchemaModel)
       expect(result.input.valid?).to be true
     end
   end
-end 
+end

data/spec/examples/sentiment_analysis_spec.rb

@@ -1,13 +1,14 @@
-require 'spec_helper'
-require_relative '../../examples/sentiment_analysis'
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../../examples/sentiment_analysis"
 
 RSpec.describe SentimentAnalysis do
   let(:text) { "I absolutely love this new feature!" }
 
-  describe '.call' do
-    it 'analyzes sentiment of given text' do
+  describe ".call" do
+    it "analyzes sentiment of given text" do
       result = described_class.call(text: text)
-      
+
       expect(result.output.sentiment).to be_a(String)
       expect(result.output.sentiment).not_to be_empty
       expect(result.output.explanation).to be_a(String)
@@ -16,7 +17,7 @@ RSpec.describe SentimentAnalysis do
       expect(result.output.confidence).to be_between(0, 100)
     end
 
-    it 'returns valid JSON response' do
+    it "returns valid JSON response" do
       result = described_class.call(text: text)
       expect(result.output.raw_response).to be_a(String)
       expect { JSON.parse(result.output.raw_response) }.not_to raise_error
@@ -29,17 +30,19 @@ RSpec.describe SentimentAnalysis do
       expect(json["confidence"]).to eq(result.output.confidence)
     end
 
-    it 'requires text input' do
+    it "requires text input" do
       result = described_class.call({})
       expect(result.valid?).to be false
-      expect(result.input.errors.full_messages).to include("Text can't be blank")
+      expect(result.input.errors.full_messages).to include(
+        "Text can't be blank"
+      )
     end
 
-    it 'returns a valid result object' do
+    it "returns a valid result object" do
       result = described_class.call(text: text)
       expect(result).to be_a(Lluminary::Task)
       expect(result.input).to be_a(Lluminary::SchemaModel)
       expect(result.input.valid?).to be true
     end
   end
-end 
+end