convenient_service 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4686692f187c6eed32b5bab389f30e138aa547050234676d4cd25271c451287b
-  data.tar.gz: c3c7ac1895761d5abb36b6783a4fcaa1167117efc6c42813a201f0e4c64defa1
+  metadata.gz: 86314358470fd8502e3b00853f6f0aed31fe7837fe879b8a6fe9b02b23a37055
+  data.tar.gz: 8c7ddbfa504ef02c2774bbc4c616297345b684320ed0e4b4b10134f2a8851c24
 SHA512:
-  metadata.gz: 336c3065ee969a78debe0824585deb22940b96257a3109c663a4348469da28740478bded21dffae4750b1e9889cb839ea2558591c14d81109f873d7929f57a8d
-  data.tar.gz: bb8a77dacf096fdb7451d70b5d484d1ecdb074bce0fbbe3faace722e52c6ba39a48b17ef52dfc2fc3252f93b9623182e6b5157e93b444509eb559dd947cbd6af
+  metadata.gz: 59dc4c6936c9764718dd105ef24255e89a21397b56770460850fa38365c37d0a4ba7d97bba924c72906f2ba27fc6b66b3981e9f1682a43c22f245e6daa811627
+  data.tar.gz: bc6942d0091fe8805164bfb01b00ed09c2be71ae0ea2838d2958331844053984309600f15151cb33fe261bc76913eed1f5299898b2e95df696020ab5a92e4d9d

data/.gitignore

@@ -50,3 +50,8 @@
 # Check `HasMermaidFlowchart` for details.
 #
 flowchart.html
+
+##
+# NOTE: Ignores `TODO.md`. Usually, this file is used for notes that are NOT ready to be shared with the outside world.
+#
+TODO.md

data/.vscode/CacheItsValue.code-snippets

@@ -8,7 +8,7 @@
     "scope": "ruby",
     "prefix": "CacheItsValue",
     "body": [
-      "include ConvenientService::RSpec::Matchers::CacheItsValue",
+      "include ConvenientService::RSpec::PrimitiveMatchers::CacheItsValue",
     ],
     "description": "`CacheItsValue` - a module that allows to use custom RSpec matcher `cache_its_value` to verify caching"
   }

data/.yardopts

@@ -1,4 +1,6 @@
 ##
+# NOTE: This config is used by `task docs:generate`.
+#
 # NOTE: `.yardopts` docs.
 # https://rubydoc.info/gems/yard/YARD/CLI/Yardoc
 #
@@ -9,5 +11,6 @@
 --markup-provider commonmarker
 --output-dir docs
 --tag internal --hide-tag internal
+--plugin convenient_service_concern
 'lib/**/*.rb' -
 README.md

data/CHANGELOG.md

@@ -1,5 +1,72 @@
 # Changelog
 
