ruby_llm-schema 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 224352dd84018a682d0d2ccaa116bd203dfd026b2f139a6d539133b488d5c6c0
-  data.tar.gz: 64ebb57d1efdde8341acef3dcb3bdb817ed0b9c2186fea3aa8e0b36779dbfd6d
+  metadata.gz: fceccc2292efb7c17ce5457a08d6a18ddc3debd920052a1d8e368d74e450547e
+  data.tar.gz: b16fafc541af3b9f1a1e3a96f81be21175a380606f2e40325afa29d76108daea
 SHA512:
-  metadata.gz: d49388efee637cfc97ef27b4c4924cd997a5dd5976f2a7cd90b3b6d373d6305a109ae7340aa072843dc81187b1378a290f84d6e7d179197e0e02a5d65bf0691b
-  data.tar.gz: 80990f6709a2fdb77ab207c664f71f525dacf01242fcc469aa0f427926e7be60390b0f6da221a2588045a71502a814bb0982baea3d4d54513662b66213b8f461
+  metadata.gz: 984b11c9fcfcaf68f0892a9a7b9c10064436aa59279f0a0992ebae5c6d20fbcfd1e6afbef8376bf7a9239aaaea246dd9f8c7f6a3d9521509789c8e334e3e0363
+  data.tar.gz: e9658cff5e3e1f0912eab47fe8438a5dfd5bf52928dd0198ff39131ecf1aeb5d3b2a8e08344feab0b363ed6a9a27747c1489fcfadefd8f30af4d03c77fb601d8

data/README.md

@@ -1,21 +1,24 @@
 # 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)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/crmne/ruby_llm-schema/blob/main/LICENSE)
