storyboard.md

Storyboard

Contents

• Why Use Storyboards
• How To Use Storyboards
• verify_storyboard

Why Use Storyboards

Sometimes we might want to see different steps in a workflow or lifetime of an object. Storyboards are a convenience object to help enable that.

Approvaltests allows us to look at a complete object instead of just pieces of it. Storyboards allow us to track an object through time.

The mechanism to map time to space that storyboards use is very analogous to a comic book, but with each frame vertically after each other so that it works well with the diff tool and shows a progression.

How To Use Storyboards

Here is example of creating story board, adding content to it, and verifying it.

story = Storyboard()
story.add_description("Spinning wheel")
story.add_frame(ascii_wheel)
ascii_wheel.advance()
story.add_frame(ascii_wheel)
verify(story)

^{snippet source | anchor}

will produce

Spinning wheel

Initial:
-

Frame #1:
\

^{snippet source | anchor}

verify_storyboard

You can also use the with verify_storyboard() as b: syntax which will verify the storyboard on context exit.

---

Back to top