bcdd-process 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aec3a08f8e5f7dd092929d24fb76c2c1b95d07bf13b3683256daafe19595070
-  data.tar.gz: bb29f54a9ec8129bfbb52a1465736df59fa0c34957dc5cebe9566c3d312ec040
+  metadata.gz: 4fc44df9862fb1cc767ccf9c30a2449c9757beededc5362a827f0910cce3502f
+  data.tar.gz: ac170094d857f6dc057675083ebf5224620a423d8e9b09e50b5ab31f0442802b
 SHA512:
-  metadata.gz: 15b804dd0b7b72c1e2c93013619677f1ca45db9f9fe56cb818c83ef59c2974064304366475d43b6e0a2232c677bff7edc76c439c773c083868e3fe1600ef06d9
-  data.tar.gz: 02da1b070eb0f1ad40b5c04e719aae2759aaaaca9fac878c4abc4afb588a788032417d9a3a4f754baeb81a70d9dbc9f2d41ac485917a24f547442a4b6e855768
+  metadata.gz: d55396e492e307ff8c62e54b875bc4476c34918a4f0d722f1f8ef15a1a78ca12f1c984b4d129fa9957e237d431a923fd05325ff22eae58aca7d8f34ea7a06ab5
+  data.tar.gz: b81991dc5c9ee80191e5045824a22a91f5bd0635ba584585402d56e793fd5d2026e007e3288c02a7e2a61dede9b2436635151d97517294e4bd45d102b4885127

data/CHANGELOG.md

@@ -1,11 +1,35 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-02-03
+
+### Added
+
+- Allow the usage of `proc(&)` with the input `normalize:` property.
+  ```ruby
+  attribute :name, type: String, normalize: proc(&:to_s) >> proc(&:strip)
+  ```
+
+### Changed
+
+- **BREAKING**: Remove `validate:` input property and allow the composition of `contract:` + `type:` properties.
+  ```ruby
+  # Before
+  attribute :name, type: String, validate: :is_present
+
+  # After
+  attribute :name, type: String, contract: is_present
+  ```
+
 ## [0.2.0] - 2024-02-01
 
-- Update gem's dependencies.
+### Changed
+
+- **BREAKING**: Update gem's dependencies.
   - bcdd-contract >= 0.1.0
   - bcdd-result >= 0.3.0
 
 ## [0.1.0] - 2024-02-01
 
+### Added
+
 - Add `BCDD::Process` - Initial/POC release.

data/README.md

@@ -37,7 +37,7 @@ class User
     include BCDD::Result::RollbackOnFailure
 
     input do
-      attribute :uuid, contract: :is_uuid, default: -> { ::SecureRandom.uuid }, normalize: -> { _1.strip.downcase }
+      attribute :uuid, contract: :is_uuid, normalize: -> { _1.strip.downcase }, default: -> { ::SecureRandom.uuid }
       attribute :name, contract: :is_str, normalize: -> { _1.strip.gsub(/\s+/, ' ') }
       attribute :email, contract: :is_email, normalize: -> { _1.strip.downcase }
       attribute :password, contract: :is_password
@@ -47,13 +47,13 @@ class User
     output do
       Failure(
         invalid_user: :errors_by_attribute,
-        email_already_taken: :empty_hash,
+        email_already_taken: :empty_hash
       )
 
-      user = contract[::User] & :is_persisted
-      token = contract[Token] & :is_persisted
-
-      Success(user_created: { user:, token: })
+      Success user_created: {
+        user: contract[::User] & :is_persisted,
+        token: contract[Token] & :is_persisted
+      }
     end
 
     def call(**input)

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

@@ -5,32 +5,29 @@ class Account
     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
+      attribute :uuid, contract: :is_uuid, normalize: -> { _1.strip.downcase }, default: -> { ::SecureRandom.uuid }
+      attribute :owner, type: ::Hash, contract: :is_present
     end
 
     output do
       Failure(
         invalid_owner: ::Hash,
-        invalid_account: :errors_by_attribute,
+        invalid_account: :errors_by_attribute
       )
 
-      user = contract[::User] & :is_persisted
-      account = contract[::Account] & :is_persisted
-
-      Success(account_owner_created: { account:, user: })
+      Success account_owner_created: {
+        user: contract[::User] & :is_persisted,
+        account: contract[::Account] & :is_persisted
+      }
     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])
+      rollback_on_failure {
+        Given(input)
+          .and_then(:create_owner)
+          .and_then(:create_account)
+          .and_then(:link_owner_to_account)
+      }.and_expose(:account_owner_created, %i[account user])
     end
 
     private

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

@@ -5,7 +5,7 @@ class User
     include BCDD::Result::RollbackOnFailure
 
     input do
-      attribute :uuid, contract: :is_uuid, default: -> { ::SecureRandom.uuid }, normalize: -> { _1.strip.downcase }
+      attribute :uuid, contract: :is_uuid, normalize: -> { _1.strip.downcase }, default: -> { ::SecureRandom.uuid }
       attribute :name, contract: :is_str, normalize: -> { _1.strip.gsub(/\s+/, ' ') }
       attribute :email, contract: :is_email, normalize: -> { _1.strip.downcase }
       attribute :password, contract: :is_password
