solid-result 2.0.0

data/sig/solid/result/expectations.rbs

@@ -0,0 +1,71 @@
+class Solid::Result::Expectations
+  def self.mixin: (
+    ?config: Hash[Symbol, Hash[Symbol, bool]],
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol]
+  ) -> Module
+
+  def self.mixin!: (
+    ?config: Hash[Symbol, Hash[Symbol, bool]],
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol]
+  ) -> Module
+
+  def self.mixin_module: -> singleton(Solid::Result::Expectations::Mixin)
+
+  def self.result_factory_without_expectations: -> singleton(Solid::Result)
+
+  def self.new: (
+    ?source: untyped,
+    ?contract: Solid::Result::Contract::Evaluator,
+    ?terminal: bool,
+    **untyped
+  ) -> (Solid::Result::Expectations | untyped)
+
+  def initialize: (
+    ?source: untyped,
+    ?contract: Solid::Result::Contract::Evaluator,
+    ?terminal: bool,
+    **untyped
+  ) -> void
+
+  def Success: (Symbol, ?untyped) -> Solid::Result::Success
+  def Failure: (Symbol, ?untyped) -> Solid::Result::Failure
+
+  def with: (source: untyped) -> Solid::Result::Expectations
+
+  private
+
+  def _ResultAs: (singleton(Solid::Result), Symbol, untyped) -> untyped
+
+  attr_reader source: untyped
+  attr_reader contract: Solid::Result::Contract::Evaluator
+  attr_reader terminal: bool
+end
+
+module Solid::Result::Expectations::Mixin
+  module Factory
+    def self.module!: -> Module
+  end
+
+  module Methods
+    BASE: String
+    FACTORY: String
+
+    def self.to_eval: (Hash[Symbol, untyped]) -> String
+  end
+
+  module Addons
+    module Continue
+      private def Continue: (untyped) -> Solid::Result::Success
+    end
+
+    module Given
+      private def Given: (untyped) -> Solid::Result::Success
+    end
+
+    OPTIONS: Hash[Symbol, Module]
+
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
+  end
+end

data/sig/solid/result/handler.rbs

@@ -0,0 +1,47 @@
+class Solid::Result
+  class Handler
+    UNDEFINED: Object
+
+    def initialize: (
+      Solid::Result,
+      type_checker: Solid::Result::Contract::TypeChecker
+    ) -> void
+
+    def []: (*Symbol) { (untyped, Symbol) -> void } -> untyped
+    def failure: (*Symbol) { (untyped, Symbol) -> void } -> untyped
+    def success: (*Symbol) { (untyped, Symbol) -> void } -> untyped
+    def unknown: () { (untyped, Symbol) -> void } -> untyped
+
+    alias type []
+
+    private
+
+    attr_reader result: Solid::Result
+    attr_reader allowed_types: Solid::Result::Handler::AllowedTypes
+
+    def outcome?: -> bool
+    def outcome=: (Proc) -> void
+    def outcome: -> untyped
+  end
+end
+
+class Solid::Result::Handler
+  class AllowedTypes
+    attr_reader unchecked: Set[Symbol]
+    attr_reader type_checker: Solid::Result::Contract::TypeChecker
+
+    def initialize: (
+      Solid::Result::Contract::TypeChecker
+    ) -> void
+
+    def allow?: (Array[Symbol]) -> bool
+    def allow_success?: (Array[Symbol]) -> bool
+    def allow_failure?: (Array[Symbol]) -> bool
+
+    def all_checked?: -> bool
+
+    private
+
+    def check!: (Array[Symbol], bool) -> bool
+  end
+end

data/sig/solid/result/ignored_types.rbs

@@ -0,0 +1,9 @@
+class Solid::Result
+  module IgnoredTypes
+    LIST: ::Set[::Symbol]
+    GIVEN: ::Symbol
+    CONTINUE: ::Symbol
+
+    def self.include?: (::Symbol) -> bool
+  end
+end

data/sig/solid/result/mixin.rbs

@@ -0,0 +1,45 @@
+class Solid::Result
+  module Mixin
+    module Factory
+      def self.module!: -> Module
+    end
+
+    module Methods
+      def Success: (Symbol type, ?untyped value) -> Solid::Result::Success
+
+      def Failure: (Symbol type, ?untyped value) -> Solid::Result::Failure
+
+      private
+
+      def _ResultAs: (singleton(Solid::Result), Symbol, untyped, ?terminal: bool) -> untyped
+    end
+
+    module Addons
+      module Continue
+        include Solid::Result::Mixin::Methods
+
+        private
+
+        def Continue: (untyped) -> Solid::Result::Success
+      end
+
+      module Given
+        include Solid::Result::Mixin::Methods
+
+        private
+
+        def Given: (untyped) -> Solid::Result::Success
+      end
+
+      OPTIONS: Hash[Symbol, Module]
+
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
+    end
+  end
+
+  def self.mixin: (?config: Hash[Symbol, Hash[Symbol, bool]]) -> Module
+
+  def self.mixin_module: -> singleton(Solid::Result::Mixin)
+
+  def self.result_factory: -> singleton(Solid::Result)
+end

