convenient_service 0.12.0 → 0.13.0

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

@@ -1,65 +0,0 @@
-# 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 [r] value
-                        #   @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, nil]
-                        #
-                        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_j_send_status_and_attributes/entities/data/concern/instance_methods.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasJSendStatusAndAttributes
-                module Entities
-                  class Data
-                    module Concern
-                      module InstanceMethods
-                        ##
-                        # @!attribute [r] value
-                        #   @return [Hash]
-                        #
-                        attr_reader :value
-
-                        ##
-                        # @param value [Hash]
-                        # @return [void]
-                        #
-                        # @internal
-                        #   NOTE: Ruby hashes enumerate their values in the order that the corresponding keys were inserted.
-                        #   That is why the end-user can be 100% sure that the failure message is always generated from the first key/value pair.
-                        #   - https://ruby-doc.org/core-2.7.0/Hash.html
-                        #
-                        #   TODO: A test that crashes when such behaviour is broken.
-                        #
-                        #   NOTE: As a result, there is NO need to use any custom `OrderedHash` implementations.
-                        #   - https://api.rubyonrails.org/v5.1/classes/ActiveSupport/OrderedHash.html
-                        #   - https://github.com/rails/rails/issues/22681
-                        #   - https://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html
-                        #
-                        def initialize(value:)
-                          @value = value
-                        end
-
-                        ##
-                        # @param key [String, Symbol]
-                        # @return [Boolean]
-                        #
-                        def has_attribute?(key)
-                          value.has_key?(key.to_sym)
-                        end
-
-                        ##
-                        # @param other [Object] Can be any type.
-                        # @return [Boolean, nil]
-                        #
-                        def ==(other)
-                          casted = cast(other)
-
-                          return unless casted
-
-                          value == casted.value
-                        end
-
-                        ##
-                        # @param key [String, Symbol]
-                        # @return [Object] Can be any type.
-                        # @raise [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Errors::NotExistingAttribute]
-                        #
-                        def [](key)
-                          value.fetch(key.to_sym) { raise Errors::NotExistingAttribute.new(attribute: key) }
-                        end
-
-                        ##
-                        # @return [Hash]
-                        #
-                        def to_h
-                          @to_h ||= value.to_h
-                        end
-
-                        ##
-                        # @return [String]
-                        #
-                        def to_s
-                          @to_s ||= to_h.to_s
-                        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_j_send_status_and_attributes/entities/message/concern/instance_methods.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasJSendStatusAndAttributes
-                module Entities
-                  class Message
-                    module Concern
-                      module InstanceMethods
-                        ##
-                        # @!attribute [r] value
-                        #   @return [String]
-                        #
-                        attr_reader :value
-
-                        ##
-                        # @param value [String]
-                        # @return [void]
-                        #
-                        def initialize(value:)
-                          @value = value
-                        end
-
-                        ##
-                        # @param other [Object] Can be any type.
-                        # @return [Boolean, nil]
-                        #
-                        def ==(other)
-                          casted = cast(other)
-
-                          return unless casted
-
-                          value == casted.value
-                        end
-
-                        ##
-                        # @return [String]
-                        #
-                        def to_s
-                          @to_s ||= value.to_s
-                        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_result_short_syntax/concern.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasResultShortSyntax
-                module Concern
-                  include Support::Concern
-
-                  instance_methods do
-                    ##
-                    # @param key [String, Symbol]
-                    # @return [Object] Can be any type.
-                    #
-                    # @internal
-                    #   NOTE: Delegates to `data` instead of aliasing in order to have an ability
-                    #   to use the same RSpec stubs for short and usual syntax.
-                    #
-                    #   For example:
-                    #
-                    #     allow(result).to receive(:data).with(:foo).and_call_original
-                    #
-                    #   works for both `result.data[:foo]` and `result[:foo]`.
-                    #
-                    def [](key)
-                      data[key]
-                    end
-
-                    ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
-                    #
-                    def ud
-                      unsafe_data
-                    end
-
-                    ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
-                    #
-                    def um
-                      unsafe_message
-                    end
-
-                    ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
-                    #
-                    def uc
-                      unsafe_code
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "has_result_short_syntax/concern"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize/middleware.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasStep
-                module Initialize
-                  class Middleware < Core::MethodChainMiddleware
-                    def next(*args, **kwargs, &block)
-                      entity.internals.cache[:step] = kwargs[:step]
-
-                      chain.next(*args, **kwargs, &block)
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "initialize/middleware"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/to_kwargs/middleware.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasStep
-                module ToKwargs
-                  class Middleware < Core::MethodChainMiddleware
-                    def next(...)
-                      chain.next(...).merge(step: entity.step)
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/to_kwargs.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "to_kwargs/middleware"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "has_step/concern"
-require_relative "has_step/initialize"
-require_relative "has_step/to_kwargs"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/marks_result_status_as_checked/middleware.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module MarksResultStatusAsChecked
-                class Middleware < Core::MethodChainMiddleware
-                  def next(...)
-                    entity.internals.cache[:has_checked_status] = true
-
-                    chain.next(...)
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/marks_result_status_as_checked.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "marks_result_status_as_checked/middleware"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/raises_on_not_checked_result_status/middleware.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module RaisesOnNotCheckedResultStatus
-                class Middleware < Core::MethodChainMiddleware
-                  def next(...)
-                    assert_has_checked_status!
-
-                    chain.next(...)
-                  end
-
-                  private
-
-                  def assert_has_checked_status!
-                    return if entity.internals.cache.exist?(:has_checked_status)
-
-                    raise Errors::StatusIsNotChecked.new(attribute: method)
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/errors.rb

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

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        class Middleware < Core::MethodChainMiddleware
-          def next(...)
-            original_result = chain.next(...)
-
-            return original_result if original_result.class.include?(Entities::Result::Concern)
-
-            raise Errors::ServiceReturnValueNotKindOfResult.new(service: entity, result: original_result)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_short_syntax/failure/commands/refute_kwargs_contain_data_and_extra_keys.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultShortSyntax
-        module Failure
-          module Commands
-            class RefuteKwargsContainDataAndExtraKeys < Support::Command
-              attr_reader :kwargs
-
-              def initialize(kwargs:)
-                @kwargs = kwargs
-              end
-
-              def call
-                return unless kwargs.has_key?(:data)
-
-                return if kwargs.keys.one?
-
-                raise Errors::KwargsContainDataAndExtraKeys.new
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_short_syntax/failure/errors.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultShortSyntax
-        module Failure
-          module Errors
-            class KwargsContainDataAndExtraKeys < ::ConvenientService::Error
-              def initialize
-                message = <<~TEXT
-                  `kwargs` passed to `failure` method contain `data` and extra keys. That's NOT allowed.
-
-                  Please, consider something like:
-
-                  failure(foo: :bar)
-                  failure(data: {foo: :bar})
-                TEXT
-
-                super(message)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_short_syntax/failure/middleware.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultShortSyntax
-        module Failure
-          class Middleware < Core::MethodChainMiddleware
-            def next(**kwargs)
-              Commands::RefuteKwargsContainDataAndExtraKeys.call(kwargs: kwargs)
-
-              kwargs.has_key?(:data) ? chain.next(**kwargs) : chain.next(data: kwargs)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_short_syntax/success/commands.rb

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

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "has_result_short_syntax/concern"
-require_relative "has_result_short_syntax/success"
-require_relative "has_result_short_syntax/failure"
-require_relative "has_result_short_syntax/error"

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

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "has_result_status_check_short_syntax/concern"

data/lib/convenient_service/services/run_method_in_organizer.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Services
-    class RunMethodInOrganizer
-      ##
-      # @internal
-      #   TODO: Reuse parent config?
-      #
-      include Configs::Standard
-
-      attr_reader :method_name, :organizer, :kwargs
-
-      def initialize(method_name:, organizer:, **kwargs)
-        @method_name = method_name
-        @organizer = organizer
-        @kwargs = kwargs
-      end
-
-      def result
-        ##
-        # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `organizer.__send__(method_name)` body.
-        #
-        organizer.__send__(method_name)
-      end
-    end
-  end
-end

data/lib/convenient_service/services/run_own_method_in_organizer.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Services
-    class RunOwnMethodInOrganizer
-      module Errors
-        class MethodForStepIsNotDefined < ::ConvenientService::Error
-          def initialize(service_class:, method_name:)
-            message = <<~TEXT
-              Service #{service_class} tries to use `#{method_name}` method in a step, but it NOT defined.
-
-              Did you forget to define it?
-            TEXT
-
-            super(message)
-          end
-        end
-      end
-
-      ##
-      # @internal
-      #   TODO: Reuse parent config?
-      #
-      include Configs::Standard
-
-      attr_reader :method_name, :organizer, :kwargs
-
-      def initialize(method_name:, organizer:, **kwargs)
-        @method_name = method_name
-        @organizer = organizer
-        @kwargs = kwargs
-      end
-
-      def result
-        raise Errors::MethodForStepIsNotDefined.new(service_class: organizer.class, method_name: method_name) unless own_method
-
-        ##
-        # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `own_method` body.
-        #
-        own_method.call
-      end
-
-      private
-
-      ##
-      # @return [Method, nil]
-      #
-      # @internal
-      #   TODO: A possible bottleneck. Should be removed if receives negative feedback.
-      #
-      #   NOTE: `own_method.bind(organizer).call` is logically the same as `own_method.bind_call(organizer)`.
-      #   - https://ruby-doc.org/core-2.7.1/UnboundMethod.html#method-i-bind_call
-      #   - https://blog.saeloun.com/2019/10/17/ruby-2-7-adds-unboundmethod-bind_call-method.html
-      #
-      def own_method
-        method = Utils::Module.get_own_instance_method(organizer.class, method_name, private: true)
-
-        return unless method
-
-        method.bind(organizer)
-      end
-    end
-  end
-end