chore(tests2png): add first version of PNG diagram generator #757

staltz · 2015-11-20T04:23:21Z

Build Jasmine helper that detects tests tagged with asDiagram() and runs a painter script to create
a PNG marble diagram out of them.

First attempt at resolving #697.

kwonoj · 2015-11-20T04:32:38Z

Seems travis is not happy with changes - is this PR work in progress?

staltz · 2015-11-21T12:09:59Z

Now passing tests.

kwonoj · 2015-11-23T00:57:11Z

Does images supposed to be checked in, or to be generated on each local machine?

kwonoj · 2015-11-23T00:58:07Z

package.json

let's remove ^ to stay with specific version as same as other libraries.

staltz · 2015-11-23T12:34:12Z

Does images supposed to be checked in, or to be generated on each local machine?

I don't know, that's up to us. What do you suggest? They could be generated at the same time docs are generated. Primary reason why I checked them in is to show how the diagrams look like, for review. :)

staltz · 2015-11-23T17:56:34Z

This is now feature complete. It generates diagrams for the trickiest cases:

Cold observables that start emitting after a while has passed

Observable of Observables as input

Observable of Observables as output

When this is merged, all we need to do is add it.asDiagram(label) test cases to all operator spec files.

kwonoj · 2015-11-23T19:05:28Z

They could be generated at the same time docs are generated.

: Think this makes sense, doc could include this diagrams so doesn't require to generate it manually per each users.

kwonoj · 2015-11-23T19:06:22Z

spec/operators/buffer-spec.js

so does it.asDiagram() serves as test case as well as diagram generator?

Yes, both. Only it.asDiagram specs are used for tests2png, but both it and it.asDiagram are used for npm test.

benlesh · 2015-11-23T23:13:50Z

WOOO! That is some fancy work, @staltz

staltz · 2015-11-24T01:02:43Z

:)

staltz · 2015-11-24T12:21:23Z

@kwonoj images removed from git, and fixed that // commented line.

kwonoj · 2015-11-24T21:58:11Z

I'll try to look in detail around tomorrow, stuck in bed with flu all day.

benlesh · 2015-11-24T22:00:23Z

I'll try to look in detail around tomorrow, stuck in bed with flu all day.

Yuck. Get better.

benlesh · 2015-11-25T21:23:10Z

@staltz can you rebase?

Build Jasmine helper that detects tests tagged with asDiagram() and runs a painter script to create a PNG marble diagram out of them. First attempt at resolving ReactiveX#697.

Support drawing diagrams of cold observables with an offset in time to account for the time they get subscribed to, specially important in diagrams such as for the concat operator. For issue ReactiveX#697.

…rble Improve the looks of the complete marker when it overlaps with a marble (both happen at the same VirtualTimeScheduler frame, or are very close in time). For issue ReactiveX#697.

For issue ReactiveX#697.

Support diagrams for Observable of Observables, either as inputs or as outputs. Add example usage for mergeAll, switch, and groupBy For issue ReactiveX#697.

For issue ReactiveX#697.

Create img folder before running image generation script, and use verbose output when debugging. For issue ReactiveX#697.

staltz · 2015-11-25T21:30:53Z

@Blesh Rebased.

benlesh · 2015-11-25T22:27:30Z

@staltz I've pulled it down and tried it out. It definitely works.

I ran into a few issues I think we should address in this PR though:

I didn't know what "imagemagick", "graphicsmagick" or "ghostscript" were or how to install them. I figured it out eventually (used brew), but we'll need to have that part documented.
I still don't really know how it decides which tests to make PNGs from. How is this configured? Can O do anything ad hoc with it?
it wrote to img/ and that's fine, but it should probably be in .gitignore.

Overall a VERY COOL PR!

staltz · 2015-11-26T12:10:12Z

I still don't really know how it decides which tests to make PNGs from. How is this configured? Can O do anything ad hoc with it?

I can write down how to configure a test to be converted to a PNG. But the general case of ad hoc generating PNGs is not supported. If it would, it would make sense to make that a separate library.

staltz · 2015-11-26T13:02:20Z

@Blesh some few commits added to fix issues you mentioned.

staltz · 2015-11-26T13:04:48Z

Tests failing just because markdown-doctest doesn't recognize it() from Jasmine and prefers to blow up.

staltz · 2015-11-30T08:32:47Z

@Widdershin how do I configure .markdown-doctest-setup.js? Do I need to require Jasmine or can I somehow mock it() calls?

Widdershin · 2015-11-30T08:38:53Z

@staltz You could probably do either, but my instinct is just to mock it out.

If you add something like this to .markdown-doctest-setup.js:

var it = {
  asDiagram: function (name) {
    return function (label, callback) {
      callback()
    }
  }
}

And then add it to the exported globals object:

  globals: {
    ...
    it: it
  },

That should do the trick. Does that make sense?

staltz · 2015-11-30T08:42:55Z

Hmm, I'll try that! Thanks!

