bcdd-process 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9aec3a08f8e5f7dd092929d24fb76c2c1b95d07bf13b3683256daafe19595070
+  data.tar.gz: bb29f54a9ec8129bfbb52a1465736df59fa0c34957dc5cebe9566c3d312ec040
+SHA512:
+  metadata.gz: 15b804dd0b7b72c1e2c93013619677f1ca45db9f9fe56cb818c83ef59c2974064304366475d43b6e0a2232c677bff7edc76c439c773c083868e3fe1600ef06d9
+  data.tar.gz: 02da1b070eb0f1ad40b5c04e719aae2759aaaaca9fac878c4abc4afb588a788032417d9a3a4f754baeb81a70d9dbc9f2d41ac485917a24f547442a4b6e855768

data/.rubocop.yml

@@ -0,0 +1,90 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'examples/**/*'
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+
+Layout/LineLength:
+  Max: 120
+
+Layout/ExtraSpacing:
+  AllowBeforeTrailingComments: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/MapToSet:
+  Enabled: false
+
+Style/MixinGrouping:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*.rb
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Minitest/AssertEmptyLiteral:
+  Enabled: false
+
+Minitest/AssertOperator:
+  Enabled: false
+
+Minitest/AssertWithExpectedArgument:
+  Exclude:
+    - test/test_helper.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/bcdd-process.rb

data/.rubocop_todo.yml

