faulty 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8604d16866bb43e4b58ebd4d9efd9e3ae2a85555bd5e2d92c1f1ec8bfa24fb69
-  data.tar.gz: a766e4e122b41e4d58cab15fc0c249a254e940e523b54e8d906d00bcefafb5e2
+  metadata.gz: 70d795aa07a3ebdb6ab1d59f03b0a93d6c65c6c83c88c4700eb0e553fdf210c6
+  data.tar.gz: 25df4a11f04f0a865bf9ea1236d0ad75f4b10b5d810966894c57911126b9dfde
 SHA512:
-  metadata.gz: d2bf7c915310ab7eac608fc738f64df191555c7acfe1b6a28eb5a8e0519e42f2cf0512ba5bd7d13d62379783cdbefef69c9fa952d08ff78bf95d973afbd7f15e
-  data.tar.gz: 56963c2e80e34f2f56ac5a4efa405032f9eb72bd176ee0e7683a2f7dd0a4d26f06535773b9056c84c50d2d5349b2c2eb6d9dcc97fa98f3ef130245e3d65adb2b
+  metadata.gz: d778e63ab973c4e31c64f72af87e53d99ce744f39e28edf698d7cf32a53da77c65beccd645e6447ca5360bd821169b2700e16224127a2c287cb9c353d33f133d
+  data.tar.gz: 1bb9248883024814297780af0f2417cae07466f246714b238bf2da18f29eb0bea9c6d0f56985b7e72cc7a8b6824756da5945bd7e931addea766d1d09ae597eb3

data/CHANGELOG.md

@@ -9,6 +9,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [Unreleased]
 -------------------
 
+[0.12.0] - 2026-05-13
+---------------------
+
+Runtime behavior is unchanged from `0.11.0` — the version bump reflects
+support-policy and toolchain breaking changes only. Upgrading should be
+a drop-in replacement on any supported Ruby.
+
+### Breaking
+
+* Drop support for Ruby < 3.1. Ruby 2.3 – 3.0 are EOL upstream and are no
+  longer covered by CI. Faulty now requires Ruby 3.1 or newer.
+* `faulty.gemspec` declares `required_ruby_version = '>= 3.1'`, so older
+  Rubies will refuse to install the gem.
+
+### Changed
+
+* Modernize the CI matrix: Ruby `3.1`, `3.2`, `3.3`, `3.4`, `jruby-head`,
+  and `truffleruby-head`; Redis 4 and 5; OpenSearch `2.19.5` (default) and
+  `3.0.0`; Elasticsearch `7.17.x` for back-compat coverage. The
+  Elasticsearch 7.17 row runs the `elasticsearch:7.17.28` Docker image
+  (which ships a JDK that handles cgroupv2 on current runners) against
+  the `elasticsearch ~> 7.17.11` gem.
+* Pass `DISABLE_INSTALL_DEMO_CONFIG=true` to the OpenSearch service
+  container so OpenSearch 2.12+ doesn't require an admin-password env
+  var just to boot up with the security plugin disabled.
+* Replace the deprecated `:mingw` / `:x64_mingw` platform symbols in the
+  `Gemfile` with the unified `:windows` symbol Bundler now expects.
+* Upgrade development dependencies: `rubocop ~> 1.84`, `rubocop-rspec ~> 3.9`,
+  `simplecov-cobertura ~> 3.1`, `opensearch-ruby ~> 3.4`.
+* `LogListener` now lazy-requires `logger` only when constructing the
+  default `Logger.new($stderr)`. Consumers that pass their own logger or
+  run under Rails do not need the stdlib `logger` gem on the load path.
+  This keeps Faulty boot-clean on Ruby 3.5+ where `logger` is no longer a
+  default gem.
+
+### Removed
+
+* Drop Redis 3 from the test matrix.
+* Drop the Ruby 2.3 carve-out in `spec/spec_helper.rb` that conditionally
+  loaded the `mysql2` patch.
+
 [0.11.0] - 2023-04-26
 ---------------------
 

