ckib16 / seeing_is_believing

Displays the results of every line of code in your file

Unix/Mac:    Windows:

Seeing Is Believing

Evaluates Ruby code, recording the results of each line. Integrates with any extensible editor (I've integrated it with many already, see the list). If you like Swift Playgrounds, you'll like SiB.

Helpful links

• Install
• Integrate with your editor
• Use as a library
• Use on the command line
• Pro Tips (useful patterns)
• Features
• Potential Future Features
• Set up it up for development work

Examples

• Watch a longer video.
• Watch John Cinnamond use it in a presentation at the 10 minute mark.
• Avdi uses it in Ruby Tapas, an amazing resource for developers in general and Ruby Developers in particular!

Known Issues

• Assumes utf-8 everywhere. If this is an issue, please see the encodings section of the wiki.
• begin; else; break; end this code (an else without a rescue) will emit a warning in Ruby, and is omitted from Parser's AST. As such, I doubt that anyone will ever write it. But if you were to write it, it would blow up, because SiB rewrites your code, wrapping every expression that could have a value. This code will be wrapped. But using the value is syntactically invalid in Ruby, because it constitutes a "void value expression" (aka a pointless time sink and the cause of many bugs in SiB). Unfortunately, I can't easily check it to see if it's void since it's not in the parsed AST. But it's so edge that I don't think it's worth worrying about.

Inspiration

• Xmpfilter, which is a part of the rcodetools gem.
• Bret Victor's completely inspiring talk Inventing on Principle.
• My 8th Light mentor, Doug Bradbury who asked me to make it for his Kids Ruby sessions (I don't think we ever finished integrating it, though >.<)

Shout outs

• Whitequark for all the work on Parser, which dramatically dramatically improved SiB (I used to have my own horribly shitty line-based parser)
• Travis CI... I love you times a million! So many difficult bugs have been caught by this. It's so easy to work with, astoundingly convenient, helps me guarantee that SiB works on everyone else's computers, too. And it's free since SiB is open source. I literally have a Travis CI sticker on my laptop, I love you that much.

License

Copyright (C) 2014 Josh Cheek <[e-mail]>

This program is free software. It comes without any warranty,
to the extent permitted by applicable law.
You can redistribute it and/or modify it under the terms of the
Do What The Fuck You Want To Public License,
Version 2, as published by Sam Hocevar.
See http://www.wtfpl.net/ for more details.