bcdd-result 0.13.0 → 1.0.0

data/sig/bcdd/context.rbs

@@ -0,0 +1,175 @@
+class BCDD::Context < BCDD::Result
+  EXPECTED_OUTCOME: String
+
+  SourceMethodArity: ^(Method) -> Integer
+
+  attr_reader acc: Hash[Symbol, untyped]
+
+  def initialize: (
+    type: Symbol,
+    value: untyped,
+    ?source: untyped,
+    ?expectations: BCDD::Result::Contract::Evaluator,
+    ?terminal: bool
+  ) -> void
+
+  def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> untyped
+
+  def and_then!: (untyped, **untyped) -> untyped
+
+  private
+
+  def call_and_then_source_method: (Symbol, Hash[Symbol, untyped]) -> BCDD::Context
+
+  def call_and_then_callable!: (untyped, value: untyped, injected_value: untyped, method_name: (Symbol | nil)) -> BCDD::Context
+
+  def ensure_result_object: (untyped, origin: Symbol) -> BCDD::Context
+
+  def raise_unexpected_outcome_error: (BCDD::Context | untyped, Symbol) -> void
+end
+
+class BCDD::Context
+  class Error < BCDD::Result::Error
+    class InvalidExposure < BCDD::Context::Error
+    end
+  end
+end
+
+class BCDD::Context
+  class Success < BCDD::Context
+    include BCDD::Success
+
+    FetchValues: Proc
+
+    def and_expose: (Symbol, Array[Symbol], terminal: bool) -> BCDD::Context::Success
+  end
+
+  def self.Success: (Symbol, **untyped) -> BCDD::Context::Success
+end
+
+module BCDD::Context::CallableAndThen
+  class Caller < BCDD::Result::CallableAndThen::Caller
+    module KeyArgs
+      def self.parameters?: (untyped) -> bool
+
+      def self.invalid_arity: (untyped, Symbol) -> BCDD::Result::CallableAndThen::Error::InvalidArity
+    end
+
+    def self.call: (
+      untyped source,
+      value: untyped,
+      injected_value: untyped,
+      method_name: (Symbol | nil),
+    ) -> BCDD::Context
+
+    private
+
+    def self.call_proc!: (
+      untyped source,
+      Hash[Symbol, untyped] value,
+      nil injected_value
+    ) -> BCDD::Context
+
+    def self.call_method!: (
+      untyped source,
+      Method method,
+      Hash[Symbol, untyped] value,
+      nil injected_value
+    ) -> BCDD::Context
+
+    def self.callable_method: (
+      untyped source,
+      (Symbol | nil) method_name
+    ) -> ::Method
+
+    def self.ensure_result_object: (
+      untyped source,
+      untyped value,
+      BCDD::Context result
+    ) -> BCDD::Context
+
+    def self.expected_result_object: () -> singleton(BCDD::Context)
+
+    def self.expected_outcome: () -> String
+  end
+end
+
+class BCDD::Context
+  class Failure < BCDD::Context
+    include BCDD::Failure
+
+    def and_expose: (Symbol, Array[Symbol], **untyped) -> BCDD::Context::Failure
+  end
+
+  def self.Failure: (Symbol, **untyped) -> BCDD::Context::Failure
+end
+
+class BCDD::Context
+  module Mixin
+    Factory: singleton(BCDD::Result::Mixin::Factory)
+
+    module Methods
+      def Success: (Symbol, **untyped) -> BCDD::Context::Success
+
+      def Failure: (Symbol, **untyped) -> BCDD::Context::Failure
+
+      private
+
+      def _ResultAs: (singleton(BCDD::Context), Symbol, untyped, ?terminal: bool) -> untyped
+    end
+
+    module Addons
+      module Continue
+        include BCDD::Context::Mixin::Methods
+
+        private
+
+        def Continue: (**untyped) -> BCDD::Context::Success
+      end
+
+      module Given
+        include BCDD::Context::Mixin::Methods
+
+        private
+
+        def Given: (*untyped) -> BCDD::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::Context::Mixin)
+
+  def self.result_factory: -> singleton(BCDD::Context)
+end
+
+class BCDD::Context::Expectations < BCDD::Result::Expectations
+  def self.mixin_module: -> singleton(BCDD::Context::Expectations::Mixin)
+
+  def self.result_factory_without_expectations: -> singleton(BCDD::Result)
+
+  def Success: (Symbol, **untyped) -> BCDD::Context::Success
+  def Failure: (Symbol, **untyped) -> BCDD::Context::Failure
+end
+
+module BCDD::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::Context::Success
+    end
+
+    module Given
+      private def Given: (*untyped) -> BCDD::Context::Success
+    end
+
+    OPTIONS: Hash[Symbol, Module]
+
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
+  end
+end

