Skip to content

Commit

Permalink
feat(has_j_send_result_short_syntax): allow to pass data, message, co…
Browse files Browse the repository at this point in the history 
…de to all results
  • Loading branch information
@marian13
marian13 committed Sep 10, 2023
1 parent b8c479c commit aabf2f9
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 61 deletions.
27 changes: 10 additions & 17 deletions lib/convenient_service/service/plugins/has_j_send_result/concern/class_methods.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,18 @@ module ClassMethods
# @internal
# NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
#
# TODO: Is it OK to pass custom `message`, `code` to `success`? Why?
# NOTE: Extract to `HasJSendResults`.
#
def success(
service: new_without_initialize,
data: Constants::DEFAULT_SUCCESS_DATA
data: Constants::DEFAULT_SUCCESS_DATA,
message: Constants::DEFAULT_SUCCESS_MESSAGE,
code: Constants::DEFAULT_SUCCESS_CODE
)
result_class.new(
service: service,
status: Constants::SUCCESS_STATUS,
data: data,
message: Constants::SUCCESS_MESSAGE,
code: Constants::SUCCESS_CODE
message: message,
code: code
)
end

Expand All @@ -36,22 +35,18 @@ def success(
# @internal
# NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
#
# TODO: Is it OK to pass custom `code` to `failure`? Why?
# NOTE: Extract to `HasJSendResults`.
#
# TODO: `data.first.join(" ")` is duplicated in `be_result` matcher.
#
def failure(
service: new_without_initialize,
data: Constants::DEFAULT_FAILURE_DATA,
message: data.any? ? data.first.join(" ") : Constants::DEFAULT_FAILURE_MESSAGE
message: Constants::DEFAULT_FAILURE_MESSAGE,
code: Constants::DEFAULT_FAILURE_CODE
)
result_class.new(
service: service,
status: Constants::FAILURE_STATUS,
data: data,
message: message,
code: Constants::FAILURE_CODE
code: code
)
end

Expand All @@ -62,18 +57,16 @@ def failure(
# @internal
# NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
#
# TODO: Is it OK to pass custom `data` to `error`? Why?
# NOTE: Extract to `HasJSendResults`.
#
def error(
service: new_without_initialize,
data: Constants::DEFAULT_ERROR_DATA,
message: Constants::DEFAULT_ERROR_MESSAGE,
code: Constants::DEFAULT_ERROR_CODE
)
result_class.new(
service: service,
status: Constants::ERROR_STATUS,
data: Constants::ERROR_DATA,
data: data,
message: message,
code: code
)
Expand Down
111 changes: 67 additions & 44 deletions spec/lib/convenient_service/service/plugins/has_j_send_result/concern/class_methods_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,28 @@ def result
end
end

let(:service_instance) { service_class.new(*args, **kwargs, &block) }
let(:service_instance) { service_class.new }
let(:not_initialized_service_instance) { service_class.new_without_initialize }

let(:args) { [:foo] }
let(:kwargs) { {foo: :bar} }
let(:block) { proc { :foo } }
let(:params) { {service: service_instance, data: data, message: message, code: code} }
let(:data) { {foo: "bar"} }
let(:message) { "foo" }
let(:code) { :custom }

let(:constants) { ConvenientService::Service::Plugins::HasJSendResult::Constants }

example_group "class methods" do
include ConvenientService::RSpec::Matchers::BeDescendantOf
include ConvenientService::RSpec::Matchers::DelegateTo

describe "#success" do
let(:result) { service_class.success(**params) }
let(:params) { {service: service_instance, data: data} }
let(:data) { {foo: :bar} }

specify do
expect { result }
.to delegate_to(service_class.result_class, :new)
.with_arguments(service: service_instance, status: constants::SUCCESS_STATUS, data: data, message: constants::SUCCESS_MESSAGE, code: constants::SUCCESS_CODE)
.with_arguments(**params.merge(service: service_instance, status: constants::SUCCESS_STATUS))
end

context "when `service` is NOT passed" do
let(:result) { service_class.success(**ConvenientService::Utils::Hash.except(params, [:service])) }
let(:not_initialized_service_instance) { double }

before do
allow(service_class).to receive(:new_without_initialize).and_return(not_initialized_service_instance)
Expand All @@ -63,27 +59,46 @@ def result
end

it "defaults `data` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAUTL_SUCCESS_DATA`" do
expect(result.data).to eq(service_class.result_class.data(value: constants::DEFAULT_SUCCESS_DATA))
expect(result.data).to eq(result.create_data(constants::DEFAULT_SUCCESS_DATA))
end
end

context "when `message` is NOT passed" do
let(:result) { service_class.success(**ConvenientService::Utils::Hash.except(params, [:message])) }

before do
result.success?
end

it "defaults `message` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_SUCCESS_MESSAGE`" do
expect(result.message).to eq(result.create_message(constants::DEFAULT_SUCCESS_MESSAGE))
end
end

context "when `code` is NOT passed" do
let(:result) { service_class.success(**ConvenientService::Utils::Hash.except(params, [:code])) }

before do
result.success?
end

it "defaults `code` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_SUCCESS_CODE`" do
expect(result.code).to eq(result.create_code(ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_SUCCESS_CODE))
end
end
end

describe "#failure" do
let(:result) { service_class.failure(**params) }
let(:params) { {service: service_instance, data: data, message: message} }
let(:data) { {foo: "bar"} }
let(:message) { "foo" }
let(:first_pair_message) { data.first.join(" ") }

specify do
expect { result }
.to delegate_to(service_class.result_class, :new)
.with_arguments(service: service_instance, status: constants::FAILURE_STATUS, data: data, message: message, code: constants::FAILURE_CODE)
.with_arguments(**params.merge(service: service_instance, status: constants::FAILURE_STATUS))
end

context "when `service` is NOT passed" do
let(:result) { service_class.failure(**ConvenientService::Utils::Hash.except(params, [:service])) }
let(:not_initialized_service_instance) { double }

before do
allow(service_class).to receive(:new_without_initialize).and_return(not_initialized_service_instance)
Expand All @@ -98,54 +113,50 @@ def result
let(:result) { service_class.failure(**ConvenientService::Utils::Hash.except(params, [:data])) }

before do
result.success?
result.failure?
end

it "defaults `data` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_FAILURE_DATA`" do
expect(result.data).to eq(service_class.result_class.data(value: constants::DEFAULT_FAILURE_DATA))
it "defaults `data` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAUTL_FAILURE_DATA`" do
expect(result.data).to eq(result.create_data(constants::DEFAULT_FAILURE_DATA))
end
end

context "when `message` is NOT passed" do
let(:result) { service_class.failure(**ConvenientService::Utils::Hash.except(params, [:message])) }

context "when `data` is NOT empty" do
before do
result.success?
end
before do
result.failure?
end

it "defaults `message` to concatenated by space first key and first value from `data`" do
expect(result.message).to eq(service_class.result_class.message(value: first_pair_message))
end
it "defaults `message` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_FAILURE_MESSAGE`" do
expect(result.message).to eq(result.create_message(constants::DEFAULT_FAILURE_MESSAGE))
end
end

context "when `data` is empty" do
let(:result) { service_class.failure(**ConvenientService::Utils::Hash.except(params, [:message]).merge(data: {})) }
context "when `code` is NOT passed" do
let(:result) { service_class.failure(**ConvenientService::Utils::Hash.except(params, [:code])) }

it "internally passes `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_FAILURE_MESSAGE` as `message` to result constructor" do
expect { result }
.to delegate_to(service_class.result_class, :new)
.with_arguments(service: service_instance, status: constants::FAILURE_STATUS, data: {}, message: constants::DEFAULT_FAILURE_MESSAGE, code: constants::FAILURE_CODE)
end
before do
result.failure?
end

it "defaults `code` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_FAILURE_CODE`" do
expect(result.code).to eq(result.create_code(ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_FAILURE_CODE))
end
end
end

describe "#error" do
let(:result) { service_class.error(**params) }
let(:params) { {service: service_instance, message: message, code: code} }
let(:message) { "foo" }
let(:code) { :custom }

specify do
expect { result }
.to delegate_to(service_class.result_class, :new)
.with_arguments(service: service_instance, status: constants::ERROR_STATUS, data: constants::ERROR_DATA, message: message, code: code)
.with_arguments(**params.merge(service: service_instance, status: constants::ERROR_STATUS))
end

context "when `service` is NOT passed" do
let(:result) { service_class.error(**ConvenientService::Utils::Hash.except(params, [:service])) }
let(:not_initialized_service_instance) { double }

before do
allow(service_class).to receive(:new_without_initialize).and_return(not_initialized_service_instance)
Expand All @@ -156,27 +167,39 @@ def result
end
end

context "when `data` is NOT passed" do
let(:result) { service_class.error(**ConvenientService::Utils::Hash.except(params, [:data])) }

before do
result.error?
end

it "defaults `data` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAUTL_ERROR_DATA`" do
expect(result.data).to eq(result.create_data(constants::DEFAULT_ERROR_DATA))
end
end

context "when `message` is NOT passed" do
let(:result) { service_class.error(**ConvenientService::Utils::Hash.except(params, [:message])) }

before do
result.success?
result.error?
end

it "defaults `message` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_ERROR_MESSAGE`" do
expect(result.message).to eq(service_class.result_class.message(value: constants::DEFAULT_ERROR_MESSAGE))
expect(result.message).to eq(result.create_message(constants::DEFAULT_ERROR_MESSAGE))
end
end

context "when `code` is NOT passed" do
let(:result) { service_class.error(**ConvenientService::Utils::Hash.except(params, [:code])) }

before do
result.success?
result.error?
end

it "defaults `code` to `ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_ERROR_CODE`" do
expect(result.code).to eq(service_class.result_class.code(value: ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_ERROR_CODE))
expect(result.code).to eq(result.create_code(ConvenientService::Service::Plugins::HasJSendResult::Constants::DEFAULT_ERROR_CODE))
end
end
end
Expand Down

0 comments on commit aabf2f9

Please sign in to comment.