convenient_service 0.12.0 → 0.13.0

data/lib/convenient_service/examples/dry/gemfile/services/print_shell_command.rb

@@ -8,25 +8,32 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class PrintShellCommand
             include DryService::Config
 
-            option :text
+            option :command
+            option :skip, default: -> { false }
             option :out, default: -> { $stdout }
 
             contract do
               schema do
-                required(:text).filled(:string)
+                required(:command).filled(:string)
               end
             end
 
             def result
+              return error("Printing of shell command `#{command}` is skipped") if skip
+
               out.puts
 
-              out.puts ::Paint["$ #{text}", :blue, :bold]
+              out.puts ::Paint["$ #{command}", :blue, :bold]
+
+              success
+            end
 
+            def fallback_result
               success
             end
           end

data/lib/convenient_service/examples/dry/gemfile/services/read_file_content.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class ReadFileContent
             include DryService::Config

data/lib/convenient_service/examples/dry/gemfile/services/{run_shell.rb → run_shell_command.rb}

@@ -3,9 +3,9 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
-          class RunShell
+          class RunShellCommand
             include DryService::Config
 
             option :command
@@ -18,11 +18,16 @@ module ConvenientService
               end
             end
 
-            def result
-              Services::PrintShellCommand.result(text: command) if debug
+            step Services::PrintShellCommand,
+              in: [:command, {skip: -> { !debug }}],
+              fallback: true
+
+            step :result,
+              in: :command
 
+            def result
               ##
-              # NOTE: When the command exit code is 0, `system` return true, and false otherwise.
+              # NOTE: When the command exit code is 0, `system` return `true`, and `false` otherwise.
               # - https://ruby-doc.org/core-3.1.2/Kernel.html#method-i-system
               # - https://stackoverflow.com/a/37329716/12201472
               #

data/lib/convenient_service/examples/dry/gemfile/services/strip_comments.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class StripComments
             include DryService::Config
@@ -24,7 +24,7 @@ module ConvenientService
             alias_method :content_with_comments, :content
 
             step Services::AssertNpmPackageAvailable, in: {name: -> { "strip-comments" }}
-            step Services::RunShell, in: {command: -> { "node -e '#{js_script}' #{file_with_comments.path} #{file_without_comments.path}" }}
+            step Services::RunShellCommand, in: {command: -> { "node -e '#{js_script}' #{file_with_comments.path} #{file_without_comments.path}" }}
             step :result, in: :file_without_comments, out: :content_without_comments
 
             def result

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "services/run_shell"
+require_relative "services/print_shell_command"
+require_relative "services/run_shell_command"
+
 require_relative "services/assert_file_exists"
 require_relative "services/assert_file_not_empty"
 require_relative "services/assert_node_available"
@@ -9,7 +11,6 @@ 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"

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

@@ -13,7 +13,7 @@ require_relative "gemfile/services"
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         include ConvenientService::Feature
 
         entry :format do |path|

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

@@ -9,45 +9,43 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         class RailsService
           module Config
             include Support::Concern
 
-            included do |service_class|
-              service_class.class_exec do
-                include ConvenientService::Standard::Config
+            included do
+              include ConvenientService::Standard::Config
 
-                ##
-                # NOTE: `AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment` plugin.
-                #
-                concerns do
-                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
-                end
+              ##
+              # NOTE: `AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment` plugin.
+              #
+              concerns do
+                use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
+              end
 
-                middlewares :initialize do
-                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
-                end
+              middlewares :initialize do
+                use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
+              end
 
-                ##
-                # NOTE: `HasAttributes::UsingActiveModelAttributes` plugin.
-                #
-                concerns do
-                  use ConvenientService::Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
-                end
+              ##
+              # NOTE: `HasAttributes::UsingActiveModelAttributes` plugin.
+              #
+              concerns do
+                use ConvenientService::Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
+              end
 
-                ##
-                # NOTE: `HasResultParamsValidations::UsingActiveModelValidations` plugin.
-                #
-                concerns do
-                  use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
-                end
+              ##
+              # NOTE: `HasJSendResultParamsValidations::UsingActiveModelValidations` plugin.
+              #
+              concerns do
+                use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingActiveModelValidations::Concern
+              end
 
