convenient_service 0.19.0 → 0.20.0

data/lib/convenient_service/alias.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-CS = ::ConvenientService

data/lib/convenient_service/commands/is_service.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Commands
-    class IsService < Support::Command
-      ##
-      # @!attribute [r] service
-      #   @return [Object] Can be any type.
-      #
-      attr_reader :service
-
-      ##
-      # @param service [Object] Can be any type.
-      # @return [void]
-      #
-      def initialize(service:)
-        @service = service
-      end
-
-      ##
-      # @return [Boolean]
-      #
-      def call
-        Commands::IsServiceClass[service_class: service.class]
-      end
-    end
-  end
-end

data/lib/convenient_service/commands/is_service_class.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Commands
-    class IsServiceClass < Support::Command
-      ##
-      # @!attribute [r] service_class
-      #   @return [Object] Can be any type.
-      #
-      attr_reader :service_class
-
-      ##
-      # @param service_class [Object] Can be any type.
-      # @return [void]
-      #
-      def initialize(service_class:)
-        @service_class = service_class
-      end
-
-      ##
-      # @return [Boolean]
-      #
-      def call
-        return unless service_class.instance_of?(::Class)
-
-        service_class.include?(Service::Configs::Essential)
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/can_have_user_provided_entity/container.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module CanHaveUserProvidedEntity
-        module Container
-          include Support::DependencyContainer::Export
-
-          export :"commands.FindOrCreateEntity" do
-            Commands::FindOrCreateEntity
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasAroundCallbacks
-        module Concern
-          include Support::Concern
-
-          class_methods do
-            ##
-            # @api public
-            #
-            # @param type [Symbol]
-            # @param block [Proc]
-            # @return [ConvenientService::Common::Plugins::HasCallbacks::Entities::Callback]
-            #
-            def around(type, &block)
-              callbacks.create(types: [:around, type], block: block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasAroundCallbacks
-        class Middleware < MethodChainMiddleware
-          include Support::Delegate
-
-          ##
-          # @internal
-          #   TODO: Support of callbacks for class methods.
-          #
-          intended_for any_method, entity: any_entity
-
-          ##
-          # @return [Class<ConvenientService::Common::Plugins::HasCallbacks::Entities::Callback>]
-          #
-          delegate :callback_class, to: :callbacks
-
-          ##
-          # @param args [Array<Object>]
-          # @param kwargs [Hash{Symbol => Object}]
-          # @param block [Proc, nil]
-          # @return [Object] Can be any type.
-          #
-          # @internal
-          #   TODO: Move to command.
-          #
-          def next(*args, **kwargs, &block)
-            ##
-            # A variable that stores return value of middleware `chain.next` aka `original_value`.
-            # It is reassigned later by the `initial_around_callback`.
-            #
-            original_value = nil
-
-            ##
-            # A list of around callbacks.
-            #
-            # class Service
-            #   around do |chain|
-            #     # part before `chain.yield`
-            #     original_value = chain.yield
-            #     # part after `chain.yield`
-            #   end
-            # end
-            #
-            # class Service
-            #   around do |chain, arguments|
-            #     # part before `chain.yield`
-            #     original_value = chain.yield
-            #     # part after `chain.yield`
-            #   end
-            # end
-            #
-            around_callbacks = callbacks.for([:around, method])
-
-            ##
-            #
-            #
-            initial_around_callback = callback_class.new(
-              types: [:around, method],
-              block: proc { original_value = chain.next(*args, **kwargs, &block) }
-            )
-
-            ##
-            # Let's suppose that we have 3 `around` callbacks:
-            #
-            # class Service
-            #   # first
-            #   around do |chain|
-            #     # part before `chain.yield`
-            #     original_value = chain.yield
-            #     # part after `chain.yield`
-            #   end
-            #
-            #   # second
-            #   around do |chain|
-            #     # part before `chain.yield`
-            #     original_value = chain.yield
-            #     # part after `chain.yield`
-            #   end
-            #
-            #   # third
-            #   around do |chain|
-            #     # part before `chain.yield`
-            #     original_value = chain.yield
-            #     # part after `chain.yield`
-            #   end
-            # end
-            #
-            # NOTE: if a user forgets to call `chain.yield` - an error is raised.
-            #
-            # Then `composed` may be built with the following preudocode (that is why `reverse` is needed):
-            #
-            #   composed = original
-            #   composed = proc { instance_exec(composed, &third) }
-            #   composed = proc { instance_exec(composed, &second) }
-            #   composed = proc { instance_exec(composed, &first) }
-            #
-            # Where `first`, `second`, `third` are taken from `entity.callbacks.for([:around, method])`.
-            #
-            # Original implementation is modified in order to return `original_value` from all `chain.yield` calls.
-            #
-            #   # Original implementation:
-            #   composed =
-            #     callbacks.for([:around, method]).reverse.reduce(original) do |composed, callback|
-            #       proc { instance_exec(composed, &callback) }
-            #     end
-            #
-            # Original implementation is modified for the second time in order to raise an error
-            # if a user forgets to call `chain.yield` inside an around callback.
-            #
-            # rubocop:disable Style/Semicolon
-            composed =
-              around_callbacks.reverse.reduce(initial_around_callback) do |composed, callback|
-                proc { callback.call_in_context_with_value_and_arguments(entity, composed, *args, **kwargs, &block); original_value }
-              end
-            # rubocop:enable Style/Semicolon
-
-            ##
-            # Call sequence:
-            #
-            #   composed.call
-            #   proc { instance_exec(composed, &first) }.call  # part before `chain.yield`
-            #   proc { instance_exec(composed, &second) }.call # part before `chain.yield`
-            #   proc { instance_exec(composed, &third) }.call  # part before `chain.yield`
-            #   initial_around_callback
-            #   proc { instance_exec(composed, &third) }.call  # part after `chain.yield`
-            #   proc { instance_exec(composed, &second) }.call # part after `chain.yield`
-            #   proc { instance_exec(composed, &first) }.call  # part after `chain.yield`
-            #
-            composed.call
-
-            ##
-            #
-            #
-            ::ConvenientService.raise Exceptions::AroundCallbackChainIsNotContinued.new(callback: Utils::Array.find_last(around_callbacks, &:called?)) if around_callbacks.any?(&:not_called?)
-
-            ##
-            #
-            #
-            ::ConvenientService.raise Exceptions::AroundCallbackChainIsNotContinued.new(callback: around_callbacks.last) if initial_around_callback.not_called?
-
-            original_value
-          end
-
-          private
-
-          ##
-          # @return [ConvenientService::Common::Plugins::HasCallbacks::Entities::CallbackCollection]
-          #
-          def callbacks
-            entity.class.callbacks
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "has_around_callbacks/concern"
-require_relative "has_around_callbacks/exceptions"
-require_relative "has_around_callbacks/middleware"

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasCallbacks
-        module Concern
-          include Support::Concern
-
-          class_methods do
-            ##
-            # @api private
-            #
-            # @return [ConvenientService::Common::Plugins::HasCallbacks::Entities::CallbackCollection]
-            #
-            def callbacks
-              internals_class.cache.fetch(:callbacks) { Entities::CallbackCollection.new }
-            end
-
-            ##
-            # @api public
-            #
-            # @param type [Symbol]
-            # @param block [Proc]
-            # @return [ConvenientService::Common::Plugins::HasCallbacks::Entities::Callback]
-            #
-            def before(type, &block)
-              callbacks.create(types: [:before, type], block: block)
-            end
-
-            ##
-            # @api public
-            #
-            # @param type [Symbol]
-            # @param block [Proc]
-            # @return [ConvenientService::Common::Plugins::HasCallbacks::Entities::Callback]
-            #
-            def after(type, &block)
-              callbacks.create(types: [:after, type], block: block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/has_callbacks/entities/type/class_methods.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasCallbacks
-        module Entities
-          class Type
-            module ClassMethods
-              def cast(other)
-                case other
-                when ::Symbol
-                  Type.new(value: other)
-                when ::String
-                  Type.new(value: other.to_sym)
-                when Type
-                  Type.new(value: other.value)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/has_callbacks/entities/type.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "type/class_methods"
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasCallbacks
-        module Entities
-          class Type
-            include Support::Castable
-            include Support::Delegate
-
-            extend ClassMethods
-
-            attr_reader :value
-
-            delegate :hash, to: :value
-
-            def initialize(value:)
-              @value = value
-            end
-
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              return false if value != other.value
-
-              true
-            end
-
-            ##
-            # NOTE: Used by `contain_exactly`. Check its specs.
-            #
-            # NOTE: This method is intented to be used only for hash keys comparison,
-            # when you know for sure that `other` is always an `Entities::Type` instance.
-            #
-            # IMPORTANT: Do NOT use `eql?` without a strong reason, prefer `==`.
-            #
-            def eql?(other)
-              return unless other.instance_of?(self.class)
-
-              hash == other.hash
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasCallbacks
-        class Middleware < MethodChainMiddleware
-          ##
-          # @internal
-          #   TODO: Support of callbacks for class methods.
-          #
-          intended_for any_method, entity: any_entity
-
-          ##
-          # @param args [Array<Object>]
-          # @param kwargs [Hash{Symbol => Object}]
-          # @param block [Proc, nil]
-          # @return [Object] Can be any type.
-          #
-          # @internal
-          #   TODO: Move to command.
-          #
-          def next(*args, **kwargs, &block)
-            ##
-            # class Service
-            #   before :result do
-            #   end
-            #
-            #   before :result do |arguments|
-            #   end
-            # end
-            #
-            callbacks.for([:before, method]).each { |callback| callback.call_in_context_with_arguments(entity, *args, **kwargs, &block) }
-
-            original_value = chain.next(*args, **kwargs, &block)
-
-            ##
-            # class Service
-            #   after :result do
-            #   end
-            #
-            #   after :result do |result|
-            #   end
-            #
-            #   after :result do |result, arguments|
-            #   end
-            # end
-            #
-            callbacks.for([:after, method]).reverse_each { |callback| callback.call_in_context_with_value_and_arguments(entity, original_value, *args, **kwargs, &block) }
-
-            original_value
-          end
-
-          private
-
-          ##
-          # @return [ConvenientService::Common::Plugins::HasCallbacks::Entities::CallbackCollection]
-          #
-          def callbacks
-            entity.class.callbacks
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "has_callbacks/concern"
-require_relative "has_callbacks/entities"
-require_relative "has_callbacks/middleware"

data/lib/convenient_service/common/plugins/has_internals/commands/create_internals_class.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasInternals
-        module Commands
-          class CreateInternalsClass < Support::Command
-            include Support::DependencyContainer::Import
-
-            ##
-            # @!attribute [r] entity_class
-            #   @return Class
-            #
-            attr_reader :entity_class
-
-            ##
-            # @return Class
-            #
-            import :"commands.FindOrCreateEntity", from: Common::Plugins::CanHaveUserProvidedEntity::Container
-
-            ##
-            # @param entity_class [Class]
-            # @return [void]
-            #
-            def initialize(entity_class:)
-              @entity_class = entity_class
-            end
-
-            ##
-            # @return [Class]
-            #
-            def call
-              commands.FindOrCreateEntity.call(namespace: entity_class, proto_entity: Entities::Internals)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/dependencies/extractions/b.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Works in a similar way as `p`, but for `byebug`.
-# @see https://ruby-doc.org/core-2.7.0/Kernel.html#method-i-p
-#
-def b(*args)
-  require "byebug"
-  require "byebug/core"
-
-  ::Byebug.attach
-
-  args.one? ? args.first : args
-end

data/lib/convenient_service/dependencies/extractions/byebug_syntax_highlighting.rb

@@ -1,58 +0,0 @@
-##
-# @internal
-#   Yet another hack how to enable the syntax highlighting for the byebug gem. Works for v10.0.0 and higher.
-#   (See https://gist.github.com/marian13/5dade20a431d7254db30e543167058ce)
-#
-#   WARNING: Although this hack is based on the monkey patching,
-#   use this technique for other issues in your own codebases with a precaution.
-#
-require "byebug/runner" unless defined? Byebug::VERSION
-
-if Gem::Version.new(Byebug::VERSION) >= Gem::Version.new("10.0.0")
-  module Byebug
-    class SourceFileFormatter
-      ##
-      # This is a replacement of the internal <tt>Byebug::SourceFileFormatter.file</tt> method
-      # which adds syntax highlighting capability to it.
-      #
-      # The original implementation simply returns the file path
-      # which is passed to the <tt>Byebug::SourceFileFormatter</tt> constructor just as <tt>file</tt>.
-      # (See https://github.com/deivid-rodriguez/byebug/blob/master/lib/byebug/source_file_formatter.rb#L13)
-      #
-      # The current replacement, instead of returning the original file path,
-      # returns a copy of it, where the syntax is highlighted by the Rouge gem(A pure Ruby code highlighter).
-      # (See https://github.com/rouge-ruby/rouge)
-      #
-      # In order to create a copy, it utilizes Ruby's <tt>tempfile</tt> stdlib.
-      # (See https://ruby-doc.org/stdlib-2.7.0/libdoc/tempfile/rdoc/Tempfile.html)
-      # A tempfile is automatically deleted from the underlying OS when it is garbage-collected.
-      #
-      def file
-        @highlighted_file ||=
-          begin
-            if defined? Rouge
-              source = File.read(@file)
-
-              theme     = Rouge::Themes::Monokai.new
-              formatter = Rouge::Formatters::Terminal256.new(theme)
-              lexer     = Rouge::Lexers::Ruby.new
-
-              dest = formatter.format(lexer.lex(source))
-
-              # Tempfile with the highlighted syntax is assigned to the instance variable
-              # in order to prevent its premature garbage collection.
-              @tempfile_with_highlighted_syntax = Tempfile.new.tap { |t| t.write(dest) }.tap(&:close)
-
-              @tempfile_with_highlighted_syntax.path
-            else
-              warn %q{Rouge(a pure Ruby code highlighter) is not defined. Maybe you forgot to require it? (require 'rouge')}
-
-              @file
-            end
-          end
-      end
-    end
-  end
-else
-  warn "Byebug version is lower than v10.0.0..."
-end

data/lib/convenient_service/dependencies/extractions/ce.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-##
-# @note `ce` is short for `catch_exception`.
-#
-# @example
-#   ce { some_code }
-#   e = ce { some_code }
-#
-def ce
-  yield
-
-  nil
-rescue => exception
-  exception
-end

data/lib/convenient_service/dependencies/extractions/ds.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-##
-# @api private
-#
-# Defines `ds` helper in order to have a quick way to find differences between strings like `git diff`.
-#
-# @param first_string [String]
-# @param second_string [String]
-# @return [nil]
-#
-# @note `ds' is a dev-only helper.
-# @note `ds` is a short for `diff_strings`.
-#
-# @example
-#   first_string = <<~TEXT
-#     Step of `AnonymousClass(#14360)` is passed as constructor argument `kwargs[:baz]` to `AnonymousClass(#14360)`.
-#
-#     It is an antipattern. It neglects the idea of steps.
-#
-#     Please, try to reorganize `AnonymousClass(#14400)` service.
-#   TEXT
-#
-#   second_string = <<~TEXT
-#     Step of `AnonymousClass(#14360)` is passed as constructor argument `kwargs[:baz]` to `AnonymousClass(#14400)`.
-#
-#     It is an antipattern. It neglects the idea of steps.
-#
-#     Please, try to reorganize `AnonymousClass(#14400)` service.
-#   TEXT
-#
-#   ds(first_string, second_string)
-#   =>
-#   -Step of `AnonymousClass(#14360)` is passed as constructor argument `kwargs[:baz]` to `AnonymousClass(#14360)`.
-#   +Step of `AnonymousClass(#14360)` is passed as constructor argument `kwargs[:baz]` to `AnonymousClass(#14400)`.
-#
-#   It is an antipattern. It neglects the idea of steps.
-#
-#   Please, try to reorganize `AnonymousClass(#14400)` service.
-#
-def ds(first_string, second_string)
-  require "diffy"
-
-  puts ::Diffy::Diff.new(first_string, second_string).to_s(:color)
-end

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

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "classes/ignoring_exception"
-require_relative "classes/in_threads"

data/lib/convenient_service/rspec/primitive_helpers/ignoring_exception.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveHelpers
-      module IgnoringException
-        def ignoring_exception(...)
-          Classes::IgnoringException.call(...)
-        end
-      end
-    end
-  end
-end