@@ -0,0 +1,28 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-02-01 01:06:41 UTC using RuboCop version 1.60.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/bcdd/process.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 13

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.2.0] - 2024-02-01
+
+- Update gem's dependencies.
+  - bcdd-contract >= 0.1.0
+  - bcdd-result >= 0.3.0
+
+## [0.1.0] - 2024-02-01
+
+- Add `BCDD::Process` - Initial/POC release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rodrigo.serradura@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Rodrigo Serradura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+<p align="center">
+  <h1 align="center" id="-bcddresult">🚄 BCDD::Process</h1>
+  <p align="center"><i>Write reliable, self-documented, and self-observable business processes in Ruby.</i></p>
+</p>
+
+## Ruby Version
+
+`>= 2.7.0`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bcdd-process'
+```
+
+And then execute:
+
+    $ bundle install
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install bcdd-process
+
+And require it in your code:
+
+    require 'bcdd/process'
+
+## Usage Example
+
+Check out the [examples/business_processes](examples/business_processes) directory for a complete (Rails like app) example.
+
+```ruby
+class User
+  class Creation < ::BCDD::Process
+    include BCDD::Result::RollbackOnFailure
+
+    input do
+      attribute :uuid, contract: :is_uuid, default: -> { ::SecureRandom.uuid }, normalize: -> { _1.strip.downcase }
+      attribute :name, contract: :is_str, normalize: -> { _1.strip.gsub(/\s+/, ' ') }
+      attribute :email, contract: :is_email, normalize: -> { _1.strip.downcase }
+      attribute :password, contract: :is_password
+      attribute :password_confirmation, contract: :is_password
+    end
+
+    output do
+      Failure(
+        invalid_user: :errors_by_attribute,
+        email_already_taken: :empty_hash,
+      )
+
+      user = contract[::User] & :is_persisted
+      token = contract[Token] & :is_persisted
+
+      Success(user_created: { user:, token: })
+    end
+
+    def call(**input)
+      Given(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
+
+    private
+
+    def validate_email_uniqueness(email:, **)
+      ::User.exists?(email:) ? Failure(:email_already_taken) : Continue()
+    end
+
+    def create_user(uuid:, name:, email:, password:, password_confirmation:)
+      user = ::User.create(uuid:, name:, email:, password:, password_confirmation:)
+
+      user.persisted? ? Continue(user:) : Failure(:invalid_user, **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
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/b-cdd/process. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/b-cdd/process/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BCDD::Process project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/b-cdd/process/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.warning = false
+
+  t.libs += %w[lib test]
+
+  t.test_files = FileList.new('test/**/*_test.rb')
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/business_processes/Rakefile

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+if RUBY_VERSION <= '3.1'
+  puts 'This example requires Ruby 3.1 or higher.'
+  exit! 1
+end
+
+# Usage:
+#
+# rake DISABLE_TRANSITIONS=t
+# rake DISABLE_LISTENER=t
+#
+# rake HIDE_GIVEN_AND_CONTINUE=t
+#
+# rake BREAK_ACCOUNT_CREATION=t
+# rake BREAK_USER_CREATION=t
+# rake BREAK_USER_TOKEN_CREATION=t
+#
+# rake BREAK_ACCOUNT_CREATION=t HIDE_GIVEN_AND_CONTINUE=t
+task default: %i[bcdd_result_transitions]
+
+desc 'creates an account and an owner user through BCDD::Result'
+task :bcdd_result_transitions do
+  require_relative 'config'
+
+  BCDD::Result.configuration do |config|
+    config.feature.disable!(:transitions) if ENV['DISABLE_TRANSITIONS']
+
+    unless ENV['DISABLE_LISTENER']
+      # config.transitions.listener = BCDD::Result::TransitionsRecord::Listener
+      config.transitions.listener = BCDD::Result::Transitions::Listeners[
+        TransitionsListener::Stdout,
+        BCDD::Result::TransitionsRecord::Listener
+      ]
+    end
+  end
+
+  result = nil
+
+  bench = Benchmark.measure do
+    result = Account::OwnerCreation.new.call(
+      owner: {
+        name: "\tJohn     Doe \n",
+        email: '   JOHN.doe@email.com',
+        password: '123123123',
+        password_confirmation: '123123123'
+      }
+    )
+  rescue RuntimeBreaker::Interruption => e
+    nil
+  end
+
+  puts "\nBCDD::Result::TransitionsRecord.count: #{BCDD::Result::TransitionsRecord.count}"
+
+  puts "\nBenchmark: #{bench}"
+end

data/examples/business_processes/app/models/account/member.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Account::Member < ActiveRecord::Base
+  self.table_name = 'account_members'
+
+  enum role: { owner: 0, admin: 1, contributor: 2 }
+
+  belongs_to :user, inverse_of: :memberships
+  belongs_to :account, inverse_of: :memberships
+end

data/examples/business_processes/app/models/account/owner_creation.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+class Account
+  class OwnerCreation < ::BCDD::Process
+    include BCDD::Result::RollbackOnFailure
+
+    input do
+      attribute :uuid, contract: :is_uuid, default: -> { ::SecureRandom.uuid }, normalize: -> { _1.strip.downcase }
+      attribute :owner, type: ::Hash, validate: :is_present
+    end
+
+    output do
+      Failure(
+        invalid_owner: ::Hash,
+        invalid_account: :errors_by_attribute,
+      )
+
+      user = contract[::User] & :is_persisted
+      account = contract[::Account] & :is_persisted
+
+      Success(account_owner_created: { account:, user: })
+    end
+
+    def call(**input)
+      Given(input)
+        .then { |result|
+          rollback_on_failure {
+            result
+              .and_then(:create_owner)
+              .and_then(:create_account)
+              .and_then(:link_owner_to_account)
+          }
+        }.and_expose(:account_owner_created, %i[account user])
+    end
+
+    private
+
+    def create_owner(owner:, **)
+      ::User::Creation.call(**owner).handle do |on|
+        on.success { |output| Continue(user: output[:user]) }
+        on.failure { |output| Failure(:invalid_owner, **output) }
+      end
+    end
+
+    def create_account(uuid:, **)
+      ::RuntimeBreaker.try_to_interrupt(env: 'BREAK_ACCOUNT_CREATION')
+
+      account = ::Account.create(uuid:)
+
+      account.persisted? ? Continue(account:) : Failure(:invalid_account, **account.errors.messages)
+    end
+
+    def link_owner_to_account(account:, user:, **)
+      Member.create!(account:, user:, role: :owner)
+
+      Continue()
+    end
+  end
+end

data/examples/business_processes/app/models/account.rb

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

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class User
+  class Creation < ::BCDD::Process
+    include BCDD::Result::RollbackOnFailure
+
+    input do
+      attribute :uuid, contract: :is_uuid, default: -> { ::SecureRandom.uuid }, normalize: -> { _1.strip.downcase }
+      attribute :name, contract: :is_str, normalize: -> { _1.strip.gsub(/\s+/, ' ') }
+      attribute :email, contract: :is_email, normalize: -> { _1.strip.downcase }
+      attribute :password, contract: :is_password
+      attribute :password_confirmation, contract: :is_password
+    end
+
+    output do
+      Failure(
+        invalid_user: :errors_by_attribute,
+        email_already_taken: :empty_hash,
+      )
+
+      user = contract[::User] & :is_persisted
+      token = contract[Token] & :is_persisted
+
+      Success(user_created: { user:, token: })
+    end
+
+    def call(**input)
+      Given(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
+
+    private
+
+    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_user, **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/business_processes/app/models/user/token/creation.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class User::Token
+  class Creation < ::BCDD::Process
+    input do
+      attribute :user, contract: contract[::User] & :is_persisted
+      attribute :executed_at, contract: contract[::Time], default: -> { ::Time.current }
+    end
+
+    output do
+      Failure(
+        token_already_exists: :empty_hash,
+        token_creation_failed: :errors_by_attribute
+      )
+
+      token = contract[User::Token] & :is_persisted
+
+      Success(token_created: { token: })
+    end
+
+    def call(**input)
+      Given(input)
+        .and_then(:validate_token_existence)
+        .and_then(:create_token)
+        .and_expose(:token_created, %i[token])
+    end
+
+    private
+
+    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/business_processes/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/business_processes/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/business_processes/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-process', path: '../../'
+end
+
+require 'active_support/all'

data/examples/business_processes/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/business_processes/config.rb

@@ -0,0 +1,28 @@
+# 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/bcdd/result/transitions_record'
+require 'lib/bcdd/contracts'
+require 'lib/runtime_breaker'
+
+module TransitionsListener
+  require 'lib/transitions_listener/stdout'
+end
+
+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/business_processes/db/setup.rb

@@ -0,0 +1,61 @@
+# 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 :bcdd_result_transitions do |t|
+      t.string :root_name, null: false, index: true
+      t.string :trace_id, index: true
+      t.integer :version, null: false
+      t.integer :duration, null: false, index: true
+      t.json :ids_tree, null: false, default: []
+      t.json :ids_matrix, null: false, default: {}
+      t.json :records, null: false, default: []
+
+      t.timestamps
+    end
+
+    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/business_processes/lib/bcdd/contracts.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BCDD::Contracts
+  HasSize = ->(min, max) { ->(val) { val.size.between?(min, max) or "must be >= #{min} and <= #{max} chars" } }
+
+  is_str = ::BCDD::Contract[::String]
+  is_uuid = ->(val) { val.match?(/\A[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}\z/) or '%p must be an UUID' }
+  is_email = ->(val) { val.match?(::URI::MailTo::EMAIL_REGEXP) or '%p must be an email' }
+  is_present = ->(val) { val.present? or '%p must be present' }
+  is_persisted = ->(val) { val.persisted? or '%p must be persisted' }
+
+  ::BCDD::Contract.register(
+    is_str: is_str,
+    is_uuid: is_str & is_present & is_uuid,
+    is_email: is_str & is_present& is_email,
+    is_present: is_present,
+    is_password: is_str & is_present & HasSize[8, 72],
+    is_persisted: is_persisted
+  )
+
+  EmptyHash = ::BCDD::Contract[::Hash] & ->(value) { value.empty? }
+  ErrorMessages = ::BCDD::Contract[errors: [::String]]
+  ErrorsByAttribute = ::BCDD::Contract.pairs(::Symbol => [::String])
+
+  ::BCDD::Contract.register(
+    empty_hash: EmptyHash,
+    error_messages: ErrorMessages,
+    errors_by_attribute: ErrorsByAttribute
+  )
+end

data/examples/business_processes/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/business_processes/lib/bcdd/result/transitions_record.rb

@@ -0,0 +1,34 @@
+# 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'
+
+      records = transitions[:records].map do |record|
+        record.deep_transform_values do |value|
+          value.is_a?(::BCDD::Process) ? value.class.name : value
+        end
+      end
+
+      BCDD::Result::TransitionsRecord.create(
+        root_name: root_name,
+        duration: metadata[:duration],
+        trace_id: metadata[:trace_id],
+        ids_tree: metadata[:ids_tree],
+        ids_matrix: metadata[:ids_matrix],
+        version: transitions[:version],
+        records: 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/business_processes/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/business_processes/lib/transitions_listener/stdout.rb

@@ -0,0 +1,54 @@
+# 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/process/caller.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BCDD
+  class Process
+    module Caller
+      class NullContract
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+
+        def invalid?
+          false
+        end
+      end
+
+      PrepareInputs = ->(spec, input) do
+        spec.each_with_object({}) do |(name, options), result|
+          value = input.fetch(name) do
+            if options.key?(:default)
+              default = options[:default]
+
+              default.is_a?(::Proc) ? default.call : default
+            end
+          end
+
+          value = options[:normalize].call(value) if options.key?(:normalize)
+
+          result[name] = options.key?(:contract) ? options[:contract][value] : NullContract.new(value)
+        end
+      end
+
+      def call(**inputs)
+        prepared_input = PrepareInputs[self.class.__input__, inputs]
+
+        Result.transitions(name: self.class.name) do
+          if self.class.__input_contract__
+            invalid_input = prepared_input.select { |_key, value| value.invalid? }
+
+            return Failure(:invalid_input, **invalid_input.transform_values(&:errors)) unless invalid_input.empty?
+          end
+
+          super(**prepared_input.transform_values!(&:value))
+        end
+      end
+    end
+  end
+end

data/lib/bcdd/process/input_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module BCDD
+  class Process
+    class InputSpec
+      module MapContract
+        def self.[](options)
+          required = options.fetch(:required, true)
+
+          if options.key?(:contract) || options.key?(:type) || options.key?(:validate)
+            resolve(options).then { required ? _1 : (_1 | nil) }
+          elsif required
+            Contracts::CannotBeNil
+          end
+        end
+
+        def self.resolve(options)
+          return ::BCDD::Contract[options[:contract]] if options.key?(:contract)
+
+          type = ::BCDD::Contract.unit(options[:type]) if options.key?(:type)
+          validate = ::BCDD::Contract.unit(options[:validate]) if options.key?(:validate)
+
+          type && validate ? (type & validate) : type || validate
+        end
+      end
+
+      MapDefault = ->(options) do
+        value = options[:default]
+
+        return value unless value.is_a?(Proc)
+        return value if value.lambda? && value.arity.zero?
+
+        raise ArgumentError, 'Default value must be a lambda with zero arity'
+      end
+
+      MapNormalize = ->(options) do
+        value = options[:normalize]
+
+        return value if value.is_a?(Proc) && value.lambda? && value.arity == 1
+
+        raise ArgumentError, 'normalize value must be a lambda with one arity'
+      end
+
+      # :nodoc:
+      attr_reader :__result__
+
+      def initialize
+        @__result__ = {}
+      end
+
+      def attribute(name, **options)
+        name.is_a?(Symbol) or raise ArgumentError, "#{name.inspect} must be a Symbol"
+
+        if options.key?(:contract) && (options.key?(:type) || options.key?(:validate))
+          raise ArgumentError, 'Cannot specify both :contract and (:type or :validate)'
+        end
+
+        spec = {}
+        spec[:default] = MapDefault[options] if options.key?(:default)
+        spec[:normalize] = MapNormalize[options] if options.key?(:normalize)
+
+        MapContract[options].then { spec[:contract] = _1 if _1 }
+
+        __result__[name] = spec
+      end
+
+      def contract
+        BCDD::Contract
+      end
+    end
+  end
+end

data/lib/bcdd/process/output_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BCDD
+  class Process
+    class OutputSpec
+      def initialize
+        @success = {}
+        @failure = {}
+      end
+
+      def Success(**spec)
+        @success = spec.transform_values(&BCDD::Contract)
+      end
+
+      def Failure(**spec)
+        @failure = spec.transform_values(&BCDD::Contract)
+      end
+
+      # :nodoc:
+      def __result__
+        { success: @success, failure: @failure }
+      end
+
+      private
+
+      def contract
+        ::BCDD::Contract
+      end
+    end
+  end
+end

data/lib/bcdd/process/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BCDD
+  class Process
+    VERSION = '0.2.0'
+  end
+end

data/lib/bcdd/process.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'bcdd/result'
+require 'bcdd/contract'
+
+require_relative 'process/version'
+require_relative 'process/caller'
+require_relative 'process/input_spec'
+require_relative 'process/output_spec'
+
+module BCDD
+  module Contracts
+    CannotBeNil = BCDD::Contract[-> { _1.nil? and 'cannot be nil' }]
+  end
+
+  class Process
+    class << self
+      attr_reader :__input__, :__input_contract__, :__output__
+
+      def input(&block)
+        return @__input__ if defined?(@__input__)
+
+        spec = InputSpec.new
+        spec.instance_eval(&block)
+        spec.__result__.transform_values!(&:freeze).freeze
+
+        @__input_contract__ = spec.__result__.any? { |_key, value| value.key?(:contract) }
+        @__input__ = spec.__result__
+      end
+
+      def output(expectations: true, &block)
+        @__output__ and raise ArgumentError, 'outputs already defined'
+
+        config = { addon: { given: true, continue: true } }
+
+        if expectations
+          spec = OutputSpec.new
+          spec.instance_eval(&block)
+
+          output = spec.__result__
+          success = output[:success]
+          failure = output.fetch(:failure, {}).merge(invalid_input: ::Hash)
+
+          include(Result::Context::Expectations.mixin(config: config, success: success, failure: failure))
+        else
+          include(Result::Context.mixin(config: config))
+        end
+
+        @__output__ = { expectations: expectations }.freeze
+      end
+
+      def inherited(subclass)
+        subclass.prepend(Caller)
+      end
+
+      def call(**input)
+        new.call(**input)
+      end
+    end
+  end
+end

data/lib/bcdd-process.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bcdd/process'

data/sig/bcdd/process.rbs

@@ -0,0 +1,6 @@
+module BCDD
+  module Process
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: bcdd-process
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Rodrigo Serradura
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcdd-contract
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bcdd-result
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Write reliable, self-documented, and self-observable business processes
+  in Ruby.
+email:
+- rodrigo.serradura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/business_processes/Rakefile
+- examples/business_processes/app/models/account.rb
+- examples/business_processes/app/models/account/member.rb
+- examples/business_processes/app/models/account/owner_creation.rb
+- examples/business_processes/app/models/user.rb
+- examples/business_processes/app/models/user/creation.rb
+- examples/business_processes/app/models/user/token.rb
+- examples/business_processes/app/models/user/token/creation.rb
+- examples/business_processes/config.rb
+- examples/business_processes/config/boot.rb
+- examples/business_processes/config/initializers/bcdd.rb
+- examples/business_processes/db/setup.rb
+- examples/business_processes/lib/bcdd/contracts.rb
+- examples/business_processes/lib/bcdd/result/rollback_on_failure.rb
+- examples/business_processes/lib/bcdd/result/transitions_record.rb
+- examples/business_processes/lib/runtime_breaker.rb
+- examples/business_processes/lib/transitions_listener/stdout.rb
+- lib/bcdd-process.rb
+- lib/bcdd/process.rb
+- lib/bcdd/process/caller.rb
+- lib/bcdd/process/input_spec.rb
+- lib/bcdd/process/output_spec.rb
+- lib/bcdd/process/version.rb
+- sig/bcdd/process.rbs
+homepage: https://github.com/b-cdd/process
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/b-cdd/process
+  source_code_uri: https://github.com/b-cdd/process
+  changelog_uri: https://github.com/b-cdd/process/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Write reliable, self-documented, and self-observable business processes in
+  Ruby.
+test_files: []