convenient_service 0.19.0 → 0.20.0

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "stub_service/constants"
 require_relative "stub_service/entities"
 
@@ -8,17 +13,28 @@ module ConvenientService
     module Helpers
       module Classes
         ##
-        # TODO: Specs.
+        # TODO: Direct Specs.
         #
         class StubService < Support::Command
+          ##
+          # @!attribute [r] service_class
+          #   @return [ConvenientService::Service]
+          #
           attr_reader :service_class
 
+          ##
+          # @param service_class [ConvenientService::Service]
+          # @return [void]
+          #
           def initialize(service_class)
             @service_class = service_class
           end
 
+          ##
+          # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubbedService]
+          #
           def call
-            Entities::StubbedService.new(service_class: @service_class)
+            Entities::StubbedService.new(service_class: service_class)
           end
         end
       end

data/lib/convenient_service/rspec/helpers/classes/wrap_method/entities/wrapped_method.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Helpers
@@ -43,7 +48,7 @@ module ConvenientService
                 @observe_middleware = observe_middleware
 
                 ##
-                # TODO: When middleware is NOT used yet.
+                # TODO: When middleware is NOT used yet (`::ConvenientService.raise Exceptions::NoMiddlewareIsSetToObserve.new`).
                 #
                 observable_middleware.middleware_events[:before_chain_next].add_observer(self)
                 observable_middleware.middleware_events[:after_chain_next].add_observer(self)
@@ -60,8 +65,8 @@ module ConvenientService
               #   NOTE: The following handler is triggered only when `chain.next` is called from method chain middleware.
               #
               def handle_before_chain_next(arguments)
-                @chain_called = true
-                @chain_arguments = arguments
+                chain[:called] = true
+                chain[:arguments] = arguments
               end
 
               ##
@@ -69,7 +74,7 @@ module ConvenientService
               #   NOTE: The following handler is triggered only when `chain.next` is called from method chain middleware.
               #
               def handle_after_chain_next(value, _arguments)
-                @chain_value = value
+                chain[:value] = value
               end
 
               ##
@@ -99,14 +104,14 @@ module ConvenientService
               # @param block [Proc, nil]
               # @return [Object] Can be any type.
               #
+              # @internal
+              #   NOTE: `raise` with no args inside `rescue` reraises rescued exception.
+              #
               def call(*args, **kwargs, &block)
                 entity.__send__(method, *args, **kwargs, &block)
               rescue => exception
-                @chain_exception = exception
+                chain[:exception] = exception
 
-                ##
-                # NOTE: `raise` with no args inside `rescue` reraises rescued exception.
-                #
                 raise
               end
 
@@ -114,17 +119,14 @@ module ConvenientService
               # @return [void]
               #
               def reset!
-                remove_instance_variable(:@chain_called) if defined? @chain_called
-                remove_instance_variable(:@chain_value) if defined? @chain_value
-                remove_instance_variable(:@chain_arguments) if defined? @chain_arguments
-                remove_instance_variable(:@chain_exception) if defined? @chain_exception
+                chain.clear
               end
 
               ##
               # @return [Boolean]
               #
               def chain_called?
-                Utils.to_bool(defined? @chain_called)
+                chain.has_key?(:called)
               end
 
               ##
@@ -134,7 +136,7 @@ module ConvenientService
               def chain_value
                 ::ConvenientService.raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :value) unless chain_called?
 
-                @chain_value
+                chain[:value]
               end
 
               ##
@@ -144,7 +146,7 @@ module ConvenientService
               def chain_args
                 ::ConvenientService.raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :args) unless chain_called?
 
-                @chain_arguments.args
+                chain[:arguments].args
               end
 
               ##
@@ -154,7 +156,7 @@ module ConvenientService
               def chain_kwargs
                 ::ConvenientService.raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :kwargs) unless chain_called?
 
-                @chain_arguments.kwargs
+                chain[:arguments].kwargs
               end
 
               ##
@@ -164,7 +166,7 @@ module ConvenientService
               def chain_block
                 ::ConvenientService.raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :block) unless chain_called?
 
-                @chain_arguments.block
+                chain[:arguments].block
               end
 
               ##
@@ -174,7 +176,7 @@ module ConvenientService
               def chain_exception
                 ::ConvenientService.raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :exception) unless chain_called?
 
-                @chain_exception
+                chain[:exception]
               end
 
               ##
@@ -187,9 +189,19 @@ module ConvenientService
                 return false if entity != other.entity
                 return false if method != other.method
                 return false if observe_middleware != other.observe_middleware
+                return false if chain != other.chain
 
                 true
               end
+
+              protected
+
+              ##
+              # @return [Hash{Symbol => Object}]
+              #
+              def chain
+                @chain ||= {}
+              end
             end
           end
         end

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

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "entities/wrapped_method"

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Helpers

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "wrap_method/entities"
 require_relative "wrap_method/exceptions"
 

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

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+require_relative "classes/in_threads"
+
+require_relative "classes/ignoring_exception"
 require_relative "classes/stub_service"
+require_relative "classes/stub_entry"
 require_relative "classes/wrap_method"

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

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Helpers
       module IgnoringException
         def ignoring_exception(...)
-          RSpec::PrimitiveHelpers::Classes::IgnoringException.call(...)
+          Classes::IgnoringException.call(...)
         end
       end
     end

data/lib/convenient_service/rspec/{primitive_helpers → helpers}/in_threads.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveHelpers
+    module Helpers
       module InThreads
         def in_threads(...)
           Classes::InThreads.call(...)

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module StubEntry
+        ##
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubEntry]
+        #
+        def stub_entry(...)
+          Classes::StubEntry.call(...)
+        end
+
+        ##
+        # @param value [Object] Can be any type.
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubEntry::Entities::ValueSpec]
+        #
+        def return_value(value)
+          Classes::StubEntry::Entities::ValueSpec.new(value: value)
+        end
+      end
+    end
+  end
+end

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

@@ -1,25 +1,46 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Helpers
       module StubService
+        ##
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubService]
+        #
         def stub_service(...)
           Classes::StubService.call(...)
         end
 
+        ##
+        # @param status [Symbol]
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubService::Entities::ResultSpec]
+        #
         def return_result(status)
           Classes::StubService::Entities::ResultSpec.new(status: status)
         end
 
+        ##
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubService::Entities::ResultSpec]
+        #
         def return_success
           Classes::StubService::Entities::ResultSpec.new(status: :success)
         end
 
+        ##
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubService::Entities::ResultSpec]
+        #
         def return_failure
           Classes::StubService::Entities::ResultSpec.new(status: :failure)
         end
 
+        ##
+        # @return [ConvenientService::RSpec::Helpers::StubEntry::Classes::StubService::Entities::ResultSpec]
+        #
         def return_error
           Classes::StubService::Entities::ResultSpec.new(status: :error)
         end

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Helpers

data/lib/convenient_service/rspec/helpers.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "helpers/classes"
 
 require_relative "helpers/ignoring_exception"
+require_relative "helpers/in_threads"
+
 require_relative "helpers/stub_service"
+require_relative "helpers/stub_entry"
 require_relative "helpers/wrap_method"
 
 module ConvenientService
@@ -12,8 +20,11 @@ module ConvenientService
       include Support::Concern
 
       included do
+        include InThreads
+
         include IgnoringException
         include StubService
+        include StubEntry
         include WrapMethod
       end
     end

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/be_descendant_of.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module BeDescendantOf
         def be_descendant_of(...)
           Classes::BeDescendantOf.new(...)

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/be_direct_descendant_of.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module BeDirectDescendantOf
         def be_direct_descendant_of(...)
           Classes::BeDirectDescendantOf.new(...)

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/cache_its_value.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module CacheItsValue
         def cache_its_value(...)
           Classes::CacheItsValue.new(...)

data/lib/convenient_service/rspec/matchers/call_chain_next.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Matchers

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/classes/be_descendant_of.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module Classes
         ##
         # NOTE: Navigate to the link below and `Ctrl + F` for "Custom Matcher from scratch"

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/classes/be_direct_descendant_of.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module Classes
         ##
         # NOTE: Navigate to the link below and `Ctrl + F` for "Custom Matcher from scratch"

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/classes/cache_its_value.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module Classes
         class CacheItsValue
           ##

data/lib/convenient_service/rspec/matchers/classes/call_chain_next.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
     module Matchers

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/classes/delegate_to/commands/generate_printable_method.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module Classes
         class DelegateTo
           module Commands
@@ -29,11 +34,14 @@ module ConvenientService
                 @method = method
               end
 
+              ##
+              # @return [String]
+              #
               def call
                 case Utils::Object.resolve_type(object)
                 when "class", "module"
                   "#{object}.#{method}"
-                when "instance"
+                else # "instance"
                   "#{object.class}##{method}"
                 end
               end

data/lib/convenient_service/rspec/matchers/classes/delegate_to/commands.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+require_relative "commands/generate_printable_method"

data/lib/convenient_service/rspec/{primitive_matchers → matchers}/classes/delegate_to/entities/delegation.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module RSpec
-    module PrimitiveMatchers
+    module Matchers
       module Classes
         class DelegateTo
           module Entities
@@ -11,7 +16,7 @@ module ConvenientService
               # @api private
               #
               # @!attribute [r] arguments
-              #   @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Entities::Delegation]
+              #   @return [ConvenientService::RSpec::Matchers::Classes::DelegateTo::Entities::Delegation]
               #
               attr_reader :arguments
 

data/lib/convenient_service/rspec/matchers/classes/delegate_to/entities/inputs/jruby.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+##
+# HACK: For some reason, the following spec if NOT passing in JRuby:
+#
+#   # spec/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/concern/instance_methods_spec.rb:205
+#   RSpec.describe ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Concern::InstanceMethods, type: :standard do
+#     include ConvenientService::RSpec::Matchers::DelegateTo
+#
+#     let(:service_class) do
+#       Class.new do
+#         include ConvenientService::Standard::Config
+#       end
+#     end
+#
+#     let(:service_instance) { service_class.new }
+#
+#     let(:result_class) { service_class.result_class }
+#
+#     let(:result_instance) { result_class.new(**params) }
+#
+#     let(:params) do
+#       {
+#         service: service_instance,
+#         status: status,
+#         data: {foo_foo_foo: :bar},
+#         message: "foo",
+#         code: :foo,
+#         **extra_kwargs
+#       }
+#     end
+#
+#     let(:status) { :foo }
+#
+#     let(:extra_kwargs) { {} }
+#
+#     specify do
+#       expect { result_instance.create_data!(params[:data]) }
+#         .to delegate_to(result_class.data_class, :cast!)
+#           .with_arguments(params[:data])
+#           .and_return { |data| data.copy(overrides: {kwargs: {result: result_instance}}) }
+#     end
+#
+#  That is why JRuby has its own version of `delegation_value` method.
+#
+#  To debug, place the following code inside `delegation_value` method.
+#
+#     if expected_arguments.args == [{foo_foo_foo: :bar}]
+#       binding.pry
+#     end
+#
+#  And run RSpec with `JRUBY_OPTS='--debug'`.
+#
+return unless ConvenientService::Dependencies.ruby.match?("jruby < 10.1")
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Classes
+        class DelegateTo
+          module Entities
+            class Inputs
+              ##
+              # @api private
+              #
+              # @return [Object] Can be any type.
+              #
+              def delegation_value
+                return values[:delegation_value] if values.has_key?(:delegation_value)
+
+                values[:delegation_value] =
+                  case
+                  when expected_arguments.args.any? && expected_arguments.kwargs.any? && expected_arguments.block
+                    object.__send__(method, *expected_arguments.args, **expected_arguments.kwargs, &expected_arguments.block)
+                  when expected_arguments.args.any? && expected_arguments.kwargs.any? && !expected_arguments.block
+                    object.__send__(method, *expected_arguments.args, **expected_arguments.kwargs)
+                  when expected_arguments.args.any? && !expected_arguments.kwargs.any? && expected_arguments.block
+                    object.__send__(method, *expected_arguments.args, &expected_arguments.block)
+                  when !expected_arguments.args.any? && expected_arguments.kwargs.any? && expected_arguments.block
+                    object.__send__(method, **expected_arguments.kwargs, &expected_arguments.block)
+                  when expected_arguments.args.any? && !expected_arguments.kwargs.any? && !expected_arguments.block
+                    object.__send__(method, *expected_arguments.args)
+                  when !expected_arguments.args.any? && expected_arguments.kwargs.any? && !expected_arguments.block
+                    object.__send__(method, **expected_arguments.kwargs)
+                  when !expected_arguments.args.any? && !expected_arguments.kwargs.any? && expected_arguments.block
+                    object.__send__(method, &expected_arguments.block)
+                  else
+                    object.__send__(method)
+                  end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end