Add #name to renderers

[bkeepers]

Closes #374

From the tests:

    assert_equal "markdown", GitHub::Markup.renderer('README.md').name
    assert_equal "redcloth", GitHub::Markup.renderer('README.textile').name
    assert_equal "rdoc", GitHub::Markup.renderer('README.rdoc').name
    assert_equal "org-ruby", GitHub::Markup.renderer('README.org').name
    assert_equal "creole", GitHub::Markup.renderer('README.creole').name
    assert_equal "wikicloth", GitHub::Markup.renderer('README.wiki').name
    assert_equal "asciidoctor", GitHub::Markup.renderer('README.adoc').name
    assert_equal "restructuredtext", GitHub::Markup.renderer('README.rst').name
    assert_equal "pod", GitHub::Markup.renderer('README.pod').name

/cc @aroben @github/user-content

[mojavelinux]

Shouldn't the name for AsciiDoc files be "asciidoc" instead of "asciidoctor" to follow the pattern?

[ymendel]

Shouldn't the name for AsciiDoc files be "asciidoc" instead of
"asciidoctor" to follow the pattern?

I think asciidoctor makes sense, with analogy to textile/redcloth.

[bkeepers]

Shouldn't the name for AsciiDoc files be "asciidoc" instead of "asciidoctor" to follow the pattern?

I had the same question myself. Initially I wrote it to be the name of the format. The original motivation in #374 is for a name to use in cache keys. In that case, I think it makes sense to use the name of the library instead of the format.

[aroben]

I can see arguments in either direction. Given the currently proposed API (Renderer#name), I think we should be returning the names of the renderers themselves, not the language they render.

@bkeepers Are there any renderers that handle multiple languages currently? If so then returning language names would probably be better. This is all a bit hypothetical, but say you had a renderer that handles both Markdown and Textile documents. If we put the renderer's name (not the document's language) in the cache key, we wouldn't re-render when you renamed a file from README.md to README.textile.

[bkeepers]

Are there any renderers that handle multiple languages currently?

Nope. They might handle multiple file extensions, but their behavior doesn't change if the file extension changes (e.g. .markdown to .md).

[aroben]

Maybe this should return the name of the gem that will be used for rendering? Presumably the different gems produce different rendering for at least some documents.

[bkeepers]

@aroben is this still needed?

[aroben]

It would still be useful to have. We have a workaround for it currently as described in #374. The situation hasn't changed since I filed that issue.