fluxo 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9453729318ec0b9d59e2833d19a4383c4b2f1bb241a8f97774c3f3b2cb4e6654
-  data.tar.gz: b428e33f29ababb0e2099eb9807f295fb899c965088ab2e650c111961d24c76a
+  metadata.gz: 383f612dadbf2c9b9c7cd5d8e4e09e3f140a8665405e3069e29e1c6629ff1da1
+  data.tar.gz: d91c37a9e158ad85b039cd3fb82d09881ed8390083e60ace2f3c345549902cff
 SHA512:
-  metadata.gz: 6ce303be1b5fa233fb9fc0e72eccebafd6d36e5ac81b2f6b8b1796c07c63bc5cbc097ed5fa7f48fdaf3457d3414335b8bbd1a63765557e7f3de0279a0dbb78ba
-  data.tar.gz: 514da4e79141fae0847ef16e2f4e9c67ac0246de87415277c657c93471cfe444a6eca8ec332b7a64aaa6286b61375b80d46ce49185fb5942b887d5a01ea4a271
+  metadata.gz: b7ba58999435d17f261decb8bd64a37f2f75135027a3e3683cce67ceae08bd065145c31e0c5e9f70c394fa944faa2e20986cf15860ca90236c0feb06d54a68ab
+  data.tar.gz: 8d2b54df3b612c2c6f20430d9086ff2a53a958ae9989a8605c05bfe12ebf2e3c93978b1add2af3919f5a6a99c294ebe5b610ab9b10f34f21ba7979bdb5e30406

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluxo (0.2.0)
+    fluxo (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -240,6 +240,57 @@ class CreateUserOperation < Fluxo::Operation(:name, :email)
 end
 ```
 
+### Operation Validation
+
+If you have the `ActiveModel` gem installed, you can use the `validations` method to define validations on the operation.
+
+```ruby
+class SubscribeOperation < Fluxo::Operation(:name, :email)
+  validations do
+    validates :name, presence: true
+    validates :email, presence: true, format: { with: /\A[^@]+@[^@]+\z/ }
+  end
+
+  def call!(name:, email:)
+    # ...
+  end
+end
+```
+
+### Operations Composition
+
+To promote single responsibility principle, Fluxo allows compose a complex operation flow by combining other operations.
+
+```ruby
+class DoubleOperation < Fluxo::Operation(:num)
+  def call!(num:)
+    Success(num: num * 2)
+  end
+end
+
+class SquareOperation < Fluxo::Operation(:num)
+  def call!(num:)
+    Success(num: num * 2)
+  end
+end
+
+class ArithmeticOperation < Fluxo::Operation(:num)
+  flow :normalize, :double, :square
+
+  def normalize(num:)
+    Success(num: num.to_i)
+  end
+
+  def double(num:)
+    DoubleOperation.call(num: num)
+  end
+
+  def square(num:)
+    SquareOperation.call(num: num)
+  end
+end
+```
+
 ### Configuration
 
 ```ruby

data/ci/Gemfile.activemodel-4.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    fluxo (0.1.0)
+    fluxo (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/ci/Gemfile.activemodel-5.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    fluxo (0.1.0)
+    fluxo (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/ci/Gemfile.activemodel-6.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    fluxo (0.1.0)
+    fluxo (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/ci/Gemfile.activemodel-7.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    fluxo (0.1.0)
+    fluxo (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/fluxo/operation.rb

@@ -42,7 +42,7 @@ module Fluxo
     # Calls step-method by step-method always passing the value to the next step
     # If one of the methods is a failure stop the execution and return a result.
     def __execute_flow__(steps: [], attributes: {})
-      transient_attributes, transient_ids = attributes.dup, {ok: [], failure: [], exception: []}
+      transient_attributes, transient_ids = attributes.dup, Hash.new { |h, k| h[k] = [] }
       __validate_attributes__(first_step: steps.first, attributes: transient_attributes)
 
       result = nil
@@ -57,7 +57,7 @@ module Fluxo
           end
         else
           result = __wrap_result__(send(step, **transient_attributes))
-          transient_ids.fetch(result.type).push(*result.ids)
+          transient_ids[result.type].push(*result.ids)
         end
 
         break unless result.success?
@@ -70,7 +70,7 @@ module Fluxo
           )
         end
       end
-      result.tap { |r| r.ids = transient_ids.fetch(r.type).uniq }
+      result.mutate(ids: transient_ids[result.type].uniq, operation: self)
     end
 
     # @param value_or_result_id [Any] The value for the result or the id when the result comes from block

data/lib/fluxo/result.rb

@@ -2,8 +2,7 @@
 
 module Fluxo
   class Result
-    attr_reader :operation, :type, :value
-    attr_accessor :ids
+    attr_reader :operation, :type, :value, :ids
 
     # @param options [Hash]
     # @option options [Fluxo::Operation] :operation The operation instance that gererated this result
@@ -17,6 +16,15 @@ module Fluxo
       @ids = Array(ids)
     end
 
+    def mutate(**attrs)
+      self.class.new(**{operation: operation, type: type, value: value, ids: ids}.merge(attrs))
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && other.operation == operation && other.type == type && other.value == value && other.ids == ids
+    end
+    alias_method :eql?, :==
+
     # @return [Boolean] true if the result is a success
     def success?
       type == :ok

data/lib/fluxo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fluxo
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluxo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard