convenient_service 0.1.0 → 0.2.1

data/lib/convenient_service/support/cache.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require_relative "cache/key"
+
+module ConvenientService
+  module Support
+    class Cache
+      ##
+      # @return [void]
+      #
+      def initialize(hash = {})
+        @hash = hash
+      end
+
+      class << self
+        ##
+        # @return [ConvenientService::Support::Cache::Key]
+        #
+        def keygen(...)
+          Cache::Key.new(...)
+        end
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      # @internal
+      #   https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-exist-3F
+      #
+      def exist?(key)
+        hash.has_key?(key)
+      end
+
+      ##
+      # @return [Object] Can be any type.
+      #
+      # @internal
+      #   https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-read
+      #
+      def read(key)
+        hash[key]
+      end
+
+      ##
+      # @return [Object] Can be any type.
+      #
+      # @internal
+      #   NOTE: `alias_method` is NOT used in order to have an ability to use `allow(cache).to receive(:read).with(key).and_call_original` for both `cache[key]` and `cache.read(key)` in RSpec.
+      #
+      def [](key)
+        read(key)
+      end
+
+      ##
+      # @param key [Object] Can be any type.
+      # @param value [Object] Can be any type.
+      # @return [Object] Can be any type.
+      #
+      # @internal
+      #   https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-write
+      #
+      def write(key, value)
+        hash[key] = value
+      end
+
+      ##
+      # @param key [Object] Can be any type.
+      # @param value [Object] Can be any type.
+      # @return [Object] Can be any type.
+      #
+      # @internal
+      #   NOTE: `alias_method` is NOT used in order to have an ability to use `allow(cache).to receive(:write).with(key, value).and_call_original` for both `cache[key] = value` and `cache.write(key, value)` in RSpec.
+      #
+      def []=(key, value)
+        write(key, value)
+      end
+
+      ##
+      # @param key [Object] Can be any type.
+      # @return [Object] Can be any type.
+      #
+      # @internal
+      #   https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-delete
+      #
+      def delete(key)
+        hash.delete(key)
+      end
+
+      ##
+      # @param key [Object] Can be any type.
+      # @param block [Proc]
+      # @return [Object] Can be any type.
+      #
+      # @internal
+      #   https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch
+      #
+      def fetch(key, &block)
+        return read(key) unless block
+
+        exist?(key) ? read(key) : write(key, block.call)
+      end
+
+      ##
+      # @return [ConvenientService::Support::Cache::Key]
+      #
+      def keygen(...)
+        Cache.keygen(...)
+      end
+
+      ##
+      # @param other [Object] Can be any type.
+      # @return [Boolean]
+      #
+      def ==(other)
+        return unless other.instance_of?(self.class)
+
+        return false if hash != other.hash
+
+        true
+      end
+
+      protected
+
+      ##
+      # @!attribute [r] hash
+      #   @return [Hash]
+      #
+      attr_reader :hash
+    end
+  end
+end

data/lib/convenient_service/support/copyable.rb

@@ -15,8 +15,9 @@ module ConvenientService
       #   copy = person.copy(overrides: {kwargs: {age: 18}})
       #   copy = person.copy(overrides: {block: proc { |p| print p }})
       #
-      # NOTE: Inline logic instead of private methods is used intentionally in order to NOT pollute the public interface.
-      # NOTE: This method is NOT likely to be ever changed, that is why inline logic is preferred over command classes in this particular case.
+      # @internal
+      #   NOTE: Inline logic instead of private methods is used intentionally in order to NOT pollute the public interface.
+      #   NOTE: This method is NOT likely to be ever changed, that is why inline logic is preferred over command classes in this particular case.
       #
       def copy(overrides: {})
         overrides[:args] ||= {}

data/lib/convenient_service/support/delegate.rb

@@ -19,8 +19,9 @@ module ConvenientService
       end
 
       ##
-      # `ClassMethods` is loaded faster than `included` by `Concern`.
-      # Since `Forwardable` has it own `delegate` - a different name is used.
+      # @internal
+      #   `ClassMethods` is loaded faster than `included` by `Concern`.
+      #   Since `Forwardable` has it own `delegate` - a different name is used.
       #
       module ClassMethodsForForwardable
         def delegate(*methods, to:)

