convenient_service 0.10.1 → 0.12.0

data/lib/convenient_service/factories/services.rb

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-##
-# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
-#
-module ConvenientService
-  module Factories
-    module Services
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     def result
-      #       success
-      #     end
-      #   end
-      #
-      def create_service_with_success_result
-        ::Class.new do
-          include ::ConvenientService::Configs::Standard
-
-          def result
-            success
-          end
-        end
-      end
-
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     def result
-      #       error("foo")
-      #     end
-      #   end
-      #
-      def create_service_with_not_success_result
-        create_service_with_error_result
-      end
-
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     def result
-      #       failure(foo: "bar")
-      #     end
-      #   end
-      #
-      def create_service_with_failure_result
-        ::Class.new do
-          include ::ConvenientService::Configs::Standard
-
-          def result
-            failure(data)
-          end
-
-          private
-
-          def data
-            @data ||= {::Faker::Lorem.word => ::Faker::Lorem.sentence}
-          end
-        end
-      end
-
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     def result
-      #       error("foo")
-      #     end
-      #   end
-      #
-      def create_service_with_error_result
-        ::Class.new do
-          include ::ConvenientService::Configs::Standard
-
-          def result
-            error(message)
-          end
-
-          private
-
-          def message
-            @message ||= ::Faker::Lorem.sentence
-          end
-        end
-      end
-
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     def result
-      #       success
-      #     end
-      #   end
-      #
-      def create_service(...)
-        create_service_class(...)
-      end
-
-      ##
-      # @param steps [<Class, Symbol>]
-      # @return [Class]
-      #
-      # @example Default.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     def result
-      #       success
-      #     end
-      #   end
-      #
-      # @example One step.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     step Step # `steps.first` is `args.first`.
-      #   end
-      #
-      # @example One method step.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     step :validate # `steps.first` is `args.first`.
-      #
-      #     def validate
-      #       success
-      #     end
-      #   end
-      #
-      # @example Multiple steps.
-      #   class Service # `service` is class.
-      #     include ConvenientService::Standard::Config
-      #
-      #     step Step # `steps[0]` is `args.first`.
-      #     step OtherStep # `steps[1]` is `args.first`.
-      #     step :result # `steps[2]` is `args.first`.
-      #
-      #     def result
-      #       success
-      #     end
-      #   end
-      #
-      def create_service_class(steps: [])
-        ::Class.new.tap do |klass|
-          klass.class_exec(steps: steps) do
-            include ::ConvenientService::Configs::Standard
-
-            steps.each do |step_name|
-              case step_name
-              when ::Class
-                step step_name
-              when ::Symbol
-                step step_name
-
-                define_method(step_name) { success }
-              end
-            end
-
-            if steps.none?
-              def result
-                success
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/factories/step/instance.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-##
-# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
-#
-module ConvenientService
-  module Factories
-    module Step
-      module Instance
-        ##
-        # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
-        #
-        def create_step_instance
-          service_class =
-            ::Class.new do
-              include ::ConvenientService::Configs::Standard
-
-              step :result
-
-              def result
-                success
-              end
-            end
-
-          service_instance = service_class.new
-
-          service_instance.steps.first
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/factories/step.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "step/instance"

