bcdd-result 0.12.0 → 0.13.0

data/examples/single_listener/app/models/user/creation.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class User
+  class Creation
+    include BCDD::Context.mixin
+    include BCDD::Result::RollbackOnFailure
+
+    def call(**input)
+      BCDD::Result.transitions(name: self.class.name) do
+        Given(input)
+          .and_then(:normalize_input)
+          .and_then(:validate_input)
+          .and_then(:validate_email_uniqueness)
+          .then { |result|
+            rollback_on_failure {
+              result
+                .and_then(:create_user)
+                .and_then(:create_user_token)
+            }
+          }
+          .and_expose(:user_created, %i[user token])
+      end
+    end
+
+    private
+
+    def normalize_input(name:, email:, **options)
+      name = String(name).strip.gsub(/\s+/, ' ')
+      email = String(email).strip.downcase
+
+      uuid = String(options.fetch(:uuid) { ::SecureRandom.uuid }).strip.downcase
+
+      Continue(uuid:, name:, email:)
+    end
+
+    def validate_input(uuid:, name:, email:, password:, password_confirmation:)
+      err = ::Hash.new { |hash, key| hash[key] = [] }
+
+      err[:uuid] << 'must be an UUID' unless uuid.match?(/\A[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}\z/i)
+      err[:name] << 'must be present' if name.blank?
+      err[:email] << 'must be email' unless email.match?(::URI::MailTo::EMAIL_REGEXP)
+      err[:password] << 'must be present' if password.blank?
+      err[:password_confirmation] << 'must be present' if password_confirmation.blank?
+
+      err.empty? ? Continue() : Failure(:invalid_input, **err)
+    end
+
+    def validate_email_uniqueness(email:, **)
+      ::User.exists?(email:) ? Failure(:email_already_taken) : Continue()
+    end
+
+    def create_user(uuid:, name:, email:, password:, password_confirmation:)
+      ::RuntimeBreaker.try_to_interrupt(env: 'BREAK_USER_CREATION')
+
+      user = ::User.create(uuid:, name:, email:, password:, password_confirmation:)
+
+      user.persisted? ? Continue(user:) : Failure(:invalid_record, **user.errors.messages)
+    end
+
+    def create_user_token(user:, **)
+      Token::Creation.new.call(user: user).handle do |on|
+        on.success { |output| Continue(token: output[:token]) }
+        on.failure { raise 'Token creation failed' }
+      end
+    end
+  end
+end

data/examples/single_listener/app/models/user/token/creation.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class User::Token
+  class Creation
+    include BCDD::Context.mixin
+
+    def call(**input)
+      BCDD::Result.transitions(name: self.class.name) do
+        Given(input)
+          .and_then(:normalize_input)
+          .and_then(:validate_input)
+          .and_then(:validate_token_existence)
+          .and_then(:create_token)
+          .and_expose(:token_created, %i[token])
+      end
+    end
+
+    private
+
+    def normalize_input(**options)
+      Continue(executed_at: options.fetch(:executed_at) { ::Time.current })
+    end
+
+    def validate_input(user:, executed_at:)
+      err = ::Hash.new { |hash, key| hash[key] = [] }
+
+      err[:user] << 'must be a User' unless user.is_a?(::User)
+      err[:user] << 'must be persisted' unless user.try(:persisted?)
+      err[:executed_at] << 'must be a time' unless executed_at.is_a?(::Time)
+
+      err.empty? ? Continue() : Failure(:invalid_user, **err)
+    end
+
+    def validate_token_existence(user:, **)
+      user.token.nil? ? Continue() : Failure(:token_already_exists)
+    end
+
+    def create_token(user:, executed_at:, **)
+      ::RuntimeBreaker.try_to_interrupt(env: 'BREAK_USER_TOKEN_CREATION')
+
+      token = user.create_token(
+        access_token: ::SecureRandom.hex(24),
+        refresh_token: ::SecureRandom.hex(24),
+        access_token_expires_at: executed_at + 15.days,
+        refresh_token_expires_at: executed_at + 30.days
+      )
+
+      token.persisted? ? Continue(token:) : Failure(:token_creation_failed, **token.errors.messages)
+    end
+  end
+end

data/examples/single_listener/app/models/user/token.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class User::Token < ActiveRecord::Base
+  self.table_name = 'user_tokens'
+
+  belongs_to :user, inverse_of: :token
+end

