bcdd-result 0.11.0 → 0.13.0

data/lib/bcdd/result/transitions/tracking/enabled.rb

@@ -2,30 +2,36 @@
 
 module BCDD::Result::Transitions
   class Tracking::Enabled
-    attr_accessor :tree, :records, :root_started_at
+    attr_accessor :tree, :records, :root_started_at, :listener
 
-    private :tree, :tree=, :records, :records=, :root_started_at, :root_started_at=
+    private :tree, :tree=, :records, :records=, :root_started_at, :root_started_at=, :listener, :listener=
 
-    def start(name:, desc:)
-      name_and_desc = [name, desc]
+    def exec(name, desc)
+      transition_node, scope = start(name, desc)
 
-      tree.frozen? ? root_start(name_and_desc) : tree.insert!(name_and_desc)
-    end
+      result = nil
 
-    def finish(result:)
-      node = tree.current
+      listener.around_transitions(scope: scope) do
+        result = EnsureResult[yield]
+      end
 
-      tree.move_up!
+      tree.move_to_root! if transition_node.root?
 
-      return unless node.root?
+      finish(result)
 
-      duration = (now_in_milliseconds - root_started_at)
+      result
+    rescue ::Exception => e
+      err!(e, transition_node)
+    end
 
-      metadata = { duration: duration, tree_map: tree.nested_ids }
+    def err!(exception, transition_node)
+      if transition_node.root?
+        listener.before_interruption(exception: exception, transitions: map_transitions)
 
-      result.send(:transitions=, version: Tracking::VERSION, records: records, metadata: metadata)
+        reset!
+      end
 
-      reset!
+      raise exception
     end
 
     def reset!
@@ -38,43 +44,116 @@ module BCDD::Result::Transitions
       track(result, time: ::Time.now.getutc)
     end
 
-    def record_and_then(type_arg, arg, subject)
+    def record_and_then(type_arg, arg)
+      return yield if tree.frozen?
+
       type = type_arg.instance_of?(::Method) ? :method : type_arg
 
-      unless tree.frozen?
-        current_and_then = { type: type, arg: arg, subject: subject }
-        current_and_then[:method_name] = type_arg.name if type == :method
+      current_and_then = { type: type, arg: arg }
+      current_and_then[:method_name] = type_arg.name if type == :method
 
-        tree.current.value[1] = current_and_then
-      end
+      tree.current.value[1] = current_and_then
+
+      scope, and_then = tree.current_value
 
-      yield
+      result = nil
+
+      listener.around_and_then(scope: scope, and_then: and_then) { result = yield }
+
+      result
+    end
+
+    def reset_and_then!
+      return if tree.frozen?
+
+      tree.current.value[1] = Tracking::EMPTY_HASH
     end
 
     private
 
+    def start(name, desc)
+      name_and_desc = [name, desc]
+
+      tree.frozen? ? root_start(name_and_desc) : tree.insert!(name_and_desc)
+
+      scope = tree.current.value[0]
+
+      listener.on_start(scope: scope)
+
+      [tree.current, scope]
+    end
+
+    def finish(result)
+      node = tree.current
+
+      tree.move_up!
+
+      return unless node.root?
+
+      transitions = map_transitions
+
+      result.send(:transitions=, transitions)
+
+      listener.on_finish(transitions: transitions)
+
+      reset!
+    end
+
     TreeNodeValueNormalizer = ->(id, (nam, des)) { [{ id: id, name: nam, desc: des }, Tracking::EMPTY_HASH] }
 
     def root_start(name_and_desc)
       self.root_started_at = now_in_milliseconds
 
+      self.listener = build_listener
+
       self.records = []
 
       self.tree = Tree.new(name_and_desc, normalizer: TreeNodeValueNormalizer)
     end
 
     def track(result, time:)
