convenient_service 0.19.1 → 0.20.0

data/lib/convenient_service/service/plugins/can_have_connected_steps/entities/expressions/scalar.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -21,6 +26,13 @@ module ConvenientService
                 @step = step
               end
 
+              ##
+              # @return [ConvenientService::Service]
+              #
+              def organizer
+                step.organizer
+              end
+
               ##
               # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
               #
@@ -108,7 +120,7 @@ module ConvenientService
 
               ##
               # @param other [Object] Can be any type.
-              # @return [Boolean]
+              # @return [Boolean, nil]
               #
               def ==(other)
                 return unless other.instance_of?(self.class)

data/lib/convenient_service/service/plugins/can_have_connected_steps/entities/expressions.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "expressions/base"
 
 require_relative "expressions/empty"
@@ -8,3 +13,7 @@ require_relative "expressions/not"
 require_relative "expressions/and"
 require_relative "expressions/or"
 require_relative "expressions/group"
+
+require_relative "expressions/if"
+require_relative "expressions/else"
+require_relative "expressions/complex_if"

data/lib/convenient_service/service/plugins/can_have_connected_steps/entities/step_collection.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -90,7 +95,11 @@ module ConvenientService
             def with_organizer(organizer)
               expression_with_organizer = expression.with_organizer(organizer)
 
-              copy(overrides: {kwargs: {expression: expression_with_organizer, steps: expression_with_organizer.steps}})
+              if frozen?
+                copy(overrides: {kwargs: {expression: expression_with_organizer.freeze, steps: expression_with_organizer.steps.freeze}}).freeze
+              else
+                copy(overrides: {kwargs: {expression: expression_with_organizer, steps: expression_with_organizer.steps}})
+              end
             end
 
             ##
@@ -123,7 +132,7 @@ module ConvenientService
             # @return [Boolean]
             #
             def committed?
-              expression.frozen?
+              frozen?
             end
 
             ##

data/lib/convenient_service/service/plugins/can_have_connected_steps/entities.rb

@@ -1,4 +1,9 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "entities/expressions"
 require_relative "entities/step_collection"

data/lib/convenient_service/service/plugins/can_have_connected_steps/exceptions.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -10,16 +15,15 @@ module ConvenientService
             # @param container [Class<ConvenientService::Service>]
             # @return [void]
             #
-            # @internal
-            #   TODO: Use `display_name`.
-            #
             def initialize_with_kwargs(container:)
+              printable_container = Utils::Class.display_name(container)
+
               message = <<~TEXT
-                First step of `#{container}` is NOT set.
+                First step of `#{printable_container}` is NOT set.
 
                 Did you forget to use `step`? For example:
 
-                class #{container}
+                class #{printable_container}
                   # ...
 
                   step SomeService
@@ -35,18 +39,18 @@ module ConvenientService
           class FirstGroupStepIsNotSet < ::ConvenientService::Exception
             ##
             # @param container [Class<ConvenientService::Service>]
+            # @param method [Symbol]
             # @return [void]
             #
-            # @internal
-            #   TODO: Use `display_name`.
-            #
             def initialize_with_kwargs(container:, method:)
+              printable_container = Utils::Class.display_name(container)
+
               message = <<~TEXT
-                First step of `#{method}` from `#{container}` is NOT set.
+                First step of `#{method}` from `#{printable_container}` is NOT set.
 
                 Did you forget to use `step`? For example:
 
-                class #{container}
+                class #{printable_container}
                   # ...
 
                   #{method} do
@@ -63,6 +67,85 @@ module ConvenientService
             end
           end
 
+          class FirstConditionalGroupStepIsNotSet < ::ConvenientService::Exception
+            ##
+            # @param container [Class<ConvenientService::Service>]
+            # @param method [Symbol]
+            # @return [void]
+            #
+            def initialize_with_kwargs(container:, method:)
+              printable_container = Utils::Class.display_name(container)
+
+              message = <<~TEXT
+                First step of `#{method}` from `#{printable_container}` is NOT set.
+
+                Did you forget to use `step`? For example:
+
+                class #{printable_container}
+                  # ...
+
+                  #{method} SomeService do
+                    step SomeOtherService
+
+                    # ...
+                  end
+
+                  # ...
+                end
+              TEXT
+
+              initialize(message)
+            end
+          end
+
+          class ElseWithoutIf < ::ConvenientService::Exception
+            ##
+            # @param container [Class<ConvenientService::Service>]
+            # @param method [Symbol]
+            # @return [void]
+            #
+            def initialize_with_kwargs(container:, method:)
+              printable_container = Utils::Class.display_name(container)
+
+              message = <<~TEXT
+                First step of `#{method}` from `#{printable_container}` is NOT set.
+
+                Did you forget to use `step`? For example:
+
+                class #{printable_container}
+                  # ...
+
+                  #{method} SomeService do
+                    step SomeOtherService
+
+                    # ...
+                  end
+
+                  # ...
+                end
+              TEXT
+
+              initialize(message)
+            end
+          end
+
+          class ElseIfAfterElse < ::ConvenientService::Exception
+            ##
+            # @param container [Class<ConvenientService::Service>]
+            # @param method [Symbol]
+            # @return [void]
+            #
+            def initialize_with_kwargs(container:, method:)
+              printable_container = Utils::Class.display_name(container)
+
+              message = <<~TEXT
+                `#{method}` is called after `else_group` in `#{printable_container}`.
+              TEXT
+
+              initialize(message)
+            end
+          end
+
           class EmptyExpressionHasNoResult < ::ConvenientService::Exception
             ##
             # @return [void]
