u-case 2.5.0 → 3.0.0.rc4

data/lib/micro/case.rb

@@ -3,66 +3,43 @@
 require 'kind'
 require 'micro/attributes'
 
+require 'micro/case/version'
+
 module Micro
   class Case
-    require 'micro/case/version'
     require 'micro/case/utils'
     require 'micro/case/result'
     require 'micro/case/error'
     require 'micro/case/safe'
     require 'micro/case/strict'
-    require 'micro/case/flow/reducer'
-    require 'micro/case/flow'
-    require 'micro/case/safe/flow'
-
-    include Micro::Attributes.without(:strict_initialize)
-
-    def self.to_proc
-      Proc.new { |arg| call(arg) }
-    end
+    require 'micro/case/config'
 
-    def self.Flow(args)
-      Flow::Reducer.build(Array(args))
-    end
-
-    def self.>>(use_case)
-      Flow([self, use_case])
-    end
+    require 'micro/cases'
 
-    def self.&(use_case)
-      Safe::Flow([self, use_case])
-    end
+    include Micro::Attributes.without(:strict_initialize)
 
     def self.call(options = {})
-      new(options).call
+      new(options).__call__
     end
 
-    def self.__new__(result, arg)
-      instance = new(arg)
-      instance.__set_result__(result)
-      instance
+    def self.to_proc
+      Proc.new { |arg| call(arg) }
     end
 
-    def self.__call_and_set_transition__(result, arg)
-      if arg.respond_to?(:keys)
-        result.__set_transitions_accessible_attributes__(arg.keys)
-      end
-
-      __new__(result, arg).call
+    def self.flow(*args)
+      @__flow_use_cases = args
     end
 
-    FLOW_STEP = 'Flow_Step'.freeze
-
-    private_constant :FLOW_STEP
-
-    def self.__call!
-      return const_get(FLOW_STEP) if const_defined?(FLOW_STEP, false)
+    class << self
+      alias __call__ call
 
-      class_eval("class #{FLOW_STEP} < #{self.name}; private def __call; __call_use_case; end; end")
-    end
+      def config
+        yield(Config.instance)
+      end
 
-    def self.call!
-      self
+      def call!
+        self
+      end
     end
 
     def self.inherited(subclass)
@@ -77,43 +54,58 @@ module Micro
       end
     end
 
-    def self.__flow_reducer
-      Flow::Reducer
+    def self.__new__(result, arg)
+      instance = new(arg)
+      instance.__set_result__(result)
+      instance
     end
 
-    def self.__flow_get
-      return @__flow if defined?(@__flow)
-    end
+    def self.__call_and_set_transition__(result, arg)
+      input =
+        arg.is_a?(Hash) ? result.__set_transitions_accessible_attributes__(arg) : arg
 
-    private_class_method def self.__flow_use_cases
-      return @__flow_use_cases if defined?(@__flow_use_cases)
+      __new__(result, input).__call__
     end
 
-    private_class_method def self.__flow_use_cases_get
-      Array(__flow_use_cases)
-        .map { |use_case| use_case == self ? self.__call! : use_case }
+    def self.__flow_builder__
+      Cases::Flow
     end
 
-    private_class_method def self.__flow_use_cases_set(args)
-      @__flow_use_cases = args
+    def self.__flow_get__
+      return @__flow if defined?(@__flow)
     end
 
     private_class_method def self.__flow_set(args)
-      return if __flow_get
+      return if __flow_get__
 
-      def self.use_cases; __flow_get.use_cases; end
+      def self.use_cases; __flow_get__.use_cases; end
 
       self.class_eval('def use_cases; self.class.use_cases; end')
 
-      @__flow = __flow_reducer.build(args)
+      @__flow = __flow_builder__.build(args)
     end
 
-    def self.__flow_set!
-      __flow_set(__flow_use_cases_get) if !__flow_get && __flow_use_cases
+    FLOW_STEP = 'Flow_Step'.freeze
+
+    private_constant :FLOW_STEP
+
+    def self.__call__!
+      return const_get(FLOW_STEP) if const_defined?(FLOW_STEP, false)
+
+      class_eval("class #{FLOW_STEP} < #{self.name}; private def __call; __call_use_case; end; end")
     end
 
