ruby_llm-schema 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4706281dcd180f4d6e2b385cc42b79d73629d8eb8a7b5723ddde3b2786a5022e
-  data.tar.gz: eb083d6fa029a0b107f7a728c86e9f8342a1b9d0c3d0a46d8d4d33adaacd756a
+  metadata.gz: 5965c9d64040358651a74d313d1bd50010378ca33b20ec46a26db8fb006e4e25
+  data.tar.gz: a4d9ac3040a6ce33fe0bbc4294166c00e8cafb5e87dcb336d47e1541b504dc12
 SHA512:
-  metadata.gz: bc52ea4b47664561909278ece104676ae5053572aa791fe6985deb1ecdf40421e49b3b02529ba2a02cbb1df068484d6d162ec0d4c8d525105111ced98451fcbf
-  data.tar.gz: df555cdab1fb1c786ee0425fb5a1c0dd61bd5ed6c35dfc53bb355cdad27b462c5dbd84cb5d8fb32db6fdbe2c364916f0c8d2ed32565bff87c8ca17b79915ee03
+  metadata.gz: d6ce13ba9d6164a794004fe1138f92ab8d141348d86b33163ad23c119425f252f57b585853ab73a21cff102de9cc403f8936f7b63d4b52d4a572795d8a340aad
+  data.tar.gz: 4edbb7d38e7fa1414a812d0fa87f6f20b24e19d2ceb1a151e476c1b330d2e6ac84cfc7faf4aa388858d322bbdaeccffcaa5002db4d19e5a68d5e263876b3db0f

data/README.md

@@ -1,5 +1,9 @@
 # RubyLLM::Schema
 
+[![Gem Version](https://badge.fury.io/rb/ruby_llm-schema.svg)](https://rubygems.org/gems/ruby_llm-schema)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/danielfriis/ruby_llm-schema/blob/main/LICENSE.txt)
+[![CI](https://github.com/danielfriis/ruby_llm-schema/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/danielfriis/ruby_llm-schema/actions/workflows/ci.yml)
+
 A Ruby DSL for creating JSON schemas with a clean, Rails-inspired API. Perfect for defining structured data schemas for LLM function calling or structured outputs.
 
 ## Use Cases
@@ -267,9 +271,14 @@ class MySchema < RubyLLM::Schema
     string :longitude
   end
   
+  # Using a reference in an array
   array :coordinates, of: :location
-  
-  object :home_location do
+
+  # Using a reference in an object via the `reference` option
+  object :home_location, reference: :location
+
+  # Using a reference in an object via block
+  object :user do
     reference :location
   end
 end

data/lib/ruby_llm/schema/dsl.rb

@@ -41,8 +41,8 @@ module RubyLLM
       end
 
       # Complex type methods
-      def object(name = nil, description: nil, required: true, &block)
-        add_property(name, build_property_schema(:object, description: description, &block), required: required)
+      def object(name = nil, reference: nil, description: nil, required: true, &block)
+        add_property(name, build_property_schema(:object, description: description, reference: reference, &block), required: required)
       end
 
       def array(name, of: nil, description: nil, required: true, min_items: nil, max_items: nil, &block)
@@ -81,7 +81,8 @@ module RubyLLM
         definitions[name] = {
           type: "object",
           properties: sub_schema.properties,
-          required: sub_schema.required_properties
+          required: sub_schema.required_properties,
+          additionalProperties: sub_schema.additional_properties
         }
       end
 
@@ -123,16 +124,26 @@ module RubyLLM
         when :null
           {type: "null", description: options[:description]}.compact
         when :object
+          # If the reference option is provided, return the reference
+          return reference(options[:reference]) if options[:reference]
+
           sub_schema = Class.new(Schema)
-          sub_schema.class_eval(&)
 
-          {
-            type: "object",
-            properties: sub_schema.properties,
-            required: sub_schema.required_properties,
-            additionalProperties: additional_properties,
-            description: options[:description]
-          }.compact
+          # Evaluate the block and capture the result
+          result = sub_schema.class_eval(&)
+
+          # If the block returned a reference and no properties were added, use the reference
+          if result.is_a?(Hash) && result["$ref"] && sub_schema.properties.empty?
+            result.merge(options[:description] ? {description: options[:description]} : {})
+          else
+            {
+              type: "object",
+              properties: sub_schema.properties,
+              required: sub_schema.required_properties,
+              additionalProperties: sub_schema.additional_properties,
+              description: options[:description]
+            }.compact
+          end
         when :any_of
           schemas = collect_property_schemas_from_block(&)
           {

data/lib/ruby_llm/schema/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLlm
   class Schema
-    VERSION = "0.1.7"
+    VERSION = "0.1.9"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-schema
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Daniel Friis