bcdd-result 0.13.0 → 1.1.0

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-result
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies: []
 description: Unleash a pragmatic and observable use of Result Pattern and Railway-Oriented
   Programming in Ruby.
@@ -38,10 +38,23 @@ files:
 - 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/bcdd/result/transitions_record.rb
+- examples/multiple_listeners/lib/event_logs_listener/stdout.rb
 - examples/multiple_listeners/lib/runtime_breaker.rb
-- examples/multiple_listeners/lib/transitions_listener/stdout.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
@@ -56,9 +69,18 @@ files:
 - 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_transitions_listener.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
@@ -70,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
@@ -87,25 +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/config.rb
-- lib/bcdd/result/transitions/listener.rb
-- lib/bcdd/result/transitions/listeners.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
@@ -113,12 +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
@@ -143,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Unleash a pragmatic and observable use of Result Pattern and Railway-Oriented

data/examples/multiple_listeners/lib/bcdd/result/transitions_record.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-class BCDD::Result::TransitionsRecord < ActiveRecord::Base
-  self.table_name = 'bcdd_result_transitions'
-
-  class Listener
-    include ::BCDD::Result::Transitions::Listener
-
-    def on_finish(transitions:)
-        metadata = transitions[:metadata]
-        root_name = transitions.dig(:records, 0, :root, :name) || 'Unknown'
-
-        BCDD::Result::TransitionsRecord.create(
-          root_name: root_name,
-          trace_id: metadata[:trace_id],
-          version: transitions[:version],
-          duration: metadata[:duration],
-          ids_tree: metadata[:ids_tree],
-          ids_matrix: metadata[:ids_matrix],
-          records: transitions[:records]
-        )
-    rescue ::StandardError => e
-      err = "#{e.message} (#{e.class}); Backtrace: #{e.backtrace.join(', ')}"
-
-      ::Kernel.warn "Error on BCDD::Result::TransitionsRecord::Listener#on_finish: #{err}"
-    end
-  end
-end

data/examples/multiple_listeners/lib/transitions_listener/stdout.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-class TransitionsListener::Stdout
-  include BCDD::Result::Transitions::Listener
-
-  def initialize
-    @buffer = []
-  end
-
-  def on_start(scope:)
-    scope => { id:, name:, desc: }
-
-    @buffer << [id, "##{id} #{name} - #{desc}".chomp('- ')]
-  end
-
-  def on_record(record:)
-    record => { current: { id: }, result: { kind:, type: } }
-
-    method_name = record.dig(:and_then, :method_name)
-
-    @buffer << [id, " * #{kind}(#{type}) from method: #{method_name}".chomp('from method: ')]
-  end
-
-  MapNestedMessages = ->(transitions, buffer, hide_given_and_continue) do
-    ids_matrix = transitions.dig(:metadata, :ids_matrix)
-
-    messages = buffer.filter_map { |(id, msg)| "#{'   ' * ids_matrix[id].last}#{msg}" if ids_matrix[id] }
-
-    messages.reject! { _1.match?(/\(_(given|continue)_\)/) } if hide_given_and_continue
-
-    messages
-  end
-
-  def on_finish(transitions:)
-    messages = MapNestedMessages[transitions, @buffer, ENV['HIDE_GIVEN_AND_CONTINUE']]
-
-    puts messages.join("\n")
-  end
-
-  def before_interruption(exception:, transitions:)
-    messages = MapNestedMessages[transitions, @buffer, ENV['HIDE_GIVEN_AND_CONTINUE']]
-
-    puts messages.join("\n")
-
-    bc = ::ActiveSupport::BacktraceCleaner.new
-    bc.add_filter { |line| line.gsub(__dir__.sub('/lib', ''), '').sub(/\A\//, '')}
-    bc.add_silencer { |line| /lib\/bcdd\/result/.match?(line) }
-    bc.add_silencer { |line| line.include?(RUBY_VERSION) }
-
-    backtrace = bc.clean(exception.backtrace)
-
-    puts "\nException: #{exception.message} (#{exception.class}); Backtrace: #{backtrace.join(", ")}"
-  end
-end

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.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.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-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, &block)
-    Transitions.tracking.exec(name, desc, &block)
-  end
-end