Emoji Syntax Gravatars

[simeonwillbanks]

Fixes #56

• Propose $simeonwillbanks$ syntax; $ as delimiter
• Add AvatarFilter test for template method
• Add GravatarFilter tests for parsing and various context options
• AvatarFilter defines interface
• GravatarFilter defines concrete implementation
  • GravatarFilter requires service for converting username to email

Notes

• Initial implementation for discussion
• Needs TomDoc

[simeonwillbanks]

Another interesting option is @! which allows reuse of existing @mention helpers.

[rsanheim]

I realize there was discussion of this back in #56, so I'm a bit late here.

But I'm pretty 👎 at adding this to the pipeline. It feels like adding some strange syntax for something that not be used very often.

[jch]

@rsanheim I usually prefer to add filters as a separate gem (e.g. html-pipeline-gravatar). But in this case, I'm open to adding this to the main project because:

• it doesn't add any external code dependencies
• avatars are a common and general web feature

Yes, we are depending on the interface of Gravatar, but that's been stable for a long time. The addition of AvatarFilter also allows people to write their own implementation. Whether we want to use this feature on GitHub.com should be a separate discussion for that team. It makes sense to me in the upstream open source gem. Thoughts?

@simeonwillbanks 👍 thanks for the pull. I'll review it after we decide this discussion ^^

[simeonwillbanks]

@rsanheim @jch Thanks for the input; I'm cool either way!

[jch]

@rsanheim any more thoughts on this?

[rsanheim]

@rsanheim any more thoughts on this?

So, I may have a much more focused vision for html-pipeline in general than other maintainers. But I think adding things that we aren't using in github.com directly adds maintenance burden in the long term without much gain. I'm 👎 this change or other similar changes that aren't direct fixes or improvements we can use in .com. The more focused we keep the pipeline, the better.

[bkeepers]

I tend to agree with @rsanheim's sentiments. Our open source projects at GitHub that have struggled are the ones that tried to be everything to everyone. I would stay focused on our needs, and encourage people to release their custom extensions as separate gems (like html-pipeline-gravatar).

[jch]

The more focused we keep the pipeline, the better.

Fair enough. @simeonwillbanks could you create and maintain a html-pipeline-gravatar gem? We can add a section to the README linking to 3rd party filters.

[simeonwillbanks]

@rsanheim and @bkeepers I appreciate your thoughts, and they're sound 😄

@jch Sure!