data/lib/convenient_service/support.rb

@@ -3,6 +3,7 @@
 require_relative "support/concern"
 
 require_relative "support/abstract_method"
+require_relative "support/cache"
 require_relative "support/castable"
 require_relative "support/command"
 require_relative "support/copyable"

data/lib/convenient_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvenientService
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marian Kostyk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -303,6 +303,8 @@ extra_rdoc_files: []
 files:
 - ".dockerignore"
 - ".gem_release.yml"
+- ".github/issue_template.md"
+- ".github/pull_request_template.md"
 - ".github/workflows/cd.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
@@ -342,8 +344,6 @@ files:
 - lib/convenient_service/common/plugins/caches_constructor_params/entities/constructor_params.rb
 - lib/convenient_service/common/plugins/caches_constructor_params/middleware.rb
 - lib/convenient_service/common/plugins/caches_return_value.rb
-- lib/convenient_service/common/plugins/caches_return_value/entities.rb
-- lib/convenient_service/common/plugins/caches_return_value/entities/key.rb
 - lib/convenient_service/common/plugins/caches_return_value/middleware.rb
 - lib/convenient_service/common/plugins/can_be_copied.rb
 - lib/convenient_service/common/plugins/can_be_copied/concern.rb
@@ -366,6 +366,8 @@ files:
 - lib/convenient_service/common/plugins/has_callbacks/middleware.rb
 - lib/convenient_service/common/plugins/has_constructor.rb
 - lib/convenient_service/common/plugins/has_constructor/concern.rb
+- lib/convenient_service/common/plugins/has_constructor_without_initialize.rb
+- lib/convenient_service/common/plugins/has_constructor_without_initialize/concern.rb
 - lib/convenient_service/common/plugins/has_internals.rb
 - lib/convenient_service/common/plugins/has_internals/commands.rb
 - lib/convenient_service/common/plugins/has_internals/commands/create_internals_class.rb
@@ -376,8 +378,6 @@ files:
 - lib/convenient_service/common/plugins/has_internals/entities/internals/plugins.rb
 - lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache.rb
 - lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache/concern.rb
-- lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache/entities.rb
-- lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache/entities/cache.rb
 - lib/convenient_service/common/plugins/normalizes_env.rb
 - lib/convenient_service/common/plugins/normalizes_env/middleware.rb
 - lib/convenient_service/configs.rb
@@ -471,6 +471,11 @@ files:
 - lib/convenient_service/examples/rails/gemfile/services/read_file_content.rb
 - lib/convenient_service/examples/rails/gemfile/services/run_shell.rb
 - lib/convenient_service/examples/rails/gemfile/services/strip_comments.rb
+- lib/convenient_service/examples/standard/cowsay.rb
+- lib/convenient_service/examples/standard/cowsay/services.rb
+- lib/convenient_service/examples/standard/cowsay/services/build_cloud.rb
+- lib/convenient_service/examples/standard/cowsay/services/build_cow.rb
+- lib/convenient_service/examples/standard/cowsay/services/print.rb
 - lib/convenient_service/examples/standard/gemfile.rb
 - lib/convenient_service/examples/standard/gemfile/services.rb
 - lib/convenient_service/examples/standard/gemfile/services/assert_file_exists.rb
@@ -545,6 +550,8 @@ files:
 - lib/convenient_service/service/plugins/aliases.rb
 - lib/convenient_service/service/plugins/can_recalculate_result.rb
 - lib/convenient_service/service/plugins/can_recalculate_result/concern.rb
+- lib/convenient_service/service/plugins/has_inspect.rb
+- lib/convenient_service/service/plugins/has_inspect/concern.rb
 - lib/convenient_service/service/plugins/has_result.rb
 - lib/convenient_service/service/plugins/has_result/commands.rb
 - lib/convenient_service/service/plugins/has_result/commands/create_result_class.rb
