bcdd-result 0.12.0 → 1.0.0

data/sig/bcdd/result/event_logs.rbs

@@ -0,0 +1,189 @@
+class BCDD::Result
+  module EventLogs
+    module Listener
+      module ClassMethods
+        def around_and_then?: () -> bool
+        def around_event_logs?: () -> bool
+      end
+
+      extend ClassMethods
+
+      def around_event_logs: (scope: Hash[Symbol, untyped]) { () -> untyped } -> untyped
+
+      def on_start: (scope: Hash[Symbol, untyped]) -> untyped
+
+      def around_and_then: (scope: Hash[Symbol, untyped], and_then: Hash[Symbol, untyped]) { () -> untyped } -> untyped
+
+      def on_record: (record: Hash[Symbol, untyped] ) -> untyped
+
+      def on_finish: (event_logs: Hash[Symbol, untyped] ) -> untyped
+
+      def before_interruption: (exception: ::Exception, event_logs: Hash[Symbol, untyped]) -> untyped
+    end
+
+    class Listeners
+      class Chain
+        include Listener
+
+        attr_reader listeners: Hash[Symbol, untyped]
+
+        def initialize: (Array[untyped]) -> void
+
+        def new: () -> Listeners
+
+        private
+
+        def listener?: (untyped, untyped) -> bool
+      end
+
+      def self.[]: (*untyped) -> Chain
+
+      private attr_reader listeners: Array[Listener]
+      private attr_reader around_and_then_listener: untyped
+      private attr_reader around_event_logs_listener: untyped
+
+      def initialize: (Array[Listener], untyped, untyped) -> void
+
+      def around_event_logs: (scope: Hash[Symbol, untyped]) { () -> untyped } -> untyped
+
+      def on_start: (scope: Hash[Symbol, untyped]) -> untyped
+
+      def around_and_then: (scope: Hash[Symbol, untyped], and_then: Hash[Symbol, untyped]) { () -> untyped } -> untyped
+
+      def on_record: (record: Hash[Symbol, untyped] ) -> untyped
+
+      def on_finish: (event_logs: Hash[Symbol, untyped] ) -> untyped
+
+      def before_interruption: (exception: ::Exception, event_logs: Hash[Symbol, untyped]) -> untyped
+    end
+
+    module Listener::Null
+      extend Listener
+
+      def self.new: () -> untyped
+    end
+
+    class Config
+      attr_reader listener: untyped
+      attr_reader trace_id: ::Proc
+
+      def self.instance: -> Config
+
+      def initialize: -> void
+
+      def listener=: (Listener) -> void
+      def trace_id=: (::Proc) -> void
+    end
+
+    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) -> Tree
+      def move_to!: (Node) -> Tree
+      def move_up!: (?Integer level) -> Tree
+      def move_down!: (?Integer level) -> Tree
+      def move_to_root!: () -> Tree
+
+      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: EventLogs::Tree
+      EMPTY_IDS: Hash[untyped, untyped]
+      VERSION: Integer
+      EMPTY: Hash[Symbol, untyped]
+
+      class Enabled
+        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
+
+        def exec: (untyped, untyped) { () -> untyped } -> untyped
+        def err!: (::Exception, untyped) -> void
+        def reset!: () -> void
+        def record: (BCDD::Result) -> void
+        def record_and_then: ((untyped), untyped) { () -> untyped } -> untyped
+        def reset_and_then!: () -> void
+
+        private
+
+        def start: (String, String) -> [EventLogs::Tree::Node, Hash[Symbol, untyped]]
+        def finish: (untyped) -> untyped
+
+        TreeNodeValueNormalizer: ^(Integer, Array[untyped]) -> untyped
+
+        def root_start: (Array[untyped]) -> void
+
+        def track: (BCDD::Result, time: Time) -> void
+        def track_record: (BCDD::Result, Time) -> Hash[Symbol, untyped]
+
+        def now_in_milliseconds: () -> Integer
+
+        def map_event_logs: () -> Hash[Symbol, untyped]
+
+        def build_listener: () -> Listener
+      end
+
+      module Disabled
+        def self.exec: (untyped, untyped) { () -> untyped } -> untyped
+        def self.err!: (::Exception) -> void
+        def self.reset!: () -> void
+        def self.record: (BCDD::Result) -> void
+        def self.record_and_then: ((untyped), untyped) { () -> BCDD::Result } -> BCDD::Result
+        def self.reset_and_then!: () -> void
+
+        private
+
+        def self.start: (String, String) -> void
+        def self.finish: (untyped) -> untyped
+      end
+
+      def self.instance: () -> (Enabled | singleton(Disabled))
+    end
+
+    THREAD_VAR_NAME: Symbol
+
+    EnsureResult: ^(untyped) -> BCDD::Result
+
+    def self.tracking: () -> (Tracking::Enabled | singleton(Tracking::Disabled))
+  end
+end

data/sig/bcdd/result/ignored_types.rbs

@@ -0,0 +1,9 @@
+class BCDD::Result
+  module IgnoredTypes
+    LIST: ::Set[::Symbol]
+    GIVEN: ::Symbol
+    CONTINUE: ::Symbol
+
+    def self.include?: (::Symbol) -> bool
+  end
+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: { (BCDD::Result::Config) -> void } -> BCDD::Result::Config
-  def self.transitions: { () -> untyped } -> BCDD::Result
+  def self.configuration: (freeze: bool) { (BCDD::Result::Config) -> void } -> (bool | BCDD::Result::Config)
+  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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-result
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-03-16 00:00:00.000000000 Z
 dependencies: []
-description: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway
-  Oriented Programming, and B/CDD.
+description: Unleash a pragmatic and observable use of Result Pattern and Railway-Oriented
+  Programming in Ruby.
 email:
 - rodrigo.serradura@gmail.com
 executables: []
@@ -26,8 +26,61 @@ files:
 - 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/bcdd.rb
+- examples/multiple_listeners/db/setup.rb
+- examples/multiple_listeners/lib/bcdd/result/event_logs_record.rb
+- examples/multiple_listeners/lib/bcdd/result/rollback_on_failure.rb
+- examples/multiple_listeners/lib/event_logs_listener/stdout.rb
+- examples/multiple_listeners/lib/runtime_breaker.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/bcdd.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/bcdd.rb
+- examples/single_listener/db/setup.rb
+- examples/single_listener/lib/bcdd/result/rollback_on_failure.rb
+- examples/single_listener/lib/runtime_breaker.rb
+- examples/single_listener/lib/single_event_logs_listener.rb
 - lib/bcdd-result.rb
+- lib/bcdd/context.rb
+- lib/bcdd/context/callable_and_then.rb
+- lib/bcdd/context/expectations.rb
+- lib/bcdd/context/expectations/mixin.rb
+- lib/bcdd/context/failure.rb
+- lib/bcdd/context/mixin.rb
+- lib/bcdd/context/success.rb
+- lib/bcdd/failure.rb
 - lib/bcdd/result.rb
+- lib/bcdd/result/_self.rb
 - lib/bcdd/result/callable_and_then.rb
 - lib/bcdd/result/callable_and_then/caller.rb
 - lib/bcdd/result/callable_and_then/config.rb
@@ -39,13 +92,6 @@ files:
 - 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/callable_and_then.rb
-- lib/bcdd/result/context/expectations.rb
-- lib/bcdd/result/context/expectations/mixin.rb
-- lib/bcdd/result/context/failure.rb
-- lib/bcdd/result/context/mixin.rb
-- lib/bcdd/result/context/success.rb
 - lib/bcdd/result/contract.rb
 - lib/bcdd/result/contract/disabled.rb
 - lib/bcdd/result/contract/error.rb
@@ -56,21 +102,26 @@ files:
 - lib/bcdd/result/contract/type_checker.rb
 - lib/bcdd/result/data.rb
 - lib/bcdd/result/error.rb
+- lib/bcdd/result/event_logs.rb
+- lib/bcdd/result/event_logs/config.rb
+- lib/bcdd/result/event_logs/listener.rb
+- lib/bcdd/result/event_logs/listeners.rb
+- lib/bcdd/result/event_logs/tracking.rb
+- lib/bcdd/result/event_logs/tracking/disabled.rb
+- lib/bcdd/result/event_logs/tracking/enabled.rb
+- lib/bcdd/result/event_logs/tree.rb
 - lib/bcdd/result/expectations.rb
 - lib/bcdd/result/expectations/mixin.rb
 - lib/bcdd/result/failure.rb
-- lib/bcdd/result/failure/methods.rb
 - lib/bcdd/result/handler.rb
 - lib/bcdd/result/handler/allowed_types.rb
+- lib/bcdd/result/ignored_types.rb
 - 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
+- lib/bcdd/success.rb
+- sig/bcdd/context.rbs
+- sig/bcdd/failure.rbs
 - sig/bcdd/result.rbs
 - sig/bcdd/result/callable_and_then.rbs
 - sig/bcdd/result/config.rbs
@@ -78,11 +129,13 @@ files:
 - sig/bcdd/result/contract.rbs
 - sig/bcdd/result/data.rbs
 - sig/bcdd/result/error.rbs
+- sig/bcdd/result/event_logs.rbs
 - sig/bcdd/result/expectations.rbs
 - sig/bcdd/result/handler.rbs
+- sig/bcdd/result/ignored_types.rbs
 - sig/bcdd/result/mixin.rbs
-- sig/bcdd/result/transitions.rbs
 - sig/bcdd/result/version.rbs
+- sig/bcdd/success.rbs
 homepage: https://github.com/b-cdd/result
 licenses:
 - MIT
