llm.rb 12.6.0 → 13.0.0

data/lib/llm/tools/shell.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal
-
 class LLM::Tool
   ##
   # The {LLM::Tool::Shell} class implements a tool that can
@@ -12,11 +10,16 @@ class LLM::Tool
   # by managing the tool loop manually through
   # {LLM::Context LLM::Context}.
   class Shell < self
+    require_relative "utils"
+    include Utils
+
     name "shell"
     description "run a shell command"
     parameter :name, String, "the command name"
     parameter :arguments, Array[String], "one or more command arguments"
+    parameter :timeout, Integer, "the maximum allowed time for the command to run (in seconds)"
     required %i[name]
+    defaults arguments: [], timeout: 60
 
     ##
     # @param [String] name
@@ -24,8 +27,9 @@ class LLM::Tool
     # @param [Array<String>] arguments
     #  One or more command-line arguments
     # @return [Hash]
-    def call(name:, arguments: nil)
+    def call(name:, arguments: [], timeout: 60)
       command = spawn(name:, arguments:)
+      wait(command:, timeout:)
       {ok: command.success?, stdout: command.stdout, stderr: command.stderr}
     end
 
@@ -42,7 +46,7 @@ class LLM::Tool
         .spawn
     end
 
-    LLM.require "test-cmd.rb"
+    LLM.require "test-cmd.rb", "~> 1.1"
     Command = Test::Cmd
   end
 end

data/lib/llm/tools/utils.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class LLM::Tool
+  ##
+  # Shared utilities for tool implementations.
+  module Utils
+    ##
+    # Wait for a command to finish, or abort
+    # with an error when it exceeds the
+    # specified timeout.
+    # @param [Test::Cmd] command
+    # @param [Integer] timeout
+    # @return [void]
+    def wait(command:, timeout:)
+      start = now
+      while command.running?
+        if now - start > timeout
+          command.kill!
+          raise "command timed out after #{timeout}s"
+        end
+        sleep 0.01
+      end
+    end
+
+    ##
+    # @return [Numeric]
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LLM
-  VERSION = "12.6.0"
+  VERSION = "13.0.0"
 end

data/lib/llm.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
+##
+# llm.rb is a zero-dependency AI runtime for Ruby. Twelve providers, six
+# concurrency strategies, MCP and A2A, streaming tool calls with
+# cancellation, context compaction, and ORM persistence.
+#
+# @example The three-step workflow
+#   require "llm"
+#   llm = LLM.deepseek(key: ENV["KEY"])           # 1. pick a provider
+#   agent = LLM::Agent.new(llm, stream: $stdout)   # 2. create an agent
+#   agent.talk "Hello world"                       # 3. talk to it
+#
+# @see LLM::Agent The recommended high-level interface
+# @see LLM::Context The low-level stateful runtime (advanced)
 module LLM
   require "stringio"
   require "securerandom"
+  require_relative "llm/compactor"
   require_relative "llm/json_adapter"
   require_relative "llm/tracer"
   require_relative "llm/error"
@@ -49,15 +63,21 @@ module LLM
 
   ##
   # Requires an optional runtime dependency
-  # @raise [LLM::DependencyError]
+  # @param [String] name
+  #  The name of a gem
+  # @param [String, nil] version
+  #  Optional gem version
+  # @raise [LLM::LoadError]
   #  When the dependency cannot be loaded
-  def self.require(name)
-    super
-  rescue ::LoadError
+  def self.require(name, version = nil)
     names = {"xchan" => "xchan.rb", "net/http/persistent" => "net-http-persistent"}
+    gem(names[name] || name, version) if version
+    super(name)
+  rescue ::LoadError
     name = names[name] || name
     raise LLM::LoadError,
-      "#{name} is an optional runtime dependency but it does not appear to be installed. " \
+      "#{name}#{version ? " #{version}" : ""} is an optional " \
+      "runtime dependency but it does not appear to be installed. " \
       "Consider 'gem install #{name}', adding '#{name}' to your Gemfile or " \
       "opting out of the functionality provided by '#{name}'"
   end

data/llm.gemspec

@@ -16,7 +16,7 @@ functionality – such as ActiveRecord support – require
 optional dependencies that are opt-in.
 DESCRIPTION
 
-  spec.license = "BUSL-1.1"
+  spec.license = "MIT"
   spec.required_ruby_version = ">= 3.3.0"
 
   spec.homepage = "https://r.uby.dev/llm/"
@@ -38,7 +38,7 @@ DESCRIPTION
   spec.add_development_dependency "yard", "~> 0.9.37"
   spec.add_development_dependency "redcarpet", "~> 3.6"
   spec.add_development_dependency "webrick", "~> 1.8"
-  spec.add_development_dependency "test-cmd.rb", "~> 0.12.0"
+  spec.add_development_dependency "test-cmd.rb", "~> 1.1.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "standard", "~> 1.50"
@@ -50,7 +50,7 @@ DESCRIPTION
   spec.add_development_dependency "activerecord", "~> 8.0"
   spec.add_development_dependency "sequel", "~> 5.0"
   spec.add_development_dependency "sqlite3", "~> 2.0"
-  spec.add_development_dependency "xchan.rb", "~> 0.20"
+  spec.add_development_dependency "xchan.rb", "~> 0.22"
   spec.add_development_dependency "pg", "~> 1.5"
   spec.add_development_dependency "irb", "~> 1.18"
 end