convenient_service 0.5.0 → 0.7.0

data/lib/convenient_service/dependencies.rb

@@ -106,6 +106,18 @@ module ConvenientService
         require_relative "rspec"
       end
 
+      ##
+      # Loads test factory.
+      #
+      # @return [Boolean]
+      # @note Expected to be called from `spec_helper.rb`.
+      #
+      def require_factory
+        require "faker"
+
+        require_relative "factory"
+      end
+
       ##
       # Loads standard config examples.
       #
@@ -113,9 +125,12 @@ module ConvenientService
       # @api private
       #
       def require_standard_examples
+        require "json"
         require "progressbar"
+        require "webrick"
 
         require_relative "examples/standard/cowsay"
+        require_relative "examples/standard/request_params"
         require_relative "examples/standard/gemfile"
       end
 
@@ -126,7 +141,9 @@ module ConvenientService
       # @api private
       #
       def require_rails_examples
+        require "json"
         require "progressbar"
+        require "webrick"
 
         require_relative "examples/rails/gemfile"
       end
@@ -138,7 +155,9 @@ module ConvenientService
       # @api private
       #
       def require_dry_examples
+        require "json"
         require "progressbar"
+        require "webrick"
 
         require_relative "examples/dry/gemfile"
       end

data/lib/convenient_service/examples/dry/gemfile/dry_service/config.rb

@@ -12,7 +12,9 @@ module ConvenientService
       module Gemfile
         class DryService
           module Config
-            def self.included(service_class)
+            include Support::Concern
+
+            included do |service_class|
               service_class.class_exec do
                 include Configs::Standard
 
@@ -32,7 +34,7 @@ module ConvenientService
 
                 middlewares :result do
                   insert_before \
-                    Plugins::Service::HasResultSteps::Middleware,
+                    Plugins::Service::HasResult::Middleware,
                     Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
                 end
               end

data/lib/convenient_service/examples/rails/gemfile/rails_service/config.rb

@@ -12,7 +12,9 @@ module ConvenientService
       module Gemfile
         class RailsService
           module Config
-            def self.included(service_class)
+            include Support::Concern
+
+            included do |service_class|
               service_class.class_exec do
                 include Configs::Standard
 
@@ -43,7 +45,7 @@ module ConvenientService
 
                 middlewares :result do
                   insert_before \
-                    Plugins::Service::HasResultSteps::Middleware,
+                    Plugins::Service::HasResult::Middleware,
                     Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
                 end
               end

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

@@ -16,17 +16,46 @@ module ConvenientService
 
             attribute :path, :string
 
-            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}
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            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
           end

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

@@ -38,8 +38,7 @@ module ConvenientService
             #
             # TODO: Implement custom types.
             #
-            attr_accessor :parsed_content
-
+            attribute :parsed_content
             attribute :skip_frozen_string_literal, :boolean, default: false
 
             def result

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class MergeSections
+            include RailsService::Config
+
+            attribute :header, :string
+            attribute :body, :string
+
+            validates :header, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :body, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            def result
+              success(merged_sections: "#{header}\n#{body}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class ReplaceFileContent
+            include RailsService::Config
+
+            attribute :path, :string
+            attribute :content, :string
+
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            validate :content_not_nil if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            step Services::AssertFileExists, in: :path
+            step :result, in: :path
+
+            def result
+              ::File.write(path, content)
+
+              success
+            end
+
+            private
+
+            def content_not_nil
+              errors.add(:content, "can't be nil") if content.nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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/examples/standard/request_params/constants.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Constants
+          module Tags
+            EMPTY = ""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/description.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Description
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/format.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Format
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/id.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          ##
+          # TODO: https://ruby-doc.org/3.1.3/stdlibs/yaml/YAML/DBM.html
+          #
+          class ID
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String, ::Integer
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_i
+              value.to_i
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/logger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Logger
+            class << self
+              def log(message, out: $stdout)
+                out.puts message
+
+                message
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Request
+            attr_reader :http_string
+
+            def initialize(http_string:)
+              @http_string = http_string
+            end
+
+            def to_s
+              http_string
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/source.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Source
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end