-      result = result.data.to_h
+      record = track_record(result, time)
+
+      records << record
+
+      listener.on_record(record: record)
+
+      record
+    end
+
+    def track_record(result, time)
+      result_data = result.data.to_h
+      result_data[:source] = result.send(:source)
 
       root, = tree.root_value
       parent, = tree.parent_value
       current, and_then = tree.current_value
 
-      records << { root: root, parent: parent, current: current, result: result, and_then: and_then, time: time }
+      { root: root, parent: parent, current: current, result: result_data, and_then: and_then, time: time }
     end
 
     def now_in_milliseconds
-      Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+      ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, :millisecond)
+    end
+
+    def map_transitions
+      duration = (now_in_milliseconds - root_started_at)
+
+      trace_id = Config.instance.trace_id.call
+
+      metadata = { duration: duration, ids_tree: tree.nested_ids, ids_matrix: tree.ids_matrix, trace_id: trace_id }
+
+      { version: Tracking::VERSION, records: records, metadata: metadata }
+    end
+
+    def build_listener
+      Config.instance.listener.new
+    rescue ::StandardError => e
+      err = "#{e.message} (#{e.class}); Backtrace: #{e.backtrace&.join(', ')}"
+
+      warn("Fallback to #{Listener::Null} because registered listener raised an exception: #{err}")
+
+      Listener::Null.new
     end
   end
 end

data/lib/bcdd/result/transitions/tracking.rb

@@ -6,14 +6,19 @@ class BCDD::Result
       require_relative 'tracking/enabled'
       require_relative 'tracking/disabled'
 
+      VERSION = 1
+
       EMPTY_ARRAY = [].freeze
       EMPTY_HASH = {}.freeze
       EMPTY_TREE = Tree.new(nil).freeze
-      VERSION = 1
-      EMPTY = { version: VERSION, records: EMPTY_ARRAY, metadata: { duration: 0, tree_map: EMPTY_ARRAY } }.freeze
+      EMPTY = {
+        version: VERSION,
+        records: EMPTY_ARRAY,
+        metadata: { duration: 0, ids_tree: EMPTY_ARRAY, ids_matrix: EMPTY_HASH, trace_id: nil }.freeze
+      }.freeze
 
       def self.instance
-        Config.instance.feature.enabled?(:transitions) ? Tracking::Enabled.new : Tracking::Disabled
+        ::BCDD::Result::Config.instance.feature.enabled?(:transitions) ? Tracking::Enabled.new : Tracking::Disabled
       end
     end
   end

data/lib/bcdd/result/transitions/tree.rb

@@ -46,9 +46,9 @@ class BCDD::Result
       def initialize(value, normalizer: ->(_id, val) { val })
         @size = 0
 
-        @root = Node.new(value, parent: nil, id: @size, normalizer: normalizer)
+        @root = Node.new(value, parent: nil, id: size, normalizer: normalizer)
 
-        @current = @root
+        @current = root
       end
 
       def root_value
@@ -70,19 +70,23 @@ class BCDD::Result
       end
 
       def insert!(value)
-        @current = insert(value)
+        move_to! insert(value)
+      end
+
+      def move_to!(node)
+        tap { @current = node }
       end
 
       def move_up!(level = 1)
-        tap { level.times { @current = current.parent || root } }
+        tap { level.times { move_to!(current.parent || root) } }
       end
 
       def move_down!(level = 1, index: -1)
-        tap { level.times { current.children[index].then { |child| @current = child if child } } }
+        tap { level.times { current.children[index].then { |child| move_to!(child) if child } } }
       end
 
       def move_to_root!
-        tap { @current = root }
+        move_to!(root)
       end
 
       NestedIds = ->(node) { [node.id, node.children.map(&NestedIds)] }
@@ -90,6 +94,32 @@ class BCDD::Result
       def nested_ids
         NestedIds[root]
       end
