bcdd-result 0.9.1 → 0.11.0

data/lib/bcdd/result.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'result/version'
+require_relative 'result/transitions'
 require_relative 'result/error'
 require_relative 'result/data'
 require_relative 'result/handler'
@@ -13,13 +14,13 @@ require_relative 'result/context'
 require_relative 'result/config'
 
 class BCDD::Result
-  attr_accessor :unknown
+  attr_accessor :unknown, :transitions
 
-  attr_reader :subject, :data, :type_checker, :halted
+  attr_reader :subject, :data, :type_checker, :terminal
 
   protected :subject
 
-  private :unknown, :unknown=, :type_checker
+  private :unknown, :unknown=, :type_checker, :transitions=
 
   def self.config
     Config.instance
@@ -31,19 +32,22 @@ class BCDD::Result
     config.freeze
   end
 
-  def initialize(type:, value:, subject: nil, expectations: nil, halted: nil)
+  def initialize(type:, value:, subject: nil, expectations: nil, terminal: nil)
     data = Data.new(kind, type, value)
 
     @type_checker = Contract.evaluate(data, expectations)
     @subject = subject
-    @halted = halted || kind == :failure
+    @terminal = terminal || kind == :failure
     @data = data
 
     self.unknown = true
+    self.transitions = Transitions::Tracking::EMPTY
+
+    Transitions.tracking.record(self)
   end
 
-  def halted?
-    halted
+  def terminal?
+    terminal
   end
 
   def type
@@ -85,7 +89,7 @@ class BCDD::Result
   end
 
   def and_then(method_name = nil, context = nil, &block)
-    return self if halted?
+    return self if terminal?
 
     method_name && block and raise ::ArgumentError, 'method_name and block are mutually exclusive'
 
@@ -135,28 +139,35 @@ class BCDD::Result
     block.call(value, type)
   end
 
-  def call_and_then_subject_method(method_name, context)
+  def call_and_then_subject_method(method_name, context_data)
     method = subject.method(method_name)
 
-    result =
-      case method.arity
-      when 0 then subject.send(method_name)
-      when 1 then subject.send(method_name, value)
-      when 2 then subject.send(method_name, value, context)
-      else raise Error::InvalidSubjectMethodArity.build(subject: subject, method: method, max_arity: 2)
-      end
+    Transitions.tracking.record_and_then(method, context_data, subject) do
+      result = call_and_then_subject_method!(method, context_data)
 
-    ensure_result_object(result, origin: :method)
+      ensure_result_object(result, origin: :method)
+    end
   end
 
-  def call_and_then_block(block)
-    call_and_then_block!(block, value)
+  def call_and_then_subject_method!(method, context_data)
+    case method.arity
+    when 0 then subject.send(method.name)
+    when 1 then subject.send(method.name, value)
+    when 2 then subject.send(method.name, value, context_data)
+    else raise Error::InvalidSubjectMethodArity.build(subject: subject, method: method, max_arity: 2)
+    end
   end
 
-  def call_and_then_block!(block, value)
-    result = block.call(value)
+  def call_and_then_block(block)
+    Transitions.tracking.record_and_then(:block, nil, subject) do
+      result = call_and_then_block!(block)
+
+      ensure_result_object(result, origin: :block)
+    end
+  end
 
-    ensure_result_object(result, origin: :block)
+  def call_and_then_block!(block)
+    block.call(value)
   end
 
   def ensure_result_object(result, origin:)

data/sig/bcdd/result/config.rbs

