feat(has_negated_result): introduce #negated_result

lib/convenient_service/service/configs/minimal.rb

@@ -55,6 +55,7 @@ module Minimal
             use ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern
 
             use ConvenientService::Plugins::Service::HasResult::Concern
+            use ConvenientService::Plugins::Service::HasNegatedResult::Concern
             use ConvenientService::Plugins::Service::HasJSendResult::Concern
             use ConvenientService::Plugins::Service::CanHaveSteps::Concern
           end

lib/convenient_service/service/plugins.rb

@@ -5,6 +5,8 @@
 #   NOTE: Order matters.
 #
 require_relative "plugins/has_result"
+require_relative "plugins/has_negated_result"
+
 require_relative "plugins/has_j_send_result"
 
 require_relative "plugins/can_recalculate_result"

lib/convenient_service/service/plugins/has_negated_result.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "has_negated_result/concern"
+require_relative "has_negated_result/exceptions"

lib/convenient_service/service/plugins/has_negated_result/concern.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasNegatedResult
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @api public
+            # @raise [ConvenientService::Service::Plugins::HasNegatedResult::Exceptions::NegatedResultIsNotOverridden]
+            #
+            def negated_result(...)
+              new(...).negated_result
+            end
+          end
+
+          instance_methods do
+            ##
+            # @api public
+            # @raise [ConvenientService::Service::Plugins::HasNegatedResult::Exceptions::NegatedResultIsNotOverridden]
+            #
+            def negated_result
+              ::ConvenientService.raise Exceptions::NegatedResultIsNotOverridden.new(service: self)
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/convenient_service/service/plugins/has_negated_result/exceptions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasNegatedResult
+        module Exceptions
+          class NegatedResultIsNotOverridden < ::ConvenientService::Exception
+            def initialize_with_kwargs(service:)
+              message = <<~TEXT
+                Negated result method (#negated_result) of `#{service.class}` is NOT overridden.
+              TEXT
+
+              initialize(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

spec/lib/convenient_service/examples/dry/gemfile/dry_service/config_spec.rb

@@ -36,6 +36,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern,
               ConvenientService::Common::Plugins::CachesConstructorArguments::Concern,

spec/lib/convenient_service/examples/dry/v1/gemfile/dry_service/config_spec.rb

@@ -36,6 +36,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern,
               ConvenientService::Common::Plugins::CachesConstructorArguments::Concern,

spec/lib/convenient_service/examples/rails/gemfile/rails_service/config_spec.rb

@@ -36,6 +36,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern,
               ConvenientService::Common::Plugins::CachesConstructorArguments::Concern,

spec/lib/convenient_service/examples/rails/v1/gemfile/rails_service/config_spec.rb

@@ -36,6 +36,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern,
               ConvenientService::Common::Plugins::CachesConstructorArguments::Concern,

spec/lib/convenient_service/service/configs/awesome_print_inspect_spec.rb

@@ -97,7 +97,7 @@
       # https://github.com/marian13/convenient_service/discussions/43
       #
       it "applies its `included` block only once" do
-        expect(service_class.concerns.to_a.size).to eq(8)
+        expect(service_class.concerns.to_a.size).to eq(9)
       end
     end
   end

spec/lib/convenient_service/service/configs/minimal_spec.rb

@@ -33,6 +33,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern
             ]

spec/lib/convenient_service/service/configs/standard/v1_spec.rb

@@ -34,6 +34,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern,
               ConvenientService::Common::Plugins::CachesConstructorArguments::Concern,

spec/lib/convenient_service/service/configs/standard_spec.rb

@@ -34,6 +34,7 @@
               ConvenientService::Common::Plugins::HasConstructor::Concern,
               ConvenientService::Plugins::Common::HasConstructorWithoutInitialize::Concern,
               ConvenientService::Service::Plugins::HasResult::Concern,
+              ConvenientService::Service::Plugins::HasNegatedResult::Concern,
               ConvenientService::Service::Plugins::HasJSendResult::Concern,
               ConvenientService::Service::Plugins::CanHaveSteps::Concern,
               ConvenientService::Common::Plugins::CachesConstructorArguments::Concern,

spec/lib/convenient_service/service/plugins/has_negated_result/concern_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+require "convenient_service"
+
+# rubocop:disable RSpec/MultipleMemoizedHelpers
+RSpec.describe ConvenientService::Service::Plugins::HasNegatedResult::Concern do
+  include ConvenientService::RSpec::Helpers::IgnoringException
+
+  include ConvenientService::RSpec::Matchers::DelegateTo
+
+  let(:service_class) do
+    Class.new do
+      include ConvenientService::Service::Configs::Minimal
+    end
+  end
+
+  let(:service_instance) { service_class.new }
+  let(:negated_result) { service_instance.negated_result }
+
+  let(:args) { [:foo] }
+  let(:kwargs) { {foo: :bar} }
+  let(:block) { proc { :foo } }
+
+  example_group "modules" do
+    include ConvenientService::RSpec::Matchers::IncludeModule
+    include ConvenientService::RSpec::PrimitiveMatchers::ExtendModule
+
+    subject { described_class }
+
+    it { is_expected.to include_module(ConvenientService::Support::Concern) }
+
+    context "when included" do
+      subject { service_class }
+
+      let(:service_class) do
+        Class.new.tap do |klass|
+          klass.class_exec(described_class) do |mod|
+            include mod
+          end
+        end
+      end
+
+      it { is_expected.to include_module(described_class::InstanceMethods) }
+      it { is_expected.to extend_module(described_class::ClassMethods) }
+    end
+  end
+
+  example_group "instance methods" do
+    describe "#negated_result" do
+      let(:exception_message) do
+        <<~TEXT
+          Negated result method (#negated_result) of `#{service_class}` is NOT overridden.
+        TEXT
+      end
+
+      it "raises `ConvenientService::Service::Plugins::HasNegatedResult::Exceptions::NegatedResultIsNotOverridden`" do
+        expect { negated_result }
+          .to raise_error(ConvenientService::Service::Plugins::HasNegatedResult::Exceptions::NegatedResultIsNotOverridden)
+          .with_message(exception_message)
+      end
+
+      specify do
+        expect { ignoring_exception(ConvenientService::Service::Plugins::HasNegatedResult::Exceptions::NegatedResultIsNotOverridden) { negated_result } }
+          .to delegate_to(ConvenientService, :raise)
+      end
+    end
+  end
+
+  example_group "class methods" do
+    include ConvenientService::RSpec::Helpers::IgnoringException
+    include ConvenientService::RSpec::Matchers::DelegateTo
+
+    let(:service_class) do
+      Class.new do
+        include ConvenientService::Service::Configs::Minimal
+
+        def negated_result
+          failure
+        end
+      end
+    end
+
+    describe ".negated_result" do
+      specify do
+        expect { service_class.negated_result(*args, **kwargs, &block) }
+          .to delegate_to(service_class, :new)
+          .with_arguments(*args, **kwargs, &block)
+      end
+
+      specify do
+        allow(service_class).to receive(:new).and_return(service_instance)
+
+        expect { service_class.negated_result(*args, **kwargs, &block) }
+          .to delegate_to(service_instance, :negated_result)
+          .and_return_its_value
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/MultipleMemoizedHelpers

spec/lib/convenient_service/service/plugins/has_negated_result/exceptions_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+require "convenient_service"
+
+RSpec.describe ConvenientService::Service::Plugins::HasNegatedResult::Exceptions do
+  include ConvenientService::RSpec::PrimitiveMatchers::BeDescendantOf
+
+  specify { expect(described_class::NegatedResultIsNotOverridden).to be_descendant_of(ConvenientService::Exception) }
+end