convenient_service 0.23.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94c8ca0f2034e3f58de99abb35774ad54ec24dd4caa610558d29d6922833f9c6
-  data.tar.gz: 866734bae2fbb20eef12154b20f3bc1048ea07008086bfd7bf9adf32f9bce72e
+  metadata.gz: 9a077e3ef95d8ad18dbc79399c5513f29a17491111557cfad7b446eda2bec5a8
+  data.tar.gz: 07e8481191d8a8fe51b7995d5507147755ee2676cfe51b9c5a5b11e42f5a47e2
 SHA512:
-  metadata.gz: 1531174cc0056a071142a5fd4c4070be7d62acb2db90664320987680729cbc8c938ca2443eb4c605d8bf217f30b29d996e97b6019a7d6c633e6ce08af53c6bf6
-  data.tar.gz: c55b6d8ee0dbd402f48bc96d5d536122e1268bdccd12cdd44961dacf5b70a0ca848921be4a18841b900cb5174b4d2212af17ab6ce5eaaaded3e027e04567fc0a
+  metadata.gz: 268d3a56e8ea1e0161dde099762d3d91dcb8c85b005d2fc45e6ab9e8e622a7da15b4c6d70c45809dd8cd83787cbb042ffe71f4aaef369be4562f18d2b6b22340
+  data.tar.gz: deeb6b2c67a294a98fee2fdb409d653b4674c83c22f9e8ef413014ef42d1dfe8127e3aaecc85d020a206350607f2276e1f09575f5bb9e0888e4927a73697e513

data/lib/convenient_service/dependencies/queries/version.rb

@@ -41,6 +41,24 @@ module ConvenientService
           false
         end
 
+        ##
+        # @return [ConvenientService::Dependencies::Queries::Version]
+        #
+        # @example Beta version is considered as lower than major version.
+        #   ConvenientService::Dependencies::Queries::Version.new("4.0.0.beta1") >= 4
+        #   # => false
+        #
+        # @example That is why there is a way to compare only by the first segment of version.
+        #   ConvenientService::Dependencies::Queries::Version.new("4.0.0.beta1").major_version >= 4
+        #   # => true
+        #
+        # @internal
+        #   TODO: Add direct specs.
+        #
+        def major_version
+          self.class.new(gem_version&.segments&.first.to_s)
+        end
+
         ##
         # @return [Gem::Version, nil]
         #

data/lib/convenient_service/dependencies/queries.rb

@@ -25,10 +25,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?
         ::ENV["CONVENIENT_SERVICE_DEBUG"] == "true"
       end
@@ -499,7 +501,7 @@ module ConvenientService
       # @return [Boolean]
       # @note Expected to be called from `spec_helper.rb`.
       #
-      def require_rspec_extentions
+      def require_rspec_extensions
         require "rspec/expectations"
         require "rspec/matchers"
         require "rspec/mocks"

data/lib/convenient_service/extras/rspec.rb

@@ -12,4 +12,4 @@
 
 require "convenient_service"
 
-ConvenientService::Dependencies.require_rspec_extentions
+ConvenientService::Dependencies.require_rspec_extensions

data/lib/convenient_service/logger.rb

@@ -46,10 +46,10 @@ module ConvenientService
       def new
         super(::STDOUT).tap do |logger|
           logger.level =
-            if ::ENV["CONVENIENT_SERVICE_DEBUG"] == "true"
-              ::Logger::DEBUG
-            elsif ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"]
+            if ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"]
               ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"]
+            elsif ::ENV["CONVENIENT_SERVICE_DEBUG"] == "true"
+              ::Logger::DEBUG
             else
               ::Logger::INFO
             end
@@ -98,6 +98,9 @@ module ConvenientService
     ##
     # @api public
     #
+    # @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
+    #
     # @internal
     #   IMPORTANT: Older versions of `Logger` do NOT support `level` as a string.
     #   - https://github.com/ruby/logger/blob/v1.2.8.1/lib/logger.rb#L333

data/lib/convenient_service/rspec/matchers/classes/results/base/entities/printers/error/commands/generate_got_jsend_attributes_part.rb

@@ -90,7 +90,7 @@ module ConvenientService
                       # @return [String]
                       #
                       def code_part
-                        (code == Service::Plugins::HasJSendResult::Constants::DEFAULT_ERROR_CODE) ? "" : "with code `#{code}`"
+                        (code == Service::Plugins::HasJSendResult.default_error_code) ? "" : "with code `#{code}`"
                       end
 
                       ##

data/lib/convenient_service/rspec/matchers/classes/results/base/entities/printers/failure/commands/generate_got_jsend_attributes_part.rb

