u-case 3.0.0 → 4.2.0

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,26 +17,32 @@ module Micro
 
     require 'micro/cases'
 
-    include Micro::Attributes.without(:strict_initialize)
+    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_THE_METHOD =
-      Error::InvalidInvocationOfTheThenMethod.new(self.name)
+    INVALID_INVOCATION_OF_THE_THEN_METHOD =
+      Error::InvalidInvocationOfTheThenMethod.new("#{self.name}.")
 
     def self.then(use_case = nil, &block)
       can_yield_self = respond_to?(:yield_self)
 
       if block
-        raise INVALID_INVOCATION_OF_THE_THE_METHOD if use_case
+        raise INVALID_INVOCATION_OF_THE_THEN_METHOD if use_case
         raise NotImplementedError if !can_yield_self
 
         yield_self(&block)
       else
         return yield_self if !use_case && can_yield_self
 
+        raise INVALID_INVOCATION_OF_THE_THEN_METHOD unless ::Micro.case_or_flow?(use_case)
+
         self.call.then(use_case)
       end
     end
@@ -45,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
@@ -61,7 +68,8 @@ module Micro
     end
 
     def self.inherited(subclass)
-      subclass.attributes(self.attributes_data({}))
+      subclass.__attributes_set_after_inherit__(self.__attributes_data__)
+
       subclass.extend ::Micro::Attributes.const_get('Macros::ForSubclasses'.freeze)
 
       if self.send(:__flow_use_cases) && !subclass.name.to_s.end_with?(FLOW_STEP)
@@ -78,6 +86,8 @@ module Micro
       new(input).__set_result__(result)
     end
 
+    private_class_method :new
+
     def self.__flow_builder__
       Cases::Flow
     end
@@ -119,6 +129,28 @@ module Micro
       __flow_set(__flow_use_cases_get) if !__flow_get__ && __flow_use_cases
     end
 
+    InspectKey = :__inspect_key__ # :nodoc:
+
+    def self.inspect
+      ids = (Thread.current[InspectKey] ||= [])
+
+      if ids.include?(object_id)
+        return sprintf('#<%s: {...}>', self)
+      end
+
+      begin
+        ids << object_id
+
+        if __flow_use_cases
+          return '<%s (%s) use_cases=%s>' % [self, __flow_builder__, @__flow_use_cases]
+        else
+          return '<%s (%s) attributes=%s>' % [self, self.superclass, attributes]
+        end
+      ensure
+        ids.pop
+      end
+    end
+
     def initialize(input)
       __setup_use_case(input)
     end
@@ -128,7 +160,7 @@ module Micro
     end
 
     def __call__
-      call
+      __call_the_use_case_or_its_flow
     end
 
     def __set_result__(result)
@@ -142,8 +174,21 @@ module Micro
 
     private
 
-      def call
-        return __call_use_case_flow if __call_use_case_flow?
+      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_the_use_case_or_its_flow
+        return __call_the_use_case_flow if __call_the_use_case_flow?
 
         __call_use_case
       end
@@ -164,11 +209,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
 
@@ -194,18 +239,32 @@ module Micro
         __get_result(false, value, type)
       end
 
-      def __result
-        @__result ||= Result.new
+      def __get_result(is_success, value, type)
+        @__result.__set__(is_success, value, type, self)
       end
 
-      def __get_result(is_success, value, type)
-        __result.__set__(is_success, value, type, self)
+      def transaction(adapter = :activerecord)
+        raise NotImplementedError unless adapter == :activerecord
+
+        result = nil
+
+        ActiveRecord::Base.transaction do
+          result = yield
+
+          raise ActiveRecord::Rollback if result.failure?
+        end
+
+        result
       end
 
-      private_constant :MapFailureType
+    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/config.rb

@@ -26,7 +26,7 @@ module Micro
       end
 
       def activemodel_validation_errors_failure
-        @activemodel_validation_errors_failure if defined?(@activemodel_validation_errors_failure)
+        return @activemodel_validation_errors_failure if defined?(@activemodel_validation_errors_failure)
 
         @activemodel_validation_errors_failure = :invalid_attributes
       end

data/lib/micro/case/error.rb

@@ -47,12 +47,15 @@ module Micro
 
       class InvalidInvocationOfTheThenMethod < StandardError
         def initialize(class_name)
-          super("Invalid invocation of the #{class_name}#then method")
+          super("Invalid invocation of the #{class_name}then method")
         end
       end
 
       def self.by_wrong_usage?(exception)
-        exception.is_a?(InvalidResult) || exception.is_a?(UnexpectedResult) || exception.is_a?(ArgumentError)
+        case exception
+        when Kind::Error, ArgumentError, InvalidResult, UnexpectedResult then true
+        else false
+        end
       end
     end
   end

data/lib/micro/case/result.rb

@@ -5,10 +5,13 @@ require 'set'
 module Micro
   class Case
     class Result
+      require 'micro/case/result/wrapper'
+      require 'micro/case/result/transitions'
+
       Kind::Types.add(self)
 
-      INVALID_INVOCATION_OF_THE_THE_METHOD =
-        Error::InvalidInvocationOfTheThenMethod.new(self.name)
+      INVALID_INVOCATION_OF_THE_THEN_METHOD =
+        Error::InvalidInvocationOfTheThenMethod.new("#{self.name}#")
 
       @@transitions_enabled = true
 
@@ -20,16 +23,35 @@ module Micro
 
       alias value data
 
