u-case 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349609a8d927ab7fd8edb1eb96141dff2f78f9957f31f2b88a8975239fc0de87
-  data.tar.gz: 4b6293023f49f28dd8283656a0d423f7d24abbfb7f010a90ba4d0dd17f577d22
+  metadata.gz: de7b8e442e0b578b478d9d63f05901c9023884f3f2b15a1819228af36fe7afc5
+  data.tar.gz: 50e9128500306350a56102b93ca8bd171c75ecae24899c6157a7955e845221a3
 SHA512:
-  metadata.gz: 0553e560e40f71d0e8284ebbbbf7a51326d8c9bc9de6ad0de76db526466a94f633e2b038563868a2c93234800b7bdacc30a99ba57f1624ce08463fdc012d165d
-  data.tar.gz: 2866ca201676827b2ffc82877b1615e7ecbb6fc6e993df17007c6446b348a850266faf162a0953954ee6adfb0d35a88c303bee385d2fb52a9c228f45513655db
+  metadata.gz: 93fcec72232ac2d1ce479cdc2efa02d7b4eddf0d3b57e2c93346ecb6359a0f9ccba33f7851b2115c813ef53f79f9276984864f172c341be23be8c11120e933fe
+  data.tar.gz: 9993e5cdcbe6f1e864c32a9db7f637c1cdb839bd838d1823e64b2646b704b079d9f83915af65e364abe8edd66034952202909a42833a634d04aeac11eee384bd

data/README.md

