Merge pull request #78 from ParentSquare/modernize

Release 0.12.0: modernize toolchain and CI matrix

Author: justinhoward

.github/workflows/ci.yml

@@ -12,30 +12,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0', jruby-head, truffleruby-head]
-        redis: ['4']
-        search: [['opensearch-ruby:2.1.0', 'opensearchproject/opensearch:2.2.1']]
+        ruby: ['3.1', '3.2', '3.3', '3.4', jruby-head, truffleruby-head]
+        redis: ['5']
+        search: [['opensearch-ruby:3.4.0', 'opensearchproject/opensearch:2.19.5']]
         include:
-          # Redis 3
-          - ruby: '2.7'
-            redis: '3'
-            search: ['opensearch-ruby:2.1.0', 'opensearchproject/opensearch:2.2.1']
-          # Opensearch 1.0
-          - ruby: '2.7'
+          # Redis 4
+          - ruby: '3.4'
             redis: '4'
-            search: ['opensearch-ruby:1.0.1', 'opensearchproject/opensearch:1.0.1']
-          # Elasticsearch 7.13
-          - ruby: '2.7'
-            redis: '4'
-            search: ['elasticsearch:7.13.3', 'elasticsearch:7.13.4']
-          # Redis 5
-          - ruby: '2.7'
+            search: ['opensearch-ruby:3.4.0', 'opensearchproject/opensearch:2.19.5']
+          # OpenSearch 3.x
+          - ruby: '3.4'
             redis: '5'
-            search: ['opensearch-ruby:2.1.0', 'opensearchproject/opensearch:2.2.1']
-          # Ruby 2.3 & Elasticsearch 7.5
-          - ruby: '2.3'
-            redis: '4'
-            search: ['elasticsearch:7.5.0', 'elasticsearch:7.13.4']
+            search: ['opensearch-ruby:3.4.0', 'opensearchproject/opensearch:3.0.0']
+          # Elasticsearch 7.17 (last release of the pre-8 transport API
+          # that the Faulty patch currently targets). ES 8+ moves the
+          # transport into the `elastic-transport` gem under
+          # `Elastic::Transport`, which the patch does not yet support.
+          - ruby: '3.4'
+            redis: '5'
+            search: ['elasticsearch:7.17.11', 'elasticsearch:7.17.28']
     services:
       redis:
         image: redis
@@ -48,6 +43,13 @@ jobs:
         env:
           discovery.type: single-node
           plugins.security.disabled: ${{ contains(matrix.search[1], 'opensearch') && 'true' || '' }}
+          xpack.security.enabled: ${{ contains(matrix.search[1], 'elasticsearch') && 'false' || '' }}
+          # OpenSearch 2.12+ requires an initial admin password for the
+          # security demo installer (which still runs even with
+          # `plugins.security.disabled=true`). Skip the demo config
+          # entirely so we don't have to set a placeholder password.
+          # Older OpenSearch and all Elasticsearch images ignore this.
+          DISABLE_INSTALL_DEMO_CONFIG: 'true'
         options: >-
           --health-cmd="curl http://localhost:9200/_cluster/health"
           --health-interval=3s
@@ -59,7 +61,7 @@ jobs:
       SEARCH_GEM: ${{ matrix.search[0] }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -70,39 +72,39 @@ jobs:
         env:
           MYSQL_USER: root
           MYSQL_PASSWORD: root
-      - uses: codecov/codecov-action@v3
-        if: matrix.ruby == '2.7'
+      - uses: codecov/codecov-action@v5
+        if: matrix.ruby == '3.4'
         with:
           files: coverage/coverage.xml
 
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7'
+          ruby-version: '3.4'
           bundler-cache: true
       - run: bundle exec rubocop
 
   yard:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7'
+          ruby-version: '3.4'
           bundler-cache: true
       - run: bin/yardoc --fail-on-warning
 
   check_version:
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/v')
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7'
+          ruby-version: '3.4'
           bundler-cache: true
       - run: bin/check-version
 
@@ -111,7 +113,7 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: dawidd6/action-publish-gem@v1
         with:
           api_key: ${{secrets.RUBYGEMS_API_KEY}}

.rubocop.yml

@@ -1,11 +1,16 @@
 ---
-require:
+plugins:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
 
 Gemspec/DeprecatedAttributeAssignment: { Enabled: true }
+# Faulty intentionally keeps essential dev deps in the gemspec; the rest
+# live in the Gemfile (per the comment in faulty.gemspec).
+Gemspec/DevelopmentDependencies: { Enabled: false }
 Gemspec/RequireMFA: { Enabled: true }
 
 Layout/ArgumentAlignment: { EnforcedStyle: with_fixed_indentation }
@@ -54,19 +59,22 @@ Lint/UselessRuby2Keywords: { Enabled: true }
 
 RSpec/BeEq: { Enabled: true }
 RSpec/BeNil: { Enabled: true }
-RSpec/Capybara/SpecificMatcher: { Enabled: true }
 RSpec/ChangeByZero: { Enabled: true }
 RSpec/ExampleLength: { Enabled: false }
 RSpec/ExcessiveDocstringSpacing: { Enabled: true }
-RSpec/FactoryBot/SyntaxMethods: { Enabled: true }
-RSpec/FilePath: { Enabled: false }
 RSpec/IdenticalEqualityAssertion: { Enabled: true }
+# auto_wire_spec deliberately exercises wiring multiple instances of the
+# same backend, where numeric suffixes (storage1/storage2) read clearer
+# than any contrived semantic name.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/storage/auto_wire_spec.rb'
 RSpec/MessageSpies: { Enabled: false }
 RSpec/MultipleExpectations: { Enabled: false }
 RSpec/MultipleMemoizedHelpers: { Enabled: false }
 RSpec/NamedSubject: { Enabled: false }
-RSpec/Rails/AvoidSetupHook: { Enabled: true }
-RSpec/Rails/HaveHttpStatus: { Enabled: true }
+RSpec/SpecFilePathFormat: { Enabled: false }
+RSpec/SpecFilePathSuffix: { Enabled: false }
 RSpec/SubjectDeclaration: { Enabled: true }
 RSpec/SubjectStub: { Enabled: false }
 RSpec/VerifiedDoubleReference: { Enabled: true }
@@ -80,6 +88,12 @@ Metrics/PerceivedComplexity: { Enabled: false }
 
 Naming/BlockForwarding: { Enabled: true }
 Naming/MethodParameterName: { MinNameLength: 1 }
+# Storage interface methods like #open / #close / #reopen are imperative
+# actions, not predicates — they happen to return a boolean to indicate
+# success. Renaming them would break the public Storage::Interface contract.
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/faulty/storage/**/*.rb'
 
 Security/CompoundHash: { Enabled: true }
 Security/IoMethods: { Enabled: true }
@@ -115,6 +129,11 @@ Style/NilLambda: { Enabled: true }
 Style/NumberedParameters: { Enabled: true }
 Style/NumberedParametersLimit: { Enabled: true }
 Style/ObjectThen: { Enabled: true }
+# Patch files monkey-patch upstream constants (Redis, Mysql2) and so
+# necessarily reopen multiple top-level modules in the same file.
+Style/OneClassPerFile:
+  Exclude:
+    - 'lib/faulty/patch/**/*.rb'
 Style/OpenStructUse: { Enabled: true }
 Style/QuotedSymbols: { Enabled: true }
 Style/RedundantArgument: { Enabled: true }

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
 ---------------------
 

Gemfile

@@ -8,28 +8,27 @@ gemspec
 # here. This also allows us to use conditional dependencies that depend on the
 # platform
 
-not_jruby = %i[ruby mingw x64_mingw].freeze
+not_jruby = %i[ruby windows].freeze
 
 gem 'activesupport', '>= 4.2'
 gem 'byebug', platforms: not_jruby
+gem 'honeybadger', '>= 2.0'
 gem 'irb', '~> 1.0'
+# stdlib `logger` became a bundled gem in Ruby 3.5. The runtime only needs
+# it when the default LogListener actually constructs a Logger; we pull it
+# in here so the test suite and `bin/benchmark` boot the default Faulty
+# pipeline without forcing it on consumers who supply their own listeners.
+gem 'logger'
 # Minimum of 0.5.0 for specific error classes
 gem 'mysql2', '>= 0.5.0', platforms: not_jruby
 gem 'redcarpet', '~> 3.5', platforms: not_jruby
 gem 'rspec_junit_formatter', '~> 0.4'
+gem 'rubocop', '~> 1.84'
+gem 'rubocop-rspec', '~> 3.9'
+gem 'simplecov', '>= 0.17.1'
+gem 'simplecov-cobertura', '~> 3.1'
 gem 'yard', '~> 0.9.25', platforms: not_jruby
 
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4')
-  gem 'honeybadger', '>= 2.0'
-end
-
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
-  gem 'rubocop', '~> 1.32.0'
-  gem 'rubocop-rspec', '~> 2.12'
-  gem 'simplecov', '>= 0.17.1'
-  gem 'simplecov-cobertura', '~> 2.1'
-end
-
 if ENV['REDIS_VERSION']
   gem 'redis', "~> #{ENV['REDIS_VERSION']}"
 end
@@ -39,5 +38,5 @@ if ENV['SEARCH_GEM']
   name = 'opensearch-ruby' if name == 'opensearch'
   gem name, "~> #{version}"
 else
-  gem 'opensearch-ruby', '~> 2.1'
+  gem 'opensearch-ruby', '~> 3.4'
 end

bin/benchmark

@@ -18,11 +18,9 @@ Benchmark.bm(width) do |b|
 
   b.report('memory storage failures') do
     n.times do
-      begin
-        in_memory.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
-      rescue StandardError
-        # Expected to raise here
-      end
+      in_memory.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
+    rescue StandardError
+      # Expected to raise here
     end
   end
 
@@ -42,11 +40,9 @@ Benchmark.bm(width) do |b|
 
   b.report('redis storage failures') do
     n.times do
-      begin
-        redis.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
-      rescue StandardError
-        # Expected to raise here
-      end
+      redis.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
+    rescue StandardError
+      # Expected to raise here
     end
   end
 

faulty.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.files = Dir['lib/**/*.rb', '*.md', '*.txt', '.yardopts']
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 3.1'
 
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
 
   # Only essential development tools and dependencies go here.
   # Other non-essential development dependencies go in the Gemfile.

lib/faulty.rb

@@ -41,12 +41,12 @@ class << self
     # @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 @@ def options
     # @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 @@ def defaults
   # @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 @@ def initialize(**options, &block)
   # @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 @@ def clear!
   # @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