convenient_service 0.23.0 → 0.25.0

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/rescues_result_unhandled_exceptions/middleware.rb

@@ -81,7 +81,7 @@ module ConvenientService
               message: format_exception(exception, *args, **kwargs, &block),
               code: :unhandled_exception
             )
-              .copy(overrides: {kwargs: {unhandled_exception: exception}})
+              .copy(overrides: {kwargs: {exceptions: {unhandled: exception}}})
           end
 
           ##
@@ -92,14 +92,14 @@ module ConvenientService
           # @return [String]
           #
           def format_exception(exception, *args, **kwargs, &block)
-            Commands::FormatException.call(exception: exception, args: args, kwargs: kwargs, block: block, max_backtrace_size: max_backtrace_size)
+            Plugins::CanHaveFormattedExceptions.format_exception(exception, args: args, kwargs: kwargs, block: block, max_backtrace_size: max_backtrace_size)
           end
 
           ##
           # @return [Integer]
           #
           def max_backtrace_size
-            middleware_arguments.kwargs.fetch(:max_backtrace_size) { Constants::DEFAULT_MAX_BACKTRACE_SIZE }
+            middleware_arguments.kwargs.fetch(:max_backtrace_size) { Plugins::CanHaveFormattedExceptions.default_max_backtrace_size }
           end
 
           ##

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

@@ -5,6 +5,4 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
-require_relative "rescues_result_unhandled_exceptions/commands"
-require_relative "rescues_result_unhandled_exceptions/constants"
 require_relative "rescues_result_unhandled_exceptions/middleware"

data/lib/convenient_service/service/plugins.rb

@@ -27,9 +27,12 @@ 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"
+require_relative "plugins/can_have_handled_exceptions"
+require_relative "plugins/can_have_formatted_exceptions"
 require_relative "plugins/collects_services_in_exception"
 require_relative "plugins/forbids_convenient_service_entities_as_constructor_arguments"
 require_relative "plugins/has_inspect"

data/lib/convenient_service/version.rb

@@ -13,5 +13,5 @@ module ConvenientService
   # @since 1.0.0
   # @return [String]
   #
-  VERSION = "0.23.0"
+  VERSION = "0.25.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.23.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Marian Kostyk
@@ -425,6 +425,22 @@ files:
 - lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb
 - lib/convenient_service/service/plugins/can_have_fallbacks/exceptions.rb
 - lib/convenient_service/service/plugins/can_have_fallbacks/middleware.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands/format_backtrace.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands/format_cause.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands/format_class.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands/format_exception.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands/format_line.rb
+- lib/convenient_service/service/plugins/can_have_formatted_exceptions/commands/format_message.rb
+- 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
@@ -507,8 +523,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
@@ -594,6 +610,11 @@ files:
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_exception/concern.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_fallback.rb
 - 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
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_own_result/concern.rb
 - lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_strict.rb
@@ -731,14 +752,6 @@ files:
 - lib/convenient_service/service/plugins/raises_on_not_result_return_value/exceptions.rb
 - lib/convenient_service/service/plugins/raises_on_not_result_return_value/middleware.rb
 - lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_backtrace.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_cause.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_class.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_line.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_message.rb
-- lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/constants.rb
 - lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/middleware.rb
 - lib/convenient_service/service/plugins/sets_parent_to_foreign_result.rb
 - lib/convenient_service/service/plugins/sets_parent_to_foreign_result/middleware.rb