@@ -0,0 +1,101 @@
+class BCDD::Result::Config
+  include Singleton
+
+  ADDON: Hash[Symbol, Hash[Symbol, untyped]]
+  FEATURE: Hash[Symbol, Hash[Symbol, untyped]]
+  PATTERN_MATCHING: Hash[Symbol, Hash[Symbol, untyped]]
+
+  attr_reader addon: BCDD::Result::Config::Switcher
+  attr_reader feature: BCDD::Result::Config::Switcher
+  attr_reader constant_alias: BCDD::Result::Config::Switcher
+  attr_reader pattern_matching: BCDD::Result::Config::Switcher
+
+  def self.instance: -> BCDD::Result::Config
+
+  def initialize: -> void
+
+  def freeze: -> BCDD::Result::Config
+  def options: -> Hash[Symbol, BCDD::Result::Config::Switcher]
+  def to_h: -> Hash[Symbol, Hash[Symbol | String, bool]]
+end
+
+module BCDD::Result::Config::Options
+  def self.with_defaults: (
+    Hash[Symbol, Hash[Symbol, bool]],
+    Symbol
+  ) -> Hash[Symbol, bool]
+
+  def self.select: (
+    Hash[Symbol, Hash[Symbol, bool]],
+    config: Symbol,
+    from: Hash[Symbol, untyped]
+  ) -> Hash[Symbol, untyped]
+
+  def self.addon: (
+    map: Hash[Symbol, Hash[Symbol, bool]],
+    from: Hash[Symbol, Module]
+  ) -> Hash[Symbol, Module]
+end
+
+class BCDD::Result::Config::Switcher
+  private attr_reader _affects: Hash[Symbol | String, Array[String]]
+  private attr_reader _options: Hash[Symbol | String, bool]
+  private attr_reader listener: Proc
+
+  def initialize: (
+    options: Hash[Symbol | String, Hash[Symbol, untyped]],
+    ?listener: Proc
+  ) -> void
+
+  def freeze: -> BCDD::Result::Config::Switcher
+
+  def to_h: -> Hash[Symbol | String, bool]
+
+  def options: -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  def enabled?: (Symbol | String) -> bool
+
+  def enable!: (*(Symbol | String)) -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  def disable!: (*(Symbol | String)) -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  private
+
+  def set_many: (Array[Symbol | String], to: bool) -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  def set_one: (Symbol | String, bool) -> void
+
+  def require_option!: (Array[Symbol | String]) -> void
+
+  def validate_option!: (Symbol | String) -> void
+
+  def available_options_message: -> String
+end
+
+module BCDD::Result::Config::Addons
+  AFFECTS: Array[String]
+  OPTIONS: Hash[String, Hash[Symbol, untyped]]
+
+  def self.switcher: -> BCDD::Result::Config::Switcher
+end
+
+module BCDD::Result::Config::ConstantAliases
+  MAPPING: Hash[String, Hash[Symbol, untyped]]
+  OPTIONS: Hash[String, Hash[Symbol, untyped]]
+  Listener: Proc
+
+  def self.switcher: -> BCDD::Result::Config::Switcher
+end
+
+module BCDD::Result::Config::Features
+  OPTIONS: Hash[String, Hash[Symbol, untyped]]
+  Listener: Proc
+
+  def self.switcher: -> BCDD::Result::Config::Switcher
+end
+
+module BCDD::Result::Config::PatternMatching
+  OPTIONS: Hash[String, Hash[Symbol, untyped]]
+
+  def self.switcher: -> BCDD::Result::Config::Switcher
+end

data/sig/bcdd/result/context.rbs

@@ -0,0 +1,114 @@
+class BCDD::Result::Context < BCDD::Result
+  EXPECTED_OUTCOME: String
+
+  SubjectMethodArity: ^(Method) -> Integer
+
+  attr_reader acc: Hash[Symbol, untyped]
+
+  def initialize: (
+    type: Symbol,
+    value: untyped,
+    ?subject: untyped,
+    ?expectations: BCDD::Result::Contract::Evaluator,
+    ?terminal: bool
+  ) -> void
+
+  def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> BCDD::Result::Context
+
+  private
+
+  def call_and_then_subject_method: (Symbol, Hash[Symbol, untyped]) -> BCDD::Result::Context
+  def ensure_result_object: (untyped, origin: Symbol) -> BCDD::Result::Context
+
+  def raise_unexpected_outcome_error: (BCDD::Result::Context | untyped, Symbol) -> void
+end
+
+class BCDD::Result::Context
+  class Success < BCDD::Result::Context
+    include BCDD::Result::Success::Methods
+
+    def and_expose: (Symbol, Array[Symbol], terminal: bool) -> BCDD::Result::Context::Success
+  end
+
+  def self.Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
+end
+
+class BCDD::Result::Context
+  class Failure < BCDD::Result::Context
+    include BCDD::Result::Failure::Methods
+
+    def and_expose: (Symbol, Array[Symbol], **untyped) -> BCDD::Result::Context::Failure
+  end
+
+  def self.Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
+end
+
+class BCDD::Result::Context
+  module Mixin
+    Factory: singleton(BCDD::Result::Mixin::Factory)
+
+    module Methods
+      def Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
+
+      def Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
+
+      private
+
+      def _ResultAs: (singleton(BCDD::Result::Context), Symbol, untyped, ?terminal: bool) -> untyped
+    end
+
+    module Addons
+      module Continue
+        include BCDD::Result::Context::Mixin::Methods
+
+        private
+
+        def Continue: (**untyped) -> BCDD::Result::Context::Success
+      end
+
+      module Given
+        include BCDD::Result::Context::Mixin::Methods
+
+        private
+
+        def Given: (*untyped) -> BCDD::Result::Context::Success
+      end
+
+      OPTIONS: Hash[Symbol, Module]
+
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
+    end
+  end
+
+  def self.mixin_module: -> singleton(BCDD::Result::Context::Mixin)
+
+  def self.result_factory: -> singleton(BCDD::Result::Context)
+end
+
+class BCDD::Result::Context::Expectations < BCDD::Result::Expectations
+  def self.mixin_module: -> singleton(BCDD::Result::Context::Expectations::Mixin)
+
+  def self.result_factory_without_expectations: -> singleton(BCDD::Result)
+
+  def Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
+  def Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
+end
+
+module BCDD::Result::Context::Expectations::Mixin
+  Methods: singleton(BCDD::Result::Expectations::Mixin::Methods)
+  Factory: singleton(BCDD::Result::Expectations::Mixin::Factory)
+
+  module Addons
+    module Continue
+      private def Continue: (**untyped) -> BCDD::Result::Context::Success
+    end
+
+    module Given
+      private def Given: (*untyped) -> BCDD::Result::Context::Success
+    end
+
+    OPTIONS: Hash[Symbol, Module]
+
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
+  end
+end