-      def initialize
-        @__transitions = @@transitions_enabled ? [] : Kind::Empty::ARRAY
+      def initialize(transitions_mapper = Transitions::MapEverything)
+        enable_transitions = @@transitions_enabled
+
+        @__is_unknown = true
         @__accumulated_data = {}
+        @__tracked_use_cases = Set.new
         @__accessible_attributes = {}
+
+        @__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
 
+      def to_sym
+        @__success ? :success : :failure
+      end
+
       def [](key)
         data[key]
       end
@@ -47,20 +69,29 @@ module Micro
       end
 
       def slice(*keys)
-        Utils.slice_hash(data, keys)
+        Utils::Hashes.slice(data, keys)
       end
 
       def success?
-        @success
+        @__success
       end
 
       def failure?
         !success?
       end
 
+      def unknown?
+        @__is_unknown
+      end
+
+      def accessible_attributes
+        @__accessible_attributes.keys
+      end
+
       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)
@@ -71,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)
@@ -88,11 +120,19 @@ 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)
 
         if block
-          raise INVALID_INVOCATION_OF_THE_THE_METHOD if use_case
+          raise INVALID_INVOCATION_OF_THE_THEN_METHOD if use_case
           raise NotImplementedError if !can_yield_self
 
           yield_self(&block)
@@ -101,7 +141,7 @@ module Micro
           return failure? ? self : __call_proc(use_case, 'then(-> {})'.freeze) if use_case.is_a?(Proc)
           return failure? ? self : __call_method(use_case, attributes) if use_case.is_a?(Method)
 
-          raise INVALID_INVOCATION_OF_THE_THE_METHOD unless ::Micro.case_or_flow?(use_case)
+          raise INVALID_INVOCATION_OF_THE_THEN_METHOD unless ::Micro.case_or_flow?(use_case)
 
           return self if failure?
 
@@ -121,13 +161,13 @@ module Micro
         return __call_proc(arg, '| -> {}'.freeze) if arg.is_a?(Proc)
         return __call_method(arg) if arg.is_a?(Method)
 
-        raise INVALID_INVOCATION_OF_THE_THE_METHOD unless ::Micro.case_or_flow?(arg)
+        raise INVALID_INVOCATION_OF_THE_THEN_METHOD unless ::Micro.case_or_flow?(arg)
 
         failure? ? self : arg.__new__(self, data).__call__
       end
 
       def transitions
-        @__transitions.clone
+        @__transitions.dup
       end
 
       FetchData = -> (data) do
@@ -141,17 +181,21 @@ module Micro
         raise Error::InvalidResultType unless type.is_a?(Symbol)
         raise Error::InvalidUseCase unless use_case.is_a?(::Micro::Case)
 
-        @success, @type, @use_case = is_success, type, use_case
+        @__success, @type, @use_case = is_success, type, use_case
 
-        @data = FetchData.call(data)
+        @data = FetchData.call(data).freeze
 
         raise Micro::Case::Error::InvalidResult.new(is_success, type, use_case) unless @data
 
         @__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?
 
@@ -161,23 +205,26 @@ 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
       end
 
       private
 
-        def __fetch_accumulated_data(opt = nil)
-          __update_accessible_attributes(
-            opt ? opt.merge(@__accumulated_data) : @__accumulated_data
-          )
+        def __update_accessible_attributes(attributes)
+          @__accessible_attributes.merge!(attributes)
+        end
+
+        def __fetch_accessible_attributes
+          @__accessible_attributes.dup
         end
 
         def __call_proc(fn, expected)
-          input = __fetch_accumulated_data
+          __update_accessible_attributes(@__accumulated_data)
 
-          result = fn.arity.zero? ? fn.call : fn.call(input)
+          result = fn.arity.zero? ? fn.call : fn.call(__fetch_accessible_attributes)
 
           return self if result === self
 
@@ -185,9 +232,9 @@ module Micro
         end
 
         def __call_method(methd, attributes = nil)
-          input = __fetch_accumulated_data(attributes)
+          __update_accessible_attributes(attributes ? attributes.merge(@__accumulated_data) : @__accumulated_data)
 
-          result = methd.arity.zero? ? methd.call : methd.call(**input)
+          result = methd.arity.zero? ? methd.call : methd.call(**__fetch_accessible_attributes)
 
           return self if result === self
 
@@ -202,24 +249,11 @@ module Micro
           failure? && (expected_type.nil? || expected_type == type)
         end
 
-        def __update_accessible_attributes(attributes)
-          @__accessible_attributes.merge!(attributes)
-          @__accessible_attributes.dup
-        end
-
         def __set_transition(use_case_attributes)
-          use_case_class = @use_case.class
-
-          result = @success ? :success : :failure
-
-          @__transitions << {
-            use_case: { class: use_case_class, attributes: use_case_attributes },
-            result => { type: @type, result: data },
-            accessible_attributes: @__accessible_attributes.keys
-          }
+          @__transitions << @__transitions_mapper.call(self, use_case_attributes)
         end
 
-        private_constant :FetchData, :INVALID_INVOCATION_OF_THE_THE_METHOD
+      private_constant :FetchData, :INVALID_INVOCATION_OF_THE_THEN_METHOD
     end
   end
 end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Micro
+  class Case
+    class Result
+      class Transitions
+        MapEverything = -> (result, use_case_attributes) do
+          {
+            use_case: { class: result.use_case.class, attributes: use_case_attributes },
+            result.to_sym => { type: result.type, result: result.data },
+            accessible_attributes: result.accessible_attributes
+          }
+        end
+      end
+    end
+  end
+end