convenient_service 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd38d2c3dd6b1e8a5d8baf78b0b017a2e8f46bf17a1099221da1c3f1b6da0cc
-  data.tar.gz: eb5f1bad44ec8d80c6e4b661e354c59c170bb0174dcf9f8c9ee9902f434a3cc4
+  metadata.gz: bea27107b54aa89400ea5c24d48db2087287b5c4d4aea9bdf3f860dc626bf864
+  data.tar.gz: 58a10038fa38887094a47b7dc00745244ac9ce0ef8daa5d1afa1fc8fd6ef893f
 SHA512:
-  metadata.gz: fef2d2dda95a3386ebc25494c003053fd72746fac690a4d7b4e1acd4b2eaadf1f858e85ec7340f0a451dc1e658dd288570a1c424671fd47112576870b18935b3
-  data.tar.gz: 055ec4a62139d303a21c058088fb92cea5eae7d520e4f112445a410049564e3c16c23917ac60884b349673e6174a2a16208b58748eb1eb1df6b241a84f327673
+  metadata.gz: faade4af5c03737c1954bfba9cbd9eaa5e31b13856e527cfcfb6e05db3f645729b81b65be8ed22e5f678845b1c3024224b9fe42eccb0bc3b27ed24ae5d8a2dec
+  data.tar.gz: 55fef97517812e04cf89eed571570728fd9a9f1ba2504422e3399600d5d71e27cc2723ced664b1eed147f0289b1cf0d0963805c8ffed45c0dfc173f0b4646505

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [0.10.1](https://github.com/marian13/convenient_service/compare/v0.10.0...v0.10.1) (2023-03-02)
+
+
+### Bug Fixes
+
+* **can_have_stubbed_result:** add thread-safety ([1962dcc](https://github.com/marian13/convenient_service/commit/1962dccdea29fb36c1b581e312329f41bb23c179))
+
+## [0.10.0](https://github.com/marian13/convenient_service/compare/v0.9.0...v0.10.0) (2023-03-01)
+
+
+### Features
+
+* **utils:** introduce Utils::String.demodulize ([87a145a](https://github.com/marian13/convenient_service/commit/87a145a7742e1fce04fa40917dae6ee61e811c71))
+
+
+### Bug Fixes
+
+* **be_result:** commit config manually ([658e314](https://github.com/marian13/convenient_service/commit/658e3147cad50cb7226c8530227e704bb4c30945))
+* **can_have_user_provided_entity:** use demodulized proto entity name ([f25e63c](https://github.com/marian13/convenient_service/commit/f25e63c23a9407ec8cc513311de506781e3cb5ca))
+* **has_result_steps:** no validate ([6c14a57](https://github.com/marian13/convenient_service/commit/6c14a572b8fa2dfcb3afef26e64859bb67ac9729))
+* **rescues_result_unhandled_exceptions:** add indentation for all message lines ([6458103](https://github.com/marian13/convenient_service/commit/6458103c362c66da42587b1a0bec4935b42606ac))
+* **rescues_result_unhandled_exceptions:** use formatted message and class for cause ([c75c389](https://github.com/marian13/convenient_service/commit/c75c3891158ea58d28d8de3718a6296565a1cd84))
+
 ## [0.9.0](https://github.com/marian13/convenient_service/compare/v0.8.0...v0.9.0) (2023-02-22)
 
 

data/lib/convenient_service/common/plugins/can_have_user_provided_entity/commands/find_or_create_entity.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module CanHaveUserProvidedEntity
+        module Commands
+          class FindOrCreateEntity < Support::Command
+            ##
+            # @!attribute [r] namespace
+            #   @return [Class]
+            #
+            attr_reader :namespace
+
+            ##
+            # @!attribute [r] proto_entity
+            #   @return [Class]
+            #
+            attr_reader :proto_entity
+
+            ##
+            # @param namespace [Class]
+            # @param proto_entity [Class]
+            # @return [void]
+            #
+            def initialize(namespace:, proto_entity:)
+              @namespace = namespace
+              @proto_entity = proto_entity
+            end
+
+            ##
+            # @return [void]
+            #
+            def call
+              raise Errors::ProtoEntityHasNoName.new(proto_entity: proto_entity) unless proto_entity_name
+              raise Errors::ProtoEntityHasNoConcern.new(proto_entity: proto_entity) unless proto_entity_concern
+
+              entity.include proto_entity_concern
+
+              ##
+              # @example Result for service.
+              #
+              #   klass = ConvenientService::Common::Plugins::CanHaveUserProvidedEntity::Commands::FindOrCreateEntity.call(
+              #     namespace: SomeService,
+              #     proto_entity: ConvenientService::Service::Plugins::HasResult::Entities::Result
+              #   )
+              #
+              #   ##
+              #   # `klass` is something like:
+              #   #
+              #   # class Result < ConvenientService::Service::Plugins::HasResult::Entities::Result # or just `class Result` if service (namespace) class defines its own.
+              #   #   include ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern # (concern)
+              #   #
+              #   #   class << self
+              #   #     def proto_entity
+              #   #       ##
+              #   #       # NOTE: Returns `proto_entity` passed to `FindOrCreateEntity`.
+              #   #       #
+              #   #       proto_entity
+              #   #     end
+              #   #
+              #   #     def ==(other)
+              #   #       return unless other.respond_to?(:proto_entity)
+              #   #
+              #   #       self.proto_entity == other.proto_entity
+              #   #     end
+              #   #   end
+              #   # end
+              #
+              entity.class_exec(proto_entity) do |proto_entity|
+                define_singleton_method(:proto_entity) { proto_entity }
+                define_singleton_method(:==) { |other| self.proto_entity == other.proto_entity if other.respond_to?(:proto_entity) }
+
+                ##
+                # TODO: `inspect`.
+                #
+                # define_singleton_method(:inspect) { "#{entity}(Prototyped by #{proto_entity})" }
+              end
+
+              entity
+            end
+
+            private
+
+            ##
+            # @return [Class]
+            #
+            def entity
+              @entity ||= Utils::Module.get_own_const(namespace, proto_entity_demodulized_name) || ::Class.new(proto_entity)
+            end
+
+            ##
+            # @return [String, nil]
+            #
+            def proto_entity_name
+              Utils::Object.memoize_including_falsy_values(self, :@proto_entity_name) { proto_entity.name }
+            end
+
+            ##
+            # @return [String]
+            #
+            def proto_entity_demodulized_name
+              @proto_entity_demodulized_name ||= Utils::String.demodulize(proto_entity_name)
+            end
+
+            ##
+            # @return [Module]
+            #
+            def proto_entity_concern
+              Utils::Object.memoize_including_falsy_values(self, :@proto_entity_concern) { Utils::Module.get_own_const(proto_entity, :Concern) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/can_have_user_provided_entity/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/find_or_create_entity"

data/lib/convenient_service/common/plugins/can_have_user_provided_entity/container.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module CanHaveUserProvidedEntity
+        module Container
+          include Support::DependencyContainer::Export
+
+          export :"commands.FindOrCreateEntity" do
+            Commands::FindOrCreateEntity
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/can_have_user_provided_entity/errors.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module CanHaveUserProvidedEntity
+        module Errors
+          class ProtoEntityHasNoName < ConvenientService::Error
+            def initialize(proto_entity:)
+              message = <<~TEXT
+                Proto entity `#{proto_entity}` has no name.
+
+                In other words:
+
+                  proto_entity.name
+                  # => nil
+
+                NOTE: Anonymous classes do NOT have names. Are you passing an anonymous class?
+              TEXT
+
+              super(message)
+            end
+          end
+
+          class ProtoEntityHasNoConcern < ConvenientService::Error
+            def initialize(proto_entity:)
+              message = <<~TEXT
+                Proto entity `#{proto_entity}` has no concern.
+
+                Have a look at `ConvenientService::Service::Plugins::HasResult::Entities::Result`.
+
+                It is an example of a valid proto entity.
+              TEXT
+
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/can_have_user_provided_entity.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "can_have_user_provided_entity/commands"
+require_relative "can_have_user_provided_entity/container"
+require_relative "can_have_user_provided_entity/errors"

data/lib/convenient_service/common/plugins/has_internals/commands/create_internals_class.rb

@@ -6,47 +6,32 @@ module ConvenientService
       module HasInternals
         module Commands
           class CreateInternalsClass < Support::Command
-            attr_reader :service_class
+            include Support::DependencyContainer::Import
 
-            def initialize(service_class:)
-              @service_class = service_class
-            end
-
-            def call
-              internals_class.include Entities::Internals::Concern
+            ##
+            # @!attribute [r] entity_class
+            #   @return Class
+            #
+            attr_reader :entity_class
 
-              ##
-              # class Internals < ConvenientService::Common::Plugins::HasInternals::Entities::Internals # or just `class Internals` if service class defines its own.
-              #   include ConvenientService::Common::Plugins::HasInternals::Entities::Internals::Concern
-              #
-              #   class << self
-              #     def service_class
-              #       ##
-              #       # NOTE: Returns `service_class` passed to `CreateInternalsClass`.
-              #       #
-              #       service_class
-              #     end
-              #
-              #     def ==(other)
-              #       return unless other.instance_of?(self.class)
-              #
-              #       self.service_class == other.service_class
-              #     end
-              #   end
-              # end
-              #
-              internals_class.class_exec(service_class) do |service_class|
-                define_singleton_method(:service_class) { service_class }
-                define_singleton_method(:==) { |other| self.service_class == other.service_class if other.instance_of?(self.class) }
-              end
+            ##
+            # @return Class
+            #
+            import :"commands.FindOrCreateEntity", from: Common::Plugins::CanHaveUserProvidedEntity::Container
 
-              internals_class
+            ##
+            # @param entity_class [Class]
+            # @return [void]
+            #
+            def initialize(entity_class:)
+              @entity_class = entity_class
             end
 
-            private
-
-            def internals_class
-              @internals_class ||= Utils::Module.get_own_const(service_class, :Internals) || ::Class.new(Entities::Internals)
+            ##
+            # @return [Class]
+            #
+            def call
+              commands.FindOrCreateEntity.call(namespace: entity_class, proto_entity: Entities::Internals)
             end
           end
         end

data/lib/convenient_service/common/plugins/has_internals/concern.rb

@@ -15,10 +15,7 @@ module ConvenientService
 
           class_methods do
             def internals_class
-              ##
-              # TODO: Generic `CreateInternalsClass`.
-              #
-              @internals_class ||= Commands::CreateInternalsClass.call(service_class: self)
+              @internals_class ||= Commands::CreateInternalsClass.call(entity_class: self)
             end
           end
         end

data/lib/convenient_service/common/plugins.rb

@@ -8,6 +8,7 @@ require_relative "plugins/normalizes_env"
 require_relative "plugins/caches_constructor_params"
 require_relative "plugins/caches_return_value"
 require_relative "plugins/can_be_copied"
+require_relative "plugins/can_have_user_provided_entity"
 require_relative "plugins/has_callbacks"
 require_relative "plugins/has_around_callbacks"
 require_relative "plugins/has_constructor"

data/lib/convenient_service/rspec/matchers/custom/results/base.rb

@@ -25,6 +25,11 @@ module ConvenientService
 
               rules = []
 
+              ##
+              # IMPORTANT: Makes `result.class.include?` from the following line idempotent.
+              #
+              result.commit_config! if result.respond_to?(:commit_config!)
+
               rules << ->(result) { result.class.include?(Service::Plugins::HasResult::Entities::Result::Concern) }
 
               ##

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

@@ -22,7 +22,24 @@ module ConvenientService
             def stubbed_results
               return Support::Cache.new unless Support::Gems::RSpec.current_example
 
-              cache = Utils::Object.instance_variable_fetch(::RSpec.current_example, :@__convenient_service_stubbed_results__) { Support::Cache.new }
+              ##
+              # IMPORTANT: ivar name with class and current thread enforces thread safety since there is no resource to share.
+              #
+              # TODO: Thread safety specs.
+              #
+              # NOTE: `self` is a service class in the current context. For example:
+              #
+              #   before do
+              #     stub_service(ConvenientService::Examples::Standard::Gemfile::Services::RunShell)
+              #       .with_arguments(command: node_available_command)
+              #       .to return_result(node_available_status)
+              #   end
+              #
+              #   # Then `self` is `ConvenientService::Examples::Standard::Gemfile::Services::RunShell`.
+              #
+              ivar_name = "@__convenient_service_stubbed_results__#{object_id}__#{Thread.current.object_id}__"
+
+              cache = Utils::Object.instance_variable_fetch(::RSpec.current_example, ivar_name) { Support::Cache.new }
 
               cache.scope(self)
             end

data/lib/convenient_service/service/plugins/has_result/commands/create_result_class.rb

@@ -6,57 +6,32 @@ module ConvenientService
       module HasResult
         module Commands
           class CreateResultClass < Support::Command
+            include Support::DependencyContainer::Import
+
+            ##
+            # @!attribute [r] service_class
+            #   @return Class
+            #
             attr_reader :service_class
 
             ##
-            # @param service_class [Class]
-            # @return [void]
+            # @return Class
             #
-            def initialize(service_class:)
-              @service_class = service_class
-            end
+            import :"commands.FindOrCreateEntity", from: Common::Plugins::CanHaveUserProvidedEntity::Container
 
             ##
+            # @param service_class [Class]
             # @return [void]
             #
-            def call
-              result_class.include Entities::Result::Concern
-
-              ##
-              # class Result < ConvenientService::Service::Plugins::HasResult::Entities::Result # or just `class Result` if service class defines its own.
-              #   include ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern
-              #
-              #   class << self
-              #     def service_class
-              #       ##
-              #       # NOTE: Returns `service_class` passed to `CreateResultClass`.
-              #       #
-              #       service_class
-              #     end
-              #
-              #     def ==(other)
-              #       return unless other.instance_of?(self.class)
-              #
-              #       self.service_class == other.service_class
-              #     end
-              #   end
-              # end
-              #
-              result_class.class_exec(service_class) do |service_class|
-                define_singleton_method(:service_class) { service_class }
-                define_singleton_method(:==) { |other| self.service_class == other.service_class if other.instance_of?(self.class) }
-              end
-
-              result_class
+            def initialize(service_class:)
+              @service_class = service_class
             end
 
-            private
-
             ##
             # @return [Class]
             #
-            def result_class
-              @result_class ||= Utils::Module.get_own_const(service_class, :Result) || ::Class.new(Entities::Result)
+            def call
+              commands.FindOrCreateEntity.call(namespace: service_class, proto_entity: Entities::Result)
             end
           end
         end

data/lib/convenient_service/service/plugins/has_result/concern/class_methods.rb

@@ -80,6 +80,10 @@ module ConvenientService
             # @api private
             # @return [Class]
             #
+            # @internal
+            #   NOTE: A command instead of `import` is used in order to NOT pollute the public interface.
+            #   TODO: Specs that prevent public interface accidental pollution.
+            #
             def result_class
               @result_class ||= Commands::CreateResultClass.call(service_class: self)
             end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern/class_methods.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Concern
+                  module ClassMethods
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "concern/class_methods"
 require_relative "concern/instance_methods"
 
 module ConvenientService
@@ -15,6 +16,8 @@ module ConvenientService
 
                   included do |result_class|
                     result_class.include InstanceMethods
+
+                    result_class.extend ClassMethods
                   end
                 end
               end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/concern/class_methods.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Concern
+                      module ClassMethods
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code, nil]
+                        #
+                        def cast(other)
+                          case other
+                          when ::String
+                            new(value: other.to_sym)
+                          when ::Symbol
+                            new(value: other)
+                          when Code
+                            new(value: other.value)
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/concern/instance_methods.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Concern
+                      module InstanceMethods
+                        ##
+                        # @!attribute value [r]
+                        #   @return [Symbol]
+                        #
+                        attr_reader :value
+
+                        ##
+                        # @param value [Symbol]
+                        # @return [void]
+                        #
+                        def initialize(value:)
+                          @value = value
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean]
+                        #
+                        def ==(other)
+                          casted = cast(other)
+
+                          return unless casted
+
+                          value == casted.value
+                        end
+
+                        ##
+                        # @return [String]
+                        #
+                        def to_s
+                          @to_s ||= value.to_s
+                        end
+
+                        ##
+                        # @return [Symbol]
+                        #
+                        def to_sym
+                          @to_sym ||= value.to_sym
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/{class_methods.rb → concern.rb}

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "concern/class_methods"
+require_relative "concern/instance_methods"
+
 module ConvenientService
   module Service
     module Plugins
@@ -10,16 +13,15 @@ module ConvenientService
               module HasJsendStatusAndAttributes
                 module Entities
                   class Code
-                    module ClassMethods
-                      def cast(other)
-                        case other
-                        when ::String
-                          new(value: other.to_sym)
-                        when ::Symbol
-                          new(value: other)
-                        when Code
-                          new(value: other.value)
-                        end
+                    module Concern
+                      include Support::Concern
+
+                      included do |code_class|
+                        code_class.include Support::Castable
+
+                        code_class.include InstanceMethods
+
+                        code_class.extend ClassMethods
                       end
                     end
                   end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "code/class_methods"
+require_relative "code/concern"
 
 module ConvenientService
   module Service
@@ -12,31 +12,7 @@ module ConvenientService
               module HasJsendStatusAndAttributes
                 module Entities
                   class Code
-                    include Support::Castable
-
-                    extend ClassMethods
-
-                    attr_reader :value
-
-                    def initialize(value:)
-                      @value = value
-                    end
-
-                    def ==(other)
-                      casted = cast(other)
-
-                      return unless casted
-
-                      value == casted.value
-                    end
-
-                    def to_s
-                      @to_s ||= value.to_s
-                    end
-
-                    def to_sym
-                      @to_sym ||= value.to_sym
-                    end
+                    include Concern
                   end
                 end
               end

data/lib/convenient_service/service/plugins/has_result_steps/commands/create_step_class.rb

@@ -6,51 +6,32 @@ module ConvenientService
       module HasResultSteps
         module Commands
           class CreateStepClass < Support::Command
+            include Support::DependencyContainer::Import
+
+            ##
+            # @!attribute [r] service_class
+            #   @return Class
+            #
             attr_reader :service_class
 
+            ##
+            # @return Class
+            #
+            import :"commands.FindOrCreateEntity", from: Common::Plugins::CanHaveUserProvidedEntity::Container
+
+            ##
+            # @param service_class [Class]
+            # @return [void]
+            #
             def initialize(service_class:)
               @service_class = service_class
             end
 
+            ##
+            # @return [Class]
+            #
             def call
-              step_class.include Entities::Step::Concern
-
-              ##
-              # class Step < ConvenientService::Service::Plugins::HasResultSteps::Entities::Step # or just `class Step` if service class defines its own.
-              #   include ConvenientService::Service::Plugins::HasResultSteps::Entities::Step::Concern
-              #
-              #   class << self
-              #     def service_class
-              #       ##
-              #       # NOTE: Returns `service_class` passed to `CreateResultClass`.
-              #       #
-              #       service_class
-              #     end
-              #
-              #     def ==(other)
-              #       return unless other.instance_of?(self.class)
-              #
-              #       self.service_class == other.service_class
-              #     end
-              #   end
-              # end
-              #
-              step_class.class_exec(service_class) do |service_class|
-                define_singleton_method(:service_class) { service_class }
-
-                ##
-                # TODO: Fix a bug with `ap`.
-                #
-                define_singleton_method(:==) { |other| self.service_class == other.service_class if other.instance_of?(self.class) }
-              end
-
-              step_class
-            end
-
-            private
-
-            def step_class
-              @step_class ||= Utils::Module.get_own_const(service_class, :Step) || ::Class.new(Entities::Step)
+              commands.FindOrCreateEntity.call(namespace: service_class, proto_entity: Entities::Step)
             end
           end
         end

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

@@ -20,7 +20,10 @@ module ConvenientService
             def commit!
               return false if committed?
 
-              steps.each { |step| step.validate! && step.define! }.freeze
+              ##
+              # IMPORTANT: Temporarily removed `step.validate!` since it is neither thread-safe nor idempotent.
+              #
+              steps.each { |step| step.define! }.freeze
 
               true
             end

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

@@ -39,14 +39,28 @@ module ConvenientService
               <<~MESSAGE.chomp
                 ------------------
                 --- Caused by: ---
-                #{cause.class}:
-                  #{cause.message}
+                #{formatted_cause_class}
+                #{formatted_cause_message}
                 #{formatted_cause_first_line}
               MESSAGE
             end
 
             private
 
+            ##
+            # @return [String]
+            #
+            def formatted_cause_class
+              Commands::FormatClass.call(klass: cause.class)
+            end
+
+            ##
+            # @return [String]
+            #
+            def formatted_cause_message
+              Commands::FormatMessage.call(message: cause.message)
+            end
+
             ##
             # @return [String, nil]
             #

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module RescuesResultUnhandledExceptions
+        module Commands
+          class FormatClass < Support::Command
+            ##
+            # @!attribute [r] klass
+            #   @return [Class]
+            #
+            attr_reader :klass
+
+            ##
+            # @param klass [Class]
+            # @return [void]
+            #
+            def initialize(klass:)
+              @klass = klass
+            end
+
+            ##
+            # @return [String]
+            #
+            # @note Exceptions formatting is inspired by RSpec. It has almost the same output (at least for RSpec 3).
+            #
+            # @example Line.
+            #
+            #   StandardError:
+            #
+            def call
+              "#{klass}:"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -64,6 +64,23 @@ module ConvenientService
             #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb:73:in `call'
             #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
             #
+            # @example Exception with multiline message.
+            #
+            #   StandardError:
+            #     exception message first line
+            #     exception message second line
+            #     exception message third line
+            #   # /gem/lib/convenient_service/factories/services.rb:120:in `result'
+            #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_middlewares_caller.rb:116:in `call'
+            #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_middlewares_caller.rb:116:in `block in result'
+            #   # /gem/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/runner.rb:67:in `block (2 levels) in build_call_chain'
+            #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
+            #   # /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `block in next'
+            #   # /gem/lib/convenient_service/support/cache.rb:110:in `fetch'
+            #   # /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `next'
+            #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb:73:in `call'
+            #   # /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
+            #
             # @example Exception with backtrace with more than 10 lines.
             #
             #   StandardError:
@@ -107,7 +124,8 @@ module ConvenientService
             #
             def call
               <<~MESSAGE.rstrip
-                #{formatted_exception}
+                #{formatted_exception_class}
+                #{formatted_exception_message}
                 #{formatted_exception_backtrace}
                 #{formatted_exception_cause}
               MESSAGE
@@ -118,11 +136,15 @@ module ConvenientService
             ##
             # @return [String]
             #
-            def formatted_exception
-              <<~MESSAGE.chomp
-                #{exception.class}:
-                  #{exception.message}
-              MESSAGE
+            def formatted_exception_class
+              Commands::FormatClass.call(klass: exception.class)
+            end
+
+            ##
+            # @return [String]
+            #
+            def formatted_exception_message
+              Commands::FormatMessage.call(message: exception.message)
             end
 
             ##
@@ -151,6 +173,9 @@ module ConvenientService
             ##
             # @return [String]
             #
+            # @note `exception.cause` may be `$!`.
+            # @see https://ruby-doc.org/core-2.7.0/Exception.html#method-i-cause
+            #
             def formatted_exception_cause
               Commands::FormatCause.call(cause: exception.cause)
             end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module RescuesResultUnhandledExceptions
+        module Commands
+          class FormatMessage < Support::Command
+            ##
+            # @!attribute [r] message
+            #   @return [String, nil]
+            #
+            attr_reader :message
+
+            ##
+            # @param message [String, nil]
+            # @return [void]
+            #
+            def initialize(message:)
+              @message = message
+            end
+
+            ##
+            # @return [String]
+            #
+            # @note Message formatting is inspired by RSpec. It has almost the same output (at least for RSpec 3).
+            #
+            # @note Underscores are used to highlight spaces in docs, they are NOT included in the resulting message, check `FormatException` for a full example.
+            #
+            # @example Message.
+            #   __exception message
+            #
+            # @example Multiline message.
+            #   __exception message first line
+            #   __exception message second line
+            #   __exception message third line
+            #
+            # @see ConvenientService::Service::Plugins::RescuesResultUnhandledExceptions::Commands::FormatException
+            #
+            def call
+              message.to_s.chomp.split("\n").map { |line| line.prepend(Constants::MESSAGE_LINE_PREFIX) }.join("\n")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,8 @@
 
 require_relative "commands/format_backtrace"
 require_relative "commands/format_cause"
+require_relative "commands/format_class"
 require_relative "commands/format_line"
+require_relative "commands/format_message"
 
 require_relative "commands/format_exception"

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

@@ -5,7 +5,15 @@ module ConvenientService
     module Plugins
       module RescuesResultUnhandledExceptions
         module Constants
+          ##
+          # @return [Integer]
+          #
           DEFAULT_MAX_BACKTRACE_SIZE = 10
+
+          ##
+          # @return [String]
+          #
+          MESSAGE_LINE_PREFIX = " " * 2
         end
       end
     end

data/lib/convenient_service/utils/string/camelize.rb

@@ -13,7 +13,7 @@ module ConvenientService
       class Camelize < Support::Command
         ##
         # @!attribute [r] string
-        #   @return [#to_s]
+        #   @return [String]
         #
         attr_reader :string
 
@@ -24,7 +24,7 @@ module ConvenientService
         attr_reader :capitalize_first_letter
 
         ##
-        # @param string [Symbol, String]
+        # @param string [#to_s]
         # @return [void]
         #
         def initialize(string, capitalize_first_letter: true)
@@ -45,6 +45,10 @@ module ConvenientService
 
         private
 
+        ##
+        # @param part [String]
+        # @return [String]
+        #
         def upcase_first_char(part)
           return part if part.empty?
 

data/lib/convenient_service/utils/string/demodulize.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Utils
+    module String
+      ##
+      # @example
+      #   demodulize('ActiveSupport::Inflector::Inflections') # => "Inflections"
+      #   demodulize('Inflections')                           # => "Inflections"
+      #   demodulize('::Inflections')                         # => "Inflections"
+      #   demodulize('')                                      # => ""
+      #
+      # @see https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-demodulize
+      #
+      class Demodulize < Support::Command
+        ##
+        # @!attribute [r] string
+        #   @return [String]
+        #
+        attr_reader :string
+
+        ##
+        # @param string [#to_s]
+        # @return [void]
+        #
+        def initialize(string)
+          @string = string.to_s
+        end
+
+        ##
+        # @return [String]
+        #
+        # @internal
+        #   NOTE: Copied with cosmetic modifications from:
+        #   - https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-demodulize
+        #
+        #   NOTE: Modifications.
+        #   - `string` is `path.to_s` is the original implementation.
+        #   - Fixed Rubocop complaint about `Style/SlicingWithRange`.
+        #   - Fixed Rubocop complaint about `Lint/AssignmentInCondition`.
+        #
+        def call
+          i = string.rindex("::")
+
+          i ? string[(i + 2)..] : string
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/utils/string/split.rb

@@ -6,7 +6,7 @@ module ConvenientService
       class Split < Support::Command
         ##
         # @!attribute [r] string
-        #   @return [#to_s]
+        #   @return [String]
         #
         attr_reader :string
 
@@ -17,12 +17,12 @@ module ConvenientService
         attr_reader :delimiters
 
         ##
-        # @param string [Symbol, String]
+        # @param string [#to_s]
         # @param delimiters [Array<String>]
         # @return [void]
         #
         def initialize(string, *delimiters)
-          @string = string
+          @string = string.to_s
           @delimiters = delimiters
         end
 
@@ -33,7 +33,7 @@ module ConvenientService
         #   https://stackoverflow.com/a/51380514/12201472
         #
         def call
-          string.to_s.split(::Regexp.union(delimiters))
+          string.split(::Regexp.union(delimiters))
         end
       end
     end

data/lib/convenient_service/utils/string.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "string/camelize"
+require_relative "string/demodulize"
 require_relative "string/split"
 
 module ConvenientService
@@ -11,6 +12,10 @@ module ConvenientService
           Camelize.call(...)
         end
 
+        def demodulize(...)
+          Demodulize.call(...)
+        end
+
         def split(...)
           Split.call(...)
         end

data/lib/convenient_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvenientService
-  VERSION = "0.9.0"
+  VERSION = "0.10.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Marian Kostyk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -391,6 +391,11 @@ files:
 - lib/convenient_service/common/plugins/caches_return_value/middleware.rb
 - lib/convenient_service/common/plugins/can_be_copied.rb
 - lib/convenient_service/common/plugins/can_be_copied/concern.rb
+- lib/convenient_service/common/plugins/can_have_user_provided_entity.rb
+- lib/convenient_service/common/plugins/can_have_user_provided_entity/commands.rb
+- lib/convenient_service/common/plugins/can_have_user_provided_entity/commands/find_or_create_entity.rb
+- lib/convenient_service/common/plugins/can_have_user_provided_entity/container.rb
+- lib/convenient_service/common/plugins/can_have_user_provided_entity/errors.rb
 - lib/convenient_service/common/plugins/has_around_callbacks.rb
 - lib/convenient_service/common/plugins/has_around_callbacks/concern.rb
 - lib/convenient_service/common/plugins/has_around_callbacks/errors.rb
@@ -712,10 +717,13 @@ files:
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/commands.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/commands/cast_jsend_attributes.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern/class_methods.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern/instance_methods.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/class_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/concern/class_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/concern/instance_methods.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data/class_methods.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/message.rb
@@ -829,8 +837,10 @@ files:
 - 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/wraps_result_in_db_transaction.rb
@@ -914,6 +924,7 @@ files:
 - lib/convenient_service/utils/proc/exec_config.rb
 - lib/convenient_service/utils/string.rb
 - lib/convenient_service/utils/string/camelize.rb
+- lib/convenient_service/utils/string/demodulize.rb
 - lib/convenient_service/utils/string/split.rb
 - lib/convenient_service/version.rb
 - logo.png