@@ -32,6 +32,7 @@ The main project goals are:
     - [Why the failure hook (without a type) exposes a different kind of data?](#why-the-failure-hook-without-a-type-exposes-a-different-kind-of-data)
     - [What happens if a result hook was declared multiple times?](#what-happens-if-a-result-hook-was-declared-multiple-times)
     - [How to use the `Micro::Case::Result#then` method?](#how-to-use-the-microcaseresultthen-method)
+      - [How to make attributes data injection using this feature?](#how-to-make-attributes-data-injection-using-this-feature)
   - [`Micro::Case::Flow` - How to compose use cases?](#microcaseflow---how-to-compose-use-cases)
     - [Is it possible to compose a use case flow with other ones?](#is-it-possible-to-compose-a-use-case-flow-with-other-ones)
     - [Is it possible a flow accumulates its input and merges each success result to use as the argument of the next use cases?](#is-it-possible-a-flow-accumulates-its-input-and-merges-each-success-result-to-use-as-the-argument-of-the-next-use-cases)
@@ -44,7 +45,7 @@ The main project goals are:
     - [`Micro::Case::Result#on_exception`](#microcaseresulton_exception)
   - [`u-case/with_activemodel_validation` - How to validate use case attributes?](#u-casewith_activemodel_validation---how-to-validate-use-case-attributes)
     - [If I enabled the auto validation, is it possible to disable it only in specific use case classes?](#if-i-enabled-the-auto-validation-is-it-possible-to-disable-it-only-in-specific-use-case-classes)
-    - [Kind::Validator](#kindvalidator)
+    - [`Kind::Validator`](#kindvalidator)
 - [Benchmarks](#benchmarks)
   - [`Micro::Case`](#microcase)
     - [Best overall](#best-overall)
@@ -431,6 +432,9 @@ result.value * 4 == accum # true
 
 #### How to use the `Micro::Case::Result#then` method?
 
+This method allows you to create dynamic flows, so, with it,
+you can add new use cases or flows to continue the result transformation. e.g:
+
 ```ruby
 class ForbidNegativeNumber < Micro::Case
   attribute :number
@@ -455,7 +459,6 @@ result1 =
     .call(number: -1)
     .then(Add3)
 
-result1.type     # :error
 result1.value    # {'number' => -1}
 result1.failure? # true
 
@@ -466,11 +469,26 @@ result2 =
     .call(number: 1)
     .then(Add3)
 
-result2.type     # :ok
 result2.value    # {'number' => 4}
 result2.success? # true
 ```
 
+> **Note:** this method changes the [`Micro::Case::Result#transitions`](#how-to-understand-what-is-happening-during-a-flow-execution).
+
+[⬆️ Back to Top](#table-of-contents-)
+
+##### How to make attributes data injection using this feature?
+
+Pass a Hash as the second argument of the `Micro::Case::Result#then` method.
+
+```ruby
+Todo::FindAllForUser
+  .call(user: current_user, params: params)
+  .then(Paginate)
+  .then(Serialize::PaginatedRelationAsJson, serializer: Todo::Serializer)
+  .on_success { |result| render_json(200, data: result[:todos]) }
+```
+
 [⬆️ Back to Top](#table-of-contents-)
 
 ### `Micro::Case::Flow` - How to compose use cases?
@@ -972,7 +990,7 @@ In functional programming errors/exceptions are handled as regular data, the ide
 
 To address this the `Micro::Case::Result` has a special hook `#on_exception` to helping you to handle the control flow in the case of exceptions.
 
-> **Note** this feature will work better if you use it with a `Micro::Case::Safe` use case/flow.
+> **Note**: this feature will work better if you use it with a `Micro::Case::Safe` use case/flow.
 
 How does it work?
 
@@ -1092,7 +1110,7 @@ Multiply.call(a: 2, b: 'a')
 
 [⬆️ Back to Top](#table-of-contents-)
 
-#### Kind::Validator
+#### `Kind::Validator`
 
 The [kind gem](https://github.com/serradura/kind) has a module to enable the validation of data type through [`ActiveModel validations`](https://guides.rubyonrails.org/active_model_basics.html#validations). So, when you require the `'u-case/with_activemodel_validation'`, this module will require the [`Kind::Validator`](https://github.com/serradura/kind#kindvalidator-activemodelvalidations).
 

data/lib/micro/case.rb

@@ -44,11 +44,10 @@ module Micro
     end
 
     def self.__call_and_set_transition__(result, arg)
-      if arg.respond_to?(:keys)
-        result.__set_transitions_accessible_attributes__(arg.keys)
-      end
+      input =
+        arg.is_a?(Hash) ? result.__set_transitions_accessible_attributes__(arg) : arg
 
-      __new__(result, arg).call
+      __new__(result, input).call
     end
 
     FLOW_STEP = 'Flow_Step'.freeze

data/lib/micro/case/flow/reducer.rb

@@ -93,7 +93,7 @@ module Micro
               value = result.value
               input = value.is_a?(Hash) ? memo.tap { |data| data.merge!(value) } : value
 
-              result.__set_transitions_accessible_attributes__(memo.keys)
+              result.__set_transitions_accessible_attributes__(memo)
 
               next_use_case_result(use_case, result, input)
             end

data/lib/micro/case/result.rb

@@ -28,8 +28,8 @@ module Micro
       attr_reader :value, :type
 
       def initialize
-        @__transitions__ = {}
-        @__transitions_accessible_attributes__ = Set.new
+        @__transitions__ = []
+        @__transitions_accessible_attributes__ = {}
       end
 
       def __set__(is_success, value, type, use_case)
@@ -83,7 +83,7 @@ module Micro
         self
       end
 
-      def then(arg = nil, &block)
+      def then(arg = nil, attributes = nil, &block)
         can_yield_self = respond_to?(:yield_self)
 
         if block
@@ -98,30 +98,33 @@ module Micro
 
           return self if failure?
 
-          arg.__call_and_set_transition__(self, self.value)
+          input = attributes.is_a?(Hash) ? self.value.merge(attributes) : self.value
+
+          arg.__call_and_set_transition__(self, input)
         end
       end
 
       def transitions
-        return [] if @__transitions__.empty?
-
-        @__transitions__.map { |_use_case, transition| transition }
+        @__transitions__.clone
       end
 
-      def __set_transitions_accessible_attributes__(attribute_names)
-        return if @@transition_tracking_disabled
+      def __set_transitions_accessible_attributes__(attributes_data)
+        return attributes_data if @@transition_tracking_disabled
 
-        __set_transitions_accessible_attributes__!(
-          attribute_names.map!(&:to_sym)
-        )
+        __set_transitions_accessible_attributes__!(attributes_data)
       end
 
       private
 
-        def __set_transitions_accessible_attributes__!(attribute_names)
-          @__transitions_accessible_attributes__.merge(
-            attribute_names
-          )
+        def __set_transitions_accessible_attributes__!(attributes_data)
+          attributes = Utils.symbolize_hash_keys(attributes_data)
+
+          __update_transitions_accessible_attributes__(attributes)
+        end
+
+        def __update_transitions_accessible_attributes__(attributes)
+          @__transitions_accessible_attributes__.merge!(attributes)
+          @__transitions_accessible_attributes__
         end
 
         def success_type?(expected_type)
@@ -140,16 +143,15 @@ module Micro
           use_case_class = @use_case.class
           use_case_attributes = Utils.symbolize_hash_keys(@use_case.attributes)
 
-          __set_transitions_accessible_attributes__!(use_case_attributes.keys)
+          __update_transitions_accessible_attributes__(use_case_attributes)
 
           result = @success ? :success : :failure
-          transition = {
+
+          @__transitions__ << {
             use_case: { class: use_case_class, attributes: use_case_attributes },
             result => { type: @type, value: @value },
-            accessible_attributes: @__transitions_accessible_attributes__.to_a
+            accessible_attributes: @__transitions_accessible_attributes__.keys
           }
-
-          @__transitions__[use_case_class] = transition
         end
     end
   end

data/lib/micro/case/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-case
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kind