v3.0

[JoshCheek]

V3 is basically ready at this point. But I'm going to wait until my next break so I can try and make the editor integrations better. I figure a big version bump will get a little bit of attention, so it should be particularly slick when it rolls out. But I spent a lot of time on this (270 commits since I started my break) and want to spend the rest of it on https://github.com/JoshCheek/ruby_object_model_viewer

---

To accommodate the changes I want, should bump the major version. As long as I'm doing that, might as well stick in a bunch of things I want.

Code

Code is now on master, see the commits.
956bd0c..a38fcf4

Lots more stuff happened than is listed here. But I don't think anyone other than me cares about this, so not going to put the effort in to update it.

Features

• Library
  • Ability to specify in a per-line basis what kind of inspection should be used (basically, allow for the overriding of WrapExpressions keys) Record inspections by type (e.g. :inspect and :pp), and Caller can inject their own expression wrapping.
  • SeeingIsBelieving::VERSION is available to the program (it's something I often want to see). completed
• Binary
  • Upgrade to latest Parser
  • Ability to get an event stream, so that someone could get the events as they occur rather than at the end. Probably emit events each on one-line and in JSON format. Maybe try implementing it in atom-seeing-is-believing. 6893b81
  • Display xmpfilter previous-line annotations with pretty-print (for Support pp for large/complex structures #44)
  • Deprecate --shebang since RbConfig.ruby gives the information we needed this for.

Cleanup

• Generally, tons of stuff happened here. A lot more than is listed.
• Renamings in EventStream + split it out into multiple files
• Rename CleanBody -> RemoveAnnotations
• Refactor that POS AddAnnotations. Probably there are two objects in there, one for sib style, one for xmpfilter style, also, it is annoying that we get the result from AddAnnotations, it conceptually should take a file and a set of results, and add them on each line.
• Make sure I actually like the Result class (I don't particularly, but it solves a relevant issue).
• Probably get rid of the line class (the exception is already on Result, other than that it's just an array) completed
• Parser fixed the heredoc bugs, so doesn't need the stupid hacks I wrote. Probably they are littered all over ParserHelpers and WrapExpressions
• Figure out this encoding bullshit (Encoding variable is wrong #33)
• Switch syntax checking to use Pry's trick (Switch syntax checking to use pry's trick #38)
• Get rid of --start-line and --end-line and instead have maybe --show-lines, a comma-separated array of lines to display output on (e.g. I can't think of a start/end line use-case, but it makes sense to want to see the current line, but then show for multiple cursors or where a user has marked in their editor)

Other

• Order frog stickers I NEED JOSH CHEEK FROG PERSON STICKERS #14

Descoped

• Add a changelog (I added one, but didn't keep it up)
• Get it working on JRuby and Rbx (already put a lot of work into this, but a bug in current version of JRuby, and inability to install Rbx due to not having llvm are preventing me from getting it at the moment -- actually, I might try again, this worked for me)
• Use custom evaluators to support safe mode (integration with eval_in) (I no longer intend to do this 17db7e9)
• Expose ability to provide custom evaluators. (I only need one now. If anyone else needs one, they can ask me to do this. It shouldn't be hard, but don't see the need for the indirection at present.
• auto-record rescued exceptions (seemed like a lot of work without an obvious benefit)
• Track, for each line, what kind of obj it's recording (e.g. method def/literal/etc) and provide an interface for the user to specify what they would like to see. (going to have to wait until the next version, it's just going to take a lot of effort)
• A hybrid chunk/file line aligner that tries to line everything up for the whole file, but will discard outliers that are fucking it up. (might still do this one)
• Would be nice to find a way to deal with Atom identifying the file change too quickly. (yeah, idk what it would be)
• Would be nice to bundle a ruby executable with the editor integrations so newbies can just install with the editor's package manager instead of having to configure everything. (Traveling Ruby was what I was thinking, but it doesn't support Windows)

[JoshCheek]

TODO list is now primarily stored in the source code as "TODO" comments. Kinda stinks b/c you can't see it from the outside, but I find those a lot more engaging (ie I'm a lot more likely to actually do them).

[JoshCheek]

V3 is released.