bcdd-result 0.9.1 → 0.11.0

data/sig/bcdd/result/transitions.rbs

@@ -0,0 +1,89 @@
+class BCDD::Result
+  module Transitions
+    class Tree
+      class Node
+        attr_reader id: Integer
+        attr_reader value: untyped
+        attr_reader parent: (Node | nil)
+        attr_reader normalizer: ^(Integer, Array[untyped]) -> untyped
+        attr_reader children: Array[Node]
+
+        def initialize: (
+          untyped value,
+          parent: (Node | nil),
+          id: Integer,
+          normalizer: ^(Integer, Array[untyped]) -> untyped
+        ) -> void
+
+        def insert: (untyped, id: Integer) -> Node
+
+        def root?: () -> bool
+        def leaf?: () -> bool
+        def node?: () -> bool
+        def inspect: () -> String
+      end
+
+      attr_reader size: Integer
+      attr_reader root: Node
+      attr_reader current: Node
+
+      def initialize: (untyped, ?normalizer: ^(Integer, Array[untyped]) -> untyped) -> void
+      def root_value: () -> untyped
+      def parent_value: () -> untyped
+      def current_value: () -> untyped
+      def insert: (untyped) -> Node
+      def insert!: (untyped) -> Node
+      def move_up!: (?Integer level) -> Tree
+      def move_down!: (?Integer level) -> Tree
+      def move_to_root!: () -> Tree
+
+      NestedIds: ^(Node) -> Array[untyped]
+
+      def nested_ids: () -> Array[untyped]
+    end
+
+    module Tracking
+      EMPTY_ARRAY: Array[untyped]
+      EMPTY_HASH: Hash[untyped, untyped]
+      EMPTY_TREE: Transitions::Tree
+      VERSION: Integer
+      EMPTY: Hash[Symbol, untyped]
+
+      class Enabled
+        private attr_accessor tree: Transitions::Tree
+        private attr_accessor records: Array[Hash[Symbol, untyped]]
+        private attr_accessor root_started_at: Integer
+
+        def start: (name: String, desc: String) -> void
+        def finish: (result: BCDD::Result) -> void
+        def reset!: () -> void
+        def record: (BCDD::Result) -> void
+        def record_and_then: ((untyped), untyped, untyped) { () -> BCDD::Result } -> BCDD::Result
+
+        private
+
+        TreeNodeValueNormalizer: ^(Integer, Array[untyped]) -> untyped
+
+        def root_start: (Array[untyped]) -> void
+
+        def track: (BCDD::Result, time: Time) -> void
+
+        def now_in_milliseconds: () -> Integer
+      end
+
+      module Disabled
+        def self.start: (name: String, desc: String) -> void
+        def self.finish: (result: BCDD::Result) -> void
+        def self.reset!: () -> void
+        def self.record: (BCDD::Result) -> void
+        def self.record_and_then: ((untyped), untyped, untyped) { () -> BCDD::Result } -> BCDD::Result
+      end
+
+      def self.instance: () -> (Enabled | singleton(Disabled))
+    end
+
+    THREAD_VAR_NAME: Symbol
+
+    def self.tracking: () -> (Tracking::Enabled | singleton(Tracking::Disabled))
+  end
+end

data/sig/bcdd/result/version.rbs

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

data/sig/bcdd/result.rbs

@@ -1,16 +1,12 @@
-module BCDD
-  class Result
-    VERSION: String
-  end
-end
-
 class BCDD::Result
   private attr_accessor unknown: bool
+  private attr_writer transitions: Hash[Symbol, untyped]
   private attr_reader type_checker: BCDD::Result::Contract::TypeChecker
 
   attr_reader data: BCDD::Result::Data
   attr_reader subject: untyped
-  attr_reader halted: bool
+  attr_reader terminal: bool
+  attr_reader transitions: Hash[Symbol, untyped]
 
   def self.config: -> BCDD::Result::Config
   def self.configuration: { (BCDD::Result::Config) -> void } -> BCDD::Result::Config
@@ -20,13 +16,13 @@ class BCDD::Result
     value: untyped,
     ?subject: untyped,
     ?expectations: BCDD::Result::Contract::Evaluator,
-    ?halted: bool
+    ?terminal: bool
   ) -> void
 
   def type: -> Symbol
   def value: -> untyped
 
