convenient_service 0.24.0 → 0.26.0

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

@@ -0,0 +1,30 @@
+# 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 CanHaveInlineServices
+        module Exceptions
+          class InlineServiceIsAlreadyDefined < ::ConvenientService::Exception
+            ##
+            # @param object [Object] Can be any type.
+            # @return [void]
+            #
+            def initialize_with_kwargs(object:)
+              message = <<~TEXT
+                Definition of already defined inline service can NOT be modified.
+              TEXT
+
+              initialize(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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_inline_services/concern"
+require_relative "can_have_inline_services/entities"
+require_relative "can_have_inline_services/exceptions"
+
+# 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 CanHaveInlineServices
+        class << self
+          ##
+          # @api private
+          # @param block [Proc, nil]
+          # @return [ConvenientService::Service::Plugins::CanHaveInlineServices::Entities::Proxy]
+          #
+          def proxy(&block)
+            Entities::Proxy.new(&block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,6 +22,8 @@ module ConvenientService
             # @param kwargs [Hash{Symbol => Object}]
             # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
             #
+            # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/best_practices/declare_in_out_explicitly_on_method_steps.html
+            #
             def step(*args, **kwargs)
               steps.create(*args, **kwargs)
             end

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

@@ -52,11 +52,7 @@ module ConvenientService
           #   Do NOT spend too much time on that again, you have a lot of other tasks to do.
           #
           def find_first_not_successful_step_with_side_effects_during_lookup
-            entity.steps.find do |step|
-              step.status.unsafe_not_success?
-                .tap { step.save_outputs_in_organizer! }
-                .tap { step.mark_as_evaluated! }
-            end
+            entity.steps.find { |step| step.organizer_result.status.unsafe_not_success? }
           end
 
           ##

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

@@ -24,13 +24,8 @@ module ConvenientService
             ##
             # @api public
             #
-            # Allows to pass a value to `in` method without its intermediate processing.
             # @see https://userdocs.convenientservice.org/basics/step_to_result_translation_table
-            #
-            # @example `:chat_v2` is passed to `AssertFeatureEnabled` as it is.
-            #   step AssertFeatureEnabled, in: {name: raw(:chat_v2)}
-            #   # that is converted to the following service invocation:
-            #   AssertFeatureEnabled.result(name: :chat_v2)
+            # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_what/what_is_a_step_raw_input.html
             #
             # @param value [Object] Can be any type.
             # @return [ConvenientService::Support::RawValue]

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/commands/cast_method_factory.rb

@@ -27,7 +27,7 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factries::Base, nil]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factories::Base, nil]
                 #
                 def call
                   return unless factory_class
@@ -59,28 +59,25 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factries::Base, nil]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factories::Base, nil]
                 #
                 def cast_symbol
                   Entities::Factories::Symbol
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factries::Base, nil]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factories::Base, nil]
                 #
                 def cast_string
                   Entities::Factories::String
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factries::Base, nil]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factories::Base, nil]
                 #
                 def cast_hash
                   return unless other.keys.one?
 
-                  ##
-                  # TODO: Add `other.keys.first.is_a?(Integer)` and `other.keys.first == Support::BLOCK` to support args and block via `step`?
-                  #
                   value = other.values.first
 
                   case value
@@ -96,7 +93,7 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factries::Base, nil]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factories::Base, nil]
                 #
                 def cast_method
                   Entities::Factories::Method

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/proc.rb

@@ -26,7 +26,7 @@ module ConvenientService
                   end
 
                   def define_output_in_container!(container, index:, method:)
-                    false
+                    Commands::DefineMethodInContainer.call(method: method, container: container, index: index)
                   end
 
                   private

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/raw.rb

@@ -26,7 +26,7 @@ module ConvenientService
                   end
 
                   def define_output_in_container!(container, index:, method:)
-                    false
+                    Commands::DefineMethodInContainer.call(method: method, container: container, index: index)
                   end
 
                   private

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/string.rb

@@ -18,7 +18,7 @@ module ConvenientService
                   # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
                   #
                   def create_key
-                    Entities::Key.new(other)
+                    Entities::Key.new(other.to_sym)
                   end
 
                   ##

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/key.rb

@@ -25,7 +25,7 @@ module ConvenientService
                 ##
                 # @return [String]
                 #
-                delegate :to_s, :to_sym, to: :value
+                delegate :to_s, to: :value
 
                 ##
                 # @return [Symbol]

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/concern/instance_methods.rb

@@ -174,6 +174,19 @@ module ConvenientService
                   @organizer
                 end
 
+                ##
+                # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                #
+                def organizer_result
+                  original_result = result
+
+                  save_outputs_in_organizer!
+
+                  mark_as_evaluated!
+
+                  original_result
+                end
+
                 ##
                 # @api public
                 #

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/{can_be_completed → can_be_evaluated}/concern.rb

@@ -12,7 +12,7 @@ module ConvenientService
         module Entities
           class Step
             module Plugins
-              module CanBeCompleted
+              module CanBeEvaluated
                 module Concern
                   include Support::Concern
 

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_evaluated.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_be_evaluated/concern"

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins.rb

@@ -7,7 +7,7 @@
 
 require_relative "plugins/has_result"
 
-require_relative "plugins/can_be_completed"
+require_relative "plugins/can_be_evaluated"
 require_relative "plugins/can_be_service_step"
 require_relative "plugins/can_be_method_step"
 require_relative "plugins/can_be_used_in_service_aware_enumerables"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_handled_exception/concern.rb

@@ -36,19 +36,44 @@ module ConvenientService
                     end
 
                     ##
-                    # TODO: error.from_exception(exception)
-                    # TODO: error.from_exception(exception, max_backtrace_size: 5)
-                    # TODO: error("custom_message").from_exception(exception)
-                    # TODO: error(code: :custom_code).from_exception(exception)
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::CanBeFromHandledException::Exceptions::FromExceptionOnNotErrorResult]
                     #
-                    # @internal
-                    #   If `error` message is default, use `from_exception` message.
-                    #   If `error` code is default, use `from_exception` code.
-                    #
-                    # def from_exception(exception, **kwargs)
-                    #   # ...
-                    # end
-                    ##
+                    def from_exception(exception, **kwargs)
+                      ::ConvenientService.raise Exceptions::FromExceptionOnNotErrorResult.new(result: self) unless status.unsafe_error?
+
+                      data =
+                        if Service::Plugins::HasJSendResult.default_error_data == unsafe_data.to_h
+                          {handled_exception: exception}
+                        else
+                          unsafe_data
+                        end
+
+                      message =
+                        if Service::Plugins::HasJSendResult.default_error_message == unsafe_message.to_s
+                          Service::Plugins::CanHaveFormattedExceptions.format_exception(exception, **kwargs)
+                        else
+                          unsafe_message
+                        end
+
+                      code =
+                        if Service::Plugins::HasJSendResult.default_error_code == unsafe_code.to_sym
+                          :handled_exception
+                        else
+                          unsafe_code
+                        end
+
+                      copy(
+                        overrides: {
+                          kwargs: {
+                            data: data,
+                            message: message,
+                            code: code,
+                            exceptions: {handled: exception}
+                          }
+                        }
+                      )
+                    end
                   end
                 end
               end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_handled_exception/exceptions.rb

@@ -0,0 +1,38 @@
+# 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 HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module CanBeFromHandledException
+                module Exceptions
+                  class FromExceptionOnNotErrorResult < ::ConvenientService::Exception
+                    ##
+                    # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    # @return [void]
+                    #
+                    def initialize_with_kwargs(result:)
+                      message = <<~TEXT
+                        `#{result.status}(...).from_exception(exception, ...)` is NOT allowed. Only `error` results can be from exceptions.
+                      TEXT
+
+                      initialize(message)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_handled_exception.rb

@@ -6,3 +6,4 @@
 ##
 
 require_relative "can_be_from_handled_exception/concern"
+require_relative "can_be_from_handled_exception/exceptions"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/concern/instance_methods.rb

@@ -103,6 +103,13 @@ module ConvenientService
                       internals.cache[:jsend_attributes]
                     end
 
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    def result
+                      self
+                    end
+
                     ##
                     # @param status [Symbol]
                     # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]

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

@@ -14,6 +14,90 @@ module ConvenientService
     module Plugins
       module HasJSendResult
         class << self
