convenient_service 0.6.0 → 0.7.0

data/lib/convenient_service/examples/rails/gemfile/services.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
 require_relative "services/run_shell"
+
 require_relative "services/assert_file_exists"
 require_relative "services/assert_file_not_empty"
 require_relative "services/assert_node_available"
 require_relative "services/assert_npm_package_available"
 require_relative "services/assert_valid_ruby_syntax"
-require_relative "services/read_file_content"
-require_relative "services/strip_comments"
-require_relative "services/parse_content"
-require_relative "services/print_shell_command"
 require_relative "services/format_header"
 require_relative "services/format_gems_without_envs"
 require_relative "services/format_gems_with_envs"
 require_relative "services/format_body"
+require_relative "services/merge_sections"
+require_relative "services/parse_content"
+require_relative "services/print_shell_command"
+require_relative "services/read_file_content"
+require_relative "services/replace_file_content"
+require_relative "services/strip_comments"
+
 require_relative "services/format"

data/lib/convenient_service/examples/standard/gemfile/services/format.rb

@@ -16,23 +16,62 @@ module ConvenientService
 
             attr_reader :path
 
-            step Services::ReadFileContent, in: :path, out: :content
-            step Services::StripComments, in: :content, out: :content_without_comments
-            step Services::ParseContent, in: {content: :content_without_comments}, out: :parsed_content
-            step Services::FormatHeader, in: :parsed_content, out: {formatted_content: :formatted_header_content}
-            step Services::FormatBody, in: :parsed_content, out: {formatted_content: :formatted_body_content}
+            step :validate_path,
+              in: :path
+
+            step Services::ReadFileContent,
+              in: :path,
+              out: :content
+
+            step Services::StripComments,
+              in: :content,
+              out: :content_without_comments
+
+            step Services::ParseContent,
+              in: {content: :content_without_comments},
+              out: :parsed_content
+
+            step Services::FormatHeader,
+              in: :parsed_content,
+              out: {formatted_content: :formatted_header_content}
+
+            step Services::FormatBody,
+              in: :parsed_content,
+              out: {formatted_content: :formatted_body_content}
+
+            step Services::MergeSections,
+              in: [
+                {header: :formatted_header_content},
+                {body: :formatted_body_content}
+              ],
+              out: :merged_sections
+
+            step Services::ReplaceFileContent,
+              in: [
+                :path,
+                {content: :merged_sections}
+              ]
 
             before :result do
               @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
             end
 
-            after :step do |step_result|
+            after :step do |step|
               @progressbar.increment
             end
 
             def initialize(path:)
               @path = path
             end
+
+            private
+
+            def validate_path
+              return failure(path: "Path is `nil`") if path.nil?
+              return failure(path: "Path is empty") if path.empty?
+
+              success
+            end
           end
         end
       end

data/lib/convenient_service/examples/standard/gemfile/services/merge_sections.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module Gemfile
+        module Services
+          class MergeSections
+            include ConvenientService::Standard::Config
+
+            attr_reader :header, :body
+
+            step :validate_header,
+              in: :header
+
+            step :validate_body,
+              in: :body
+
+            step :result,
+              in: [
+                :header,
+                :body
+              ]
+
+            def initialize(header:, body:)
+              @header = header
+              @body = body
+            end
+
+            def result
+              success(merged_sections: "#{header}\n#{body}")
+            end
+
+            def validate_header
+              return failure(header: "Header is `nil`") if header.nil?
+              return failure(header: "Header is empty") if header.empty?
+
+              success
+            end
+
+            def validate_body
+              return failure(body: "Body is `nil`") if body.nil?
+              return failure(body: "Body is empty") if body.empty?
+
+              success
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/gemfile/services/replace_file_content.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module Gemfile
+        module Services
+          class ReplaceFileContent
+            include ConvenientService::Standard::Config
+
+            attr_reader :path, :content
+
+            step :validate_path, in: :path
+            step :validate_content, in: :content
+            step Services::AssertFileExists, in: :path
+            step :result, in: :path
+
+            def initialize(path:, content:)
+              @path = path
+              @content = content
+            end
+
+            def result
+              ::File.write(path, content)
+
+              success
+            end
+
+            private
+
+            def validate_path
+              return failure(path: "Path is `nil`") if path.nil?
+              return failure(path: "Path is empty") if path.empty?
+
+              success
+            end
+
+            def validate_content
+              return failure(content: "Content is `nil`") if content.nil?
+
+              success
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/gemfile/services.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
 require_relative "services/run_shell"
+
 require_relative "services/assert_file_exists"
 require_relative "services/assert_file_not_empty"
 require_relative "services/assert_node_available"
 require_relative "services/assert_npm_package_available"
 require_relative "services/assert_valid_ruby_syntax"
-require_relative "services/read_file_content"
-require_relative "services/strip_comments"
-require_relative "services/parse_content"
-require_relative "services/print_shell_command"
 require_relative "services/format_header"
 require_relative "services/format_gems_without_envs"
 require_relative "services/format_gems_with_envs"
 require_relative "services/format_body"
+require_relative "services/merge_sections"
+require_relative "services/parse_content"
+require_relative "services/print_shell_command"
+require_relative "services/read_file_content"
+require_relative "services/replace_file_content"
+require_relative "services/strip_comments"
+
 require_relative "services/format"

data/lib/convenient_service/factories/arguments.rb

@@ -0,0 +1,43 @@
+# 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 Arguments
+      ##
+      # @return [Array]
+      #
+      # @example Default.
+      #
+      #   hello(*args)
+      #
+      def create_args
+        [:foo, :bar]
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   hello(**kwargs)
+      #
+      def create_kwargs
+        {foo: :bar, baz: :qux}
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   hello(&block)
+      #
+      def create_block
+        proc { :foo }
+      end
+    end
+  end
+end

data/lib/convenient_service/factories/results.rb

@@ -0,0 +1,214 @@
+# 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 Results
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success # `result` is return value
+      #     end
+      #   end
+      #
+      def create_result
+        service_class = create_service_class
+
+        service_class.result
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success # `result` is return value
+      #     end
+      #   end
+      #
+      def create_result_without_step
+        service_class = create_service_class
+
+        service_class.result
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step Step # `result` is return value
+      #   end
+      #
+      def create_result_with_step(...)
+        create_result_with_service_step(...)
+      end
+
+      ##
+      # @param service_step [Class]
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step Step # `result` is return value
+      #   end
+      #
+      # @example When `service_step` is passed.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step service_step # `result` is return value
+      #   end
+      #
+      def create_result_with_service_step(service_step: Support::NOT_PASSED)
+        service_step_class = (service_step == Support::NOT_PASSED) ? create_service_step_class : service_step
+
+        service_class = create_service_class(steps: [service_step_class])
+
+        service_class.result
+      end
+
+      ##
+      # @param method_step [Symbol]
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step :validate # `result` is return value
+      #   end
+      #
+      # @example When `method_step` is passed.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step method_step # `result` is return value
+      #   end
+      #
+      def create_result_with_method_step(method_step: Support::NOT_PASSED)
+        method_step = (method_step == Support::NOT_PASSED) ? create_method_step : method_step
+
+        service_class = create_service_class(steps: [method_step])
+
+        service_class.result
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step :result # `result` is return value
+      #   end
+      #
+      def create_result_with_result_method_step
+        service_class = create_service_class(steps: [:result])
+
+        service_class.result
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   {
+      #     service: result.service,
+      #     status: :success,
+      #     data: {foo: :bar},
+      #     message: "",
+      #     code: :default_success
+      #   }
+      #
+      def create_result_attributes
+        create_result.jsend_attributes.to_h
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   {
+      #     service: result.service,
+      #     status: :success,
+      #     data: {foo: :bar},
+      #     message: "",
+      #     code: :default_success,
+      #     parent: result.parent
+      #   }
+      #
+      def create_result_attributes_with_parent(parent: Support::NOT_PASSED)
+        parent = (parent == Support::NOT_PASSED) ? create_result_parent : parent
+
+        result_attributes = create_result_attributes
+
+        result_attributes.merge(parent: parent)
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   {
+      #     service: result.service,
+      #     status: :success,
+      #     data: {foo: :bar},
+      #     message: "",
+      #     code: :default_success,
+      #     step: result.step
+      #   }
+      #
+      def create_result_attributes_with_step(step: Support::NOT_PASSED)
+        step = (step == Support::NOT_PASSED) ? create_result_step : step
+
+        result_attributes = create_result_attributes
+
+        result_attributes.merge(step: step)
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success # `result_parent` is return value
+      #     end
+      #   end
+      #
+      def create_result_parent
+        create_result
+      end
+    end
+  end
+end

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"