u-case 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0411016e16662d422a9f6b641ae91a516225e877f5cd8951058b479ea1b413d
-  data.tar.gz: 586af968d98bf2add7a9882a894db2ea4e6ada5eb3c3e31eae39a1d09e2410bf
+  metadata.gz: 3ba53faeaf465b491f94a686da7fc2537e9c50108b18162d11c473246e6a531e
+  data.tar.gz: 6b91c842ad57b917678649f4003f34ade8459a70c56938d2e226a4d8322e855d
 SHA512:
-  metadata.gz: ab3231e87cca1c25cc5148f922292177239738da22a7f1528bd4cdc56a601028c4a4e9eec0660e00c1cfc0a126746c53f37db159002639d9226f22cec931b812
-  data.tar.gz: 308404bc8b913d4ef84cd59e31fecd18b6bfe5ba51c6724d4a8880525c6058d01bf7b669676a843f2ff47754a7db9e643abcbbd53f50b178d72efce6c979eb40
+  metadata.gz: 8d4790abfb49211a69d9874900e83a0237d5fe0f0b288102e9bcff33fd932db4192e66ea2e5814990da2d5e92b5499dd93173257433639e2248463f2b3c991e8
+  data.tar.gz: e2bd4e73018961d931a76298dacf8000836d26f2331f975b777bc0371dcfe84d2064a51ef12636f31eaf22986a76b97f99e7cbe16b653a1bd1923ae5f8f4f125

data/README.md