+[![CI](https://github.com/crmne/ruby_llm-schema/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/crmne/ruby_llm-schema/actions/workflows/main.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.
+A Ruby DSL for creating JSON schemas with a clean, Rails-inspired API.
+
+Originally created by [Daniel Friis](https://github.com/danielfriis).
 
 ## Use Cases
 
-Structured output is a powerful tool for LLMs to generate consistent and predictable responses.
+JSON Schema is useful wherever Ruby code needs to describe structured data in a portable format.
 
 Some ideal use cases:
 
-- Extracting *metadata, topics, and summary* from articles or blog posts
-- Organizing unstructured feedback or reviews with *sentiment and summary* 
-- Defining structured *actions* from user messages or emails
-- Extracting *entities and relationships* from documents
+- Defining API request and response shapes
+- Describing configuration files or structured payloads
+- Sharing validation contracts across systems
+- Generating structured output schemas for LLM workflows
+- Defining structured parameters for RubyLLM tools
 
 ### Simple Example
 
@@ -24,22 +27,22 @@ class PersonSchema < RubyLLM::Schema
   string :name, description: "Person's full name"
   number :age, description: "Age in years", minimum: 0, maximum: 120
   boolean :active, required: false
-  
+
   object :address do
     string :street
     string :city
     string :country, required: false
   end
-  
+
   array :tags, of: :string, description: "User tags"
-  
+
   array :contacts do
     object do
       string :email, format: "email"
       string :phone, required: false
     end
   end
-  
+
   any_of :status do
     string enum: ["active", "pending", "inactive"]
     null
@@ -51,6 +54,62 @@ schema = PersonSchema.new
 puts schema.to_json
 ```
 
+### RubyLLM structured output
+
+```ruby
+class PersonSchema < RubyLLM::Schema
+  string :name, description: "Person's full name"
+  integer :age, description: "Person's age in years"
+  string :city, required: false, description: "City where they live"
+end
+
+# Use it natively with RubyLLM
+chat     = RubyLLM.chat
+response = chat.with_schema(PersonSchema)
+               .ask("Generate a person named Alice who is 30 years old and lives in New York")
+
+# The response is automatically parsed from JSON
+puts response.content # => {"name" => "Alice", "age" => 30}
+puts response.content.class # => Hash
+```
+
+### RubyLLM tools
+
+RubyLLM tools can use schema classes for structured parameters. This is useful when the same argument shape is shared across tools or elsewhere in your app.
+
+```ruby
+class SearchParams < RubyLLM::Schema
+  string :query, description: "Search query"
+  integer :limit, required: false, description: "Maximum results"
+end
+
+class SearchDocuments < RubyLLM::Tool
+  desc "Searches internal documents"
+  params SearchParams
+
+  def execute(query:, limit: 10)
+    DocumentSearch.call(query:, limit:)
+  end
+end
+```
+
+For tool-specific parameters, define the schema inline with `params do ... end`.
+
+```ruby
+class Weather < RubyLLM::Tool
+  desc "Gets current weather"
+
+  params do
+    string :city, description: "City name"
+    string :units, enum: %w[celsius fahrenheit], required: false
+  end
+
+  def execute(city:, units: "celsius")
+    WeatherAPI.current(city:, units:)
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -82,12 +141,12 @@ class PersonSchema < RubyLLM::Schema
   string :name, description: "Person's full name"
   number :age
   boolean :active, required: false
-  
+
   object :address do
     string :street
     string :city
   end
-  
+
   array :tags, of: :string
 end
 
@@ -102,12 +161,12 @@ PersonSchema = RubyLLM::Schema.create do
   string :name, description: "Person's full name"
   number :age
   boolean :active, required: false
-  
+
   object :address do
     string :street
     string :city
   end
-  
+
   array :tags, of: :string
 end
 
@@ -125,12 +184,12 @@ person_schema = schema "PersonData", description: "A person object" do
   string :name, description: "Person's full name"
   number :age
   boolean :active, required: false
-  
+
   object :address do
     string :street
     string :city
   end
-  
+
   array :tags, of: :string
 end
 
@@ -250,7 +309,7 @@ Union types are a way to specify that a property can be one of several types.
 ```ruby
 any_of :value do
   string
-  number  
+  number
   null
 end
 
@@ -270,7 +329,7 @@ class MySchema < RubyLLM::Schema
     string :latitude
     string :longitude
   end
-  
+
   # Using a reference in an array
   array :coordinates, of: :location
 
@@ -305,7 +364,7 @@ class CompanySchema < RubyLLM::Schema
   # Using 'of' parameter
   object :ceo, of: PersonSchema
   array :employees, of: PersonSchema
-  
+
   # Using Schema.new in block
   object :founder do
     PersonSchema.new

data/lib/ruby_llm/schema/dsl/schema_builders.rb

@@ -118,21 +118,19 @@ module RubyLLM
 
         def determine_object_reference(of, description = nil)
           result = case of
-          when Symbol
-            reference(of)
-          when Class
-            if schema_class?(of)
-              schema_class_to_inline_schema(of)
-            else
-              raise InvalidObjectTypeError, "Invalid object type: #{of.inspect}. Class must inherit from RubyLLM::Schema."
-            end
-          else
-            if schema_class?(of)
-              schema_class_to_inline_schema(of)
-            else
-              raise InvalidObjectTypeError, "Invalid object type: #{of.inspect}. Must be a symbol reference, a Schema class, or a Schema instance."
-            end
-          end
+                   when Symbol
+                     reference(of)
+                   when Class
+                     raise InvalidObjectTypeError, "Invalid object type: #{of.inspect}. Class must inherit from RubyLLM::Schema." unless schema_class?(of)
+
+                     schema_class_to_inline_schema(of)
+
+                   else
+                     raise InvalidObjectTypeError, "Invalid object type: #{of.inspect}. Must be a symbol reference, a Schema class, or a Schema instance." unless schema_class?(of)
+
+                     schema_class_to_inline_schema(of)
+
+                   end
 
           description ? result.merge(description: description) : result
         end
@@ -147,7 +145,7 @@ module RubyLLM
           schema_builder.methods.grep(/_schema$/).each do |schema_method|
             type_name = schema_method.to_s.sub(/_schema$/, "")
 
-            context.define_singleton_method(type_name) do |name = nil, **options, &blk|
+            context.define_singleton_method(type_name) do |_name = nil, **options, &blk|
               schemas << schema_builder.send(schema_method, **options, &blk)
             end
           end
@@ -164,10 +162,10 @@ module RubyLLM
         def schema_class_to_inline_schema(schema_class_or_instance)
           # Handle both Schema classes and Schema instances
           schema_class = if schema_class_or_instance.is_a?(Class)
-            schema_class_or_instance
-          else
-            schema_class_or_instance.class
-          end
+                           schema_class_or_instance
+                         else
+                           schema_class_or_instance.class
+                         end
 
           # Directly convert schema class to inline object schema
           {
@@ -178,10 +176,10 @@ module RubyLLM
           }.tap do |schema|
             # For instances, prefer instance description over class description
             description = if schema_class_or_instance.is_a?(Class)
-              schema_class.description
-            else
-              schema_class_or_instance.instance_variable_get(:@description) || schema_class.description
-            end
+                            schema_class.description
+                          else
+                            schema_class_or_instance.instance_variable_get(:@description) || schema_class.description
+                          end
             schema[:description] = description if description
           end
         end

data/lib/ruby_llm/schema/dsl/utilities.rb

@@ -28,8 +28,16 @@ module RubyLLM
         private
 
         def add_property(name, definition, required:)
-          properties[name.to_sym] = definition
-          required_properties << name.to_sym if required
+          property_name = name.to_sym
+
+          properties[property_name] = definition
+          if required
+            required_properties << property_name unless required_properties.include?(property_name)
+          else
+            required_properties.delete(property_name)
+          end
+
+          nil
         end
 
         def primitive_type?(type)

data/lib/ruby_llm/schema/errors.rb

@@ -13,18 +13,10 @@ module RubyLLM
     end
 
     # Raised when an invalid array type is specified
-    class InvalidArrayTypeError < Error
-      def initialize(message)
-        super
-      end
-    end
+    class InvalidArrayTypeError < Error; end
 
     # Raised when an invalid object type is specified
-    class InvalidObjectTypeError < Error
-      def initialize(message)
-        super
-      end
-    end
+    class InvalidObjectTypeError < Error; end
 
     # Raised when schema definition is invalid
     class InvalidSchemaError < Error; end

data/lib/ruby_llm/schema/json_output.rb

@@ -4,16 +4,17 @@ module RubyLLM
   class Schema
     module JsonOutput
       def to_json_schema
-        validate!  # Validate schema before generating JSON
+        validate! # Validate schema before generating JSON
 
         schema_hash = {
           type: "object",
           properties: self.class.properties,
           required: self.class.required_properties,
-          additionalProperties: self.class.additional_properties,
-          strict: self.class.strict
+          additionalProperties: self.class.additional_properties
         }
 
+        schema_hash[:strict] = self.class.strict unless self.class.strict.nil?
+
         # Only include $defs if there are definitions
         schema_hash["$defs"] = self.class.definitions unless self.class.definitions.empty?
 
@@ -25,7 +26,7 @@ module RubyLLM
       end
 
       def to_json(*_args)
-        validate!  # Validate schema before generating JSON string
+        validate! # Validate schema before generating JSON string
         JSON.pretty_generate(to_json_schema)
       end
     end

data/lib/ruby_llm/schema/validator.rb

@@ -45,9 +45,7 @@ module RubyLLM
         return if marks[node] == BLACK
 
         # If node has a temporary mark, we found a cycle
-        if marks[node] == GRAY
-          raise ValidationError, "Circular reference detected involving '#{node}'"
-        end
+        raise ValidationError, "Circular reference detected involving '#{node}'" if marks[node] == GRAY
 
         # Mark node with temporary mark
         marks[node] = GRAY

data/lib/ruby_llm/schema/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module RubyLlm
+module RubyLLM
   class Schema
-    VERSION = "0.2.5"
+    VERSION = '0.3.1'
   end
 end

data/lib/ruby_llm/schema.rb

@@ -48,14 +48,16 @@ module RubyLLM
 
       def additional_properties(value = nil)
         return @additional_properties ||= false if value.nil?
+
         @additional_properties = value
       end
 
-      def strict(value = nil)
-        if value.nil?
-          return @strict.nil? ? (@strict = true) : @strict
+      def strict(*args)
+        if args.empty?
+          instance_variable_defined?(:@strict) ? @strict : true
+        else
+          @strict = args.first
         end
-        @strict = value
       end
 
       def validate!

data/lib/tasks/release.rake

@@ -1,33 +1,8 @@
+# frozen_string_literal: true
+
 namespace :release do
-  desc "Prepare and push the release branch to trigger the automated pipeline"
+  desc 'Prepare for release'
   task :prepare do
-    abort "Git working directory not clean. Commit or stash changes first." unless `git status --porcelain`.strip.empty?
-    abort "Not on main branch. Releases must be run from main branch" unless `git rev-parse --abbrev-ref HEAD`.strip == "main"
-
-    require_relative "../ruby_llm/schema/version"
-    version = RubyLlm::Schema::VERSION or abort "Could not determine version"
-
-    branch = "release/#{version}"
-
-    if system("git rev-parse --quiet --verify refs/tags/v#{version} > /dev/null 2>&1")
-      abort "Tag v#{version} already exists. Bump the version first."
-    end
-
-    if system("git show-ref --verify --quiet refs/heads/#{branch}")
-      abort "Local branch #{branch} already exists. Remove it or choose a new version."
-    end
-
-    sh "git fetch origin"
-
-    if system("git ls-remote --exit-code --heads origin #{branch} > /dev/null 2>&1")
-      abort "Release branch #{branch} already exists on origin. Remove it or choose a new version."
-    end
-
-    sh "git checkout -b #{branch}"
-    sh "git push -u origin #{branch}"
-
-    puts "Release branch #{branch} pushed. GitHub Actions will run tests and publish if they pass."
-  ensure
-    system "git checkout main"
+    sh 'overcommit --run'
   end
 end

metadata

@@ -1,55 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-schema
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Friis
-autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: 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: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description:
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A compact Ruby DSL for building standards-oriented JSON Schema documents
+  from Ruby.
 email:
 - d@friis.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- LICENSE.txt
+- LICENSE
 - README.md
-- RELEASE.md
-- Rakefile
 - lib/ruby_llm/schema.rb
 - lib/ruby_llm/schema/dsl.rb
 - lib/ruby_llm/schema/dsl/complex_types.rb
@@ -62,15 +31,15 @@ files:
 - lib/ruby_llm/schema/validator.rb
 - lib/ruby_llm/schema/version.rb
 - lib/tasks/release.rake
-homepage: https://github.com/danielfriis/ruby_llm-schema
+homepage: https://github.com/crmne/ruby_llm-schema#readme
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/danielfriis/ruby_llm-schema
-  source_code_uri: https://github.com/danielfriis/ruby_llm-schema
-  changelog_uri: https://github.com/danielfriis/ruby_llm-schema/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/crmne/ruby_llm-schema#readme
+  source_code_uri: https://github.com/crmne/ruby_llm-schema
+  changelog_uri: https://github.com/crmne/ruby_llm-schema/releases
+  bug_tracker_uri: https://github.com/crmne/ruby_llm-schema/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,15 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.1.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
-summary: A simple and clean Ruby DSL for creating JSON schemas.
+summary: A simple Ruby DSL for creating JSON schemas.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---require spec_helper
---color
---format documentation 

data/RELEASE.md

@@ -1,8 +0,0 @@
-# Release process
-
-1. Bump the version in `lib/ruby_llm/schema/version.rb`
-2. Run `bundle install` to update the gemspec
-3. Commit the changes with a message like "Bump version to X.Y.Z"
-4. Run `bundle exec rake release:prepare` to create a release branch and push it to GitHub
-5. Github Actions will run the tests and publish the gem if they pass
-6. Delete the release branch: `git branch -d release/<version> && git push origin --delete release/<version>`

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "standard/rake"
-
-# Load custom tasks
-Dir.glob("lib/tasks/**/*.rake").each { |r| load r }
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: %i[standard spec]