data/sig/bcdd/result/contract.rbs

@@ -0,0 +1,119 @@
+module BCDD::Result::Contract
+  NONE: BCDD::Result::Contract::Evaluator
+
+  def self.evaluate: (
+    BCDD::Result::Data,
+    BCDD::Result::Contract::Evaluator
+  ) -> BCDD::Result::Contract::TypeChecker
+
+  ToEnsure: ^(Hash[Symbol, untyped] | Array[Symbol], Hash[Symbol, Hash[Symbol, bool]])
+    -> BCDD::Result::Contract::Interface
+
+  def self.new: (
+    success: Hash[Symbol, untyped] | Array[Symbol],
+    failure: Hash[Symbol, untyped] | Array[Symbol],
+    config: Hash[Symbol, Hash[Symbol, bool]]
+  ) -> BCDD::Result::Contract::Evaluator
+end
+
+module BCDD::Result::Contract
+  class TypeChecker
+    attr_reader result_type: Symbol
+    attr_reader expectations: BCDD::Result::Contract::Evaluator
+
+    def initialize: (
+      Symbol,
+      expectations: BCDD::Result::Contract::Evaluator
+    ) -> void
+
+    def allow?: (Array[Symbol]) -> bool
+    def allow_success?: (Array[Symbol]) -> bool
+    def allow_failure?: (Array[Symbol]) -> bool
+
+    private
+
+    def validate: (
+      Array[Symbol],
+      expected: BCDD::Result::Contract::Interface,
+      allow_empty: bool
+    ) -> bool
+  end
+end
+
+class BCDD::Result::Contract::Error < BCDD::Result::Error
+  class UnexpectedType < BCDD::Result::Contract::Error
+    def self.build: (type: Symbol, allowed_types: Set[Symbol])
+        -> BCDD::Result::Contract::Error::UnexpectedType
+  end
+
+  class UnexpectedValue < BCDD::Result::Contract::Error
+    def self.build: (type: Symbol, value: untyped, ?cause: Exception)
+      -> BCDD::Result::Contract::Error::UnexpectedValue
+  end
+end
+
+module BCDD::Result::Contract
+  module Interface
+    def ==: (BCDD::Result::Contract::Interface) -> bool
+
+    def allowed_types: -> Set[Symbol]
+
+    def type?: (Symbol) -> bool
+
+    def type!: (Symbol) -> Symbol
+
+    def type_and_value!: (BCDD::Result::Data) -> void
+
+    def !=: (untyped) -> bool
+  end
+end
+
+module BCDD::Result::Contract
+  module Disabled
+    extend Interface
+
+    EMPTY_SET: Set[Symbol]
+  end
+end
+
+module BCDD::Result::Contract
+  class ForTypes
+    include Interface
+
+    def initialize: (Array[Symbol]) -> void
+  end
+end
+
+module BCDD::Result::Contract
+  class ForTypesAndValues
+    include Interface
+
+    def initialize: (
+      Hash[Symbol, untyped],
+      Hash[Symbol, Hash[Symbol, bool]]
+    ) -> void
+
+    private
+
+    def nil_as_valid_value_checking?: -> bool
+  end
+end
+
+module BCDD::Result::Contract
+  class Evaluator
+    include Interface
+
+    attr_reader allowed_types: Set[Symbol]
+    attr_reader success: BCDD::Result::Contract::Interface
+    attr_reader failure: BCDD::Result::Contract::Interface
+
+    def initialize: (
+      BCDD::Result::Contract::Interface,
+      BCDD::Result::Contract::Interface
+    ) -> void
+
+    private
+
+    def for: (BCDD::Result::Data) -> BCDD::Result::Contract::Interface
+  end
+end

data/sig/bcdd/result/data.rbs