@@ -90,7 +90,7 @@ module ConvenientService
                       # @return [String]
                       #
                       def code_part
-                        (code == Service::Plugins::HasJSendResult::Constants::DEFAULT_FAILURE_CODE) ? "" : "with code `#{code}`"
+                        (code == Service::Plugins::HasJSendResult.default_failure_code) ? "" : "with code `#{code}`"
                       end
 
                       ##

data/lib/convenient_service/rspec/matchers/classes/results/base/entities/printers/success/commands/generate_got_jsend_attributes_part.rb

@@ -90,7 +90,7 @@ module ConvenientService
                       # @return [String]
                       #
                       def code_part
-                        (code == Service::Plugins::HasJSendResult::Constants::DEFAULT_SUCCESS_CODE) ? "" : "with code `#{code}`"
+                        (code == Service::Plugins::HasJSendResult.default_success_code) ? "" : "with code `#{code}`"
                       end
 
                       ##

data/lib/convenient_service/rspec/matchers/classes/results/be_error.rb

@@ -17,7 +17,7 @@ module ConvenientService
             # @return [Array<Symbol>]
             #
             def statuses
-              [Service::Plugins::HasJSendResult::Constants::ERROR_STATUS]
+              [Service::Plugins::HasJSendResult.error_status]
             end
           end
         end

data/lib/convenient_service/rspec/matchers/classes/results/be_failure.rb

@@ -17,7 +17,7 @@ module ConvenientService
             # @return [Array<Symbol>]
             #
             def statuses
-              [Service::Plugins::HasJSendResult::Constants::FAILURE_STATUS]
+              [Service::Plugins::HasJSendResult.failure_status]
             end
           end
         end

data/lib/convenient_service/rspec/matchers/classes/results/be_not_error.rb

@@ -18,8 +18,8 @@ module ConvenientService
             #
             def statuses
               [
-                Service::Plugins::HasJSendResult::Constants::SUCCESS_STATUS,
-                Service::Plugins::HasJSendResult::Constants::FAILURE_STATUS
+                Service::Plugins::HasJSendResult.success_status,
+                Service::Plugins::HasJSendResult.failure_status
               ]
             end
           end

data/lib/convenient_service/rspec/matchers/classes/results/be_not_failure.rb

@@ -18,8 +18,8 @@ module ConvenientService
             #
             def statuses
               [
-                Service::Plugins::HasJSendResult::Constants::SUCCESS_STATUS,
-                Service::Plugins::HasJSendResult::Constants::ERROR_STATUS
+                Service::Plugins::HasJSendResult.success_status,
+                Service::Plugins::HasJSendResult.error_status
               ]
             end
           end

data/lib/convenient_service/rspec/matchers/classes/results/be_not_success.rb

@@ -18,8 +18,8 @@ module ConvenientService
             #
             def statuses
               [
-                Service::Plugins::HasJSendResult::Constants::FAILURE_STATUS,
-                Service::Plugins::HasJSendResult::Constants::ERROR_STATUS
+                Service::Plugins::HasJSendResult.failure_status,
+                Service::Plugins::HasJSendResult.error_status
               ]
             end
           end

data/lib/convenient_service/rspec/matchers/classes/results/be_success.rb

@@ -17,7 +17,7 @@ module ConvenientService
             # @return [Array<Symbol>]
             #
             def statuses
-              [Service::Plugins::HasJSendResult::Constants::SUCCESS_STATUS]
+              [Service::Plugins::HasJSendResult.success_status]
             end
           end
         end

data/lib/convenient_service/service/configs/standard.rb

@@ -94,12 +94,14 @@ module ConvenientService
             use ConvenientService::Plugins::Service::CanBeCalled::Concern if options.enabled?(:essential)
             use ConvenientService::Plugins::Common::CanHaveCallbacks::Concern if options.enabled?(:callbacks)
             use ConvenientService::Plugins::Service::CanHaveFallbacks::Concern if options.enabled?(:fallbacks)
+            use ConvenientService::Plugins::Service::CanHaveInlineServices::Concern if options.enabled?(:essential)
             use ConvenientService::Plugins::Service::HasInspect::Concern if options.enabled?(:inspect)
             use ConvenientService::Plugins::Service::HasAwesomePrintInspect::Concern if options.enabled?(:awesome_print_inspect)
             use ConvenientService::Plugins::Service::HasAmazingPrintInspect::Concern if options.enabled?(:amazing_print_inspect)
             use ConvenientService::Plugins::Common::CachesConstructorArguments::Concern if options.enabled?(:recalculation)
             use ConvenientService::Plugins::Common::CanBeCopied::Concern if options.enabled?(:recalculation)
             use ConvenientService::Plugins::Service::CanHaveRecalculations::Concern if options.enabled?(:recalculation)
