F!! storyboard has better spacing

Author: isidore

approvaltests-tests/src/test/java/org/approvaltests/StoryBoardTest.gameOfLifeWithDescription.approved.txt

@@ -1,43 +1,56 @@
-Game of Life
-
-Initial:
-.  .  .  .  .  
-.  .  .  .  .  
-.  x  x  x  .  
-.  .  .  .  .  
-.  .  .  .  .  
-
-
-Start Game:
-.  .  .  .  .  
-.  .  x  .  .  
-.  .  x  .  .  
-.  .  x  .  .  
-.  .  .  .  .  
-
-
-Frame #2:
-.  .  .  .  .  
-.  .  .  .  .  
-.  x  x  x  .  
-.  .  .  .  .  
-.  .  .  .  .  
-
-
-setting alive: *
-setting dead: _
-
-Frame #3:
-_  _  _  _  _  
-_  _  *  _  _  
-_  _  *  _  _  
-_  _  *  _  _  
-_  _  _  _  _  
-
-
-Frame #4:
-_  _  _  _  _  
-_  _  _  _  _  
-_  *  *  *  _  
-_  _  _  _  _  
-_  _  _  _  _  
+Game of Life
+
+
+Initial:
+.  .  .  .  .  
+.  .  .  .  .  
+.  x  x  x  .  
+.  .  .  .  .  
+.  .  .  .  .  
+
+
+Start Game:
+.  .  .  .  .  
+.  .  x  .  .  
+.  .  x  .  .  
+.  .  x  .  .  
+.  .  .  .  .  
+
+
+Frame #2:
+.  .  .  .  .  
+.  .  .  .  .  
+.  x  x  x  .  
+.  .  .  .  .  
+.  .  .  .  .  
+
+
+setting alive: *
+setting dead: _
+
+
+Frame #3:
+_  _  _  _  _  
+_  _  *  _  _  
+_  _  *  _  _  
+_  _  *  _  _  
+_  _  _  _  _  
+
+
+Frame #4:
+_  _  _  _  _  
+_  _  _  _  _  
+_  *  *  *  _  
+_  _  _  _  _  
+_  _  _  _  _  
+
+
+setting dead:  
+
+
+Frame #5:
+               
+      *        
+      *        
+      *        
+               

approvaltests-tests/src/test/java/org/approvaltests/StoryBoardTest.java

@@ -34,6 +34,8 @@ void gameOfLifeWithDescription()
     storyboard.addDescriptionWithData("setting alive", gameOfLife.setAliveCell("*"));
     storyboard.addDescriptionWithData("setting dead", gameOfLife.setDeadCell("_"));
     storyboard.addFrames(2, gameOfLife::advance);
+    storyboard.addDescriptionWithData("setting dead", gameOfLife.setDeadCell(" "));
+    storyboard.addFrames(1, gameOfLife::advance);
     Approvals.verify(storyboard);
   }
   private static class GameOfLife

approvaltests/src/main/java/org/approvaltests/StoryBoard.java

@@ -4,9 +4,10 @@
 
 public class StoryBoard
 {
+  enum Types  {None, Description, Frame}
   private StringBuffer stringBuffer  = new StringBuffer();
   int                  index         = 0;
-  private boolean      newLineNeeded = false;
+  private Types      last = Types.None;
   public static <T> StoryBoard createSequence(T initial, int additionalFrames, Function0<T> getNextFrame)
   {
     return new StoryBoard().add(initial).addFrames(additionalFrames, getNextFrame);
@@ -18,11 +19,29 @@ public <T> StoryBoard add(T object)
   }
   public <T> StoryBoard addFrame(String title, T frame)
   {
-    String frameTitle = index == 0 ? title : "\n\n" + title;
+    addNewLines(Types.Frame);
+    String frameTitle =  title;
     stringBuffer.append(String.format("%s:\n%s", frameTitle, frame));
     index++;
     return this;
   }
+
+  private void addNewLines(Types type) {
+    switch (last){
+      case None:
+        break;
+      case Description:
+        if (type == Types.Frame){
+          stringBuffer.append("\n\n");
+        }
+        break;
+      case Frame:
+        stringBuffer.append("\n\n");
+        break;
+    }
+    last = type;
+  }
+
   public <T> StoryBoard addFrames(int howMany, Function0<T> getNextFrame)
   {
     for (int i = 0; i < howMany; i++)
@@ -36,28 +55,20 @@ public String toString()
   {
     return stringBuffer.toString();
   }
-  public void addDescription(String game_of_life)
+  public StoryBoard addDescription(String game_of_life)
   {
-    stringBuffer.append(game_of_life);
-    stringBuffer.append("\n");
-    stringBuffer.append("\n");
+    addNewLines(Types.Description);
+    stringBuffer.append(game_of_life+"\n");
+    return this;
   }
   public <T> StoryBoard addFrame(T frame)
   {
     return add(frame);
   }
   public <T> StoryBoard addDescriptionWithData(String description, String data)
   {
-    if (newLineNeeded)
-    {
-      stringBuffer.append("\n");
-    }
-    else
-    {
-      stringBuffer.append("\n\n");
-    }
-    newLineNeeded = true;
-    stringBuffer.append(description + ": " + data);
+    addNewLines(Types.Description);
+    stringBuffer.append(description + ": " + data + "\n");
     return this;
   }
 }