data/sig/solid/result/version.rbs

@@ -0,0 +1,5 @@
+module Solid
+  class Result
+    VERSION: String
+  end
+end

data/sig/solid/result.rbs

@@ -0,0 +1,85 @@
+class Solid::Result
+  private attr_accessor unknown: bool
+  private attr_writer event_logs: Hash[Symbol, untyped]
+  private attr_reader type_checker: Solid::Result::Contract::TypeChecker
+
+  attr_reader data: Solid::Result::Data
+  attr_reader source: untyped
+  attr_reader terminal: bool
+  attr_reader event_logs: Hash[Symbol, untyped]
+
+  def self.config: -> Solid::Result::Config
+  def self.configuration: (freeze: bool) { (Solid::Result::Config) -> void } -> (bool | Solid::Result::Config)
+  def self.event_logs: (name: untyped, desc: untyped) { () -> untyped } -> Solid::Result
+
+  def initialize: (
+    type: Symbol,
+    value: untyped,
+    ?source: untyped,
+    ?expectations: Solid::Result::Contract::Evaluator,
+    ?terminal: bool
+  ) -> void
+
+  def type: -> Symbol
+  def value: -> untyped
+
+  def type?: (Symbol | String) -> bool
+  def terminal?: -> bool
+  def success?: (?Symbol type) -> bool
+  def failure?: (?Symbol type) -> bool
+
+  def value_or: { () -> untyped } -> untyped
+
+  def on: (*Symbol) { (untyped, Symbol) -> void } -> Solid::Result
+  def on_success: (*Symbol) { (untyped, Symbol) -> void } -> Solid::Result
+  def on_failure: (*Symbol) { (untyped, Symbol) -> void } -> Solid::Result
+  def on_unknown: () { (untyped, Symbol) -> void } -> Solid::Result
+
+  def and_then: (?Symbol method_name, ?untyped injected_value) ?{ (untyped) -> untyped } -> untyped
+
+  def and_then!: (untyped, ?untyped injected_value, _call: (Symbol | nil)) -> untyped
+
+  def handle: () { (Solid::Result::Handler) -> void } -> untyped
+
+  def ==: (untyped) -> bool
+  def hash: -> Integer
+  def inspect: -> String
+
+  def deconstruct: -> [Symbol, [Symbol, untyped]]
+  def deconstruct_keys: (Array[Symbol]) -> Hash[Symbol, Hash[Symbol, untyped]]
+
+  TYPE_AND_VALUE: Array[Symbol]
+
+  def method_missing: (Symbol, *untyped) { (untyped) -> untyped } -> untyped
+
+  alias is? type?
+  alias eql? ==
+  alias on_type on
+
+  private
+
+  def kind: -> Symbol
+  def known: (Proc) -> untyped
+  def call_and_then_source_method: (Symbol, untyped) -> Solid::Result
+  def call_and_then_source_method!: (untyped, untyped) -> Solid::Result
+  def call_and_then_block: (untyped) -> Solid::Result
+  def call_and_then_block!: (untyped) -> Solid::Result
+  def call_and_then_callable!: (untyped, value: untyped, injected_value: untyped, method_name: (Symbol | nil)) -> Solid::Result
+  def ensure_result_object: (untyped, origin: Symbol) -> Solid::Result
+end
+
+class Solid::Result
+  class Success < Solid::Result
+    include Solid::Success
+  end
+
+  def self.Success: (Symbol type, ?untyped value) -> Solid::Result::Success
+end
+
+class Solid::Result
+  class Failure < Solid::Result
+    include Solid::Failure
+  end
+
+  def self.Failure: (Symbol type, ?untyped value) -> Solid::Result::Failure
+end

data/sig/solid/success.rbs

