rspec-time-guard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2236097d6377167a8f7a07f9d37e1d23ca71110aabdfcf0e6b79ca2d9783c8e5
+  data.tar.gz: d9b596f350b3efef6f8fe67513aa7dd03c933208196cbb31808b8d79e305411b
+SHA512:
+  metadata.gz: 3f8aab7a4360a8226ca00e4501eedca92b7c2fdebffcffb89ae5f92e6e7a700b4e225d37445140e6888e8fa58643dea80be4c06d6ef849a02ddb0aa3297532e2
+  data.tar.gz: 006735ff24aa6e288d72d043f7efad35169d4af3c481de695ae3dcc2d5cfc868cc29c28139c7107badf77025fbee846a2e90885e6556d709822982711bf23e81

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-11
+
+- Initial release

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) 2025 Lucas Montorio
+
+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,182 @@
+[//]: # (TODO: Add a public TODO list?)
+
+# ⚠️ **_This project is a Work In Progress_** ⚠️
+
+# RspecTimeGuard
+
+`RspecTimeGuard` helps you identify and manage slow-running tests in your RSpec test suite by setting time limits on individual examples or globally across your test suite.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-time-guard'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it globally:
+
+```bash
+$ gem install rspec-time-guard
+```
+
+
+## Usage
+
+### Basic Setup
+
+RSpec Time Guard integrates automatically with Rails applications in the test environment. For non-Rails projects, you'll need to manually require and set it up.
+
+#### Rails Setup
+
+The gem will automatically initialize itself when Rails loads in the test environment.
+
+#### Manual Setup (for non-Rails projects)
+
+In your `spec_helper.rb` or similar file:
+
+```ruby
+require 'rspec_time_guard'
+
+RspecTimeGuard.setup
+```
+
+### Configuration
+
+Create an initializer at `config/initializers/rspec_time_guard.rb` (for Rails) or add to your spec configuration file:
+
+```ruby
+RspecTimeGuard.configure do |config|
+  # Set a global time limit in seconds for all examples (nil = no global limit)
+  config.global_time_limit_seconds = 1.0
+  
+  # Whether to continue running tests that exceed their time limit
+  # true = shows warning but allows test to complete
+  # false = raises TimeLimitExceededError and stops the test (default)
+  config.continue_on_timeout = false
+end
+```
+
+### Setting Time Limits
+
+#### Option 1: Global Time Limit
+
+Set a global time limit that applies to all your tests through configuration:
+
+```ruby
+RspecTimeGuard.configure do |config|
+  config.global_time_limit_seconds = 0.5 # 500 milliseconds
+end
+```
+
+#### Option 2: Per-Example Time Limits
+
+Add a specific time limit to individual examples using metadata:
+
+```ruby
+# Apply a 0.25 second time limit to this test
+it "should do something quickly", time_limit_seconds: 0.25 do
+  # Your test code
+end
+
+# Apply a 5 second time limit to this group of tests
+describe "operations that need more time", time_limit_seconds: 5 do
+  it "does a complex operation" do
+    # ...
+  end
+  
+  it "does another complex operation" do
+    # ...
+  end
+end
+```
+
+### Error Handling
+
+When a test exceeds its time limit:
+
+1. If `continue_on_timeout` is `false` (default):
+   - The test will be interrupted
+   - A `RspecTimeGuard::TimeLimitExceededError` will be raised
+   - The test will be marked as failed
+
+2. If `continue_on_timeout` is `true`:
+   - A warning message will be displayed
+   - The test will continue running until completion
+   - The test will pass or fail based on its assertions, not its timing
+
+### Important Notes on Test Execution
+
+#### Test Interruption
+
+When a time limit is exceeded and `continue_on_timeout` is set to `false` (the default):
+
+- Test execution is immediately interrupted at the time limit
+- Any code after the point where the timeout occurs will not be executed
+- Cleanup operations such as database transactions may not complete normally
+- Any assertions or expectations after the timeout point won't be evaluated
+
+This means if your test has important cleanup steps or assertions near the end, they might not run if the test times out earlier.
+If you need to ensure all test code runs even when timing out, use the `continue_on_timeout` option.
+
+#### Thread Safety Considerations
+
+RSpec Time Guard uses threads for execution monitoring. While we take care to properly clean up these threads, be aware that:
+
+1. Tests with threading or process-spawning code might behave unexpectedly
+2. Thread-local variables could be lost when a test is interrupted
+3. Some Ruby extensions and libraries might not be fully thread-safe
+ite
+
+
+## Examples
+
+### Basic Example
+
+```ruby
+# spec/models/user_spec.rb
+require 'rails_helper'
+
+RSpec.describe User, type: :model do
+  it "validates email quickly", time_limit_seconds: 0.1 do
+    user = User.new(email: "invalid")
+    expect(user.valid?).to be false
+  end
+  
+  # This test will use the global time limit if configured
+  it "can generate a profile" do
+    user = User.create(name: "John", email: "john@example.com")
+    expect(user.generate_profile).to include(name: "John")
+  end
+end
+```
+
+
+## How It Works
+
+RSpec Time Guard works by:
+
+1. Setting up an RSpec `around(:each)` hook
+2. Running your test in a separate thread
+3. Monitoring execution time
+4. Taking action if the time limit is exceeded
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-time-guard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rspec-time-guard/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `RspecTimeGuard` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec-time-guard/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/rspec-time-guard.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "rspec_time_guard"

data/lib/rspec_time_guard/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RspecTimeGuard
+  class Configuration
+    attr_accessor :global_time_limit_seconds, :continue_on_timeout
+
+    def initialize
+      @global_time_limit_seconds = nil
+      @continue_on_timeout = false
+    end
+  end
+end

data/lib/rspec_time_guard/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RspecTimeGuard
+  class Railtie < Rails::Railtie
+    initializer "rspec_time_guard.configure" do
+      Rails.logger.info("INITIALIZER")
+
+      config.after_initialize do
+        Rails.logger.info("AFTER INITIALIZE")
+
+        if defined?(RSpec) && Rails.env.test?
+          require "rspec_time_guard"
+
+          RspecTimeGuard.setup if defined?(RSpec)
+        end
+      end
+    end
+  end
+end

data/lib/rspec_time_guard/version.rb

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

data/lib/rspec_time_guard.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rspec_time_guard/configuration"
+require "rspec_time_guard/version"
+require "rspec_time_guard/railtie" if defined?(Rails)
+
+module RspecTimeGuard
+  class TimeLimitExceededError < StandardError; end
+
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @_configuration ||= RspecTimeGuard::Configuration.new
+    end
+
+    # TODO: Handle RSpec summary manually?
+    # TODO: Check that it doesn't break RSpec parallel runs in CI (if any)
+    # TODO: Run profiling on the whole test suite to check for performance issues
+    # TODO: add PR template
+    def setup
+      RSpec.configure do |config|
+        config.around(:each) do |example|
+          time_limit_seconds = example.metadata[:time_limit_seconds] || RspecTimeGuard.configuration.global_time_limit_seconds
+
+          next example.run unless time_limit_seconds
+
+          completed = false
+
+          # NOTE: We instantiate a monitoring thread, to allow the example to run in the main RSpec thread.
+          # This is required to keep the RSpec context.
+          monitor_thread = Thread.new do
+            Thread.current.report_on_exception = false
+
+            # NOTE: The following logic:
+            #  - Waits for the duration of the time limit
+            #  - If the main thread is still running at that stage, raises a TimeLimitExceededError
+            sleep time_limit_seconds
+
+            unless completed
+              message = "[RspecTimeGuard] Example exceeded timeout of #{time_limit_seconds} seconds"
+              if RspecTimeGuard.configuration.continue_on_timeout
+                warn "#{message} - Running the example anyway (:continue_on_timeout option set to TRUE)"
+                example.run
+              else
+                Thread.main.raise RspecTimeGuard::TimeLimitExceededError, message
+              end
+            end
+          end
+
+          # NOTE: Main RSpec thread execution
+          begin
+            example.run
+            completed = true
+          ensure
+            # NOTE: We explicitly clean up the monitoring thread in case the example completes before the time limit.
+            monitor_thread.kill if monitor_thread.alive?
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rspec-time-guard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Montorio
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec Time Guard helps you identify and manage slow-running tests in
+  your RSpec test suite by setting time limits on individual examples or globally
+  across your test suite.
+email:
+- lucas.montorio@lifen.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-time-guard.rb
+- lib/rspec_time_guard.rb
+- lib/rspec_time_guard/configuration.rb
+- lib/rspec_time_guard/railtie.rb
+- lib/rspec_time_guard/version.rb
+homepage: https://github.com/LucasMontorio/rspec-time-guard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LucasMontorio/rspec-time-guard
+  source_code_uri: https://github.com/LucasMontorio/rspec-time-guard
+  changelog_uri: https://github.com/LucasMontorio/rspec-time-guard/blob/main/CHANGELOG.md
+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 simple time keeper for RSpec tests.
+test_files: []