convenient_service 0.5.0 → 0.7.0

data/lib/convenient_service/factories/services.rb

@@ -0,0 +1,189 @@
+# 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

@@ -0,0 +1,32 @@
+# 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

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

data/lib/convenient_service/factories/steps.rb

@@ -0,0 +1,126 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,21 @@
+# 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/rspec/matchers/custom/be_descendant_of.rb

@@ -30,7 +30,7 @@ module ConvenientService
           end
 
           ##
-          # NOTE: `failure_message` is only called when `mathces?` returns `false`.
+          # NOTE: `failure_message` is only called when `matches?` returns `false`.
           # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
           #
           def failure_message
@@ -38,7 +38,7 @@ module ConvenientService
           end
 
           ##
-          # NOTE: `failure_message_when_negated` is only called when `mathces?` returns `false`.
+          # NOTE: `failure_message_when_negated` is only called when `matches?` returns `false`.
           # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
           #
           def failure_message_when_negated

data/lib/convenient_service/rspec/matchers/custom/be_direct_descendant_of.rb

@@ -30,7 +30,7 @@ module ConvenientService
           end
 
           ##
-          # NOTE: `failure_message` is only called when `mathces?` returns `false`.
+          # NOTE: `failure_message` is only called when `matches?` returns `false`.
           # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
           #
           def failure_message
@@ -38,7 +38,7 @@ module ConvenientService
           end
 
           ##
-          # NOTE: `failure_message_when_negated` is only called when `mathces?` returns `false`.
+          # NOTE: `failure_message_when_negated` is only called when `matches?` returns `false`.
           # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
           #
           def failure_message_when_negated

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/commands/generate_printable_method.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        class DelegateTo
+          module Entities
+            class Matcher
+              module Commands
+                class GeneratePrintableMethod < Support::Command
+                  ##
+                  # @!attribute [r] object
+                  #   @return [Object] Can be any type.
+                  #
+                  attr_reader :object
+
+                  ##
+                  # @!attribute [r] method
+                  #   @return [Symbol, String]
+                  #
+                  attr_reader :method
+
+                  ##
+                  # @param object [Object] Can by any type.
+                  # @param method [Symbol, String]
+                  # @return [void]
+                  #
+                  def initialize(object:, method:)
+                    @object = object
+                    @method = method
+                  end
+
+                  def call
+                    case Utils::Object.resolve_type(object)
+                    when "class", "module"
+                      "#{object}.#{method}"
+                    when "instance"
+                      "#{object.class}##{method}"
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/commands.rb

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

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/entities/chainings/sub_matchers/arguments/commands/apply_stub_to_track_delegations.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        class DelegateTo
+          module Entities
+            class Matcher
+              module Entities
+                module Chainings
+                  module SubMatchers
+                    class Arguments < Chainings::SubMatchers::Base
+                      module Commands
+                        class ApplyStubToTrackDelegations < Support::Command
+                          ##
+                          # @internal
+                          #   NOTE: `include ::RSpec::Mocks::ExampleMethods`.
+                          #   - https://github.com/rspec/rspec-mocks/blob/v3.11.1/lib/rspec/mocks/example_methods.rb
+                          #   - https://github.com/rspec/rspec-mocks/blob/main/lib/rspec/mocks/example_methods.rb
+                          #
+                          include ::RSpec::Mocks::ExampleMethods
+
+                          ##
+                          # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
+                          #
+                          attr_reader :matcher
+
+                          ##
+                          # @param matcher [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
+                          # @return [void]
+                          #
+                          def initialize(matcher:)
+                            @matcher = matcher
+                          end
+
+                          def call
+                            ##
+                            # NOTE: RSpec `allow(object).to receive(method).with(*args, **kwargs)` does NOT support block.
+                            # https://github.com/rspec/rspec-mocks/issues/1182#issuecomment-679820352
+                            #
+                            # NOTE: RSpec `allow(object).to receive(method) do` does NOT support `and_call_original`.
+                            # https://github.com/rspec/rspec-mocks/issues/774#issuecomment-54245277
+                            #
+                            # NOTE: That is why `and_wrap_original` is used.
+                            # https://relishapp.com/rspec/rspec-mocks/docs/configuring-responses/wrapping-the-original-implementation
+                            #
+                            allow(matcher.object).to receive(matcher.method).and_wrap_original do |original, *actual_args, **actual_kwargs, &actual_block|
+                              ##
+                              # TODO: Add backtrace for easier reason tracing.
+                              #
+                              matcher.delegations << Entities::Delegation.new(
+                                object: matcher.object,
+                                method: matcher.method,
+                                args: actual_args,
+                                kwargs: actual_kwargs,
+                                block: actual_block
+                              )
+
+                              ##
+                              # NOTE: Imitates `and_call_original`.
+                              #
+                              original.call(*actual_args, **actual_kwargs, &actual_block) if matcher.should_call_original?
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/entities/chainings/sub_matchers/arguments/commands/generate_printable_arguments.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        class DelegateTo
+          module Entities
+            class Matcher
+              module Entities
+                module Chainings
+                  module SubMatchers
+                    class Arguments < Chainings::SubMatchers::Base
+                      module Commands
+                        class GeneratePrintableArguments < Support::Command
+                          include Support::Delegate
+
+                          ##
+                          # @!attribute [r] arguments
+                          #   @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Entities::Arguments]
+                          #
+                          attr_reader :arguments
+
+                          ##
+                          # @return [Array]
+                          #
+                          delegate :args, to: :arguments
+
+                          ##
+                          # @return [Hash]
+                          #
+                          delegate :kwargs, to: :arguments
+
+                          ##
+                          # @return [Proc]
+                          #
+                          delegate :block, to: :arguments
+
+                          ##
+                          # @param arguments [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Entities::Arguments]
+                          #
+                          def initialize(arguments:)
+                            @arguments = arguments
+                          end
+
+                          ##
+                          # @return [String]
+                          #
+                          def call
+                            return "" if arguments.null_arguments?
+
+                            text =
+                              if args.any? && kwargs.any?
+                                "(#{printable_args}, #{printable_kwargs})"
+                              elsif args.any?
+                                "(#{printable_args})"
+                              elsif kwargs.any?
+                                "(#{printable_kwargs})"
+                              else
+                                "()"
+                              end
+
+                            text += " #{printable_block}" if block
+
+                            text
+                          end
+
+                          ##
+                          # @return [String]
+                          #
+                          def printable_args
+                            args.map(&:inspect).join(", ")
+                          end
+
+                          ##
+                          # @return [String]
+                          #
+                          def printable_kwargs
+                            kwargs.map { |key, value| "#{key}: #{value.inspect}" }.join(", ")
+                          end
+
+                          ##
+                          # @return [String]
+                          #
+                          def printable_block
+                            block ? Utils::Proc.display(block) : ""
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/entities/chainings/sub_matchers/arguments/commands.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "commands/apply_stub_to_track_delegations"
+require_relative "commands/generate_printable_arguments"