RubyGems - convenient_service - Versions diffs - 0.11.0 → 0.13.0 - Mend

convenient_service 0.11.0 → 0.13.0

Files changed (713) hide show

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/template.rb ADDED Viewed

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+module ConvenientService
+  module Service
+    module Plugins
+      module HasMermaidFlowchart
+        module Entities
+          class Flowchart
+            module Entities
+              class Template
+                ##
+                # @api private
+                #
+                # @return [String]
+                #
+                def relative_path
+                  @relative_path ||= ::File.join("..", "templates", "flowchart.html.erb")
+                end
+                ##
+                # @api private
+                #
+                # @return [String]
+                #
+                # @internal
+                #   NOTE: `expand_path` docs.
+                #   - https://ruby-doc.org/core-2.7.0/File.html#method-c-expand_path
+                #
+                def absolute_path
+                  @absolute_path ||= ::File.expand_path(relative_path, __dir__)
+                end
+                ##
+                # @api private
+                #
+                # @return [ERB]
+                #
+                def erb
+                  @erb ||= ::ERB.new(content)
+                end
+                ##
+                # @api private
+                #
+                # @return [String]
+                #
+                def content
+                  @content ||= ::File.read(absolute_path)
+                end
+                ##
+                # @api private
+                #
+                # @param replacements [Hash{Symbol => Object}]
+                # @return [String]
+                #
+                # @see ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart#replacements
+                #
+                # @internal
+                #   NOTE: Prefer `result_with_hash`.
+                #   - https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB.html#method-i-result_with_hash
+                #
+                def render(**replacements)
+                  erb.result_with_hash(replacements)
+                end
+                ##
+                # @api private
+                #
+                # @param other [Object]
+                # @return [Boolean, nil]
+                #
+                def ==(other)
+                  return unless other.instance_of?(self.class)
+                  true
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require_relative "entities/code"
+require_relative "entities/settings"
+require_relative "entities/template"

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/templates/flowchart.html.erb ADDED Viewed

@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <!-- https://www.w3schools.com/css/css_rwd_viewport.asp -->
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <style>
+      /**
+       * https://www.w3schools.com/howto/howto_css_loader.asp
+       * https://www.w3schools.com/howto/tryit.asp?filename=tryhow_css_loader
+       */
+      #loader {
+        border: 16px solid #f3f3f3;
+        border-radius: 50%;
+        border-top: 16px solid #3498db;
+        width: 120px;
+        height: 120px;
+        -webkit-animation: spin 2s linear infinite; /* Safari */
+        animation: spin 2s linear infinite;
+      }
+      /* Safari */
+      @-webkit-keyframes spin {
+        0% { -webkit-transform: rotate(0deg); }
+        100% { -webkit-transform: rotate(360deg); }
+      }
+      @keyframes spin {
+        0% { transform: rotate(0deg); }
+        100% { transform: rotate(360deg); }
+      }
+      /**
+       * https://github.com/anvaka/panzoom
+       */
+      #diagram {
+        height: 100%;
+        width: 100%;
+        /*
+         * https://www.w3schools.com/howto/howto_js_toggle_hide_show.asp
+         */
+        display: none;
+      }
+    </style>
+  </head>
+  <body>
+    <!-- https://www.w3schools.com/howto/howto_css_loader.asp -->
+    <!-- https://www.w3schools.com/howto/tryit.asp?filename=tryhow_css_loader -->
+    <div id="loader"></div>
+    <!-- https://mermaid-js.github.io/mermaid/#/sequenceDiagram?id=sequence-diagrams -->
+    <div id="diagram" class="mermaid">
+      <%= code %>
+    </div>
+    <script type="module">
+      /**
+       * https://docs.skypack.dev/
+       */
+      import mermaid from 'https://cdn.skypack.dev/mermaid@^8.14.0';
+      import panzoom from 'https://cdn.skypack.dev/panzoom@^9.4.3';
+      /**
+       * https://mermaid-js.github.io/mermaid/#/
+       */
+      mermaid.initialize({ startOnLoad: true });
+      /**
+       * https://github.com/anvaka/panzoom
+       */
+      const elementWithDiagram = document.getElementById('diagram');
+      panzoom(elementWithDiagram);
+      /**
+       * https://www.w3schools.com/howto/howto_css_loader.asp
+       * https://www.w3schools.com/howto/tryit.asp?filename=tryhow_css_loader
+       */
+      const loader = document.getElementById('loader');
+      /*
+       * https://developer.mozilla.org/en-US/docs/Web/API/Element/remove
+       */
+      loader.remove();
+      /*
+       * https://www.w3schools.com/howto/howto_js_toggle_hide_show.asp
+       */
+      elementWithDiagram.style.display = 'block';
+    </script>
+  </body>
+</html>

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart.rb ADDED Viewed

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+require_relative "flowchart/entities"
+module ConvenientService
+  module Service
+    module Plugins
+      module HasMermaidFlowchart
+        module Entities
+          class Flowchart
+            ##
+            # @api private
+            #
+            # @!attribute service [r]
+            #   @return [ConvenientService::Service]
+            #
+            attr_reader :service
+            ##
+            # @api private
+            #
+            # @param service [ConvenientService::Service]
+            # @return [void]
+            #
+            def initialize(service:)
+              @service = service
+            end
+            ##
+            # @api private
+            #
+            # @return [String]
+            #
+            def content
+              template.render(**replacements)
+            end
+            ##
+            # @api private
+            #
+            # @return [Hash{Symbol => Object}]
+            #
+            def replacements
+              {
+                title: settings.title,
+                code: code.generate
+              }
+            end
+            ##
+            # @api private
+            #
+            # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Code]
+            #
+            def code
+              @code ||= Entities::Code.new(flowchart: self)
+            end
+            ##
+            # @api public
+            #
+            # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Settings]
+            #
+            def settings
+              @settings ||= Entities::Settings.new(flowchart: self)
+            end
+            ##
+            # @api private
+            #
+            # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Template]
+            #
+            def template
+              @template ||= Entities::Template.new
+            end
+            ##
+            # @api public
+            #
+            # @return [Boolean]
+            #
+            # @internal
+            #   TODO: Specs for logger.
+            #
+            def save
+              ::File.write(settings.absolute_path, content)
+                .tap { ConvenientService.logger.info { "[HasMermaidFlowchart] Flowchart is saved into `#{settings.absolute_path}` " } }
+            end
+            ##
+            # @api private
+            #
+            # @param other [Object]
+            # @return [Boolean, nil]
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+              return false if service != other.service
+              true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities.rb ADDED Viewed

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require_relative "entities/flowchart"

data/lib/convenient_service/service/plugins/has_mermaid_flowchart.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require_relative "has_mermaid_flowchart/concern"
+require_relative "has_mermaid_flowchart/entities"

data/lib/convenient_service/service/plugins/has_result/concern.rb CHANGED Viewed

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
-require_relative "concern/instance_methods"
-require_relative "concern/class_methods"
 module ConvenientService
   module Service
     module Plugins
@@ -10,10 +7,24 @@ module ConvenientService
         module Concern
           include Support::Concern
-          included do |service_class|
-            service_class.include InstanceMethods
+          class_methods do
+            ##
+            # @api public
+            # @raise [ConvenientService::Service::Plugins::HasResult::Exceptions::ResultIsNotOverridden]
+            #
+            def result(...)
+              new(...).result
+            end
+          end
-            service_class.extend ClassMethods
+          instance_methods do
+            ##
+            # @api public
+            # @raise [ConvenientService::Service::Plugins::HasResult::Exceptions::ResultIsNotOverridden]
+            #
+            def result
+              raise Exceptions::ResultIsNotOverridden.new(service: self)
+            end
           end
         end
       end