@@ -107,9 +160,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
-summary: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway Oriented
-  Programming, and B/CDD.
+summary: Unleash a pragmatic and observable use of Result Pattern and Railway-Oriented
+  Programming in Ruby.
 test_files: []

data/lib/bcdd/result/context/failure.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-class BCDD::Result::Context::Failure < BCDD::Result::Context
-  include BCDD::Result::Failure::Methods
-
-  def and_expose(_type, _keys, **_options)
-    self
-  end
-end

data/lib/bcdd/result/context/success.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-class BCDD::Result
-  class Context::Success < Context
-    include ::BCDD::Result::Success::Methods
-
-    def and_expose(type, keys, terminal: true)
-      unless keys.is_a?(::Array) && !keys.empty? && keys.all?(::Symbol)
-        raise ::ArgumentError, 'keys must be an Array of Symbols'
-      end
-
-      Transitions.tracking.reset_and_then!
-
-      exposed_value = acc.merge(value).slice(*keys)
-
-      self.class.new(type: type, value: exposed_value, source: source, terminal: terminal)
-    end
-  end
-end

data/lib/bcdd/result/context.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-class BCDD::Result
-  class Context < self
-    require_relative 'context/failure'
-    require_relative 'context/success'
-    require_relative 'context/mixin'
-    require_relative 'context/expectations'
-    require_relative 'context/callable_and_then'
-
-    EXPECTED_OUTCOME = 'BCDD::Result::Context::Success or BCDD::Result::Context::Failure'
-
-    def self.Success(type, **value)
-      Success.new(type: type, value: value)
-    end
-
-    def self.Failure(type, **value)
-      Failure.new(type: type, value: value)
-    end
-
-    def initialize(type:, value:, source: nil, expectations: nil, terminal: nil)
-      value.is_a?(::Hash) or raise ::ArgumentError, 'value must be a Hash'
-
-      @acc = {}
-
-      super
-    end
-
-    def and_then(method_name = nil, **injected_value, &block)
-      super(method_name, injected_value, &block)
-    end
-
-    def and_then!(source, **injected_value)
-      _call = injected_value.delete(:_call)
-
-      acc.merge!(injected_value)
-
-      super(source, injected_value, _call: _call)
-    end
-
-    protected
-
-    attr_reader :acc
-
-    private
-
-    SourceMethodArity = ->(method) do
-      return 0 if method.arity.zero?
-
-      parameters = method.parameters.map(&:first)
-
-      return 1 if !parameters.empty? && parameters.all?(/\Akey/)
-
-      -1
-    end
-
-    def call_and_then_source_method!(method, injected_value)
-      acc.merge!(value.merge(injected_value))
-
-      case SourceMethodArity[method]
-      when 0 then source.send(method.name)
-      when 1 then source.send(method.name, **acc)
-      else raise Error::InvalidSourceMethodArity.build(source: source, method: method, max_arity: 1)
-      end
-    end
-
-    def call_and_then_block!(block)
-      acc.merge!(value)
-
-      block.call(acc)
-    end
-
-    def call_and_then_callable!(source, value:, injected_value:, method_name:)
-      acc.merge!(value.merge(injected_value))
-
-      CallableAndThen::Caller.call(source, value: acc, injected_value: injected_value, method_name: method_name)
-    end
-
-    def ensure_result_object(result, origin:)
-      raise_unexpected_outcome_error(result, origin) unless result.is_a?(Context)
-
-      return result.tap { _1.acc.merge!(acc) } if result.source.equal?(source)
-
-      raise Error::InvalidResultSource.build(given_result: result, expected_source: source)
-    end
-
-    def raise_unexpected_outcome_error(result, origin)
-      raise Error::UnexpectedOutcome.build(outcome: result, origin: origin, expected: EXPECTED_OUTCOME)
-    end
-
-    private_constant :SourceMethodArity
-  end
-end

data/lib/bcdd/result/failure/methods.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module BCDD::Result::Failure::Methods
-  def success?(_type = nil)
-    false
-  end
-
-  def failure?(type = nil)
-    type.nil? || type_checker.allow_failure?([type])
-  end
-
-  def value_or
-    yield(value)
-  end
-
-  private
-
-  def kind
-    :failure
-  end
-end

data/lib/bcdd/result/success/methods.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module BCDD::Result::Success::Methods
-  def success?(type = nil)
-    type.nil? || type_checker.allow_success?([type])
-  end
-
-  def failure?(_type = nil)
-    false
-  end
-
-  def value_or
-    value
-  end
-
-  private
-
-  def kind
-    :success
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module BCDD::Result::Transitions
-  module Tracking::Disabled
-    def self.exec(_name, _desc)
-      EnsureResult[yield]
-    end
-
-    def self.reset!; end
-
-    def self.record(result); end
-
-    def self.record_and_then(_type, _data, _source)
-      yield
-    end
-
-    def self.reset_and_then!; end
-
-    class << self
-      private
-
-      def start(name, desc); end
-
-      def finish(result); end
-    end
-  end
-end