u-case 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5a9b11b39c8c90670c4308c91e4e887871eb8f98a1fb739c4be71885a14d0b8
-  data.tar.gz: d4ce16229a9afd7dd4d1a1cf8e5b11067a11a6317c6857264ba46b324b220994
+  metadata.gz: e43c3e14dcb10002feb94f83f7d9289b49164e5908f3e8b58fa64e62d69796db
+  data.tar.gz: 9f3a37d02e5e1c1369f74e8cdf14cc3038fad55df5db08bd1a330dd7004e5ba1
 SHA512:
-  metadata.gz: '078f264aa7ca294bcbc12e97b4ef210a11a46151adc94d7954846e81f6e6f1647896969ee8fcf40b1bf715145b7adf029f7d22d26f226c7071d29ea477ca56b7'
-  data.tar.gz: e5a24e5095cb1178e92919d3f953bfbc6d690242dffafb9b8cdc4ce7c00e943c9921d4013e76b3e062d4269d32b4e4f7bb133951cc0e395416090b36cbf91b36
+  metadata.gz: 744d7c78a228a3ae9197762f9e259dd72ab2f1b8c20af968fca4cbe46931c703abd9aa051c4aa0669b61f51b14d42a990834dc4fc34dc2f60a9f20d68867fbab
+  data.tar.gz: 7da45bc3752296dd000bf016ef35ff7c993d0ea5c2218e43e6f1d492ec7d41f457e7048cf8b281d0ecb6f40efe05df19d07809d69db3a7a41df02f10028a7e68

data/README.md

@@ -6,7 +6,7 @@
 </p>
 
 <p align="center">
-  <img src="https://img.shields.io/badge/ruby-2.2+-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
+  <img src="https://img.shields.io/badge/ruby->%3D%202.2.0-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
 
   <a href="https://rubygems.org/gems/u-case">
     <img alt="Gem" src="https://img.shields.io/gem/v/u-case.svg?style=flat-square">
@@ -38,7 +38,8 @@ The main project goals are:
 
 Version   | Documentation
 --------- | -------------
-4.0.0     | https://github.com/serradura/u-case/blob/main/README.md
+unreleased| https://github.com/serradura/u-case/blob/main/README.md
+4.1.0     | https://github.com/serradura/u-case/blob/v4.x/README.md
 3.1.0     | https://github.com/serradura/u-case/blob/v3.x/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
@@ -100,7 +101,8 @@ Version   | Documentation
 
 | u-case         | branch  | ruby     |  activemodel  | u-attributes |
 | -------------- | ------- | -------- | ------------- | ------------ |
-| 4.0.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 2.0 |
+| unreleased     | main    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 2.0 |
+| 4.1.0          | v4.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 2.0 |
 | 3.1.0          | v3.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 1.1 |
 | 2.6.0          | v2.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 1.1 |
 | 1.1.0          | v1.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 1.1 |
@@ -124,7 +126,7 @@ Version   | Documentation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'u-case', '~> 3.1.0'
+gem 'u-case', '~> 4.1.0'
 ```
 
 And then execute:

data/README.pt-BR.md

@@ -38,7 +38,8 @@ Principais objetivos deste projeto:
 
 Versão    | Documentação
 --------- | -------------
-4.0.0     | https://github.com/serradura/u-case/blob/main/README.md
+unreleased| https://github.com/serradura/u-case/blob/main/README.md
+4.1.0     | https://github.com/serradura/u-case/blob/v4.x/README.md
 3.1.0     | https://github.com/serradura/u-case/blob/v3.x/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
@@ -99,7 +100,7 @@ Versão    | Documentação
 
 | u-case         | branch  | ruby     |  activemodel  | u-attributes |
 | -------------- | ------- | -------- | ------------- | ------------ |
-| 4.0.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 2.0 |
+| 4.1.0          | main    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 2.0 |
 | 3.1.0          | v3.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 1.1 |
 | 2.6.0          | v2.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 1.1 |
 | 1.1.0          | v1.x    | >= 2.2.0 | >= 3.2, < 6.1 |       ~> 1.1 |
@@ -123,7 +124,7 @@ Versão    | Documentação
 Adicione essa linha ao Gemfile da sua aplicação:
 
 ```ruby