data/examples/single_listener/app/models/user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class User < ActiveRecord::Base
+  has_secure_password
+
+  has_many :memberships, inverse_of: :user, dependent: :destroy, class_name: '::Account::Member'
+  has_many :accounts, through: :memberships, inverse_of: :users
+
+  where_ownership = -> { where(account_members: { role: :owner }) }
+
+  has_one :ownership, where_ownership, inverse_of: :user, class_name: '::Account::Member'
+  has_one :account, through: :ownership, inverse_of: :owner
+
+  has_one :token, inverse_of: :user, dependent: :destroy, class_name: '::User::Token'
+end

data/examples/single_listener/config/boot.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+$LOAD_PATH.unshift(__dir__)
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'sqlite3', '~> 1.7'
+  gem 'bcrypt', '~> 3.1.20'
+  gem 'activerecord', '~> 7.1', '>= 7.1.3', require: 'active_record'
+  gem 'bcdd-result', path: '../../'
+end
+
+require 'active_support/all'

data/examples/single_listener/config/initializers/bcdd.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+BCDD::Result.config.then do |config|
+  config.addon.enable!(:continue)
+
+  config.constant_alias.enable!('BCDD::Context')
+
+  config.pattern_matching.disable!(:nil_as_valid_value_checking)
+
+  # config.feature.disable!(:expectations) if Rails.env.production?
+end

data/examples/single_listener/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+$LOAD_PATH.unshift(__dir__)
+
+require_relative 'config/boot'
+require_relative 'config/initializers/bcdd'
+
+require 'db/setup'
+
+require 'lib/bcdd/result/rollback_on_failure'
+require 'lib/single_transitions_listener'
+require 'lib/runtime_breaker'
+
+require 'app/models/account'
+require 'app/models/account/member'
+require 'app/models/user'
+require 'app/models/user/token'
+
+require 'app/models/account/owner_creation'
+require 'app/models/user/token/creation'
+require 'app/models/user/creation'

