📛 Shields::Badge

if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the notification.

if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.

👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️

I’ve summarized my thoughts in this blog post.

🌻 Synopsis

💡 Info you can shake a stick at

Tokens to Remember
Works with JRuby
Works with Truffle Ruby
Works with MRI Ruby 4
Works with MRI Ruby 3
Support & Community
Source
Documentation
Compliance
Style
Maintainer 🎖️
`...` 💖	🧊 🐙 🛖 🧪

Compatibility

Compatible with MRI Ruby 3.1+, JRuby, and TruffleRuby.
CI workflows and Appraisals are generated for MRI Ruby 3.1+.
This test floor is configured by ruby.test_minimum in .kettle-jem.yml and
may be higher than the gem’s runtime compatibility floor when legacy Rubies are
not practical for the current toolchain.

The amazing test matrix is powered by the kettle-dev stack.

How kettle-dev manages complexity in tests

Gem	Source	Role
appraisal2	GitHub	multi-dependency Appraisal matrix generation
appraisal2-rubocop	GitHub	RuboCop Appraisal generator integration
kettle-dev	GitHub	development, release, and CI workflow tooling
kettle-jem	GitHub	Appraisals & CI workflow templates
kettle-soup-cover	GitHub	SimpleCov coverage policy and reporting
kettle-test	GitHub	standard test runner and coverage harness
rubocop-lts	GitHub	Ruby-version-aware linting
turbo_tests2	GitHub	parallel test execution

Federated DVCS

Find this repo on federated forges (Coming soon!)

Federated DVCS Repository	Status	Issues	PRs	Wiki	CI
🧪 galtzo-floss/shields-badge on GitLab	The Truth	💚	💚	💚	🐭 Tiny Matrix
🧊 galtzo-floss/shields-badge on CodeBerg	An Ethical Mirror (Donate)	💚	💚	➖	⭕️ No Matrix
🐙 galtzo-floss/shields-badge on GitHub	Another Mirror	💚	💚	💚	💯 Full Matrix

Enterprise Support

Available as part of the Tidelift Subscription.

Need enterprise-level guarantees?

The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.

💡Subscribe for support guarantees covering all your FLOSS dependencies
💡Tidelift is part of Sonar
💡Tidelift pays maintainers to maintain the software you depend on!
📊@Pointy Haired Boss: An enterprise support subscription is “never gonna let you down”, and supports open source maintainers

Alternatively:

✨ Installation

Install the gem and add to the application’s Gemfile by executing:

bundle add shields-badge

If bundler is not being used to manage dependencies, install the gem by executing:

gem install shields-badge

⚙️ Configuration

There is no application-wide configuration file. Requiring shields/badge
loads the badge registry and plugins; use Shields::Badge.register_all when
you want every built-in badge eagerly loaded. Otherwise badge classes are
loaded on first use. Badge methods accept an as: formatter option, currently
:markdown or :image_src_url.

🔧 Basic Usage

All parameters are in snake case when passing as Ruby arguments.
Certain parameters are configured to serialize as camel case (lower first) when formatted.
This is all automatic, and you don’t need to worry about it.
You can even supply the parameters in camel case (lower first) if you want.

Setup

Require the library (if this gem is in your Gemfile bundler will do this for you):

require "shields/badge"

Prefer method_missing or eager load?

The first time they are invoked, the badge generation methods on Shields::Badge will automatically require the badge tooling they need to generate a badge. If you want to avoid method_missing, you can eager load all the badges with Shields::Badge.register_all.

Path Parameters

These are generally required arguments and vary from badge to badge.

See the specs for examples. There is a spec for every badge, and at least one spec that utilizes every available path parameter.

Query Parameters

Most of these are optional arguments, but the odd one is required.

The query parameters that all badges share are:

path_parameters = {gem: "orange"}
query_parameters = {
  style: "flat",
  logo: "github",
  logo_color: "yellow",
  logo_size: "auto",
  label: "banana",
  label_color: "blue",
  color: "black",
  cache_seconds: "3600",
  link: "https://example.com/green/red"
}
# NOTE: You can specify path and query parameters separately, or as top-level arguments.
Shields::Badge.gem_total_downloads(path_parameters:, query_parameters:)
# => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)
Shields::Badge.gem_total_downloads(**path_parameters, **query_parameters)
# => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)

