F!! AwtApprovals.verifySequenceWithTimings

Author: actions-user

approvaltests-tests/src/test/java/org/approvaltests/awt/ApprovalsTest.java

@@ -1,15 +1,19 @@
 package org.approvaltests.awt;
 
-import com.spun.util.Tuple;
 import java.time.Duration;
+
 import org.approvaltests.core.Options;
-import org.approvaltests.reporters.*;
+import org.approvaltests.reporters.FileCaptureReporter;
+import org.approvaltests.reporters.ImageWebReporter;
+import org.approvaltests.reporters.UseReporter;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.DisabledOnJre;
 import org.junit.jupiter.api.condition.EnabledOnJre;
 import org.junit.jupiter.api.condition.JRE;
 
+import com.spun.util.Tuple;
+
 //@UseReporter({FileCaptureReporter.class})
 public class ApprovalsTest
 {
@@ -41,7 +45,15 @@ void testSequence()
   {
     SquareDrawer squareDrawer = new SquareDrawer();
     AwtApprovals.verifySequence(5, f -> squareDrawer.setSquareSize(f * 10));
-//    AwtApprovals.verifySequence(5, Duration.ofMillis(500), f -> squareDrawer.setSquareSize(f * 10));
-//    AwtApprovals.verifySequence(5, f -> new Tuple(squareDrawer.setSquareSize(f * 10), Duration.ofMillis(500));
+    //    AwtApprovals.verifySequence(5, Duration.ofMillis(500), f -> squareDrawer.setSquareSize(f * 10));
+  }
+  @Test
+  @UseReporter(ImageWebReporter.class)
+  void testSequenceWithTimings()
+  {
+    SquareDrawer squareDrawer = new SquareDrawer();
+    AwtApprovals.verifySequenceWithTimings(5,
+        f -> new Tuple<>(squareDrawer.setSquareSize(f * 10), Duration.ofSeconds(1 + f)));
+    // TODO: write documentation
   }
 }

approvaltests-tests/src/test/java/org/approvaltests/awt/ApprovalsTest.testSequenceWithTimings.approved.gif

@@ -3,6 +3,7 @@
 import java.awt.Component;
 import java.awt.Image;
 import java.awt.image.BufferedImage;
+import java.time.Duration;
 
 import org.approvaltests.Approvals;
 import org.approvaltests.core.Options;
@@ -14,6 +15,7 @@
 import org.lambda.functions.Function1;
 
 import com.spun.swing.Paintable;
+import com.spun.util.Tuple;
 import com.spun.util.images.ImageWriter;
 
 public class AwtApprovals
@@ -57,9 +59,20 @@ public static void verifySequence(int numberOfFrames, Function1<Integer, Paintab
   {
     verifySequence(numberOfFrames, sequenceRenderer, new Options());
   }
+  public static void verifySequenceWithTimings(int numberOfFrames,
+      Function1<Integer, Tuple<Paintable, Duration>> sequenceRenderer)
+  {
+    verifySequenceWithTimings(numberOfFrames, sequenceRenderer, new Options());
+  }
+  public static void verifySequenceWithTimings(int numberOfFrames,
+      Function1<Integer, Tuple<Paintable, Duration>> sequenceRenderer, Options options)
+  {
+    Approvals.verify(new PaintableMultiframeWriter(numberOfFrames, sequenceRenderer), options);
+  }
   public static void verifySequence(int numberOfFrames, Function1<Integer, Paintable> sequenceRenderer,
       Options options)
   {
-    Approvals.verify(new PaintableMultiframeWriter(numberOfFrames, sequenceRenderer), options);
+    Approvals.verify(new PaintableMultiframeWriter(numberOfFrames,
+        c -> new Tuple<>(sequenceRenderer.call(c), Duration.ofMillis(500))), options);
   }
 }

approvaltests/src/main/java/org/approvaltests/awt/AwtApprovals.java

@@ -8,6 +8,7 @@
 // License. To view a copy of this license, visit
 // http://creativecommons.org/licenses/by/3.0/ or send a letter to Creative
 // Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
+import com.spun.util.Tuple;
 import java.awt.image.BufferedImage;
 import java.awt.image.RenderedImage;
 import java.io.File;
@@ -16,6 +17,7 @@
 import java.util.ArrayList;
 import java.util.Iterator;
 
+import java.util.List;
 import javax.imageio.IIOException;
 import javax.imageio.IIOImage;
 import javax.imageio.ImageIO;
@@ -88,16 +90,16 @@ public static byte[] getBytesForLoopContinuously(boolean loopContinuously)
     byte[] once = {1, 1, 0};
     return loopContinuously ? loop : once;
   }
-  static File writeAnimatedGif(File imageFile, ArrayList<BufferedImage> images, Duration timeBetweenFrames)
+  static File writeAnimatedGif(File imageFile, List<Tuple<BufferedImage, Duration>> images)
   {
     try (ImageOutputStream output = new FileImageOutputStream(imageFile))
     {
-      try (GifSequenceWriter writer = new GifSequenceWriter(output, images.get(0).getType(), timeBetweenFrames,
+      try (GifSequenceWriter writer = new GifSequenceWriter(output, images.get(0).getFirst().getType(), Duration.ZERO,
           true))
       {
-        for (BufferedImage image : images)
+        for (Tuple<BufferedImage, Duration> image : images)
         {
-          writer.writeToSequence(image, timeBetweenFrames);
+          writer.writeToSequence(image.getFirst(), image.getSecond());
         }
       }
     }

approvaltests/src/main/java/org/approvaltests/awt/GifSequenceWriter.java

@@ -1,5 +1,6 @@
 package org.approvaltests.awt;
 
+import com.spun.util.Tuple;
 import java.awt.image.BufferedImage;
 import java.io.File;
 import java.time.Duration;
@@ -14,24 +15,25 @@
 public class PaintableMultiframeWriter implements ApprovalWriter
 {
   private int                           numberOfFrames;
-  private Function1<Integer, Paintable> frameGetter;
-  public PaintableMultiframeWriter(int numberOfFrames, Function1<Integer, Paintable> frameGetter)
+  private Function1<Integer, Tuple<Paintable,Duration>> frameGetter;
+  public PaintableMultiframeWriter(int numberOfFrames, Function1<Integer, Tuple<Paintable,Duration>> frameGetter)
   {
     this.numberOfFrames = numberOfFrames;
     this.frameGetter = frameGetter;
   }
   @Override
   public File writeReceivedFile(File received)
   {
-    return GifSequenceWriter.writeAnimatedGif(received, getBufferedImages(), Duration.ofMillis(500));
+    return GifSequenceWriter.writeAnimatedGif(received, getBufferedImages());
   }
-  private ArrayList<BufferedImage> getBufferedImages()
+  private ArrayList<Tuple<BufferedImage, Duration>> getBufferedImages()
   {
-    ArrayList<BufferedImage> images = new ArrayList<>();
+    ArrayList<Tuple<BufferedImage, Duration>> images = new ArrayList<>();
     for (int i = 0; i < numberOfFrames; i++)
     {
-      BufferedImage image = PaintableApprovalWriter.drawComponent(frameGetter.call(i));
-      images.add(image);
+      final Tuple<Paintable, Duration> tuple = frameGetter.call(i);
+      BufferedImage image = PaintableApprovalWriter.drawComponent(tuple.getFirst());
+      images.add(new Tuple<>(image, tuple.getSecond()));
     }
     return images;
   }