data/lib/convenient_service/service/plugins/has_result/exceptions.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Exceptions
+          class ResultIsNotOverridden < ::ConvenientService::Exception
+            def initialize(service:)
+              message = <<~TEXT
+                Result method (#result) of `#{service.class}` is NOT overridden.
+              TEXT
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result.rb CHANGED Viewed

@@ -1,8 +1,4 @@
 # frozen_string_literal: true
 require_relative "has_result/concern"
-require_relative "has_result/constants"
-require_relative "has_result/commands"
-require_relative "has_result/entities"
-require_relative "has_result/errors"
-require_relative "has_result/middleware"
+require_relative "has_result/exceptions"

data/lib/convenient_service/service/plugins/raises_on_double_result/{errors.rb → exceptions.rb} RENAMED Viewed

@@ -4,8 +4,8 @@ module ConvenientService
   module Service
     module Plugins
       module RaisesOnDoubleResult
-        module Errors
-          class DoubleResult < ConvenientService::Error
+        module Exceptions
+          class DoubleResult < ::ConvenientService::Exception
             def initialize(service:)
               message = <<~TEXT
                 `#{service.class}` service has a double result.

data/lib/convenient_service/service/plugins/raises_on_double_result/middleware.rb CHANGED Viewed

@@ -4,9 +4,11 @@ module ConvenientService
   module Service
     module Plugins
       module RaisesOnDoubleResult
-        class Middleware < Core::MethodChainMiddleware
+        class Middleware < MethodChainMiddleware
+          intended_for :result, entity: :service
           ##
-          # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
           #
           # @internal
           #   TODO: Rewrite `RaisesOnDoubleResult` to make it thread-safe.
@@ -26,7 +28,7 @@ module ConvenientService
           #     10.times.reduce([]) { |threads| threads << Thread.new { service.result } }.join
           #
           def next(...)
-            refute_has_result! || mark_as_has_result!
+            refute_has_j_send_result! || mark_as_has_j_send_result!
             chain.next(...)
           end
@@ -35,7 +37,7 @@ module ConvenientService
           ##
           # @return [Boolean]
-          # @raise [ConvenientService::Service::Plugins::RaisesOnDoubleResult::Errors::DoubleResult]
+          # @raise [ConvenientService::Service::Plugins::RaisesOnDoubleResult::Exceptions::DoubleResult]
           #
           # @internal
           #   NOTE: `refute` is `!assert`.
@@ -43,10 +45,10 @@ module ConvenientService
           #
           #   NOTE: This method contains a trailing exclamation mark in its name since it is mutable.
           #
-          def refute_has_result!
-            return unless entity.internals.cache.exist?(:has_result)
+          def refute_has_j_send_result!
+            return unless entity.internals.cache.exist?(:has_j_send_result)
-            raise Errors::DoubleResult.new(service: entity)
+            raise Exceptions::DoubleResult.new(service: entity)
           end
           ##
@@ -58,8 +60,8 @@ module ConvenientService
           #
           #   NOTE: This method contains a trailing exclamation mark in its name since it is mutable.
           #
-          def mark_as_has_result!
-            entity.internals.cache.write(:has_result, true)
+          def mark_as_has_j_send_result!
+            entity.internals.cache.write(:has_j_send_result, true)
           end
         end
       end

data/lib/convenient_service/service/plugins/raises_on_double_result.rb CHANGED Viewed

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
-require_relative "raises_on_double_result/errors"
+require_relative "raises_on_double_result/exceptions"
 require_relative "raises_on_double_result/middleware"

data/lib/convenient_service/service/plugins/raises_on_not_result_return_value/exceptions.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module ConvenientService
+  module Service
+    module Plugins
+      module RaisesOnNotResultReturnValue
+        module Exceptions
+          class ReturnValueNotKindOfResult < ::ConvenientService::Exception
+            def initialize(service:, result:, method:)
+              message = <<~TEXT
+                Return value of service `#{service.class}` is NOT a `Result`.
+                It is `#{result.class}`.
+                Did you forget to call `success`, `failure`, or `error` from the `:#{method}` method?
+              TEXT
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module ConvenientService
+  module Service
+    module Plugins
+      module RaisesOnNotResultReturnValue
+        class Middleware < MethodChainMiddleware
+          include Support::DependencyContainer::Import
+          import :"commands.is_result?", from: Service::Plugins::HasJSendResult::Container
+          intended_for any_method, entity: :service
+          def next(...)
+            original_result = chain.next(...)
+            return original_result if commands.is_result?(original_result)
+            raise Exceptions::ReturnValueNotKindOfResult.new(service: entity, result: original_result, method: method)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/raises_on_not_result_return_value.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require_relative "raises_on_not_result_return_value/exceptions"
+require_relative "raises_on_not_result_return_value/middleware"

data/lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_backtrace.rb CHANGED Viewed

@@ -28,7 +28,7 @@ module ConvenientService
             #   - https://blog.kalina.tech/2019/04/exception-without-backtrace-in-ruby.html
             #   - https://github.com/jruby/jruby/issues/4467
             #
-            def initialize(backtrace:, max_size:)
+            def initialize(backtrace:, max_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE)
               @backtrace = backtrace.to_a
               @max_size = max_size
             end

data/lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb CHANGED Viewed

@@ -12,6 +12,12 @@ module ConvenientService
             #
             attr_reader :exception
+            ##
+            # @!attribute [r] max_backtrace_size
+            #   @return [Integer]
+            #
+            attr_reader :max_backtrace_size
             ##
             # @!attribute [r] args
             #   @return [StandardError]
@@ -32,16 +38,18 @@ module ConvenientService
             ##
             # @param exception [StandardError]
-            # @param args [Array]
-            # @param kwargs [Hash]
+            # @param args [Array<Object>]
+            # @param kwargs [Hash{Symbol => Object}]
             # @param block [Proc, nil]
+            # @param max_backtrace_size [Integer]
             # @return [void]
             #
-            def initialize(exception:, args:, kwargs:, block:)
+            def initialize(exception:, args:, kwargs:, block:, max_backtrace_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE)
               @exception = exception
               @args = args
               @kwargs = kwargs
               @block = block
+              @max_backtrace_size = max_backtrace_size
             end
             ##
@@ -179,13 +187,6 @@ module ConvenientService
             def formatted_exception_cause
               Commands::FormatCause.call(cause: exception.cause)
             end
-            ##
-            # @return [Integer]
-            #
-            def max_backtrace_size
-              Constants::DEFAULT_MAX_BACKTRACE_SIZE
-            end
           end
         end
       end

data/lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/middleware.rb CHANGED Viewed

@@ -4,12 +4,46 @@ module ConvenientService
   module Service
     module Plugins
       module RescuesResultUnhandledExceptions
-        class Middleware < Core::MethodChainMiddleware
+        class Middleware < MethodChainMiddleware
+          intended_for :result, scope: any_scope, entity: :service
           ##
-          # @param args [Array]
-          # @param kwargs [Hash]
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
           # @param block [Proc, nil]
-          # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+          #
+          # @note This middleware can be used for both instance and class `:result` methods.
+          #
+          # @example Usage for instance `:result`.
+          #
+          #   class Service
+          #     include ConvenientService::Standard::Config
+          #
+          #     middlewares :result do
+          #       use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware
+          #     end
+          #   end
+          #
+          # @example Usage for class `:result`.
+          #
+          #   class Service
+          #     include ConvenientService::Standard::Config
+          #
+          #     middlewares :result, scope: :class do
+          #       use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware
+          #     end
+          #   end
+          #
+          # @example Max backtrace size can be configured.
+          #
+          #   class Service
+          #     include ConvenientService::Standard::Config
+          #
+          #     middlewares :result do
+          #       use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware.with(max_backtrace_size: 1_000)
+          #     end
+          #   end
           #
           # @internal
           #   NOTE: `rescue => exception` is the same as `rescue ::StandardError => exception`.
@@ -29,10 +63,10 @@ module ConvenientService
           ##
           # @param exception [StandardError]
-          # @param args [Array]
-          # @param kwargs [Hash]
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
           # @param block [Proc, nil]
-          # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
           #
           def failure_result_from(exception, *args, **kwargs, &block)
             entity.failure(
@@ -43,13 +77,20 @@ module ConvenientService
           ##
           # @param exception [StandardError]
-          # @param args [Array]
-          # @param kwargs [Hash]
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
           # @param block [Proc, nil]
           # @return [String]
           #
           def format_exception(exception, *args, **kwargs, &block)
-            Commands::FormatException.call(exception: exception, args: args, kwargs: kwargs, block: block)
+            Commands::FormatException.call(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 }
           end
         end
       end