ruby_llm-test 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a0eae1a8d1ab14addc132333aa7f6baef9695e8a13c0160ee7ff85b5114c2a9
-  data.tar.gz: a45059e4ae9b0f182f791b43df7905b25a11d38d7a3d87878d2e6f0ad8a4421f
+  metadata.gz: ef753ca266479d9530fb44f0660cb2292bc916c2c949376c65686488bd41f5d9
+  data.tar.gz: f96175266a8866d9038b529b37ae0f099f1b20cdf677f591ab36acc941e566bb
 SHA512:
-  metadata.gz: 4504b45b39bfea4799804b39f14f54560650646269eded1b0f3a50f019cf803f09a9bc04a82c7b4a66ddf88e345843c8be4bd4396655c4e7d11051bcafda200b
-  data.tar.gz: 7583a4bc1e8b89d0c2d358eb3d90956205ca3d622d06907045e2e48827c3cd7b9444433876e84af94b81d60ea1e416c872f2d81e2c7aaef063ce1d61d57f1af5
+  metadata.gz: e58becb7a4ae7b1d2248746f8aad685aa5a382307fe8c57887d0b6d2c170e35ffc4e97ae095cc0601ebf17e50de3374cab6060619c6ba57adfed4c85f5be576b
+  data.tar.gz: 76456e9ec3ed46ec76eafbae1bdebe6fd9598cce423f527c505028a43520dfa01c538341fd28c71fddfd70f36d7c47410b2cfb2fb8425fa6ba0abe6ccc6aac55

data/README.md

@@ -1,6 +1,14 @@
+[![Gem Version](https://badge.fury.io/rb/ruby_llm-test.svg)](https://badge.fury.io/rb/ruby_llm-test)
+[![Tests](https://github.com/RockSolt/ruby_llm-test/actions/workflows/test.yml/badge.svg)](https://github.com/RockSolt/ruby_llm-test/actions/workflows/test.yml)
+[![RuboCop](https://github.com/RockSolt/ruby_llm-test/actions/workflows/rubocop.yml/badge.svg)](https://github.com/RockSolt/ruby_llm-test/actions/workflows/rubocop.yml)
+
 # RubyLLM::Test
 
-This gem provides testing utilities for RubyLLM, a Ruby library for working with large language models (LLMs). It enables calls to LLMs to be stubbed so that the surrounding application logic can be tested without making actual calls to the LLM. This is particularly useful for testing code that interacts with LLMs, as it allows developers to simulate responses from the LLM without incurring the cost, latency, or randomness of real API calls.
+How do you test your business logic when it interacts with large language models (LLMs)? From a testing point of view, an LLM is just an external system. To keep tests fast and consistent, pick a boundary then stub or mock the external system.
+
+Part of the appeal of the RubyLLM library is that code using it does not need to know the specifics of provider APIs. The RubyLLM::Test gem brings the same benefit to your tests. No API or provider-specific knowledge is required to stub calls.
+
+Simple stubs make for simple tests. Keep your tests fast, consistent, and thorough with RubyLLM::Test!
 
 ```ruby
 RubyLLM::Test.stub_response("Outlook good")
@@ -29,7 +37,7 @@ Or install it yourself as:
 
 ## Usage
 
-Add the following lines to your `spec/spec_helper.rb` or `test/test_helper.rb`:
+Add the following lines to your `spec_helper.rb` or `test_helper.rb`:
 
 ```ruby
 require 'ruby_llm/test'
@@ -43,21 +51,22 @@ Then, in your tests, you can use the `stub_response` method to stub responses fr
 it 'returns a stubbed response' do
   RubyLLM::Test.stub_response('Hello, world!')
 
-  response = MyLLMClient.call('Hello?')
-  expect(response).to eq('Hello, world!')
+  response = RubyLLM.chat.ask 'Hello?'
+  expect(response.content).to eq('Hello, world!')
 end
 ```
 
-If you make multiple calls to the LLM, you can call `stub_response` more than once or use method `stub_responses` to stub multiple responses at once. For example:
+If you make multiple calls to the LLM, you can call `stub_response` more than once or use the `stub_responses` method to stub multiple responses at once. For example:
 
 ```ruby
 it 'returns multiple stubbed responses' do
-  RubyLLM::Test.stub_responses('Hello, world!', 'How are you?')
-  response1 = MyLLMClient.call('Hello?')
-  response2 = MyLLMClient.call('How are you?')
+  RubyLLM::Test.stub_responses('Blue.', 'No, yellow.')
+  chat = RubyLLM.chat
+  response1 = chat.ask 'What is your favorite color?'
+  response2 = chat.ask 'Are you sure?'
 
-  expect(response1).to eq('Hello, world!')
-  expect(response2).to eq('How are you?')
+  expect(response1.content).to eq('Blue.')
+  expect(response2.content).to eq('No, yellow.')
 end
 ```
 
@@ -70,7 +79,7 @@ it 'returns a stubbed message' do
   message = RubyLLM::Message.new(role: :assistant, content: 'Hello, world!')
   RubyLLM::Test.stub_response(message)
 
-  response = MyLLMClient.call('Hello?')
+  response = RubyLLM.chat.ask 'Hello?'
   expect(response).to eq(message)
 end
 ```
@@ -84,14 +93,14 @@ it 'returns a stubbed JSON message' do
   hash = { key: 'value' }
   RubyLLM::Test.stub_response(hash)
 
-  response = MyLLMClient.call('Hello?')
+  response = RubyLLM.chat.ask 'Hello?'
   expect(response.content).to eq(hash.to_json)
 end
 ```
 
 ### Resetting Stubs
 
-Make sure to reset stubs after each test to avoid interference before or between tests.
+Reset stubs before each test to ensure a clean slate.
 
 ```ruby
 RubyLLM::Test.reset
@@ -102,10 +111,9 @@ RubyLLM::Test.reset
 You can also stub responses in a block, which handles the setup and teardown of stubs automatically. For example:
 
 ```ruby
-
 RubyLLM::Test.with_responses('Hello, world!') do
-  response = MyLLMClient.call('Hello?')
-  expect(response).to eq('Hello, world!')
+  response = RubyLLM.chat.ask 'Hello?'
+  expect(response.content).to eq('Hello, world!')
 end
 ```
 

data/lib/ruby_llm/test/test_provider.rb

@@ -11,6 +11,12 @@ module RubyLLM
         @test_harness = test_harness
       end
 
+      # There are a number of cases that access `provider.class.display_name`, which avoids the delegation. Adding
+      # dummy stub for this. TBD if this needs to be more sophisticated in the future.
+      def self.display_name
+        "TestProvider"
+      end
+
       def complete(...)
         parameters = CompleteParameters.capture_from(__getobj__, ...)
         @test_harness.record_request(parameters)

data/lib/ruby_llm/test/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLLM
   module Test
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-test
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Todd Kummer
 bindir: bin
 cert_chain: []
-date: 2026-04-25 00:00:00.000000000 Z
+date: 2026-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_llm