@@ -554,23 +561,30 @@ files:
 - lib/convenient_service/service/plugins/has_result/constants.rb
 - lib/convenient_service/service/plugins/has_result/entities.rb
 - lib/convenient_service/service/plugins/has_result/entities/result.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/commands.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/commands/cast_result_params.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/concern.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/concern/instance_methods.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/code.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/code/class_methods.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/data.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/data/class_methods.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/message.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/message/class_methods.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/status.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/entities/status/class_methods.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/errors.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_recalculate_result.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_recalculate_result/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_inspect.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_inspect/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/commands.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/commands/cast_jsend_attributes.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern/instance_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/class_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data/class_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/message.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/message/class_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/status.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/status/class_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/errors.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/middleware.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/structs.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/structs/jsend_attributes.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern/instance_methods.rb
@@ -579,8 +593,6 @@ files:
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/raises_on_not_checked_result_status.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/raises_on_not_checked_result_status/errors.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/raises_on_not_checked_result_status/middleware.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/structs.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/structs/result_params.rb
 - lib/convenient_service/service/plugins/has_result/errors.rb
 - lib/convenient_service/service/plugins/has_result/middleware.rb
 - lib/convenient_service/service/plugins/has_result_method_steps.rb
@@ -614,6 +626,8 @@ files:
 - lib/convenient_service/service/plugins/has_result_short_syntax/success/commands/refute_kwargs_contain_data_and_extra_keys.rb
 - lib/convenient_service/service/plugins/has_result_short_syntax/success/errors.rb
 - lib/convenient_service/service/plugins/has_result_short_syntax/success/middleware.rb
+- lib/convenient_service/service/plugins/has_result_status_check_short_syntax.rb
+- lib/convenient_service/service/plugins/has_result_status_check_short_syntax/concern.rb
 - lib/convenient_service/service/plugins/has_result_steps.rb
 - lib/convenient_service/service/plugins/has_result_steps/commands.rb
 - lib/convenient_service/service/plugins/has_result_steps/commands/create_step_class.rb
@@ -655,6 +669,9 @@ files:
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/concern.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/concern/instance_methods.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/errors.rb
+- lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins.rb
+- lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/has_inspect.rb
+- lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/has_inspect/concern.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/structs.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/structs/params.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step_collection.rb
@@ -668,6 +685,8 @@ files:
 - lib/convenient_service/support.rb
 - lib/convenient_service/support/abstract_method.rb
 - lib/convenient_service/support/abstract_method/errors.rb
