ruby_timeout_safe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fc2f4c28c6c3ab39dda99ecbddfba1e0128954b7361ae18605594b84175ca36
+  data.tar.gz: 35b8c41ab8c1f413b493c77d1b272fb532dfcb58c16e3dfac1a2aa6c67b5bab0
+SHA512:
+  metadata.gz: 377bda663c266dacaf4d9c18227fdd176bbe868c5911abc6cf8ef07d274ac71ba6a6bc967964acd382d1f58b99eb3489c860d82710e6e070523eac00e6c7747c
+  data.tar.gz: 29c8399c8f0a37752bb379535d8b0118ccd9e39d11e4a3aa05afe696f21428bce5dd6fcb95ab977fefbfe6cf7ca6ce135e07d2543c1d3797f651e523199294d2

data/.rspec

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

data/.rubcop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sebi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# 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.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run tests'
+task test: :spec

data/lib/ruby_timeout_safe/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyTimeoutSafe
+  VERSION = '0.1.0'
+end

data/lib/ruby_timeout_safe.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'timeout'
+require_relative 'ruby_timeout_safe/version'
+
+# A safe timeout implementation for Ruby using monotonic time.
+module RubyTimeoutSafe
+  def self.timeout(seconds) # rubocop:disable Metrics/MethodLength
+    raise ArgumentError, 'timeout value must be at least 1 second' if seconds.nil? || seconds < 1.0
+
+    start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    thread = Thread.new do
+      sleep(seconds)
+      Thread.main.raise Timeout::Error, 'execution expired'
+    end
+
+    begin
+      yield
+    ensure
+      elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+      remaining_time = seconds - elapsed_time
+      thread.kill if remaining_time.positive?
+    end
+  end
+end

data/ruby-timeout-safe.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ruby_timeout_safe/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ruby_timeout_safe'
+  spec.version = RubyTimeoutSafe::VERSION
+  spec.authors = ['sebi']
+  spec.email = ['gore.sebyx@yahoo.com']
+
+  spec.summary = 'A safe timeout implementation for Ruby using monotonic time.'
+  spec.description = <<~DESC
+    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.
+
+    The gem 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.
+
+    This implementation leverages Ruby's built-in threading and monotonic time functions to
+    provide a robust timeout mechanism.
+  DESC
+  spec.homepage = 'https://github.com/sebyx07/ruby-timeout-safe'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match?(%r{\A(?:bin/|test/|spec/|features/|\.git|\.github|appveyor|Gemfile)})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/sig/ruby_timeout_safe.rbs

@@ -0,0 +1,18 @@
+# The RubyTimeoutSafe module provides a safe and reliable timeout functionality
+# for executing Ruby blocks. It uses POSIX threads (pthreads) and signal handling
+# to ensure that timeouts are enforced even in the presence of blocking operations
+# or long-running computations.
+module RubyTimeoutSafe
+  # The current version of the Ruby::Timeout::Safe module.
+  VERSION: String
+
+  # Executes the given block with a specified timeout duration.
+  #
+  # @param seconds [Integer, Float, nil] The timeout duration in seconds.
+  #   If `nil` is provided, the block will be executed without a timeout.
+  # @yield The block to be executed with the specified timeout.
+  # @raise [ArgumentError] If the `seconds` argument is negative.
+  # @raise [Timeout::Error] If the block execution exceeds the specified timeout.
+  # @return [Object] The result of the block execution.
+  def self.timeout: (seconds: (Integer)) { () -> untyped } -> untyped
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ruby_timeout_safe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sebi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-04 00:00:00.000000000 Z
+dependencies: []
+description: |
+  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.
+
+  The gem 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.
+
+  This implementation leverages Ruby's built-in threading and monotonic time functions to
+  provide a robust timeout mechanism.
+email:
+- gore.sebyx@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubcop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_timeout_safe.rb
+- lib/ruby_timeout_safe/version.rb
+- ruby-timeout-safe.gemspec
+- sig/ruby_timeout_safe.rbs
+homepage: https://github.com/sebyx07/ruby-timeout-safe
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sebyx07/ruby-timeout-safe
+  source_code_uri: https://github.com/sebyx07/ruby-timeout-safe
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: A safe timeout implementation for Ruby using monotonic time.
+test_files: []