https://github.com/rocksolt/ruby_llm-test
Stub your RubyLLM calls to test application logic.
https://github.com/rocksolt/ruby_llm-test
llm ruby ruby-llm testing
Last synced: about 15 hours ago
JSON representation
Stub your RubyLLM calls to test application logic.
- Host: GitHub
- URL: https://github.com/rocksolt/ruby_llm-test
- Owner: RockSolt
- License: mit
- Created: 2026-04-21T22:18:26.000Z (5 days ago)
- Default Branch: main
- Last Pushed: 2026-04-24T16:09:09.000Z (2 days ago)
- Last Synced: 2026-04-25T12:36:55.739Z (1 day ago)
- Topics: llm, ruby, ruby-llm, testing
- Language: Ruby
- Homepage:
- Size: 57.6 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RubyLLM::Test
This gem provides testing utilities for RubyLLM, a Ruby library for working with large language models (LLMs). It enables calls to LLM's 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.
```ruby
RubyLLM::Test.stub_response("Outlook good")
chat = RubyLLM.chat
response = chat.ask "What are the odds this works?"
assert_equal "Outlook good", response.content
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ruby_llm-test'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ruby_llm-test
## Usage
Add the following lines to your `spec/spec_helper.rb` or `test/test_helper.rb`:
```ruby
require 'ruby_llm/test'
RubyLLM::Models.singleton_class.prepend(RubyLLM::Test::ResolveWithTestProvider)
```
Then, in your tests, you can use the `stub_response` method to stub responses from the LLM. For example:
```ruby
it 'returns a stubbed response' do
RubyLLM::Test.stub_response('Hello, world!')
response = MyLLMClient.call('Hello?')
expect(response).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:
```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?')
expect(response1).to eq('Hello, world!')
expect(response2).to eq('How are you?')
end
```
### Stubbing with a Message
If you stub with a string, it will be wrapped in a `RubyLLM::Message` with the role of `:assistant`. If you want more control over the message, you can stub with a `RubyLLM::Message` directly. For example:
```ruby
it 'returns a stubbed message' do
message = RubyLLM::Message.new(role: :assistant, content: 'Hello, world!')
RubyLLM::Test.stub_response(message)
response = MyLLMClient.call('Hello?')
expect(response).to eq(message)
end
```
### Stubbing with a Hash Returns JSON
If you stub with a hash, it will be converted to a `RubyLLM::Message` with the content set to the JSON representation of the hash. For example:
```ruby
it 'returns a stubbed JSON message' do
hash = { key: 'value' }
RubyLLM::Test.stub_response(hash)
response = MyLLMClient.call('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.
```ruby
RubyLLM::Test.reset
```
### Stubbing with a Block
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!')
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/RockSolt/ruby_llm-test.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).