+          ##
+          # @return [Symbol]
+          #
+          def success_status
+            Constants::SUCCESS_STATUS
+          end
+
+          ##
+          # @return [Symbol]
+          #
+          def failure_status
+            Constants::FAILURE_STATUS
+          end
+
+          ##
+          # @return [Symbol]
+          #
+          def error_status
+            Constants::ERROR_STATUS
+          end
+
+          ##
+          # @return [Hash{Symbol => Object}]
+          #
+          def default_success_data
+            Constants::DEFAULT_SUCCESS_DATA
+          end
+
+          ##
+          # @return [Hash{Symbol => Object}]
+          #
+          def default_failure_data
+            Constants::DEFAULT_FAILURE_DATA
+          end
+
+          ##
+          # @return [Hash{Symbol => Object}]
+          #
+          def default_error_data
+            Constants::DEFAULT_ERROR_DATA
+          end
+
+          ##
+          # @return [String]
+          #
+          def default_success_message
+            Constants::DEFAULT_SUCCESS_MESSAGE
+          end
+
+          ##
+          # @return [String]
+          #
+          def default_failure_message
+            Constants::DEFAULT_FAILURE_MESSAGE
+          end
+
+          ##
+          # @return [String]
+          #
+          def default_error_message
+            Constants::DEFAULT_ERROR_MESSAGE
+          end
+
+          ##
+          # @return [Symbol]
+          #
+          def default_success_code
+            Constants::DEFAULT_SUCCESS_CODE
+          end
+
+          ##
+          # @return [Symbol]
+          #
+          def default_failure_code
+            Constants::DEFAULT_FAILURE_CODE
+          end
+
+          ##
+          # @return [Symbol]
+          #
+          def default_error_code
+            Constants::DEFAULT_ERROR_CODE
+          end
+
           ##
           # Checks whether an object is a result class.
           #

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

@@ -12,12 +12,16 @@ module ConvenientService
         class Middleware < MethodChainMiddleware
           intended_for any_method, entity: :service
 
+          ##
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+          # @raise [ConvenientService::Service::Plugins::RaisesOnNotResultReturnValue::Exceptions::ReturnValueNotKindOfResult]
+          #
           def next(...)
-            original_result = chain.next(...)
+            result = chain.next(...)
 
-            return original_result if Service::Plugins::HasJSendResult.result?(original_result)
+            return result if Service::Plugins::HasJSendResult.result?(result)
 
-            ::ConvenientService.raise Exceptions::ReturnValueNotKindOfResult.new(service: entity, result: original_result, method: method)
+            ::ConvenientService.raise Exceptions::ReturnValueNotKindOfResult.new(service: entity, result: result, method: method)
           end
         end
       end

data/lib/convenient_service/service/plugins.rb

@@ -27,6 +27,7 @@ require_relative "plugins/can_have_around_step_callbacks"
 require_relative "plugins/can_have_before_step_callbacks"
 require_relative "plugins/can_have_fallbacks"
 require_relative "plugins/can_have_rollbacks"
+require_relative "plugins/can_have_inline_services"
 require_relative "plugins/can_have_stubbed_results"
 require_relative "plugins/can_not_be_inherited"
 require_relative "plugins/can_have_recalculations"

data/lib/convenient_service/version.rb

@@ -13,5 +13,5 @@ module ConvenientService
   # @since 1.0.0
   # @return [String]
   #
-  VERSION = "0.24.0"
+  VERSION = "0.26.0"
 end

data/lib/convenient_service.rb

@@ -209,10 +209,12 @@ module ConvenientService
     ##
     # Returns `true` when Convenient Service is in debug mode. In other words `$CONVENIENT_SERVICE_DEBUG` env variable is set to `true`.
     #
-    # @api private
+    # @api public
     # @since 1.0.0
     # @return [Boolean]
     #
+    # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_how/how_to_debug_the_convenient_service_lib_itself.html
+    #
     def debug?
       Dependencies.debug?
     end
@@ -249,6 +251,9 @@ module ConvenientService
     #
     # @see https://github.com/ruby/logger
     # @see https://ruby-doc.org/stdlib-2.7.0/libdoc/logger/rdoc/Logger.html
+    # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_how/how_to_debug_the_convenient_service_lib_itself.html
+    # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_what/what_is_convenient_service_logger.html
+    # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_how/how_to_configure_convenient_service_logger.html
     #
     # @example Set log level.
     #   ConvenientService.logger.level = Logger::DEBUG
