Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ThrowsOnFalse #1692

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions src/main/java/org/cactoos/scalar/ThrowsOnFalse.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2022 Yegor Bugayenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

package org.cactoos.scalar;

import org.cactoos.Scalar;

/**
* Throws an exception on false expression.
*
* @since 0.56.0
*/
public final class ThrowsOnFalse implements Scalar<Boolean> {

/**
* Logical statement.
*/
private final Scalar<Boolean> scalar;

/**
* Error message.
*/
private final String message;

/**
* Ctor.
* @param sclr Scalar
* @param msg Message
*/
public ThrowsOnFalse(final Scalar<Boolean> sclr, final String msg) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@h1alexbel can you also add a constructor ThrowsOnFalse(final Scalar<Boolean> sclr, final Scalar<Exception> exception) to allow the user to choose which exception will be thrown

this.scalar = sclr;
this.message = msg;
}

@Override
public Boolean value() throws Exception {
if (!this.scalar.value()) {
throw new IllegalArgumentException(
this.message
);
}
return true;
}
}
73 changes: 73 additions & 0 deletions src/test/java/org/cactoos/scalar/ThrowsOnFalseTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2022 Yegor Bugayenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

package org.cactoos.scalar;

import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

/**
* Test suite for {@link ThrowsOnFalse}.
*
* @since 0.56.0
*/
final class ThrowsOnFalseTest {

@Test
void throwsOnFalse() {
final String msg = "test message";
final String message =
Assertions.assertThrows(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@h1alexbel please use the Assertion class to write assertions, see other tests for some examples.

IllegalArgumentException.class,
() -> new ThrowsOnFalse(
() -> false, msg
).value()
).getMessage();
MatcherAssert.assertThat(
"Exception message in right format",
message,
Matchers.equalTo(msg)
);
}

@Test
void returnsTrueOnTrue() throws Exception {
MatcherAssert.assertThat(
"Returns true on true statement",
new ThrowsOnFalse(() -> true, "test").value(),
Matchers.equalTo(true)
);
}

@Test
void doesNotThrowOnTrue() {
Assertions.assertDoesNotThrow(
() -> new ThrowsOnFalse(
() -> true, "msg"
).value()
);
}
}