+## [0.15.0](https://github.com/marian13/convenient_service/compare/v0.14.0...v0.15.0) (2023-11-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* **feature:** allow to use plugins for features
+
+### Features
+
+* **can_have_steps:** do not allow to modify steps from callbacks ([b90b7f7](https://github.com/marian13/convenient_service/commit/b90b7f7b5ba7b9cb12151d02495d1ad1c230504e))
+* **feature:** allow to use plugins for features ([17645f8](https://github.com/marian13/convenient_service/commit/17645f888849b5cb42c2ae45aa8430cb96e28eff))
+
+
+### Bug Fixes
+
+* **can_have_steps:** introduce raises_on_not_result_return_value for steps ([bb27527](https://github.com/marian13/convenient_service/commit/bb27527b708747df356980cf831c660757fb4093))
+
+
+### Miscellaneous Chores
+
+* release 0.15.0 ([7f6a6a7](https://github.com/marian13/convenient_service/commit/7f6a6a74b722eaf26ae7195351a9078c944032dd))
+
+## [0.14.0](https://github.com/marian13/convenient_service/compare/v0.13.0...v0.14.0) (2023-09-20)
+
+
+### ⚠ BREAKING CHANGES
+
+* **has_j_send_result_params_validations:** return errors on validation issues
+* **has_j_send_result_params_validations:** return errors on validation issues
+* **can_have_fallbacks:** fallback only failures by default
+* **be_result:** update got part
+* **has_j_send_result_short:** update constants
+* **fallbacks:** create separate fallbacks failures and errors, run only error fallback when true
+
+### Features
+
+* **be_result:** introduce be_result ([f8fc85b](https://github.com/marian13/convenient_service/commit/f8fc85bb9141851c130a040731e4bb99114050d2))
+* **can_have_fallbacks:** allow to pass fallback_true_status ([584dabe](https://github.com/marian13/convenient_service/commit/584dabe83f87c2d794ea779a3e5c7f0b0ea97f65))
+* **can_have_fallbacks:** fallback only failures by default ([58650a7](https://github.com/marian13/convenient_service/commit/58650a736be0a4daaf283c6eef9e0867a34d44d4))
+* **configs:** create copy of v1 ([bb039c8](https://github.com/marian13/convenient_service/commit/bb039c83f53607c4cf59f634c662fc604f13ff7b))
+* **examples:** create copy of v1 ([70bd3fe](https://github.com/marian13/convenient_service/commit/70bd3febc4a88ebe7e7c3d33c7dd2e1c03331ccb))
+* **has_awesome_print_inspect:** add message and data keys ([14e0a3f](https://github.com/marian13/convenient_service/commit/14e0a3f088edf8ea8565ba7ff06ca0212c4116e9))
+* **has_inspect:** add message and data keys ([8f30b7a](https://github.com/marian13/convenient_service/commit/8f30b7a905b8a953d514061ed381a404b65c81af))
+* **has_j_send_result_params_validations:** return errors on validation issues ([e25e1a4](https://github.com/marian13/convenient_service/commit/e25e1a4f94cc309035533220dbcfbfccbb94cc94))
+* **has_j_send_result_params_validations:** return errors on validation issues ([09a9b94](https://github.com/marian13/convenient_service/commit/09a9b948070f3132818d1da9ef009d1d15655ab9))
+* **has_j_send_result_short_syntax:** allow to pass data, message, code to all results ([aabf2f9](https://github.com/marian13/convenient_service/commit/aabf2f98d32407616159cbcd2bcc6349a9a3b98f))
+* **has_j_send_result_short_syntax:** allow to pass message and code to short form of error ([1af3153](https://github.com/marian13/convenient_service/commit/1af3153aa1bf385eadcf73f30e13a3cc5126d793))
+* **has_j_send_result_short_syntax:** allow to pass message and code to short form of failure ([7390630](https://github.com/marian13/convenient_service/commit/73906300f94ec6488f312d4a611f433d8c850691))
+* **has_j_send_result_short_syntax:** allow to pass message and code to short form of success ([fdf2ab2](https://github.com/marian13/convenient_service/commit/fdf2ab23ade8941ed2c6dd10d17769eaebecc855))
+* **has_j_send_status_and_attributes:** introduce Data#keys ([27f43e1](https://github.com/marian13/convenient_service/commit/27f43e1594988cc523e9bb3608e90a40e4c2b442))
+* **has_j_send_status_and_attributes:** introduce Message#empty? ([6c1452d](https://github.com/marian13/convenient_service/commit/6c1452d99d71be45bb6cb95159a2fd32ffca668e))
+* **rescues_result_unhandled_exceptions:** allow to pass status ([2ef85f2](https://github.com/marian13/convenient_service/commit/2ef85f2970dd56802bd22f467529da6242faf967))
+* **using_active_model_validations:** allow to pass status to middleware ([bc5bb70](https://github.com/marian13/convenient_service/commit/bc5bb7027fe94724a8d28a3770b68c731b37ff10))
+* **using_dry_validation:** allow to pass status to middleware ([3a5ef12](https://github.com/marian13/convenient_service/commit/3a5ef120219a8a94b1d15bb7226f265db967ce9e))
+
+
+### Miscellaneous Chores
+
+* release 0.14.0 ([c7cef07](https://github.com/marian13/convenient_service/commit/c7cef0721d8360329c19b8ad4d636bcec83805c6))
+
+
+### Code Refactoring
+
+* **be_result:** update got part ([428280a](https://github.com/marian13/convenient_service/commit/428280a8eb2aed09f49bd949f84b7e10ef933708))
+* **fallbacks:** create separate fallbacks failures and errors, run only error fallback when true ([bbab564](https://github.com/marian13/convenient_service/commit/bbab5647d09ecdba9c9727bef3e2dc6b8138710b))
+* **has_j_send_result_short:** update constants ([2074acd](https://github.com/marian13/convenient_service/commit/2074acd001115dd4c60d432e71a4fef58794c881))
+
 ## 0.13.0 (2023-08-27)
 
 

data/README.md

@@ -38,7 +38,7 @@ Yet another approach to revisit the service object pattern, but this time focusi
 <!-- general_description:end -->
 
 <!-- warning:start -->
-## WARNING ❗❗❗
+## ❗❗❗ WARNING ❗❗❗
 
 This library is under heavy development. Public API may be subject to change. The first major release is still to come. Use the current version at your own risk. Ruby 2.7+, JRuby 9.4+ (TruffleRuby support is planned as well). Thanks.
 <!-- features:end -->

data/Taskfile.yml

@@ -339,7 +339,13 @@ tasks:
   #
   docs:generate:
     cmds:
-      - bundle exec yardoc
+      ##
+      # NOTE: yard supports plugins as gems only.
+      # - https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#plugin-support
+      #
+      # NOTE: `RUBYLIB` is used to extend Ruby's `$LOAD_PATH`. This way yard treats `./yard` folder as a directory with custom gems.
+      #
+      - RUBYLIB=./yard bundle exec yardoc
 
   docs:generate:open:
     cmds:
@@ -664,4 +670,10 @@ tasks:
   yard_junk:
     cmds:
       - mkdir -p docs
-      - bundle exec yard-junk --text --html docs/junk-yard.html
+      ##
+      # NOTE: yard supports plugins as gems only.
+      # - https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#plugin-support
+      #
+      # NOTE: `RUBYLIB` is used to extend Ruby's `$LOAD_PATH`. This way yard treats `./yard` folder as a directory with custom gems.
+      #
+      - RUBYLIB=./yard bundle exec yard-junk --text --html docs/junk-yard.html

data/lib/convenient_service/dependencies.rb

@@ -125,8 +125,8 @@ module ConvenientService
         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"
+        require_relative "service/configs/awesome_print_inspect"
+        require_relative "service/configs/awesome_print_inspect/aliases"
       end
 
       ##
@@ -292,9 +292,10 @@ module ConvenientService
       #
       # Loads standard config examples.
       #
+      # @param version [String]
       # @return [Boolean]
       #
-      def require_standard_examples
+      def require_standard_examples(version: "")
         ##
         # - 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
@@ -325,11 +326,11 @@ module ConvenientService
         #
         require "uri"
 
-        require_relative "examples/standard/cowsay"
-        require_relative "examples/standard/date_time"
-        require_relative "examples/standard/factorial"
-        require_relative "examples/standard/gemfile"
-        require_relative "examples/standard/request_params"
+        require_relative ::File.join("examples", "standard", version, "cowsay")
+        require_relative ::File.join("examples", "standard", version, "date_time")
+        require_relative ::File.join("examples", "standard", version, "factorial")
+        require_relative ::File.join("examples", "standard", version, "gemfile")
+        require_relative ::File.join("examples", "standard", version, "request_params")
       end
 
       ##
@@ -337,9 +338,10 @@ module ConvenientService
       #
       # Loads rails config examples.
       #
+      # @param version [String]
       # @return [Boolean]
       #
-      def require_rails_examples
+      def require_rails_examples(version: "")
         ##
         # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
         # - https://github.com/flori/json
@@ -357,7 +359,7 @@ module ConvenientService
         #
         require "webrick"
 
-        require_relative "examples/rails/gemfile"
+        require_relative ::File.join("examples", "rails", version, "gemfile")
       end
 
       ##
@@ -365,9 +367,10 @@ module ConvenientService
       #
       # Loads dry config examples.
       #
+      # @param version [String]
       # @return [Boolean]
       #
-      def require_dry_examples
+      def require_dry_examples(version: "")
         ##
         # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
         # - https://github.com/flori/json
@@ -385,7 +388,7 @@ module ConvenientService
         #
         require "webrick"
 
-        require_relative "examples/dry/gemfile"
+        require_relative ::File.join("examples", "dry", version, "gemfile")
       end
 
       ##

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

@@ -17,7 +17,7 @@ module ConvenientService
             end
 
             def result
-              return error("File with path `#{path}` does NOT exist") unless ::File.exist?(path)
+              return failure("File with path `#{path}` does NOT exist") unless ::File.exist?(path)
 
               success
             end

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

@@ -17,7 +17,7 @@ module ConvenientService
             end
 
             def result
-              return error(message: "File with path `#{path}` is empty") if ::File.zero?(path)
+              return failure("File with path `#{path}` is empty") if ::File.zero?(path)
 
               success
             end

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

@@ -52,7 +52,7 @@ module ConvenientService
             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/dry/gemfile/services/print_shell_command.rb

@@ -3,7 +3,7 @@
 ##
 # Usage example:
 #
-#   ConvenientService::Examples::Dry::Gemfile::Services::PrintShellCommand.result(text: "ls -a")
+#   ConvenientService::Examples::Dry::Gemfile::Services::PrintShellCommand.result(command: "ls -a")
 #
 module ConvenientService
   module Examples
@@ -24,7 +24,7 @@ module ConvenientService
             end
 
             def result
-              return error("Printing of shell command `#{command}` is skipped") if skip
+              return failure("Printing of shell command `#{command}` is skipped") if skip
 
               out.puts
 
@@ -33,7 +33,7 @@ module ConvenientService
               success
             end
 
-            def fallback_result
+            def fallback_failure_result
               success
             end
           end

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

@@ -21,7 +21,7 @@ module ConvenientService
             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/dry/gemfile/services/run_shell_command.rb

@@ -34,7 +34,7 @@ module ConvenientService
               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/dry/gemfile/services/strip_comments.rb

@@ -28,7 +28,7 @@ module ConvenientService
             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
 
             private

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

@@ -14,7 +14,7 @@ module ConvenientService
   module Examples
     module Dry
       class Gemfile
-        include ConvenientService::Feature
+        include ConvenientService::Feature::Standard::Config
 
         entry :format do |path|
           Services::Format[path: path]

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::V1::Gemfile.format(path: "Gemfile")
+# result = ConvenientService::Examples::Dry::V1::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          class DryService
+            module Config
+              include Support::Concern
+
+              included do
+                include ConvenientService::Standard::V1::Config
+
+                ##
+                # NOTE: `AssignsAttributesInConstructor::UsingDryInitializer` plugin.
+                #
+                concerns do
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
+                end
+
+                ##
+                # NOTE: `HasJSendResultParamsValidations::UsingDryValidation` plugin.
+                #
+                concerns do
+                  use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Concern
+                end
+
+                middlewares :result do
+                  insert_before \
+                    ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
+                    ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Middleware.with(status: :failure)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          module Services
+            class AssertFileExists
+              include DryService::Config
+
+              option :path
+
+              contract do
+                schema do
+                  required(:path).filled(:string)
+                end
+              end
+
+              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/dry/v1/gemfile/services/assert_file_not_empty.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          module Services
+            class AssertFileNotEmpty
+              include DryService::Config
+
+              option :path
+
+              contract do
+                schema do
+                  required(:path).filled(:string)
+                end
+              end
+
+              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/dry/v1/gemfile/services/assert_node_available.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Dry::V1::Gemfile::Services::AssertNodeAvailable.result
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          module Services
+            class AssertNodeAvailable
+              include DryService::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/dry/v1/gemfile/services/assert_npm_package_available.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Dry::V1::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          module Services
+            class AssertNpmPackageAvailable
+              include DryService::Config
+
+              option :name
+
+              contract do
+                schema do
+                  required(:name).filled(:string)
+                end
+              end
+
+              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/dry/v1/gemfile/services/assert_valid_ruby_syntax.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          module Services
+            class AssertValidRubySyntax
+              include DryService::Config
+
+              option :content
+
+              contract do
+                schema do
+                  required(:content).value(:string)
+                end
+              end
+
+              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/dry/v1/gemfile/services/format.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::V1::Gemfile::Services::Format.result(path: "Gemfile")
+# result = ConvenientService::Examples::Dry::V1::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module V1
+        class Gemfile
+          module Services
+            class Format
+              include DryService::Config
+
+              option :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}
+
+              before :result do
+                @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
+              end
+
+              after :step do |step_result|
+                @progressbar.increment
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end