https://github.com/sebyx07/ruby-timeout-safe

https://github.com/sebyx07/ruby-timeout-safe

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sebyx07/ruby-timeout-safe
• Owner: sebyx07
• License: mit
• Created: 2024-07-04T15:27:19.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T11:40:51.000Z (5 months ago)
• Last Synced: 2024-10-29T23:42:22.963Z (2 months ago)
• Language: Ruby
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Ruby Timeout Safe

ruby-timeout-safe is a Ruby library that provides a safe and reliable timeout functionality for executing Ruby blocks. It uses Ruby's threading and monotonic time to ensure that timeouts are enforced even in the presence of blocking operations or long-running computations.

## Features

- Defines a `RubyTimeoutSafe` module with a `timeout` method that executes a given Ruby block with a specified timeout duration.

- If the block execution exceeds the timeout, a `TimeoutError` exception is raised.

- Supports handling large timeout values.

- Raises an `ArgumentError` if a negative timeout value is provided.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'ruby_timeout_safe'

```

## Usage:

```ruby

require 'ruby_timeout_safe'

# Execute a block with a 2-second timeout

RubyTimeoutSafe.timeout(2) do

  # Your code here

  sleep 1 # This will not raise a timeout error

  # ...

end

# Handling a timeout error

begin

  RubyTimeoutSafe.timeout(1) do

    # Your code here

    sleep 3 # This will raise a TimeoutError

  end

rescue Timeout::Error => e

  puts "Execution timed out: #{e.message}"

end

```

## Caveats

This implementation uses Ruby's built-in threading and monotonic time functions. While it is more compatible with different Ruby implementations and platforms than a C extension, it may still have limitations based on Ruby's threading model.

## Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests.

To install this gem onto your local machine, run bundle exec rake install.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sebyx07/ruby-timeout-safe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

## License

The gem is available as open source under the terms of the MIT License.

## Code of Conduct

Everyone interacting in the ruby-timeout-safe project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.