u-case 3.0.0.rc2 → 3.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc46204c461937d19681ae26dca7846a8d36720b735d759023b4c1369ef2a9a
-  data.tar.gz: 21bfd7bc9d2c2a13c901672eac77f15da4b7975aeeea925b3f94ff7e36dd1161
+  metadata.gz: de27799d2fbf95d3399af2caa3053038fd9817c6f800747213eb8ee3722604b5
+  data.tar.gz: dc2f1b40964d646978d28ffb44c049a58ddca614440e296ff5fa7f35e347def1
 SHA512:
-  metadata.gz: 1e6992400490ef920d9ad855ebf698174ee2fcf9ab555db880ab2dea065360b921af7e38e4be5eb74e28c484862a25ca476beba9e2daebbc668bae07ef1b1853
-  data.tar.gz: d081ddf7bf5b3209f31c385060fd8dbbc9f72a8b1a05e553b1666df2f2de1550859017e9aa85aa329118bdef965f390a1637348c2a7549139e462e3cb091c250
+  metadata.gz: 90af10df71576124850933260f703e7a2f9c6a67df5e5add06d7d657de34a291879e279eec59795bfd548c0e0f898dc3795657de1de524e3aac16dddf25b24cf
+  data.tar.gz: e5b374929b87a7a5a0f604afa5742195910809b9198c11d01110bb8cf9f2540de73aa80fedb4432357ee86b96fe5e81b91a003fd410da989ac5b22b9ad40aa30

data/README.md

@@ -22,7 +22,7 @@ The main project goals are:
 
 Version   | Documentation
 --------- | -------------
-3.0.0.rc2 | https://github.com/serradura/u-case/blob/master/README.md
+3.0.0.rc3 | https://github.com/serradura/u-case/blob/master/README.md
 2.6.0     | https://github.com/serradura/u-case/blob/v2.x/README.md
 1.1.0     | https://github.com/serradura/u-case/blob/v1.x/README.md
 