staltz · 2015-11-30T09:04:24Z

@Blesh I fixed the markdown-doctest. Maybe now it's good to merge.

benlesh · 2015-11-30T17:27:12Z

Awesome stuff @staltz! Merged with 30a6214

🎉🎉🎉

staltz · 2015-11-30T17:37:19Z

Woot!!!

I'll start going wild by making diagrams for all operators :)

staltz mentioned this pull request Nov 20, 2015

Generating marble diagram PNGs from tests to documentation #697

Closed

staltz force-pushed the marble-diagram-generator branch from 1158c80 to 3ebb2cf Compare November 20, 2015 04:28

staltz force-pushed the marble-diagram-generator branch 2 times, most recently from 82a349b to 7584ac4 Compare November 21, 2015 11:58

kwonoj reviewed Nov 23, 2015
View reviewed changes

staltz added 8 commits November 25, 2015 19:25

chore(tests2png): add first version of PNG diagram generator

14e1b5f

Build Jasmine helper that detects tests tagged with asDiagram() and runs a painter script to create a PNG marble diagram out of them. First attempt at resolving ReactiveX#697.

chore(tests2png): support diagrams of cold observables

cb4380a

Support drawing diagrams of cold observables with an offset in time to account for the time they get subscribed to, specially important in diagrams such as for the concat operator. For issue ReactiveX#697.

chore(tests2png): prettify Complete marker when it overlaps with a ma…

62c9f9c

…rble Improve the looks of the complete marker when it overlaps with a marble (both happen at the same VirtualTimeScheduler frame, or are very close in time). For issue ReactiveX#697.

chore(tests2png): add dynamic color for marbles, according to content

ed2b51e

For issue ReactiveX#697.

chore(tests2png): fix version of 'gm' to 1.21.1

5760dbf

For issue ReactiveX#697.

chore(tests2png): support diagrams of higher-order Observables

8d0881c

Support diagrams for Observable of Observables, either as inputs or as outputs. Add example usage for mergeAll, switch, and groupBy For issue ReactiveX#697.

chore(tests2png): remove generated images from git

5638d08

For issue ReactiveX#697.

chore(tests2png): improve image generation script

2f7fdf9

Create img folder before running image generation script, and use verbose output when debugging. For issue ReactiveX#697.

staltz force-pushed the marble-diagram-generator branch from d240045 to 2f7fdf9 Compare November 25, 2015 21:30

staltz added 2 commits November 26, 2015 10:58

docs(tests2png): add installation and usage instructions for tests2png

a7d60ef

chore(tests2png): make Git ignore img/ directory

b40d25b

staltz mentioned this pull request Nov 30, 2015

Proposal : migrate unit test to typescript #826

Closed

test(tests2png): fix markdown-doctest to recognize it.asDiagram() specs

9901615

benlesh closed this Nov 30, 2015

staltz deleted the marble-diagram-generator branch November 30, 2015 17:37

tg44 mentioned this pull request Oct 3, 2018

Streams operators docs DIAGRAMS (ticket only for diagrams) akka/akka-core#24933

Open

lock bot locked as resolved and limited conversation to collaborators Jan 18, 2019

chore(tests2png): add first version of PNG diagram generator #757

chore(tests2png): add first version of PNG diagram generator #757

Uh oh!

Conversation

staltz commented Nov 20, 2015

Uh oh!

kwonoj commented Nov 20, 2015

Uh oh!

staltz commented Nov 21, 2015

Uh oh!

kwonoj commented Nov 23, 2015

Uh oh!

kwonoj Nov 23, 2015

Choose a reason for hiding this comment

Uh oh!

staltz Nov 23, 2015

Choose a reason for hiding this comment

Uh oh!

staltz commented Nov 23, 2015

Uh oh!

staltz commented Nov 23, 2015

Uh oh!

kwonoj commented Nov 23, 2015

Uh oh!

kwonoj Nov 23, 2015

Choose a reason for hiding this comment

Uh oh!

staltz Nov 23, 2015

Choose a reason for hiding this comment

Uh oh!

benlesh commented Nov 23, 2015

Uh oh!

staltz commented Nov 24, 2015

Uh oh!

staltz commented Nov 24, 2015

Uh oh!

kwonoj commented Nov 24, 2015

Uh oh!

benlesh commented Nov 24, 2015

Uh oh!

benlesh commented Nov 25, 2015

Uh oh!

staltz commented Nov 25, 2015

Uh oh!

benlesh commented Nov 25, 2015

Uh oh!

staltz commented Nov 26, 2015

Uh oh!

staltz commented Nov 26, 2015

Uh oh!

staltz commented Nov 26, 2015

Uh oh!

staltz commented Nov 30, 2015

Uh oh!

Widdershin commented Nov 30, 2015

Uh oh!

staltz commented Nov 30, 2015

Uh oh!

staltz commented Nov 30, 2015

Uh oh!

benlesh commented Nov 30, 2015

Uh oh!

staltz commented Nov 30, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants