rspec-retryable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4780f14d90cc2bdce6da95e999e53bc8d7161b298840726e88c509bdddfbafc
+  data.tar.gz: cd5346007d8ce02a9ae49186bd0b5e6f81938641a191bafe7f882e15e47adc4f
+SHA512:
+  metadata.gz: '0927eb2492bd7c287d2c96a10bbfc1eb811a61d4ac39dd4fc632f7416a112ef623227f0a6813a126332b961dfefdd3a0000f074659b16c12992fc6f8dcbf9bd6'
+  data.tar.gz: a2feafa640ee50b563983f25554a53281726aa557ff7ac7a4e4b52db699e7ceac3d0de4f1de21192fd6b25ca18a9d869f6d272470e6dfc97b7d471e2440a4255

data/.rspec

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

data/README.md

@@ -0,0 +1,35 @@
+# RSpec::Retryable
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/retryable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/ngan/rspec-retryable.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rspec/retryable/example.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'rspec/retryable/metadata'
+require 'rspec/retryable/payload'
+
+module RSpec
+  module Retryable
+    module Example
+      def finish(reporter)
+        metadata[:retryable] ||= Metadata.new
+
+        if @exception
+          state = :failed
+          execution_result.exception = @exception
+          record_finished :failed, reporter
+        elsif execution_result.pending_message
+          state = :pending
+          record_finished :pending, reporter
+        else
+          state = :passed
+          record_finished :passed, reporter
+        end
+
+        @payload = RSpec::Retryable::Payload.new(self, state)
+
+        RSpec::Retryable.handlers.invoke(@payload)
+
+        if @payload.retry
+          # Replaced the final result by the retry result
+          @payload.result = retry_example
+        end
+
+        # Notify reporter only if it's not handled by the handlers
+        notify_reporter if @payload.notify
+
+        @payload.result
+      end
+
+      # https://github.com/rspec/rspec-core/blob/3-10-maintenance/lib/rspec/core/example.rb#L433-L441
+      # Used internally to set an exception and fail without actually executing
+      # the example when an exception is raised in before(:context).
+      def fail_with_exception(...)
+        @failed_in_context = true
+        super
+      end
+
+      def failed_in_context?
+        !!@failed_in_context
+      end
+
+      def retry_example
+        metadata[:retryable].failures << @exception
+        metadata[:retryable].attempts += 1
+        # Every retry turns off the retry and notify flag, it's up to the handler to turn them back on or not.
+        @payload.retry = false
+        @payload.notify = false
+        # Duplicate the example for re-run
+        new_example = duplicate_with(metadata)
+        new_example.instance_variable_set(:@id, id)
+        # Taken from https://github.com/rspec/rspec-core/blob/main/lib/rspec/core/example_group.rb#L644-L646
+        instance = new_example.example_group.new(new_example.inspect_output)
+        new_example.example_group.set_ivars(instance, new_example.example_group.before_context_ivars)
+        # Use same reporter from example instead of the one passing in to behave like
+        # a fresh new example.
+
+        new_example.run(instance, reporter)
+      end
+
+      def notify_reporter
+        case @payload.state
+        when :failed
+          reporter.example_failed self
+        when :pending
+          reporter.example_pending self
+        when :passed
+          reporter.example_passed self
+        end
+      end
+    end
+  end
+end

data/lib/rspec/retryable/handlers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Retryable
+    class Handlers
+      def initialize
+        @handlers = []
+      end
+
+      def register(klass, *args, **kwargs)
+        @handlers << klass.new(*args, **kwargs)
+      end
+
+      def invoke(payload)
+        traverse(0, payload)
+      end
+
+      private
+
+      def traverse(index, payload)
+        @handlers[index]&.call(payload) do
+          traverse(index + 1, payload)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/retryable/metadata.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Retryable
+    class Metadata
+      attr_writer :attempts, :retry, :failures
+
+      def attempts
+        @attempts ||= 0
+      end
+
+      def retry
+        return @retry if defined?(@retry)
+
+        @retry = false
+      end
+
+      def failures
+        @failures ||= []
+      end
+
+      def to_h
+        {
+          attempts: attempts,
+          retry: @retry,
+          failures: failures,
+        }
+      end
+    end
+  end
+end

data/lib/rspec/retryable/payload.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Retryable
+    class Payload
+      attr_reader :example
+      attr_accessor :notify, :result, :retry, :state
+
+      # Default payload with:
+      # - example: RSpec example
+      # - state: Current state of the example, can be alterted by handlers
+      # - notify: default to `true`, if set to `false`, reporter will not be notified
+      # - result: this is the final result returned to RSpec runner
+      # - retry: default to `false`, if set to `true`, the example will be retried
+      def initialize(example, state)
+        @example = example
+        @state = state
+        @notify = true
+        @result = state == :failed ? false : true
+        @retry = false
+      end
+    end
+  end
+end

data/lib/rspec/retryable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Retryable
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/retryable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rspec/retryable/version'
+require 'rspec/retryable/example'
+require 'rspec/retryable/handlers'
+
+module RSpec
+  module Retryable
+    class << self
+      def handlers
+        @handlers ||= Handlers.new
+      end
+
+      def bind
+        require 'rspec/core'
+
+        ::RSpec::Core::Example.prepend(RSpec::Retryable::Example)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: rspec-retryable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ngan Pham
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- ngan@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/rspec/retryable.rb
+- lib/rspec/retryable/example.rb
+- lib/rspec/retryable/handlers.rb
+- lib/rspec/retryable/metadata.rb
+- lib/rspec/retryable/payload.rb
+- lib/rspec/retryable/version.rb
+homepage: https://github.com/Gusto/rspec-retryable
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Gusto/rspec-retryable
+  source_code_uri: https://github.com/Gusto/rspec-retryable
+  changelog_uri: https://github.com/Gusto/rspec-retryable/releases
+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.0
+signing_key:
+specification_version: 4
+summary: Adds ability to fully control RSpec retrying
+test_files: []