data/sig/bcdd/failure.rbs

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

data/sig/bcdd/result/config.rbs

@@ -1,6 +1,4 @@
 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]]
@@ -15,7 +13,7 @@ class BCDD::Result::Config
   def initialize: -> void
 
   def and_then!: () -> BCDD::Result::CallableAndThen::Config
-  def transitions: () -> BCDD::Result::Transitions::Config
+  def event_logs: () -> BCDD::Result::EventLogs::Config
 
   def freeze: -> BCDD::Result::Config
   def options: -> Hash[Symbol, BCDD::Result::Config::Switcher]

data/sig/bcdd/result/context.rbs

@@ -1,175 +1,3 @@
-class BCDD::Result::Context < BCDD::Result
-  EXPECTED_OUTCOME: String
-
-  SourceMethodArity: ^(Method) -> Integer
-
-  attr_reader acc: Hash[Symbol, untyped]
-
-  def initialize: (
-    type: Symbol,
-    value: untyped,
-    ?source: untyped,
-    ?expectations: BCDD::Result::Contract::Evaluator,
-    ?terminal: bool
-  ) -> void
-
-  def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> untyped
-
-  def and_then!: (untyped, **untyped) -> untyped
-
-  private
-
-  def call_and_then_source_method: (Symbol, Hash[Symbol, untyped]) -> BCDD::Result::Context
-
-  def call_and_then_callable!: (untyped, value: untyped, injected_value: untyped, method_name: (Symbol | nil)) -> 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 Error < BCDD::Result::Error
-    class InvalidExposure < BCDD::Result::Context::Error
-    end
-  end
-end
-
-class BCDD::Result::Context
-  class Success < BCDD::Result::Context
-    include BCDD::Result::Success::Methods
-
-    FetchValues: Proc
-
-    def and_expose: (Symbol, Array[Symbol], terminal: bool) -> BCDD::Result::Context::Success
-  end
-
-  def self.Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
-end
-
-module BCDD::Result::Context::CallableAndThen
-  class Caller < BCDD::Result::CallableAndThen::Caller
-    module KeyArgs
-      def self.parameters?: (untyped) -> bool
-
-      def self.invalid_arity: (untyped, Symbol) -> BCDD::Result::CallableAndThen::Error::InvalidArity
-    end
-
-    def self.call: (
-      untyped source,
-      value: untyped,
-      injected_value: untyped,
-      method_name: (Symbol | nil),
-    ) -> BCDD::Result::Context
-
-    private
-
-    def self.call_proc!: (
-      untyped source,
-      Hash[Symbol, untyped] value,
-      nil injected_value
-    ) -> BCDD::Result::Context
-
-    def self.call_method!: (
-      untyped source,
-      Method method,
-      Hash[Symbol, untyped] value,
-      nil injected_value
-    ) -> BCDD::Result::Context
-
-    def self.callable_method: (
-      untyped source,
-      (Symbol | nil) method_name
-    ) -> ::Method
-
-    def self.ensure_result_object: (
-      untyped source,
-      untyped value,
-      BCDD::Result::Context result
-    ) -> BCDD::Result::Context
-
-    def self.expected_result_object: () -> singleton(BCDD::Result::Context)
-
-    def self.expected_outcome: () -> String
-  end
-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
+class BCDD::Result
+  Context: BCDD::Context
 end

