u-case 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d654bd6a59c3920ef02a3fa0c2b82fb32ff5f695cfe1f4d4565a84c53bf1d86c
-  data.tar.gz: e42a81c72ad2f49d01f2464e220e72bd201ca0adce6be06f14defa4ee84f67fe
+  metadata.gz: 2c0d84e916ac431f822d767a3485ce0a6ec9db47bba8b9b6cbc914ec72ec18da
+  data.tar.gz: b272186504907f0f2e88fe3fd19c241a7135bfa191a621a55ae912c95f680b57
 SHA512:
-  metadata.gz: '090c4536a5205ed89e0cf2e76b163ca127455f90df793980bd33cdc28efecabd35736e543dc2f003954b8131367672dea79319382412dd7ce6ae25121847eab6'
-  data.tar.gz: 0a9f2345b82957003238137fcd5a4ca081205f3b83c1f8f092d92f153ef3b57dd7d726abef600cdd1b76b7e6983b222931d8903edf984573cf8dd4696851a7cd
+  metadata.gz: ee96e3cc845c753481a94e394b496b8a923c0a15d220713c610dbb77046d4f79f434291f31cc5b8e88fa16d55dba12db11953d1553b0a8aa284277aa4558512a
+  data.tar.gz: 4edb2ce9cb98319bab947ebfb9166518eaeca467d68198e5b3ac4a258ac907b16e1eb8c44ffd991140dddf863e4a821a146c29ef007139ad8c2e666732630fce

data/Gemfile

@@ -9,6 +9,8 @@ gem "rake", "~> 13.0"
 
 group :test do
   gem "simplecov", "~> 0.22.0", require: false
+  gem "minitest", (RUBY_VERSION >= "4.0") ? "~> 6.0" : "~> 5.27" if RUBY_VERSION >= "3.1"
+  gem "ostruct", "~> 0.6.3" if RUBY_VERSION >= "3.5"
 end
 
 group :development, :test do

data/README.md

@@ -27,7 +27,7 @@ The main project goals are:
 Version   | Documentation
 --------- | -------------
 unreleased| https://github.com/serradura/u-case/blob/main/README.md