+- lib/convenient_service/support/cache.rb
+- lib/convenient_service/support/cache/key.rb
 - lib/convenient_service/support/castable.rb
 - lib/convenient_service/support/castable/errors.rb
 - lib/convenient_service/support/command.rb

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module CachesReturnValue
-        module Entities
-          class Key
-            attr_reader :method, :args, :kwargs, :block
-
-            ##
-            #
-            #
-            def initialize(method:, args:, kwargs:, block:)
-              @method = method
-              @args = args
-              @kwargs = kwargs
-              @block = block
-            end
-
-            ##
-            #
-            #
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              return false if method != other.method
-              return false if args != other.args
-              return false if kwargs != other.kwargs
-              return false if block&.source_location != other.block&.source_location
-
-              true
-            end
-
-            ##
-            # IMPORTANT: `Key` instances are used as Ruby hash keys.
-            #
-            # This method is overridden in order to avoid the following case:
-            #
-            #   hash = {}
-            #
-            #   ##
-            #   # Two equal keys in terms of `==`.
-            #   #
-            #   first_key = ConvenientService::Common::Plugins::CachesReturnValue::Entities::Key.new(method: :result, args: [], kwargs: {}, block: nil)
-            #   second_key = ConvenientService::Common::Plugins::CachesReturnValue::Entities::Key.new(method: :result, args: [], kwargs: {}, block: nil)
-            #
-            #   first_key == second_key
-            #   # => true
-            #
-            #   hash[first_key] = "value"
-            #
-            #   hash[second_key]
-            #   # => nil # This happens since keys are not equal in terms of `eql?`.
-            #
-            # NOTE: Ruby hash and Object#hash are not the same things.
-            # https://ruby-doc.org/core-3.1.2/Object.html#method-i-hash
-            # https://belighted.com/blog/overriding-equals-equals/
-            #
-            def eql?(other)
-              return unless other.instance_of?(self.class)
-
-              hash == other.hash
-            end
-
-            ##
-            # NOTE: hash is overridden to treat blocks that were defined at the same location as equal.
-            # https://ruby-doc.org/core-3.1.2/Proc.html#method-i-source_location
-            # https://ruby-doc.org/core-3.1.2/Object.html#method-i-hash
-            #
-            def hash
-              [method, args, kwargs, block&.source_location].hash
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "entities/key"

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasInternals
-        module Entities
-          class Internals
-            module Plugins
-              module HasCache
-                module Entities
-                  ##
-                  # TODO: Specs.
-                  #
-                  class Cache
-                    attr_reader :hash
-
-                    def initialize
-                      @hash = {}
-                    end
-
-                    ##
-                    # https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-exist-3F
-                    #
-                    def exist?(key)
-                      hash.has_key?(key)
-                    end
-
-                    ##
-                    # https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-read
-                    #
-                    def read(key)
-                      hash[key]
-                    end
-
-                    ##
-                    # NOTE: `alias_method` is NOT used in order to have an ability to use `allow(cache).to receive(:read).with(key).and_call_original` for both `cache[key]` and `cache.read(key)` in RSpec.
-                    #
-                    def [](key)
-                      read(key)
-                    end
-
-                    ##
-                    # https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-write
-                    #
-                    def write(key, value)
-                      hash[key] = value
-                    end
-
-                    ##
-                    # NOTE: `alias_method` is NOT used in order to have an ability to use `allow(cache).to receive(:write).with(key, value).and_call_original` for both `cache[key] = value` and `cache.write(key, value)` in RSpec.
-                    #
-                    def []=(key, value)
-                      write(key, value)
-                    end
-
-                    ##
-                    # https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-delete
-                    #
-                    def delete(key)
-                      hash.delete(key)
-                    end
-
-                    ##
-                    # https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch
-                    #
-                    def fetch(key, &block)
-                      return read(key) unless block
-
-                      exist?(key) ? read(key) : write(key, block.call)
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "entities/cache"

data/lib/convenient_service/service/plugins/has_result/entities/result/commands/cast_result_params.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Commands
-              class CastResultParams < Support::Command
-                attr_reader :params
-
-                def initialize(params:)
-                  @params = params
-                end
-
-                def call
-                  Structs::ResultParams.new(
-                    service: params[:service],
-                    status: Entities::Status.cast!(params[:status]),
-                    data: Entities::Data.cast!(params[:data]),
-                    message: Entities::Message.cast!(params[:message]),
-                    code: Entities::Code.cast!(params[:code])
-                  )
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/entities/result/commands.rb

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

data/lib/convenient_service/service/plugins/has_result/entities/result/concern/instance_methods.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Concern
-              ##
-              # TODO: How to use concern outside?
-              #
-              module InstanceMethods
-                include Support::Delegate
-                include Support::Copyable
-
-                delegate \
-                  :service,
-                  :status,
-                  :data,
-                  :message,
-                  :code,
-                  to: :params
-
-                delegate \
-                  :success?,
-                  :failure?,
-                  :error?,
-                  :not_success?,
-                  :not_failure?,
-                  :not_error?,
-                  to: :status
-
-                def initialize(**params)
-                  @params = Commands::CastResultParams.call(params: params)
-                end
-
-                def ==(other)
-                  return unless other.instance_of?(self.class)
-
-                  return false if service.class != other.service.class
-                  return false if status != other.status
-                  return false if data != other.data
-                  return false if message != other.message
-                  return false if code != other.code
-
-                  true
-                end
-
-                def to_kwargs
-                  {service: service, status: status, data: data, message: message, code: code}
-                end
-
-                private
-
-                attr_reader :params
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result/entities/result/entities/code/class_methods.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Entities
-              class Code
-                module ClassMethods
-                  def cast(other)
-                    case other
-                    when ::String
-                      new(value: other.to_sym)
-                    when ::Symbol
-                      new(value: other)
-                    when Code
-                      new(value: other.value)
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end