-gem 'u-case', '~> 3.1.0'
+gem 'u-case', '~> 4.1.0'
 ```
 
 E então execute:

data/lib/micro/case.rb

@@ -7,6 +7,7 @@ require 'micro/case/version'
 
 module Micro
   class Case
+    require 'micro/cases/utils'
     require 'micro/case/utils'
     require 'micro/case/error'
     require 'micro/case/result'
@@ -16,10 +17,14 @@ module Micro
 
     require 'micro/cases'
 
-    include Micro::Attributes.with(:initialize, :diff)
+    include Micro::Attributes
 
-    def self.call(options = Kind::Empty::HASH)
-      new(options).__call__
+    def self.call(input = Kind::Empty::HASH)
+      result = __new__(Result.new, input).__call__
+
+      return result unless block_given?
+
+      yield Result::Wrapper.new(result)
     end
 
     INVALID_INVOCATION_OF_THE_THEN_METHOD =
@@ -47,7 +52,7 @@ module Micro
     end
 
     def self.flow(*args)
-      @__flow_use_cases = args
+      @__flow_use_cases = Cases::Utils.map_use_cases(args)
     end
 
     class << self
@@ -81,6 +86,8 @@ module Micro
       new(input).__set_result__(result)
     end
 
+    private_class_method :new
+
     def self.__flow_builder__
       Cases::Flow
     end
@@ -122,6 +129,14 @@ module Micro
       __flow_set(__flow_use_cases_get) if !__flow_get__ && __flow_use_cases
     end
 
+    def self.inspect
+      if __flow_use_cases
+        '<%s (%s) use_cases=%s>' % [self, __flow_builder__, @__flow_use_cases]
+      else
+        '<%s (%s) attributes=%s>' % [self, self.superclass, attributes]
+      end
+    end
+
     def initialize(input)
       __setup_use_case(input)
     end
@@ -131,7 +146,7 @@ module Micro
     end
 
     def __call__
-      call
+      __call_the_use_case_or_its_flow
     end
 
     def __set_result__(result)
@@ -145,12 +160,21 @@ module Micro
 
     private
 
+      def call(use_case, defaults = Kind::Empty::HASH)
+        raise Error::InvalidUseCase unless ::Micro.case_or_flow?(use_case)
+
+        input =
+          defaults.empty? ? attributes : attributes.merge(Utils::Hashes.stringify_keys(defaults))
+
+        use_case.__new__(@__result, input).__call__
+      end
+
       def apply(name)
         method(name)
       end
 
-      def call
-        return __call_use_case_flow if __call_use_case_flow?
+      def __call_the_use_case_or_its_flow
+        return __call_the_use_case_flow if __call_the_use_case_flow?
 
         __call_use_case
       end
@@ -171,11 +195,11 @@ module Micro
         raise Error::UnexpectedResult.new("#{self.class.name}#call!")
       end
 
-      def __call_use_case_flow?
+      def __call_the_use_case_flow?
         self.class.__flow_get__
       end
 
-      def __call_use_case_flow
+      def __call_the_use_case_flow
         self.class.__flow_get__.call(@__input)
       end
 
@@ -201,18 +225,18 @@ module Micro
         __get_result(false, value, type)
       end
 
-      def __result
-        @__result ||= Result.new
-      end
-
       def __get_result(is_success, value, type)
-        __result.__set__(is_success, value, type, self)
+        @__result.__set__(is_success, value, type, self)
       end
 
     private_constant :MapFailureType, :INVALID_INVOCATION_OF_THE_THEN_METHOD
   end
 
+  def self.case?(arg)
+    arg.is_a?(Class) && arg < Case
+  end
+
   def self.case_or_flow?(arg)
-    (arg.is_a?(Class) && arg < Case) || arg.is_a?(Cases::Flow)
+    case?(arg) || arg.is_a?(Cases::Flow)
   end
 end

data/lib/micro/case/result.rb

@@ -5,6 +5,7 @@ require 'set'
 module Micro
   class Case
     class Result
+      require 'micro/case/result/wrapper'
       require 'micro/case/result/transitions'
 
       Kind::Types.add(self)
@@ -23,15 +24,26 @@ module Micro
       alias value data
 
       def initialize(transitions_mapper = Transitions::MapEverything)
+        enable_transitions = @@transitions_enabled
+
+        @__is_unknown = true
         @__accumulated_data = {}
+        @__tracked_use_cases = Set.new
         @__accessible_attributes = {}
 
-        enable_transitions = @@transitions_enabled
-
         @__transitions = enable_transitions ? [] : Kind::Empty::ARRAY
         @__transitions_mapper = transitions_mapper if enable_transitions
       end
 
+      def inspect
+        pretty_type = @__success ? 'Success' : 'Failure'
+
+        instance_info = '%s (%s) type=:%s data=%s' % [pretty_type, self.class, @type, data]
+        transitions_info = ' transitions=%d' % [@__transitions.size] if Micro::Case::Result.transitions_enabled?
+
+        "<#{instance_info}#{transitions_info}>"
+      end
+
       def to_ary
         [data, type]
       end
@@ -57,7 +69,7 @@ module Micro
       end
 
       def slice(*keys)
-        Utils.slice_hash(data, keys)
+        Utils::Hashes.slice(data, keys)
       end
 
       def success?
@@ -68,6 +80,10 @@ module Micro
         !success?
       end
 
+      def unknown?
+        @__is_unknown
+      end
+
       def accessible_attributes
         @__accessible_attributes.keys
       end
@@ -75,6 +91,7 @@ module Micro
       def on_success(expected_type = nil)
         return self unless __success_type?(expected_type)
 
+        @__is_unknown = false
         hook_data = expected_type.nil? ? self : data
 
         yield(hook_data, @use_case)
@@ -85,6 +102,7 @@ module Micro
       def on_failure(expected_type = nil)
         return self unless __failure_type?(expected_type)
 
+        @__is_unknown = false
         hook_data = expected_type.nil? ? self : data
 
         yield(hook_data, @use_case)
@@ -102,6 +120,14 @@ module Micro
         self
       end
 
+      def on_unknown
+        return self unless unknown?
+
+        yield(self, @use_case)
+
+        self
+      end
+
       def then(use_case = nil, attributes = nil, &block)
         can_yield_self = respond_to?(:yield_self)
 
@@ -163,9 +189,13 @@ module Micro
 
         @__accumulated_data.merge!(@data)
 
-        use_case_attributes = Utils.symbolize_hash_keys(@use_case.attributes)
+        use_case_attributes = Utils::Hashes.symbolize_keys(@use_case.attributes)
 
-        __update_accessible_attributes(use_case_attributes)
+        unless @__tracked_use_cases.member?(use_case_class = @use_case.class)
+          @__tracked_use_cases.add(use_case_class)
+
+          __update_accessible_attributes(use_case_attributes)
+        end
 
         __set_transition(use_case_attributes) unless @__transitions.frozen?
 
@@ -175,7 +205,7 @@ module Micro
       def __set_accessible_attributes__(arg)
         return arg unless arg.is_a?(Hash)
 
-        attributes = Utils.symbolize_hash_keys(arg)
+        attributes = Utils::Hashes.symbolize_keys(arg)
 
         __update_accessible_attributes(attributes)
         __fetch_accessible_attributes

data/lib/micro/case/result/transitions.rb

@@ -15,4 +15,3 @@ module Micro
     end
   end
 end
-

data/lib/micro/case/result/wrapper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Micro
+  class Case
+    class Result
+      class Wrapper
+        def initialize(result)
+          @__is_unknown = true
+
+          @result = result
+        end
+
+        def failure(type = nil)
+          return if @result.success?
+
+          if result_type?(type)
+            @__is_unknown = false
+
+            yield(@result)
+          end
+        end
+
+        def success(type = nil)
+          return if @result.failure?
+
+          if result_type?(type)
+            @__is_unknown = false
+
+            yield(@result)
+          end
+        end
+
+        def unknown
+          return yield(@result) if @__is_unknown
+        end
+
+        private
+
+          def result_type?(type)
+            type.nil? || @result.type == type
+          end
+      end
+    end
+  end
+end

data/lib/micro/case/safe.rb

@@ -8,7 +8,7 @@ module Micro
       end
 
       def __call__
-        call
+        __call_the_use_case_or_its_flow
       rescue => exception
         raise exception if Error.by_wrong_usage?(exception)
 

data/lib/micro/case/utils.rb

@@ -3,25 +3,34 @@
 module Micro
   class Case
     module Utils
-      def self.symbolize_hash_keys(hash)
-        if Kind::Of::Hash(hash).respond_to?(:transform_keys)
-          hash.transform_keys { |key| key.to_sym rescue key }
-        else
+
+      module Hashes
+        def self.respond_to?(hash, method)
+          Kind.of(Hash, hash).respond_to?(method)
+        end
+
+        def self.symbolize_keys(hash)
+          return hash.transform_keys { |key| key.to_sym rescue key } if respond_to?(hash, :transform_keys)
+
           hash.each_with_object({}) do |(k, v), memo|
             key = k.to_sym rescue k
-
             memo[key] = v
           end
         end
-      end
 
-      def self.slice_hash(hash, keys)
-        if Kind::Of::Hash(hash).respond_to?(:slice)
-          hash.slice(*keys)
-        else
+        def self.stringify_keys(hash)
+          return hash.transform_keys(&:to_s) if respond_to?(hash, :transform_keys)
+
+          hash.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v }
+        end
+
+        def self.slice(hash, keys)
+          return hash.slice(*keys) if respond_to?(hash, :slice)
+
           hash.select { |key, _value| keys.include?(key) }
         end
       end
+
     end
   end
 end

data/lib/micro/case/version.rb

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

data/lib/micro/cases.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'micro/cases/utils'
+require 'micro/cases/error'
 require 'micro/cases/flow'
 require 'micro/cases/safe/flow'
+require 'micro/cases/map'
 
 module Micro
   module Cases
@@ -12,5 +15,9 @@ module Micro
     def self.safe_flow(args)
       Safe::Flow.build(args)
     end
+
+    def self.map(args)
+      Map.build(args)
+    end
   end
 end

data/lib/micro/cases/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Micro
+  module Cases
+
+    module Error
+      class InvalidUseCases < ArgumentError
+        def initialize; super('argument must be a collection of `Micro::Case` classes'.freeze); end
+      end
+    end
+
+  end
+end

data/lib/micro/cases/flow.rb

@@ -3,20 +3,15 @@
 module Micro
   module Cases
     class Flow
-      class InvalidUseCases < ArgumentError
-        def initialize; super('argument must be a collection of `Micro::Case` classes'.freeze); end
-      end
+      IsAUseCaseWithDefaults = -> arg { arg.is_a?(Array) && Micro.case?(arg[0]) && arg[1].is_a?(Hash) }
+      IsAValidUseCase = -> use_case { Micro.case?(use_case) || IsAUseCaseWithDefaults[use_case] }
 
       attr_reader :use_cases
 
-      def self.map_use_cases(arg)
-        arg.is_a?(Flow) ? arg.use_cases : Array(arg)
-      end
-
       def self.build(args)
-        use_cases = Array(args).flat_map { |arg| map_use_cases(arg) }
+        use_cases = Utils.map_use_cases(args)
 
-        raise InvalidUseCases if use_cases.any? { |klass| !(klass < ::Micro::Case) }
+        raise Error::InvalidUseCases if use_cases.none?(&IsAValidUseCase)
 
         new(use_cases)
       end
@@ -27,8 +22,12 @@ module Micro
         @first = @next_ones.shift
       end
 
+      def inspect
+        '<(%s) use_cases=%s>' % [self.class, @use_cases]
+      end
+
       def call!(input:, result:)
-        first_result = __case_use_case(@first, result, input)
+        first_result = __call_use_case(@first, result, input)
 
         return first_result if @next_ones.empty?
 
@@ -36,7 +35,11 @@ module Micro
       end
 
       def call(input = Kind::Empty::HASH)
-        call!(input: input, result: Case::Result.new)
+        result = call!(input: input, result: Case::Result.new)
+
+        return result unless block_given?
+
+        yield ::Micro::Case::Result::Wrapper.new(result)
       end
 
       alias __call__ call
@@ -68,17 +71,23 @@ module Micro
           raise Case::Error::InvalidInvocationOfTheThenMethod.new("#{self.class.name}#")
         end
 
-        def __case_use_case(use_case, result, input)
-          use_case.__new__(result, input).__call__
+        def __call_use_case(use_case, result, input)
+          __build_use_case(use_case, result, input).__call__
         end
 
         def __call_next_use_cases(first_result)
           @next_ones.reduce(first_result) do |result, use_case|
             break result if result.failure?
 
-            __case_use_case(use_case, result, result.data)
+            __call_use_case(use_case, result, result.data)
           end
         end
+
+        def __build_use_case(use_case, result, input)
+          return use_case.__new__(result, input) unless use_case.is_a?(Array)
+
+          use_case[0].__new__(result, input.merge(use_case[1]))
+        end
     end
   end
 end

data/lib/micro/cases/map.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Micro
+  module Cases
+    class Map
+      IsAUseCaseOrFlowWithDefaults = -> arg { arg.is_a?(Array) && Micro.case_or_flow?(arg[0]) && arg[1].is_a?(Hash) }
+      IsAUseCaseOrFlow = -> arg { Micro.case_or_flow?(arg) || IsAUseCaseOrFlowWithDefaults[arg] }
+      HasValidArgs = -> (args) { Kind.of(Array, args).all?(&IsAUseCaseOrFlow) }
+
+      attr_reader :use_cases
+
+      def self.build(args)
+        raise Error::InvalidUseCases unless HasValidArgs[args]
+
+        new(args)
+      end
+
+      def initialize(use_cases)
+        @use_cases = use_cases
+      end
+
+      GetUseCaseResult = -> (hash) do
+        -> (use_case) do
+          return use_case.call(hash) unless use_case.is_a?(Array)
+
+          use_case[0].call(hash.merge(use_case[1]))
+        end
+      end
+
+      def call(arg = {})
+        hash = Kind.of(Hash, arg)
+
+        use_cases.map(&GetUseCaseResult[hash])
+      end
+
+      private_constant :HasValidArgs, :IsAUseCaseOrFlow, :IsAUseCaseOrFlowWithDefaults, :GetUseCaseResult
+    end
+  end
+end

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

@@ -4,8 +4,8 @@ module Micro
   module Cases
     module Safe
       class Flow < Cases::Flow
-        private def __case_use_case(use_case, result, input)
-          instance = use_case.__new__(result, input)
+        private def __call_use_case(use_case, result, input)
+          instance = __build_use_case(use_case, result, input)
           instance.__call__
         rescue => exception
           raise exception if Case::Error.by_wrong_usage?(exception)

data/lib/micro/cases/utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Micro
+  module Cases
+
+    module Utils
+      def self.map_use_cases(args)
+        collection = args.is_a?(Array) && args.size == 1 ? args[0] : args
+
+        Array(collection).each_with_object([]) do |arg, memo|
+          if arg.is_a?(Flow)
+            arg.use_cases.each { |use_case| memo << use_case }
+          else
+            memo << arg
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-case
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kind
@@ -97,14 +97,18 @@ files:
 - lib/micro/case/error.rb
 - lib/micro/case/result.rb
 - lib/micro/case/result/transitions.rb
+- lib/micro/case/result/wrapper.rb
 - lib/micro/case/safe.rb
 - lib/micro/case/strict.rb
 - lib/micro/case/utils.rb
 - lib/micro/case/version.rb
 - lib/micro/case/with_activemodel_validation.rb
 - lib/micro/cases.rb
+- lib/micro/cases/error.rb
 - lib/micro/cases/flow.rb
+- lib/micro/cases/map.rb
 - lib/micro/cases/safe/flow.rb
+- lib/micro/cases/utils.rb
 - lib/u-case.rb
 - lib/u-case/with_activemodel_validation.rb
 - test.sh