Skip to content

Commit

Permalink
Merge branch '__rultor'
Browse files Browse the repository at this point in the history
  • Loading branch information
rultor committed Jan 15, 2021
2 parents ec5bfcf + 9746028 commit ecb0cf4
Show file tree
Hide file tree
Showing 2 changed files with 253 additions and 0 deletions.
84 changes: 84 additions & 0 deletions src/main/java/org/cactoos/scalar/Xor.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2020 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;
import org.cactoos.iterable.IterableOf;
import org.cactoos.iterable.Joined;

/**
* Logical exclusive or.
* Returns {@link True} when an odd number of elements have value true,
* otherwise return {@link False}.
*
* <p>This class could be also used for matching multiple boolean
* expressions:</p>
*
* {@code
* new Xor(
* new True(),
* new True(),
* new True()
* ).value(); // the result is true
*
* new Xor(
* new True(),
* new False(),
* new True()
* ).value(); // the result is false
* }
*
* <p>This class implements {@link Scalar}, which throws a checked
* {@link Exception}. This may not be convenient in many cases. To make
* it more convenient and get rid of the checked exception you can
* use the {@link Unchecked} decorator. Or you may use
* {@link IoChecked} to wrap it in an IOException.</p>
*
* <p>There is no thread-safety guarantee.
*
* @see Unchecked
* @see IoChecked
* @since 0.49
*/
public final class Xor extends ScalarEnvelope<Boolean> {

/**
* Ctor.
* @param scalar The Scalar.
*/
@SafeVarargs
public Xor(final Scalar<Boolean>... scalar) {
this(new IterableOf<>(scalar));
}

/**
* Ctor.
* @param iterable The iterable.
*/
public Xor(final Iterable<Scalar<Boolean>> iterable) {
super(new Reduced<>((a, b) -> a ^ b, new Joined<>(new False(), iterable))
);
}
}
169 changes: 169 additions & 0 deletions src/test/java/org/cactoos/scalar/XorTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2020 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;
import org.cactoos.iterable.IterableOf;
import org.junit.jupiter.api.Test;
import org.llorllale.cactoos.matchers.Assertion;
import org.llorllale.cactoos.matchers.ScalarHasValue;

/**
* Test case for {@link Xor}.
* @since 0.48
*/
@SuppressWarnings({"PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods"})
final class XorTest {

@Test
void trueTrue() throws Exception {
new Assertion<>(
"Either one, but not both nor none",
new Xor(
new True(),
new True()
),
new ScalarHasValue<>(false)
).affirm();
}

@Test
void falseTrue() throws Exception {
new Assertion<>(
"Either one, but not both nor none",
new Xor(
new False(),
new True()
),
new ScalarHasValue<>(true)
).affirm();
}

@Test
void treuFalse() throws Exception {
new Assertion<>(
"Either one, but not both nor none",
new Xor(
new True(),
new False()
),
new ScalarHasValue<>(true)
).affirm();
}

@Test
void falseFalse() throws Exception {
new Assertion<>(
"Either one, but not both nor none",
new Xor(
new False(),
new False()
),
new ScalarHasValue<>(false)
).affirm();
}

@Test
void singleTrue() throws Exception {
new Assertion<>(
"Single True must be True",
new Xor(
new True()
),
new ScalarHasValue<>(true)
).affirm();
}

@Test
void singleFalse() throws Exception {
new Assertion<>(
"Single False must be False",
new Xor(
new False()
),
new ScalarHasValue<>(false)
).affirm();
}

@Test
void emptyIterable() throws Exception {
new Assertion<>(
"Empty iterable must be False",
new Xor(new IterableOf<Scalar<Boolean>>()),
new ScalarHasValue<>(false)
).affirm();
}

@Test
void oddNumberOfTrue() throws Exception {
new Assertion<>(
"Odd number of True must be True",
new Xor(
new False(),
new False(),
new True()
),
new ScalarHasValue<>(true)
).affirm();
}

@Test
void evenNumberOfTrue() throws Exception {
new Assertion<>(
"Even number of True must be False",
new Xor(
new False(),
new True(),
new True()
),
new ScalarHasValue<>(false)
).affirm();
}

@Test
void allFalse() throws Exception {
new Assertion<>(
"All False must be False",
new Xor(
new False(),
new False(),
new False()
),
new ScalarHasValue<>(false)
).affirm();
}

@Test
void allTrue() throws Exception {
new Assertion<>(
"Odd number of True must be True",
new Xor(
new True(),
new True(),
new True()
),
new ScalarHasValue<>(true)
).affirm();
}
}

0 comments on commit ecb0cf4

Please sign in to comment.