data/README.md

@@ -146,7 +146,7 @@ Faulty.init do |config|
   config.storage = Faulty::Storage::Redis.new
 
   config.listeners << Faulty::Events::CallbackListener.new do |events|
-    events.circuit_open do |payload|
+    events.circuit_opened do |payload|
       puts 'Circuit was opened'
     end
   end
@@ -1353,12 +1353,15 @@ but there are and have been many other options:
 - [circuitbox](https://github.com/yammer/circuitbox): Also uses a block syntax
   to manually define circuits. It uses Moneta to abstract circuit storage to
   allow any key-value store.
+- [stoplight](https://github.com/bolshakov/stoplight): Stoplight uses Redis for
+  leader-less coordination in distributed environments to ensure coordinated states
+  transitions and recovery and offers a built-in Admin Panel while focusing on performance
+  by utilizing Lua scripts for the Redis data store which minimizes operational overhead.
 
 ### Previous Work
 
 - [circuit_breaker-ruby](https://github.com/scripbox/circuit_breaker-ruby) (no
   recent activity)
-- [stoplight](https://github.com/orgsync/stoplight) (unmaintained)
 - [circuit_breaker](https://github.com/wsargent/circuit_breaker) (no recent
 activity)
 - [simple_circuit_breaker](https://github.com/soundcloud/simple_circuit_breaker)

data/lib/faulty/cache/auto_wire.rb

@@ -37,8 +37,8 @@ class Faulty
         # @param cache [Interface] A cache backend
         # @param options [Hash] Attributes for {Options}
         # @yield [Options] For setting options in a block
-        def wrap(cache, **options, &block)
-          options = Options.new(options, &block)
+        def wrap(cache, **options, &)
+          options = Options.new(options, &)
           if cache.nil?
             Cache::Default.new
           elsif cache.fault_tolerant?

data/lib/faulty/cache/circuit_proxy.rb

@@ -40,9 +40,9 @@ class Faulty
       # @param cache [Cache::Interface] The cache backend to wrap
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(cache, **options, &block)
+      def initialize(cache, **options, &)
         @cache = cache
-        @options = Options.new(options, &block)
+        @options = Options.new(options, &)
       end
 
       %i[read write].each do |method|

data/lib/faulty/cache/fault_tolerant_proxy.rb

@@ -30,19 +30,19 @@ class Faulty
       # @param cache [Cache::Interface] The cache backend to wrap
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(cache, **options, &block)
+      def initialize(cache, **options, &)
         @cache = cache
-        @options = Options.new(options, &block)
+        @options = Options.new(options, &)
       end
 
       # Wrap a cache in a FaultTolerantProxy unless it's already fault tolerant
       #
       # @param cache [Cache::Interface] The cache to maybe wrap
       # @return [Cache::Interface] The original cache or a {FaultTolerantProxy}
-      def self.wrap(cache, **options, &block)
+      def self.wrap(cache, ...)
         return cache if cache.fault_tolerant?
 
-        new(cache, **options, &block)
+        new(cache, ...)
       end
 
       # Read from the cache safely

data/lib/faulty/circuit.rb

@@ -178,11 +178,11 @@ class Faulty
     # @param name [String] The name of the circuit
     # @param options [Hash] Attributes for {Options}
     # @yield [Options] For setting options in a block
-    def initialize(name, **options, &block)
+    def initialize(name, **options, &)
       raise ArgumentError, 'name must be a String' unless name.is_a?(String)
 
       @name = name
-      @given_options = Options.new(options, &block)
+      @given_options = Options.new(options, &)
       @pulled_options = nil
       @options_pushed = false
     end
@@ -266,8 +266,8 @@ class Faulty
     # @return [Result<Object, Error>] A result where the ok value is the return
     #   value of the block, or the error value is an error captured by the
     #   circuit.
-    def try_run(**options, &block)
-      Result.new(ok: run(**options, &block))
+    def try_run(...)
+      Result.new(ok: run(...))
     rescue FaultyError => e
       Result.new(error: e)
     end

data/lib/faulty/error.rb

@@ -8,7 +8,7 @@ class Faulty
   class UninitializedError < FaultyError
     def initialize(message = nil)
       message ||= 'Faulty is not initialized'
-      super(message)
+      super
     end
   end
 
@@ -16,7 +16,7 @@ class Faulty
   class AlreadyInitializedError < FaultyError
     def initialize(message = nil)
       message ||= 'Faulty is already initialized'
-      super(message)
+      super
     end
   end
 
@@ -24,7 +24,7 @@ class Faulty
   class MissingDefaultInstanceError < FaultyError
     def initialize(message = nil)
       message ||= 'No default instance. Create one with init or get your instance with Faulty[:name]'
-      super(message)
+      super
     end
   end
 

data/lib/faulty/events/log_listener.rb

@@ -10,8 +10,17 @@ class Faulty
       #   by default if available, otherwise it creates a new `Logger` to
       #   stderr.
       def initialize(logger = nil)
-        logger ||= defined?(Rails) ? Rails.logger : ::Logger.new($stderr)
-        @logger = logger
+        @logger = if logger
+          logger
+        elsif defined?(Rails)
+          Rails.logger
+        else
+          # Lazy-require so consumers who pass their own logger or use Rails
+          # don't need the stdlib `logger` gem on the load path. Required for
+          # Ruby >= 3.5 where `logger` was extracted from the default gems.
+          require 'logger'
+          ::Logger.new($stderr)
+        end
       end
 
       # (see ListenerInterface#handle)

data/lib/faulty/events/notifier.rb

@@ -22,11 +22,9 @@ class Faulty
         raise ArgumentError, "Unknown event #{event}" unless EVENTS.include?(event)
 
         @listeners.each do |listener|
-          begin
-            listener.handle(event, payload)
-          rescue StandardError => e
-            warn "Faulty listener #{listener.class.name} crashed: #{e.message}"
-          end
+          listener.handle(event, payload)
+        rescue StandardError => e
+          warn "Faulty listener #{listener.class.name} crashed: #{e.message}"
         end
       end
     end

data/lib/faulty/immutable_options.rb

@@ -5,12 +5,12 @@ class Faulty
   module ImmutableOptions
     # @param hash [Hash] A hash of attributes to initialize with
     # @yield [self] Yields itself to the block to set options before freezing
-    def initialize(hash, &block)
-      setup(defaults.merge(hash), &block)
+    def initialize(hash, &)
+      setup(defaults.merge(hash), &)
     end
 
-    def dup_with(hash, &block)
-      dup.setup(hash, &block)
+    def dup_with(hash, &)
+      dup.setup(hash, &)
     end
 
     def setup(hash)

data/lib/faulty/patch/base.rb

@@ -31,13 +31,13 @@ class Faulty
       #
       # @yield A block to run inside the circuit
       # @return The block return value
-      def faulty_run(&block)
+      def faulty_run(&)
         faulty_running_key = "faulty_running_#{object_id}"
         return yield unless @faulty_circuit
         return yield if Thread.current[faulty_running_key]
 
         Thread.current[faulty_running_key] = true
-        @faulty_circuit.run(&block)
+        @faulty_circuit.run(&)
       ensure
         Thread.current[faulty_running_key] = nil
       end

data/lib/faulty/patch/elasticsearch.rb

@@ -54,7 +54,7 @@ class Faulty
       }
 
       module Errors
-        PATCHED_MODULE::Transport::Transport::ERRORS.each do |_code, klass|
+        PATCHED_MODULE::Transport::Transport::ERRORS.each_value do |klass|
           MAPPED_ERRORS[klass] = const_set(klass.name.split('::').last, Module.new)
         end
       end
@@ -69,7 +69,7 @@ class Faulty
       end
       private_constant :ERROR_MAPPER, :MAPPED_ERRORS
 
-      def initialize(arguments = {}, &block)
+      def initialize(arguments = {}, &)
         super
 
         errors = [PATCHED_MODULE::Transport::Transport::Error]

data/lib/faulty/patch/redis/patch.rb

@@ -55,7 +55,7 @@ class Faulty
       #
       # The call* methods above will then raise that error, so we are able to
       # capture it with faulty_run.
-      def io(&block)
+      def io(&)
         return super unless @faulty_circuit
 
         reply = super

data/lib/faulty/patch.rb

@@ -75,7 +75,7 @@ class Faulty
       #   `:error_mapper`
       # @yield [Circuit::Options] For setting override options in a block
       # @return [Circuit, nil] The circuit if one was created
-      def circuit_from_hash(default_name, hash, **options, &block)
+      def circuit_from_hash(default_name, hash, **options, &)
         return unless hash
 
         hash = symbolize_keys(hash)
@@ -84,7 +84,7 @@ class Faulty
         error_mapper = options.delete(:patched_error_mapper)
         hash[:error_mapper] ||= error_mapper if error_mapper && patch_errors
         faulty = resolve_instance(hash.delete(:instance))
-        faulty.circuit(name, **hash, **options, &block)
+        faulty.circuit(name, **hash, **options, &)
       end
 
       # Create a full set of {CircuitError}s with a given base error class

data/lib/faulty/storage/auto_wire.rb

@@ -52,8 +52,8 @@ class Faulty
         #   of storage backends to setup.
         # @param options [Hash] Attributes for {Options}
         # @yield [Options] For setting options in a block
-        def wrap(storage, **options, &block)
-          options = Options.new(options, &block)
+        def wrap(storage, **options, &)
+          options = Options.new(options, &)
           if storage.nil?
             Memory.new
           elsif storage.is_a?(Array)

data/lib/faulty/storage/circuit_proxy.rb

@@ -40,9 +40,9 @@ class Faulty
       # @param storage [Storage::Interface] The storage backend to wrap
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(storage, **options, &block)
+      def initialize(storage, **options, &)
         @storage = storage
-        @options = Options.new(options, &block)
+        @options = Options.new(options, &)
       end
 
       %i[

data/lib/faulty/storage/fallback_chain.rb

@@ -42,9 +42,9 @@ class Faulty
       #   additional entries will be tried in sequence until one succeeds.
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(storages, **options, &block)
+      def initialize(storages, **options, &)
         @storages = storages
-        @options = Options.new(options, &block)
+        @options = Options.new(options, &)
       end
 
       # Get options from the first available storage backend
@@ -189,12 +189,10 @@ class Faulty
       def send_chain(method, *args)
         errors = []
         @storages.each do |s|
-          begin
-            return s.public_send(method, *args)
-          rescue StandardError => e
-            errors << e
-            yield e
-          end
+          return s.public_send(method, *args)
+        rescue StandardError => e
+          errors << e
+          yield e
         end
 
         raise AllFailedError.new("#{self.class}##{method} failed for all storage backends", errors)
@@ -211,11 +209,9 @@ class Faulty
       def send_all(method, *args)
         errors = []
         @storages.each do |s|
-          begin
-            s.public_send(method, *args)
-          rescue StandardError => e
-            errors << e
-          end
+          s.public_send(method, *args)
+        rescue StandardError => e
+          errors << e
         end
 
         if errors.empty?

data/lib/faulty/storage/fault_tolerant_proxy.rb

@@ -31,9 +31,9 @@ class Faulty
       # @param storage [Storage::Interface] The storage backend to wrap
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(storage, **options, &block)
+      def initialize(storage, **options, &)
         @storage = storage
-        @options = Options.new(options, &block)
+        @options = Options.new(options, &)
       end
 
       # Wrap a storage backend in a FaultTolerantProxy unless it's already
@@ -41,10 +41,10 @@ class Faulty
       #
       # @param storage [Storage::Interface] The storage to maybe wrap
       # @return [Storage::Interface] The original storage or a {FaultTolerantProxy}
-      def self.wrap(storage, **options, &block)
+      def self.wrap(storage, ...)
         return storage if storage.fault_tolerant?
 
-        new(storage, **options, &block)
+        new(storage, ...)
       end
 
       # @!method lock(circuit, state)

data/lib/faulty/storage/memory.rb

@@ -71,9 +71,9 @@ class Faulty
 
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(**options, &block)
+      def initialize(**options, &)
         @circuits = Concurrent::Map.new
-        @options = Options.new(options, &block)
+        @options = Options.new(options, &)
       end
 
       # Get the options stored for circuit

data/lib/faulty/storage/redis.rb

@@ -80,8 +80,8 @@ class Faulty
 
       # @param options [Hash] Attributes for {Options}
       # @yield [Options] For setting options in a block
-      def initialize(**options, &block)
-        @options = Options.new(options, &block)
+      def initialize(**options, &)
+        @options = Options.new(options, &)
 
         # Ensure JSON is available since we don't explicitly require it
         JSON # rubocop:disable Lint/Void
@@ -387,9 +387,9 @@ class Faulty
       #
       # @yield [Redis] Yields the connection to the block
       # @return The value returned from the block
-      def redis(&block)
+      def redis(&)
         if options.client.respond_to?(:with)
-          options.client.with(&block)
+          options.client.with(&)
         else
           yield options.client
         end

data/lib/faulty/version.rb

@@ -3,6 +3,6 @@
 class Faulty
   # The current Faulty version
   def self.version
-    Gem::Version.new('0.11.0')
+    Gem::Version.new('0.12.0')
   end
 end

data/lib/faulty.rb

@@ -41,12 +41,12 @@ class Faulty
     # @param config [Hash] Attributes for {Faulty::Options}
     # @yield [Faulty::Options] For setting options in a block
     # @return [self]
-    def init(default_name = :default, **config, &block)
+    def init(default_name = :default, **config, &)
       raise AlreadyInitializedError if @instances
 
       @default_instance = default_name
       @instances = Concurrent::Map.new
-      register(default_name, new(**config, &block)) unless default_name.nil?
+      register(default_name, new(**config, &)) unless default_name.nil?
       self
     rescue StandardError
       @instances = nil
@@ -110,8 +110,8 @@ class Faulty
     # @param (see Faulty#circuit)
     # @yield (see Faulty#circuit)
     # @return (see Faulty#circuit)
-    def circuit(name, **config, &block)
-      default.circuit(name, **config, &block)
+    def circuit(name, **config, &)
+      default.circuit(name, **config, &)
     end
 
     # Get a list of all circuit names for the default instance
@@ -236,8 +236,8 @@ class Faulty
   # @see Options
   # @param options [Hash] Attributes for {Options}
   # @yield [Options] For setting options in a block
-  def initialize(**options, &block)
-    @options = Options.new(options, &block)
+  def initialize(**options, &)
+    @options = Options.new(options, &)
     @registry = CircuitRegistry.new(circuit_options)
   end
 
@@ -252,9 +252,9 @@ class Faulty
   # @param options [Hash] Attributes for {Circuit::Options}
   # @yield [Circuit::Options] For setting options in a block
   # @return [Circuit] The new circuit or the existing circuit if it already exists
-  def circuit(name, **options, &block)
+  def circuit(name, **options, &)
     name = name.to_s
-    @registry.retrieve(name, options, &block)
+    @registry.retrieve(name, options, &)
   end
 
   # Get a list of all circuit names
@@ -285,7 +285,7 @@ class Faulty
   # @return [Hash] The circuit options
   def circuit_options
     @options.to_h
-      .select { |k, _v| %i[cache storage notifier].include?(k) }
+      .slice(:cache, :storage, :notifier)
       .merge(options.circuit_defaults)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Justin Howard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2026-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
 - jmhoward0@gmail.com
 executables: []
@@ -152,8 +152,8 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   changelog_uri: https://github.com/ParentSquare/faulty/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/faulty/0.11.0
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/faulty/0.12.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,15 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Fault-tolerance tools for ruby based on circuit-breakers
 test_files: []