convenient_service 0.12.0 → 0.14.0

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,13 +42,13 @@ 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
 
             def result
-              success(data: {parsed_content: parse_content})
+              success(parsed_content: parse_content)
             end
 
             def parse_content

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

@@ -3,26 +3,33 @@
 ##
 # Usage example:
 #
-#   ConvenientService::Examples::Rails::Gemfile::Services::PrintShellCommand.result(text: "ls -a")
+#   ConvenientService::Examples::Rails::Gemfile::Services::PrintShellCommand.result(command: "ls -a")
 #
 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 failure("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_failure_result
               success
             end
           end

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

@@ -3,21 +3,21 @@
 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
             step :result, in: :path, out: :content
 
             def result
-              success(data: {content: ::File.read(path)})
+              success(content: ::File.read(path))
             end
           end
         end

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,28 +3,33 @@
 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
               #
               if system(command)
                 success
               else
-                error(message: "#{command} returned non-zero exit code")
+                error("#{command} returned non-zero exit code")
               end
             end
           end

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

@@ -8,23 +8,23 @@
 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
-              success(data: {content_without_comments: file_without_comments.read})
+              success(content_without_comments: file_without_comments.read)
             end
 
             ##

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/rails/v1/gemfile/rails_service/config.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Rails::V1::Gemfile.format(path: "Gemfile")
+# result = ConvenientService::Examples::Rails::V1::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          class RailsService
+            module Config
+              include Support::Concern
+
+              included do
+                include ConvenientService::Standard::V1::Config
+
+                ##
+                # 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
+
+                ##
+                # NOTE: `HasAttributes::UsingActiveModelAttributes` plugin.
+                #
+                concerns do
+                  use ConvenientService::Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
+                end
+
+                ##
+                # NOTE: `HasJSendResultParamsValidations::UsingActiveModelValidations` plugin.
+                #
+                concerns do
+                  use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingActiveModelValidations::Concern
+                end
+
+                middlewares :result do
+                  insert_before \
+                    ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
+                    ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingActiveModelValidations::Middleware.with(status: :failure)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rails_service/config"

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          module Services
+            class AssertFileExists
+              include RailsService::Config
+
+              attribute :path, :string
+
+              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)
+
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          module Services
+            class AssertFileNotEmpty
+              include RailsService::Config
+
+              attribute :path, :string
+
+              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)
+
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Rails::V1::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          module Services
+            class AssertNpmPackageAvailable
+              include RailsService::Config
+
+              attribute :name, :string
+
+              validates :name, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
+
+              step Services::AssertNodeAvailable
+
+              ##
+              # NOTE: `> /dev/null 2>&1` is used to hide output.
+              # https://unix.stackexchange.com/a/119650/394253
+              #
+              # NOTE: For `npm list` and its options docs, see
+              # https://docs.npmjs.com/cli/v7/commands/npm-ls
+              #
+              step Services::RunShellCommand, in: {command: -> { "npm list #{name} --depth=0 > /dev/null 2>&1" }}
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          module Services
+            class AssertValidRubySyntax
+              include RailsService::Config
+
+              attribute :content, :string
+
+              def result
+                ##
+                # NOTE: `> /dev/null 2>&1` is used to hide output.
+                # https://unix.stackexchange.com/a/119650/394253
+                #
+                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?
+
+                success
+              end
+
+              private
+
+              def file
+                @file ||= ::Tempfile.new.tap { |tempfile| tempfile.write(content) }.tap(&:close)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::Format.result(path: "Gemfile")
+# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          module Services
+            class Format
+              include RailsService::Config
+
+              attribute :path, :string
+
+              validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_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|
+                @progressbar.increment
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::FormatBody.result(
+#   parsed_content: {
+#     gems: [
+#       {
+#         envs: [],
+#         line: %(gem "bootsnap", ">= 1.4.4", require: false)
+#       },
+#       {
+#         envs: [],
+#         line: %(gem "pg")
+#       },
+#       {
+#         envs: [:development],
+#         line: %(gem "listen", "~> 3.3")
+#       },
+#       {
+#         envs: [:development],
+#         line: %(gem "web-console", ">= 4.1.0")
+#       },
+#       {
+#         envs: [:development, :test],
+#         line: %(gem "rspec-rails")
+#       },
+#       {
+#         envs: [:test],
+#         line: %(gem "simplecov", require: false)
+#       },
+#       {
+#         envs: [],
+#         line: %(gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby])
+#       }
+#     ]
+#   }
+# )
+#
+# NOTE: Check the corresponding spec file to see more examples.
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module V1
+        class Gemfile
+          module Services
+            class FormatBody
+              include RailsService::Config
+
+              attr_accessor :parsed_content
+
+              step Services::FormatGemsWithoutEnvs,
+                in: :parsed_content,
+                out: [{formatted_content: :formatted_gems_without_envs_content}]
+
+              step Services::FormatGemsWithEnvs,
+                in: :parsed_content,
+                out: [{formatted_content: :formatted_gems_with_envs_content}]
+
+              step :result,
+                in: [:formatted_gems_without_envs_content, :formatted_gems_with_envs_content],
+                out: :formatted_content
+
+              def result
+                success(formatted_content: format_content)
+              end
+
+              private
+
+              def format_content
+                [formatted_gems_without_envs_content, formatted_gems_with_envs_content].reject(&:empty?).join("\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end