data/sig/bcdd/result/contract.rbs

@@ -26,6 +26,7 @@ module BCDD::Result::Contract
       expectations: BCDD::Result::Contract::Evaluator
     ) -> void
 
+    def allow!: (Symbol) -> Symbol
     def allow?: (Array[Symbol]) -> bool
     def allow_success?: (Array[Symbol]) -> bool
     def allow_failure?: (Array[Symbol]) -> bool

data/sig/bcdd/result/{transitions.rbs → event_logs.rbs}

@@ -1,14 +1,14 @@
 class BCDD::Result
-  module Transitions
+  module EventLogs
     module Listener
       module ClassMethods
         def around_and_then?: () -> bool
-        def around_transitions?: () -> bool
+        def around_event_logs?: () -> bool
       end
 
       extend ClassMethods
 
-      def around_transitions: (scope: Hash[Symbol, untyped]) { () -> untyped } -> untyped
+      def around_event_logs: (scope: Hash[Symbol, untyped]) { () -> untyped } -> untyped
 
       def on_start: (scope: Hash[Symbol, untyped]) -> untyped
 
@@ -16,9 +16,9 @@ class BCDD::Result
 
       def on_record: (record: Hash[Symbol, untyped] ) -> untyped
 
-      def on_finish: (transitions: Hash[Symbol, untyped] ) -> untyped
+      def on_finish: (event_logs: Hash[Symbol, untyped] ) -> untyped
 
-      def before_interruption: (exception: ::Exception, transitions: Hash[Symbol, untyped]) -> untyped
+      def before_interruption: (exception: ::Exception, event_logs: Hash[Symbol, untyped]) -> untyped
     end
 
     class Listeners
@@ -40,11 +40,11 @@ class BCDD::Result
 
       private attr_reader listeners: Array[Listener]
       private attr_reader around_and_then_listener: untyped
-      private attr_reader around_transitions_listener: untyped
+      private attr_reader around_event_logs_listener: untyped
 
       def initialize: (Array[Listener], untyped, untyped) -> void
 
-      def around_transitions: (scope: Hash[Symbol, untyped]) { () -> untyped } -> untyped
+      def around_event_logs: (scope: Hash[Symbol, untyped]) { () -> untyped } -> untyped
 
       def on_start: (scope: Hash[Symbol, untyped]) -> untyped
 
@@ -52,9 +52,9 @@ class BCDD::Result
 
       def on_record: (record: Hash[Symbol, untyped] ) -> untyped
 
-      def on_finish: (transitions: Hash[Symbol, untyped] ) -> untyped
+      def on_finish: (event_logs: Hash[Symbol, untyped] ) -> untyped
 
-      def before_interruption: (exception: ::Exception, transitions: Hash[Symbol, untyped]) -> untyped
+      def before_interruption: (exception: ::Exception, event_logs: Hash[Symbol, untyped]) -> untyped
     end
 
     module Listener::Null
@@ -64,8 +64,6 @@ class BCDD::Result
     end
 
     class Config
-      include ::Singleton
-
       attr_reader listener: untyped
       attr_reader trace_id: ::Proc
 
@@ -115,24 +113,26 @@ class BCDD::Result
       def move_down!: (?Integer level) -> Tree
       def move_to_root!: () -> Tree
 
-      NestedIds: ^(Node) -> Array[untyped]
-
-      def nested_ids: () -> Array[untyped]
-
+      Ids: ^(Node) -> Array[untyped]
       IdsMatrix: ::Proc
+      IdsLevelParent: ::Proc
 
+      def ids: () -> Array[untyped]
+      def ids_list: () -> Array[Integer]
       def ids_matrix: () -> untyped