-    def self.flow(*args)
-      __flow_use_cases_set(args)
+    private_class_method def self.__flow_use_cases
+      return @__flow_use_cases if defined?(@__flow_use_cases)
+    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
+
+    def self.__flow_set__!
+      __flow_set(__flow_use_cases_get) if !__flow_get__ && __flow_use_cases
     end
 
     def initialize(input)
@@ -124,8 +116,8 @@ module Micro
       raise NotImplementedError
     end
 
-    def call
-      __call
+    def __call__
+      __call!
     end
 
     def __set_result__(result)
@@ -137,15 +129,19 @@ module Micro
 
     private
 
+      # This method was reserved for a new feature
+      def call
+      end
+
       def __setup_use_case(input)
-        self.class.__flow_set!
+        self.class.__flow_set__!
 
         @__input = input
 
         self.attributes = input
       end
 
-      def __call
+      def __call!
         return __call_use_case_flow if __call_use_case_flow?
 
         __call_use_case
@@ -156,44 +152,55 @@ module Micro
 
         return result if result.is_a?(Result)
 
-        raise Error::UnexpectedResult.new(self.class)
+        raise Error::UnexpectedResult.new("#{self.class.name}#call!")
       end
 
       def __call_use_case_flow?
-        self.class.__flow_get
+        self.class.__flow_get__
       end
 
       def __call_use_case_flow
-        self.class.__flow_get.call(@__input)
+        self.class.__flow_get__.call(@__input)
       end
 
-      def Success(arg = :ok)
-        value, type = block_given? ? [yield, arg] : [arg, :ok]
+      def Success(type = :ok, result: nil)
+        value = result || type
 
-        __get_result_with(true, value, type)
+        __get_result(true, value, type)
       end
 
-      def Failure(arg = :error)
-        value = block_given? ? yield : arg
-        type = __map_failure_type(value, block_given? ? arg : :error)
+      MapFailureType = -> (value, type) do
+        return type if type != :error
+        return value if value.is_a?(Symbol)
+        return :exception if value.is_a?(Exception)
 
-        __get_result_with(false, value, type)
+        type
       end
 
-      def __map_failure_type(arg, type)
-        return type if type != :error
-        return arg if arg.is_a?(Symbol)
-        return :exception if arg.is_a?(Exception)
+      def Failure(type = :error, result: nil)
+        value = result || type
 
-        type
+        type = MapFailureType.call(value, type)
+
+        __get_result(false, value, type)
       end
 
-      def __get_result__
+      def __result
         @__result ||= Result.new
       end
 
-      def __get_result_with(is_success, value, type)
-        __get_result__.__set__(is_success, value, type, self)
+      def __get_result(is_success, value, type)
+        __result.__set__(is_success, value, type, self)
       end
+
+      private_constant :MapFailureType
+  end
+
+  def self.case?(arg)
+    (arg.is_a?(Class) && arg < Case) || arg.is_a?(Case)
+  end
+
+  def self.case_or_flow?(arg)
+    case?(arg) || arg.is_a?(Cases::Flow)
   end
 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

@@ -4,9 +4,11 @@ module Micro
   class Case
     module Error
       class UnexpectedResult < TypeError
-        MESSAGE = '#call! must return an instance of Micro::Case::Result'.freeze
+        MESSAGE = 'must return an instance of Micro::Case::Result'.freeze
 
-        def initialize(klass); super(klass.name + MESSAGE); end
+        def initialize(context)
+          super("#{context} #{MESSAGE}")
+        end
       end
 
       class ResultIsAlreadyDefined < ArgumentError
@@ -17,6 +19,24 @@ module Micro
         def initialize; super('type must be a Symbol'.freeze); end
       end
 