@@ -76,6 +159,19 @@ module ConvenientService
             end
           end
 
+          class EmptyExpressionHasNoOrganizer < ::ConvenientService::Exception
+            ##
+            # @return [void]
+            #
+            def initialize_without_arguments
+              message = <<~TEXT
+                Empty expression has NO organizer.
+              TEXT
+
+              initialize(message)
+            end
+          end
+
           class EmptyExpressionHasNoStatus < ::ConvenientService::Exception
             ##
             # @return [void]
@@ -88,6 +184,20 @@ module ConvenientService
               initialize(message)
             end
           end
+
+          class ServiceHasNoSteps < ::ConvenientService::Exception
+            ##
+            # @param service_class [Class<ConvenientService::Service>]
+            # @return [void]
+            #
+            def initialize_with_kwargs(service_class:)
+              message = <<~TEXT
+                #{Utils::Class.display_name(service_class)} has NO steps.
+              TEXT
+
+              initialize(message)
+            end
+          end
         end
       end
     end

data/lib/convenient_service/service/plugins/can_have_connected_steps/middleware.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -7,21 +12,16 @@ module ConvenientService
         class Middleware < MethodChainMiddleware
           intended_for :result, entity: :service
 
+          ##
+          # @return [ConvenientService::Service]
+          #
+          alias_method :service, :entity
+
           ##
           # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
           #
           def next(...)
-            return chain.next(...) if entity.steps.none?
-
-            entity.steps.each_evaluated_step do |step|
-              step.save_outputs_in_organizer!
-
-              step.trigger_callback
-
-              step.mark_as_completed!
-            end
-
-            entity.steps.result
+            service.steps.any? ? service.steps_result(...) : service.regular_result(...)
           end
         end
       end

data/lib/convenient_service/service/plugins/can_have_connected_steps.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "can_have_connected_steps/concern"
 require_relative "can_have_connected_steps/entities"
 require_relative "can_have_connected_steps/exceptions"

data/lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins

data/lib/convenient_service/service/plugins/can_have_fallbacks/exceptions.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins

data/lib/convenient_service/service/plugins/can_have_fallbacks/middleware.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -17,8 +22,7 @@ module ConvenientService
 
             ::ConvenientService.raise Exceptions::ServiceFallbackReturnValueNotSuccess.new(service: entity, result: fallback_result, status: status) unless fallback_result.success?
 
-            fallback_result.copy(overrides: {kwargs: {method => true}})
-              .tap { |result| result.success? }
+            fallback_result.copy(overrides: {kwargs: {method => true}}).tap(&:success?)
           end
 
           private

data/lib/convenient_service/service/plugins/can_have_fallbacks.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "can_have_fallbacks/concern"
 require_relative "can_have_fallbacks/exceptions"
 require_relative "can_have_fallbacks/middleware"

data/lib/convenient_service/service/plugins/can_have_recalculations/concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveRecalculations
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @return [ConvenientService::Service]
+            #
+            def recalculate
+              copy
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_recalculations.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+require_relative "can_have_recalculations/concern"

data/lib/convenient_service/service/plugins/can_have_rollbacks/middleware.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -37,9 +42,6 @@ module ConvenientService
           # @param service [ConvenientService::Service]
           # @return [void]
           #
-          # @internal
-          #   TODO: Compare what is faster `respond_to?` or `own_method`.
-          #
           def rollback_service(service)
             Utils::Object.safe_send(service, :rollback_result)
           end
@@ -55,7 +57,7 @@ module ConvenientService
             rollback_service(organizer)
 
             organizer.steps
-              .select(&:completed?)
+              .select(&:evaluated?)
               .reject(&:method_step?)
               .reverse_each { |step| rollback_result(step.service_result) }
           end

data/lib/convenient_service/service/plugins/can_have_rollbacks.rb

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "can_have_rollbacks/middleware"

data/lib/convenient_service/service/plugins/can_have_sequential_steps/concern.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -52,22 +57,6 @@ module ConvenientService
                   .tap(&:commit!)
               end
             end
-
-            ##
-            # @api private
-            #
-            # Returns step by index.
-            # Returns `nil` when index is out of range.
-            #
-            # @param index [Integer]
-            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
-            #
-            # @note This method was initially designed as a hook (callback trigger).
-            # @see ConvenientService::Service::Plugins::CanHaveSequentialSteps::Middleware#next
-            #
-            def step(index)
-              steps[index]
-            end
           end
         end
       end