+
+      IdsMatrix = ->(tree, row, col, ids, previous) do
+        last_row = previous[0]
+
+        tree.each_with_index do |node, index|
+          row = [(index + 1), last_row].max
+
+          id, leaf = node
+
+          ids[id] = previous == [row, col] ? [row, col + 1] : [row, col]
+
+          previous = ids[id]
+
+          IdsMatrix[leaf, row, col + 1, ids, previous]
+        end
+      end
+
+      def ids_matrix
+        current = [0, 0]
+
+        ids = { 0 => current }
+
+        IdsMatrix[nested_ids[1], 1, 1, ids, current]
+
+        ids
+      end
     end
   end
 end

data/lib/bcdd/result/transitions.rb

@@ -2,29 +2,26 @@
 
 class BCDD::Result
   module Transitions
+    require_relative 'transitions/listener'
+    require_relative 'transitions/listeners'
+    require_relative 'transitions/config'
     require_relative 'transitions/tree'
     require_relative 'transitions/tracking'
 
     THREAD_VAR_NAME = :bcdd_result_transitions_tracking
 
+    EnsureResult = ->(result) do
+      return result if result.is_a?(::BCDD::Result)
+
+      raise Error::UnexpectedOutcome.build(outcome: result, origin: :transitions)
+    end
+
     def self.tracking
       Thread.current[THREAD_VAR_NAME] ||= Tracking.instance
     end
   end
 
-  def self.transitions(name: nil, desc: nil)
-    Transitions.tracking.start(name: name, desc: desc)
-
-    result = yield
-
-    result.is_a?(::BCDD::Result) or raise Error::UnexpectedOutcome.build(outcome: result, origin: :transitions)
-
-    Transitions.tracking.finish(result: result)
-
-    result
-  rescue ::Exception => e
-    Transitions.tracking.reset!
-
-    raise e
+  def self.transitions(name: nil, desc: nil, &block)
+    Transitions.tracking.exec(name, desc, &block)
   end
 end

data/lib/bcdd/result/version.rb

@@ -2,6 +2,6 @@
 
 module BCDD
   class Result
-    VERSION = '0.11.0'
+    VERSION = '0.13.0'
   end
 end

data/lib/bcdd/result.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+require 'set'
+require 'singleton'
+
 require_relative 'result/version'
-require_relative 'result/transitions'
 require_relative 'result/error'
+require_relative 'result/ignored_types'
+require_relative 'result/transitions'
+require_relative 'result/callable_and_then'
 require_relative 'result/data'
 require_relative 'result/handler'
 require_relative 'result/failure'
@@ -16,9 +21,9 @@ require_relative 'result/config'
 class BCDD::Result
   attr_accessor :unknown, :transitions
 
-  attr_reader :subject, :data, :type_checker, :terminal
+  attr_reader :source, :data, :type_checker, :terminal
 
-  protected :subject
+  protected :source
 
   private :unknown, :unknown=, :type_checker, :transitions=
 
@@ -26,18 +31,18 @@ class BCDD::Result
     Config.instance
   end
 
-  def self.configuration
+  def self.configuration(freeze: true)
     yield(config)
 
-    config.freeze
+    freeze and config.freeze
   end
 
-  def initialize(type:, value:, subject: nil, expectations: nil, terminal: nil)
+  def initialize(type:, value:, source: nil, expectations: nil, terminal: nil)
     data = Data.new(kind, type, value)
 
     @type_checker = Contract.evaluate(data, expectations)
-    @subject = subject
-    @terminal = terminal || kind == :failure
+    @source = source
+    @terminal = kind == :failure || (terminal && !IgnoredTypes.include?(type))
     @data = data
 
     self.unknown = true
@@ -88,12 +93,20 @@ class BCDD::Result
     tap { yield(value, type) if unknown }
   end
 
-  def and_then(method_name = nil, context = nil, &block)
+  def and_then(method_name = nil, injected_value = nil, &block)
     return self if terminal?
 
     method_name && block and raise ::ArgumentError, 'method_name and block are mutually exclusive'
 