@@ -15,8 +15,10 @@ The main project goals are:
 4. Solve complex business logic, by allowing the composition of use cases.
 5. Be fast and optimized (Check out the [benchmarks](#benchmarks) section).
 
+> Note: Check out the repo https://github.com/serradura/from-fat-controllers-to-use-cases to see a Rails application that uses this gem to handle its business logic.
+
 ## Table of Contents <!-- omit in toc -->
-- [μ-case (Micro::Case)](#μ-case-microcase)
+- [μ-case (Micro::Case)](#%ce%bc-case-microcase)
   - [Required Ruby version](#required-ruby-version)
   - [Dependencies](#dependencies)
   - [Installation](#installation)
@@ -32,10 +34,10 @@ The main project goals are:
     - [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 their use cases?](#is-it-possible-a-flow-accumulates-its-input-and-merges-each-success-result-to-use-as-the-argument-of-their-use-cases)
-      - [Is it possible to declare a flow using the use case itself?](#is-it-possible-to-declare-a-flow-using-the-use-case-itself)
+      - [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)
-    - [u-case/with_validation - How to validate use case attributes?](#u-casewith_validation---how-to-validate-use-case-attributes)
+    - [u-case/with_validation - How to validate use case attributes?](#u-casewithvalidation---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)
   - [Benchmarks](#benchmarks)
     - [Micro::Case](#microcase)
@@ -45,6 +47,10 @@ The main project goals are:
     - [Micro::Case::Flow](#microcaseflow)
     - [Comparisons](#comparisons)
   - [Examples](#examples)
+    - [1️⃣ Rails App (API)](#1%ef%b8%8f%e2%83%a3-rails-app-api)
+    - [2️⃣ CLI calculator](#2%ef%b8%8f%e2%83%a3-cli-calculator)
+    - [3️⃣ Users creation](#3%ef%b8%8f%e2%83%a3-users-creation)
+    - [4️⃣ Rescuing exception inside of the use cases](#4%ef%b8%8f%e2%83%a3-rescuing-exception-inside-of-the-use-cases)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -598,7 +604,7 @@ Answer: Yes, it is! Check out these test examples [Micro::Case::Flow](https://gi
 
 [⬆️ Back to Top](#table-of-contents-)
 
-#### Is it possible to declare a flow using the use case itself?
+#### 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:
 
@@ -620,16 +626,15 @@ class ConvertNumberToText < Micro::Case
 end
 
 class Double < Micro::Case
+  flow ConvertTextToNumber,
+       self.call!,
+       ConvertNumberToText
+
   attribute :number
 
   def call!
     Success { { number: number * 2 } }
   end
-
-  # NOTE: You need to declare the flow after the definition of the attributes.
-  flow ConvertTextToNumber,
-       self.call!,
-       ConvertNumberToText
 end
 
 result = Double.call(text: '4')
@@ -1022,13 +1027,27 @@ Check it out implementations of the same use case with different gems/abstractio
 
 ## Examples
 
-1. [Rescuing an exception inside of use cases](https://github.com/serradura/u-case/blob/master/examples/rescuing_exceptions.rb)
-2. [Users creation](https://github.com/serradura/u-case/blob/master/examples/users_creation.rb)
+### 1️⃣ Rails App (API)
+
+> This project shows different kinds of architecture (one per commit), and in the last one, how to use the Micro::Case gem to handle the application business logic.
+>
+> Link: https://github.com/serradura/from-fat-controllers-to-use-cases
+
+### 2️⃣ CLI calculator
+
+> Rake tasks to demonstrate how to handle user data, and how to use different failure types to control the program flow.
+>
+> Link: https://github.com/serradura/u-case/tree/master/examples/calculator
+
+### 3️⃣ Users creation
+
+> An example of a use case flow that define steps to sanitize, validate, and persist its input data.
+>
+> Link: https://github.com/serradura/u-case/blob/master/examples/users_creation.rb
 
-    An example of flow in how to define steps to sanitize, validate, and persist some input data.
-3. [CLI calculator](https://github.com/serradura/u-case/tree/master/examples/calculator)
+### 4️⃣ Rescuing exception inside of the use cases
 
-    A more complex example which use rake tasks to demonstrate how to handle user data, and how to use different failures type to control the program flow.
+> Link: https://github.com/serradura/u-case/blob/master/examples/rescuing_exceptions.rb
 
 [⬆️ Back to Top](#table-of-contents-)
 

data/lib/micro/case.rb

@@ -42,35 +42,57 @@ module Micro
       instance
     end
 
-    def self.__get_flow__
+    def self.__call!
+      return const_get(:Flow_Step) if const_defined?(:Flow_Step)
+
+      const_set(:Flow_Step, Class.new(self) do
+        private def __call
+          __call_use_case
+        end
+      end)
+    end
+
+    def self.call!
+      self
+    end
+
+    def self.__flow_reducer
+      Flow::Reducer
+    end
+
+    def self.__flow_get
       @__flow
     end
 
-    private_class_method def self.__set_flow__(reducer, args)
-      def self.use_cases; __get_flow__.use_cases; end
+    private_class_method def self.__flow_use_cases_set(args)
+      @__flow_use_cases = args
+    end
+
+    private_class_method def self.__flow_use_cases_get
+      Array(@__flow_use_cases)
+        .map { |use_case| use_case == self ? self.__call! : use_case }
+    end
+
+    private_class_method def self.__flow_set(args)
+      return if __flow_get
+
+      def self.use_cases; __flow_get.use_cases; end
 
       self.class_eval('def use_cases; self.class.use_cases; end')
 
-      reducer.build(args)
+      @__flow = __flow_reducer.build(args)
     end
 
-    def self.flow(*args)
-      @__flow ||= __set_flow__(Flow::Reducer, args)
+    def self.__flow_set!
+      __flow_set(__flow_use_cases_get) if !__flow_get && @__flow_use_cases
     end
 
-    def self.call!
-      return const_get(:Flow_Step) if const_defined?(:Flow_Step)
-
-      const_set(:Flow_Step, Class.new(self) do
-        private def __call
-          __call_use_case
-        end
-      end)
+    def self.flow(*args)
+      __flow_use_cases_set(args)
     end
 
     def initialize(input)
-      @__input = input
-      self.attributes = input
+      __setup_use_case(input)
     end
 
     def call!
@@ -90,8 +112,16 @@ module Micro
 
     private
 
+      def __setup_use_case(input)
+        self.class.__flow_set!
+
+        @__input = input
+
+        self.attributes = input
+      end
+
       def __call
-        return self.class.__get_flow__.call(@__input) if self.class.__get_flow__
+        return __call_use_case_flow if __call_use_case_flow?
 
         __call_use_case
       end
@@ -104,6 +134,14 @@ module Micro
         raise Error::UnexpectedResult.new(self.class)
       end
 
+      def __call_use_case_flow?
+        self.class.__flow_get
+      end
+
+      def __call_use_case_flow
+        self.class.__flow_get.call(@__input)
+      end
+
       def Success(arg = :ok)
         value, type = block_given? ? [yield, arg] : [arg, :ok]
 

data/lib/micro/case/safe.rb

@@ -4,7 +4,7 @@ module Micro
   class Case
     class Safe < ::Micro::Case
       def call
-        super
+        __call
       rescue => exception
         raise exception if Error::ByWrongUsage.check(exception)
 

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

@@ -36,8 +36,8 @@ module Micro
         Flow::Reducer.build(Array(args))
       end
 
-      def self.flow(*args)
-        @__flow ||= __set_flow__(Flow::Reducer, args)
+      def self.__flow_reducer
+        Flow::Reducer
       end
     end
   end

data/lib/micro/case/version.rb

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

data/lib/micro/case/with_validation.rb

@@ -15,21 +15,19 @@ module Micro
     end
 
     def initialize(input)
-      @__input = input
-      self.attributes = input
+      __setup_use_case(input)
+
       run_validations! if respond_to?(:run_validations!, true)
     end
 
     private
 
-      def __call_use_case
-        return failure_by_validation_error(self) if !self.class.auto_validation_disabled? && invalid?
-
-        result = call!
+      def __call
+        return __call_use_case_flow if __call_use_case_flow?
 
-        return result if result.is_a?(Result)
+        return failure_by_validation_error(self) if !self.class.auto_validation_disabled? && invalid?
 
-        raise Error::UnexpectedResult.new(self.class)
+        __call_use_case
       end
 
       def failure_by_validation_error(object)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u-case
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Rodrigo Serradura