All the optional values supported by Shields.io are supported. Some badges have additional query parameters.

For the arguments that are designated as camel case (lower first) on Shields.io, it doesn’t matter if you supply the arguments in camel case (lower first) or snake case, as they will both work.

The above snake case arguments result in the same badge as the below camel case arguments:

path_parameters = {gem: "orange"}
query_parameters = {
  style: "flat",
  logo: "github",
  logoColor: "yellow",
  logoSize: "auto",
  label: "banana",
  labelColor: "blue",
  color: "black",
  cacheSeconds: "3600",
  link: "https://example.com/green/red"
}
Shields::Badge.gem_total_downloads(path_parameters:, query_parameters:)
# => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)

# And again it doesn't matter if the arguments are top-level or nested inside path and query parameters:
Shields::Badge.gem_total_downloads(**path_parameters, **query_parameters)
# => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)

See the specs for more examples. There is a spec for every badge, and at least one spec that utilizes every available query parameter.

Formatters

Shields.io has 5 output formats. Of those, 2 have been implemented here, and PRs are welcome for the remainder.

	URL	Markdown	rSt	AsciiDoc	HTML
Implemented	💚	💚	⏳️	⏳️	⏳️
Module	`...::ImageSrcUrl`	`...::Markdown`	⏳️	⏳️	⏳️
Source	image_src_url.rb	markdown.rb	⏳️	⏳️	⏳️

Legend

... => Shields::Formatters
⏳️ => Please submit a Pull Request to implement this formatter

Check the sources of the two that are done. They are very easy to write. This is a great project to get started with open source, because it is well tested, and patterned after the Shields.io website.

🦷 FLOSS Funding

While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding.
Raising a monthly budget of… “dollars” would make the project more sustainable.

We welcome both individual and corporate sponsors! We also offer a
wide array of funding channels to account for your preferences.
Currently, Open Collective is our preferred funding platform.

If you’re working in a company that’s making significant use of galtzo-floss tools we’d
appreciate it if you suggest to your company to become a galtzo-floss sponsor.

You can support the development of galtzo-floss tools via
GitHub Sponsors,
Liberapay,
PayPal,
Open Collective
and Tidelift.

📍 NOTE
If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we’d recommend the use of Tidelift, where you can get a support-like subscription instead.

Open Collective for Individuals

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Open Collective for Organizations

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

Another way to support open-source

I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

I’m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags

🔐 Security

See SECURITY.md.

🤝 Contributing

If you need some ideas of where to help, you could work on adding more code coverage,
check issues or PRs, or use the gem and think about how it could be better.

We so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

🚀 Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage service badges

🪇 Code of Conduct

Everyone interacting with this project’s codebases, issue trackers,
chat rooms and mailing lists agrees to follow the .

🌈 Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/shields-badge/-/graphs/main

📌 Versioning

This library follows for its public API where practical.
For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("shields-badge", "~> 1.0")

📌 Is "Platform Support" part of the public API? More details inside.

Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.

To get a better understanding of how SemVer is intended to work over a project’s lifetime, read this article from the creator of SemVer:

“Major Version Numbers are Not Sacred”

See CHANGELOG.md for a list of releases.

📄 License

The gem is available as open source under the terms of
the MIT .

© Copyright

See LICENSE.md for the official copyright notice.

🤑 A request for help

Maintainers have teeth and need to pay their dentists.
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
I began spending most of my time building open source tools.
I’m hoping to be able to pay for my kids’ health insurance this month,
so if you value the work I am doing, I need your support.
Please consider sponsoring me or the project.

To join the community or get help, use the RubyForum or Discord.

To say “thanks!” ☝️ Join the community or 👇️ send money.

💌 💌 💌

Please give the project a star ⭐ ♥.

Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.

Thanks for RTFM. ☺️