@@ -15,13 +15,13 @@ class User
     output do
       Failure(
         invalid_user: :errors_by_attribute,
-        email_already_taken: :empty_hash,
+        email_already_taken: :empty_hash
       )
 
-      user = contract[::User] & :is_persisted
-      token = contract[Token] & :is_persisted
-
-      Success(user_created: { user:, token: })
+      Success user_created: {
+        user: contract[::User] & :is_persisted,
+        token: contract[Token] & :is_persisted
+      }
     end
 
     def call(**input)

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

@@ -13,9 +13,7 @@ class User::Token
         token_creation_failed: :errors_by_attribute
       )
 
-      token = contract[User::Token] & :is_persisted
-
-      Success(token_created: { token: })
+      Success token_created: { token: contract[User::Token] & :is_persisted }
     end
 
     def call(**input)

data/examples/business_processes/lib/bcdd/contracts.rb

@@ -3,13 +3,13 @@
 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_str = 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(
+  register(
     is_str: is_str,
     is_uuid: is_str & is_present & is_uuid,
     is_email: is_str & is_present& is_email,
@@ -18,11 +18,11 @@ module BCDD::Contracts
     is_persisted: is_persisted
   )
 
-  EmptyHash = ::BCDD::Contract[::Hash] & ->(value) { value.empty? }
-  ErrorMessages = ::BCDD::Contract[errors: [::String]]
-  ErrorsByAttribute = ::BCDD::Contract.pairs(::Symbol => [::String])
+  EmptyHash = contract[::Hash] & ->(value) { value.empty? }
+  ErrorMessages = contract[errors: [::String]]
+  ErrorsByAttribute = contract.pairs(::Symbol => [::String])
 
-  ::BCDD::Contract.register(
+  register(
     empty_hash: EmptyHash,
     error_messages: ErrorMessages,
     errors_by_attribute: ErrorsByAttribute

data/lib/bcdd/contract/null.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BCDD::Contract
+  # TODO: Move to bcdd-contract
+  module Null
+    class Checking
+      include Core::Checking
+
+      EMPTY_ARRAY = [].freeze
+
+      def initialize(_checker, value)
+        @value = value
+        @errors = EMPTY_ARRAY
+      end
+
+      def errors_message
+        ''
+      end
+    end
+  end
+
+  # TODO: Move to bcdd-contract
+  def self.null(value)
+    Null::Checking.new(nil, value)
+  end
+end

data/lib/bcdd/contracts.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# TODO: Move to bcdd-contract
+module BCDD::Contracts
+  class << self
+    private
+
+    def contract
+      ::BCDD::Contract
+    end
+
+    def register(**kargs)
+      # TODO: Remove this method and make the use open BCDD::Contracts module to register contracts
+      ::BCDD::Contract.register(**kargs)
+    end
+  end
+
+  NotNil = contract[-> { _1.nil? and 'cannot be nil' }]
+
+  register(not_nil: NotNil)
+end

data/lib/bcdd/process/caller.rb

@@ -3,18 +3,6 @@
 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
@@ -27,7 +15,7 @@ module BCDD
 
           value = options[:normalize].call(value) if options.key?(:normalize)
 
-          result[name] = options.key?(:contract) ? options[:contract][value] : NullContract.new(value)
+          result[name] = options.key?(:contract) ? options[:contract][value] : Contract.null(value)
         end
       end
 

data/lib/bcdd/process/input_spec.rb

@@ -10,17 +10,15 @@ module BCDD
           if options.key?(:contract) || options.key?(:type) || options.key?(:validate)
             resolve(options).then { required ? _1 : (_1 | nil) }
           elsif required
-            Contracts::CannotBeNil
+            Contracts::NotNil
           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)
+          contract = ::BCDD::Contract[options[:contract]] if options.key?(:contract)
 
-          type && validate ? (type & validate) : type || validate
+          type && contract ? (type & contract) : type || contract
         end
       end
 
@@ -36,7 +34,7 @@ module BCDD
       MapNormalize = ->(options) do
         value = options[:normalize]
 
-        return value if value.is_a?(Proc) && value.lambda? && value.arity == 1
+        return value if value.is_a?(Proc) && value.lambda?
 
         raise ArgumentError, 'normalize value must be a lambda with one arity'
       end
@@ -51,10 +49,6 @@ module BCDD
       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)

data/lib/bcdd/process/version.rb

@@ -2,6 +2,6 @@
 
 module BCDD
   class Process
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/bcdd/process.rb

@@ -3,16 +3,15 @@
 require 'bcdd/result'
 require 'bcdd/contract'
 
+require_relative 'contracts'
+require_relative 'contract/null'
+
 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__

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-process
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcdd-contract
@@ -71,6 +71,8 @@ files:
 - examples/business_processes/lib/runtime_breaker.rb
 - examples/business_processes/lib/transitions_listener/stdout.rb
 - lib/bcdd-process.rb
+- lib/bcdd/contract/null.rb
+- lib/bcdd/contracts.rb
 - lib/bcdd/process.rb
 - lib/bcdd/process/caller.rb
 - lib/bcdd/process/input_spec.rb