@@ -267,6 +272,7 @@ module ConvenientService
     #
     # @see https://ruby-doc.org/core-2.7.1/Kernel.html#method-i-__dir__
     # @see https://api.rubyonrails.org/classes/Rails.html#method-c-root
+    # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_how/how_to_get_convenient_service_root_folder.html
     #
     def root
       @root ||= ::Pathname.new(::File.expand_path(::File.join(__dir__, "..")))
@@ -280,6 +286,9 @@ module ConvenientService
     # @since 1.0.0
     # @return [Pathname]
     #
+    # @internal
+    #   TODO: Consider to make public for plugin devs.
+    #
     def lib_root
       @lib_root ||= ::Pathname.new(::File.join(root, "lib"))
     end
@@ -292,6 +301,9 @@ module ConvenientService
     # @since 1.0.0
     # @return [Pathname]
     #
+    # @internal
+    #   TODO: Consider to make public for plugin devs.
+    #
     def examples_root
       @examples_root ||= ::Pathname.new(::File.join(root, "lib", "convenient_service", "examples"))
     end
@@ -343,6 +355,16 @@ module ConvenientService
       @backtrace_cleaner ||= Support::BacktraceCleaner.new
     end
 
+    ##
+    # @api public
+    # @since 1.0.0
+    # @param block [Proc, nil]
+    # @return [ConvenientService::Service::Plugins::CanHaveInlineServices::Entities::Proxy]
+    #
+    def inline(&block)
+      Service::Plugins::CanHaveInlineServices.proxy(&block)
+    end
+
     ##
     # Raises Convenient Service exceptions.
     # Cleans exception backtrace with `ConvenientService.backtrace_cleaner.clean` before delegating to `Kernel.raise`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Marian Kostyk
@@ -108,6 +108,8 @@ files:
 - lib/convenient_service/common/plugins/has_j_send_result_duck_short_syntax/concern.rb
 - lib/convenient_service/common/plugins/has_memoization/using_memo_wise.rb
 - lib/convenient_service/common/plugins/has_memoization/using_memo_wise/concern.rb
+- lib/convenient_service/common/plugins/tries_to_convert_result_duck_to_result.rb
+- lib/convenient_service/common/plugins/tries_to_convert_result_duck_to_result/middleware.rb
 - lib/convenient_service/config.rb
 - lib/convenient_service/config/commands.rb
 - lib/convenient_service/config/commands/normalize_options.rb
@@ -436,6 +438,11 @@ files:
 - lib/convenient_service/service/plugins/can_have_formatted_exceptions/constants.rb
 - lib/convenient_service/service/plugins/can_have_handled_exceptions.rb
 - lib/convenient_service/service/plugins/can_have_handled_exceptions/concern.rb
+- lib/convenient_service/service/plugins/can_have_inline_services.rb
+- lib/convenient_service/service/plugins/can_have_inline_services/concern.rb
+- lib/convenient_service/service/plugins/can_have_inline_services/entities.rb
+- lib/convenient_service/service/plugins/can_have_inline_services/entities/proxy.rb
+- lib/convenient_service/service/plugins/can_have_inline_services/exceptions.rb
 - lib/convenient_service/service/plugins/can_have_recalculations.rb
 - lib/convenient_service/service/plugins/can_have_recalculations/concern.rb
 - lib/convenient_service/service/plugins/can_have_rollbacks.rb
@@ -518,8 +525,8 @@ files:
 - lib/convenient_service/service/plugins/can_have_steps/entities/step/exceptions.rb
 - lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins.rb
 - lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/aliases.rb
-- lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_completed.rb
-- lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_completed/concern.rb
+- lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_evaluated.rb
+- lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_evaluated/concern.rb
 - lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_method_step.rb
 - lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_method_step/commands.rb
 - lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_method_step/commands/calculate_method_result.rb
@@ -607,6 +614,7 @@ files:
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_fallback/concern.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_handled_exception.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_handled_exception/concern.rb
+- lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_handled_exception/exceptions.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_unhandled_exception.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_unhandled_exception/concern.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_own_result.rb
@@ -906,7 +914,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby Service Objects with Steps and more.
 test_files: []