convenient_service 0.11.0 → 0.12.0

data/lib/convenient_service/factories/services.rb

@@ -1,229 +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
-
-          ##
-          # IMPORTANT:
-          #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-          #   - It will be reenabled after the introduction of thread-safety specs.
-          #   - Do not use it in production yet.
-          #
-          middlewares :step, scope: :class do
-            use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-          end
-
-          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
-
-          ##
-          # IMPORTANT:
-          #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-          #   - It will be reenabled after the introduction of thread-safety specs.
-          #   - Do not use it in production yet.
-          #
-          middlewares :step, scope: :class do
-            use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-          end
-
-          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
-
-          ##
-          # IMPORTANT:
-          #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-          #   - It will be reenabled after the introduction of thread-safety specs.
-          #   - Do not use it in production yet.
-          #
-          middlewares :step, scope: :class do
-            use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-          end
-
-          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
-
-            ##
-            # IMPORTANT:
-            #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-            #   - It will be reenabled after the introduction of thread-safety specs.
-            #   - Do not use it in production yet.
-            #
-            middlewares :step, scope: :class do
-              use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-            end
-
-            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,42 +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::CanHaveSteps::Entities::Step]
-        #
-        def create_step_instance
-          service_class =
-            ::Class.new do
-              include ::ConvenientService::Configs::Standard
-
-              ##
-              # IMPORTANT:
-              #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-              #   - It will be reenabled after the introduction of thread-safety specs.
-              #   - Do not use it in production yet.
-              #
-              middlewares :step, scope: :class do
-                use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-              end
-
-              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/can_have_steps/entities/method/commands/cast_method_caller.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Method
-            module Commands
-              ##
-              # TODO: Abstract factory.
-              #
-              class CastMethodCaller < Support::Command
-                attr_reader :other, :options
-
-                def initialize(other:, options:)
-                  @other = other
-                  @options = options
-                end
-
-                def call
-                  case other
-                  when ::Symbol then cast_symbol
-                  when ::String then cast_string
-                  when ::Hash then cast_hash
-                  when Entities::Values::Reassignment then cast_reassignment
-                  when Method then cast_method
-                  end
-                end
-
-                private
-
-                def cast_symbol
-                  Entities::Callers::Usual.new(other)
-                end
-
-                def cast_string
-                  Entities::Callers::Usual.new(other)
-                end
-
-                def cast_reassignment
-                  Entities::Callers::Reassignment.new(other)
-                end
-
-                def cast_hash
-                  return unless other.keys.one?
-
-                  value = other.values.first
-
-                  case value
-                  when ::Symbol
-                    Entities::Callers::Alias.new(value)
-                  when ::String
-                    Entities::Callers::Alias.new(value)
-                  when ::Proc
-                    Entities::Callers::Proc.new(value)
-                  when Support::RawValue
-                    Entities::Callers::Raw.new(value)
-                  when Entities::Values::Reassignment
-                    Entities::Callers::Reassignment.new(value)
-                  end
-                end
-
-                def cast_method
-                  other.caller.copy
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/commands/cast_method_key.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Method
-            module Commands
-              ##
-              # TODO: Abstract factory.
-              #
-              class CastMethodKey < Support::Command
-                attr_reader :other, :options
-
-                def initialize(other:, options:)
-                  @other = other
-                  @options = options
-                end
-
-                def call
-                  ##
-                  # TODO: Use pattern matcher when Ruby 2.7.
-                  #
-                  case other
-                  when ::Symbol then cast_symbol
-                  when ::String then cast_string
-                  when ::Hash then cast_hash
-                  when Entities::Values::Reassignment then cast_reassignment
-                  when Method then cast_method
-                  end
-                end
-
-                private
-
-                def cast_symbol
-                  Entities::Key.new(other)
-                end
-
-                def cast_string
-                  Entities::Key.new(other)
-                end
-
-                def cast_reassignment
-                  Entities::Key.new(other.to_sym)
-                end
-
-                def cast_hash
-                  return unless other.keys.one?
-
-                  key = other.keys.first
-                  value = other.values.first
-
-                  case value
-                  when ::Symbol
-                    Entities::Key.new(key)
-                  when ::String
-                    Entities::Key.new(key)
-                  when ::Proc
-                    Entities::Key.new(key)
-                  when Support::RawValue
-                    Entities::Key.new(key)
-                  when Entities::Values::Reassignment
-                    Entities::Key.new(key)
-                  end
-                end
-
-                def cast_method
-                  other.key.copy
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/commands/cast_method_name.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Method
-            module Commands
-              #
-              # TODO: Abstract factory.
-              #
-              class CastMethodName < Support::Command
-                attr_reader :other, :options
-
-                def initialize(other:, options:)
-                  @other = other
-                  @options = options
-                end
-
-                def call
-                  ##
-                  # TODO: Use pattern matcher when Ruby 2.7.
-                  #
-                  case other
-                  when ::Symbol then cast_symbol
-                  when ::String then cast_string
-                  when ::Hash then cast_hash
-                  when Entities::Values::Reassignment then cast_reassignment
-                  when Method then cast_method
-                  end
-                end
-
-                private
-
-                def cast_symbol
-                  Entities::Name.new(other)
-                end
-
-                def cast_string
-                  Entities::Name.new(other)
-                end
-
-                def cast_reassignment
-                  Entities::Name.new(other.to_sym)
-                end
-
-                def cast_hash
-                  return unless other.keys.one?
-
-                  key = other.keys.first
-                  value = other.values.first
-
-                  case value
-                  when ::Symbol
-                    Entities::Name.new(value)
-                  when ::String
-                    Entities::Name.new(value)
-                  when ::Proc
-                    Entities::Name.new(key)
-                  when Support::RawValue
-                    Entities::Name.new(key)
-                  when Entities::Values::Reassignment
-                    Entities::Name.new(value.to_sym)
-                  end
-                end
-
-                def cast_method
-                  other.name.copy
-                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/commands.rb

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