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

#939 AppendTo for appending content to files #1021

Merged
merged 9 commits into from
Feb 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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
69 changes: 69 additions & 0 deletions src/main/java/org/cactoos/io/AppendTo.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2018 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.io;

import java.io.File;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
import org.cactoos.Output;

/**
* Output that appends content to a given file.
*
* <p>There is no thread-safety guarantee.
*
* @since 1.0
*/
public final class AppendTo implements Output {

/**
* Source of the output.
*/
private final File source;

/**
* Ctor.
* @param path Path as a source of a File.
*/
public AppendTo(final Path path) {
this(path.toFile());
}

/**
* Ctor.
* @param src File to which content will be appended.
*/
public AppendTo(final File src) {
this.source = src;
}

@Override
public OutputStream stream() throws Exception {
return Files.newOutputStream(
this.source.toPath(), StandardOpenOption.APPEND
);
}
}
111 changes: 111 additions & 0 deletions src/test/java/org/cactoos/io/AppendToTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2018 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.io;

import java.io.File;
import java.nio.charset.StandardCharsets;
import java.nio.file.NoSuchFileException;
import org.cactoos.text.JoinedText;
import org.cactoos.text.Randomized;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.llorllale.cactoos.matchers.Assertion;
import org.llorllale.cactoos.matchers.InputHasContent;
import org.llorllale.cactoos.matchers.Throws;

/**
* Test case for {@link AppendTo}.
*
* @since 1.0
* @checkstyle ClassDataAbstractionCouplingCheck (100 lines)
*/
public final class AppendToTest {

/**
* Temporary files and folders generator.
*/
@Rule
public final TemporaryFolder folder = new TemporaryFolder();
Copy link
Contributor

Choose a reason for hiding this comment

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

@llorllale is there an alternative to this TemporaryFolder @Rule?

Copy link
Contributor

Choose a reason for hiding this comment

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

@Iprogrammerr Please, go ahead here.


/**
* Ensures that AppendTo is failing on a negative predicate result.
*/
@Test
public void failsIfFileDoesNotExist() {
final File source = new File(
new Randomized(
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'
).asString()
);
new Assertion<>(
"Can't throw exception with proper message",
() -> () -> new AppendTo(source).stream(),
new Throws<>(
source.getPath(),
NoSuchFileException.class
)
).affirm();
}

/**
* Ensures that AppendTo is appending to a given file.
* @throws Exception if fails
*/
@Test
public void appendsToFile() throws Exception {
final File source = this.folder.newFile();
final String first = "abdcd";
new OutputTo(source).stream().write(first.getBytes());
final String second = "efgh";
Copy link
Contributor

Choose a reason for hiding this comment

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

@Iprogrammerr let's check with some unicode text too.

new AppendTo(source).stream().write(second.getBytes());
new Assertion<>(
"Does not contain expected text",
() -> new InputOf(source),
new InputHasContent(new JoinedText("", first, second))
).affirm();
}

/**
* Ensures that AppendTo is appending unicode text to a given file.
* @throws Exception if fails
*/
@Test
public void appendsUnicodeToFile() throws Exception {
final File source = this.folder.newFile();
final String first = "Hello, товарищ output #3 äÄ ";
new OutputTo(source)
.stream()
.write(first.getBytes(StandardCharsets.UTF_8));
final String second = "#4 äÄ üÜ öÖ and ß";
new AppendTo(source)
.stream()
.write(second.getBytes(StandardCharsets.UTF_8));
new Assertion<>(
"Can't find expected unicode text content",
() -> new InputOf(source),
new InputHasContent(new JoinedText("", first, second))
).affirm();
}
}