convenient_service 0.6.0 → 0.7.0

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.rb

@@ -94,6 +94,15 @@ module ConvenientService
             self
           end
 
+          ##
+          # TODO: `and_return`.
+          #
+          # def and_return(...)
+          #   matcher.and_return(...)
+          #
+          #   self
+          # end
+
           ##
           # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
           #

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_method_step.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class FindResultMethodStep < Support::Command
+                ##
+                # @!attribute result [r]
+                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                #
+                attr_reader :result
+
+                ##
+                # @!attribute method_name [r]
+                #   @return [Symbol]
+                #
+                attr_reader :method_name
+
+                ##
+                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                # @param method_name [Symbol]
+                # @return [void]
+                #
+                def initialize(result:, method_name:)
+                  @result = result
+                  @method_name = method_name
+                end
+
+                ##
+                # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                #
+                def call
+                  return nil unless result.step
+
+                  result.step.inputs.find { |input| match_service_class?(input) && match_key?(input) && match_value?(input) }
+                end
+
+                private
+
+                ##
+                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [Boolean]
+                #
+                def match_service_class?(input)
+                  result.step.service_class == Services::RunMethodInOrganizer
+                end
+
+                ##
+                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [Boolean]
+                #
+                def match_key?(input)
+                  input.key.to_sym == :method_name
+                end
+
+                ##
+                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [Boolean]
+                #
+                def match_value?(input)
+                  input.value.to_sym == method_name
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_result_method_step.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class FindResultResultMethodStep < Support::Command
+                ##
+                # @!attribute result [r]
+                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                #
+                attr_reader :result
+
+                ##
+                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                # @return [void]
+                #
+                def initialize(result:)
+                  @result = result
+                end
+
+                ##
+                # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                #
+                def call
+                  return nil unless result.step
+
+                  result.step.inputs.find { |input| match_service_class?(input) && match_key?(input) && match_value?(input) }
+                end
+
+                private
+
+                ##
+                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [Boolean]
+                #
+                def match_service_class?(input)
+                  result.step.service_class == Services::RunOwnMethodInOrganizer
+                end
+
+                ##
+                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [Boolean]
+                #
+                def match_key?(input)
+                  input.key.to_sym == :method_name
+                end
+
+                ##
+                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [Boolean]
+                #
+                def match_value?(input)
+                  input.value.to_sym == :result
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_service_step.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class FindResultServiceStep < Support::Command
+                ##
+                # @!attribute result [r]
+                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                #
+                attr_reader :result
+
+                ##
+                # @!attribute service_class [r]
+                #   @return [Class]
+                #
+                attr_reader :service_class
+
+                ##
+                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                # @param service_class [Class]
+                # @return [void]
+                #
+                def initialize(result:, service_class:)
+                  @result = result
+                  @service_class = service_class
+                end
+
+                ##
+                # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                #
+                def call
+                  return nil unless result.step
+
+                  result.step.service_class == service_class
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/generate_expected_step_part.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class GenerateExpectedStepPart < Support::Command
+                ##
+                # @!attribute step [r]
+                #   @return [Class, Symbol]
+                #
+                attr_reader :step
+
+                ##
+                # @param step [Class, Symbol]
+                # @return [void]
+                #
+                def initialize(step:)
+                  @step = step
+                end
+
+                ##
+                # @return [String]
+                #
+                def call
+                  if step.nil?
+                    "without step"
+                  else
+                    "of step `#{step}`"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/generate_got_step_part.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class GenerateGotStepPart < Support::Command
+                ##
+                # @!attribute result [r]
+                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                #
+                attr_reader :result
+
+                ##
+                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                # @return [void]
+                #
+                def initialize(result:)
+                  @result = result
+                end
+
+                ##
+                # @return [String]
+                #
+                def call
+                  if result.step.nil?
+                    "without step"
+                  else
+                    "of step `#{result.step.service.klass}`"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/match_result_step.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class MatchResultStep < Support::Command
+                ##
+                # @!attribute result [r]
+                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                #
+                attr_reader :result
+
+                ##
+                # @!attribute step [r]
+                #   @return [Class, Symbol]
+                #
+                attr_reader :step
+
+                ##
+                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                # @param step [Class, Symbol]
+                # @return [void]
+                #
+                def initialize(result:, step:)
+                  @result = result
+                  @step = step
+                end
+
+                ##
+                # @return [Boolean]
+                # @raise [ConvenientService::RSpec::Matchers::Custom::Results::Base::Errors::InvalidStep]
+                #
+                def call
+                  case step
+                  when ::Class then match_service_step?
+                  when :result then match_result_method_step?
+                  when ::Symbol then match_method_step?
+                  when nil then match_without_step?
+                  else raise Errors::InvalidStep.new(step: step)
+                  end
+                end
+
+                private
+
+                ##
+                # @return [Boolean]
+                #
+                def match_service_step?
+                  service_step = Commands::FindResultServiceStep.call(result: result, service_class: step)
+
+                  Utils::Bool.to_bool(service_step)
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def match_result_method_step?
+                  result_method_step = Commands::FindResultResultMethodStep.call(result: result)
+
+                  Utils::Bool.to_bool(result_method_step)
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def match_method_step?
+                  method_step = Commands::FindResultMethodStep.call(result: result, method_name: step)
+
+                  Utils::Bool.to_bool(method_step)
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def match_without_step?
+                  result.step.nil?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "commands/find_result_method_step"
+require_relative "commands/find_result_result_method_step"
+require_relative "commands/find_result_service_step"
+
+require_relative "commands/generate_expected_step_part"
+require_relative "commands/generate_got_step_part"
+
+require_relative "commands/match_result_step"

data/lib/convenient_service/rspec/matchers/custom/results/base/errors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Errors
+              class InvalidStep < ConvenientService::Error
+                def initialize(step:)
+                  message = <<~TEXT
+                    Step `#{step}` is NOT valid.
+
+                    `of_step` only accepts a Class or a Symbol. For example:
+
+                    be_success.of_step(ReadFileContent)
+                    be_success.of_step(:validate_path)
+                    be_success.of_step(:result)
+
+                    If you need to confirm that `result` has NO step - use `without_step` instead.
+
+                    be_success.without_step
+                  TEXT
+
+                  super(message)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end