data/examples/single_listener/db/setup.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+ActiveRecord::Base.establish_connection(
+  host: 'localhost',
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  suppress_messages do
+    create_table :accounts do |t|
+      t.string :uuid, null: false, index: {unique: true}
+
+      t.timestamps
+    end
+
+    create_table :users do |t|
+      t.string :uuid, null: false, index: {unique: true}
+      t.string :name, null: false
+      t.string :email, null: false, index: {unique: true}
+      t.string :password_digest, null: false
+
+      t.timestamps
+    end
+
+    create_table :user_tokens do |t|
+      t.belongs_to :user, null: false, foreign_key: true, index: true
+      t.string :access_token, null: false
+      t.string :refresh_token, null: false
+      t.datetime :access_token_expires_at, null: false
+      t.datetime :refresh_token_expires_at, null: false
+
+      t.timestamps
+    end
+
+    create_table :account_members do |t|
+      t.integer :role, null: false, default: 0
+      t.belongs_to :user, null: false, foreign_key: true, index: true
+      t.belongs_to :account, null: false, foreign_key: true, index: true
+
+      t.timestamps
+
+      t.index %i[account_id role], unique: true, where: "(role = 0)"
+      t.index %i[account_id user_id], unique: true
+    end
+  end
+end

data/examples/single_listener/lib/bcdd/result/rollback_on_failure.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BCDD::Result::RollbackOnFailure
+  def rollback_on_failure(model: ::ActiveRecord::Base)
+    result = nil
+
+    model.transaction do
+      result = yield
+
+      raise ::ActiveRecord::Rollback if result.failure?
+    end
+
+    result
+  end
+end

data/examples/single_listener/lib/runtime_breaker.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RuntimeBreaker
+  Interruption = Class.new(StandardError)
+
+  def self.try_to_interrupt(env:)
+    return unless String(ENV[env]).strip.start_with?(/1|t/)
+
+    raise Interruption, "Runtime breaker activated (#{env})"
+  end
+end

data/examples/single_listener/lib/single_transitions_listener.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class SingleTransitionsListener
+  include BCDD::Result::Transitions::Listener
+
+  # A listener will be initialized before the first transition, and it is discarded after the last one.
+  def initialize
+    @buffer = []
+  end
+
+  # This method will be called before each transition block.
+  # The parent transition block will be called first in the case of nested transition blocks.
+  #
+  # @param scope: {:id=>1, :name=>"SomeOperation", :desc=>"Optional description"}
+  def on_start(scope:)
+    scope => { id:, name:, desc: }
+
+    @buffer << [id, "##{id} #{name} - #{desc}".chomp('- ')]
+  end
+
+  # This method will wrap all the transitions in the same block.
+  # It can be used to perform an instrumentation (measure/report) of the transitions.
+  #
+  # @param scope: {:id=>1, :name=>"SomeOperation", :desc=>"Optional description"}
+  def around_transitions(scope:)
+    yield
+  end
+
+  # This method will wrap each and_then call.
+  # It can be used to perform an instrumentation (measure/report) of the and_then calls.
+  #
+  # @param scope: {:id=>1, :name=>"SomeOperation", :desc=>"Optional description"}
+  # @param and_then:
+  #  {:type=>:block, :arg=>:some_injected_value}
+  #  {:type=>:method, :arg=>:some_injected_value, :method_name=>:some_method_name}
+  def around_and_then(scope:, and_then:)
+    yield
+  end
+
+  # This method will be called after each result recording/tracking.
+  #
+  # @param record:
+  # {
+  #   :root => {:id=>0, :name=>"RootOperation", :desc=>nil},
+  #   :parent => {:id=>0, :name=>"RootOperation", :desc=>nil},
+  #   :current => {:id=>1, :name=>"SomeOperation", :desc=>nil},
+  #   :result => {:kind=>:success, :type=>:_continue_, :value=>{some: :thing}, :source=><MyProcess:0x0000000102fd6378>},
+  #   :and_then => {:type=>:method, :arg=>nil, :method_name=>:some_method},
+  #   :time => 2024-01-26 02:53:11.310431 UTC
+  # }
+  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
+
+  # This method will be called at the end of the transitions tracking.
+  #
+  # @param transitions:
+  # {
+  #   :version => 1,
+  #   :metadata => {
+  #     :duration => 0,
+  #     :trace_id => nil,
+  #     :ids_tree => [0, [[1, []], [2, []]]],
+  #     :ids_matrix => {0 => [0, 0], 1 => [1, 1], 2 => [2, 1]}
+  #   },
+  #   :records => [
+  #     # ...
+  #   ]
+  # }
+  def on_finish(transitions:)
+    messages = MapNestedMessages[transitions, @buffer, ENV['HIDE_GIVEN_AND_CONTINUE']]
+
+    puts messages.join("\n")
+  end
+
+  # This method will be called when an exception is raised during the transitions tracking.
+  #
+  # @param exception: Exception
+  # @param transitions: Hash
+  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/callable_and_then/caller.rb

@@ -5,7 +5,7 @@ class BCDD::Result
     def self.call(source, value:, injected_value:, method_name:)
       method = callable_method(source, method_name)
 
-      Transitions.tracking.record_and_then(method, injected_value, source) do
+      Transitions.tracking.record_and_then(method, injected_value) do
         result =
           if source.is_a?(::Proc)
             call_proc!(source, value, injected_value)

data/lib/bcdd/result/config.rb

@@ -9,7 +9,7 @@ require_relative 'config/switchers/pattern_matching'
 
 class BCDD::Result
   class Config
-    include Singleton
+    include ::Singleton
 
     attr_reader :addon, :feature, :constant_alias, :pattern_matching
 
@@ -21,6 +21,10 @@ class BCDD::Result
       @and_then_ = CallableAndThen::Config.new
     end
 
+    def transitions
+      Transitions::Config.instance
+    end
+
     def and_then!
       @and_then_
     end
@@ -31,6 +35,7 @@ class BCDD::Result
       constant_alias.freeze
       pattern_matching.freeze
       and_then!.freeze
+      transitions.freeze
 
       super
     end

data/lib/bcdd/result/context/expectations/mixin.rb

@@ -9,7 +9,7 @@ class BCDD::Result::Context
     module Addons
       module Continue
         private def Continue(**value)
-          Success.new(type: :continued, value: value, source: self)
+          Success(::BCDD::Result::IgnoredTypes::CONTINUE, **value)
         end
       end
 
@@ -17,7 +17,7 @@ class BCDD::Result::Context
         private def Given(*values)
           value = values.map(&:to_h).reduce({}) { |acc, val| acc.merge(val) }
 
-          Success.new(type: :given, value: value, source: self)
+          Success(::BCDD::Result::IgnoredTypes::GIVEN, **value)
         end
       end
 

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

@@ -25,7 +25,7 @@ class BCDD::Result::Context
         end
 
         private def Continue(**value)
-          _ResultAs(Success, :continued, value)
+          _ResultAs(Success, ::BCDD::Result::IgnoredTypes::CONTINUE, value)
         end
       end
 
@@ -33,7 +33,7 @@ class BCDD::Result::Context
         private def Given(*values)
           value = values.map(&:to_h).reduce({}) { |acc, val| acc.merge(val) }
 
-          _ResultAs(Success, :given, value)
+          _ResultAs(Success, ::BCDD::Result::IgnoredTypes::GIVEN, value)
         end
       end
 

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

@@ -1,9 +1,23 @@
 # frozen_string_literal: true
 
 class BCDD::Result
+  class Context::Error < BCDD::Result::Error
+    InvalidExposure = ::Class.new(self)
+  end
+
   class Context::Success < Context
     include ::BCDD::Result::Success::Methods
 
+    FetchValues = ->(acc_values, keys) do
+      fetched_values = acc_values.fetch_values(*keys)
+
+      keys.zip(fetched_values).to_h
+    rescue ::KeyError => e
+      message = "#{e.message}. Available to expose: #{acc_values.keys.map(&:inspect).join(', ')}"
+
+      raise Context::Error::InvalidExposure, message
+    end
+
     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'
@@ -11,9 +25,13 @@ class BCDD::Result
 
       Transitions.tracking.reset_and_then!
 
-      exposed_value = acc.merge(value).slice(*keys)
+      acc_values = acc.merge(value)
+
+      value_to_expose = FetchValues.call(acc_values, keys)
+
+      expectations = type_checker.expectations
 
-      self.class.new(type: type, value: exposed_value, source: source, terminal: terminal)
+      self.class.new(type: type, value: value_to_expose, source: source, terminal: terminal, expectations: expectations)
     end
   end
 end

data/lib/bcdd/result/contract/for_types.rb

@@ -11,7 +11,7 @@ class BCDD::Result
     end
 
     def type?(type)
-      allowed_types.member?(type)
+      IgnoredTypes.include?(type) || allowed_types.member?(type)
     end
 
     def type!(type)

data/lib/bcdd/result/contract/for_types_and_values.rb

@@ -30,6 +30,8 @@ class BCDD::Result
     def type_and_value!(data)
       type, value = data.type, data.value
 
+      return value if IgnoredTypes.include?(type)
+
       value_checking = @types_and_values[type!(type)]
 
       checking_result = value_checking === value

data/lib/bcdd/result/expectations/mixin.rb

@@ -38,13 +38,13 @@ class BCDD::Result
     module Addons
       module Continue
         private def Continue(value)
-          Success.new(type: :continued, value: value, source: self)
+          _Result.Success(IgnoredTypes::CONTINUE, value)
         end
       end
 
       module Given
         private def Given(value)
-          Success.new(type: :given, value: value, source: self)
+          _Result.Success(IgnoredTypes::GIVEN, value)
         end
       end
 

data/lib/bcdd/result/ignored_types.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  module IgnoredTypes
+    LIST = ::Set[
+      GIVEN = :_given_,
+      CONTINUE = :_continue_
+    ].freeze
+
+    def self.include?(type)
+      LIST.member?(type)
+    end
+  end
+end

data/lib/bcdd/result/mixin.rb

@@ -32,13 +32,13 @@ class BCDD::Result
         end
 
         private def Continue(value)
-          _ResultAs(Success, :continued, value)
+          _ResultAs(Success, IgnoredTypes::CONTINUE, value)
         end
       end
 
       module Given
         private def Given(value)
-          _ResultAs(Success, :given, value)
+          _ResultAs(Success, IgnoredTypes::GIVEN, value)
         end
       end
 

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BCDD::Result::Transitions
+  class Config
+    include ::Singleton
+
+    attr_reader :listener, :trace_id
+
+    def initialize
+      @trace_id = -> {}
+      @listener = Listener::Null.new
+    end
+
+    def listener=(arg)
+      Listener.kind?(arg) or raise ::ArgumentError, "#{arg.inspect} must be a #{Listener}"
+
+      @listener = arg
+    end
+
+    def trace_id=(arg)
+      raise ::ArgumentError, 'must be a lambda with arity 0' unless arg.is_a?(::Proc) && arg.lambda? && arg.arity.zero?
+
+      @trace_id = arg
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module BCDD::Result::Transitions
+  module Listener
+    module ClassMethods
+      def around_transitions?
+        false
+      end
+
+      def around_and_then?
+        false
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def self.extended(base)
+      base.extend(ClassMethods)
+    end
+
+    def self.kind?(arg)
+      (arg.is_a?(::Class) && arg < self) || (arg.is_a?(::Module) && arg.is_a?(self)) || arg.is_a?(Listeners::Chain)
+    end
+
+    def on_start(scope:); end
+
+    def around_transitions(scope:)
+      yield
+    end
+
+    def around_and_then(scope:, and_then:)
+      yield
+    end
+
+    def on_record(record:); end
+
+    def on_finish(transitions:); end
+
+    def before_interruption(exception:, transitions:); end
+  end
+
+  module Listener::Null
+    extend Listener
+
+    def self.new
+      self
+    end
+  end
+end