+      def ids_level_parent: () -> untyped
     end
 
     module Tracking
       EMPTY_ARRAY: Array[untyped]
       EMPTY_HASH: Hash[untyped, untyped]
-      EMPTY_TREE: Transitions::Tree
+      EMPTY_TREE: EventLogs::Tree
+      EMPTY_IDS: Hash[untyped, untyped]
       VERSION: Integer
       EMPTY: Hash[Symbol, untyped]
 
       class Enabled
-        private attr_accessor tree: Transitions::Tree
+        private attr_accessor tree: EventLogs::Tree
         private attr_accessor records: Array[Hash[Symbol, untyped]]
         private attr_accessor listener: untyped
         private attr_accessor root_started_at: Integer
@@ -146,7 +146,7 @@ class BCDD::Result
 
         private
 
-        def start: (String, String) -> [Transitions::Tree::Node, Hash[Symbol, untyped]]
+        def start: (String, String) -> [EventLogs::Tree::Node, Hash[Symbol, untyped]]
         def finish: (untyped) -> untyped
 
         TreeNodeValueNormalizer: ^(Integer, Array[untyped]) -> untyped
@@ -158,7 +158,7 @@ class BCDD::Result
 
         def now_in_milliseconds: () -> Integer
 
-        def map_transitions: () -> Hash[Symbol, untyped]
+        def map_event_logs: () -> Hash[Symbol, untyped]
 
         def build_listener: () -> Listener
       end

data/sig/bcdd/result.rbs

@@ -1,16 +1,16 @@
 class BCDD::Result
   private attr_accessor unknown: bool
-  private attr_writer transitions: Hash[Symbol, untyped]
+  private attr_writer event_logs: Hash[Symbol, untyped]
   private attr_reader type_checker: BCDD::Result::Contract::TypeChecker
 
   attr_reader data: BCDD::Result::Data
   attr_reader source: untyped
   attr_reader terminal: bool
-  attr_reader transitions: Hash[Symbol, untyped]
+  attr_reader event_logs: Hash[Symbol, untyped]
 
   def self.config: -> BCDD::Result::Config
   def self.configuration: (freeze: bool) { (BCDD::Result::Config) -> void } -> (bool | BCDD::Result::Config)
-  def self.transitions: (name: untyped, desc: untyped) { () -> untyped } -> BCDD::Result
+  def self.event_logs: (name: untyped, desc: untyped) { () -> untyped } -> BCDD::Result
 
   def initialize: (
     type: Symbol,
@@ -23,6 +23,7 @@ class BCDD::Result
   def type: -> Symbol
   def value: -> untyped
 
+  def type?: (Symbol | String) -> bool
   def terminal?: -> bool
   def success?: (?Symbol type) -> bool
   def failure?: (?Symbol type) -> bool
@@ -47,6 +48,11 @@ class BCDD::Result
   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
 
@@ -64,40 +70,16 @@ end
 
 class BCDD::Result
   class Success < BCDD::Result
-    module Methods
-      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: -> BCDD::Result::Contract::TypeChecker
-    end
-
-    include Methods
+    include BCDD::Success
   end
 
-  def self.Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
+  def self.Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
 end
 
 class BCDD::Result
   class Failure < BCDD::Result
-    module Methods
-      def success?: (?Symbol type) -> bool
-      def failure?: (?Symbol type) -> bool
-      def value_or: { (untyped) -> untyped } -> untyped
-      def value: -> untyped
-
-      private
-
-      def kind: -> Symbol
-      def type_checker: -> BCDD::Result::Contract::TypeChecker
-    end
-
-    include Methods
+    include BCDD::Failure
   end
 
-  def self.Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
+  def self.Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
 end

data/sig/bcdd/success.rbs

@@ -0,0 +1,13 @@
+module BCDD
+  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: -> BCDD::Result::Contract::TypeChecker
+  end
+end