-                middlewares :result do
-                  insert_before \
-                    ConvenientService::Plugins::Service::HasResult::Middleware,
-                    ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
-                end
+              middlewares :result do
+                insert_before \
+                  ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
+                  ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingActiveModelValidations::Middleware
               end
             end
           end

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

@@ -3,14 +3,14 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class AssertFileExists
             include RailsService::Config
 
             attribute :path, :string
 
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             def result
               return error("File with path `#{path}` does NOT exist") unless ::File.exist?(path)

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

@@ -3,14 +3,14 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class AssertFileNotEmpty
             include RailsService::Config
 
             attribute :path, :string
 
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             def result
               return error(message: "File with path `#{path}` is empty") if ::File.zero?(path)

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

@@ -8,7 +8,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class AssertNodeAvailable
             include RailsService::Config
@@ -17,7 +17,7 @@ module ConvenientService
             # NOTE: `> /dev/null 2>&1` is used to hide output.
             # https://unix.stackexchange.com/a/119650/394253
             #
-            step Services::RunShell, in: {command: -> { "which node > /dev/null 2>&1" }}
+            step Services::RunShellCommand, in: {command: -> { "which node > /dev/null 2>&1" }}
           end
         end
       end

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

@@ -8,14 +8,14 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class AssertNpmPackageAvailable
             include RailsService::Config
 
             attribute :name, :string
 
-            validates :name, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :name, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             step Services::AssertNodeAvailable
 
@@ -26,7 +26,7 @@ module ConvenientService
             # NOTE: For `npm list` and its options docs, see
             # https://docs.npmjs.com/cli/v7/commands/npm-ls
             #
-            step Services::RunShell, in: {command: -> { "npm list #{name} --depth=0 > /dev/null 2>&1" }}
+            step Services::RunShellCommand, in: {command: -> { "npm list #{name} --depth=0 > /dev/null 2>&1" }}
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class AssertValidRubySyntax
             include RailsService::Config
@@ -15,7 +15,7 @@ module ConvenientService
               # NOTE: `> /dev/null 2>&1` is used to hide output.
               # https://unix.stackexchange.com/a/119650/394253
               #
-              check_ruby_syntax_result = Services::RunShell.result(command: "ruby -c #{file.path} > /dev/null 2>&1")
+              check_ruby_syntax_result = Services::RunShellCommand.result(command: "ruby -c #{file.path} > /dev/null 2>&1")
 
               return error("`#{content}` contains invalid Ruby syntax") unless check_ruby_syntax_result.success?
 

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

@@ -9,14 +9,14 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class Format
             include RailsService::Config
 
             attribute :path, :string
 
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             step Services::ReadFileContent,
               in: :path,

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

@@ -43,7 +43,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class FormatBody
             include RailsService::Config

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

@@ -31,7 +31,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class FormatGemsWithEnvs
             BLOCK_END = "end"

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

@@ -35,7 +35,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class FormatGemsWithoutEnvs
             EMPTY_LINE = ""

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

@@ -23,7 +23,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class FormatHeader
             FROZEN_STRING_LITERAL = "# frozen_string_literal: true"

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class MergeSections
             include RailsService::Config
@@ -11,8 +11,8 @@ module ConvenientService
             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?
+            validates :header, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
+            validates :body, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             def result
               success(merged_sections: "#{header}\n#{body}")

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

@@ -27,7 +27,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class ParseContent
             RUBY_REGEX = /\A\s*ruby/
@@ -42,7 +42,7 @@ module ConvenientService
 
             attribute :content, :string
 
-            validates :content, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :content, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             step Services::AssertValidRubySyntax, in: :content
             step :result, in: :content, out: :parsed_content

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

@@ -8,21 +8,28 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class PrintShellCommand
             include RailsService::Config
 
-            attribute :text, :string
+            attribute :command, :string
+            attribute :skip, :boolean, default: false
             attribute :out, default: $stdout
 
-            validates :text, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :command, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             def result
+              return error("Printing of shell command `#{command}` is skipped") if skip
+
               out.puts
 
-              out.puts ::Paint["$ #{text}", :blue, :bold]
+              out.puts ::Paint["$ #{command}", :blue, :bold]
+
+              success
+            end
 