-    method_name ? call_and_then_subject_method(method_name, context) : call_and_then_block(block)
+    method_name ? call_and_then_source_method(method_name, injected_value) : call_and_then_block(block)
+  end
+
+  def and_then!(source, injected_value = nil, _call: nil)
+    raise Error::CallableAndThenDisabled unless Config.instance.feature.enabled?(:and_then!)
+
+    return self if terminal?
+
+    call_and_then_callable!(source, value: value, injected_value: injected_value, method_name: _call)
   end
 
   def handle
@@ -139,27 +152,27 @@ class BCDD::Result
     block.call(value, type)
   end
 
-  def call_and_then_subject_method(method_name, context_data)
-    method = subject.method(method_name)
+  def call_and_then_source_method(method_name, injected_value)
+    method = source.method(method_name)
 
-    Transitions.tracking.record_and_then(method, context_data, subject) do
-      result = call_and_then_subject_method!(method, context_data)
+    Transitions.tracking.record_and_then(method, injected_value) do
+      result = call_and_then_source_method!(method, injected_value)
 
       ensure_result_object(result, origin: :method)
     end
   end
 
-  def call_and_then_subject_method!(method, context_data)
+  def call_and_then_source_method!(method, injected_value)
     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)
+    when 0 then source.send(method.name)
+    when 1 then source.send(method.name, value)
+    when 2 then source.send(method.name, value, injected_value)
+    else raise Error::InvalidSourceMethodArity.build(source: source, method: method, max_arity: 2)
     end
   end
 
   def call_and_then_block(block)
-    Transitions.tracking.record_and_then(:block, nil, subject) do
+    Transitions.tracking.record_and_then(:block, nil) do
       result = call_and_then_block!(block)
 
       ensure_result_object(result, origin: :block)
@@ -170,11 +183,15 @@ class BCDD::Result
     block.call(value)
   end
 
+  def call_and_then_callable!(source, value:, injected_value:, method_name:)
+    CallableAndThen::Caller.call(source, value: value, injected_value: injected_value, method_name: method_name)
+  end
+
   def ensure_result_object(result, origin:)
     raise Error::UnexpectedOutcome.build(outcome: result, origin: origin) unless result.is_a?(::BCDD::Result)
 
-    return result if result.subject.equal?(subject)
+    return result if result.source.equal?(source)
 
-    raise Error::InvalidResultSubject.build(given_result: result, expected_subject: subject)
+    raise Error::InvalidResultSource.build(given_result: result, expected_source: source)
   end
 end

data/sig/bcdd/result/callable_and_then.rbs

@@ -0,0 +1,60 @@
+module BCDD::Result::CallableAndThen
+  class Config
+    attr_accessor default_method_name_to_call: Symbol
+
+    def initialize: -> void
+
+    def options: () -> Hash[Symbol, untyped]
+  end
+
+  class Error < BCDD::Result::Error
+  end
+
+  class Error::InvalidArity < Error
+    def self.build: (
+      source: untyped,
+      method: Symbol,
+      arity: String
+    ) -> Error::InvalidArity
+  end
+
+  class Caller
+    def self.call: (
+      untyped source,
+      value: untyped,
+      injected_value: untyped,
+      method_name: (Symbol | nil)
+    ) -> BCDD::Result
+
+    private
+
+    def self.call_proc!: (
+      untyped source,
+      untyped value,
+      untyped injected_value
+    ) -> BCDD::Result
+
+    def self.call_method!: (
+      untyped source,
+      Method method,
+      untyped value,
+      untyped injected_value
+    ) -> BCDD::Result
+
+    def self.callable_method: (
+      untyped source,
+      (Symbol | nil) method_name
+    ) -> ::Method
+
+    def self.ensure_result_object: (
+      untyped source,
+      untyped value,
+      BCDD::Result result
+    ) -> BCDD::Result
+
+    def self.expected_result_object: () -> singleton(BCDD::Result)
+
+    def self.expected_outcome: () -> String
+  end
+end
+

data/sig/bcdd/result/config.rbs