@@ -47,6 +47,7 @@ Version   | Documentation
     - [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)
     - [How to understand what is happening during a flow execution?](#how-to-understand-what-is-happening-during-a-flow-execution)
       - [`Micro::Case::Result#transitions` schema](#microcaseresulttransitions-schema)
+      - [Is it possible disable the `Micro::Case::Result#transitions`?](#is-it-possible-disable-the-microcaseresulttransitions)
     - [Is it possible to declare a flow which includes the use case itself?](#is-it-possible-to-declare-a-flow-which-includes-the-use-case-itself)
   - [`Micro::Case::Strict` - What is a strict use case?](#microcasestrict---what-is-a-strict-use-case)
   - [`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)
@@ -55,6 +56,7 @@ Version   | Documentation
   - [`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)
+- [`Micro::Case.config`](#microcaseconfig)
 - [Benchmarks](#benchmarks)
   - [`Micro::Case` (v2.6.0)](#microcase-v260)
     - [Best overall](#best-overall)
@@ -164,12 +166,13 @@ result.value # { number: 6 }
 A `Micro::Case::Result` stores the use cases output data. These are their main methods:
 - `#success?` returns true if is a successful result.
 - `#failure?` returns true if is an unsuccessful result.
-- `#data` the result data itself.
+- `#use_case` returns the use case responsible for it. This feature is handy to handle a flow failure (this topic will be covered ahead).
 - `#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.
 - `#on_success` or `#on_failure` are hook methods that help you to define the application flow.
-- `#use_case` if is a failure result, the use case responsible for it will be accessible through this method. This feature is handy to handle a flow failure (this topic will be covered ahead).
 - `#then` this method will allow applying a new use case if the current result was a success. The idea of this feature is to allow the creation of dynamic flows.
-- `#[]` and `#values_at` are shortcuts to access the `#data` values.
+- `#transitions` returns an array with all of transformations wich a result [has during a flow](#how-to-understand-what-is-happening-during-a-flow-execution).
 
 > **Note:** for backward compatibility, you could use the `#value` method as an alias of `#data` method.
 
@@ -207,7 +210,7 @@ result = Divide.call(a: 2, b: 2)
 result.type     # :ok
 result.data     # { number: 1 }
 result.success? # true
-result.use_case # raises `Micro::Case::Error::InvalidAccessToTheUseCaseObject: only a failure result can access its own use case`
+result.use_case # #<Divide:0x0000 @__attributes={"a"=>2, "b"=>2}, @a=2, @b=2, @__result=...>
 
 # Failure result (type == :error)
 
@@ -216,7 +219,7 @@ bad_result = Divide.call(a: 2, b: '2')
 bad_result.type     # :error
 bad_result.data     # { invalid_attributes: { "b"=>"2" } }
 bad_result.failure? # true
-bad_result.use_case # #<Divide:0x0000 @__attributes={"a"=>2, "b"=>"2"}, @a=2, @b="2", @__result=#<Micro::Case::Result:0x0000 @use_case=#<Divide:0x0000 ...>, @type=:error, @value={"b"=>"2"}, @success=false>
+bad_result.use_case # #<Divide:0x0000 @__attributes={"a"=>2, "b"=>"2"}, @a=2, @b="2", @__result=...>
 
 # Failure result (type == :exception)
 
@@ -834,8 +837,6 @@ And look up the `accessible_attributes` property, it shows whats attributes are
 
 > **Note:** The [`Micro::Case::Result#then`](#how-to-use-the-microcaseresultthen-method) increments the `Micro::Case::Result#transitions`.
 
-PS: Use the `Micro::Case::Result.disable_transition_tracking` feature toggle to disable this feature (use once, because it is global) and increase the use cases' performance.
-
 ##### `Micro::Case::Result#transitions` schema
 ```ruby
 [
@@ -856,6 +857,10 @@ PS: Use the `Micro::Case::Result.disable_transition_tracking` feature toggle to
 ]
 ```
 
+##### Is it possible disable the `Micro::Case::Result#transitions`?
+
+Answer: Yes, it is! You can use the `Micro::Case.config` to do this. [Link to](#microcaseconfig) this section.
+
 #### Is it possible to declare a flow which includes the use case itself?
 
 Answer: Yes, it is! You can use the `self.call!` macro. e.g:
@@ -1073,18 +1078,22 @@ class Multiply < Micro::Case
     Success result: { number: a * b }
   end
 end
+```
 
-#
-# But if do you want an automatic way to fail
-# your use cases on validation errors, you can use:
+But if do you want an automatic way to fail your use cases on validation errors, you can:
 
-# In some file. e.g: A Rails initializer
-require 'u-case/with_activemodel_validation' # or require 'micro/case/with_validation'
+1. **require 'u-case/with_activemodel_validation'** mode
 
-# In the Gemfile
-gem 'u-case', require: 'u-case/with_activemodel_validation'
+  ```ruby
+  gem 'u-case', require: 'u-case/with_activemodel_validation'
+  ```
 
-# Using this approach, you can rewrite the previous example with less code. e.g:
+2. Use the `Micro::Case.config` to enable it. [Link to](#microcaseconfig) this section.
+
+Using this approach, you can rewrite the previous example with less code. e.g:
+
+```ruby
+require 'u-case/with_activemodel_validation'
 
 class Multiply < Micro::Case
   attributes :a, :b
@@ -1154,6 +1163,23 @@ class Todo::List::AddItem < Micro::Case
 end
 ```
 
+## `Micro::Case.config`
+
+The idea of this feature is to allow the configuration of some `u-case` features/modules.
+I recommend you use it only once in your codebase. e.g. In a Rails initializer.
+
+You can see below, which are all of the available configurations with their default values:
+
+```ruby
+Micro::Case.config do |config|
+  # Use ActiveModel to auto-validate your use cases' attributes.
+  config.enable_activemodel_validations = false
+
+  # Use to enable/disable the `Micro::Case::Results#transitions` tracking.
+  config.enable_transitions = true
+end
+```
+
 ## Benchmarks
 
 ### `Micro::Case` (v2.6.0)

data/lib/micro/case.rb

@@ -12,11 +12,16 @@ module Micro
     require 'micro/case/error'
     require 'micro/case/safe'
     require 'micro/case/strict'
+    require 'micro/case/config'
 
     require 'micro/cases'
 
     include Micro::Attributes.without(:strict_initialize)
 
+    def self.config
+      yield(Config.instance)
+    end
+
     def self.call(options = {})
       new(options).call
     end

data/lib/micro/case/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Micro
+  class Case
+    class Config
+      include Singleton
+
+      def enable_activemodel_validation=(value)
+        return unless Kind::Of::Boolean(value)
+
+        require 'micro/case/with_activemodel_validation'
+      end
+
+      def enable_transitions=(value)
+        Micro::Case::Result.class_variable_set(
+          :@@transition_tracking_disabled, !Kind::Of::Boolean(value)
+        )
+      end
+    end
+  end
+end

data/lib/micro/case/error.rb

@@ -47,10 +47,6 @@ module Micro
         def initialize; super('Invalid invocation of the Micro::Case::Result#then method'); end
       end
 
-      class InvalidAccessToTheUseCaseObject < StandardError
-        def initialize; super('only a failure result can access its use case object'.freeze); end
-      end
-
       def self.by_wrong_usage?(exception)
         exception.is_a?(InvalidResult) || exception.is_a?(UnexpectedResult) || exception.is_a?(ArgumentError)
       end

data/lib/micro/case/result.rb

@@ -9,11 +9,7 @@ module Micro
 
       @@transition_tracking_disabled = false
 
-      def self.disable_transition_tracking
-        @@transition_tracking_disabled = true
-      end
-
-      attr_reader :type, :data
+      attr_reader :type, :data, :use_case
 
       alias_method :value, :data
 
@@ -42,14 +38,12 @@ module Micro
         !success?
       end
 
-      def use_case
-        return @use_case if failure?
+      def on_success(expected_type = nil)
+        return self unless success_type?(expected_type)
 
-        raise Error::InvalidAccessToTheUseCaseObject
-      end
+        hook_data = expected_type.nil? ? self : data
 
-      def on_success(expected_type = nil)
-        yield(data) if success_type?(expected_type)
+        yield(hook_data, @use_case)
 
         self
       end

data/lib/micro/case/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   class Case
-    VERSION = '3.0.0.rc2'.freeze
+    VERSION = '3.0.0.rc3'.freeze
   end
 end

data/lib/micro/case/with_activemodel_validation.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'kind/active_model/validation'
+
 require 'micro/case'
 
 module Micro

data/lib/u-case/with_activemodel_validation.rb

@@ -1,5 +1,3 @@
 # frozen_string_literal: true
 
-require 'kind/active_model/validation'
-
 require 'micro/case/with_activemodel_validation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-case
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc2
+  version: 3.0.0.rc3
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kind
@@ -91,6 +91,7 @@ files:
 - bin/console
 - bin/setup
 - lib/micro/case.rb
+- lib/micro/case/config.rb
 - lib/micro/case/error.rb
 - lib/micro/case/result.rb
 - lib/micro/case/safe.rb