convenient_service 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ac75a9e4491384ec69ea4ddf3b7e9c4b9fc652dda2ec28236d0625d684605a2
-  data.tar.gz: a76819b97f23ef9d66185757832cb3be6c8b703cbfbe39fa8704be59c2af936d
+  metadata.gz: 03335557e59a7d6c469fe20e478efb1d7f9563d7651b5e0761e61d820e7515e6
+  data.tar.gz: 055c3cfaa2b176689bf8cc105d649a40779788279c89bd1f5a6bdfde8d7994c1
 SHA512:
-  metadata.gz: 8da7165d9eee47a3f978db542c7eaf77b6b80d8a2c27d885ce032b8433bae881d2c7c345923c676c38b1b1d30ad5aef9231c962ae282d0392f7278d768e8d9d6
-  data.tar.gz: e64a25c3a7513b2c2cf028a11c6a1ee692d6ad01c31ebd053d32e44c980bfddab9e77c2a1d7ca5fa529e4458eea6dae026b3f01bb743159045d6874e02757a47
+  metadata.gz: f9f55f6baab2736bcbb8661a55bb494bdfb1f7e000a87b3c7c78f326b417e44bcd69cccb992b54435ec10ce919afc2e3a7cd73695858025fa241aff609b9882c
+  data.tar.gz: 72778dcdb0df0003b3c9b13a266af24a9c8de4150ed7d048887bd5007b223c88ce34c9494c186c5ac49ba0102ca5bd31858e37d55698fe1cfb49fe22dd6ed6e7

data/.gem_release.yml

@@ -1,17 +1,5 @@
 quiet: false
 
-##
-# NOTE: `bump` options.
-# https://github.com/svenfuchs/gem-release#gem-bump
-#
-bump:
-  file: ./lib/convenient_service/version.rb
-  message: 🎉 🎉 🎉 Release %{version} 🎉 🎉 🎉
-  recurse: false
-  release: true
-  sign: true
-  tag: true
-
 ##
 # NOTE: `release` options.
 # https://github.com/svenfuchs/gem-release#gem-release

data/.github/issue_template.md

@@ -0,0 +1,35 @@
+## What is the issue?
+<!--- Briefly describe the problem -->
+
+-
+
+## When it happens? How to reproduce it?
+<!--- Tell us how to reproduce the problem. You can write a step-by-step guide, for example -->
+
+-
+
+## Where it happens?
+<!--- Point to the file/loc which causes inconsistent behaviour -->
+
+-
+
+## How big is the damage from it?
+
+-
+
+## Why it happens?
+
+-
+
+## What can be done to resolve it?
+
+-
+
+## What is the complexity of a possible fix?
+
+-
+
+## Notes
+<!--- Additional info, links, screenshots, actually anything that helps to recreate the way of thoughts (optional). -->
+
+-

data/.github/pull_request_template.md

