convenient_service 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e849e1385e9637d36289bfeb4e78eccddd53b22f5f9e828c5a35c8c90967954d
-  data.tar.gz: 9538a0fb396cbe7a9f04879845a25287145021b4bfa17ea78eaf4e54643552d9
+  metadata.gz: 86314358470fd8502e3b00853f6f0aed31fe7837fe879b8a6fe9b02b23a37055
+  data.tar.gz: 8c7ddbfa504ef02c2774bbc4c616297345b684320ed0e4b4b10134f2a8851c24
 SHA512:
-  metadata.gz: f4cc32889e3c0958bc5acebc744a01b9fc80c0fa2c7a7c3a609ffd4a9d8254822d0ad4a8c1d75fd2ce39472b2ededc2ef69b3d899edcda406f1eff99b06df2b8
-  data.tar.gz: 30bf372859ef693d1d67058a886065eb7db3b3dddb530cc585e471417a94ccedfac1c86d17df56881c3f5849b04d6a0a64b752746209afa5d860f9f35f3b3689
+  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,27 @@
 # 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)
 
 

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
 
       ##

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.rb

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

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

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

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

@@ -15,7 +15,7 @@ module ConvenientService
     module Rails
       module V1
         class Gemfile
-          include ConvenientService::Feature
+          include ConvenientService::Feature::Standard::Config
 
           entry :format do |path|
             Services::Format[path: path]

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

@@ -13,7 +13,7 @@ module ConvenientService
   module Examples
     module Standard
       class Cowsay
-        include ConvenientService::Feature
+        include ConvenientService::Feature::Standard::Config
 
         entry :print do |text = "Hello World!", out: $stdout|
           Services::Print[text: text, out: out]

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

@@ -12,7 +12,7 @@ module ConvenientService
   module Examples
     module Standard
       class DateTime
-        include ConvenientService::Feature
+        include ConvenientService::Feature::Standard::Config
 
         entry :safe_parse do |string, format|
           Services::SafeParse[string: string, format: format]

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

@@ -13,7 +13,7 @@ module ConvenientService
   module Examples
     module Standard
       class Factorial
-        include ConvenientService::Feature
+        include ConvenientService::Feature::Standard::Config
 
         entry :calculate do |number|
           Services::Calculate[number: number]

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

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

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

@@ -37,7 +37,7 @@ module ConvenientService
   module Examples
     module Standard
       class RequestParams
-        include ConvenientService::Feature
+        include ConvenientService::Feature::Standard::Config
 
         entry :prepare do |request|
           Services::Prepare[request: request]

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

@@ -14,7 +14,7 @@ module ConvenientService
     module Standard
       module V1
         class Cowsay
-          include ConvenientService::Feature
+          include ConvenientService::Feature::Standard::Config
 
           entry :print do |text = "Hello World!", out: $stdout|
             Services::Print[text: text, out: out]

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

@@ -13,7 +13,7 @@ module ConvenientService
     module Standard
       module V1
         class DateTime
-          include ConvenientService::Feature
+          include ConvenientService::Feature::Standard::Config
 
           entry :safe_parse do |string, format|
             Services::SafeParse[string: string, format: format]

data/lib/convenient_service/examples/standard/v1/factorial.rb

@@ -14,7 +14,7 @@ module ConvenientService
     module Standard
       module V1
         class Factorial
-          include ConvenientService::Feature
+          include ConvenientService::Feature::Standard::Config
 
           entry :calculate do |number|
             Services::Calculate[number: number]

data/lib/convenient_service/examples/standard/v1/gemfile.rb

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

data/lib/convenient_service/examples/standard/v1/request_params.rb

@@ -38,7 +38,7 @@ module ConvenientService
     module Standard
       module V1
         class RequestParams
-          include ConvenientService::Feature
+          include ConvenientService::Feature::Standard::Config
 
           entry :prepare do |request|
             Services::Prepare[request: request]

data/lib/convenient_service/feature/configs/aliases.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Standard
+      Config = ::ConvenientService::Feature::Configs::Standard
+    end
+  end
+end

data/lib/convenient_service/feature/configs/standard.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Configs
+      ##
+      # Default configuration for the user-defined features.
+      #
+      module Standard
+        include Support::Concern
+
+        included do
+          include Core
+
+          concerns do
+            use ConvenientService::Plugins::Feature::CanHaveEntries::Concern
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/configs.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "configs/standard"
+
+require_relative "configs/aliases"

data/lib/convenient_service/feature/plugins/aliases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Plugins
+    Feature = ::ConvenientService::Feature::Plugins
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_entries/commands/define_entry.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveEntries
+        module Commands
+          class DefineEntry < Support::Command
+            ##
+            # @!attribute [r] feature_class
+            #   @return [Class]
+            #
+            attr_reader :feature_class
+
+            ##
+            # @!attribute [r] name
+            #   @return [String, Symbol]
+            #
+            attr_reader :name
+
+            ##
+            # @!attribute [r] body
+            #   @return [Proc]
+            #
+            attr_reader :body
+
+            ##
+            # @param feature_class [Class]
+            # @param name [String, Symbol]
+            # @param body [Proc]
+            #
+            def initialize(feature_class:, name:, body:)
+              @feature_class = feature_class
+              @name = name
+              @body = body
+            end
+
+            ##
+            # @return [String, Symbol]
+            #
+            def call
+              feature_class.define_singleton_method(name, &body)
+
+              name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_entries/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/define_entry"

