Add tests and some missing conversions to AbstractOrigin subclasses

Author: garydgregory

src/changes/changes.xml

@@ -68,6 +68,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="add" due-to="Gary Gregory">
         Add AbstractStreamBuilder.setOpenOptions(OpenOption...).
       </action>
+      <action dev="ggregory" type="add" due-to="Gary Gregory">
+        Add some missing conversions to AbstractOrigin subclasses.
+      </action>
       <!-- UPDATE -->
     </release>
     <release version="2.12.0" date="2023-05-13" description="Java 8 required.">

src/main/java/org/apache/commons/io/build/AbstractOrigin.java

@@ -21,7 +21,9 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.InputStreamReader;
 import java.io.OutputStream;
+import java.io.OutputStreamWriter;
 import java.io.Reader;
 import java.io.Writer;
 import java.net.URI;
@@ -32,6 +34,10 @@
 import java.nio.file.Paths;
 import java.util.Objects;
 
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.input.ReaderInputStream;
+import org.apache.commons.io.output.WriterOutputStream;
+
 /**
  * Abstracts the origin of data for builders like a {@link File}, {@link Path}, {@link Reader}, {@link Writer}, {@link InputStream}, {@link OutputStream}, and
  * {@link URI}.
@@ -71,6 +77,11 @@ public InputStream getInputStream(final OpenOption... options) throws IOExceptio
             return new ByteArrayInputStream(origin);
         }
 
+        @Override
+        public Reader getReader(final Charset charset) throws IOException {
+            return new InputStreamReader(getInputStream(), charset);
+        }
+
     }
 
     /**
@@ -87,6 +98,12 @@ public CharSequenceOrigin(final CharSequence origin) {
             super(origin);
         }
 
+        @Override
+        public byte[] getByteArray() {
+            // TODO Pass in a Charset? Consider if call sites actually need this.
+            return origin.toString().getBytes(Charset.defaultCharset());
+        }
+
         @Override
         public CharSequence getCharSequence(final Charset charset) {
             // No conversion
@@ -101,6 +118,11 @@ public InputStream getInputStream(final OpenOption... options) throws IOExceptio
             // return CharSequenceInputStream.builder().setCharSequence(getCharSequence(Charset.defaultCharset())).get();
         }
 
+        @Override
+        public Reader getReader(final Charset charset) throws IOException {
+            return new InputStreamReader(getInputStream(), charset);
+        }
+
     }
 
     /**
@@ -136,7 +158,7 @@ public Path getPath() {
     /**
      * An {@link InputStream} origin.
      * <p>
-     * This origin cannot provide other aspects.
+     * This origin cannot provide some of the other aspects.
      * </p>
      */
     public static class InputStreamOrigin extends AbstractOrigin<InputStream, InputStreamOrigin> {
@@ -150,18 +172,28 @@ public InputStreamOrigin(final InputStream origin) {
             super(origin);
         }
 
+        @Override
+        public byte[] getByteArray() throws IOException {
+            return IOUtils.toByteArray(origin);
+        }
+
         @Override
         public InputStream getInputStream(final OpenOption... options) {
             // No conversion
             return get();
         }
 
+        @Override
+        public Reader getReader(final Charset charset) throws IOException {
+            return new InputStreamReader(getInputStream(), charset);
+        }
+
     }
 
     /**
      * An {@link OutputStream} origin.
      * <p>
-     * This origin cannot provide other aspects.
+     * This origin cannot provide some of the other aspects.
      * </p>
      */
     public static class OutputStreamOrigin extends AbstractOrigin<OutputStream, OutputStreamOrigin> {
@@ -181,6 +213,10 @@ public OutputStream getOutputStream(final OpenOption... options) {
             return get();
         }
 
+        @Override
+        public Writer getWriter(final Charset charset, final OpenOption... options) throws IOException {
+            return new OutputStreamWriter(origin, charset);
+        }
     }
 
     /**
@@ -230,6 +266,23 @@ public ReaderOrigin(final Reader origin) {
             super(origin);
         }
 
+        @Override
+        public byte[] getByteArray() throws IOException {
+            // TODO Pass in a Charset? Consider if call sites actually need this.
+            return IOUtils.toByteArray(origin, Charset.defaultCharset());
+        }
+
+        @Override
+        public CharSequence getCharSequence(final Charset charset) throws IOException {
+            return IOUtils.toString(origin);
+        }
+
+        @Override
+        public InputStream getInputStream(final OpenOption... options) throws IOException {
+            // TODO Pass in a Charset? Consider if call sites actually need this.
+            return ReaderInputStream.builder().setReader(origin).setCharset(Charset.defaultCharset()).get();
+        }
+
         @Override
         public Reader getReader(final Charset charset) throws IOException {
             // No conversion
@@ -280,6 +333,12 @@ public WriterOrigin(final Writer origin) {
             super(origin);
         }
 
+        @Override
+        public OutputStream getOutputStream(final OpenOption... options) throws IOException {
+            // TODO Pass in a Charset? Consider if call sites actually need this.
+            return WriterOutputStream.builder().setWriter(origin).setCharset(Charset.defaultCharset()).get();
+        }
+
         @Override
         public Writer getWriter(final Charset charset, final OpenOption... options) throws IOException {
             // No conversion
@@ -315,7 +374,7 @@ public T get() {
      * Gets this origin as a byte array, if possible.
      *
      * @return this origin as a byte array, if possible.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException                   if an I/O error occurs.
      * @throws UnsupportedOperationException if the origin cannot be converted to a Path.
      */
     public byte[] getByteArray() throws IOException {
@@ -327,7 +386,7 @@ public byte[] getByteArray() throws IOException {
      *
      * @param charset The charset to use if conversion from bytes is needed.
      * @return this origin as a byte array, if possible.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException                   if an I/O error occurs.
      * @throws UnsupportedOperationException if the origin cannot be converted to a Path.
      */
     public CharSequence getCharSequence(final Charset charset) throws IOException {
@@ -349,7 +408,7 @@ public File getFile() {
      *
      * @param options options specifying how the file is opened
      * @return this origin as an InputStream, if possible.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException                   if an I/O error occurs.
      * @throws UnsupportedOperationException if the origin cannot be converted to a Path.
      */
     public InputStream getInputStream(final OpenOption... options) throws IOException {
@@ -361,7 +420,7 @@ public InputStream getInputStream(final OpenOption... options) throws IOExceptio
      *
      * @param options options specifying how the file is opened
      * @return this origin as an OutputStream, if possible.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException                   if an I/O error occurs.
      * @throws UnsupportedOperationException if the origin cannot be converted to a Path.
      */
     public OutputStream getOutputStream(final OpenOption... options) throws IOException {
@@ -395,7 +454,7 @@ public Reader getReader(final Charset charset) throws IOException {
      * @param charset the charset to use for encoding
      * @param options options specifying how the file is opened
      * @return a new Writer on the origin.
-     * @throws IOException if an I/O error occurs opening or creating the file.
+     * @throws IOException                   if an I/O error occurs opening or creating the file.
      * @throws UnsupportedOperationException if the origin cannot be converted to a Path.
      */
     public Writer getWriter(final Charset charset, final OpenOption... options) throws IOException {

src/test/java/org/apache/commons/io/build/AbstractOriginTest.java

@@ -0,0 +1,108 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.io.build;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Reader;
+import java.io.Writer;
+import java.nio.charset.Charset;
+import java.util.Objects;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link AbstractOrigin} and subclasses.
+ *
+ * @param <T> the type of instances to build.
+ * @param <B> the type of builder subclass.
+ */
+public abstract class AbstractOriginTest<T, B extends AbstractOrigin<T, B>> {
+
+    protected static final String FILE_NAME_RO = "src/test/resources/org/apache/commons/io/test-file-20byteslength.bin";
+    protected static final String FILE_NAME_RW = "target/" + AbstractOriginTest.class.getSimpleName() + ".txt";
+
+    protected AbstractOrigin<T, B> originRo;
+    protected AbstractOrigin<T, B> originRw;
+
+    protected AbstractOrigin<T, B> getOriginRo() {
+        return Objects.requireNonNull(originRo, "originRo");
+    }
+
+    protected AbstractOrigin<T, B> getOriginRw() {
+        return Objects.requireNonNull(originRw, "originRw");
+    }
+
+    protected void setOriginRo(final AbstractOrigin<T, B> origin) {
+        this.originRo = origin;
+    }
+
+    protected void setOriginRw(final AbstractOrigin<T, B> origin) {
+        this.originRw = origin;
+    }
+
+    @Test
+    public void testGetByteArray() throws IOException {
+        assertNotNull(getOriginRo().getByteArray());
+    }
+
+    @Test
+    public void testGetCharSequence() throws IOException {
+        assertNotNull(getOriginRo().getCharSequence(Charset.defaultCharset()));
+    }
+
+    @Test
+    public void testGetFile() {
+        assertNotNull(getOriginRo().getFile());
+    }
+
+    @Test
+    public void testGetInputStream() throws IOException {
+        try (final InputStream inputStream = getOriginRo().getInputStream()) {
+            assertNotNull(inputStream);
+        }
+    }
+
+    @Test
+    public void testGetOutputStream() throws IOException {
+        try (final OutputStream output = getOriginRw().getOutputStream()) {
+            assertNotNull(output);
+        }
+    }
+
+    @Test
+    public void testGetPath() {
+        assertNotNull(getOriginRo().getPath());
+    }
+
+    @Test
+    public void testGetReader() throws IOException {
+        try (final Reader reader = getOriginRo().getReader(Charset.defaultCharset())) {
+            assertNotNull(reader);
+        }
+    }
+
+    @Test
+    public void testGetWriter() throws IOException {
+        try (final Writer writer = getOriginRw().getWriter(Charset.defaultCharset())) {
+            assertNotNull(writer);
+        }
+    }
+}

src/test/java/org/apache/commons/io/build/ByteArrayOriginTest.java

@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.io.build;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link ByteArrayOrigin}.
+ *
+ * A ByteArrayOrigin can convert into some of the other aspects.
+ */
+public class ByteArrayOriginTest extends AbstractOriginTest<byte[], ByteArrayOrigin> {
+
+    @BeforeEach
+    public void beforeEach() {
+        setOriginRo(new ByteArrayOrigin(new byte[] { 0 }));
+        setOriginRw(new ByteArrayOrigin(new byte[] { 1 }));
+    }
+
+    @Override
+    @Test
+    public void testGetFile() {
+        // Cannot convert a byte[] to a File.
+        assertThrows(UnsupportedOperationException.class, super::testGetFile);
+    }
+
+    @Override
+    @Test
+    public void testGetOutputStream() {
+        // Cannot convert a byte[] to an OutputStream.
+        assertThrows(UnsupportedOperationException.class, super::testGetOutputStream);
+    }
+
+    @Override
+    @Test
+    public void testGetPath() {
+        // Cannot convert a byte[] to a Path.
+        assertThrows(UnsupportedOperationException.class, super::testGetPath);
+    }
+
+    @Override
+    @Test
+    public void testGetWriter() {
+        // Cannot convert a byte[] to a Writer.
+        assertThrows(UnsupportedOperationException.class, super::testGetWriter);
+    }
+
+}