sorbet_typed-short_circuit 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eac217ecd0ee520431efe864e122dfd5e27ea426e3041d57ef5d4ad17f735f3
-  data.tar.gz: 64c245c6e20806c1b8856d2cd071c49752d41ed88ae09b4652b3fc7581f44f83
+  metadata.gz: ef54af7b2d2c19ddea4ad8032de8dc0bac9f0897be33326492baf17c84b116da
+  data.tar.gz: 2abb0ab9abe6c95c38ceb991b754b0964f89d6f658145075b4a2afa5dcd00f4e
 SHA512:
-  metadata.gz: 54d29ca68e65bfb32d511d0f8f3cc17ec29ae45db1f575ef3e00c71ddcce3458186560605d6639c3f1c799001327ebb1ae14fdad5fddefb9e38b06431fcd91da
-  data.tar.gz: '0049e24a52c6bbbb8909aaf382408eb187c0824858dca534e6886a8652c59bb128c3cfc792d33cff1d34526c0d4d3b25cf4baa7189918ba50bc2d139f10068f3'
+  metadata.gz: 2b2d8c8940ff7ea7ef5dc94570005de6b5b57496dc0f60a3b40989e60671de0c0dc59e9cace3339ec6d12d10a353090e46ac71fbe037e2f27ee7c41be83adc5a
+  data.tar.gz: 518dc424888b0c2dde66b010fd2019736f8e7cca0619c1abb798a3739ad5b3df8af8c2b9842de2da7db9261de5d542e80b444c1a4be002c3740f0891d22f0c00

data/.cz.yaml

@@ -0,0 +1,20 @@
+---
+commitizen:
+  allowed_prefixes:
+    - fixup!
+    - squash!
+    - Merge
+    - Revert
+    - '[WIP]'
+  annotated_tag: true
+  name: cz_conventional_commits
+  pre_bump_hooks:
+    - mise x -- bundle install
+    - mise run update
+    - mise run format
+  tag_format: v$version
+  update_changelog_on_bump: true
+  version: 1.0.0
+  version_files:
+    - lib/sorbet_typed/short_circuit/version.rb
+  version_scheme: semver2

data/.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - hooks:
+      - id: commitizen
+      - id: commitizen-branch
+        stages:
+          - pre-push
+    repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.9.1

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## v1.0.0 (2025-11-07)
+
+### Feat
+
+- **CircuitBreaker**: allow public usage in signatures
+- **interface**: add specs and update interfaces
+- **renovate**: update CI matrix on lockFileMaintenance
+- **ci**: trigger renovate pipeline on default branch
+- **mise**: change default task output to "replacing"
+- **mise**: execute typecheck when running lint task
+- **renovate**: remove manual usage dependency declaration, as renovate seems to know it now
+- initial commit
+
+### Fix
+
+- **ci**: adjust job rules
+- **sorbet**: robust tapioca dsl update/verification + removal of unused DSL RBIs
+- **sorbet**: exclude local gem from RBI generation
+- **renovate**: group ci ruby version matrix upgrades
+- **ci**: run ruby version matrix validation only for merge request events
+- **ci**: generate ruby version matrix only for versions with valid docker images
+- **appraisals**: make appraisal gem versions always deterministic by tracking lock files and update them via renovate
+  lockFileMaintenance
+- **coverage**: explicitly track all relevant ruby files, even if they don't get required
+- **ci**: make pipeline jobs interruptible by default to support canceling redundant pipelines
+- **coverage**: enable coverage in CI and exclude temporary, untested code from coverage
+- **rubocop**: make it pass by disabling offenses on temporary code

data/lib/sorbet_typed/short_circuit/circuit_breaker/untyped_call.rb

@@ -1,13 +1,13 @@
 # typed: false # rubocop:disable Sorbet/HasSigil -- type for this gets defined by rbi/sorbet_typed/short_circuit/circuit_breaker.rbi
 # frozen_string_literal: true
 
-# HACK: monkey patching the circuit breaker to have an untyped call method. It's
-# signatures get provided by rbi/sorbet_typed/short_circuit/circuit_breaker.rbi
-# to support overloads.
-
 module SorbetTyped
   class ShortCircuit
-    class CircuitBreaker # rubocop:disable Style/Documentation -- documentation comment exists on the main implementation of this class
+    # HACK: monkey patching the circuit breaker to have an untyped call method. It's
+    # signatures get provided by rbi/sorbet_typed/short_circuit/circuit_breaker.rbi
+    # to support overloads.
+    # -- documentation comment exists on the main implementation of this class
+    class CircuitBreaker
       def call(result)
         case result
         when SorbetTyped::ShortCircuit::Signals::Shorted

data/lib/sorbet_typed/short_circuit/circuit_breaker.rb

@@ -3,6 +3,18 @@
 
 module SorbetTyped
   class ShortCircuit
+    # Module to be used in type signatures to allow passing CircuitBreaker
+    # instances around. This module is publicly available, in contrast to the
+    # CircuitBreaker class.
+    module CircuitBreakerType
+      extend T::Generic
+      extend T::Helpers
+
+      sealed!
+
+      ShortedResult = type_member
+    end
+
     # Callable implementing the logic to fail fast if the input is a Shorted
     # signal. To be used like Dry::Monads `yield foo` syntax.
     #
@@ -11,6 +23,8 @@ module SorbetTyped
       extend T::Sig
       extend T::Generic
 
+      include CircuitBreakerType
+
       ShortedResult = type_member
 
       private

data/lib/sorbet_typed/short_circuit/signals/shorted.rb