data/lib/convenient_service/factories/steps.rb

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-##
-# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
-#
-module ConvenientService
-  module Factories
-    module Steps
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #
-      #   class Step
-      #     include ConvenienService::Standard::Config
-      #   end
-      #
-      #   class Service
-      #     include ConvenienService::Standard::Config
-      #     # ...
-      #     step Step # `step` is `args.first`
-      #     # ...
-      #   end
-      #
-      def create_step(...)
-        create_service_step_class(...)
-      end
-
-      ##
-      # @return [Integer]
-      #
-      # @example Default.
-      #
-      #   class Service
-      #     include ConvenienService::Standard::Config
-      #     # ...
-      #     step 42 # `step` is `args.first`
-      #     # ...
-      #   end
-      #
-      def create_invalid_step(...)
-        42
-      end
-
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #
-      #   class Step
-      #     include ConvenienService::Standard::Config
-      #   end
-      #
-      #   class Service
-      #     include ConvenienService::Standard::Config
-      #     # ...
-      #     step Step # `step` is `args.first`
-      #     # ...
-      #   end
-      #
-      def create_service_step(...)
-        create_service_step_class(...)
-      end
-
-      ##
-      # @return [Symbol]
-      #
-      # @example Default.
-      #
-      #   class Step
-      #     include ConvenienService::Standard::Config
-      #   end
-      #
-      #   class Service
-      #     include ConvenienService::Standard::Config
-      #     # ...
-      #     step :validate # `step` is `args.first`
-      #     # ...
-      #   end
-      #
-      def create_method_step
-        ::Faker::Verb.unique.base.to_sym
-      end
-
-      ##
-      # @return [Symbol]
-      #
-      # @example Default.
-      #
-      #   class Step
-      #     include ConvenienService::Standard::Config
-      #   end
-      #
-      #   class Service
-      #     include ConvenienService::Standard::Config
-      #     # ...
-      #     step :result # `step` is `args.first`
-      #     # ...
-      #   end
-      #
-      def create_result_method_step
-        :result
-      end
-
-      ##
-      # @return [Class]
-      #
-      # @example Default.
-      #
-      #   class Step
-      #     include ConvenienService::Standard::Config
-      #   end
-      #
-      #   class Service
-      #     include ConvenienService::Standard::Config
-      #     # ...
-      #     step Step # `step` is `args.first`
-      #     # ...
-      #   end
-      #
-      def create_service_step_class
-        create_service_class
-      end
-    end
-  end
-end

data/lib/convenient_service/factories.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "factories/arguments"
-require_relative "factories/services"
-require_relative "factories/results"
-require_relative "factories/steps"
-
-require_relative "factories/step"
-
-##
-# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
-#
-module ConvenientService
-  module Factories
-    extend Arguments
-    extend Services
-    extend Results
-    extend Steps
-
-    extend Step::Instance
-  end
-end

data/lib/convenient_service/factory.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "factories"
-
-##
-# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
-#
-module ConvenientService
-  module Factory
-    class << self
-      ##
-      # @param method [String, Symbol]
-      # @param kwargs [Hash]
-      # @return [Object] Can be any type.
-      #
-      def create(method, **kwargs)
-        Factories.public_send("create_#{method}", **kwargs)
-      end
-    end
-  end
-end

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

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

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

@@ -1,32 +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 ClassMethods
-                      def cast(other)
-                        case other
-                        when ::Hash
-                          new(value: other.transform_keys(&:to_sym))
-                        when Data
-                          new(value: other.value)
-                        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/data.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "data/class_methods"
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasJsendStatusAndAttributes
-                module Entities
-                  class Data
-                    include Support::Castable
-
-                    extend ClassMethods
-
-                    attr_reader :value
-
-                    ##
-                    # @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
-
-                    def ==(other)
-                      casted = cast(other)
-
-                      return unless casted
-
-                      value == casted.value
-                    end
-
-                    def [](key)
-                      value.fetch(key.to_sym) { raise Errors::NotExistingAttribute.new(attribute: key) }
-                    end
-
-                    def to_h
-                      @to_h ||= value.to_h
-                    end
-
-                    def to_s
-                      @to_s ||= to_h.to_s
-                    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/message/class_methods.rb

@@ -1,34 +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 ClassMethods
-                      def cast(other)
-                        case other
-                        when ::String
-                          new(value: other)
-                        when ::Symbol
-                          new(value: other.to_s)
-                        when Message
-                          new(value: other.value)
-                        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/message.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "message/class_methods"
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasJsendStatusAndAttributes
-                module Entities
-                  class Message
-                    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
-                  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/status/class_methods.rb

@@ -1,34 +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 Status
-                    module ClassMethods
-                      def cast(other)
-                        case other
-                        when ::String
-                          new(value: other.to_sym)
-                        when ::Symbol
-                          new(value: other)
-                        when Status
-                          new(value: other.value)
-                        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/status.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "status/class_methods"
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasJsendStatusAndAttributes
-                module Entities
-                  class Status
-                    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 success?
-                      value == :success
-                    end
-
-                    def failure?
-                      value == :failure
-                    end
-
-                    def error?
-                      value == :error
-                    end
-
-                    def not_success?
-                      !success?
-                    end
-
-                    def not_failure?
-                      !failure?
-                    end
-
-                    def not_error?
-                      !error?
-                    end
-
-                    def in?(statuses)
-                      statuses.any? { |status| self == status }
-                    end
-
-                    def to_s
-                      @to_s ||= value.to_s
-                    end
-
-                    def to_sym
-                      @to_sym ||= value.to_sym
-                    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/structs.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "structs/jsend_attributes"