Skip to content

Commit

Permalink
#1643 IoCheckedText
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor256 committed Jul 13, 2022
1 parent 5bc1e01 commit a7644f3
Show file tree
Hide file tree
Showing 3 changed files with 281 additions and 21 deletions.
34 changes: 13 additions & 21 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -147,31 +147,23 @@ SOFTWARE.
</dependency>
</dependencies>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-verifier-plugin</artifactId>
<version>1.1</version>
<executions>
<execution>
<id>main</id>
<phase>package</phase>
<goals>
<goal>verify</goal>
</goals>
<configuration>
<verificationFile>src/verifier/verifications.xml</verificationFile>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-verifier-plugin</artifactId>
<version>1.1</version>
<executions>
<execution>
<id>main</id>
<phase>package</phase>
<goals>
<goal>verify</goal>
</goals>
<configuration>
<verificationFile>src/verifier/verifications.xml</verificationFile>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
Expand Down
115 changes: 115 additions & 0 deletions src/main/java/org/cactoos/text/IoCheckedText.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/*
* 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.text;

import java.io.IOException;
import org.cactoos.Func;
import org.cactoos.Text;
import org.cactoos.func.UncheckedFunc;

/**
* Text that doesn't throw checked {@link Exception}, but only
* throws {@link IOException}.
*
* <p>There is no thread-safety guarantee.
*
* @since 0.51
*/
public final class IoCheckedText implements Text {

/**
* Original text.
*/
private final Text text;

/**
* Fallback.
*/
private final Func<Exception, String> fallback;

/**
* Ctor.
* @param txt Encapsulated text
* @since 0.9
*/
public IoCheckedText(final CharSequence txt) {
this(new TextOf(txt));
}

/**
* Ctor.
* @param txt Encapsulated text
*/
@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
public IoCheckedText(final Text txt) {
this(
txt,
error -> {
throw new RuntimeException(error);
}
);
}

/**
* Ctor.
* @param txt Encapsulated text
* @param fbk Fallback func if {@link Exception} happens
* @since 0.5
*/
public IoCheckedText(final Text txt, final Func<Exception, String> fbk) {
this.text = txt;
this.fallback = fbk;
}

@Override
@SuppressWarnings({"PMD.AvoidCatchingGenericException", "PMD.AvoidRethrowingException"})
public String asString() throws IOException {
String txt;
try {
txt = this.text.asString();
} catch (final IOException ex) {
throw ex;
// @checkstyle IllegalCatchCheck (1 line)
} catch (final Exception ex) {
txt = new UncheckedFunc<>(this.fallback).apply(ex);
}
return txt;
}

@Override
public String toString() {
return new UncheckedText(this).toString();
}

@Override
public boolean equals(final Object obj) {
return new UncheckedText(this).equals(obj);
}

@Override
public int hashCode() {
return this.toString().hashCode();
}

}
153 changes: 153 additions & 0 deletions src/test/java/org/cactoos/text/IoCheckedTextTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/*
* 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.text;

import java.io.IOException;
import org.cactoos.Text;
import org.hamcrest.core.IsEqual;
import org.hamcrest.core.IsNot;
import org.hamcrest.core.StringContains;
import org.hamcrest.object.HasToString;
import org.junit.jupiter.api.Test;
import org.llorllale.cactoos.matchers.Assertion;
import org.llorllale.cactoos.matchers.Throws;

/**
* Test case for {@link IoCheckedText}.
*
* @since 0.51
* @checkstyle JavadocMethodCheck (500 lines)
* @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
*/
final class IoCheckedTextTest {

@Test
void rethrowsCheckedIoException() {
final String msg = "intended IO error";
new Assertion<>(
"Must throw same IO exception",
new IoCheckedText(
() -> {
throw new IOException(msg);
}
)::asString,
new Throws<>(
new StringContains(msg),
IOException.class
)
).affirm();
}

@Test
@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
void rethrowsCheckedToUncheckedException() {
final String msg = "intended";
new Assertion<>(
"Must throw an exception when something goes wrong",
new IoCheckedText(
() -> {
throw new Exception(msg);
}
)::asString,
new Throws<>(
new StringContains(msg),
RuntimeException.class
)
).affirm();
}

@Test
void toStringMustReturnSameOfAsString() {
final String text = "one";
new Assertion<>(
"Must implement #toString which returns the same of #asString",
new IoCheckedText(
new TextOf(text)
),
new HasToString<>(
new IsEqual<>(text)
)
).affirm();
}

@Test
void equalsToTheSameTextObject() {
final Text text = new TextOf("anything");
new Assertion<>(
"Must match text representing the same value",
new IoCheckedText(text),
new IsEqual<>(text)
).affirm();
}

@Test
void equalsOtherTextRepresentingTheSameValue() {
new Assertion<>(
"Must match another text representing the same value",
new IoCheckedText(
new TextOf("abcdefghijkl")
),
new IsEqual<>(
new Concatenated("ab", "cde", "fghi", "j", "kl")
)
).affirm();
}

@Test
void equalsNonTextObject() {
new Assertion<>(
"Must does not match another object which is not a string",
new IoCheckedText(
new TextOf("is not equals to null")
),
new IsNot<>(
new IsEqual<>(new Object())
)
).affirm();
}

@Test
@SuppressWarnings("PMD.EqualsNull")
void notEqualsWhenAnObjectIsNull() {
new Assertion<>(
"Must match equals null",
new IoCheckedText(
new TextOf("is not equals to not Text object")
).equals(null),
new IsEqual<>(false)
).affirm();
}

@Test
void matchTheSameHashCode() {
final String text = "hashCode";
new Assertion<>(
"Must match its represented String hashcode",
new IoCheckedText(
new TextOf(text)
).hashCode(),
new IsEqual<>(text.hashCode())
).affirm();
}
}

0 comments on commit a7644f3

Please sign in to comment.