+      class InvalidResult < TypeError
+        def initialize(is_success, type, use_case)
+          base =
+            "The result returned from #{use_case.class.name}#call! must be a Hash."
+
+          result = is_success ? 'Success'.freeze : 'Failure'.freeze
+
+          example =
+            if type === :ok || type === :error || type === :exception
+              "#{result}(result: { key: 'value' })"
+            else
+              "#{result}(:#{type}, result: { key: 'value' })"
+            end
+
+          super("#{base}\n\nExample:\n  #{example}")
+        end
+      end
+
       class InvalidResultInstance < ArgumentError
         def initialize; super('argument must be an instance of Micro::Case::Result'.freeze); end
       end
@@ -25,26 +45,12 @@ module Micro
         def initialize; super('use case must be a kind or an instance of Micro::Case'.freeze); end
       end
 
-      class InvalidUseCases < ArgumentError
-        def initialize; super('argument must be a collection of `Micro::Case` classes'.freeze); end
-      end
-
       class InvalidInvocationOfTheThenMethod < StandardError
         def initialize; super('Invalid invocation of the Micro::Case::Result#then method'); end
       end
 
-      class UndefinedFlow < ArgumentError
-        def initialize; super("This class hasn't declared its flow. Please, use the `flow()` macro to define one.".freeze); end
-      end
-
-      class InvalidAccessToTheUseCaseObject < StandardError
-        def initialize; super('only a failure result can access its use case object'.freeze); end
-      end
-
-      module ByWrongUsage
-        def self.check(exception)
-          exception.is_a?(Error::UnexpectedResult) || exception.is_a?(ArgumentError)
-        end
+      def self.by_wrong_usage?(exception)
+        exception.is_a?(InvalidResult) || exception.is_a?(UnexpectedResult) || exception.is_a?(ArgumentError)
       end
     end
   end

data/lib/micro/case/result.rb

@@ -9,38 +9,25 @@ module Micro
 
       @@transition_tracking_disabled = false
 
-      def self.disable_transition_tracking
-        @@transition_tracking_disabled = true
-      end
-
-      class Data
-        attr_reader :value, :type
-
-        def initialize(value, type)
-          @value, @type = value, type
-        end
-
-        def to_ary; [value, type]; end
-      end
-
-      private_constant :Data
+      attr_reader :type, :data, :use_case
 
-      attr_reader :value, :type
+      alias value data
 
       def initialize
-        @__transitions__ = {}
-        @__transitions_accessible_attributes__ = Set.new
+        @__transitions__ = []
+        @__transitions_accessible_attributes__ = {}
       end
 
-      def __set__(is_success, value, type, use_case)
-        raise Error::InvalidResultType unless type.is_a?(Symbol)
-        raise Error::InvalidUseCase if !is_a_use_case?(use_case)
-
-        @success, @value, @type, @use_case = is_success, value, type, use_case
+      def to_ary
+        [data, type]
+      end
 
-        __set_transition__ unless @@transition_tracking_disabled
+      def [](key)
+        data[key]
+      end
 
-        self
+      def values_at(*keys)
+        data.values_at(*keys)
       end
 
       def success?
@@ -51,106 +38,145 @@ 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(value) if success_type?(expected_type)
+        yield(hook_data, @use_case)
 
         self
       end
 
       def on_failure(expected_type = nil)
-        return self unless failure_type?(expected_type)
+        return self unless __failure_type?(expected_type)
 
-        data = expected_type.nil? ? Data.new(value, type).tap(&:freeze) : value
+        hook_data = expected_type.nil? ? self : data
 
-        yield(data, @use_case)
+        yield(hook_data, @use_case)
 
         self
       end
 
       def on_exception(expected_exception = nil)
-        return self unless failure_type?(:exception)
+        return self unless __failure_type?(:exception)
 
-        if !expected_exception || (Kind.is(Exception, expected_exception) && value.is_a?(expected_exception))
-          yield(value, @use_case)
+        if !expected_exception || (Kind.is(Exception, expected_exception) && data.fetch(:exception).is_a?(expected_exception))
+          yield(data, @use_case)
         end
 
         self
       end
 
-      def then(arg = nil, &block)
+      def then(use_case = nil, attributes = nil, &block)
         can_yield_self = respond_to?(:yield_self)
 
         if block
-          raise Error::InvalidInvocationOfTheThenMethod if arg
+          raise Error::InvalidInvocationOfTheThenMethod if use_case
           raise NotImplementedError if !can_yield_self
 
           yield_self(&block)
         else
-          return yield_self if !arg && can_yield_self
+          return yield_self if !use_case && can_yield_self
 
-          raise Error::InvalidInvocationOfTheThenMethod if !is_a_use_case?(arg)
+          if use_case.is_a?(Proc)
+            return failure? ? self : __call_proc(use_case, expected: 'then(-> {})'.freeze)
+          end
+
+          # TODO: Test the then method with a Micro::Cases.{flow,safe_flow}() instance.
+          raise Error::InvalidInvocationOfTheThenMethod unless ::Micro.case_or_flow?(use_case)
 
           return self if failure?
 
-          arg.__call_and_set_transition__(self, self.value)
+          input = attributes.is_a?(Hash) ? self.data.merge(attributes) : self.data
+
+          use_case.__call_and_set_transition__(self, input)
         end
       end
 
+      def |(arg)
+        return self if failure?
+
+        return __call_proc(arg, expected: '| -> {}'.freeze) if arg.is_a?(Proc)
+
+        raise Error::InvalidInvocationOfTheThenMethod unless ::Micro.case_or_flow?(arg)
+
+        failure? ? self : arg.__call_and_set_transition__(self, data)
+      end
+
       def transitions
-        return [] if @__transitions__.empty?
+        @__transitions__.clone
+      end
 
-        @__transitions__.map { |_use_case, transition| transition }
+      FetchData = -> (data) do
+        return data if data.is_a?(Hash)
+        return { data => true } if data.is_a?(Symbol)
+
+        { exception: data } if data.is_a?(Exception)
       end
 
-      def __set_transitions_accessible_attributes__(attribute_names)
-        return if @@transition_tracking_disabled
+      def __set__(is_success, data, type, use_case)
+        raise Error::InvalidResultType unless type.is_a?(Symbol)
+        raise Error::InvalidUseCase unless ::Micro.case?(use_case)
+
+        @success, @type, @use_case = is_success, type, use_case
+
+        @data = FetchData.call(data)
+
+        raise Micro::Case::Error::InvalidResult.new(is_success, type, use_case) unless @data
 
-        __set_transitions_accessible_attributes__!(
-          attribute_names.map!(&:to_sym)
-        )
+        __set_transition unless @@transition_tracking_disabled
+
+        self
+      end
+
+      def __set_transitions_accessible_attributes__(attributes_data)
+        return attributes_data if @@transition_tracking_disabled
+
+        attributes = Utils.symbolize_hash_keys(attributes_data)
+
+        __update_transitions_accessible_attributes(attributes)
       end
 
       private
 
-        def __set_transitions_accessible_attributes__!(attribute_names)
-          @__transitions_accessible_attributes__.merge(
-            attribute_names
-          )
+        def __call_proc(arg, expected:)
+          result = arg.arity.zero? ? arg.call : arg.call(data.clone)
+
+          return result if result.is_a?(Result)
+
+          raise Error::UnexpectedResult.new("#{Result.name}##{expected}")
         end
 
-        def success_type?(expected_type)
+        def __success_type?(expected_type)
           success? && (expected_type.nil? || expected_type == type)
         end
 
-        def failure_type?(expected_type)
+        def __failure_type?(expected_type)
           failure? && (expected_type.nil? || expected_type == type)
         end
 
-        def is_a_use_case?(arg)
-          (arg.is_a?(Class) && arg < ::Micro::Case) || arg.is_a?(::Micro::Case)
+        def __update_transitions_accessible_attributes(attributes)
+          @__transitions_accessible_attributes__.merge!(attributes)
+          @__transitions_accessible_attributes__
         end
 
-        def __set_transition__
+        def __set_transition
           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
+            result => { type: @type, result: data },
+            accessible_attributes: @__transitions_accessible_attributes__.keys
           }
-
-          @__transitions__[use_case_class] = transition
         end
+
+        private_constant :FetchData
     end
   end
 end