+            use ConvenientService::Plugins::Service::CanHaveHandledExceptions::Concern if options.enabled?(:essential)
             use ConvenientService::Plugins::Service::CanNotBeInherited::Concern if options.enabled?(:code_review_automation)
             use ConvenientService::Plugins::Service::HasJSendResultShortSyntax::Concern if options.enabled?(:short_syntax)
             use ConvenientService::Plugins::Service::HasJSendResultStatusCheckShortSyntax::Concern if options.enabled?(:short_syntax)
@@ -224,7 +226,9 @@ module ConvenientService
               use ConvenientService::Plugins::Result::HasPatternMatchingSupport::Concern if options.enabled?(:essential)
               use ConvenientService::Plugins::Result::CanBeFromFallback::Concern if options.enabled?(:fallbacks)
               use ConvenientService::Plugins::Result::CanHaveFallbacks::Concern if options.enabled?(:fallbacks)
-              use ConvenientService::Plugins::Result::CanBeFromException::Concern if options.enabled?(:fault_tolerance)
+              use ConvenientService::Plugins::Result::CanBeFromException::Concern if options.enabled?(:essential)
+              use ConvenientService::Plugins::Result::CanBeFromHandledException::Concern if options.enabled?(:essential)
+              use ConvenientService::Plugins::Result::CanBeFromUnhandledException::Concern if options.enabled?(:fault_tolerance)
               use ConvenientService::Plugins::Result::HasInspect::Concern if options.enabled?(:inspect)
               use ConvenientService::Plugins::Result::HasAwesomePrintInspect::Concern if options.enabled?(:awesome_print_inspect)
               use ConvenientService::Plugins::Result::HasAmazingPrintInspect::Concern if options.enabled?(:amazing_print_inspect)
@@ -335,7 +339,7 @@ module ConvenientService
             concerns do
               use ConvenientService::Plugins::Common::HasInternals::Concern if options.enabled?(:essential)
               use ConvenientService::Plugins::Step::HasResult::Concern if options.enabled?(:essential)
-              use ConvenientService::Plugins::Step::CanBeCompleted::Concern if options.enabled?(:essential)
+              use ConvenientService::Plugins::Step::CanBeEvaluated::Concern if options.enabled?(:essential)
               use ConvenientService::Plugins::Step::CanBeServiceStep::Concern if options.enabled?(:essential)
               use ConvenientService::Plugins::Step::CanBeMethodStep::Concern if options.enabled?(:essential)
               use ConvenientService::Plugins::Step::CanBeUsedInServiceAwareEnumerables::Concern if options.enabled?(:essential)
@@ -349,7 +353,6 @@ module ConvenientService
 
             middlewares :result do
               use ConvenientService::Plugins::Common::CachesReturnValue::Middleware if options.enabled?(:per_instance_caching)
-              use ConvenientService::Plugins::Common::CanHaveCallbacks::Middleware if options.enabled?(:callbacks)
               use ConvenientService::Plugins::Step::HasResult::Middleware if options.enabled?(:essential)
               use ConvenientService::Plugins::Step::CanHaveParentResult::Middleware if options.enabled?(:result_parents_trace)
               use ConvenientService::Plugins::Step::CanHaveFallbacks::Middleware.with(fallback_true_status: :failure) if options.enabled?(:fallbacks)
@@ -366,6 +369,11 @@ module ConvenientService
               use ConvenientService::Plugins::Common::CachesReturnValue::Middleware if options.enabled?(:per_instance_caching)
             end
 
+            middlewares :organizer_result do
+              use ConvenientService::Plugins::Common::CachesReturnValue::Middleware if options.enabled?(:per_instance_caching)
+              use ConvenientService::Plugins::Common::CanHaveCallbacks::Middleware if options.enabled?(:callbacks)
+            end
+
             entity :Internals do
               concerns do
                 use ConvenientService::Plugins::Internals::HasCache::Concern if options.enabled?(:per_instance_caching)

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

@@ -65,11 +65,15 @@ module ConvenientService
           #     end
           #   end
           #
+          # @internal
+          #   IMPORTANT: `result.step.result` does NOT take result from internal cache, it raises instead. That is frustrating to the end-users, but there is NO workaroud yet.
+          #   TODO: Think about passing `result` with `callback_arguments`. Not perfect, but better than nothing.
+          #
           def next(method, **kwargs, &block)
             return chain.next(method, **kwargs, &block) if method != :step
 
             entity.step_class.class_exec(kwargs, block) do |kwargs, block|
