convenient_service 0.11.0 → 0.13.0

data/lib/convenient_service/dependencies.rb

@@ -13,69 +13,160 @@ module ConvenientService
   module Dependencies
     class << self
       ##
+      # @api private
+      #
+      # @return [Boolean]
+      # @see ConvenientService.Dependencies.require_has_j_send_result_params_validations_using_active_model_validations
+      #
+      def support_has_j_send_result_params_validations_using_active_model_validations?
+        return false unless active_model.loaded?
+        return false if ruby.version >= 3.0 && active_model.version < 6.0
+
+        true
+      end
+
+      ##
+      # @api private
+      #
+      # @return [Boolean]
+      #
+      # @see https://github.com/ruby/logger/commit/74690b87b15244e19dd91cd06ae295251e1e5781
+      #
+      def support_logger_non_integer_levels?
+        logger.version >= "1.3.0"
+      end
+
+      ##
+      # @api public
+      #
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_alias
+        require_relative "alias"
+      end
+
+      ##
+      # @api public
+      #
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
       def require_assigns_attributes_in_constructor_using_active_model_attribute_assignment
+        ##
+        # - https://edgeguides.rubyonrails.org/active_model_basics.html
+        # - https://api.rubyonrails.org/classes/ActiveModel.html
+        # - https://github.com/rails/rails/tree/main/activemodel
+        #
         require "active_model"
 
         require_relative "common/plugins/assigns_attributes_in_constructor/using_active_model_attribute_assignment"
       end
 
       ##
+      # @api public
+      #
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
       def require_assigns_attributes_in_constructor_using_dry_initializer
+        ##
+        # - https://dry-rb.org/gems/dry-initializer/main
+        # - https://github.com/dry-rb/dry-initializer
+        #
         require "dry-initializer"
 
         require_relative "common/plugins/assigns_attributes_in_constructor/using_dry_initializer"
       end
 
       ##
+      # @api public
+      #
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_can_utilize_finite_loop
+        require_relative "common/plugins/can_utilize_finite_loop"
+      end
+
+      ##
+      # @api public
+      #
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
       def require_has_attributes_using_active_model_attributes
+        ##
+        # - https://edgeguides.rubyonrails.org/active_model_basics.html
+        # - https://api.rubyonrails.org/classes/ActiveModel.html
+        # - https://github.com/rails/rails/tree/main/activemodel
+        #
         require "active_model"
 
         require_relative "common/plugins/has_attributes/using_active_model_attributes"
       end
 
       ##
+      # @api public
+      #
       # @return [Boolean]
-      # @api private
+      # @note Expected to be called from app entry points like `initializers` in Rails.
       #
-      def support_has_result_params_validations_using_active_model_validations?
-        return false unless active_model.loaded?
-        return false if ruby.version >= 3.0 && active_model.version < 6.0
+      def require_awesome_print_inspect
+        ##
+        # - https://github.com/awesome-print/awesome_print
+        #
+        require "awesome_print"
 
-        true
+        require_relative "service/plugins/has_awesome_print_inspect"
+        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_awesome_print_inspect"
+        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_awesome_print_inspect"
+        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_awesome_print_inspect"
+        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/plugins/has_awesome_print_inspect"
+        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_awesome_print_inspect"
+        require_relative "service/plugins/can_have_steps/entities/step/plugins/has_awesome_print_inspect"
+        require_relative "configs/awesome_print_inspect"
+        require_relative "configs/awesome_print_inspect/aliases"
       end
 
       ##
+      # @api public
+      #
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
       # @see https://marian13.github.io/convenient_service_docs/troubleshooting/i18n_translate_wrong_number_of_arguments
       #
-      def require_has_result_params_validations_using_active_model_validations
+      def require_has_j_send_result_params_validations_using_active_model_validations
+        ##
+        # - https://edgeguides.rubyonrails.org/active_model_basics.html
+        # - https://api.rubyonrails.org/classes/ActiveModel.html
+        # - https://github.com/rails/rails/tree/main/activemodel
+        #
         require "active_model"
 
-        require_relative "service/plugins/has_result_params_validations/using_active_model_validations"
+        require_relative "service/plugins/has_j_send_result_params_validations/using_active_model_validations"
       end
 
       ##
+      # @api public
+      #
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
-      def require_has_result_params_validations_using_dry_validation
+      def require_has_j_send_result_params_validations_using_dry_validation
+        ##
+        # - https://dry-rb.org/gems/dry-validation/main/
+        # - https://github.com/dry-rb/dry-validation
+        #
         require "dry-validation"
 
-        require_relative "service/plugins/has_result_params_validations/using_dry_validation"
+        require_relative "service/plugins/has_j_send_result_params_validations/using_dry_validation"
       end
 
       ##
+      # @api public
+      #
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
@@ -84,115 +175,263 @@ module ConvenientService
       end
 
       ##
+      # @api public
+      #
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_cleans_exception_backtrace
+        require_relative "dependencies/extractions/active_support_backtrace_cleaner"
+      end
+
+      ##
+      # @api private
+      #
       # @return [Boolean]
       # @note Expected to be called from `irb`, `pry`, `spec_helper.rb`, etc.
       #
+      # @internal
+      #   NOTE: `byebug` has C extensions, that is why it is NOT supported in JRuby.
+      #   - https://github.com/deivid-rodriguez/byebug/tree/master/ext/byebug
+      #   - https://github.com/deivid-rodriguez/byebug/issues/179#issuecomment-152727003
+      #
       def require_development_tools
+        ##
+        # - https://github.com/awesome-print/awesome_print
+        #
         require "awesome_print"
-        require "byebug"
+
+        ##
+        # - https://github.com/gsamokovarov/break
+        #
+        require "break"
+
+        ##
+        # - https://github.com/deivid-rodriguez/byebug
+        #
+        require "byebug" unless ruby.jruby?
+
+        ##
+        # - https://github.com/ruby/debug
+        #
+        require "debug" unless ruby.jruby?
+
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/ostruct/rdoc/OpenStruct.html
+        # - https://github.com/ruby/ostruct
+        #
+        require "ostruct"
+
+        ##
+        # - https://github.com/janlelis/paint
+        #
         require "paint"
+
+        ##
+        # - https://github.com/rouge-ruby/rouge
+        #
         require "rouge"
+
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/tempfile/rdoc/Tempfile.html
+        # - https://github.com/ruby/tempfile
+        #
         require "tempfile"
 
-        require_relative "dependencies/extractions/byebug_syntax_highlighting"
-        require_relative "dependencies/extractions/b"
+        ##
+        # - https://gist.github.com/marian13/5dade20a431d7254db30e543167058ce
+        #
+        require_relative "dependencies/extractions/byebug_syntax_highlighting" unless ruby.jruby?
+
+        require_relative "dependencies/extractions/b" unless ruby.jruby?
       end
 
       ##
-      # Loads RSpec extensions like `be_success` matcher, `stub_service` helper, etc.
+      # @api private
       #
       # @return [Boolean]
       # @note Expected to be called from `spec_helper.rb`.
       #
-      def require_rspec_extentions
-        require "rspec/expectations"
-        require "rspec/matchers"
-        require "rspec/mocks"
+      def require_test_tools
+        ##
+        # - https://github.com/faker-ruby/faker
+        #
+        require "faker"
 
-        require "tempfile"
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/ostruct/rdoc/OpenStruct.html
+        # - https://github.com/ruby/ostruct
+        #
+        require "ostruct"
 
-        require_relative "rspec"
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/tempfile/rdoc/Tempfile.html
+        # - https://github.com/ruby/tempfile
+        #
+        require "tempfile"
       end
 
       ##
-      # Loads test factory.
+      # @api public
+      #
+      # Loads RSpec extensions like `be_success` matcher, `stub_service` helper, etc.
       #
       # @return [Boolean]
       # @note Expected to be called from `spec_helper.rb`.
       #
-      def require_factory
-        require "faker"
+      def require_rspec_extentions
+        require "rspec/expectations"
+        require "rspec/matchers"
+        require "rspec/mocks"
 
-        require_relative "factory"
+        require_relative "rspec"
       end
 
       ##
+      # @api private
+      #
       # Loads standard config examples.
       #
       # @return [Boolean]
-      # @api private
       #
       def require_standard_examples
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/date/rdoc/Date.html
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/date/rdoc/DateTime.html
+        # - https://github.com/ruby/date
+        #
+        require "date"
+
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
+        # - https://github.com/flori/json
+        #
         require "json"
+
+        ##
+        # - https://github.com/jfelchner/ruby-progressbar
+        #
         require "progressbar"