-5.0.0     | https://github.com/serradura/u-case/blob/v5.x/README.md
+5.2.0     | https://github.com/serradura/u-case/blob/v5.x/README.md
 4.5.1     | https://github.com/serradura/u-case/blob/v4.x/README.md
 
 > **Note:** Você entende português? 🇧🇷 🇵🇹 Verifique o [README traduzido em pt-BR](https://github.com/serradura/u-case/blob/main/README.pt-BR.md).
@@ -60,6 +60,7 @@ unreleased| https://github.com/serradura/u-case/blob/main/README.md
   - [`Micro::Case::Safe` - Is there some feature to auto handle exceptions inside of a use case or flow?](#microcasesafe---is-there-some-feature-to-auto-handle-exceptions-inside-of-a-use-case-or-flow)
     - [`Micro::Cases::Safe::Flow`](#microcasessafeflow)
     - [`Micro::Case::Result#on_exception`](#microcaseresulton_exception)
+  - [Validating attributes with `accept:` / `reject:`](#validating-attributes-with-accept--reject)
   - [`u-case/with_activemodel_validation` - How to validate the use case attributes?](#u-casewith_activemodel_validation---how-to-validate-the-use-case-attributes)
     - [If I enabled the auto validation, is it possible to disable it only in specific use cases?](#if-i-enabled-the-auto-validation-is-it-possible-to-disable-it-only-in-specific-use-cases)
     - [`Kind::Validator`](#kindvalidator)
@@ -87,8 +88,9 @@ unreleased| https://github.com/serradura/u-case/blob/main/README.md
 
 | u-case           | branch | ruby     | activemodel    | u-attributes   |
 | ---------------- | ------ | -------- | -------------- | -------------- |
-| unreleased       | main   | >= 2.7   | >= 6.0         | >= 2.7, < 4.0  |
-| 5.0.0            | v5.x   | >= 2.7   | >= 6.0         | >= 2.7, < 4.0  |
+| unreleased       | main   | >= 2.7   | >= 6.0         | >= 2.8, < 4.0  |
+| 5.2.0            | v5.x   | >= 2.7   | >= 6.0         | >= 2.8, < 4.0  |
+| 5.1.0            | v5.x   | >= 2.7   | >= 6.0         | >= 2.7, < 4.0  |
 | 4.5.1            | v4.x   | >= 2.2.0 | >= 3.2, <= 8.1 | >= 2.7, < 3.0  |
 
 This library is tested (CI matrix) against:
@@ -189,6 +191,8 @@ A `Micro::Case::Result` stores the use cases output data. These are their main m
 - `#type` a Symbol which gives meaning for the result, this is useful to declare different types of failures or success.
 - `#data` the result data itself.
 - `#[]` and `#values_at` are shortcuts to access the `#data` values.
+- `#fetch` and `#fetch_values` are another way of accessing values of the result data, but raises a `KeyError` if the one of the keys are not present in the result.
+- `#keys` returns an array of keys present in the result data.
 - `#key?` returns `true` if the key is present in `#data`.
 - `#value?` returns `true` if the given value is present in `#data`.
 - `#slice` returns a new hash that includes only the given keys. If the given keys don't exist, an empty hash is returned.
@@ -1066,6 +1070,43 @@ As you can see, this hook has the same behavior of `result.on_failure(:exception
 
 [⬆️ Back to Top](#table-of-contents-)
 
+### Validating attributes with `accept:` / `reject:`
+
+Since `u-case 5.2.0`, every use case includes the [`accept` extension](https://github.com/serradura/u-attributes#accept-extension) from [`u-attributes`](https://github.com/serradura/u-attributes) (requires `u-attributes >= 2.8`). You can declare type expectations (or any other check) directly on the attribute, and the use case will fail automatically with the `:invalid_attributes` type when any attribute is rejected — no need to validate inside `call!`.
+
+```ruby
+class CreateUser < Micro::Case
+  attribute :name,  accept: String
+  attribute :email, accept: ->(value) { value.is_a?(String) && value.include?('@') }
+  attribute :age,   accept: Integer, allow_nil: true
+
+  def call!
+    Success result: { user: User.create!(attributes) }
+  end
+end
+
+CreateUser.call(name: 'Bob', email: 'bob@example.com')
+# => #<Success type=:ok ...>
+
+CreateUser.call(name: 42, email: 'not-an-email')
+# => #<Failure type=:invalid_attributes data={
+#       errors: {
+#         "name"  => "expected to be a kind of String",
+#         "email" => "is invalid"
+#       }
+#     }>
+```
+
+The failure type follows the same setting used by the ActiveModel validation integration — see [`Micro::Case.config`](#microcaseconfig) and `set_activemodel_validation_errors_failure`.
+
+When combined with [`u-case/with_activemodel_validation`](#u-casewith_activemodel_validation---how-to-validate-the-use-case-attributes), the execution order is:
+
+1. `u-attributes` resolves the default value of each attribute.
+2. `u-attributes` runs the `accept:` / `reject:` checks.
+3. `u-case` runs the `ActiveModel` validations **only if** every attribute was accepted.
+
+[⬆️ Back to Top](#table-of-contents-)
+
 ### `u-case/with_activemodel_validation` - How to validate the use case attributes?
 
 **Requirement:**

data/README.pt-BR.md

@@ -27,7 +27,7 @@ Principais objetivos deste projeto:
 Versão    | Documentação
 --------- | -------------
 unreleased| https://github.com/serradura/u-case/blob/main/README.md
-5.0.0     | https://github.com/serradura/u-case/blob/v5.x/README.md
+5.2.0     | https://github.com/serradura/u-case/blob/v5.x/README.md
 4.5.1     | https://github.com/serradura/u-case/blob/v4.x/README.md
 
 ## Índice <!-- omit in toc -->
@@ -58,6 +58,7 @@ unreleased| https://github.com/serradura/u-case/blob/main/README.md
   - [`Micro::Case::Safe` - Existe algum recurso para lidar automaticamente com exceções dentro de um caso de uso ou fluxo?](#microcasesafe---existe-algum-recurso-para-lidar-automaticamente-com-exceções-dentro-de-um-caso-de-uso-ou-fluxo)
     - [`Micro::Cases::Safe::Flow`](#microcasessafeflow)
     - [`Micro::Case::Result#on_exception`](#microcaseresulton_exception)
+  - [Validando atributos com `accept:` / `reject:`](#validando-atributos-com-accept--reject)
   - [`u-case/with_activemodel_validation` - Como validar os atributos do caso de uso?](#u-casewith_activemodel_validation---como-validar-os-atributos-do-caso-de-uso)
     - [Se eu habilitei a validação automática, é possível desabilitá-la apenas em casos de uso específicos?](#se-eu-habilitei-a-validação-automática-é-possível-desabilitá-la-apenas-em-casos-de-uso-específicos)
     - [`Kind::Validator`](#kindvalidator)
@@ -85,8 +86,9 @@ unreleased| https://github.com/serradura/u-case/blob/main/README.md
 
 | u-case           | branch | ruby     | activemodel    | u-attributes   |
 | ---------------- | ------ | -------- | -------------- | -------------- |
-| unreleased       | main   | >= 2.7   | >= 6.0         | >= 2.7, < 4.0  |
-| 5.0.0            | v5.x   | >= 2.7   | >= 6.0         | >= 2.7, < 4.0  |
+| unreleased       | main   | >= 2.7   | >= 6.0         | >= 2.8, < 4.0  |
+| 5.2.0            | v5.x   | >= 2.7   | >= 6.0         | >= 2.8, < 4.0  |
+| 5.1.0            | v5.x   | >= 2.7   | >= 6.0         | >= 2.7, < 4.0  |
 | 4.5.1            | v4.x   | >= 2.2.0 | >= 3.2, <= 8.1 | >= 2.7, < 3.0  |
 
 Esta biblioteca é testada (matriz de CI) contra:
@@ -187,8 +189,10 @@ Um `Micro::Case::Result` armazena os dados de output de um caso de uso. Esses s
 - `#type` retorna um Symbol que dá significado ao resultado, isso é útil para declarar diferentes tipos de falha e sucesso.
 - `#data` os dados do resultado (um `Hash`).
 - `#[]` e `#values_at` são atalhos para acessar as propriedades do `#data`.
-- `#key?` retorna `true` se a chave estiver present no `#data`.
-- `#value?` retorna `true` se o valor estiver present no `#data`.
+- `#fetch` e `#fetch_values` são outras maneiras de acessar os valores contidos em `#data`, porém se alguma chave não existir, é levantado um `KeyError`.
+- `#keys` retorna uma array com as chaves presentes no resultado.
+- `#key?` retorna `true` se a chave estiver presente no `#data`.
+- `#value?` retorna `true` se o valor estiver presente no `#data`.
 - `#slice` retorna um novo `Hash` que inclui apenas as chaves fornecidas. Se as chaves fornecidas não existirem, um `Hash` vazio será retornado.
 - `#on_success` or `#on_failure` são métodos de hooks que te auxiliam a definir o fluxo da aplicação.
 - `#then` este método permite aplicar novos casos de uso ao resultado atual se ele for sucesso. A ideia dessa feature é a criação de fluxos dinâmicos.
@@ -1067,6 +1071,43 @@ Como você pode ver, este hook tem o mesmo comportamento de `result.on_failure(:
 
 [⬆️ Voltar para o índice](#índice-)
 
+### Validando atributos com `accept:` / `reject:`
+
+Desde a versão `5.2.0` do `u-case`, todo caso de uso já inclui a [extensão `accept`](https://github.com/serradura/u-attributes#accept-extension) do [`u-attributes`](https://github.com/serradura/u-attributes) (requer `u-attributes >= 2.8`). Você pode declarar a expectativa de tipo (ou qualquer outra verificação) diretamente no atributo, e o caso de uso falhará automaticamente com o tipo `:invalid_attributes` quando algum atributo for rejeitado — sem precisar validar dentro do `call!`.
+
+```ruby
+class CreateUser < Micro::Case
+  attribute :name,  accept: String
+  attribute :email, accept: ->(value) { value.is_a?(String) && value.include?('@') }
+  attribute :age,   accept: Integer, allow_nil: true
+
+  def call!
+    Success result: { user: User.create!(attributes) }
+  end
+end
+
+CreateUser.call(name: 'Bob', email: 'bob@example.com')
+# => #<Success type=:ok ...>
+
+CreateUser.call(name: 42, email: 'not-an-email')
+# => #<Failure type=:invalid_attributes data={
+#       errors: {
+#         "name"  => "expected to be a kind of String",
+#         "email" => "is invalid"
+#       }
+#     }>
+```
+
+O tipo da falha segue a mesma configuração usada pela integração com `ActiveModel` — veja [`Micro::Case.config`](#microcaseconfig) e `set_activemodel_validation_errors_failure`.
+
+Quando combinado com [`u-case/with_activemodel_validation`](#u-casewith_activemodel_validation---como-validar-os-atributos-do-caso-de-uso), a ordem de execução é:
+
+1. O `u-attributes` resolve o valor padrão de cada atributo.
+2. O `u-attributes` executa as verificações de `accept:` / `reject:`.
+3. O `u-case` executa as validações do `ActiveModel` **apenas se** todos os atributos forem aceitos.
+
+[⬆️ Voltar para o índice](#índice-)
+
 ### `u-case/with_activemodel_validation` - Como validar os atributos do caso de uso?
 
 **Requisitos:**

data/lib/micro/case/result.rb

@@ -62,6 +62,18 @@ module Micro
         data.key?(key)
       end
 
+      def keys
+        data.keys
+      end
+
+      def fetch(*args, &block)
+        data.fetch(*args, &block)
+      end
+
+      def fetch_values(*keys, &block)
+        Utils::Hashes.fetch_values(data, keys, &block)
+      end
+
       def value?(value)
         data.value?(value)
       end

data/lib/micro/case/utils.rb

@@ -27,6 +27,14 @@ module Micro::Case::Utils
 
       hash.select { |key, _value| keys.include?(key) }
     end
+
+    def self.fetch_values(hash, keys, &block)
+      return hash.fetch_values(*keys, &block) if hash_respond_to?(hash, :fetch_values)
+
+      keys.each_with_object([]) do |key, values|
+        values << hash.fetch(key, &block)
+      end
+    end
   end
 
 end

data/lib/micro/case/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   class Case
-    VERSION = '5.0.0'.freeze
+    VERSION = '5.2.0'.freeze
   end
 end

data/lib/micro/case/with_activemodel_validation.rb

@@ -19,7 +19,10 @@ module Micro
     private
 
       def __call_use_case
-        return failure_by_validation_error(self) if !self.class.auto_validation_disabled? && errors.present?
+        unless self.class.auto_validation_disabled?
+          return failure_by_validation_error(self) if errors.present?
+          return __failure_from_attributes_errors if __attributes_errors_present?
+        end
 
         result = call!
 

data/lib/micro/case.rb

@@ -18,6 +18,7 @@ module Micro
     require 'micro/cases'
 
     include Micro::Attributes
+    include Micro::Attributes::Features::Accept
 
     def self.call(input = Kind::Empty::HASH)
       result = __new__(Result.new, input).__call__
@@ -206,6 +207,8 @@ module Micro
       end
 
       def __call_use_case
+        return __failure_from_attributes_errors if __attributes_errors_present?
+
         result = call!
 
         return result if result.is_a?(Result)
@@ -213,6 +216,17 @@ module Micro
         raise Error::UnexpectedResult.new("#{self.class.name}#call!")
       end
 
+      def __attributes_errors_present?
+        attributes_errors?
+      end
+
+      def __failure_from_attributes_errors
+        Failure(
+          Config.instance.activemodel_validation_errors_failure,
+          result: { errors: attributes_errors }
+        )
+      end
+
       def __call_the_use_case_flow?
         self.class.__flow_get__
       end

data/u-case.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_runtime_dependency 'kind', '>= 5.6', '< 7.0'
-  spec.add_runtime_dependency 'u-attributes', '>= 2.7', '< 4.0'
+  spec.add_runtime_dependency 'u-attributes', '>= 2.8', '< 4.0'
 
   spec.add_development_dependency 'appraisal', '~> 2.5'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u-case
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Rodrigo Serradura
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -45,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'