@@ -24,6 +24,7 @@ module SorbetTyped
         # and other low level ruby stuff.
         ########################################################################
         sig { params(klass: ::T::Class[::T.anything]).returns(::T::Boolean) }
+        # :reek:UtilityFunction -- because the class inherits from BasicObject, self.class cannot be used
         def is_a?(klass)
           klass == Shorted
         end
@@ -44,6 +45,11 @@ module SorbetTyped
         end
 
         sig { params(method_name: ::Symbol, _include_all: ::T::Boolean).returns(::T::Boolean) }
+        # :reek:BooleanParameter -- mirroring the respond_to? implementation
+        # from Object
+        #
+        # :reek:UtilityFunction -- this object responds to only one method. It's
+        # ok to not get it from instance state.
         def respond_to?(method_name, _include_all = false) # rubocop:disable Style/OptionalBooleanParameter -- mirroring the respond_to? implementation from Object
           method_name == :payload
         end

data/lib/sorbet_typed/short_circuit/version.rb

@@ -6,7 +6,7 @@
 # -- Disabled, because this file gets required in gemspec, where zeitwerk is not active
 module SorbetTyped
   class ShortCircuit
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end
 

data/lib/sorbet_typed/short_circuit.rb

@@ -91,25 +91,21 @@ module SorbetTyped
       self.short_circuited = false
       yield(CircuitBreaker[ShortedResult].new(circuit_id: object_id))
     rescue Errors::CircuitShorted => exception
-      # This ensures, the circuit can only be broken by a circuit shorted
-      # exception raised in it's own circuit breaker. Everything else is
-      # re-raised.
-      raise exception unless exception.circuit_id == object_id
-
-      self.short_circuited = true
-
-      # NOTE: sorbet is only able to detect
-      # `SorbetTyped::ShortCircuit::CircuitShortedError[T.anything]` in this
-      # rescue. But because it must come from `CircuitBreaker[ShortedResult]`,
-      # it will also always be
-      # `CircuitShortedError[SorbetTyped::ShortCircuit::Shorted[ShortedResult]]`.
-      # So we tell that to sorbet.
-      #
-      # Unfortunately, because sorbet erases generic types at runtime, this
-      # cannot be ensured at runtime. Type-safety is still ensured, because the
-      # error and circuit breaker classes are private and can neither be
-      # instantiated, thrown or rescued (coding "normally").
-      T.cast(exception, Errors::CircuitShorted[SorbetTyped::ShortCircuit::Signals::Shorted[ShortedResult]]).signal
+      handle_shorted_circuit(
+        shorted_exception:
+          # NOTE: sorbet is only able to detect
+          # `SorbetTyped::ShortCircuit::CircuitShortedError[T.anything]` in this
+          # rescue. But because it must come from `CircuitBreaker[ShortedResult]`,
+          # it will also always be
+          # `CircuitShortedError[SorbetTyped::ShortCircuit::Shorted[ShortedResult]]`.
+          # So we tell that to sorbet.
+          #
+          # Unfortunately, because sorbet erases generic types at runtime, this
+          # cannot be ensured at runtime. Type-safety is still ensured, because the
+          # error and circuit breaker classes are private and can neither be
+          # instantiated, thrown or rescued (coding "normally").
+          T.cast(exception, Errors::CircuitShorted[SorbetTyped::ShortCircuit::Signals::Shorted[ShortedResult]])
+      )
     end
 
     sig do
@@ -143,5 +139,24 @@ module SorbetTyped
     end
 
     # TODO: #success? method
+
+    private
+
+    sig do
+      params(
+        shorted_exception: Errors::CircuitShorted[SorbetTyped::ShortCircuit::Signals::Shorted[ShortedResult]]
+      ).
+        returns(Signals::Shorted[ShortedResult])
+    end
+    def handle_shorted_circuit(shorted_exception:)
+      # This ensures, the circuit can only be broken by a circuit shorted
+      # exception raised in it's own circuit breaker. Everything else is
+      # re-raised.
+      raise shorted_exception unless shorted_exception.circuit_id == object_id
+
+      self.short_circuited = true
+
+      shorted_exception.signal
+    end
   end
 end

data/rbi/sorbet_typed/short_circuit/circuit_breaker.rbi

@@ -2,12 +2,32 @@
 
 module SorbetTyped
   class ShortCircuit
+    module CircuitBreakerType
+      # NOTE: providing overloads here, because the possible input and output
+      # cases cannot be fully modeled using a single signature within the actual
+      # class.
+      sig { params(result: SorbetTyped::ShortCircuit::Signals::Shorted[ShortedResult]).returns(T.noreturn) }
+      sig do
+
+        type_parameters(:SuccessType).
+          params(
+            result: T.any(
+              SorbetTyped::ShortCircuit::Signals::Shorted[ShortedResult],
+              T.all(T.type_parameter(:SuccessType), Object)
+            )
+          ).
+          returns(T.all(T.type_parameter(:SuccessType), Object))
+      end
+      def call(result); end
+    end
+
     class CircuitBreaker
       # NOTE: providing overloads here, because the possible input and output
       # cases cannot be fully modeled using a single signature within the actual
       # class.
       sig { params(result: SorbetTyped::ShortCircuit::Signals::Shorted[ShortedResult]).returns(T.noreturn) }
       sig do
+
         type_parameters(:SuccessType).
           params(
             result: T.any(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet_typed-short_circuit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Kramer
@@ -36,7 +36,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".cz.yaml"
+- ".pre-commit-config.yaml"
 - ".shellcheckrc.tmp"
+- CHANGELOG.md
 - COPYING
 - README.md
 - lib/sorbet_typed/short_circuit.rb