+
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/webrick/rdoc/WEBrick.html
+        # - https://github.com/ruby/webrick
+        #
         require "webrick"
 
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/uri/rdoc/URI.html
+        # - https://github.com/ruby/uri
+        #
+        require "uri"
+
         require_relative "examples/standard/cowsay"
-        require_relative "examples/standard/request_params"
+        require_relative "examples/standard/date_time"
+        require_relative "examples/standard/factorial"
         require_relative "examples/standard/gemfile"
+        require_relative "examples/standard/request_params"
       end
 
       ##
+      # @api private
+      #
       # Loads rails config examples.
       #
       # @return [Boolean]
-      # @api private
       #
       def require_rails_examples
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
+        # - https://github.com/flori/json
+        #
         require "json"
+
+        ##
+        # - https://github.com/jfelchner/ruby-progressbar
+        #
         require "progressbar"
+
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/webrick/rdoc/WEBrick.html
+        # - https://github.com/ruby/webrick
+        #
         require "webrick"
 
         require_relative "examples/rails/gemfile"
       end
 
       ##
+      # @api private
+      #
       # Loads dry config examples.
       #
       # @return [Boolean]
-      # @api private
       #
       def require_dry_examples
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
+        # - https://github.com/flori/json
+        #
         require "json"
+
+        ##
+        # - https://github.com/jfelchner/ruby-progressbar
+        #
         require "progressbar"
+
+        ##
+        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/webrick/rdoc/WEBrick.html
+        # - https://github.com/ruby/webrick
+        #
         require "webrick"
 
         require_relative "examples/dry/gemfile"
       end
 
       ##
-      # @return [ConvenientService::Support::Ruby]
       # @api private
       #
+      # @return [ConvenientService::Support::Ruby]
+      #
       def ruby
         Support::Ruby
       end
 
       ##
-      # @return [ConvenientService::Support::RSpec]
       # @api private
       #
+      # @return [ConvenientService::Support::RSpec]
+      #
       def rspec
         Support::Gems::RSpec
       end
 
       ##
-      # @return [ConvenientService::Support::Gems::ActiveModel]
       # @api private
       #
+      # @return [ConvenientService::Support::Gems::ActiveModel]
+      #
       def active_model
         Support::Gems::ActiveModel
       end
+
+      ##
+      # @api private
+      #
+      # @return [ConvenientService::Support::Gems::Logger]
+      #
+      def logger
+        Support::Gems::Logger
+      end
+
+      ##
+      # @api private
+      #
+      # @return [ConvenientService::Support::Gems::Paint]
+      #
+      def paint
+        Support::Gems::Paint
+      end
     end
   end
 end

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

@@ -9,34 +9,32 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         class DryService
           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::UsingDryInitializer` plugin.
-                #
-                concerns do
-                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
-                end
+              ##
+              # NOTE: `AssignsAttributesInConstructor::UsingDryInitializer` plugin.
+              #
+              concerns do
+                use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
+              end
 
-                ##
-                # NOTE: `HasResultParamsValidations::UsingDryValidation` plugin.
-                #
-                concerns do
-                  use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
-                end
+              ##
+              # NOTE: `HasJSendResultParamsValidations::UsingDryValidation` plugin.
+              #
+              concerns do
+                use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Concern
+              end
 
-                middlewares :result do
-                  insert_before \
-                    ConvenientService::Plugins::Service::HasResult::Middleware,
-                    ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
-                end
+              middlewares :result do
+                insert_before \
+                  ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
+                  ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Middleware
               end
             end
           end

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

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

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

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

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

@@ -8,7 +8,7 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class AssertNodeAvailable
             include DryService::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/dry/gemfile/services/assert_npm_package_available.rb

@@ -8,7 +8,7 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class AssertNpmPackageAvailable
             include DryService::Config
@@ -30,7 +30,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/dry/gemfile/services/assert_valid_ruby_syntax.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class AssertValidRubySyntax
             include DryService::Config
@@ -21,7 +21,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/dry/gemfile/services/format.rb

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

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

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

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

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

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

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

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

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

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

@@ -27,7 +27,7 @@
 module ConvenientService
   module Examples
     module Dry
-      module Gemfile
+      class Gemfile
         module Services
           class ParseContent
             RUBY_REGEX = /\A\s*ruby/

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