data/lib/convenient_service/feature/plugins/can_have_entries/concern.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveEntries
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @param name [String, Symbol]
+            # @param body [Proc]
+            # @return [String, Symbol]
+            #
+            def entry(name, &body)
+              Commands::DefineEntry.call(feature_class: self, name: name, body: body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_entries.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "can_have_entries/commands"
+require_relative "can_have_entries/concern"

data/lib/convenient_service/feature/plugins.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "plugins/can_have_entries"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/feature.rb

@@ -1,11 +1,4 @@
 # frozen_string_literal: true
 
-module ConvenientService
-  module Feature
-    include Support::Concern
-
-    included do
-      include Support::DependencyContainer::Entry
-    end
-  end
-end
+require_relative "feature/plugins"
+require_relative "feature/configs"

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service/constants.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class StubService < Support::Command
           module Constants
             module Triggers

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service/entities/result_spec.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         ##
         # @internal
         #   TODO: Specs.
@@ -26,7 +26,7 @@ module ConvenientService
 
               ##
               # @param service_class [Class]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def for(service_class)
@@ -35,7 +35,7 @@ module ConvenientService
 
               ##
               # @param data [Hash]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def with_data(data)
@@ -46,7 +46,7 @@ module ConvenientService
 
               ##
               # @param message [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def with_message(message)
@@ -57,7 +57,7 @@ module ConvenientService
 
               ##
               # @param code [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def with_code(code)
@@ -68,7 +68,7 @@ module ConvenientService
 
               ##
               # @param data [Hash]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def and_data(data)
@@ -79,7 +79,7 @@ module ConvenientService
 
               ##
               # @param message [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def and_message(message)
@@ -90,7 +90,7 @@ module ConvenientService
 
               ##
               # @param code [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def and_code(code)

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service/entities/stubbed_service.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class StubService < Support::Command
           module Entities
             class StubbedService
@@ -31,7 +31,7 @@ module ConvenientService
               end
 
               ##
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubService]
               #
               def with_arguments(...)
                 @arguments = Support::Arguments.new(...)
@@ -40,7 +40,7 @@ module ConvenientService
               end
 
               ##
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubService]
               #
               def without_arguments
                 @arguments = Support::Arguments.null_arguments
@@ -49,8 +49,8 @@ module ConvenientService
               end
 
               ##
-              # @param result_spec [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              # @param result_spec [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubService]
               #
               def to(result_spec)
                 @result_spec = result_spec
@@ -78,7 +78,7 @@ module ConvenientService
 
               ##
               # @!attribute [r] result_spec
-              #   @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              #   @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               #
               attr_reader :result_spec
 

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service.rb

@@ -6,7 +6,7 @@ require_relative "stub_service/entities"
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         ##
         # TODO: Specs.
         #

data/lib/convenient_service/rspec/helpers/{custom → classes}/wrap_method/entities/wrapped_method.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class WrapMethod < Support::Command
           module Entities
             ##
@@ -129,7 +129,7 @@ module ConvenientService
 
               ##
               # @return [Object] Can be any type.
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_value
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :value) unless chain_called?
@@ -139,7 +139,7 @@ module ConvenientService
 
               ##
               # @return [Array]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_args
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :args) unless chain_called?
@@ -149,7 +149,7 @@ module ConvenientService
 
               ##
               # @return [Hash]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_kwargs
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :kwargs) unless chain_called?
@@ -159,7 +159,7 @@ module ConvenientService
 
               ##
               # @return [Proc, nil]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_block
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :block) unless chain_called?
@@ -169,7 +169,7 @@ module ConvenientService
 
               ##
               # @return [StandardError, nil]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_exception
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :exception) unless chain_called?

data/lib/convenient_service/rspec/helpers/{custom → classes}/wrap_method/exceptions.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class WrapMethod < Support::Command
           module Exceptions
             class ChainAttributePreliminaryAccess < ::ConvenientService::Exception

data/lib/convenient_service/rspec/helpers/{custom → classes}/wrap_method.rb

@@ -6,7 +6,7 @@ require_relative "wrap_method/exceptions"
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class WrapMethod < Support::Command
           ##
           # @!attribute [r] entity
@@ -39,7 +39,7 @@ module ConvenientService
           end
 
           ##
-          # @return [ConvenientService::RSpec::Helpers::Custom::Entities::WrappedMethod]
+          # @return [ConvenientService::RSpec::Helpers::Classes::Entities::WrappedMethod]
           #
           def call
             Entities::WrappedMethod.new(entity: entity, method: method, observe_middleware: observe_middleware)

data/lib/convenient_service/rspec/helpers/classes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "classes/stub_service"
+require_relative "classes/wrap_method"