-  def halted?: -> bool
+  def terminal?: -> bool
   def success?: (?Symbol type) -> bool
   def failure?: (?Symbol type) -> bool
 
@@ -56,8 +52,9 @@ class BCDD::Result
   def kind: -> Symbol
   def known: (Proc) -> untyped
   def call_and_then_subject_method: (Symbol, untyped) -> BCDD::Result
+  def call_and_then_subject_method!: (untyped, untyped) -> BCDD::Result
   def call_and_then_block: (untyped) -> BCDD::Result
-  def call_and_then_block!: (untyped, untyped) -> BCDD::Result
+  def call_and_then_block!: (untyped) -> BCDD::Result
   def ensure_result_object: (untyped, origin: Symbol) -> BCDD::Result
 end
 
@@ -81,7 +78,6 @@ class BCDD::Result
   def self.Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
 end
 
-
 class BCDD::Result
   class Failure < BCDD::Result
     module Methods
@@ -101,511 +97,3 @@ class BCDD::Result
 
   def self.Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
 end
-
-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, ?halted: bool) -> untyped
-    end
-
-    module Addons
-      module Continuable
-        include BCDD::Result::Mixin::Methods
-
-        private
-
-        def Continue: (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
-
-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
-
-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
-
-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
-
-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
-
-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,
-    ?halted: bool,
-    **untyped
-  ) -> (BCDD::Result::Expectations | untyped)
-
-  def initialize: (
-    ?subject: untyped,
-    ?contract: BCDD::Result::Contract::Evaluator,
-    ?halted: 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 halted: 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 Continuable
-      private def Continue: (untyped) -> BCDD::Result::Success
-    end
-
-    OPTIONS: Hash[Symbol, Module]
-
-    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
-  end
-end
-
-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,
-    ?halted: 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], halted: 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, ?halted: bool) -> untyped
-    end
-
-    module Addons
-      module Continuable
-        include BCDD::Result::Context::Mixin::Methods
-
-        private
-
-        def Continue: (**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 Continuable
-      private def Continue: (**untyped) -> BCDD::Result::Context::Success
-    end
-
-    OPTIONS: Hash[Symbol, Module]
-
-    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
-  end
-end
-
-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
-
-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::ConstantAlias
-  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::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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-result
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway
   Oriented Programming, and B/CDD.
@@ -29,9 +29,12 @@ files:
 - lib/bcdd-result.rb
 - lib/bcdd/result.rb
 - lib/bcdd/result/config.rb
-- lib/bcdd/result/config/constant_alias.rb
 - lib/bcdd/result/config/options.rb
 - lib/bcdd/result/config/switcher.rb
+- lib/bcdd/result/config/switchers/addons.rb
+- lib/bcdd/result/config/switchers/constant_aliases.rb
+- lib/bcdd/result/config/switchers/features.rb
+- lib/bcdd/result/config/switchers/pattern_matching.rb
 - lib/bcdd/result/context.rb
 - lib/bcdd/result/context/expectations.rb
 - lib/bcdd/result/context/expectations/mixin.rb
@@ -57,8 +60,23 @@ files:
 - lib/bcdd/result/mixin.rb
 - lib/bcdd/result/success.rb
 - lib/bcdd/result/success/methods.rb
+- lib/bcdd/result/transitions.rb
+- lib/bcdd/result/transitions/tracking.rb
+- lib/bcdd/result/transitions/tracking/disabled.rb
+- lib/bcdd/result/transitions/tracking/enabled.rb
+- lib/bcdd/result/transitions/tree.rb
 - lib/bcdd/result/version.rb
 - sig/bcdd/result.rbs
+- sig/bcdd/result/config.rbs
+- sig/bcdd/result/context.rbs
+- sig/bcdd/result/contract.rbs
+- sig/bcdd/result/data.rbs
+- sig/bcdd/result/error.rbs
+- sig/bcdd/result/expectations.rbs
+- sig/bcdd/result/handler.rbs
+- sig/bcdd/result/mixin.rbs
+- sig/bcdd/result/transitions.rbs
+- sig/bcdd/result/version.rbs
 homepage: https://github.com/b-cdd/result
 licenses:
 - MIT
@@ -83,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway Oriented