TMI-136: Added abstract MetadataWriter, along with preliminary IPTCWriter + test cases. Retrofit EXIFWriter. Loads of small changes and clean-up.

imageio/imageio-metadata/src/test/java/com/twelvemonkeys/imageio/metadata/MetadataReaderAbstractTest.java

@@ -79,7 +79,7 @@ public abstract class MetadataReaderAbstractTest {
         assertNotNull(directory);
     }
 
-    protected final Matcher<Entry> hasValue(final Object value) {
+    protected static Matcher<Entry> hasValue(final Object value) {
         return new EntryHasValue(value);
     }
 

imageio/imageio-metadata/src/test/java/com/twelvemonkeys/imageio/metadata/MetadataWriterAbstractTest.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2012, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name "TwelveMonkeys" nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.imageio.metadata;
+
+import com.twelvemonkeys.imageio.stream.URLImageInputStreamSpi;
+import org.junit.Test;
+
+import javax.imageio.ImageIO;
+import javax.imageio.spi.IIORegistry;
+import javax.imageio.stream.ImageInputStream;
+import javax.imageio.stream.MemoryCacheImageOutputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.util.ArrayList;
+
+/**
+ * ReaderAbstractTest
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haraldk$
+ * @version $Id: ReaderAbstractTest.java,v 1.0 04.01.12 09:40 haraldk Exp$
+ */
+public abstract class MetadataWriterAbstractTest {
+    static {
+        IIORegistry.getDefaultInstance().registerServiceProvider(new URLImageInputStreamSpi());
+        ImageIO.setUseCache(false);
+    }
+
+    protected final URL getResource(final String name) throws IOException {
+        return getClass().getResource(name);
+    }
+
+    protected final ImageInputStream getDataAsIIS() throws IOException {
+        return ImageIO.createImageInputStream(getData());
+    }
+
+    protected abstract InputStream getData() throws IOException;
+
+    protected abstract MetadataWriter createWriter();
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testWriteNullDirectory() throws IOException {
+        createWriter().write(null, new MemoryCacheImageOutputStream(new ByteArrayOutputStream()));
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testWriteNullStream() throws IOException {
+        createWriter().write(new AbstractDirectory(new ArrayList<Entry>()) {
+        }, null);
+    }
+}

imageio/imageio-metadata/src/test/java/com/twelvemonkeys/imageio/metadata/exif/EXIFWriterTest.java

@@ -28,24 +28,17 @@
 
 package com.twelvemonkeys.imageio.metadata.exif;
 
-import com.twelvemonkeys.imageio.metadata.AbstractDirectory;
-import com.twelvemonkeys.imageio.metadata.AbstractEntry;
-import com.twelvemonkeys.imageio.metadata.Directory;
-import com.twelvemonkeys.imageio.metadata.Entry;
+import com.twelvemonkeys.imageio.metadata.*;
 import com.twelvemonkeys.imageio.stream.ByteArrayImageInputStream;
-import com.twelvemonkeys.imageio.stream.URLImageInputStreamSpi;
 import com.twelvemonkeys.io.FastByteArrayOutputStream;
 import org.junit.Test;
 
 import javax.imageio.ImageIO;
-import javax.imageio.spi.IIORegistry;
-import javax.imageio.stream.ImageInputStream;
 import javax.imageio.stream.ImageOutputStream;
 import javax.imageio.stream.ImageOutputStreamImpl;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.net.URL;
 import java.nio.ByteOrder;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -61,37 +54,25 @@ import static org.junit.Assert.assertNotNull;
  * @author last modified by $Author: haraldk$
  * @version $Id: EXIFWriterTest.java,v 1.0 18.07.13 09:53 haraldk Exp$
  */
-public class EXIFWriterTest {
-    static {
-        IIORegistry.getDefaultInstance().registerServiceProvider(new URLImageInputStreamSpi());
-        ImageIO.setUseCache(false);
-    }
+public class EXIFWriterTest extends MetadataWriterAbstractTest {
 
-    protected final URL getResource(final String name) throws IOException {
-        return getClass().getResource(name);
-    }
-
-    protected final ImageInputStream getDataAsIIS() throws IOException {
-        return ImageIO.createImageInputStream(getData());
-    }
-
-    //    @Override
+    @Override
     protected InputStream getData() throws IOException {
         return getResource("/exif/exif-jpeg-segment.bin").openStream();
     }
 
-//    @Override
     protected EXIFReader createReader() {
         return new EXIFReader();
     }
 
+    @Override
     protected EXIFWriter createWriter() {
         return new EXIFWriter();
     }
 
     @Test
     public void testWriteReadSimple() throws IOException {
-        ArrayList<Entry> entries = new ArrayList<Entry>();
+        ArrayList<Entry> entries = new ArrayList<>();
         entries.add(new EXIFEntry(TIFF.TAG_ORIENTATION, 1, TIFF.TYPE_SHORT));
         entries.add(new EXIFEntry(TIFF.TAG_IMAGE_WIDTH, 1600, TIFF.TYPE_SHORT));
         entries.add(new AbstractEntry(TIFF.TAG_IMAGE_HEIGHT, 900) {});
@@ -139,7 +120,7 @@ public class EXIFWriterTest {
 
     @Test
     public void testWriteMotorola() throws IOException {
-        ArrayList<Entry> entries = new ArrayList<Entry>();
+        ArrayList<Entry> entries = new ArrayList<>();
         entries.add(new AbstractEntry(TIFF.TAG_SOFTWARE, "TwelveMonkeys ImageIO") {});
         entries.add(new EXIFEntry(TIFF.TAG_IMAGE_WIDTH, Integer.MAX_VALUE, TIFF.TYPE_LONG));
         Directory directory = new AbstractDirectory(entries) {};
@@ -174,7 +155,7 @@ public class EXIFWriterTest {
 
     @Test
     public void testWriteIntel() throws IOException {
-        ArrayList<Entry> entries = new ArrayList<Entry>();
+        ArrayList<Entry> entries = new ArrayList<>();
         entries.add(new AbstractEntry(TIFF.TAG_SOFTWARE, "TwelveMonkeys ImageIO") {});
         entries.add(new EXIFEntry(TIFF.TAG_IMAGE_WIDTH, Integer.MAX_VALUE, TIFF.TYPE_LONG));
         Directory directory = new AbstractDirectory(entries) {};
@@ -254,7 +235,7 @@ public class EXIFWriterTest {
 
     @Test
     public void testComputeIFDSize() throws IOException {
-        ArrayList<Entry> entries = new ArrayList<Entry>();
+        ArrayList<Entry> entries = new ArrayList<>();
         entries.add(new EXIFEntry(TIFF.TAG_ORIENTATION, 1, TIFF.TYPE_SHORT));
         entries.add(new EXIFEntry(TIFF.TAG_IMAGE_WIDTH, 1600, TIFF.TYPE_SHORT));
         entries.add(new AbstractEntry(TIFF.TAG_IMAGE_HEIGHT, 900) {});

imageio/imageio-metadata/src/test/java/com/twelvemonkeys/imageio/metadata/iptc/IPTCWriterTest.java

@@ -0,0 +1,72 @@
+package com.twelvemonkeys.imageio.metadata.iptc;
+
+import com.twelvemonkeys.imageio.metadata.Directory;
+import com.twelvemonkeys.imageio.metadata.MetadataWriter;
+import com.twelvemonkeys.imageio.metadata.MetadataWriterAbstractTest;
+import com.twelvemonkeys.imageio.stream.ByteArrayImageInputStream;
+import org.junit.Test;
+
+import javax.imageio.stream.MemoryCacheImageOutputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assume.assumeNotNull;
+
+/**
+ * IPTCWriterTest.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: harald.kuhr$
+ * @version $Id: IPTCWriterTest.java,v 1.0 05/06/15 harald.kuhr Exp$
+ */
+public class IPTCWriterTest extends MetadataWriterAbstractTest {
+    @Override
+    protected InputStream getData() throws IOException {
+        return getResource("/iptc/iptc-jpeg-segment.bin").openStream();
+    }
+
+    @Override
+    protected MetadataWriter createWriter() {
+        return new IPTCWriter();
+    }
+
+    private IPTCReader createReader() {
+        return new IPTCReader();
+    }
+
+    @Test
+    public void testRewriteExisting() throws IOException {
+        IPTCReader reader = createReader();
+        Directory iptc = reader.read(getDataAsIIS());
+        assumeNotNull(iptc);
+
+        ByteArrayOutputStream bytes = new ByteArrayOutputStream();
+        MemoryCacheImageOutputStream stream = new MemoryCacheImageOutputStream(bytes);
+        createWriter().write(iptc, stream);
+        stream.close();
+
+        Directory written = reader.read(new ByteArrayImageInputStream(bytes.toByteArray()));
+        assertEquals(iptc, written);
+    }
+
+    @Test
+    public void testWrite() throws IOException {
+        List<IPTCEntry> entries = new ArrayList<>();
+        entries.add(new IPTCEntry(IPTC.TAG_KEYWORDS, new String[] {"Uno", "Due", "Tre"}));
+
+        Directory iptc = new IPTCDirectory(entries);
+
+        ByteArrayOutputStream bytes = new ByteArrayOutputStream();
+        MemoryCacheImageOutputStream stream = new MemoryCacheImageOutputStream(bytes);
+        createWriter().write(iptc, stream);
+        stream.close();
+
+        Directory written = createReader().read(new ByteArrayImageInputStream(bytes.toByteArray()));
+        System.err.println("written: " + written);
+        assertEquals(iptc, written);
+    }
+}