data/lib/convenient_service/service/plugins/can_have_sequential_steps/entities/step_collection.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins

data/lib/convenient_service/service/plugins/can_have_sequential_steps/entities.rb

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "entities/step_collection"

data/lib/convenient_service/service/plugins/can_have_sequential_steps/middleware.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -8,7 +13,7 @@ module ConvenientService
           intended_for :result, entity: :service
 
           ##
-          # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
           #
           def next(...)
             return chain.next(...) if entity.steps.none?
@@ -37,13 +42,11 @@ module ConvenientService
           # As a result, side effects are executed only for evaluated steps.
           #
           # Each iteration marks step as completed.
-          # Each iteration triggers callback.
           #
           # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step, nil]
           #
           # @internal
           #   IMPORTANT: `step` status MUST be checked before marking it as completed.
-          #   IMPORTANT: `step` status MUST be checked before triggering callback.
           #
           #   NOTE: @marian13 you already tried to come up with a better name to express the idea that this method has side effects numerous amount of times.
           #   Do NOT spend too much time on that again, you have a lot of other tasks to do.
@@ -52,8 +55,7 @@ module ConvenientService
             entity.steps.find do |step|
               step.status.unsafe_not_success?
                 .tap { step.save_outputs_in_organizer! }
-                .tap { step.mark_as_completed! }
-                .tap { step.trigger_callback }
+                .tap { step.mark_as_evaluated! }
             end
           end
 

data/lib/convenient_service/service/plugins/can_have_sequential_steps.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "can_have_sequential_steps/concern"
 require_relative "can_have_sequential_steps/middleware"
 require_relative "can_have_sequential_steps/entities"

data/lib/convenient_service/service/plugins/can_have_step_aware_collections.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+require_relative "can_have_step_aware_enumerables/concern"
+require_relative "can_have_step_aware_enumerables/entities"
+require_relative "can_have_step_aware_enumerables/exceptions"
+
+require_relative "can_have_step_aware_enumerables/commands"

data/lib/convenient_service/service/plugins/can_have_step_aware_enumerables/commands/cast_step_aware_enumerable.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveStepAwareEnumerables
+        module Commands
+          class CastStepAwareEnumerable < Support::Command
+            ##
+            # @return [Hash{Class => Class}]
+            #
+            RUBY_CLASS_TO_STEP_AWARE_CLASS_MAP = {
+              ::Array => Entities::StepAwareEnumerables::Array,
+              ::Hash => Entities::StepAwareEnumerables::Hash,
+              ::Set => Entities::StepAwareEnumerables::Set,
+              ::Enumerator => Entities::StepAwareEnumerables::Enumerator,
+              ::Enumerator::Lazy => Entities::StepAwareEnumerables::LazyEnumerator,
+              ::Enumerator::Chain => Entities::StepAwareEnumerables::ChainEnumerator,
+              ::Enumerator::ArithmeticSequence => Entities::StepAwareEnumerables::ArithmeticSequenceEnumerator
+            }
+
+            ##
+            # @!attribute [r] object
+            #   @return [Object] Can be any type.
+            #
+            attr_reader :object
+
+            ##
+            # @!attribute [r] organizer
+            #   @return [ConvenientService::Service]
+            #
+            attr_reader :organizer
+
+            ##
+            # @!attribute [r] propagated_result
+            #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result, nil]
+            #
+            attr_reader :propagated_result
+
+            ##
+            # @param object [Object] Can be any type.
+            # @param organizer [ConvenientService::Service]
+            # @param propagated_result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result, nil]
+            # @return [void]
+            #
+            def initialize(object:, organizer:, propagated_result: nil)
+              @object = object
+              @organizer = organizer
+              @propagated_result = propagated_result
+            end
+
+            ##
+            # @return [ConvenientService::Service::Plugins::CanHaveStepAwareEnumerables::Entities::StepAwareEnumerables::Enumerable]
+            # @raise [ConvenientService::Service::Plugins::CanHaveStepAwareEnumerables::Exceptions::ObjectIsNotEnumerable]
+            #
+            def call
+              step_aware_enumerable_klass&.new(**attributes) || ::ConvenientService.raise(Exceptions::ObjectIsNotEnumerable.new(object: object))
+            end
+
+            private
+
+            ##
+            # @return [Class]
+            #
+            def step_aware_enumerable_klass
+              klass = RUBY_CLASS_TO_STEP_AWARE_CLASS_MAP[object.class]
+
+              return klass if klass
+
+              case object
+              when ::Enumerator::Lazy then Entities::StepAwareEnumerables::LazyEnumerator
+              when ::Enumerator::Chain then Entities::StepAwareEnumerables::ChainEnumerator
+              when ::Enumerator then Entities::StepAwareEnumerables::Enumerator
+              when ::Enumerable then Entities::StepAwareEnumerables::Enumerable
+              end
+            end
+
+            ##
+            # @return [Hash]
+            #
+            def attributes
+              {object: object, organizer: organizer, propagated_result: propagated_result}
+            end
+          end
+        end
+      end
+    end
+  end
+end