@@ -0,0 +1,31 @@
+## What was done as a part of this PR?
+<!--- Describe your changes -->
+
+-
+
+## Why it was done?
+<!--- Why is this change required? Does it improve something? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+-
+
+## How it was done?
+<!--- Useful when a solution is not obvious (seems too extraordinary or too heavy) for a team you work with (optional). -->
+
+-
+
+## How to test?
+
+- `task rspec -- corresponding_spec.rb`
+- [Development: Local Development#tests](https://github.com/marian13/convenient_service/wiki/Development:-Local-Development#tests).
+
+## Notes
+<!--- Additional info, links, screenshots, actually anything that helps to recreate the way of thoughts (optional). -->
+
+-
+
+## Checklist:
+
+- [ ] I have performed a self-review of my code.
+- [ ] I have added/adjusted tests that prove my fix is effective or that my feature works.
+- [ ] CI is green.

data/.github/workflows/cd.yml

@@ -22,9 +22,9 @@ on:
       - main
 
 jobs:
-  deploy:
+  deploy_api_docs:
     runs-on: ubuntu-20.04
-    name: Deploy
+    name: Deploy API Docs
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
@@ -52,3 +52,16 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs
+
+  create_github_release:
+    runs-on: ubuntu-20.04
+    name: Create GitHub Release PR
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        with:
+          changelog-path: CHANGELOG.md
+          default-branch: main
+          include-v-in-tag: true
+          package-name: convenient_service
+          release-type: ruby
+          version-file: lib/convenient_service/version.rb

data/CHANGELOG.md

@@ -1 +1,19 @@
+# Changelog
+
+## [0.2.0](https://github.com/marian13/convenient_service/compare/v0.1.0...v0.2.0) (2022-11-26)
+
+
+### Features
+
+* **be_success:** add without_data chaining ([e1c7a7e](https://github.com/marian13/convenient_service/commit/e1c7a7e534b4c8c112b343a3318177d69f7ad06d))
+* **has_constructor_without_initialize:** introduce .create_without_initialize ([b0835aa](https://github.com/marian13/convenient_service/commit/b0835aaae46820b47ecc57887613acd8599c1908))
+* **has_constructor:** introduce .create ([2cc450b](https://github.com/marian13/convenient_service/commit/2cc450bd529596ac8e2fda3d26c2e0b1d4fad959))
+* **has_inspect:** indroduce inspect for Service and Result ([c3815c8](https://github.com/marian13/convenient_service/commit/c3815c8d25f47d8f2457ccfbad8660a930e32da1))
+* **has_inspect:** introduce HasInspect for Step ([6a6ada7](https://github.com/marian13/convenient_service/commit/6a6ada73962ea96f5e9c40d62e87d91a1e09b961))
+* **has_inspect:** introduce inspect for Service and Result ([7c9fe0e](https://github.com/marian13/convenient_service/commit/7c9fe0e4a7aedfcaff1e717f99a934d2fab4c03b))
+* **has_result_status_check_short_syntax:** add ability to use short bool result check ([14909c5](https://github.com/marian13/convenient_service/commit/14909c584164a2bd130f788fa48e76edd3c7a758))
+* **standard:** use HasConstructorWithoutInitialize ([b16232c](https://github.com/marian13/convenient_service/commit/b16232c88fe75028531cd7e834fb59fece49d122))
+* **wrap_method:** add ability to reset wrapped method ([ae01aa8](https://github.com/marian13/convenient_service/commit/ae01aa825dcf0d06b2abdc693331dccb65d95d6b))
+
+
 ## 0.1.0

data/README.md

@@ -29,8 +29,6 @@
 
 <!-- general_description:start -->
 Yet another approach to revisit the service object pattern, but this time focusing on the unique, opinionated features.
-
-\* Logo is downloaded from [CuteWallpaper.org](https://cutewallpaper.org/24/cartoon-diamond-png/2703010921.html). It will be replaced later.
 <!-- general_description:end -->
 
 <!-- warning:start -->
@@ -47,9 +45,20 @@ This library is under heavy development. Public API may be subject to change. Th
 
 - Have a look at [Convenient Service Development Wiki](https://github.com/marian13/convenient_service/wiki) if you consider making a contribution.
 
----
+- [API docs](https://marian13.github.io/convenient_service/).
+
 <!-- documentation:end -->
 
+## Links
+
+<!-- links:start -->
+- [RubyGems](https://rubygems.org/gems/convenient_service).
+
+- [Official User Docs Source](https://github.com/marian13/convenient_service_docs).
+<!-- links:end -->
+
+---
+
 <!-- author:start -->
 Copyright (c) 2022 [Marian Kostyk](http://mariankostyk.com).
 <!-- author:end -->

data/ROADMAP.md

@@ -4,11 +4,11 @@
 | - | - | - | - |
 | High | ✅ | 100% coverage of `Core` | |
 | Medium | 🚧 | Type signatures for the whole codebase ([Yard @param, @overload, @return](https://rubydoc.info/gems/yard/file/docs/Tags.md#taglist)) | |
-| Medium | 🚧 | `Service.success?` shortcut for `Service.result.success?` | |
-| Medium | 🚧 | Release `v0.1.0` with a warning that lib is still under heavy development | |
+| Medium | ✅ | `Service.success?` shortcut for `Service.result.success?` | |
+| Medium | ✅ | Release `v0.1.0` with a warning that lib is still under heavy development | |
 | Medium | 🚧 | [Active Record transaction](https://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html) examples | |
+| Medium | 🚧 | [Rails Current Attributes integration](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) to cache repeated results | |
 | Low | 🚧 | [Capybara](https://github.com/teamcapybara/capybara) examples | |
-| Low | 🚧 | [Thread.current](https://ruby-doc.org/core-3.1.2/Thread.html#method-c-current) to cache repetable nested steps during an organizer invocation | |
 | Medium | 🚧 | Inline step sequence | |
 | High | 🚧 | Move callbacks to internals | |
 | Low | 🚧 | Create an example of `id_or_record` [attribute](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html) |
@@ -17,7 +17,7 @@
 | High | ✅ | `respond_to_missing?` | [ConvenientService::Core::ClassMethods#respond_to_missing?](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/core/class_methods.rb#L105), [ConvenientService::Core::InstanceMethods#respond_to_missing?](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/core/instance_methods.rb#L30) |
 | High | ⏳ | Custom matcher to track `ConvenientService::Logger` messages | |
 | Medium | 🚧 | Remove `respond_to?` from `Copyable` | Investigate before making any decision |
-| High | 🚧 | Unified `inspect` | |
+| High | 🚧 | Unified `inspect` | Remove `internals` from inspect, ivars wrapperd by double underscore |
 | High | ✅ | Remove race condition for `method_missing` | https://github.com/marian13/convenient_service/pull/5 |
 | High | ✅ | Remove incompatiility of [Module#include](https://gist.github.com/marian13/9c25041f835564e945d978839097d419) | https://github.com/marian13/convenient_service/pull/3 |
 | Medium | ✅ | Split `Utils` specs into separate files | [convenient_service/spec/lib/convenient_service/utils](https://github.com/marian13/convenient_service/tree/main/spec/lib/convenient_service/utils) |
@@ -25,7 +25,6 @@
 | Medium | ✅ | Rename `Utils::Module.find_own_const` to `Utils::Module.get_own_const` | [ConvenientService::Utils::Module::GetOwnConst](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/utils/module/get_own_const.rb) |
 | Medium | 🚧 | Mark `@api private` methods, classes | [YARD Tags](https://www.rubydoc.info/gems/yard/file/docs/Tags.md) |
 | Medium | ✅ | A way to check if block has one required positional argument | [#proc_has_one_positional_argument?](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/utils/proc/exec_config.rb#L96) |
-| Medium | 🚧 | Factories for POROs in specs | |
 | Low | 🚧 | Define method middleware caller with visibility | |
 | Low | 🚧 | Dependency containers to remove high coupling | |
 | Low | 🚧 | Measure performance | |
@@ -33,9 +32,21 @@
 | High | 🚧 | Optimize `stack.dup` in `MethodMiddlewares#call` | Core v3 |
 | Medium | 🚧 | Make a decision of what to do with `printable_block` in custom RSpec matchers | |
 | Medium | 🚧 | User-friendly exception messages | |
-| High | 🚧 | Factories for POROs ❗❗❗ | |
+| High | 🚧 | Factories for POROs in specs ❗❗❗ | Start with `result_class`, `class self::Result`, `service_class`, `step_class`, `organizer_class` |
 | High | 🚧 | Resolve warning during specs | |
 | Medium | 🚧 | Consider to change/rewrite `delegate` backend to minify its interface | |
-| Medium | 🚧 | Same order of attr macros, delegators, initialize, class methods, attr methods, queries, actions, to_*, comparison, inspect | |
-| Medium | 🚧 | Move `Cache` to `Support` | |
+| Medium | 🚧 | Same order of attr macros, delegators, initialize, class methods, attr methods, queries, actions, `to_*`, comparison, inspect | |
+| Medium | ✅ | Move `Cache` to `Support` | |
 | Medium | 🚧 | Statically specify plugin dependencies | |
+| Medium | 🚧 | Statically specify plugin entity types | |
+| Medium | 🚧 | Consider to create `ComparableProc` descendant from `Proc` | To abstract away `block&.source_location != other.block&.source_location` |
+| Medium | 🚧 | Consider to use `Struct` as key in `Support::Cache` | To hide overriden [eql?](https://github.com/marian13/convenient_service/blob/v0.1.0/lib/convenient_service/common/plugins/caches_return_value/entities/key.rb#L60) |
+| High | 🚧 | `included_once` for `Support::Concern` |
+| Medium | 🚧 | Custom YARD type for service instance, service class as return values |
+| Medium | 🚧 | Heredoc for error messages |
+| Medium | 🚧 | Specs for `be_success`, `be_error`, `be_failure` matchers | | 
+| Low | 🚧 | [Receive Counts](https://relishapp.com/rspec/rspec-mocks/docs/setting-constraints/receive-counts) for `delegate_to` | | 
+| Low | 🚧 | Prefer versioning instead of modification plugin | |
+| Low | 🚧 | Consider to move `__steps__` and `__callbacks__` to `internals_class` | Benefit? |
+
+Search for `TODO`s in the codebase for more tasks.

data/Taskfile.yml

@@ -194,17 +194,9 @@ tasks:
       - bundle exec rake playground
     interactive: true
 
-  release:major:
+  release:
     cmds:
-      - gem bump convenient_service --version major
-
-  release:minor:
-    cmds:
-      - gem bump convenient_service --version minor
-
-  release:patch:
-    cmds:
-      - gem bump convenient_service --version patch
+      - gem release
 
   rspec:
     cmds:

data/lib/convenient_service/common/plugins/caches_return_value/middleware.rb

@@ -5,10 +5,25 @@ module ConvenientService
     module Plugins
       module CachesReturnValue
         class Middleware < Core::MethodChainMiddleware
+          ##
+          # @param args [Array]
+          # @param kwargs [Hash]
+          # @param block [Proc]
+          # @return [Object] Can be any type.
+          #
           def next(*args, **kwargs, &block)
-            key = Entities::Key.new(method: method, args: args, kwargs: kwargs, block: block)
+            key = cache.keygen(:return_values, method, *args, **kwargs, &block)
 
-            entity.internals.cache.fetch(key) { chain.next(*args, **kwargs, &block) }
+            cache.fetch(key) { chain.next(*args, **kwargs, &block) }
+          end
+
+          private
+
+          ##
+          # @return [ConvenientService::Support::Cache]
+          #
+          def cache
+            @cache ||= entity.internals.cache
           end
         end
       end

data/lib/convenient_service/common/plugins/caches_return_value.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "caches_return_value/entities"
 require_relative "caches_return_value/middleware"

data/lib/convenient_service/common/plugins/has_constructor/concern.rb

@@ -8,9 +8,22 @@ module ConvenientService
           include Support::Concern
 
           instance_methods do
+            ##
+            # @return [void]
+            #
             def initialize(...)
             end
           end
+
+          class_methods do
+            ##
+            # @return [Object]
+            # @since 0.2.0
+            #
+            def create(...)
+              new(...)
+            end
+          end
         end
       end
     end

data/lib/convenient_service/common/plugins/has_constructor_without_initialize/concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module HasConstructorWithoutInitialize
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @return [Object]
+            # @since 0.2.0
+            #
+            # @internal
+            #   - https://ruby-doc.org/core-2.5.0/Class.html#method-i-allocate
+            #   - https://frontdeveloper.pl/2018/11/ruby-allocate-method/
+            #
+            def create_without_initialize
+              allocate
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/has_constructor_without_initialize.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "has_constructor_without_initialize/concern"

data/lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache/concern.rb

@@ -7,16 +7,20 @@ module ConvenientService
         module Entities
           class Internals
             module Plugins
+              ##
+              # @internal
+              #   TODO: Consider to refactor into common plugin?
+              #
               module HasCache
-                ##
-                # TODO: Specs.
-                #
                 module Concern
                   include Support::Concern
 
                   instance_methods do
+                    ##
+                    # @return [ConvenientService::Support::Cache]
+                    #
                     def cache
-                      @cache ||= Entities::Cache.new
+                      @cache ||= Support::Cache.new
                     end
                   end
                 end

data/lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
 require_relative "has_cache/concern"
-require_relative "has_cache/entities"

data/lib/convenient_service/common/plugins.rb

@@ -11,6 +11,7 @@ require_relative "plugins/can_be_copied"
 require_relative "plugins/has_around_callbacks"
 require_relative "plugins/has_callbacks"
 require_relative "plugins/has_constructor"
+require_relative "plugins/has_constructor_without_initialize"
 require_relative "plugins/has_internals"
 
 require_relative "plugins/aliases"

data/lib/convenient_service/configs/standard.rb

@@ -20,6 +20,7 @@ module ConvenientService
         concerns do
           use Plugins::Common::HasInternals::Concern
           use Plugins::Common::HasConstructor::Concern
+          use Plugins::Common::HasConstructorWithoutInitialize::Concern
 
           use Plugins::Common::CachesConstructorParams::Concern
           use Plugins::Common::CanBeCopied::Concern
@@ -27,10 +28,12 @@ module ConvenientService
           use Plugins::Service::HasResultShortSyntax::Concern
           use Plugins::Service::HasResultSteps::Concern
           use Plugins::Service::CanRecalculateResult::Concern
+          use Plugins::Service::HasResultStatusCheckShortSyntax::Concern
 
           use Plugins::Common::HasCallbacks::Concern
           use Plugins::Common::HasAroundCallbacks::Concern
 
+          use Plugins::Service::HasInspect::Concern
           ##
           # NOTE: Optional plugins.
           # TODO: Specs.
@@ -97,9 +100,20 @@ module ConvenientService
 
           concerns do
             use Plugins::Common::HasInternals::Concern
+            use Plugins::Common::HasConstructor::Concern
+
+            use Plugins::Result::HasJsendStatusAndAttributes::Concern
 
             use Plugins::Result::HasResultShortSyntax::Concern
             use Plugins::Result::CanRecalculateResult::Concern
+
+            use Plugins::Result::HasInspect::Concern
+          end
+
+          middlewares :initialize do
+            use Plugins::Common::NormalizesEnv::Middleware
+
+            use Plugins::Result::HasJsendStatusAndAttributes::Middleware
           end
 
           middlewares :success? do
@@ -170,6 +184,8 @@ module ConvenientService
 
           concerns do
             use Plugins::Common::HasInternals::Concern
+
+            use Plugins::Step::HasInspect::Concern
           end
 
           middlewares :result do

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/container/commands/cast_container.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal: true
-
 module ConvenientService
   module Core
     module Entities

data/lib/convenient_service/dependencies.rb

@@ -102,6 +102,7 @@ module ConvenientService
       def require_standard_examples
         require "progressbar"
 
+        require_relative "examples/standard/cowsay"
         require_relative "examples/standard/gemfile"
       end
 

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

@@ -4,17 +4,18 @@ require_relative "gemfile/dry_service"
 require_relative "gemfile/services"
 
 ##
-# Usage example:
+# @internal
+#   Usage example:
 #
-# result = ConvenientService::Examples::Dry::Gemfile.format(path: "Gemfile")
-# result = ConvenientService::Examples::Dry::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#   result = ConvenientService::Examples::Dry::Gemfile.format("Gemfile")
+#   result = ConvenientService::Examples::Dry::Gemfile.format("spec/cli/gemfile/format/fixtures/Gemfile")
 #
 module ConvenientService
   module Examples
     module Dry
       module Gemfile
         class << self
-          def format
+          def format(path)
             Services::Format[path: path]
           end
         end

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

@@ -4,17 +4,18 @@ require_relative "gemfile/rails_service"
 require_relative "gemfile/services"
 
 ##
-# Usage example:
+# @internal
+#   Usage example:
 #
-# result = ConvenientService::Examples::Rails::Gemfile.format(path: "Gemfile")
-# result = ConvenientService::Examples::Rails::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#   result = ConvenientService::Examples::Rails::Gemfile.format("Gemfile")
+#   result = ConvenientService::Examples::Rails::Gemfile.format("spec/cli/gemfile/format/fixtures/Gemfile")
 #
 module ConvenientService
   module Examples
     module Rails
       module Gemfile
         class << self
-          def format
+          def format(path)
             Services::Format[path: path]
           end
         end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module Cowsay
+        module Services
+          class BuildCloud
+            include ConvenientService::Standard::Config
+
+            attr_reader :text
+
+            def initialize(text: "Hello World!")
+              @text = text
+            end
+
+            def result
+              success(cloud: cloud)
+            end
+
+            private
+
+            ##
+            # Copied with ❤️ from https://github.com/gaborbata/rosetta-cow
+            #
+            def cloud
+              <<~HEREDOC
+                 #{border(text, "_")}
+                < #{text} >
+                 #{border(text, "-")}
+              HEREDOC
+            end
+
+            def border(text, char)
+              char * (text.length + 2)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module Cowsay
+        module Services
+          class BuildCow
+            include ConvenientService::Standard::Config
+
+            def result
+              success(cow: cow)
+            end
+
+            private
+
+            ##
+            # Copied with ❤️ from https://github.com/gaborbata/rosetta-cow
+            #
+            def cow
+              <<~'HEREDOC'.split("\n").map { |line| offset(line) }.join("\n")
+                \   ^__^
+                 \  (oo)\_______
+                    (__)\       )\/\
+                        ||----w |
+                        ||     ||
+              HEREDOC
+            end
+
+            def offset(line)
+              " " * 10 + line
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module Cowsay
+        module Services
+          class Print
+            include ConvenientService::Standard::Config
+
+            attr_reader :text, :out
+
+            step Services::BuildCloud, in: :text, out: :cloud
+            step Services::BuildCow, out: :cow
+            step :result
+
+            def initialize(text: "Hello World!", out: $stdout)
+              @text = text
+              @out = out
+            end
+
+            def result
+              out.puts cloud + cow
+
+              success
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "services/build_cloud"
+require_relative "services/build_cow"
+require_relative "services/print"

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "cowsay/services"
+
+##
+# @internal
+#   Usage examples:
+#
+#   result = ConvenientService::Examples::Standard::Cowsay.print("Hello")
+#   result = ConvenientService::Examples::Standard::Cowsay.print("Hi")
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module Cowsay
+        class << self
+          def print(text = "Hello World!", out: $stdout)
+            Services::Print[text: text, out: out]
+          end
+        end
+      end
+    end
+  end
+end