@@ -0,0 +1,16 @@
+class BCDD::Result
+  class Data
+    attr_reader kind: Symbol
+    attr_reader type: Symbol
+    attr_reader value: untyped
+    attr_reader to_h: Hash[Symbol, untyped]
+    attr_reader to_a: [Symbol, Symbol, untyped]
+
+    def initialize: (Symbol, Symbol, untyped) -> void
+
+    def inspect: -> String
+
+    alias to_ary to_a
+    alias to_hash to_h
+  end
+end

data/sig/bcdd/result/error.rbs

@@ -0,0 +1,31 @@
+class BCDD::Result
+  class Error < StandardError
+    def self.build: (**untyped) -> BCDD::Result::Error
+
+    class NotImplemented < BCDD::Result::Error
+    end
+
+    class MissingTypeArgument < BCDD::Result::Error
+    end
+
+    class UnexpectedOutcome < BCDD::Result::Error
+      def self.build: (outcome: untyped, origin: Symbol, ?expected: String)
+          -> BCDD::Result::Error::UnexpectedOutcome
+    end
+
+    class InvalidResultSubject < BCDD::Result::Error
+      def self.build: (given_result: BCDD::Result, expected_subject: untyped)
+          -> BCDD::Result::Error::InvalidResultSubject
+    end
+
+    class InvalidSubjectMethodArity < BCDD::Result::Error
+      def self.build: (subject: untyped, method: Method, max_arity: Integer)
+        -> BCDD::Result::Error::InvalidSubjectMethodArity
+    end
+
+    class UnhandledTypes < BCDD::Result::Error
+      def self.build: (types: Set[Symbol])
+        -> BCDD::Result::Error::UnhandledTypes
+    end
+  end
+end

data/sig/bcdd/result/expectations.rbs

@@ -0,0 +1,71 @@
+class BCDD::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(BCDD::Result::Expectations::Mixin)
+
+  def self.result_factory_without_expectations: -> singleton(BCDD::Result)
+
+  def self.new: (
+    ?subject: untyped,
+    ?contract: BCDD::Result::Contract::Evaluator,
+    ?terminal: bool,
+    **untyped
+  ) -> (BCDD::Result::Expectations | untyped)
+
+  def initialize: (
+    ?subject: untyped,
+    ?contract: BCDD::Result::Contract::Evaluator,
+    ?terminal: bool,
+    **untyped
+  ) -> void
+
+  def Success: (Symbol, ?untyped) -> BCDD::Result::Success
+  def Failure: (Symbol, ?untyped) -> BCDD::Result::Failure
+
+  def with: (subject: untyped) -> BCDD::Result::Expectations
+
+  private
+
+  def _ResultAs: (singleton(BCDD::Result), Symbol, untyped) -> untyped
+
+  attr_reader subject: untyped
+  attr_reader contract: BCDD::Result::Contract::Evaluator
+  attr_reader terminal: bool
+end
+
+module BCDD::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) -> BCDD::Result::Success
+    end
+
+    module Given
+      private def Given: (untyped) -> BCDD::Result::Success
+    end
+
+    OPTIONS: Hash[Symbol, Module]
+
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
+  end
+end

data/sig/bcdd/result/handler.rbs

@@ -0,0 +1,47 @@
+class BCDD::Result
+  class Handler
+    UNDEFINED: Object
+
+    def initialize: (
+      BCDD::Result,
+      type_checker: BCDD::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: BCDD::Result
+    attr_reader allowed_types: BCDD::Result::Handler::AllowedTypes
+
+    def outcome?: -> bool
+    def outcome=: (Proc) -> void
+    def outcome: -> untyped
+  end
+end
+
+class BCDD::Result::Handler
+  class AllowedTypes
+    attr_reader unchecked: Set[Symbol]
+    attr_reader type_checker: BCDD::Result::Contract::TypeChecker
+
+    def initialize: (
+      BCDD::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/bcdd/result/mixin.rbs

@@ -0,0 +1,45 @@
+class BCDD::Result
+  module Mixin
+    module Factory
+      def self.module!: -> Module
+    end
+
+    module Methods
+      def Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
+
+      def Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
+
+      private
+
+      def _ResultAs: (singleton(BCDD::Result), Symbol, untyped, ?terminal: bool) -> untyped
+    end
+
+    module Addons
+      module Continue
+        include BCDD::Result::Mixin::Methods
+
+        private
+
+        def Continue: (untyped) -> BCDD::Result::Success
+      end
+
+      module Given
+        include BCDD::Result::Mixin::Methods
+
+        private
+
+        def Given: (untyped) -> BCDD::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(BCDD::Result::Mixin)
+
+  def self.result_factory: -> singleton(BCDD::Result)
+end