Boring Avatars Ruby is a Ruby implementation of Boring Avatars by boringdesigners. It generates SVG based avatars from any username and color palette in a variety of forms.
Add this line to your application's Gemfile:
gem 'boring_avatars_ruby'And then execute:
bundle installOr install it yourself as:
gem install boring_avatars_rubyCreating an avatar with default properties and returning a string containing the SVG output
avatar = BoringAvatarsRuby::Avatar.create({name: "Grace Hopper"})Overriding default property values
avatar = BoringAvatarsRuby::Avatar.create({
colors: ["#264653", "#2a9d8f", "#e9c46a", "#f4a261", "#e76f51"],
name: "Grace Hopper",
size: 120,
variant: :marble
})There are a number of variants that have been carried over from Boring Avatars: -
- Marble
- Pixel
- Ring
- Sunset
Additionally, an identicon variant has been ported from Ruby Identicon
| Property | Type |
|---|---|
| size | number (verical and horizontal size in pixels) |
| square | boolean (a square avatar is created if true) |
| name | string |
| variant | one of: :marble, :pixel, :ring, :sunset, :identicon |
| colors | array of colors in rgb notation |
The identicon variant ignores the color, size and square properties and has the following additional properties: -
| Property | Type |
|---|---|
| background_color | string, default: :transparent (the background color of the identicon in rgb notation (e.g. 0xffffff for white)) |
| border_size | number, default 35 (the size in pixels to leave as an empty border around the identicon image) |
| grid_size | number, default 7 (the number of rows and columns in the identicon, minimum 4, maximum 9) |
| square_size | number, default 50 (the size in pixels of each square that makes up the identicon) |
| key | string, a 16 byte key used by siphash when calculating the hash value (see note below) |
Varying the key ensures uniqueness of an identicon for a given title, it is assumed desirable for different applications to use a different key.
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the BoringAvatarsRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.