-              after :result, **kwargs.merge(source_location: block.source_location) do |result|
+              after :organizer_result, **kwargs.merge(source_location: block.source_location) do |result|
                 organizer.instance_exec(
                   result.step,
                   params.to_callback_arguments,

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

@@ -73,7 +73,7 @@ module ConvenientService
             return chain.next(method, **kwargs, &block) if method != :step
 
             entity.step_class.class_exec(kwargs, block) do |kwargs, block|
-              around :result, **kwargs.merge(source_location: block.source_location) do |chain|
+              around :organizer_result, **kwargs.merge(source_location: block.source_location) do |chain|
                 organizer.instance_exec(
                   proc { chain.yield.step },
                   params.to_callback_arguments,

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

@@ -69,7 +69,7 @@ module ConvenientService
             return chain.next(method, **kwargs, &block) if method != :step
 
             entity.step_class.class_exec(kwargs, block) do |kwargs, block|
-              before :result, **kwargs.merge(source_location: block.source_location) do
+              before :organizer_result, **kwargs.merge(source_location: block.source_location) do
                 organizer.instance_exec(
                   params.to_callback_arguments,
                   &block

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

@@ -23,6 +23,7 @@ module ConvenientService
             # @return [ConvenientService::Service::Plugins::CanHaveConnectedSteps::Entities::Expressions::Base]
             #
             # @note It is NOT recommended to rely on the return value of this method, since it may differ across different `step` related plugins.
+            # @see https://userdocs.convenientservice.org/comprehensive_docs/docs/the_what/what_step_input_types_are_available.html
             #
             def step(*args, **kwargs)
               previous_expression = steps.expression
@@ -717,12 +718,6 @@ module ConvenientService
             def steps_result
               ::ConvenientService.raise Exceptions::ServiceHasNoSteps.new(service_class: self.class) if steps.none?
 
-              steps.each_evaluated_step do |step|
-                step.save_outputs_in_organizer!
-
-                step.mark_as_evaluated!
-              end
-
               steps.result
             end
 

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

@@ -37,7 +37,7 @@ module ConvenientService
               # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
               #
               def result
-                step.result
+                step.organizer_result
               end
 
               ##

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/commands/format_backtrace.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Commands
           class FormatBacktrace < Support::Command
             ##

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/commands/format_cause.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Commands
           class FormatCause < Support::Command
             ##

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/commands/format_class.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Commands
           class FormatClass < Support::Command
             ##

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/commands/format_exception.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Commands
           class FormatException < Support::Command
             ##
@@ -49,7 +49,7 @@ module ConvenientService
             # @param max_backtrace_size [Integer]
             # @return [void]
             #
-            def initialize(exception:, args:, kwargs:, block:, max_backtrace_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE)
+            def initialize(exception:, args: [], kwargs: {}, block: nil, max_backtrace_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE)
               @exception = exception
               @args = args
               @kwargs = kwargs

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/commands/format_line.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Commands
           class FormatLine < Support::Command
             ##

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/commands/format_message.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Commands
           class FormatMessage < Support::Command
             ##

data/lib/convenient_service/service/plugins/{rescues_result_unhandled_exceptions → can_have_formatted_exceptions}/constants.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module RescuesResultUnhandledExceptions
+      module CanHaveFormattedExceptions
         module Constants
           ##
           # @return [Integer]

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

@@ -0,0 +1,35 @@
+# 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_formatted_exceptions/commands"
+require_relative "can_have_formatted_exceptions/constants"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveFormattedExceptions
+        class << self
+          ##
+          # @return [Integer]
+          #
+          def default_max_backtrace_size
+            Constants::DEFAULT_MAX_BACKTRACE_SIZE
+          end
+
+          ##
+          # @param exception [StandardError]
+          # @param kwargs [Hash{Symbol => Object}]
+          # @return [String]
+          #
+          def format_exception(exception, **kwargs)
+            Commands::FormatException.call(exception: exception, **kwargs)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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 CanHaveHandledExceptions
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @api public
+            # @param max_backtrace_size [Integer]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+            #
+            def error_from_exception(exception, max_backtrace_size: Plugins::CanHaveFormattedExceptions.default_max_backtrace_size)
+              error(
+                data: {handled_exception: exception},
+                message: Plugins::CanHaveFormattedExceptions.format_exception(exception, max_backtrace_size: max_backtrace_size),
+                code: :handled_exception
+              )
+                .copy(overrides: {kwargs: {exceptions: {handled: exception}}})
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_handled_exceptions.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_handled_exceptions/concern"

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

@@ -0,0 +1,29 @@
+# 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 Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @api private
+            # @param block [Proc, nil]
+            # @return [ConvenientService::Service::Plugins::CanHaveInlineServices::Entities::Proxy]
+            #
+            def inline(&block)
+              Entities::Proxy.new(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end