ideas for further development on ataru

[emig]

Once #37 is merged, there is a running version of the gem that can be used to test target gems.

I open this issue to gather ideas for further development of the gem.

[emig]

Hi, here some esotheric ideas:

• automatize ataru gem checks:

  we can build a side project that:

  • uses rubygems api to gather gem names
  • load the gem and unpack it
  • add ataru to the gem, run ataru
  • get the result

• gihtub comments are also .md files.

  Whenever there are comments on an issue - project, and it contains code, it can be checked.

  • will use github api to get the comments
  • but, probably we have to run it agains master

[moonglum]

So this is pie in the sky, right?

I would love it if ataru understood the notation of YARD for code examples and check those as well! Would be extremely helpful for @railsbros-dirk and me, as we already found that we forgot to update those in the past.

[schultyy]

So would YARD then just be a new input format, right?

On 22 Sep 2014 at 17:14:41, Lucas Dohmen (notifications@github.com) wrote:

So this is pie in the sky, right?

I would love it if ataru understood the notation of YARD for code examples and check those as well! Would be extremely helpful for @railsbros-dirk and me, as we already found that we forgot to update those in the past.

— Reply to this email directly or view it on GitHub.

[moonglum]

Probably. But ataru can't detect that a Ruby file is documented using YARD, so it has to be configured by hand!

[schultyy]

Another feature which came up in discussion with @moonglum:

When code samples in a md file depend on each other, ataru need to execute them chronologically. Currently tests are executed at random to check if there are hidden dependencies between test cases. When we come to the point of implementing this, we should talk about how to disable random ordering for those code samples.

[emig]

Some people are writting books that have tons of code examples... and some of them use tools were GFM is used. I am thinking for example in the Padrino book by https://github.com/wikimatze/PadrinoBook. Would be cool to use ataru to get all this example codes right!