+            def fallback_result
               success
             end
           end

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

@@ -3,14 +3,14 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class ReadFileContent
             include RailsService::Config
 
             attribute :path, :string
 
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             step Services::AssertFileExists, in: :path
             step Services::AssertFileNotEmpty, in: :path

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class ReplaceFileContent
             include RailsService::Config
@@ -11,9 +11,9 @@ module ConvenientService
             attribute :path, :string
             attribute :content, :string
 
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
-            validate :content_not_nil if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validate :content_not_nil if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             step Services::AssertFileExists, in: :path
             step :result, in: :path

data/lib/convenient_service/examples/rails/gemfile/services/{run_shell.rb → run_shell_command.rb}

@@ -3,21 +3,26 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
-          class RunShell
+          class RunShellCommand
             include RailsService::Config
 
             attribute :command, :string
             attribute :debug, :boolean, default: false
 
-            validates :command, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :command, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
-            def result
-              Services::PrintShellCommand.result(text: command) if debug
+            step Services::PrintShellCommand,
+              in: [:command, {skip: -> { !debug }}],
+              fallback: true
+
+            step :result,
+              in: :command
 
+            def result
               ##
-              # NOTE: When the command exit code is 0, `system` return true, and false otherwise.
+              # NOTE: When the command exit code is 0, `system` return `true`, and `false` otherwise.
               # - https://ruby-doc.org/core-3.1.2/Kernel.html#method-i-system
               # - https://stackoverflow.com/a/37329716/12201472
               #

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

@@ -8,19 +8,19 @@
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         module Services
           class StripComments
             include RailsService::Config
 
             attribute :content, :string
 
-            validates :content, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :content, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
 
             alias_method :content_with_comments, :content
 
             step Services::AssertNpmPackageAvailable, in: {name: -> { "strip-comments" }}
-            step Services::RunShell, in: {command: -> { "node -e '#{js_script}' #{file_with_comments.path} #{file_without_comments.path}" }}
+            step Services::RunShellCommand, in: {command: -> { "node -e '#{js_script}' #{file_with_comments.path} #{file_without_comments.path}" }}
             step :result, in: :file_without_comments, out: :content_without_comments
 
             def result

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "services/run_shell"
+require_relative "services/print_shell_command"
+require_relative "services/run_shell_command"
 
 require_relative "services/assert_file_exists"
 require_relative "services/assert_file_not_empty"
@@ -13,7 +14,6 @@ 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"

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

@@ -13,7 +13,7 @@ require_relative "gemfile/services"
 module ConvenientService
   module Examples
     module Rails
-      module Gemfile
+      class Gemfile
         include ConvenientService::Feature
 
         entry :format do |path|

data/lib/convenient_service/examples/standard/cowsay/services/build_cloud.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module Cowsay
+      class Cowsay
         module Services
           class BuildCloud
             include ConvenientService::Standard::Config

data/lib/convenient_service/examples/standard/cowsay/services/build_cow.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module Cowsay
+      class Cowsay
         module Services
           class BuildCow
             include ConvenientService::Standard::Config

data/lib/convenient_service/examples/standard/cowsay/services/print.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module Cowsay
+      class Cowsay
         module Services
           class Print
             include ConvenientService::Standard::Config

data/lib/convenient_service/examples/standard/cowsay.rb

@@ -12,7 +12,7 @@ require_relative "cowsay/services"
 module ConvenientService
   module Examples
     module Standard
-      module Cowsay
+      class Cowsay
         include ConvenientService::Feature
 
         entry :print do |text = "Hello World!", out: $stdout|

data/lib/convenient_service/examples/standard/date_time/services/safe_parse.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      class DateTime
+        module Services
+          class SafeParse
+            include ConvenientService::Standard::Config
+
+            attr_reader :string, :format
+
+            def initialize(string:, format:)
+              @string = string
+              @format = format
+            end
+
+            def result
+              success(date_time: ::DateTime.strptime(string, format))
+            rescue ::Date::Error => exception
+              failure(
+                data: {exception: exception},
+                message: "Failed to parse `DateTime` object from `#{string}` with `#{format}`"
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "services/safe_parse"