@@ -14,6 +14,9 @@ class BCDD::Result::Config
 
   def initialize: -> void
 
+  def and_then!: () -> BCDD::Result::CallableAndThen::Config
+  def transitions: () -> BCDD::Result::Transitions::Config
+
   def freeze: -> BCDD::Result::Config
   def options: -> Hash[Symbol, BCDD::Result::Config::Switcher]
   def to_h: -> Hash[Symbol, Hash[Symbol | String, bool]]

data/sig/bcdd/result/context.rbs

@@ -1,38 +1,99 @@
 class BCDD::Result::Context < BCDD::Result
   EXPECTED_OUTCOME: String
 
-  SubjectMethodArity: ^(Method) -> Integer
+  SourceMethodArity: ^(Method) -> Integer
 
   attr_reader acc: Hash[Symbol, untyped]
 
   def initialize: (
     type: Symbol,
     value: untyped,
-    ?subject: untyped,
+    ?source: untyped,
     ?expectations: BCDD::Result::Contract::Evaluator,
     ?terminal: bool
   ) -> void
 
-  def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> BCDD::Result::Context
+  def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> untyped
+
+  def and_then!: (untyped, **untyped) -> untyped
 
   private
 
-  def call_and_then_subject_method: (Symbol, Hash[Symbol, untyped]) -> BCDD::Result::Context
+  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

data/sig/bcdd/result/error.rbs

@@ -13,19 +13,22 @@ class BCDD::Result
           -> BCDD::Result::Error::UnexpectedOutcome
     end
 
-    class InvalidResultSubject < BCDD::Result::Error
-      def self.build: (given_result: BCDD::Result, expected_subject: untyped)
-          -> BCDD::Result::Error::InvalidResultSubject
+    class InvalidResultSource < BCDD::Result::Error
+      def self.build: (given_result: BCDD::Result, expected_source: untyped)
+          -> BCDD::Result::Error::InvalidResultSource
     end
 
-    class InvalidSubjectMethodArity < BCDD::Result::Error
-      def self.build: (subject: untyped, method: Method, max_arity: Integer)
-        -> BCDD::Result::Error::InvalidSubjectMethodArity
+    class InvalidSourceMethodArity < BCDD::Result::Error
+      def self.build: (source: untyped, method: Method, max_arity: Integer)
+        -> BCDD::Result::Error::InvalidSourceMethodArity
     end
 
     class UnhandledTypes < BCDD::Result::Error
       def self.build: (types: Set[Symbol])
         -> BCDD::Result::Error::UnhandledTypes
     end
+
+    class CallableAndThenDisabled < BCDD::Result::Error
+    end
   end
 end

data/sig/bcdd/result/expectations.rbs

@@ -16,14 +16,14 @@ class BCDD::Result::Expectations
   def self.result_factory_without_expectations: -> singleton(BCDD::Result)
 
   def self.new: (
-    ?subject: untyped,
+    ?source: untyped,
     ?contract: BCDD::Result::Contract::Evaluator,
     ?terminal: bool,
     **untyped
   ) -> (BCDD::Result::Expectations | untyped)
 
   def initialize: (
-    ?subject: untyped,
+    ?source: untyped,
     ?contract: BCDD::Result::Contract::Evaluator,
     ?terminal: bool,
     **untyped
@@ -32,13 +32,13 @@ class BCDD::Result::Expectations
   def Success: (Symbol, ?untyped) -> BCDD::Result::Success
   def Failure: (Symbol, ?untyped) -> BCDD::Result::Failure
 
-  def with: (subject: untyped) -> BCDD::Result::Expectations
+  def with: (source: untyped) -> BCDD::Result::Expectations
 
   private
 
   def _ResultAs: (singleton(BCDD::Result), Symbol, untyped) -> untyped
 
-  attr_reader subject: untyped
+  attr_reader source: untyped
   attr_reader contract: BCDD::Result::Contract::Evaluator
   attr_reader terminal: bool
 end