@@ -0,0 +1,13 @@
+module Solid
+  module Success
+    def success?: (?Symbol type) -> bool
+    def failure?: (?Symbol type) -> bool
+    def value_or: { () -> untyped } -> untyped
+    def value: -> untyped
+
+    private
+
+    def kind: -> Symbol
+    def type_checker: -> Solid::Result::Contract::TypeChecker
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: solid-result
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Rodrigo Serradura
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-14 00:00:00.000000000 Z
+dependencies: []
+description: Unleash a pragmatic and observable use of Result Pattern and Railway-Oriented
+  Programming in Ruby.
+email:
+- rodrigo.serradura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- examples/multiple_listeners/Rakefile
+- examples/multiple_listeners/app/models/account.rb
+- examples/multiple_listeners/app/models/account/member.rb
+- examples/multiple_listeners/app/models/account/owner_creation.rb
+- examples/multiple_listeners/app/models/user.rb
+- examples/multiple_listeners/app/models/user/creation.rb
+- examples/multiple_listeners/app/models/user/token.rb
+- examples/multiple_listeners/app/models/user/token/creation.rb
+- examples/multiple_listeners/config.rb
+- examples/multiple_listeners/config/boot.rb
+- examples/multiple_listeners/config/initializers/solid_result.rb
+- examples/multiple_listeners/db/setup.rb
+- examples/multiple_listeners/lib/event_logs_listener/stdout.rb
+- examples/multiple_listeners/lib/runtime_breaker.rb
+- examples/multiple_listeners/lib/solid/result/event_logs_record.rb
+- examples/multiple_listeners/lib/solid/result/rollback_on_failure.rb
+- examples/service_objects/Rakefile
+- examples/service_objects/app/models/account.rb
+- examples/service_objects/app/models/account/member.rb
+- examples/service_objects/app/models/user.rb
+- examples/service_objects/app/models/user/token.rb
+- examples/service_objects/app/services/account/owner_creation.rb
+- examples/service_objects/app/services/application_service.rb
+- examples/service_objects/app/services/user/creation.rb
+- examples/service_objects/app/services/user/token/creation.rb
+- examples/service_objects/config.rb
+- examples/service_objects/config/boot.rb
+- examples/service_objects/config/initializers/solid_result.rb
+- examples/service_objects/db/setup.rb
+- examples/single_listener/Rakefile
+- examples/single_listener/app/models/account.rb
+- examples/single_listener/app/models/account/member.rb
+- examples/single_listener/app/models/account/owner_creation.rb
+- examples/single_listener/app/models/user.rb
+- examples/single_listener/app/models/user/creation.rb
+- examples/single_listener/app/models/user/token.rb
+- examples/single_listener/app/models/user/token/creation.rb
+- examples/single_listener/config.rb
+- examples/single_listener/config/boot.rb
+- examples/single_listener/config/initializers/solid_result.rb
+- examples/single_listener/db/setup.rb
+- examples/single_listener/lib/runtime_breaker.rb
+- examples/single_listener/lib/single_event_logs_listener.rb
+- examples/single_listener/lib/solid/result/rollback_on_failure.rb
+- lib/solid-result.rb
+- lib/solid/failure.rb
+- lib/solid/output.rb
+- lib/solid/output/callable_and_then.rb
+- lib/solid/output/expectations.rb
+- lib/solid/output/expectations/mixin.rb
+- lib/solid/output/failure.rb
+- lib/solid/output/mixin.rb
+- lib/solid/output/success.rb
+- lib/solid/result.rb
+- lib/solid/result/_self.rb
+- lib/solid/result/callable_and_then.rb
+- lib/solid/result/callable_and_then/caller.rb
+- lib/solid/result/callable_and_then/config.rb
+- lib/solid/result/callable_and_then/error.rb
+- lib/solid/result/config.rb
+- lib/solid/result/config/options.rb
+- lib/solid/result/config/switcher.rb
+- lib/solid/result/config/switchers/addons.rb
+- lib/solid/result/config/switchers/constant_aliases.rb
+- lib/solid/result/config/switchers/features.rb
+- lib/solid/result/config/switchers/pattern_matching.rb
+- lib/solid/result/contract.rb
+- lib/solid/result/contract/disabled.rb
+- lib/solid/result/contract/error.rb
+- lib/solid/result/contract/evaluator.rb
+- lib/solid/result/contract/for_types.rb
+- lib/solid/result/contract/for_types_and_values.rb
+- lib/solid/result/contract/interface.rb
+- lib/solid/result/contract/type_checker.rb
+- lib/solid/result/data.rb
+- lib/solid/result/error.rb
+- lib/solid/result/event_logs.rb
+- lib/solid/result/event_logs/config.rb
+- lib/solid/result/event_logs/listener.rb
+- lib/solid/result/event_logs/listeners.rb
+- lib/solid/result/event_logs/tracking.rb
+- lib/solid/result/event_logs/tracking/disabled.rb
+- lib/solid/result/event_logs/tracking/enabled.rb
+- lib/solid/result/event_logs/tree.rb
+- lib/solid/result/expectations.rb
+- lib/solid/result/expectations/mixin.rb
+- lib/solid/result/failure.rb
+- lib/solid/result/handler.rb
+- lib/solid/result/handler/allowed_types.rb
+- lib/solid/result/ignored_types.rb
+- lib/solid/result/mixin.rb
+- lib/solid/result/success.rb
+- lib/solid/result/version.rb
+- lib/solid/success.rb
+- sig/solid/failure.rbs
+- sig/solid/output.rbs
+- sig/solid/result.rbs
+- sig/solid/result/callable_and_then.rbs
+- sig/solid/result/config.rbs
+- sig/solid/result/contract.rbs
+- sig/solid/result/data.rbs
+- sig/solid/result/error.rbs
+- sig/solid/result/event_logs.rbs
+- sig/solid/result/expectations.rbs
+- sig/solid/result/handler.rbs
+- sig/solid/result/ignored_types.rbs
+- sig/solid/result/mixin.rbs
+- sig/solid/result/version.rbs
+- sig/solid/success.rbs
+homepage: https://github.com/solid-process/solid-result
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/solid-process/solid-result
+  source_code_uri: https://github.com/solid-process/solid-result
+  changelog_uri: https://github.com/solid-process/solid-result/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Unleash a pragmatic and observable use of Result Pattern and Railway-Oriented
+  Programming in Ruby.
+test_files: []