pretty-print the json fixtures about octokit.rb HOT 6 CLOSED

The v3 fixtures should all be pretty-printed. I'll convert v2's tonight, going forward the v3 ones should all be pretty too.

from octokit.rb.

The primary purpose of the fixtures is to simulate a response from the GitHub API, so I'm against modifying them, to avoid masking parsing errors.

It's unclear to me exactly why people are reading the fixtures, but here are a couple alternatives to modifying them:

1. Recommend that users pipe the fixture data through prettify_json.rb, for example:

   cat spec/fixtures/timeline.json | prettify_json.rb
   

2. Adding more details about what each method returns to the Octokit YARD documentation

3. Creating a separate directory of pretty-printed JSON responses, which aren't used by the specs.

Of the above options—all of which I'd prefer over modifying the existing fixtures—I would lean toward 2, however, since I don't understand the exact use case for reading the fixtures, that may or may not be an adequate solution. You tell me.

from octokit.rb.

PS: Here's an example of what better YARD documentation could look like: http://rdoc.info/gems/mtgox/0.6.0/MtGox/Client#sells-instance_method

Would something like that solve the problem?

from octokit.rb.

I'm reading them because I added octokit to my editor project and they come up when searching with Command-T and are pretty useful. I just ran it through the json prettifier myself.

I like number 1 the best, unless a conclusion is reached that pretty-printing doesn't significantly impair testing. I'll just go ahead and continue to do that (that's what I did). A rake task could be helpful, though.

from octokit.rb.

Okay, if that works I'm going to close this issue. If you write a rake task and submit a pull request, I'd be happy to take a look at it, but I think improving the documentation would be a better use of time.

from octokit.rb.

@sferik Good point, I hadn't considered that since majority of my work in the project has been with v3 of the API, which already returns data in a pretty format (see here for comparison: https://gist.github.com/1081629 ).

So in theory this will be moot when Octokit is fully converted to v3.

Also, If you have the jsonpretty gem installed you can just pipe into that: | jsonpretty

from octokit.rb.