convenient_service 0.12.0 → 0.14.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_params_validations/using_active_model_validations/middleware.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultParamsValidations
-        module UsingActiveModelValidations
-          class Middleware < Core::MethodChainMiddleware
-            def next(...)
-              return entity.failure(data: errors) if errors.any?
-
-              chain.next(...)
-            end
-
-            private
-
-            ##
-            # NOTE: errors method (from Active Model Validations) does NOT trigger validations
-            # that is why valid? is called here.
-            #
-            # Check the following link for more info:
-            # https://guides.rubyonrails.org/active_record_validations.html#validations-overview-errors
-            #
-            # Quote (this method - errors):
-            # > This method is only useful after validations have been run, because it only inspects the errors collection and does not trigger validations itself.
-            #
-            def errors
-              @errors ||= entity.tap(&:valid?).errors.messages.transform_values(&:first)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_params_validations/using_dry_validation/middleware.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultParamsValidations
-        module UsingDryValidation
-          class Middleware < Core::MethodChainMiddleware
-            def next(...)
-              return entity.failure(data: errors) if errors.any?
-
-              chain.next(...)
-            end
-
-            private
-
-            ##
-            # NOTE: An example of `Dry::Validation::Contract` usage.
-            # https://dry-rb.org/gems/dry-validation/1.8/#quick-start
-            #
-            # TODO: Return one or all errors?
-            #
-            def errors
-              @errors ||= resolve_errors
-            end
-
-            def constructor_kwargs
-              @constructor_kwargs ||= entity.constructor_params.kwargs
-            end
-
-            def contract
-              @contract ||= entity.class.contract
-            end
-
-            def resolve_errors
-              return {} unless contract.schema
-
-              contract.new
-                .call(constructor_kwargs)
-                .errors
-                .to_h
-                .transform_values(&:first)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_short_syntax/error/commands/assert_args_count_lower_than_three.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultShortSyntax
-        module Error
-          module Commands
-            class AssertArgsCountLowerThanThree < Support::Command
-              attr_reader :args
-
-              def initialize(args:)
-                @args = args
-              end
-
-              def call
-                raise Errors::MoreThanTwoArgsArePassed.new if args.size > 2
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_short_syntax/error/commands/assert_either_args_or_kwargs_are_passed.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultShortSyntax
-        module Error
-          module Commands
-            class AssertEitherArgsOrKwargsArePassed < Support::Command
-              attr_reader :args, :kwargs
-
-              def initialize(args:, kwargs:)
-                @args = args
-                @kwargs = kwargs
-              end
-
-              def call
-                raise Errors::BothArgsAndKwargsArePassed.new if args.any? && kwargs.any?
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "commands/assert_args_count_lower_than_three"
-require_relative "commands/assert_either_args_or_kwargs_are_passed"

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultShortSyntax
-        module Error
-          module Errors
-            class BothArgsAndKwargsArePassed < ::ConvenientService::Error
-              def initialize
-                message = <<~TEXT
-                  Both `args` and `kwargs` are passed to the `error` method.
-
-                  Did you mean something like:
-
-                  error("Helpful text")
-                  error("Helpful text", :descriptive_code)
-
-                  error(message: "Helpful text")
-                  error(message: "Helpful text", code: :descriptive_code)
-                TEXT
-
-                super(message)
-              end
-            end
-
-            class MoreThanTwoArgsArePassed < ::ConvenientService::Error
-              def initialize
-                message = <<~TEXT
-                  More than two `args` are passed to the `error` method.
-
-                  Did you mean something like:
-
-                  error("Helpful text")
-                  error("Helpful text", :descriptive_code)
-                TEXT
-
-                super(message)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end